diff --git a/raw/rel-18/29_series/29128/raw.md b/raw/rel-18/29_series/29128/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..54adc6908c1753fc2d3156b3bd3878356f9f6c52 --- /dev/null +++ b/raw/rel-18/29_series/29128/raw.md @@ -0,0 +1,2106 @@ + + +# 3GPP TS 29.128 V18.0.0 (2023-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) interfaces for interworking with packet data networks and applications (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 General Description ..... | 9 | +| 4.1 Introduction ..... | 9 | +| 5 Procedures Description ..... | 11 | +| 5.1 Introduction ..... | 11 | +| 5.2 Report Procedures ..... | 11 | +| 5.2.1 General ..... | 11 | +| 5.2.2 Detailed Behaviour of the MME/SGSN ..... | 12 | +| 5.2.2.0 General..... | 12 | +| 5.2.2.1 UE Loss of Connectivity..... | 12 | +| 5.2.2.2 UE Reachability..... | 13 | +| 5.2.2.3 Location Reporting ..... | 13 | +| 5.2.2.4 Communication Failure ..... | 13 | +| 5.2.2.5 Availability after DDN failure..... | 13 | +| 5.2.2.6 Idle Status Indication ..... | 13 | +| 5.2.2.7 PDN Connectivity Status ..... | 14 | +| 5.2.3 Detailed Behaviour of the SCEF ..... | 14 | +| 5.2.4 Detailed Behaviour of the IWK-SCEF ..... | 14 | +| 5.3 Event Configuration Procedure ..... | 14 | +| 5.3.1 General ..... | 14 | +| 5.3.2 Detailed Behaviour of the MME/SGSN ..... | 15 | +| 5.3.3 Detailed Behaviour of the IWK-SCEF ..... | 16 | +| 5.4 Event Configuration Procedure for Roaming..... | 16 | +| 5.4.1 General ..... | 16 | +| 5.4.2 Detailed Behaviour of the IWK-SCEF ..... | 17 | +| 5.4.3 Detailed Behaviour of the MME/SGSN ..... | 17 | +| 5.5 MO-Data Procedure ..... | 18 | +| 5.5.1 General ..... | 18 | +| 5.5.2 Detailed Behaviour of the MME/SGSN ..... | 19 | +| 5.5.3 Detailed Behaviour of the SCEF ..... | 19 | +| 5.5.4 Detailed Behaviour of the IWK-SCEF ..... | 20 | +| 5.6 MT Data Procedure ..... | 20 | +| 5.6.1 General ..... | 20 | +| 5.6.2 Detailed Behaviour of the SCEF ..... | 21 | +| 5.6.3 Detailed Behaviour of the MME/SGSN ..... | 21 | +| 5.6.4 Detailed Behaviour of the IWK-SCEF ..... | 22 | +| 5.7 Connection Management by MME/SGSN Procedure. .... | 22 | +| 5.7.1 General ..... | 22 | +| 5.7.2 Detailed Behaviour of the MME/SGSN ..... | 24 | +| 5.7.3 Detailed Behaviour of the SCEF ..... | 25 | +| 5.7.4 Detailed Behaviour of the IWK-SCEF ..... | 26 | +| 5.8 Connection Management by SCEF Procedure..... | 26 | +| 5.8.1 General ..... | 26 | +| 5.8.2 Detailed Behaviour of the SCEF ..... | 27 | +| 5.8.3 Detailed Behaviour of the MME/SGSN ..... | 27 | +| 5.8.4 Detailed Behaviour of the IWK-SCEF ..... | 28 | +| 6 Protocol Specification and Implementation..... | 28 | +| 6.1 Introduction ..... | 28 | + +| | | | +|----------|---------------------------------------------------------------------------|----| +| 6.1.1 | Use of Diameter Base Protocol ..... | 28 | +| 6.1.2 | Securing Diameter Messages ..... | 28 | +| 6.1.3 | Accounting Functionality ..... | 28 | +| 6.1.4 | Use of Sessions ..... | 28 | +| 6.1.5 | Transport Protocol ..... | 29 | +| 6.1.6 | Routing Considerations ..... | 29 | +| 6.1.6.1 | Routing Considerations for Monitoring Event related Requests ..... | 29 | +| 6.1.6.2 | Routing Considerations for Non-IP Data Related Requests ..... | 29 | +| 6.1.6.3 | Handling of the Vendor-Specific-Application-Id AVP ..... | 30 | +| 6.1.7 | Advertising Application Support ..... | 30 | +| 6.1.8 | Diameter Application Identifier ..... | 30 | +| 6.1.9 | Use of the Supported-Features AVP ..... | 30 | +| 6.2 | Commands ..... | 31 | +| 6.2.1 | Introduction ..... | 31 | +| 6.2.2 | Command-Code values ..... | 31 | +| 6.2.3 | Configuration Information Request (CIR) Command ..... | 31 | +| 6.2.4 | Configuration-Information-Answer (CIA) Command ..... | 32 | +| 6.2.5 | Reporting-Information-Request (RIR) Command ..... | 32 | +| 6.2.6 | Reporting-Information-Answer (RIA) Command ..... | 33 | +| 6.2.7 | Connection-Management-Request (CMR) Command ..... | 34 | +| 6.2.8 | Connection-Management-Answer (CMA) Command ..... | 34 | +| 6.2.9 | MO-Data-Request (ODR) Command ..... | 35 | +| 6.2.10 | MO-Data-Answer (ODA) Command ..... | 35 | +| 6.2.11 | MT-Data-Request (TDR) Command ..... | 36 | +| 6.2.12 | MT-Data-Answer (TDA) Command ..... | 36 | +| 6.3 | Result-Code AVP and Experimental-Result AVP Values ..... | 37 | +| 6.3.1 | General ..... | 37 | +| 6.3.2 | Success ..... | 37 | +| 6.3.3 | Permanent Failures ..... | 37 | +| 6.3.3.1 | DIAMETER_ERROR_UNAUTHORIZED_REQUESTING_ENTITY (5510) ..... | 37 | +| 6.3.3.2 | DIAMETER_ERROR_UNAUTHORIZED_SERVICE (5511) ..... | 37 | +| 6.3.3.3 | DIAMETER_ERROR_CONFIGURATION_EVENT_STORAGE_NOT_SUCCESSFUL
(5513) ..... | 37 | +| 6.3.3.4 | DIAMETER_ERROR_CONFIGURATION_EVENT_NON_EXISTANT (5514) ..... | 38 | +| 6.3.3.5 | DIAMETER_ERROR_REQUESTED_LOCATION_NOT_SERVED (5650) ..... | 38 | +| 6.3.3.6 | DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 38 | +| 6.3.3.7 | DIAMETER_ERROR_OPERATION_NOT_ALLOWED (5101) ..... | 38 | +| 6.3.3.8 | DIAMETER_ERROR_INVALID_EPS_BEARER (5651) ..... | 38 | +| 6.3.3.9 | DIAMETER_ERROR_NIDD_CONFIGURATION_NOT_AVAILABLE (5652) ..... | 38 | +| 6.3.3.10 | DIAMETER_ERROR_SCEF_REFERENCE_ID_UNKNOWN (5515) ..... | 38 | +| 6.3.3.11 | DIAMETER_ERROR_USER_TEMPORARILY_UNREACHABLE (5653) ..... | 38 | +| 6.3.3.12 | DIAMETER_ERROR_UNREACHABLE_USER (4221) ..... | 38 | +| 6.4 | AVPs ..... | 38 | +| 6.4.1 | General ..... | 38 | +| 6.4.2 | Monitoring-Event-Configuration ..... | 42 | +| 6.4.3 | Monitoring-Event-Report ..... | 42 | +| 6.4.4 | Communication-Failure-Information ..... | 43 | +| 6.4.5 | Cause-Type ..... | 43 | +| 6.4.6 | SIAP-Cause ..... | 44 | +| 6.4.7 | RANAP-Cause ..... | 44 | +| 6.4.8 | BSSGP-Cause ..... | 44 | +| 6.4.9 | GMM-Cause ..... | 44 | +| 6.4.10 | SM-Cause ..... | 44 | +| 6.4.11 | Number-Of-UE-Per-Location-Configuration ..... | 44 | +| 6.4.12 | Number-Of-UE-Per-Location-Report ..... | 44 | +| 6.4.13 | UE-Count ..... | 45 | +| 6.4.14 | Feature-List AVP ..... | 45 | +| 6.4.14.1 | Feature-List AVP for the T6a/T6b application ..... | 45 | +| 6.4.15 | DRMP ..... | 45 | +| 6.4.16 | User-Identifier ..... | 46 | +| 6.4.17 | Bearer-Identifier ..... | 46 | +| 6.4.18 | Connection-Action ..... | 46 | + +| | | | +|-----------------------------------------------------------------------|----------------------------------------------|-----------| +| 6.4.19 | Non-IP-Data ..... | 46 | +| 6.4.20 | Service-Selection ..... | 46 | +| 6.4.21 | Serving-PLMN-Rate-Control ..... | 46 | +| 6.4.22 | Downlink-Rate-Limit ..... | 47 | +| 6.4.23 | Uplink-Rate-Limit ..... | 47 | +| 6.4.24 | SCEF-Wait-Time ..... | 47 | +| 6.4.25 | CMR-Flags ..... | 47 | +| 6.4.26 | Extended-PCO ..... | 47 | +| 6.4.27 | RRC-Cause-Counter ..... | 47 | +| 6.4.28 | Counter-Value ..... | 47 | +| 6.4.29 | RRC-Counter-Timestamp ..... | 48 | +| 6.4.30 | Terminal-Information ..... | 48 | +| 6.4.31 | TDA-Flags ..... | 48 | +| 6.4.32 | Idle-Status-Indication ..... | 48 | +| 6.4.33 | Idle-Status-Timestamp ..... | 49 | +| 6.4.34 | Active-Time ..... | 49 | +| 6.4.35 | Reachability-Cause ..... | 49 | +| 6.4.36 | APN-Rate-Control-Status ..... | 50 | +| 6.4.37 | Uplink-Number-Of-Packets-Allowed ..... | 50 | +| 6.4.38 | Number-Of-Additional-Exception-Reports ..... | 50 | +| 6.4.39 | Downlink-Number-Of-Packets-Allowed ..... | 50 | +| 6.4.40 | APN-Rate-Control-Status-Validity-Time ..... | 50 | +| A.1 | T6a/b and T7 interfaces ..... | 50 | +| A.1.1 | General ..... | 50 | +| A.1.2 | SCEF behaviour ..... | 50 | +| A.1.3 | MME/SGSN behaviour ..... | 51 | +| A.1.4 | IWK-SCEF behaviour ..... | 51 | +| Annex B (normative): Diameter message priority mechanism ..... | | 51 | +| B.1 | General ..... | 51 | +| B.2 | T6a, T6ai, T6b, T6bi, T7 interfaces ..... | 51 | +| Annex C (normative): Diameter load control mechanism ..... | | 52 | +| C.1 | General ..... | 52 | +| C.2 | SCEF behaviour ..... | 52 | +| C.3 | MME/SGSN behaviour ..... | 53 | +| C.4 | IWK-SCEF behaviour ..... | 53 | +| Annex D (informative): Change history ..... | | 54 | + +# Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document describes the Diameter-based interfaces between the SCEF/IWK-SCEF and other network entities such as MME/SGSN for the Architecture enhancements to facilitate communications with packet data networks and applications. + +In particular, this document specifies the T6a interface between the MME and the SCEF, the T6ai interface between the MME and the IWK-SCEF, the T6b interface between the SGSN and the SCEF, the T6bi interface between the SGSN and the SCEF and the T7 interface between the SCEF and the IWK-SCEF. The procedures over those interfaces are defined in 3GPP TS 23.682 [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.682: "Architecture enhancements to facilitate communications with packet data networks and applications ". +- [3] Void. +- [4] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol; protocol details ". +- [5] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [6] 3GPP TS 29.228: "IP multimedia (IM) Subsystem Cx Interface; Signalling flows and Message Elements". +- [7] IETF RFC 4960: "Stream Control Transport Protocol". +- [8] IETF RFC 5234: "Augmented BNF for Syntax Specifications: ABNF". +- [9] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [10] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [11] 3GPP TS 25.413: "UTRAN Iu interface Radio Access Network Application Part (RANAP) signalling". + +- [12] 3GPP TS 24.008: "Mobile Radio Interface Layer 3 specification; Core Network Protocols; Stage 3". +- [13] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [14] 3GPP TS 48.018: "General Packet Radio Service (GPRS); Base Station System (BSS) - Serving GPRS Support Node (SGSN); BSS GPRS protocol (BSSGP)". +- [15] IETF RFC 7944: "Diameter Routing Message Priority". +- [16] 3GPP TS 29.272: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [17] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol; Protocol details". +- [18] Void. +- [19] 3GPP TS 23.007: "Restoration procedures". +- [20] 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging applications". +- [21] IETF RFC 5778: "Diameter Mobile IPv6: Support for Home Agent to Diameter Server Interaction". +- [22] 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging applications". +- [23] 3GPP TS 32.253: "Telecommunication management; Charging management; Control Plane (CP) data transfer domain charging". +- [24] 3GPP TS 23.003: "Numbering, addressing and identification". +- [25] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access". +- [26] 3GPP TS 29.172: "Location Services (LCS); Evolved Packet Core (EPC) LCS Protocol (ELP) between the Gateway Mobile Location Centre (GMLC) and the Mobile Management Entity (MME); SLg interface". +- [27] 3GPP TS 29.338: "Diameter based protocols to support SMS capable MMEs". +- [28] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [29] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [30] 3GPP TS 32.298: "Telecommunication Management; Charging Management; Charging Data Record (CDR) parameter description". +- [31] IETF RFC 8583: "Diameter Load Information Conveyance". +- [32] IETF RFC 6733: "Diameter Base Protocol". +- [33] 3GPP TS 29.274: " Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C)". + +# --- 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. + +## 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]. + +| | | +|----------|--------------------------------------| +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| SCEF | Service Capability Exposure Function | +| IWK-SCEF | Interworking - SCEF | + +# --- 4 General Description + +## 4.1 Introduction + +The T6a/b reference point between the MME/SGSN and the SCEF, the T6ai/bi reference point between the MME/SGSN in the VPLMN and the IWK-SCEF and the T7 reference point between the IWK-SCEF and the SCEF are defined in the 3GPP TS 23.682 [2]. + +This document describes the Diameter-based T6a/b, T6ai/bi and T7 related procedures, message parameters and protocol specification. + +An excerpt of the 3GPP Architecture for the enhancements to facilitate communications with packet data networks and applications, as defined in 3GPP TS 23.682 [2] is shown in Figure 4.1-1, where the relevant interfaces towards the SCEF/IWK-SCEF are highlighted. + +![Figure 4.1-1: 3GPP Architecture for the enhancements to facilitate communications with packet data networks and applications. The diagram shows a Home PLMN (HPLMN) and a Visited PLMN (VPLMN) separated by a dashed orange line. In the HPLMN, an HSS is connected to an MME/SGSN via S6a/d and S6t interfaces. The MME/SGSN is connected to an SCEF via T6a/b interfaces. In the VPLMN, an MME/SGSN is connected to an IWK-SCEF via T6ai/T6bi interfaces. The IWK-SCEF is connected to the SCEF in the HPLMN via a T7 interface.](cfda9df1319e04207eb28bcefd1dab7b_img.jpg) + +Figure 4.1-1: 3GPP Architecture for the enhancements to facilitate communications with packet data networks and applications. The diagram shows a Home PLMN (HPLMN) and a Visited PLMN (VPLMN) separated by a dashed orange line. In the HPLMN, an HSS is connected to an MME/SGSN via S6a/d and S6t interfaces. The MME/SGSN is connected to an SCEF via T6a/b interfaces. In the VPLMN, an MME/SGSN is connected to an IWK-SCEF via T6ai/T6bi interfaces. The IWK-SCEF is connected to the SCEF in the HPLMN via a T7 interface. + +**Figure 4.1-1: 3GPP Architecture for the enhancements to facilitate communications with packet data networks and applications** + +In this architecture, the T6a/b reference point connects the MME/SGSN with the SCEF. + +The T6a/b interface shall allow the SCEF: + +- to receive reports of the monitoring events from the MME/SGSN configured via an HSS; +- to configure the monitoring events at an MME/SGSN which are not UE related in the non roaming cases; +- to manage a connection between the MME and the SCEF on T6a; +- to send MT data on T6a; +- to receive MO data on T6a. + +The T6ai/bi reference point connects the MME/SGSN with the IWK-SCEF in the visited network, if the IWK-SCEF is deployed. + +The T6ai/bi interface shall allow the IWK-SCEF to: + +- to receive configuration of the monitoring events from the MME or the SGSN and perform a filtering of the services which are allowed for this subscriber in this visited network based on roaming policies; +- to receive reports of the monitoring events from the MME/SGSN that are configured via an HSS, perform a filtering and forward them to the SCEF (in the home network which has configured the event) via the T7 reference point; +- to receive MO data on T6ai/bi and forward them to the SCEF; +- to receive MT data and forward them to the MME on T6ai/bi; +- to manage a connection between MME/SGSN and IWK-SCEF on T6ai/bi and forward connection management commands to the SCEF. + +The T7 reference point connects the IWK-SCEF in the visited network with the SCEF in the home network. + +The T7 interface shall allow the IWK-SCEF to: + +- to forward reports received on T6ai/bi to the SCEF indicated in the event report received on T6ai/T6bi; +- to receive MO data on T6ai/bi and forward them to the SCEF on T7; +- to receive MT data on T7 and forward them to the MME/SGSN; +- to manage connection between the SCEF and the IWK-SCEF on T7 and forward connection management commands to the MME/SGSN. + +# --- 5 Procedures Description + +## 5.1 Introduction + +This clause describes the Diameter-based T6a, T6b, T6ai, T6bi and T7 interface related procedures and the Information elements exchanged between the functional entities. + +In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the "Cat." column. For the correct handling of the Information Element according to the category type, see the description detailed in clause 6 of the 3GPP TS 29.228 [6]. + +## 5.2 Report Procedures + +### 5.2.1 General + +This procedure is used between the MME/SGSN and the SCEF, between the MME/SGSN and the IWK-SCEF and between the IWK-SCEF and the SCEF. + +When the procedure is invoked by the MME or the SGSN, it is used for reporting: + +- UE Loss of Connectivity; +- UE Reachability; +- Location of the UE and change in location of the UE; +- Communication Failure; +- Availability after DNN failure; +- Idle Status Indication; +- PDN Connectivity Status. + +When the procedure is invoked by the IWK-SCEF, it is used for conveying the monitoring event reported by the MME or the SGSN to the SCEF, after applying the roaming policies configured at the IWK-SCEF. + +This procedure is mapped to the commands Reporting-Information-Request/Answer in the Diameter application specified in clause 6. The tables 5.2.1-1 and 5.2.1-2 detail the involved information elements. + +**Table 5.2.1-1: Reporting Information Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------------------|-------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | C | If present, this information element shall contain the identity of the UE. This is a grouped AVP containing the MSISDN or the External-Identifier. | +| Monitoring Event Report
(see 3GPP TS 29.336 [5] clause 8.4.3) | Monitoring-Event-Report | C | If the Reporting-Information-Request is sent for reporting the monitoring events, the MME/SGSN and the IWK-SCEF shall include the monitoring event(s) reported towards the SCEF. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 5.2.1-2: Reporting Information Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code / Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Monitoring Event Report Status | Monitoring-Event-Report-Status | O | If present, this information element shall contain the status of each individual monitoring event report received by the SCEF from the MME/SGSN. | + +### 5.2.2 Detailed Behaviour of the MME/SGSN + +#### 5.2.2.0 General + +The MME/SGSN shall fill the Monitoring-Event-Report AVP according to the event reported as specified below. For all monitoring events, the SCEF-ID, the SCEF-Reference-ID/SCEF-Reference-ID-Ext and the Monitoring-Type AVPs shall be included. In addition, the event specific AVPs as listed below shall be included based on the type of event reported. + +The MME/SGSN shall include the External-Identifier or the MSISDN if present in the subscription data received from the HSS. + +If the MME/SGSN receives an Experimental-Result-Code set to DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN within an RIA command, it shall delete the event stored for the indicated SCEF-ID and SCEF-Reference-ID/SCEF-Reference-ID-Ext (see 3GPP TS 23.007 [19]). + +#### 5.2.2.1 UE Loss of Connectivity + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the UE Loss of Connectivity event is reported: + +- Monitoring-Type set to LOSS\_OF\_CONNECTIVITY (0) + +The following AVPs may be present within the Monitoring-Event-Report AVP when the UE Loss of Connectivity event is reported: + +- Loss-Of-Connectivity-Reason set to one of the values defined in 3GPP TS 29.336 [5] + +#### 5.2.2.2 UE Reachability + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the UE Reachability event is reported: + +- Monitoring-Type set to either UE\_REACHABILITY (1) or UE\_REACHABILITY\_AND\_IDLE\_STATUS\_INDICATION (8), as received in the configuration request. +- Reachability-Information set to REACHABLE\_FOR\_DATA(1) + +The following AVPs may be present within the Monitoring-Event-Report AVP when the UE Reachability event is reported: + +- Maximum-UE-Availability-Time +- Reachability-Cause + +NOTE: When the Monitoring-Type is UE\_REACHABILITY\_AND\_IDLE\_STATUS\_INDICATION (8), absence of the Idle-Status-Indication AVP from the Monitoring-Event-Report AVP indicates that UE reachability is reported. + +#### 5.2.2.3 Location Reporting + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the location event is reported: + +- Monitoring-Type set to LOCATION\_REPORTING (2) +- EPS-Location-Information + +#### 5.2.2.4 Communication Failure + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the Communication Failure event is reported + +- Monitoring-Type set to COMMUNICATION\_FAILURE (5) +- Communication-Failure-Information (see clause 6.4.3) + +#### 5.2.2.5 Availability after DDN failure + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the Availability after DDN failure event is reported: + +- Monitoring-Type set to either AVAILABILITY\_AFTER\_DDN\_FAILURE (6) or AVAILABILITY\_AFTER\_DNN\_FAILURE\_AND\_IDLE\_STATUS\_INDICATION (9), as received in the configuration request. + +NOTE: When the Monitoring-Type is AVAILABILITY\_AFTER\_DNN\_FAILURE\_AND\_IDLE\_STATUS\_INDICATION (9), absence of the Idle-Status-Indication AVP from the Monitoring-Event-Report AVP indicates that Availability after DNN failure is reported. + +#### 5.2.2.6 Idle Status Indication + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the Idle Status Indication event is reported: + +- Monitoring-Type set to UE\_REACHABILITY\_AND\_IDLE\_STATUS\_INDICATION (8) or to AVAILABILITY\_AFTER\_DDN\_FAILURE\_AND\_IDLE\_STATUS\_INDICATION (9), depending on the Monitoring-Type of the corresponding event configuration. + +- Idle-Status-Indication + +#### 5.2.2.7 PDN Connectivity Status + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the PDN Connectivity Status event is reported: + +- Monitoring-Type set to PDN\_CONNECTIVITY\_STATUS (8) +- PDN-Connectivity-Status-Report + +### 5.2.3 Detailed Behaviour of the SCEF + +When the SCEF receives a Reporting Information Request from the MME/SGSN or the IWK-SCEF and at least one of the Monitoring Event Report AVPs has a SCEF-Reference-ID/SCEF-Reference-ID-Ext not known by the SCEF, it shall reply with Experimental-Result-Code set to DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN (see 3GPP TS 23.007 [19]). In that case, if the HSS had included multiple Monitoring Event Reports in the RIR command, the SCEF shall include in the Reporting Information Answer command a list of Monitoring-Event-Report-Status AVPs where the status of multiple monitoring event reports is detailed. In that AVP list, the AVPs corresponding to event reports with a successful status may be omitted by the SCEF, for efficiency. + +Otherwise when the SCEF receives a Reporting-Information-Request command from the MME/SGSN or the IWK-SCEF, the SCEF shall set Result-Code to DIAMETER\_SUCCESS in the Reporting-Information-Answer and shall handle it according to the procedures defined in 3GPP TS 23.682 [2]. + +### 5.2.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a Reporting-Information-Request command from the MME/SGSN it shall deliver the request to the SCEF after applying the roaming policies configured at the IWK-SCEF, as specified in 3GPP TS 23.682 [2]. + +## 5.3 Event Configuration Procedure + +### 5.3.1 General + +This procedure is used between the SCEF and the MME and between the SCEF and the SGSN to configure the monitoring events directly at the MME/SGSN through the T6a/b interface. + +When the procedure is invoked by the SCEF, it is used for configuring the event(s): + +- the number of UEs at a given geographic location. + +This procedure is mapped to the commands Configuration-Information-Request/Answer in the Diameter application specified in clause 6. The tables 5.3.1-1 and 5.3.1-2 detail the involved information elements. + +**Table 5.3.1-1: Configuration Information Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------|--------------------------------|------|-------------------------------------------------------------------------------------------------------| +| Monitoring Event Configuration (see clause 6.4.2) | Monitoring-Event-Configuration | C | If present, this Information Element shall contain the details of the Monitoring event(s) configured. | +| Supported Features (See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this Information Element shall contain the list of features supported by the origin host. | + +**Table 5.3.1-2: Configuration Information Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat | Description | +|----------------------------------------------------------------------------------------|------------------------------------------|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-
Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/T6b errors.
This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-
Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Monitoring Event Report
(see 3GPP TS 29.336 [5]
clause 8.4.3) | Monitoring-Event-
Report | C | If an immediate report is available this information element shall contain the requested data available in the MME/SGSN. | +| Monitoring Event-
Configuration Status
(see 3GPP TS 29.336 [5]
clause 8.4.24) | Monitoring-Event-
Config-Status | O | If present it shall contain the status of each monitoring event configuration identified by an SCEF-Reference-ID/SCEF-Reference-ID-Ext. | + +### 5.3.2 Detailed Behaviour of the MME/SGSN + +Monitoring Events configuration and deletion directly at the MME/SGSN for roaming scenarios is not supported. For the non roaming cases, when the Configuration-Information-Request is received from the SCEF, the MME/SGSN shall, in the following order: + +1. Check whether the requesting SCEF is authorized to request the specified service (e.g: number of UEs at a given geographic location). If not, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) in the Configuration-Information-Answer. +2. If the TA / RA / ECGI location requested by the SCEF is not served by the MME/SGSN, then the MME/SGSN shall set the Experimental-Result AVP to DIAMETER\_ERROR\_REQUESTED\_LOCATION\_NOT\_SERVED (5650) in the Configuration-Information-Answer. + +If there is an error in any of the above steps then the MME/SGSN shall stop processing and shall return the error code specified in the respective step. + +If the MME/SGSN cannot fulfil the received request for reasons not stated above, it shall stop processing the request and set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +If CIR message includes multiple SCEF Reference IDs (either in SCEF-Reference-ID or in SCEF-Reference-ID-Ext AVPs) and for a SCEF Reference ID the monitoring events cannot be handled, the MME/SGSN shall report the failed SCEF Reference ID to the SCEF with an appropriate status in the Monitoring-Event-Config-Status AVP. + +For the number of UEs in a geographic location monitoring event, for each SCEF-Reference-ID that the MME/SGSN is able to successfully process, the MME/SGSN shall + +- if filtering is not requested (i.e. IMSI-Group-Id was not present in the request) or not supported: +include in the Configuration-Information-Answer, the exact count of the number of UEs that are known to be at the requested location. +- if filtering is requested and (i.e. IMSI-Group-Id was present in the request) and supported: +include in the Configuration-Information-Answer, the exact count of the number of UEs belonging to the provided IMSI Group that are known to be at the requested location. + +If the requested location type is current location, then the MME/SGSN may activate the paging and RAN location reporting procedures (if required) before providing the response in the Configuration-Information-Answer. + +If the monitoring event configuration is for a continuous monitoring (i.e. Monitoring-Duration and/or Maximum-Number-Of-Reports are set) and the deletion criteria are met (i.e. Monitoring-Duration time expired and/or Maximum-Number-Of-Reports are sent) the MME/SGSN shall locally delete the Monitoring event. + +### 5.3.3 Detailed Behaviour of the IWK-SCEF + +Monitoring Events configuration and deletion directly at the MME/SGSN for roaming scenarios is not supported. Consequently the IWK-SCEF is not impacted for Monitoring Events configuration and deletion directly at the MME/SGSN from the SCEF.5.3.4 Detailed Behaviour of the SCEF + +When the SCEF receives Monitoring Event Report AVP from the MME/SGSN or the IWK-SCEF in the CIA command, it shall handle it according to the procedures defined in 3GPP TS 23.682 [2]. + +When the SCEF receives a Monitoring Event Report AVP from the MME/SGSN with a SCEF-Reference-ID/SCEF-Reference-ID-Ext not known by the SCEF, it should discard the Monitoring Event Report received in CIA command. + +## 5.4 Event Configuration Procedure for Roaming + +### 5.4.1 General + +The MME/SGSN shall send the monitoring event configuration information to the IWK-SCEF in roaming scenarios, when the MME/SGSN receives the monitoring event configuration from the HSS. The monitoring event configuration information as received in the Monitoring-Event-Configuration AVP shall be locally consumed at the IWK-SCEF and the IWK-SCEF shall not route such information beyond it. + +This procedure is mapped to the commands Configuration-Information-Request/Answer in the Diameter application specified in clause 6. The tables 5.4.1-1 and 5.4.1-2 detail the involved information elements. + +**Table 5.4.1-1: Configuration-Information-Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|--------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Event Configuration (see 6.4.2) | Monitoring-Event-Configuration | C | If present, this Information Element shall contain the details of Monitoring event(s). | +| Monitoring Event Report (see 6.4.3) | Monitoring-Event-Report | C | If an immediate report is available this information element shall contain the event reported by the MME/SGSN. The IWK-SCEF shall normalize the event report and send the normalized monitoring event report towards the SCEF as a separate Reporting-Information-Request message. | +| Supported Features (See 3GPP TS 29.229 [7]) | Supported-Features | O | If present, this Information Element shall contain the list of features supported by the origin host. | +| User Identity (See 6.4.16) | User-Identifier | O | If present in the subscription data received from the HSS, this information element shall contain the External-Identifier or the MSISDN. | + +**Table 5.4.1-2: Configuration-Information-Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat | Description | +|-------------------------------------------------------------------------------------|------------------------------------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-
Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [7]) | Supported-
Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Monitoring Event-
Configuration Status
(see 3GPP TS 29.336 [5] clause 8.4.24) | Monitoring-Event-
Config-Status | O | If present it shall contain the status of each monitoring event configuration identified by an SCEF-Reference-ID/SCEF-Reference-ID-Ext. | + +### 5.4.2 Detailed Behaviour of the IWK-SCEF + +When the Configuration-Information-Request is received from the MME/SGSN, the IWK-SCEF shall, in the following order: + +1. Check whether the requesting SCEF, identified by the SCEF-ID is authorized to request the specified service at the VPLMN. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) in the Configuration-Information-Answer. +2. Check whether the chargeable party for the monitoring event is authorized to be charged at the VPLMN. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) in the Configuration-Information-Answer. + +If the Configuration-Information-Request also carries the monitoring event report, the IWK-SCEF checks if the immediate events reported by the MME/SGSN needs to be normalized. If yes, the IWK-SCEF shall normalize the event report as per local policies. The IWK-SCEF shall then send the normalized monitoring event report towards the SCEF as a separate Reporting-Information-Request message. + +If the monitoring event configuration is for a continuous monitoring (i.e. Monitoring-Duration and/or Maximum-Number-Of-Reports are set), then the IWK-SCEF shall temporarily store the monitoring event configuration until the deletion criteria for the monitoring event configuration is met. If the deletion criteria are met, the IWK-SCEF shall delete the Monitoring event locally. The stored monitoring event configuration information shall be used during subsequent monitoring event report procedure, to generate the charging records towards the right chargeable party. + +If the received SCEF Reference ID for Deletion (either in SCEF-Reference-ID-for-Deletion or in SCEF-Reference-ID-for-Deletion-Ext AVPs) does not exist, the IWK-SCEF shall set the Experimental-Result-Code to DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_NON\_EXISTANT (5514). + +If the SCEF Reference ID (either in SCEF-Reference-ID or in SCEF-Reference-ID-Ext) exists and the old configuration data could not be replaced by new Configuration event data, the HSS shall set the Experimental-Result-Code to DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_STORAGE\_NOT\_SUCCESSFUL (5513). + +If the IWK-SCEF cannot fulfil the received request for reasons not stated in the above, it shall stop processing the request and set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +The details how to handle expiring of Monitoring events is described in 3GPP TS 23.682 [2] + +### 5.4.3 Detailed Behaviour of the MME/SGSN + +When the MME/SGSN receives the Configuration-Information-Answer from the IWK-SCEF, it shall handle it as follows: For the monitoring event configurations for which the configuration status have changed since last informed to + +the HSS, the MME/SGSN shall report the status to the HSS through a Notify-Request command as specified in clause 5.2.5 of 3GPP TS 29.272 [16]. + +## 5.5 MO-Data Procedure + +### 5.5.1 General + +This procedure shall be used between the MME/SGSN and the SCEF, between the MME/SGSN and the IWK-SCEF and between the IWK-SCEF and the SCEF. + +When the procedure is invoked by the MME or SGSN, it is used to forward mobile originated Non-IP data of a mobile user from the MME or SGSN to the SCEF. The procedure is also invoked by the MME on reception of RRC cause "MO Exception data". + +This procedure is used according to 3GPP TS 23.682 [2] clause 5.13.4. + +The IWK-SCEF may be in the path between the MME/SGSN and the SCEF for roaming cases when the IWK-SCEF is deployed by the operator of the visited PLMN. + +When the procedure is invoked by the IWK-SCEF, it is used to forward mobile originated Non-IP data received from the MME or SGSN to the SCEF. + +This procedure is mapped to the commands MO-Data-Request/Answer (ODR/ODA) in the Diameter application specified in clause 6. + +The tables 5.5.1-1 and 5.5.1-2 detail the involved information elements. + +**Table 5.5.1-1: MO Data Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | M | This Information Element shall be present and shall contain the identity of the UE. This is a grouped AVP which shall contain the IMSI. | +| EPS Bearer Identity
(See 6.4.17) | Bearer-Identifier | M | This information element shall be present and shall contain either the identity of the EPS bearer identifying the T6a connection, or the NSAPI of the PDP context identifying the T6b connection, for the Non-IP data delivery. | +| Non IP data
(See 6.4.19) | Non-IP-Data | C | This information element shall contain the Non-IP data to be delivered to the SCEF.
This Information Element shall be present when the request conveys Non-IP data. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| MO Exception Data Counter
(see 6.4.27) | RR-Cause-Counter | C | The MME shall include this Information Element when MME needs to send a non-zero counter value for the MO Exception Data Counter. The timestamp in the counter shall be set with the time at which the counter value increased from 0 to 1. | + +Table 5.5.1-2: MO Data Answer + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|--------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +### 5.5.2 Detailed Behaviour of the MME/SGSN + +The MME shall make use of this procedure over a T6a connection identified by its EPS bearer identity and previously established with the SCEF to forward the Non-IP data received from the UE to the SCEF or to an IWK-SCEF when deployed for a roaming case. + +The SGSN shall make use of this procedure over a T6b connection identified by the NSAPI of the PDP context, and previously established with the SCEF, to forward the Non-IP data received from the UE to the SCEF or to an IWK-SCEF when deployed for a roaming case. + +The MME shall increment the "MO Exception data counter" by one each time the MME has received the RRC cause "MO Exception data". The MME may defer sending a MO Data command message to report a non-zero value for the MO Exception Data Counter based on local configuration. + +If the MME has sent the RRC-Cause-Counter for RRC Cause "MO Exception data" in the MO Data Request command the MME shall reset the RRC-Cause-Counter when receiving MO Data Answer command. + +When receiving a Permanent Failure Result-Code/Experimental-Result, the MME or SGSN shall initiate a PDN disconnection procedure or Detach procedure towards the UE and if the permanent failure is different from DIAMETER\_ERROR\_INVALID\_EPS\_BEARER and different from DIAMETER\_ERROR\_USER\_UNKNOWN, the MME or SGSN shall make use of the "Connection Management by MME/SGSN" Procedure (see clause 5.7) to release the T6a/b connection between the MME/SGSN and the SCEF. + +### 5.5.3 Detailed Behaviour of the SCEF + +When the SCEF receives a MO Data Request from the MME/SGSN or the IWK-SCEF, the SCEF shall, in the following order: + +- Check that the User Identity exists in the SCEF. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the MO Data Answer; +- Check if, for this user, a bearer context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the MO Data Answer; +- Process the delivery of the data (if available) to the SCS/AS and/or process the RRC Cause Counter (if available). If the processing of either of them is not successful, return an appropriate Diameter error code, otherwise return a Result code set to DIAMETER\_SUCCESS to the MME/SGSN or IWK-SCEF. If the data delivery to the SCS/AS has failed due to there being no NIDD configuration context with an SCS/AS, set the Experimental-Result to DIAMETER\_ERROR\_NIDD\_CONFIGURATION\_NOT\_AVAILABLE in the MO Data Answer. + +NOTE: The Diameter Result-Code / Experimental-Result returned by the SCEF can depend on the error returned by the SCS/AS to the SCEF. The interface between the SCEF and the SCS/AS is out of scope of 3GPP. + +### 5.5.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a MO Data Request from the MME or SGSN, it shall forward the request to the SCEF. + +When the IWK-SCEF receives a MO Data Answer from the SCEF, it shall forward the answer to the MME or SGSN. + +## 5.6 MT Data Procedure + +### 5.6.1 General + +This procedure shall be used between the SCEF and the MME or SGSN, between the SCEF and the IWK-SCEF and between the IWK-SCEF and the MME or SGSN. + +When the procedure is invoked by the SCEF, it is used to forward mobile terminated Non-IP data of a mobile user from the SCEF to the MME or SGSN. + +This procedure is used according to 3GPP TS 23.682 [2] clause 5.13.3. + +The IWK-SCEF may be in the path between the SCEF and the MME/SGSN for roaming cases when the IWK-SCEF is deployed by the operator of the visited PLMN. + +When the procedure is invoked by the IWK-SCEF, it is used to forward mobile terminated Non-IP data received from the SCEF to the MME or SGSN. + +This procedure is mapped to the commands MT-Data-Request/Answer (TDR/TDA) in the Diameter application specified in clause 6. + +The tables 5.6.1-1 and 5.6.1-2 detail the involved information elements. + +NOTE: The corresponding message name in 3GPP TS 23.682 [2] is "NIDD Submit Request". + +**Table 5.6.1-1: MT Data Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------------------|-----------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | M | This Information Element shall be present and shall contain the identity of the UE. This is a grouped AVP which shall contain the IMSI. | +| EPS Bearer Identity
(See 6.4.17) | Bearer-Identifier | M | This information element shall be present and shall contain either the identity of the EPS bearer identifying the T6a connection, or the NSAPI of the PDP context identifying the T6b connection, for the Non-IP data delivery. | +| Non-IP Data
(See 6.4.19) | Non-IP-Data | C | This information element shall contain the Non-IP data to be delivered to the MME or SGSN.
This Information Element shall be present when the request conveys Non-IP data. | +| SCEF Wait Time
(See 6.4.24) | SCEF-Wait-Time | O | This information element, when present, shall indicate the timestamp (in UTC) until which the SCEF expects a response. | +| Maximum Retransmission Time
(See 3GPP TS 29.338 [27]) | Maximum-Retransmission-Time | O | This information element, when present, shall indicate the maximum retransmission time (in UTC) until which the SCEF is capable to retransmit the MT Non-IP Data. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +Table 5.6.1-2: MT Data Answer + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------------|--------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-Result | M | This information element shall contain the Result of the request. The Result-Code AVP shall be used to indicate success or errors as defined in the Diameter Base Protocol. The Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Requested Retransmission Time
(See 3GPP TS 29.338 [27]) | Requested-Retransmission-Time | O | This information element may be present if the Experimental-Result-Code is set to DIAMETER_ERROR_USER_TEMPORARILY_UNREACHABLE and the Maximum Retransmission Time information element is present in the MT Data Request. It may be included if the UE is using a power saving mechanism (such as extended idle mode DRX) and the UE is currently not reachable.

When present, this shall indicate the retransmission time (in UTC) at which the SCEF is requested to retransmit the MT Non-IP Data. The Requested Retransmission Time shall not exceed the Maximum Retransmission Time received from the SCEF. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| TDA Flags
(See 6.4.31) | TDA-Flags | O | This Information Element contains a bit mask. See clause 6.4.31 for the meaning of the bits and the condition for each bit to be set or not. | + +### 5.6.2 Detailed Behaviour of the SCEF + +The SCEF shall make use of this procedure over a T6a connection identified by its EPS Bearer Identity, and previously established with the MME, to forward the Non-IP data received from the SCS/AS to the MME or to an IWK-SCEF when deployed for a roaming case. + +The SCEF shall make use of this procedure over a T6b connection identified by the NSAPI of the PDP context, and previously established with the SGSN, to forward the Non-IP data received from the SCS/AS to the SGSN or to an IWK-SCEF when deployed for a roaming case. + +The SCEF shall check if a bearer context exists for the user before sending the request. + +The SCEF may include the Maximum-Retransmission-Time AVP in the MT Data Request to indicate the maximum retransmission time for when it is capable to retransmit the Non-IP Data. + +If the MT Data Answer includes the Requested-Retransmission-Time AVP, the SCEF shall retransmit the MT Non-IP Data at the requested retransmission time. + +### 5.6.3 Detailed Behaviour of the MME/SGSN + +When the MME or SGSN receives a MT Data Request from the SCEF or the IWK-SCEF, the MME or SGSN shall, in the following order: + +- Check that the User Identity exists in the MME or SGSN. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the MT Data Answer; +- Check whether, for this user, a bearer context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the MT Data Answer. +- Process the data delivery to the UE and: + +- if it is successful, return a Result code set to DIAMETER\_SUCCESS to the SCEF or IWK-SCEF; in addition, if the successful delivery was acknowledged by the eNodeB, the MME/SGSN shall set the "Success Acknowledged Delivery" bit within the TDA-Flags AVP. +- return an Experimental-Result set to DIAMETER\_ERROR\_USER\_TEMPORARILY\_UNREACHABLE, if the UE is using a power saving function (e.g. extended idle mode DRX or UE Power Saving Mode as defined in 3GPP TS 23.682 [27]) and the UE is expected to not be reachable shortly or, based on MME or SGSN implementation, within the time indicated by the SCEF-Wait-Time; + +The MME or SGSN shall set the Not Reachable for NIDD flag and store the SCEF Host and Realm for which this flag is set; + +If the MT Data Request includes the Maximum-Retransmission-Time AVP, the MME or SGSN may additionally include the Requested-Retransmission-Time AVP requesting the SCEF to retransmit the Non-IP Data at a later time prior to the Maximum Retransmission Time; + +The MME or SGSN shall then update the SCEF, as specified in clause 5.7, when it detects that the UE is reachable or about to become reachable and the Not Reachable for NIDD flag is set. If the MME or SGSN included the Requested-Retransmission-Time AVP in the MT Data Answer, the MME or SGSN shall do so only if the UE becomes reachable before the Requested Retransmission Time, i.e. the MME or SGSN shall reset the Not Reachable for NIDD flag when the Requested-Retransmission-Time expires if the UE has not become reachable beforehand; + +- return an Experimental-Result set to DIAMETER\_ERROR\_UNREACHABLE\_USER, if the UE is not reachable; +- otherwise return an appropriate Diameter error code. + +### 5.6.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a MT Data Request from the SCEF, it shall forward the request to the MME or SGSN. + +When the IWK-SCEF receives a MT Data Answer from the MME or SGSN, it shall forward the answer to the SCEF. + +## 5.7 Connection Management by MME/SGSN Procedure. + +### 5.7.1 General + +This procedure shall be used between the MME/SGSN and the SCEF, between the MME/SGSN and the IWK-SCEF and between the IWK-SCEF and the SCEF. + +When the procedure is invoked by the MME or SGSN, it is used: + +- to establish a T6a/b connection between the MME/SGSN and the SCEF; +- to update the parameters (e.g. RAT-Type) for a T6a/b connection between the MME/SGSN and the SCEF; +- to update the status of a T6a/b connection between the MME/SGSN and the SCEF, e.g. to indicate to the SCEF that the UE has become or is about to become reachable when MT non-IP data is pending at the SCEF for a UE using a power saving function; + +This procedure is used according to 3GPP TS 23.682 [2] clause 5.13.1 and 5.13.5 and 5.13.6. The IWK-SCEF may be in the path between the MME/SGSN and the SCEF for roaming cases when the IWK-SCEF is deployed by the operator of the visited PLMN. + +When the procedure is invoked by the IWK-SCEF, it is used to forward the Connection Management Request received from the MME or SGSN to the SCEF. + +This procedure is mapped to the commands Connection-Management-Request/Answer (CMR/CMA) in the Diameter application specified in clause 6. + +The tables 5.7.1-1 and 5.7.1-2 detail the involved information elements. + +**Table 5.7.1-1: Connection Management Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------------|-------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | M | This Information Element shall be present and shall contain the identity of the UE. This is a grouped AVP which shall contain the IMSI. | +| EPS Bearer Identity
(See 6.4.17) | Bearer-Identifier | M | This Information Element shall be present and shall contain either the identity of the EPS bearer identifying the T6a connection, or the NSAPI of the PDP context of the T6b connection, to which the request applies. | +| T6a/b Connection Action
(See 6.4.18) | Connection-Action | M | This Information element shall be present and shall contain a T6a/b connection management action indicating a T6a/b connection establishment or a T6a/b connection release or a T6a/b connection update. | +| APN
(See 6.4.20) | Service-Selection | C | This Information element shall contain the APN the user wants to connect to.
It shall be present if the request is for a T6a/b connection establishment. | +| Serving PLMN Rate Control
(See 6.4.21) | Serving-PLMN-Rate-Control | O | If present, this information element shall contain the Serving PLMN rate control set by the MME. | +| CMR Flags
(See 6.4.25) | CMR-Flags | O | This Information Element contains a bit mask. See clause 6.4.25 for the meaning of the bits and the condition for each bit to be set or not. | +| Maximum UE Availability Time
(See 3GPP TS 29.338 [27]) | Maximum-UE-Availability-Time | O | This information element may be included, if available, if the Connection-Action AVP indicates a T6a/b connection update and the UE-Reachable-Indicator is set in the CMR-Flags AVP.

When present, it shall indicate the timestamp (in UTC) until which a UE using a power saving mechanism (such as extended idle mode DRX) is expected to be reachable for MT Non-IP Data Delivery.
This information may be used by the SCEF to prioritize the retransmission of MT Non-IP Data to UEs using a power saving mechanism. | +| Extended PCO | Extended-PCO | C | This Information Element shall be present, if the MME or SGSN receives Extended PCO information from the UE. | +| 3GPP Charging Characteristics
(See 3GPP TS 32.298 [30]) | 3GPP-Charging-Characteristics | C | This Information element shall contain the PDN Connection Charging Characteristics data for an APN Configuration with SCEF-based NIDD mechanism.
It shall be present if the request is for a T6a/b connection establishment and may be present if the request is for a T6a/b connection update. | +| RAT-Type
(See 3GPP TS 29.212 [10]) | RAT-Type | C | This Information Element shall contain the used RAT Type.
It shall be present if the request is for a T6a/b connection establishment or for a T6a/b connection update. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Terminal Information
(See 3GPP TS 29.272 [16]) | Terminal-Information | C | This Information Element shall contain the identity of the UE.
It shall be present if available. | +| Visited PLMN ID
(See 3GPP TS 29.272 [16]) | Visited-PLMN-Id | C | This Information Element shall contain the identity (MCC and MNC) of serving PLMN.
It shall be present if the request is for a T6a/b connection establishment or for a T6a/b connection update. | +| APN Rate Control Status (see 6.4.36) | APN-Rate-Control-Status | O | May be present if the request is for a T6a/b connection establishment. | + +**Table 5.7.1-2: Connection Management Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------------|--------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| NIDD Charging Identifier
(See 3GPP TS 32.299 [22]) | PDN-Connection-Charging-Id | C | This Information element is defined in 3GPP TS 32.253 [23] and shall be present if the answer is for a T6a/b connection establishment. | +| Extended PCO | Extended-PCO | C | This Information Element shall be present, if the SCEF needs to send Extended PCO information to the UE. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| APN Rate Control Status (see 6.4.36) | APN-Rate-Control-Status | O | May be present if the response is for a T6a/b connection release. | + +### 5.7.2 Detailed Behaviour of the MME/SGSN + +The MME or SGSN shall make use of this procedure to request one of the following T6a/b connection management actions: + +- for a T6a/b connection establishment, the MME shall: + - include the user's IMSI. + - fill the EPS Bearer Identity information element with either the identity of the EPS bearer that MME allocated to the Non-IP PDN connection, or the NSAPI of the PDP context used by the SGSN for the Non-IP connection, as described in 3GPP TS 23.682 [2]; + - if Serving PLMN Rate Control is configured, the MME shall include the Serving PLMN Rate Control information as described in 3GPP TS 23.401 [25]; +- for a T6a/b connection release, the MME or SGSN shall: + - fill the EPS Bearer Identity information element with the identity of the EPS bearer of the T6a connection, or the NSAPI of the PDP context of the T6b connection, which is released as described in 3GPP TS 23.682 [2]; + - upon getting the Connection Management Answer from the SCEF, delete the T6a/b connection context; +- for a T6a/b connection update, the MME or SGSN shall: + - fill the EPS Bearer Identity information element with the identity of the EPS bearer of the T6a connection, or the NSAPI of the PDP context of the T6b connection, that needs to be updated; + - set the UE-Reachable-Indicator in the CMR-Flags AVP if the UE has become or is about to become reachable. The MME or SGSN may additionally include the Maximum UE Availability Time AVP, if available, to indicate the timestamp (in UTC) until which a UE using a power saving mechanism (such as extended idle mode DRX) is expected to be reachable for MT Non-IP Data Delivery; + - upon getting the Connection Management Answer from the SCEF, reset the Not Reachable for NIDD flag if this flag was set and if the UE-Reachable-Indicator was set in the CMR-Flags AVP in the Connection Management Request; + - if Serving PLMN Rate Control needs to be added or updated, the MME shall include Serving PLMN Rate Control information as described in 3GPP TS 23.401 [25]. + +NOTE: If the UE has several T6a/b connections to the same SCEF, for which Non-IP data is pending, the MME or SGSN initiates a T6a/b connection update for only one of the T6a/b connections towards this SCEF; the UE can have either T6a or T6b connections, but not both simultaneously. + +If the MME or SGSN receives the Extended-PCO AVP in the Connection Management Answer from the SCEF, the MME or SGSN shall forward the Extended-PCO to the UE transparently, as specified in 3GPP TS 24.301 [28]. + +### 5.7.3 Detailed Behaviour of the SCEF + +When the SCEF receives a Connection Management Request from the MME or SGSN the SCEF shall, in the following order: + +- check that the User Identity exists in the SCEF. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the Connection Management Answer; +- check that the T6a/b connection action indicates a T6a/b connection establishment, a T6a/b connection release or a T6a/b connection update. If not, the Experimental-Result shall be set to DIAMETER\_ERROR\_OPERATION\_NOT\_ALLOWED in the Connection Management Answer; +- if the T6a/b connection action indicates a T6a/b connection establishment: + - check whether a valid NIDD configuration exists for the UE at the SCEF; + - If not, the SCEF shall: + - reject the Connection Management Request, with Experimental-Result set to DIAMETER\_ERROR\_NIDD\_CONFIGURATION\_NOT\_AVAILABLE in the Connection Management Answer, or + - accept the Connection Management Request, and initiate a NIDD Configuration procedure with a default SCS/AS configured in the SCEF and the MSISDN or an external ID obtained from the HSS, as specified in 3GPP TS 29.336 [5] clause 7.2.3.2. If such NIDD Configuration procedure fails, the SCEF shall reject the Connection Management Request, with Experimental-Result set to DIAMETER\_ERROR\_NIDD\_CONFIGURATION\_NOT\_AVAILABLE in the Connection Management Answer; + - create an EPS bearer context; + - store the MME or SGSN Identity identified by the Origin-Host AVP of the T6a/b Connection Management Request, and the MME or SGSN realm identified by the Origin-Realm AVP of the T6a/b Connection Management Request in the EPS bearer context; + - include the Extended-PCO AVP in the Connection Management Answer, if the Extended PCO information (e.g. APN Rate Control information) needs to be provided to the UE; + - if Serving PLMN Rate Control is provided by the MME, restrict the number of messages for the downlink to not exceed the values provided in Serving PLMN Rate Control. If it is not provided and Serving PLMN Rate Control is active, then continue using the previously provided values; + - If successful, Result shall be set to DIAMETER\_SUCCESS in the Connection Management Answer; +- if the T6a/b connection action indicates a T6a/b connection release: + - check whether, for this user and the received EPS bearer ID, a T6a connection context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the Connection Management Answer; + - include the Extended-PCO AVP in the Connection Management Answer, if the Extended PCO information needs to be provided to the UE; + - delete the T6a/b connection context at the SCEF. If successful, Result code shall be set to DIAMETER\_SUCCESS in the Connection Management Answer; +- if the T6a/b connection action indicates a T6a connection update: + +- check whether, for this user and the received EPS Bearer Identity, a T6a/b connection context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the Connection Management Answer; +- if successful: + - if Serving PLMN Rate Control is provided by the MME, restrict the number of messages for the downlink to not exceed the values provided in Serving PLMN Rate Control. If it is not provided and Serving PLMN Rate Control is active, then continue using the previously provided values; + - include the Extended-PCO AVP in the Connection Management Answer, if the Extended PCO information (e.g. APN Rate Control information) needs to be provided to the UE; + - store the MME or SGSN Identity identified by the Origin-Host AVP of the T6a/b Connection Management Request and the MME or SGSN realm identified by the Origin-Realm AVP of the T6a/b Connection Management Request, if the MME or SGSN identity has changed, in the bearer context, and the Result shall be set to DIAMETER\_SUCCESS in the Connection Management Answer; + - if the UE-Reachable-Indicator was set in the CMR-Flags AVP, forward any MT Non-IP data pending for any T6a/b connection for this UE, to the MME or SGSN. + +If the Serving-PLMN-Rate-Control AVP is included in the Connection Management Request message from the MME, the SCEF shall enforce the Serving PLMN Rate Control as specified in 3GPP TS 23.401 [12] clause 4.7.7.2. + +### 5.7.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a Connection Management Request from the MME or SGSN, it shall forward the request to the SCEF. + +When the IWK-SCEF receives a Connection Management Answer from the SCEF, it shall forward the answer to the MME or SGSN. + +## 5.8 Connection Management by SCEF Procedure + +### 5.8.1 General + +This procedure shall be used between the SCEF and the MME/SGSN, and between the SCEF and the MME/SGSN via the IWK-SCEF acting as a Diameter proxy agent for roaming cases. + +When the procedure is invoked by the SCEF, it is used + +- to update the parameters (e.g. Extended PCO information) associated to a T6a/b connection between the MME/SGSN and the SCEF; +- to release a T6a/b connection between MME/SGSN and SCEF. + +This procedure is used according to 3GPP TS 23.682 [2]. The IWK-SCEF may be in the path between the MME/SGSN and the SCEF for roaming cases when the IWK-SCEF is deployed by the operator of the visited PLMN. + +This procedure is mapped to the commands Connection-Management-Request/Answer (CMR/CMA) in the Diameter application specified in clause 6. + +The tables 5.8.1-1 and 5.8.1-2 detail the involved information elements. + +**Table 5.8.1-1: Connection Management SCEF Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | M | This Information Element shall be present and shall contain the identity of the UE. This is a grouped AVP containing the IMSI. | +| EPS Bearer Identity
(See 6.4.17) | Bearer-Identifier | M | This Information Element shall be present and shall contain either the identity of the EPS bearer identifying the T6a connection, or the NSAPI of the PDP context identifying the T6b connection, to which the request applies. | +| T6a/b Connection Action
(See 6.4.18) | Connection-Action | M | This Information element shall be present and shall contain a T6a/b connection management action indicating a T6a/b connection update. | +| Extended PCO
(see 6.4.26) | Extended-PCO | C | This Information Element shall be present if the SCEF needs to send updated Extended PCO information (e.g. APN Rate Control information) to the UE. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 5.8.1-2: Connection Management SCEF Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code / Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +### 5.8.2 Detailed Behaviour of the SCEF + +The SCEF shall make use of this procedure to send the updated Extended PCO information (e.g. APN Rate Control information) to the UE during T6a/b connection update, if needed. If APN Rate Control information is included in the Extended-PCO AVP within the Connection Management SCEF Request message from the SCEF, the SCEF shall enforce the APN Rate Control as specified in 3GPP TS 23.401 [12] clause 4.7.7.3. + +The SCEF shall make use of this procedure to request the release of the T6a/b connection. + +### 5.8.3 Detailed Behaviour of the MME/SGSN + +When the MME or SGSN receives a Connection Management SCEF Request from the SCEF or the IWK-SCEF, the MME or SGSN shall, in the following order: + +- check that the User Identity exists in the MME or SGSN. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the Connection Management SCEF Answer; +- check that the T6a/b connection action indicates a T6a/b connection update or T6a/b connection release. If not, the Experimental-Result shall be set to DIAMETER\_ERROR\_OPERATION\_NOT\_ALLOWED in the Connection Management SCEF Answer; + +- check whether, for this user and the received EPS Bearer Identity, a T6a/b connection context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the Connection Management SCEF Answer; +- if the T6a/b connection action indicates a T6a/b connection update: + - if the Extended-PCO AVP is received, forward the Extended-PCO to the UE, as specified in 3GPP TS 24.301[28]. If successful, the Result code shall be set to DIAMETER\_SUCCESS in the Connection Management SCEF Answer. +- if the T6a/b connection action indicates T6a/b connection release, delete the T6a/b connection context at the MME/SGSN. If successful, the Result code shall be set to DIAMETER\_SUCCESS in the Connection Management SCEF Answer. + +### 5.8.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a Connection Management SCEF Request from the SCEF, it shall forward the request to the MME or SGSN. + +When the IWK-SCEF receives a Connection Management SCEF Answer from the MME or SGSN, it shall forward the answer to the SCEF. + +# --- 6 Protocol Specification and Implementation + +## 6.1 Introduction + +### 6.1.1 Use of Diameter Base Protocol + +The Diameter base protocol as specified in IETF RFC 6733 [32] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +### 6.1.2 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [4]. + +### 6.1.3 Accounting Functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the T6a/T6b interface, T6ai/T6bi interface and the T7 interface. + +### 6.1.4 Use of Sessions + +Diameter sessions shall be implicitly terminated between: + +- the MME/SGSN and the SCEF, for the T6a/T6b interface; +- the MME/SGSN and the IWK-SCEF, for the T6ai/T6bi interface and +- the IWK-SCEF and the SCEF for the T7 interface. + +An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [32]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +### 6.1.5 Transport Protocol + +Diameter messages over the T6a/T6b, T6ai/T6bi and T7 interface shall make use of SCTP IETF RFC 4960 [7] as transport protocol. + +### 6.1.6 Routing Considerations + +#### 6.1.6.1 Routing Considerations for Monitoring Event related Requests + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host for Monitoring Event related requests. + +The MME/SGSN shall use the SCEF-ID and the SCEF realm previously received over S6a/b for a monitoring event configuration as the Destination-Host AVP and the Destination-Realm AVP in the Reporting-Information-Request for the monitoring event reports sent over the T6a/T6b or T6ai/bi interface. + +The MME/SGSN shall use the pre-configured IWK-SCEF identify and the pre-configured IWK-SCEF realm as the Destination-Host AVP and the Destination Realm AVP in the Configuration-Information-Request for the monitoring event configuration sent over the T6ai/bi interface. + +The IWK-SCEF behaves as a Diameter Proxy agent according to IETF RFC 6733 [32] for the Reporting-Information-Request received from the MME/SGSN over the T6ai/bi interface and shall forward these requests to the SCEF over the T7 interface by keeping unchanged the Destination Realm and Destination Host AVPs. + +For monitoring events directly configured at the MME/SGSN by the SCEF, if the SCEF knows the address/name of the MME/SGSN, both the Destination-Realm AVP and the Destination-Host AVP shall be present in the request. Otherwise, only the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node. Consequently, the Destination-Host AVP is declared as optional in the ABNF for all Monitoring Event related requests initiated by the SCEF. + +The Destination-Realm AVP is declared as mandatory in the ABNF for all Monitoring Event related requests. The Destination-Host AVP is declared as optional in the ABNF description of the Reporting-Information-Request and of the Configuration Information-Request. + +#### 6.1.6.2 Routing Considerations for Non-IP Data Related Requests + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host for Non-IP Data related requests. + +The MME or SGSN shall use the SCEF-ID and the SCEF realm that it received in the subscribed APN associated to the T6a/b connection at its establishment as the Destination-Host AVP and the Destination realm AVP in the Non-IP data related request commands sent over the T6a/b and T6ai/bi interfaces. + +The Destination-Host AVP is declared as optional and the Destination realm AVP as mandatory in the ABNF description of the Non-IP data related requests initiated by the MME or SGSN. + +NOTE 1: For roaming cases, the routing of MME or SGSN initiated request commands to the IWK-SCEF relies on the Destination Realm AVP as according to the Diameter base protocol. + +NOTE 2: The Diameter implicitly terminated sessions and their Session ID for the Non-IP data related traffic are end to end between the MME/SGSN and the SCEF. + +The IWK-SCEF behaves as a Diameter Proxy agent according to IETF RFC 6733 [32] for the Non-IP related requests received from the MME or SGSN over the T6ai/bi interfaces and shall forward these requests to the SCEF over the T7 interface by keeping unchanged the Destination Realm and Destination Host AVPs. + +The SCEF obtains the Destination-Host AVP and the Destination-Realm AVP to use in the Non-IP data related requests towards an MME or SGSN from the Origin-Host AVP and the Origin-Realm AVP received in previous Non-IP Data related requests from the MME or SGSN. The Origin-Realm AVP in the requests received by the SCEF in roaming cases should contain the domain name of the network to which the MME or SGSN belongs, encoded as specified in clause 19.2 of 3GPP TS 23.003 [24]. + +The Destination-Host AVP is declared as optional and the Destination realm AVP as mandatory in the ABNF for the Non-IP Data related requests initiated by the SCEF. + +The IWK-SCEF behaves as a Diameter Proxy agent according to IETF RFC 3588 [3] for the Non-IP related requests received from the SCEF over the T7 interface and shall forward these requests to the MME or SGSN over the T6ai/bi interfaces by keeping unchanged the Destination Realm and Destination Host AVPs. + +#### 6.1.6.3 Handling of the Vendor-Specific-Application-Id AVP + +If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +### 6.1.7 Advertising Application Support + +The SCEF, MME, SGSN and the IWK-SCEF shall advertise support of the Diameter T6a/T6b Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +NOTE: Even though the reference point between the MME/SGSN and the IWK-SCEF is called T6ai/T6bi respectively and the reference point between the IWK-SCEF and the SCEF is called T7, all these reference points use the same Diameter Application ID. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [32]. + +### 6.1.8 Diameter Application Identifier + +The T6a/T6b interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the T6a/T6b interface application is 16777346. + +The T6ai/T6bi and the T7 interface protocol shall use the same Diameter application identifier as the T6a/T6b interface. + +### 6.1.9 Use of the Supported-Features AVP + +When new functionality is introduced on the T6a/T6b application, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. The usage of the Supported-Features AVP on the T6a/T6b application is consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [4]. + +When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [4], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this + +document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +## 6.2 Commands + +### 6.2.1 Introduction + +This clause defines the Command code values and related ABNF for each command described in this specification. The ABNF for the commands on T6a/T6b, T6ai/T6bi and T7 are the same if not specified explicitly different. + +### 6.2.2 Command-Code values + +This clause defines Command-Code values for the T6a/T6b interface application as allocated by IANA. + +Every command is defined by means of the ABNF syntax IETF RFC 5234 [8], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [32]. When the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [32] shall apply. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with IETF RFC 6733 [32]. + +The following Command Codes are defined in this specification for T6a/T6b: + +**Table 6.2.2-1: Command-Code values for T6a/T6b** + +| Command-Name | Abbreviation | Code | Clause | +|-----------------------------------|--------------|---------|--------------------------------------------------------| +| Configuration-Information-Request | CIR | 8388718 | 3GPP TS 29.336 [5] clause 8.2.3 and clause 6.2.3 below | +| Configuration-Information-Answer | CIA | 8388718 | 3GPP TS 29.336 [5] clause 8.2.4 and clause 6.2.4 below | +| Reporting-Information-Request | RIR | 8388719 | 3GPP TS 29.336 [5] clause 8.2.5 and clause 6.2.5 below | +| Reporting-Information-Answer | RIA | 8388719 | 3GPP TS 29.336 [5] clause 8.2.6 and clause 6.2.6 below | +| Connection-Management-Request | CMR | 8388732 | 6.2.7 | +| Connection-Management-Answer | CMA | 8388732 | 6.2.8 | +| MO-Data-Request | ODR | 8388733 | 6.2.9 | +| MO-Data-Answer | ODA | 8388733 | 6.2.10 | +| MT-Data-Request | TDR | 8388734 | 6.2.11 | +| MT-Data-Answer | TDA | 8388734 | 6.2.12 | + +For these commands, the Application-ID field shall be set to 16777346 (application identifier of the T6a/T6b interface application, allocated by IANA). + +### 6.2.3 Configuration Information Request (CIR) Command + +The Configuration Information Request (CIR) command, indicated by the Command-Code field set to 8388718 and the "R" bit set in the Command Flags field, is sent from: + +- the SCEF to the MME/SGSN; +- the SCEF to the IWK-SCEF and +- the MME/SGSN to the IWK-SCEF + +This command is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Configuration-Information-Request command format is specified as following: + +Message Format: + +``` +< Configuration-Information-Request > ::= < Diameter Header: 8388718, REQ, PXY, 16777346 > + < Session-Id > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + *[ Supported-Features ] + *[ Monitoring-Event-Configuration ] + *[ Monitoring-Event-Report ] + [ User-Identifier ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] +``` + +### 6.2.4 Configuration-Information-Answer (CIA) Command + +The Configuration-Information-Answer (CIA) command, indicated by the Command-Code field set to 8388718 and the "R" bit cleared in the Command Flags field, is sent from: + +- the MME/SGSN to the SCEF; +- the IWK-SCEF to the SCEF and +- the IWK-SCEF to the MME/SGSN + +This command is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Configuration-Information-Answer command format is specified as following: + +Message Format: + +``` +< Configuration-Information-Answer > ::= < Diameter Header: 8388718, PXY, 16777346 > + < Session-Id > + [ DRMP ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ Supported-Features ] + *[ Monitoring-Event-Report ] + *[ Monitoring-Event-Config-Status ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] +``` + +### 6.2.5 Reporting-Information-Request (RIR) Command + +The Reporting-Information-Request (RIR) command, indicated by the Command-Code field set to 8388719 and the "R" bit set in the Command Flags field, is sent from: + +- the MME/SGSN to the SCEF; + +- the MME/SGSN to the IWK-SCEF and +- the IWK-SCEF to the SCEF. + +This command is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Reporting-Information-Request command format is specified as following: + +Message Format: + +``` +< Reporting-Information-Request > ::= < Diameter Header: 8388719, REQ, PXY, 16777346 > +< Session-Id > +[ DRMP ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Destination-Host ] +{ Destination-Realm } +[ OC-Supported-Features ] +*[ Supported-Features ] +[ User-Identifier ] +*[ Monitoring-Event-Report ] +**[ Proxy-Info ] +*[ Route-Record ] +*[AVP] +``` + +### 6.2.6 Reporting-Information-Answer (RIA) Command + +The Reporting-Information-Answer (RIA) command, indicated by the Command-Code field set to 8388719 and the "R" bit cleared in the Command Flags field, is sent from: + +- the SCEF to the MME/SGSN; +- the SCEF to the IWK-SCEF and +- the IWK-SCEF to the MME/SGSN. + +This command is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Reporting-Information-Answer command format is specified as following: + +Message Format: + +``` +< Reporting-Information-Answer > ::= < Diameter Header: 8388719, PXY, 16777346 > +< Session-Id > +[ DRMP ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +*[ Supported-Features ] +*[ Monitoring-Event-Report-Status ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +*[AVP] +``` + +### 6.2.7 Connection-Management-Request (CMR) Command + +The Connection-Management-Request (CMR) command, indicated by the Command-Code field set to 8388732 and the "R" bit set in the Command Flags field, is sent from: + +- the MME or SGSN to the SCEF; +- the MME or SGSN to the SCEF via the IWK-SCEF for roaming cases; +- the SCEF to the MME or SGSN; +- the SCEF to the MME or SGSN via the IWK-SCEF for roaming cases. + +For the T6a/b, T6ai/bi, T7 interfaces, the Connection-Management-Request command format is specified as following: + +Message Format: + +``` +< Connection-Management-Request > ::= < Diameter Header: 8388732, REQ, PXY, 16777346 > + < Session-Id > + < User-Identifier > + < Bearer-Identifier > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + [ OC-Supported-Features ] + [ CMR-Flags ] + [ Maximum-UE-Availability-Time ] + *[ Supported-Features ] + [ Connection-Action ] + [ Service-Selection ] + [ Serving-PLMN-Rate-Control ] + [ Extended-PCO ] + [ 3GPP-Charging-Characteristics ] + [ RAT-Type ] + [ Terminal-Information ] + [ Visited-PLMN-Id ] + [ APN-Rate-Control-Status ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] +``` + +### 6.2.8 Connection-Management-Answer (CMA) Command + +The Connection-Management-Answer (CMA) command, indicated by the Command-Code field set to 8388732 and the "R" bit cleared in the Command Flags field, is sent from: + +- the SCEF to the MME or SGSN; +- the SCEF to the MME or SGSN via the IWK-SCEF for roaming cases; +- the MME or SGSN to the SCEF; +- the MME or SGSN to the SCEF via the IWK-SCEF for roaming cases. + +For the T6a/b, T6ai/bi and T7 interfaces, the Connection-Management-Answer command format is specified as following: + +Message Format: + +``` +< Connection-Management-Answer > ::= < Diameter Header: 8388732, PXY, 16777346 > + < Session-Id > +``` + +``` + +[ DRMP ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +*[ Supported-Features ] +[ PDN-Connection-Charging-Id ] +[ Extended-PCO ] +[ APN-Rate-Control-Status ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +*[AVP] + +``` + +### 6.2.9 MO-Data-Request (ODR) Command + +The MO-Data-Request (ODR) command, indicated by the Command-Code field set to 8388733 and the "R" bit set in the Command Flags field, is sent from: + +- the MME or SGSN to the SCEF; +- the MME or SGSN to the IWK-SCEF and +- the IWK-SCEF to the SCEF. + +For the T6a/b, T6ai/bi, T7 interfaces, the MO-Data-Request command format is specified as following: + +Message Format: + +``` + +< MO-Data-Request > ::= < Diameter Header: 8388733, REQ, PXY, 16777346 > + < Session-Id > + < User-Identifier > + < Bearer-Identifier > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + [ OC-Supported-Features ] + *[ Supported-Features ] + [ Non-IP-Data ] + *[ Proxy-Info ] + *[ Route-Record ] + [ RRC-Cause-Counter ] + *[AVP] + +``` + +### 6.2.10 MO-Data-Answer (ODA) Command + +The MO-Data-Answer (ODA) command, indicated by the Command-Code field set to 8388733 and the "R" bit cleared in the Command Flags field, is sent from: + +- the SCEF to the MME or SGSN; +- the SCEF to the IWK-SCEF and +- the IWK-SCEF to the MME or SGSN. + +For the T6a/b, T6ai/bi and T7 interfaces, the MO-Data-Answer command format is specified as following: + +Message Format: + +``` + +< MO-Data-Answer > ::= < Diameter Header: 8388733, PXY, 16777346 > + < Session-Id > + [ DRMP ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] + +``` + +### 6.2.11 MT-Data-Request (TDR) Command + +The MT-Data-Request (TDR) command, indicated by the Command-Code field set to 8388734 and the "R" bit set in the Command Flags field, is sent from: + +- the SCEF to the MME or SGSN; +- the SCEF to the IWK-SCEF and +- the IWK-SCEF to the MME or SGSN. + +For the T6a/b, T6ai/bi, T7 interfaces, the MT-Data-Request command format is specified as following: + +Message Format: + +``` + +< MT-Data-Request > ::= < Diameter Header: 8388734, REQ, PXY, 16777346 > + < Session-Id > + < User-Identifier > + < Bearer-Identifier > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + [ OC-Supported-Features ] + *[ Supported-Features ] + [ Non-IP-Data ] + [ SCEF-Wait-Time ] + [ Maximum-Retransmission-Time ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] + +``` + +### 6.2.12 MT-Data-Answer (TDA) Command + +The MT-Data-Answer (TDA) command, indicated by the Command-Code field set to 8388734 and the "R" bit cleared in the Command Flags field, is sent from: + +- the MME or SGSN to the SCEF; +- the MME or SGSN to the IWK-SCEF and +- the IWK-SCEF to the SCEF. + +For the T6a/b, T6ai/bi and T7 interfaces, the MT-Data-Answer command format is specified as following: + +Message Format: + +``` + +< MT-Data-Answer > ::= < Diameter Header: 8388734, PXY, 16777346 > + < Session-Id > + [ DRMP ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + [ Requested-Retransmission-Time ] + *[ Supported-Features ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + [ TDA-Flags ] + *[AVP] + +``` + +## 6.3 Result-Code AVP and Experimental-Result AVP Values + +### 6.3.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 6.3.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [32] shall be applied. + +### 6.3.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in the Diameter base protocol specified IETF RFC 6733 [32] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 6.3.3.1 DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) + +This result code shall be sent by the MME/SGSN or the IWK-SCEF to indicate that the SCEF is not allowed to request Monitoring services. This error code is defined in 3GPP TS 29.336 [5]. + +#### 6.3.3.2 DIAMETER\_ERROR\_UNAUTHORIZED\_SERVICE (5511) + +This result code shall be sent by the MME/SGSN or the IWK-SCEF to indicate that the specific service requested by the SCEF is not allowed as per local policies. This error code is defined in 3GPP TS 29.336 [5]. + +#### 6.3.3.3 DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_STORAGE\_NOT\_SUCCESSFUL (5513) + +This result code shall be sent by the MME/SGSN to indicate that the specific service requested by the SCEF could not be stored. This error code is defined in 3GPP TS 29.336 [5]. + +#### 6.3.3.4 DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_NON\_EXISTANT (5514) + +This result code shall be sent by the IWK-SCEF to indicate that the requested deletion by the MME/SGSN could not be performed because the event does not exist. This error code is defined in 3GPP TS 29.336 [5]. + +#### 6.3.3.5 DIAMETER\_ERROR\_REQUESTED\_LOCATION\_NOT\_SERVED (5650) + +This result code shall be sent by the MME/SGSN to indicate that the location for which a related monitoring event is configured (e.g. Number of UEs at a given geographical location) by the SCEF, is not served by the MME/SGSN. + +#### 6.3.3.6 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the SCEF or the MME/SGSN to indicate that the user identified by the IMSI is unknown. This error code is defined in 3GPP TS 29.229 [4]. + +#### 6.3.3.7 DIAMETER\_ERROR\_OPERATION\_NOT\_ALLOWED (5101) + +This result code shall be sent by the SCEF to indicate that the operation is not allowed when an EPS bearer context exists for the user. This error code is defined in 3GPP TS 29.329 [17]. + +This result code shall be sent by the SCEF or the MME/SGSN to indicate that the requested T6a/b connection action is not allowed. + +#### 6.3.3.8 DIAMETER\_ERROR\_INVALID\_EPS\_BEARER (5651) + +This result code shall be sent by the SCEF or the MME/SGSN to indicate that there is no bearer context for the user. + +#### 6.3.3.9 DIAMETER\_ERROR\_NIDD\_CONFIGURATION\_NOT\_AVAILABLE (5652) + +This result code shall be sent by the SCEF to indicate that there is no valid NIDD configuration available. + +#### 6.3.3.10 DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN (5515) + +This result code shall be sent by the SCEF to indicate that the SCEF reference ID is not known by the SCEF. + +#### 6.3.3.11 DIAMETER\_ERROR\_USER\_TEMPORARILY\_UNREACHABLE (5653) + +This result code shall be sent by the MME or SGSN to indicate that the UE is temporarily not reachable due to a power saving function, and that the MME or SGSN will update the SCEF when it detects that the UE is reachable or about to become reachable as specified in clause 5.6.3. + +#### 6.3.3.12 DIAMETER\_ERROR\_UNREACHABLE\_USER (4221) + +This result code shall be sent by the MME to indicate that the UE is not reachable. This error code is defined in 3GPP TS 29.172 [26]. + +## 6.4 AVPs + +### 6.4.1 General + +The following table specifies the Diameter AVPs defined for the T6a/T6b interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415). + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +Table 6.4.1-1: T6a/T6b specific Diameter AVPs + +| | | | | AVP Flag rules | | | | | +|-----------------------------------------|----------|----------------|-------------|----------------|-----|------------|----------|-----------| +| Attribute Name | AVP Code | Clause defined | Value Type | Must | May | Should not | Must not | May Encr. | +| Communication-Failure-Information | 4300 | 6.4.4 | Grouped | M,V | | | | No | +| Cause-Type | 4301 | 6.4.5 | Unsigned32 | M,V | | | | No | +| S1AP-Cause | 4302 | 6.4.6 | Unsigned32 | M,V | | | | No | +| RANAP-Cause | 4303 | 6.4.7 | Unsigned32 | M,V | | | | No | +| BSSGP-Cause | 4309 | 6.4.8 | Unsigned32 | M,V | | | | No | +| GMM-Cause | 4304 | 6.4.9 | Unsigned32 | M,V | | | | No | +| SM-Cause | 4305 | 6.4.10 | Unsigned32 | M,V | | | | No | +| Number-Of-UE-Per-Location-Configuration | 4306 | 6.4.11 | Grouped | M,V | | | | No | +| Number-Of-UE-Per-Location-Report | 4307 | 6.4.12 | Grouped | M,V | | | | No | +| UE-Count | 4308 | 6.4.13 | Unsigned32 | M,V | | | | No | +| Connection-Action | 4314 | 6.4.18 | Unsigned32 | M,V | | | | No | +| Non-IP-Data | 4315 | 6.4.19 | OctetString | M,V | | | | No | +| Serving-PLMN-Rate-Control | 4310 | 6.4.21 | Grouped | M,V | | | | No | +| Uplink-Rate-Limit | 4311 | 6.4.23 | Unsigned32 | M,V | | | | No | +| Downlink-Rate-Limit | 4312 | 6.4.22 | Unsigned32 | M,V | | | | No | +| Extended-PCO | 4313 | 6.4.26 | OctetString | M,V | | | | No | +| SCEF-Wait-Time | 4316 | 6.4.24 | Time | M,V | | | | No | +| CMR-Flags | 4317 | 6.4.25 | Unsigned32 | M,V | | | | No | +| RR-Cause-Counter | 4318 | 6.4.27 | Grouped | M,V | | | | No | +| Counter-Value | 4319 | 6.4.28 | Unsigned32 | M,V | | | | No | +| RR-Counter-Timestamp | 4320 | 6.4.29 | Time | M,V | | | | No | +| TDA-Flags | 4321 | 6.4.31 | Unsigned32 | V | | | M | No | +| Idle-Status-Indication | 4322 | 6.4.32 | Grouped | V | | | M | No | +| Idle-Status-Timestamp | 4323 | 6.4.33 | Time | V | | | M | No | +| Active-Time | 4324 | 6.4.34 | Unsigned32 | V | | | M | No | +| Reachability-Cause | 4325 | 6.4.35 | Unsigned32 | V | | | M | No | +| APN-Rate-Control-Status | 4326 | 6.4.36 | Grouped | V | | | M | No | +| Uplink-Number-Of-Packets-Allowed | 4327 | 6.4.37 | Unsigned32 | V | | | M | No | +| Number-Of-Additional-Exception-Reports | 4328 | 6.4.38 | Unsigned32 | V | | | M | No | +| Downlink-Number-Of-Packets-Allowed | 4329 | 6.4.39 | Unsigned32 | V | | | M | No | +| APN-Rate-Control-Status-Validity-Time | 4330 | 6.4.40 | Unsigned64 | V | | | M | No | + +NOTE 1: The AVP header bit denoted as "M" indicates whether support of the AVP is required. The AVP header bit denoted as "V" indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [32]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table specifies the Diameter AVPs re-used by the T6a/T6b interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within T6a/T6b. + +Any other AVPs from existing Diameter Applications, except for the AVPs from Diameter Base Protocol, do not need to be supported. The AVPs from Diameter Base Protocol are not included in table 6.4.1-2, but they may be re-used for the T6a/T6b protocol. + +**Table 6.4.1-2: T6a/T6b re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | +|-------------------------------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------| +| Monitoring-Event-Configuration | 3GPP TS 29.336 [5] | This AVP shall contain the monitoring event to be configured at the MME/SGSN or the IWK-SCEF. See 6.4.2. | +| Monitoring-Event-Report | 3GPP TS 29.336 [5] | This AVP shall contain the monitoring event reported by the MME/SGSN or the IWK-SCEF. See 6.4.3. | +| SCEF-Reference-ID | 3GPP TS 29.336 [5] | | +| SCEF-ID | 3GPP TS 29.336 [5] | | +| SCEF-Reference-ID-for-Deletion | 3GPP TS 29.336 [5] | | +| Supported-Features | 3GPP TS 29.229 [4] | | +| Feature-List-ID | 3GPP TS 29.229 [4] | | +| Feature-List | 3GPP TS 29.229 [4] | See 6.4.14 | +| OC-Supported-Features | IETF RFC 7683 [9] | | +| OC-OLR | IETF RFC 7683 [9] | | +| Monitoring-Event-Config-Status | 3GPP TS 29.336 [5] | This AVP shall contain the status of configuration of each monitoring event identified by an SCEF-ID and SCEF-Reference-ID. | +| DRMP | IETF RFC 7944 [15] | see 6.4.15 | +| User-Identifier | 3GPP TS 29.336 [5] | See 6.4.16 | +| Bearer-Identity | 3GPP TS 29.212 [10] | See 6.4.17 | +| Monitoring-Type | 3GPP TS 29.336 [5] | | +| Loss-Of-Connectivity-Reason | 3GPP TS 29.336 [5] | | +| Maximum-Number-of-Reports | 3GPP TS 29.336 [5] | | +| Monitoring-Duration | 3GPP TS 29.336 [5] | | +| Charged-Party | 3GPP TS 32.299 [20] | | +| UE-Reachability-Configuration | 3GPP TS 29.336 [5] | | +| Location-Information-Configuration | 3GPP TS 29.336 [5] | | +| Reachability-Information | 3GPP TS 29.336 [5] | | +| EPS-Location-Information | 3GPP TS 29.272 [16] | | +| Service-Selection | IETF RFC 5778 [21] | See 6.4.20 | +| PDN-Connection-Charging-Id | 3GPP TS 32.299 [22] | | +| Maximum-Retransmission-Time | 3GPP TS 29.338 [27] | | +| Requested-Retransmission-Time | 3GPP TS 29.338 [27] | | +| Maximum-UE-Availability-Time | 3GPP TS 29.338 [27] | | +| 3GPP-Charging-Characteristics | 3GPP TS 29.061 [29] | | +| RAT-Type | 3GPP TS 29.212 [10] | | +| Terminal-Information | 3GPP TS 29.272 [16] | See 6.4.30 | +| Visited-PLMN-Id | 3GPP TS 29.272 [16] | | +| Load | IETF RFC 8583 [31] | | +| Subscribed-Periodic-RAU-TAU-Timer | 3GPP TS 29.272 [16] | | +| Monitoring-Event-Report-Status | 3GPP TS 29.336 [5] | | +| IMSI-Group-Id | 3GPP TS 29.272 [16] | | +| Reporting-Time-Stamp | 3GPP TS 29.336 [5] | | +| eDRX-Cycle-Length | 3GPP TS 29.272 [16] | | +| DL-Buffering-Suggested-Packet-Count | 3GPP TS 29.272 [16] | | +| PDN-Connectivity-Status-Report | 3GPP TS 29.336 [5] | | +| SCEF-Reference-ID-Ext | 3GPP TS 29.336 [5] | | +| SCEF-Reference-ID-for-Deletion-Ext | 3GPP TS 29.336 [5] | | + +### 6.4.2 Monitoring-Event-Configuration + +The Monitoring-Event-Configuration AVP is of type Grouped. It shall contain the Monitoring event configuration related data. It is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Monitoring-Event-Configuration AVP format is specified as following: + +AVP format: + +``` +Monitoring-Event-Configuration ::= + [ SCEF-Reference-ID ] + [ SCEF-Reference-ID-Ext ] + { SCEF-ID } + { Monitoring-Type } + *[ SCEF-Reference-ID-for-Deletion ] + *[ SCEF-Reference-ID-for-Deletion-Ext ] + [ Maximum-Number-of-Reports ] + [ Monitoring-Duration ] + [ Charged-Party ] + [ UE-Reachability-Configuration ] + [ Location-Information-Configuration ] + *[ Number-Of-UE-Per-Location-Configuration ] + *[AVP] +``` + +When the "Extended Reference IDs" feature is supported by the SCEF and MME/SGSN, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used instead of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. + +### 6.4.3 Monitoring-Event-Report + +The Monitoring-Event-Report AVP is of type Grouped. It shall contain the Monitoring event report data. It is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Monitoring-Event-Report AVP format is specified as following: + +AVP format: + +``` +Monitoring-Event-Report ::= + { SCEF-Reference-ID } + [ SCEF-Reference-ID-Ext ] + [ SCEF-ID ] + [ Monitoring-Type ] + [ Reachability-Information ] + [ EPS-Location-Information ] + [ Communication-Failure-Information ] +``` + +\*[ Number-Of-UE-Per-Location-Report ] +[ Loss-Of-Connectivity-Reason ] +[ Visited-PLMN-Id ] +[ Idle-Status-Indication ] +[ Reporting-Time-Stamp ] +[ Maximum-UE-Availability-Time ] +\*[ PDN-Connectivity-Status-Report ] +[ Reachability-Cause ] +\*[AVP] + +The AVPs applicable for each Monitoring-Type reported by the MME/SGSN are specified under clause 5.2.2. + +When the "Extended Reference IDs" feature is supported by the SCEF and MME/SGSN, the SCEF-Reference-ID-Ext AVP shall be used insted of SCEF-Reference-ID; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. + +### 6.4.4 Communication-Failure-Information + +The Communication-Failure-Information AVP is of type Grouped. It shall contain the reason for communication failure. + +AVP format: + +Communication-Failure-Information ::= +[ Cause-Type ] +[ SIAP-Cause ] +[ RANAP-Cause ] +[ BSSGP-Cause ] +[ GMM-Cause ] +[ SM-Cause ] +\*[AVP] + +### 6.4.5 Cause-Type + +The Cause-Type AVP is of type Unsigned32 and it shall identify the type of the SIAP-Cause. The following values are defined: + +RADIO\_NETWORK\_LAYER (0) +TRANSPORT\_LAYER (1) +NAS (2) +PROTOCOL (3) +MISCELLANEOUS (4) + +### 6.4.6 S1AP-Cause + +The S1AP-Cause AVP is of type Unsigned32. It shall contain a non-transparent copy of the S1AP cause code as specified clause 9.2.1.3 of 3GPP TS 36.413 [13]. The RAN cause sub-category of the S1AP-Cause as specified in 3GPP TS 36.413 [13] shall be encoded in the Cause-Type AVP as specified in clause 6.4.5 above. + +### 6.4.7 RANAP-Cause + +The RANAP-Cause AVP is of type Unsigned32. It shall contain the non-transparent copy of the cause value of the RANAP cause code as specified in clause 9.2.1.4 of 3GPP TS 25.413 [11]. + +### 6.4.8 BSSGP-Cause + +The BSSGP-Cause AVP is of type Unsigned32. It shall contain the non-transparent copy of the cause value of the BSSGP "Cause" as specified in clause 11.3.8 in 3GPP TS 48.018 [14]. + +### 6.4.9 GMM-Cause + +The GMM-Cause AVP is of type Unsigned32. It shall contain the GMM cause code as specified in clause 10.5.5.14 of 3GPP TS 24.008 [12]. + +### 6.4.10 SM-Cause + +The SM-Cause AVP is of type Unsigned32. It shall contain the SM cause code as specified in clause 10.5.6.6 and 10.5.6.6A of 3GPP TS 24.008 [12]. + +### 6.4.11 Number-Of-UE-Per-Location-Configuration + +The Number-Of-UE-Per-Location-Configuration AVP is of type Grouped. It shall contain the location information for which the number of UEs needs to be reported by the MME/SGSN. + +AVP format: + +``` +Number-of-UE-Per-Location-Configuration ::= + { EPS-Location-Information } + [ IMSI-Group-Id ] + *[AVP] +``` + +### 6.4.12 Number-Of-UE-Per-Location-Report + +The Number-Of-UE-Per-Location-Report AVP is of type Grouped. It shall contain the location information along with the number of UEs found at that location by the MME/SGSN. + +AVP format: + +``` +Number-of-UE-Per-Location-Report ::= + { EPS-Location-Information } + { UE-Count } + [ IMSI-Group-Id ] + *[AVP] +``` + +### 6.4.13 UE-Count + +The UE-Count AVP is of type Unsigned32. It shall contain the number of UEs counted against a given criteria (say location information). + +### 6.4.14 Feature-List AVP + +#### 6.4.14.1 Feature-List AVP for the T6a/T6b application + +The syntax of this AVP is defined in 3GPP TS 29.229 [4]. + +For the T6a/b application, the meaning of the bits shall be as defined in table 6.4.14.1-1 for the Feature-List-ID. + +**Table 6.4.14.1-1: Features of Feature-List-ID used in T6a/b** + +| Feature bit | Feature | M/O | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | MONTE | O |

Configuration and reporting of monitoring events

This feature is applicable to from an SCEF with CIR/CIA command pair and the reporting of events to the SCEF with RIR/RIA command pair.

If the MME/SGSN does not support this feature, the SCEF shall not send monitoring event configurations to the HSS within CIR.

| +| 1 | NIDD | O |

Support of Non-IP Data service over T6a/b

This feature is applicable to CMR/CMA, ODR/ODA and TDR/TDA command pairs.

If the SCEF does not indicate support of this feature in an CMA, the MME or SGSN may store this information and not send any further CMR commands to that SCEF.

| +| 2 | Filtering | O |

Filtering Number of UEs present at given location by IMSI-Group

This feature is applicable to the CIR/CIA command pair.

If the MME/SGSN does not support this feature, the SCEF shall interpret the reported number of UEs per location as not being filtered by the provided IMSI-Group-Id.

| +| 3 | Extended Reference IDs | O |

Extended Reference IDs

This feature is applicable for the CIR/CIA and RIR/RIA command pairs.

If the SCEF detects that the MME/SGSN does not support this feature, it shall refrain from sending CIR commands containing 64-bit long SCEF Reference IDs.

If the MME/SGSN detects that the SCEF does not support this feature, it shall refrain from sending RIR commands containing 64-bit long SCEF Reference IDs.

| +|

Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "MONTE".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.

| | | | + +### 6.4.15 DRMP + +The DRMP AVP is of type Enumerated and it is defined in IETF RFC 7944 [15]. This AVP allows the MME, the SGSN, the SCEF and the IWK-SCEF to indicate the relative priority of Diameter messages. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +### 6.4.16 User-Identifier + +The User-Identifier AVP is of type Grouped and it contains the different identifiers used by the UE. + +It is defined in 3GPP TS 29.336 [5] + +### 6.4.17 Bearer-Identifier + +The Bearer-Identifier AVP contains either the identity of the EPS bearer used to identify the T6a connection between the MME and the SCEF or the NSAPI of the PDP context identifying the T6b connection between the SGSN and the SCEF. It is defined in 3GPP TS 29.212 [10]. + +### 6.4.18 Connection-Action + +The Connection-Action AVP is of type Unsigned32 and it shall identify the action to be performed on the T6a/b connection. The following values are defined: + +#### CONNECTION\_ESTABLISHMENT (0) + +This value shall be used if the T6a/b Connection-Management-Request applies to a T6a/b connection establishment. + +#### CONNECTION\_RELEASE (1) + +This value shall be used if the T6a/b Connection-Management-Request applies to a T6a/b connection release. + +#### CONNECTION\_UPDATE (2) + +This value shall be used if the T6a/b Connection-Management-Request applies to updating the properties of a T6a/b connection. + +### 6.4.19 Non-IP-Data + +The Non-IP-Data AVP is of type OctetString and it contains the Non-IP data conveyed between the MME or SGSN and the SCEF. + +### 6.4.20 Service-Selection + +The Service-Selection AVP is of type of UTF8String. This AVP shall contain the APN Network Identifier as specified in 3GPP TS 23.003 [24] clause 9.1. + +The contents of the Service-Selection AVP shall be formatted as a character string composed of one or more labels separated by dots ("."). + +This AVP is originally defined in IETF RFC 5778[21]. + +### 6.4.21 Serving-PLMN-Rate-Control + +The Serving-PLMN-Rate-Control AVP is of type Grouped and shall contain. + +The AVP format shall conform to: + +Serving-PLMN-Rate-Control::= + +[ Uplink-Rate-Limit ] + +[ Downlink-Rate-Limit ] + +\*[AVP] + +A Downlink-Rate-Limit set to 0 shall be interpreted that the Serving PLMN Rate Control for downlink messages is deactivated in the MME. If the Serving PLMN Rate Control is activated, the value of Downlink-Rate-Limit shall not be less than 10, see 3GPP TS 23.401 [25]. + +An Uplink-Rate-Limit set at 0 shall be interpreted that the Serving PLMN Rate Control for uplink messages is deactivated in the MME. If Serving PLMN Rate Control is activated, the value of Uplink-Rate-Limit shall not be less than 10, see 3GPP TS 23.401 [25]. + +### 6.4.22 Downlink-Rate-Limit + +The Downlink-Rate-Limit AVP is of type type Unsigned32 and shall contain the maximum number of NAS Data PDUs per deci hour for this UE for downlink. + +### 6.4.23 Uplink-Rate-Limit + +The Uplink-Rate-Limit AVP is of type Unsigned32 and shall contain the maximum number of NAS Data PDUs per deci hour for this UE for uplink. + +### 6.4.24 SCEF-Wait-Time + +The SCEF-Wait-Time is of type Time and it shall contain the timestamp (in UTC) until which the SCEF expects a response. + +### 6.4.25 CMR-Flags + +The CMR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 6.4.25/1: + +**Table 6.4.25/1: CMR-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------------|------------------------|-----------------------------------------------------------------------------------| +| 0 | UE-Reachable-Indicator | This bit if set indicates that the UE has become or is about to become reachable. | +| NOTE 1: Bits not defined in this table shall be cleared by the sending entity and discarded by the receiving entity. | | | + +### 6.4.26 Extended-PCO + +The Extended-PCO AVP is of type OctetString. The Extended-PCO AVP shall contain the value part of the ePCO IE, starting from octet 4, as specified in clause 9.9.4.26 of 3GPP TS 24.301[28]. + +### 6.4.27 RRC-Cause-Counter + +The RRC-Cause-Counter AVP is of type Grouped and shall contain the number of receptions of "MO Exception data" and the time when the cause " MO Exception Data" is received for the first time. + +The AVP format shall conform to: + +``` + +RRC-Cause-Counter ::= + [ Counter-Value ] + [ RRC-Counter-Timestamp ] + *[AVP] + +``` + +### 6.4.28 Counter-Value + +The Counter-Value AVP is of type type Unsigned32 and shall contain the number of occurrences of reception of RRC cause "MO Exception data". + +### 6.4.29 RRC-Counter-Timestamp + +The RRC-Counter-Timestamp AVP is of type Time and shall contain a timestamp. + +### 6.4.30 Terminal-Information + +The Terminal-Information AVP is of type Grouped. This AVP shall contain the information about the user's terminal. It is originally defined in 3GPP TS 29.272 [16]. + +AVP format + +``` +Terminal-Information ::= + [ IMEI ] + [ Software-Version ] + *[ AVP ] +``` + +### 6.4.31 TDA-Flags + +The TDA-Flags AVP is of type Unsigned32 and it shall contain a bit map. The meaning of the bits shall be as defined in table 6.4.31-1: + +**Table 6.4.31-1: TDA-Flags** + +| Bit | Name | Description | +|------|--------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| +| 0 | Acknowledged Delivery | This bit when set indicates that eNodeB has acknowledged the successful downlink NIDD delivery. | +| NOTE | Bits not defined in this table shall be cleared by the sending entity and discarded by the receiving entity. | | + +### 6.4.32 Idle-Status-Indication + +The Idle-Status-Indication AVP is of type Grouped, and it shall contain the details when the UE transitions into idle mode. + +AVP format: + +``` +Idle-Status-Indication ::= + [ Idle-Status-Timestamp ] + [ Active-Time ] + [ Subscribed-Periodic-RAU-TAU-Timer ] + [ eDRX-Cycle-Length ] + [ DL-Buffering-Suggested-Packet-Count ] + *[AVP] +``` + +The Subscribed-Periodic-RAU-TAU-Timer AVP shall contain the periodic TAU/RAU time granted to the UE by the MME/SGSN. + +The eDRX-Cycle-Length AVP shall contain the eDRX cycle length granted to the UE by the MME/SGSN. + +The DL-Buffering-Suggested-Packet-Count AVP shall contain the suggested number of downlink packets sent to the S-GW by the MME/SGSN. + +### 6.4.33 Idle-Status-Timestamp + +The Idle-Status-Timestamp AVP is of type Time and shall contain a timestamp (the time at which the UE transitioned into idle mode). + +### 6.4.34 Active-Time + +Active-Time AVP is of type Unsigned32 and shall provide the active time granted to the UE in seconds. + +### 6.4.35 Reachability-Cause + +The Reachability-Cause AVP is of type Unsigned32. The following values are defined: + +CHANGE\_TO\_CONNECTED\_MODE (0) + +REACHABLE\_FOR\_PAGING (1) + +Annex A (normative): +Diameter overload control mechanism + +### 6.4.36 APN-Rate-Control-Status + +The APN-Rate-Control-Status AVP is of type Grouped. It shall contain APN Rate Control Status Information as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +### 6.4.37 Uplink-Number-Of-Packets-Allowed + +The Uplink-Number-Of-Packets-Allowed AVP is of type Unsigned32. It shall contain information of octets k+1 to k+4 as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +### 6.4.38 Number-Of-Additional-Exception-Reports + +The Number-Of-Additional-Exception-Reports AVP is of type Unsigned32. It shall contain information of octets k+5 to k+8 as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +### 6.4.39 Downlink-Number-Of-Packets-Allowed + +The Downlink-Number-Of-Packets-Allowed AVP is of type Unsigned32. It shall contain information of octets k+9 to k+12 as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +### 6.4.40 APN-Rate-Control-Status-Validity-Time + +The APN-Rate-Control-Status-Validity-Time AVP is of type Unsigned64. It shall contain information of octets k+13 to k+20 as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +## --- A.1 T6a/b and T7 interfaces + +### A.1.1 General + +The Diameter overload control mechanism is an optional feature over the T6a/b and T7 interface, which may be applied to the traffic of requests commands sent to the SCEF and/or to the traffic of request commands sent to the MME or SGSN. + +It is recommended to make use of the IETF RFC 7683 [9] on the T6a/b and T7 interface where: + +- when applied to the traffic of request commands sent to the SCEF, the SCEF shall behave as a reporting node while the MME/SGSN, and as an alternative the IWK-SCEF shall behave as a reacting node; +- when applied to the traffic of request commands sent to the MME or SGSN, the MME or SGSN shall behave as a reporting node while the SCEF, and as an alternative the IWK-SCEF, shall behave as a reacting node. + +### A.1.2 SCEF behaviour + +The SCEF requests traffic reduction from the MME/SGSN and the IWK-SCEF when it is in an overload situation, by including OC-OLR AVP in answer commands as described in IETF RFC 7683 [9]. + +The SCEF identifies that it is in an overload situation by implementation specific means. For example, the SCEF may take into account the traffic over the T6a/b interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources etc. + +The SCEF determines the specific contents of the OC-OLR AVP in overload reports and the SCEF decides when to send OC-OLR AVPs by implementation specific means. + +The SCEF may decide to deactivate Monitoring events to reduce the number of Reporting-Information-Requests sent for reporting monitoring events. + +The SCEF shall apply required traffic reduction according to the OC-OLR AVPs received in answer commands from the MME to subsequent applicable requests, as per IETF RFC 7683 [9]. + +Requested traffic reduction is achieved by the SCEF by implementation specific means. It may in particular implement throttling of MT non-IP data messages. + +### A.1.3 MME/SGSN behaviour + +The MME or SGSN requests traffic reduction from the SCEF when it is in an overload situation, by including OC-OLR AVP in answer commands as described in IETF RFC 7683 [9]. + +The MME or SGSN identifies that it is in an overload situation by implementation specific means. + +The MME or SGSN shall apply required traffic reduction according to the OC-OLR AVPs received in answer commands from the SCEF to subsequent applicable requests, as per IETF RFC 7683 [9]. + +Requested traffic reduction is achieved by the MME or SGSN by implementation-specific means. It may in particular implement: + +- throttling of monitoring event reports or stop reporting with prioritization (e.g. prioritisation on the type of events, or that one-time reporting takes priority over continuous reporting, ...); +- throttling of new T6a/b connection establishment messages; +- throttling of MO non-IP data messages. + +### A.1.4 IWK-SCEF behaviour + +The IWK-SCEF, when acting as a reacting node towards the SCEF shall apply required traffic reduction received in answer commands from the SCEF to subsequent applicable requests received from the MME or SGSN, as per IETF RFC 7683 [9]. In this case the IWK-SCEF does not forward OC-OLR AVPs to the MME or SGSN. + +The IWK-SCEF, when acting as a reacting node towards the MME or SGSN, shall apply required traffic reduction received in answer commands from the MME or SGSN to subsequent applicable requests received from the SCEF, as per IETF RFC 7683 [9]. In this case the IWK-SCEF does not forward OC-OLR AVPs to the SCEF. + +Requested traffic reduction is achieved by the IWK-SCEF by implementation specific means. For example, it may implement throttling of monitoring event report with prioritization, throttling of MO data or MT data messages. + +# --- Annex B (normative): Diameter message priority mechanism + +## B.1 General + +IETF RFC 7944 [15] specifies a Diameter routing message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes may leverage the relative priority of Diameter messages into routing, resource allocation, set the DSCP marking for transport of the associated Diameter message, and also abatement decisions when overload control is applied. + +## --- B.2 T6a, T6ai, T6b, T6bi, T7 interfaces + +The Diameter message priority mechanism is an optional feature which may apply on one or several of the T6a, T6ai, T6b, T6bi, T7 interfaces. + +It is recommended to make use of IETF RFC 7944 [15] over the T6a, T6ai, T6b, T6bi, T7 interfaces of an operator network when the overload control defined in Annex A is applied on these interfaces. + +A 3GPP functional entity supporting the Diameter message priority mechanism over one or several of the T6a, T6ai, T6b, T6bi, T7 interfaces shall comply with IETF RFC 7944 [15]. + +A 3GPP functional entity sending a request shall determine the required priority according to its policies. When priority is required, it shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the request according to the required priority level. + +When the 3GPP functional element receives the corresponding response, it shall prioritise the received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When a 3GPP functional entity receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, it may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, it shall include the DRMP AVP in the response. + +If: + +- a 3GPP functional entity supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the 3GPP functional entity shall set the DSCP marking for transport of the request or response according to the required priority level. + +The decisions of the 3GPP functional entity for a required priority and for the priority level value are implementation specific. + +Diameter requests related to high priority traffic shall contain a DRMP AVP with a high priority of which the level value is operator dependent. + +# Annex C (normative): Diameter load control mechanism + +## C.1 General + +The Diameter load control mechanism is an optional feature over the T6a/b and T7 interface, which may be applied to the traffic of request commands sent to the SCEF and/or to the traffic of request commands sent to the MME/SGSN. + +It is recommended to make use of the IETF RFC 8583 [31] on the T6a/b and T7 interface where: + +- when applied to the traffic of request commands sent to the SCEF, the MME/SGSN, and as an alternative the IWK-SCEF shall behave as a reacting node; +- when applied to the traffic of request commands sent to the MME/SGSN, the SCEF, and as an alternative the IWK-SCEF, shall behave as a reacting node. + +## C.2 SCEF behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the SCEF may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [31]. + +## --- C.3 MME/SGSN behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the MME/SGSN may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [31]. + +## --- C.4 IWK-SCEF behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the IWK-SCEF may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [31]. + +# --- Annex D (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------|--------| +| 2015-05 | | | | | | Skeleton of the TS after CT4#69 | 0.0.0 | +| 2015-11 | | | | | | TS after CT4#71 | 0.1.0 | +| 2015-12 | CT#70 | CP-150625 | | | | Presented for information | 1.0.0 | +| 2016-02 | | | | | | TS after CT4#72 | 1.1.0 | +| 2016-03 | CT#71 | CP-160119 | | | | Presented for approval | 2.0.0 | +| 2016-03 | CT#71 | | | | | Cersion 13.0.0. created after CT#71 | 13.0.0 | +| 2016-06 | CT#72 | CP-160225 | 0001 | 1 | | Correction on Table 6.4.1-2 | 13.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0002 | 2 | | Correction on error handling for SCEF reference ID unknown | 13.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0004 | 1 | | Removing the direct configuration of MONTE events at MME via IWK-SCEF by the SCEF for roaming case | 13.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0008 | 3 | | Overload control update for C IoT | 13.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0011 | 1 | | Corrections on styles | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0003 | - | | Assignment of command codes for C IoT | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0005 | 4 | | Signaling the change of MME to the SCEF for a T6a connection used for SCEF PDN | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0006 | 4 | | Procedures updates and new AVPs over T6a for C IoT | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0007 | 5 | | Connection Action check for CMR | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0009 | 4 | | Routing considerations for C IoT | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0012 | 2 | | Serving PLMN Rate Control | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0013 | 2 | | C IoT support in introduction clause | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0014 | 2 | | MT Non-IP Data Delivery for UEs using a power saving function | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0015 | 2 | | Accept T6 Connection Establishment | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0016 | 4 | | Support for APN Rate Control | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0017 | 1 | | Charging Characteristics | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0018 | 2 | | Corrections in clause 5.6.3 of "Detailed Behaviour of the MME" | 13.1.0 | +| 2016-09 | CT#73 | CP-160427 | 0020 | - | | Adding missing result code | 13.2.0 | +| 2016-09 | CT#73 | CP-160423 | 0021 | 1 | | Correction of Reference for ePCO | 13.2.0 | +| 2016-09 | CT#73 | CP-160423 | 0023 | - | | MT-Data-Request command | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0022 | 3 | | Handling of Exception Reports in the Core Network | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0024 | 1 | | Sending of ePCO during the T6a connection release procedure | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0025 | 1 | | Missing AVP codes and Experimental-Result codes for T6a | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0027 | 1 | | SCEF Behaviour of Rate Control Handling | 13.2.0 | +| 2016-09 | CT#73 | CP-160573 | 0028 | 2 | | Not Able to Deliver MO Non-IP Data | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0029 | 1 | | T6a Connection Release after MO Data Answer with permanent error | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0030 | 2 | | Addition of Serving PLMN ID and IMEISV to CMR | 13.2.0 | +| 2016-09 | CT#73 | CP-160435 | 0031 | 1 | | T6b reference point for NonIP-GPRS | 14.0.0 | +| 2016-12 | CT#74 | CP-160660 | 0033 | 1 | | AVAILABILITY AFTER DDN FAILURE reporting | 14.1.0 | +| 2016-12 | CT#74 | CP-160657 | 0035 | 1 | | Reference Correction | 14.1.0 | +| 2016-12 | CT#74 | CP-160657 | 0038 | 1 | | Missing RRC-Cause-Counter AVP in the MO-Data-Request Command | 14.1.0 | +| 2016-12 | CT#74 | CP-160681 | 0039 | 1 | | Load Control | 14.1.0 | +| 2016-12 | CT#74 | CP-160680 | 0036 | 1 | | Updates to T6b for Non-IP GPRS | 14.1.0 | +| 2016-12 | CT#74 | CP-160664 | 0041 | - | | Correction to change IETF drmp draft version to official RFC 7944 | 14.1.0 | +| 2017-03 | CT#75 | CP-170036 | 0042 | 1 | | Loss Of Connectivity Reason | 14.2.0 | +| 2017-03 | CT#75 | CP-170036 | 0045 | - | | Failed-AVP AVP in Request Commands | 14.2.0 | +| 2017-03 | CT#75 | CP-170036 | 0046 | 1 | | Bit ordering in Diameter AVPs used as bit-masks | 14.2.0 | +| 2017-03 | CT#75 | CP-170039 | 0043 | 1 | | RAT-Type Change | 14.2.0 | +| 2017-03 | CT#75 | CP-170039 | 0044 | 1 | | SCEF Initiated T6 Release | 14.2.0 | +| 2017-03 | CT#75 | CP-170029 | 0048 | 1 | | Maximum UE Availability Time | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0049 | 1 | | Update of reference for the Diameter base protocol | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0050 | - | | Handling of the Vendor-Specific-Application-Id AVP | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0051 | - | | Cardinality of the Failed-AVP AVP in answer | 14.2.0 | +| 2017-03 | CT#75 | CP-170047 | 0052 | - | | Removal of Editor's Note on ePCO | 14.2.0 | +| 2017-06 | CT#76 | CP-171029 | 0053 | 2 | | User Identify in RIR | 14.3.0 | +| 2017-06 | CT#76 | CP-171018 | 0055 | 1 | | Support for signaling transport level packet marking | 14.3.0 | +| 2017-09 | CT#77 | CP-172018 | 0056 | 1 | | Reliable Data Service Success cause | 14.4.0 | +| 2017-09 | CT#77 | CP-172013 | 0060 | - | | Correction of DRMP Procedures | 14.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------|--------| +| 2017-09 | CT#77 | CP-172026 | 0057 | 2 | | Enhancements for NAPS on Idle Status Indication | 15.0.0 | +| 2017-09 | CT#77 | CP-172026 | 0061 | - | | Enhancements for NAPS on Accuracy | 15.0.0 | +| 2017-12 | CT#78 | CP-173017 | 0065 | 1 | | Fixing the R Bit in T6a Requests | 15.1.0 | +| 2017-12 | CT#78 | CP-173028 | 0062 | 2 | | Monitoring Event Report Status | 15.1.0 | +| 2018-03 | CT#79 | CP-180025 | 0066 | 1 | | Filtering the Report for Number of UEs in a Geographic Area | 15.2.0 | +| 2018-06 | CT#80 | CP-181130 | 0067 | 1 | | Local deletion of Monitoring events | 15.3.0 | +| 2018-12 | CT#82 | CP-183095 | 0068 | 3 | | Monitoring event report | 15.4.0 | +| 2018-12 | CT#82 | CP-183098 | 0069 | - | | Missing parameters in IdleStatusIndication | 15.4.0 | +| 2019-03 | CT#83 | CP-190038 | 0070 | - | | Missing Maximum-UE-Availability-Time AVP | 15.5.0 | +| 2019-09 | CT#85 | CP-192094 | 0074 | 2 | | draft-ietf-dime-load published as RFC 8583 | 15.6.0 | +| 2019-09 | CT#85 | CP-192122 | 0072 | 1 | | Event type PDN Connectivity Status | 16.0.0 | +| 2020-03 | CT#87e | CP-200050 | 0075 | - | | Reachability Cause | 16.1.0 | +| 2020-12 | CT#90e | CP-203032 | 0076 | - | | Extended Reference ID | 16.2.0 | +| 2021-06 | CT#92e | CP-211072 | 0077 | 1 | | Idle Status Indication | 16.3.0 | +| 2021-09 | CT#93e | CP-212073 | 0078 | 1 | F | APN Rate Control Status | 16.4.0 | +| 2021-09 | CT#93e | CP-212077 | 0079 | - | F | Correction on NIDD Feature | 16.4.0 | +| 2021-12 | | | | | | History table fixed | 16.4.1 | +| 2022-03 | CT#95e | CP-220077 | 0080 | - | F | Correction to wrong CR implementation | 16.5.0 | +| 2022-04 | - | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 | +| 2022-12 | CT#98e | CP-223071 | 0082 | - | A | Idle Status Indication | 17.1.0 | +| 2023-03 | CT#99 | CP-230054 | 0083 | - | F | Monitoring Event Configuration for roaming | 18.0.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29165/raw.md b/raw/rel-18/29_series/29165/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..04fd61d54fef5211e243de414cbd3f76947d7906 --- /dev/null +++ b/raw/rel-18/29_series/29165/raw.md @@ -0,0 +1,6153 @@ + + +# 3GPP TS 29.165 V18.2.0 (2023-09) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Inter-IMS Network to Network Interface (NNI) (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green wave-like graphic above it, and the word 'ADVANCED' in smaller black letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'G' has a red signal icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +## Keywords + +IMS, LTE, Interconnection, II-NNI, IBCF, TrGW + +## **3GPP** + +Postal address + +3GPP support office address +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + + +## **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +## Contents + +| | | +|---------------------------------------------------------------------------------------------------|----| +| Foreword..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions, symbols and abbreviations..... | 17 | +| 3.1 Definitions..... | 17 | +| 3.2 Symbols..... | 18 | +| 3.3 Abbreviations..... | 18 | +| 4 Overview..... | 20 | +| 5 Reference model for interconnection between IM CN subsystems..... | 22 | +| 5.1 General..... | 22 | +| 5.2 Functionalities performed by entities at the edge of the network..... | 23 | +| 5.2.1 Interconnection Border Control Function (IBCF)..... | 23 | +| 5.2.2 Transition Gateway (TrGW)..... | 24 | +| 5.3 Identifying II-NNI traversal scenario..... | 24 | +| 5.3.1 General..... | 24 | +| 5.3.2 Mapping of the "iotl" SIP URI parameter to II-NNI traversal scenario..... | 24 | +| 6 Control plane interconnection..... | 25 | +| 6.1 Definition of Inter-IMS Network to Network Interconnection..... | 25 | +| 6.1.1 SIP methods and header fields..... | 25 | +| 6.1.1.1 General..... | 25 | +| 6.1.1.2 SIP methods..... | 25 | +| 6.1.1.3 SIP header fields..... | 26 | +| 6.1.1.3.0 General..... | 26 | +| 6.1.1.3.1 Trust and no trust relationship..... | 26 | +| 6.1.1.3.2 Derivation of applicable SIP header fields from 3GPP TS 24.229 [5]..... | 28 | +| 6.1.1.3.3 Applicability of SIP header fields on a roaming II-NNI..... | 28 | +| 6.1.1.3.4 Applicability of SIP header fields on a non-roaming II-NNI..... | 29 | +| 6.1.1.4 Notations of the codes..... | 29 | +| 6.1.1.5 Modes of signalling..... | 30 | +| 6.1.2 SDP protocol..... | 30 | +| 6.1.2.1 General..... | 30 | +| 6.1.3 Major capabilities..... | 30 | +| 6.1.4 SIP message bodies..... | 36 | +| 6.2 Control Plane Transport..... | 40 | +| 6.2.1 General..... | 40 | +| 6.3 SIP timers..... | 40 | +| 7 User plane Interconnection..... | 42 | +| 7.1 Media and Codec..... | 42 | +| 7.2 User Plane Transport..... | 42 | +| 8 Numbering, Naming and Addressing..... | 43 | +| 8.1 Numbering, Naming and Addressing for SIP message..... | 43 | +| 8.2 Numbering, Naming and Addressing for SDP..... | 44 | +| 9 IP Version..... | 44 | +| 10 Security..... | 44 | +| 11 Charging..... | 44 | +| 11.1 General..... | 44 | +| 11.2 Inter-operator accounting..... | 45 | +| 11.3 Transfer of IP multimedia service tariff information..... | 45 | +| 12 Supplementary services associated with the IMS multimedia telephony communication service..... | 46 | +| 12.1 General..... | 46 | + +| | | | +|---------|----------------------------------------------------------------------------------------------------------|----| +| 12.2 | Malicious Communication IDentification (MCID)..... | 46 | +| 12.3 | Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR)..... | 47 | +| 12.4 | Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR)..... | 47 | +| 12.5 | Anonymous Communication Rejection (ACR)..... | 47 | +| 12.6 | Communication DIVersion (CDIV)..... | 48 | +| 12.7 | Communication Waiting (CW)..... | 48 | +| 12.8 | Communication HOLD (HOLD)..... | 48 | +| 12.9 | Message Waiting Indication (MWI)..... | 48 | +| 12.10 | Communication Barring (CB)..... | 49 | +| 12.10.1 | Incoming Communication Barring (ICB)..... | 49 | +| 12.10.2 | Outgoing Communication Barring (OCB)..... | 49 | +| 12.11 | Completion of Communications to Busy Subscriber (CCBS)..... | 49 | +| 12.12 | Completion of Communications by No Reply (CCNR)..... | 50 | +| 12.13 | Explicit Communication Transfer (ECT)..... | 50 | +| 12.13.1 | Consultative and blind transfer..... | 50 | +| 12.13.2 | Assured transfer..... | 51 | +| 12.14 | Customized Alerting Tone (CAT)..... | 51 | +| 12.15 | Customized Ringing Signal (CRS)..... | 51 | +| 12.16 | Closed User Group (CUG)..... | 52 | +| 12.17 | Personal Network Management (PNM)..... | 52 | +| 12.18 | Three-Party (3PTY)..... | 52 | +| 12.19 | Conference (CONF)..... | 53 | +| 12.20 | Flexible Alerting (FA)..... | 53 | +| 12.21 | Announcements..... | 54 | +| 12.21.1 | General..... | 54 | +| 12.21.2 | Providing announcements during the establishment of a communication session..... | 54 | +| 12.21.3 | Providing announcements during an established communication session..... | 54 | +| 12.21.4 | Providing announcements when communication request is rejected..... | 54 | +| 12.22 | Advice Of Charge (AOC)..... | 55 | +| 12.23 | Completion of Communications on Not Logged-in (CCNL)..... | 55 | +| 12.24 | Unstructured Supplementary Service Data (USSD)..... | 56 | +| 12.25 | Enhanced Calling Name (eCNAM)..... | 56 | +| 12.26 | Multi-Device and Multi-Identity (MuD and MiD)..... | 56 | +| 12.26.1 | Multi-Device (MuD)..... | 56 | +| 12.26.2 | Multi-Identity (MiD)..... | 56 | +| 13 | Interoperability of IMS Centralized Services (ICS) over II-NNI..... | 57 | +| 13.1 | General..... | 57 | +| 13.2 | IMS Centralized Services (ICS)..... | 57 | +| 14 | Interoperability of IMS Service Continuity over II-NNI..... | 58 | +| 14.1 | General..... | 58 | +| 14.2 | PS to CS Single Radio Voice Call Continuity (SRVCC) and Single Radio Video Call Continuity (vSRVCC)..... | 58 | +| 14.2.1 | Basic PS to CS SRVCC..... | 58 | +| 14.2.2 | PS to CS SRVCC for calls in alerting phase..... | 58 | +| 14.2.3 | Using the ATCF based architecture..... | 59 | +| 14.2.4 | PS to CS SRVCC for originating calls in pre-alerting phase..... | 59 | +| 14.2.5 | PS to CS SRVCC with the MSC server assisted mid-call feature..... | 59 | +| 14.2.6 | PS to CS SRVCC for terminating calls in pre-alerting phase..... | 59 | +| 14.3 | Inter UE Transfer (IUT)..... | 59 | +| 14.4 | MSC server assisted mid-call feature..... | 60 | +| 14.5 | CS to PS Single Radio Voice Call Continuity (SRVCC)..... | 61 | +| 14.5.1 | Basic CS to PS SRVCC..... | 61 | +| 14.5.2 | CS to PS SRVCC for calls in alerting phase..... | 61 | +| 14.5.3 | CS to PS SRVCC with the assisted mid-call feature..... | 61 | +| 14.6 | PS to CS dual radio voice call continuity (DRVCC)..... | 61 | +| 14.6.1 | Basic PS to CS DRVCC..... | 61 | +| 14.6.2 | PS to CS DRVCC with the assisted mid-call feature..... | 62 | +| 14.6.3 | PS to CS DRVCC for calls in alerting phase..... | 62 | +| 14.6.4 | PS to CS DRVCC for originating calls in pre-alerting phase..... | 62 | +| 14.7 | CS to PS Dual Radio Voice Call Continuity (DRVCC)..... | 62 | + +| | | | +|--------|--------------------------------------------------------------------------------|----| +| 14.7.1 | Basic CS to PS DRVCC..... | 62 | +| 14.7.2 | CS to PS DRVCC with the assisted mid-call feature..... | 63 | +| 14.7.3 | CS to PS DRVCC for calls in alerting phase..... | 63 | +| 14.7.4 | CS to PS DRVCC for originating calls in pre-alerting phase..... | 63 | +| 14.8 | PS to PS access transfer..... | 63 | +| 15 | Presence service..... | 64 | +| 15.0 | General..... | 64 | +| 15.1 | Subscription of presence information..... | 64 | +| 15.2 | Watcher subscribing to Presence List..... | 64 | +| 15.3 | Subscription to Watcher Information..... | 65 | +| 15.4 | Subscription to state changes in XML documents..... | 65 | +| 15.5 | Presence enhancements specified in Open Mobile Alliance (OMA) Release 1.1..... | 65 | +| 15.5.1 | General..... | 65 | +| 15.5.2 | OMA subscription of presence information..... | 65 | +| 15.5.3 | OMA watcher subscribing to Presence List..... | 65 | +| 15.5.4 | OMA subscription to Watcher Information..... | 66 | +| 15.6 | Presence enhancements specified in Open Mobile Alliance (OMA) Release 2.0..... | 66 | +| 15.6.1 | General..... | 66 | +| 15.6.2 | OMA subscription of presence information..... | 66 | +| 15.6.3 | OMA watcher subscribing to Presence List..... | 66 | +| 15.6.4 | OMA subscription to Watcher Information..... | 67 | +| 15.6.5 | Subscription to state changes in XML documents..... | 67 | +| 15.6.6 | Void..... | 67 | +| 15.6.7 | Void..... | 67 | +| 16 | Messaging service..... | 67 | +| 16.1 | General..... | 67 | +| 16.2 | Page-mode messaging..... | 68 | +| 16.4 | Session-mode messaging..... | 68 | +| 16.5 | Session-mode messaging conferences..... | 68 | +| 17 | Optimal Media Routeing..... | 69 | +| 17.1 | General..... | 69 | +| 17.2 | OMR related SDP attributes..... | 69 | +| 17.3 | IP realm names..... | 69 | +| 18 | Inter-UE transfer (IUT)..... | 69 | +| 18.1 | General..... | 69 | +| 18.2 | IUT without establishment of a collaborative session..... | 69 | +| 18.3 | IUT using a collaborative session..... | 70 | +| 18.3.1 | Collaborative session of participants of the same subscription..... | 70 | +| 18.3.2 | Establishment of a collaborative session during session setup..... | 70 | +| 18.3.3 | Assignment and transfer of control of a collaborative session..... | 71 | +| 18.3.4 | Collaborative session of participants of different subscriptions..... | 71 | +| 18.4 | Session replication / media replication..... | 71 | +| 18.4.1 | Pull mode..... | 71 | +| 18.4.2 | Push mode..... | 71 | +| 19 | Roaming Architecture for Voice over IMS with Local Breakout..... | 72 | +| 20 | Delivery of Media Resource Broker address information..... | 72 | +| 21 | Overload control..... | 72 | +| 21.1 | General..... | 72 | +| 21.2 | Feedback based mechanism..... | 73 | +| 21.3 | The load filter mechanism..... | 73 | +| 22 | Delivery of original destination identity..... | 73 | +| 23 | Telepresence using IMS..... | 73 | +| 24 | Barring of premium rate numbers..... | 74 | +| 25 | P-CSCF restoration..... | 74 | +| 25.1 | General..... | 74 | + +| | | | +|----------|-------------------------------------------------------------------------------------------|----| +| 25.2 | PCRF or PCF based P-CSCF restoration..... | 74 | +| 25.3 | HSS or UDM/HSS based P-CSCF restoration..... | 74 | +| 26 | Resource sharing..... | 74 | +| 27 | Service access number translation..... | 75 | +| 28 | Mission critical services..... | 75 | +| 28.1 | General..... | 75 | +| 28.2 | Interoperability of mission critical services for communication over II-NNI..... | 76 | +| 28.2.1 | Mission Critical services session establishment..... | 76 | +| 28.2.2 | MBMS transmission usage and location procedures..... | 77 | +| 28.2.3 | Affiliation procedure..... | 78 | +| 28.2.3.1 | General..... | 78 | +| 28.2.3.2 | Mandatory mode..... | 78 | +| 28.2.3.3 | Negotiated mode..... | 79 | +| 28.2.4 | Conference event package subscription..... | 79 | +| 28.2.5 | Mission critical services settings..... | 79 | +| 28.2.6 | Registration procedures..... | 80 | +| 28.2.7 | Group regrouping..... | 80 | +| 28.2.8 | Signalling plane messages for mission critical data..... | 81 | +| 28.2.9 | Functional alias management procedure..... | 81 | +| 29 | Calling number verification using signature verification and attestation information..... | 81 | +| 30 | IMS emergency service..... | 82 | +| 30.1 | IMS emergency registration..... | 82 | +| 30.2 | IMS emergency session..... | 82 | +| 30.3 | Next-Generation Pan-European eCall emergency service..... | 82 | +| 31 | Restricted Local Operator Services (RLOS)..... | 83 | +| 32 | 3GPP PS data off extension..... | 83 | +| 33 | MTSI Data channel..... | 83 | +| 34 | Support for signed attestation for emergency and priority IMS sessions..... | 83 | +| 34.1 | General..... | 83 | +| 34.2 | Calling number verification using signature verification and attestation information..... | 84 | +| 34.3 | Priority verification using assertion of priority information..... | 84 | + +| | | +|----------------------------------------------------------------------------------------------------|------------| +| Annex A (informative): Summary of SIP header fields..... | 84 | +| Annex B (informative): Dynamic view of SIP header fields within SIP messages..... | 89 | +| B.1 Scope..... | 89 | +| B.2 Methodology..... | 89 | +| B.3 ACK method..... | 91 | +| B.4 BYE method..... | 92 | +| B.5 CANCEL method..... | 95 | +| B.6 INFO method..... | 96 | +| B.7 INVITE method..... | 100 | +| B.8 MESSAGE method..... | 106 | +| B.9 NOTIFY method..... | 110 | +| B.10 OPTIONS method..... | 112 | +| B.11 PRACK method..... | 116 | +| B.12 PUBLISH method..... | 119 | +| B.13 REFER method..... | 123 | +| B.14 REGISTER method..... | 126 | +| B.15 SUBSCRIBE method..... | 129 | +| B.16 UPDATE method..... | 133 | +| Annex C (informative): The list of option items for II-NNI..... | 137 | +| C.1 Scope..... | 137 | +| C.2 Format of option item table..... | 137 | +| C.3 Option item table..... | 137 | +| C.3.0 Supported II-NNI traversal scenarios..... | 137 | +| C.3.1 Option item table common to roaming, non-roaming II-NNI and loopback traversal scenario..... | 138 | +| C.3.2 Option item table specific to roaming II-NNI..... | 147 | +| C.3.3 Option item table specific to non-roaming II-NNI and loopback traversal scenario..... | 151 | +| Annex D (informative): Change history..... | 155 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd 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. + +# 1 Scope + +The objective of this document is to address the Inter-IMS Network to Network Interface (II-NNI) consisting of Ici and Izi reference points between IMS networks in order to support end-to-end service interoperability. + +The present document addresses the issues related to control plane signalling (3GPP usage of SIP and SDP protocols, required SIP header fields) as well as other interconnecting aspects like security, numbering/naming/addressing and user plane issues as transport protocol, media and codecs actually covered in a widespread set of 3GPP specifications. A profiling of the Inter-IMS Network to Network Interface (II-NNI) is also provided. + +Charging aspects are addressed as far as SIP signalling is concerned. + +IMS emergency session establishment between IMS networks is addressed as far as SIP signalling is concerned. + +SIP signalling traversing the NNI between a CSCF and MRB, e.g. for media control or Voice Interworking with Enterprise IP-PBX, and SIP signalling traversing the NNI on the Mr interface between the CSCF and the MRFC, or on the Mr' interface between the AS and MRFC, or on the Rc interface between AS and MRB is not considered in the present release of this specification. + +SIP signalling traversing the NNI between an application server and the remaining IMS functional entities (e.g. for MCPTT interface SIP-2 in figure 7.3.1-2 in 3GPP TS 23.280 [200]) is not considered in the present release of this specification. + +SIP signalling traversing the NNI between an ISC gateway and an AS in an enterprise network, e.g. for media control and voice interworking with enterprise IP-PBX, on the ISC interface between the ISC gateway and the enterprise network is not considered in the present release of this specification. + +# 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] IETF RFC 791: "Internet Protocol". +- [3] 3GPP TS 23.002: "Network architecture". +- [4] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [5] 3GPP TS 24.229: "Internet Protocol (IP) multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [6] 3GPP TR 24.930: "Signalling flows for the session setup in the IP Multimedia core network Subsystem (IMS) based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [7] IETF RFC 2460: "Internet Protocol, Version 6 (IPv6) Specification". +- [8] 3GPP TS 29.162: "Interworking between the IM CN subsystem and IP networks". +- [9] 3GPP TS 22.228: "Service requirements for the IP multimedia core network subsystem". +- [10] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". + +- [11] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [12] ETSI TS 181 005 V1.1.1: "Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN); Services and Capabilities Requirements". +- [13] IETF RFC 3261: "SIP: Session Initiation Protocol". +- [14] IETF RFC 3966: "The tel URI for Telephone Numbers". +- [15] IETF RFC 3860: "Common Profile for Instant Messaging (CPIM)". +- [16] IETF RFC 3859: "Common Profile for Presence (CPP)". +- [17] IETF RFC 4975: "The Message Session Relay Protocol (MSRP)". +- [18] IETF RFC 3262: "Reliability of provisional responses in Session Initiation Protocol (SIP)". +- [19] IETF RFC 3428: "Session Initiation Protocol (SIP) Extension for Instant Messaging". +- [20] IETF RFC 6665: "SIP-Specific Event Notification". + +NOTE: In earlier releases of this document the predecessor IETF RFC 3265 is used. + +- [21] IETF RFC 3903: "An Event State Publication Extension to the Session Initiation Protocol (SIP)". +- [22] IETF RFC 3515: "The Session Initiation Protocol (SIP) REFER method". +- [23] IETF RFC 3311: "The Session Initiation Protocol (SIP) UPDATE method". +- [24] IETF RFC 7315: "Private Header (P-Header) Extensions to the Session Initiation Protocol (SIP) for the 3GPP". +- [24A] IETF RFC 7976: "Updates to Private Header (P-Header) Extension Usage in Session Initiation Protocol (SIP) Requests and Responses". +- [24B] IETF RFC 7913: "P-Access-Network-Info ABNF Update". +- [25] IETF RFC 7044: "An Extension to the Session Initiation Protocol (SIP) for Request History Information". +- [26] IETF RFC 6050: "A Session Initiation Protocol (SIP) Extension for the Identification of Services". +- [27] IETF RFC 4168: "The Stream Control Transmission Protocol (SCTP) as a Transport for the Session Initiation Protocol (SIP)". +- [28] Void. +- [29] 3GPP TS 32.260: "Telecommunication management; Charging management; IP Multimedia Subsystem (IMS) charging". +- [30] 3GPP TS 22.173: "IP Multimedia Core Network Subsystem (IMS); Multimedia Telephony Service and supplementary services; Stage 1". +- [31] 3GPP TS 24.173: "IMS multimedia telephony communication service and supplementary services; Stage 3". +- [32] 3GPP TS 24.607: "Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) using IP Multimedia (IM); Core Network (CN) subsystem". +- [33] 3GPP TS 24.616: "Malicious Communication Identification (MCID) using IP Multimedia (IM) Core Network (CN) subsystem". +- [34] IETF RFC 3323: "A Privacy Mechanism for the Session Initiation Protocol (SIP)". +- [35] 3GPP TS 23.003: "Numbering, addressing and identification". + +- [36] 3GPP TS 24.610: "Communication HOLD (HOLD) using IP Multimedia (IM) Core Network (CN) subsystem". +- [37] 3GPP TS 24.615: "Communication Waiting (CW) using IP Multimedia (IM) Core Network (CN) subsystem". +- [38] 3GPP TS 24.628: "Common Basic Communication procedures using IP Multimedia (IM) Core Network (CN) subsystem". +- [39] IETF RFC 6086: "Session Initiation Protocol (SIP) INFO Method and Package Framework". +- [40] IETF RFC 3312: "Integration of resource management and Session Initiation Protocol (SIP)". +- [41] IETF RFC 4032: "Update to the Session Initiation Protocol (SIP) Preconditions Framework". +- [42] IETF RFC 3313: "Private Session Initiation Protocol (SIP) Extensions for Media Authorization". +- [43] IETF RFC 3327: "Session Initiation Protocol Extension Header Field for Registering Non-Adjacent Contacts". +- [44] IETF RFC 3325: "Private Extensions to the Session Initiation Protocol (SIP) for Network Asserted Identity within Trusted Networks". +- [45] IETF RFC 3608: "Session Initiation Protocol (SIP) Extension Header Field for Service Route Discovery During Registration". +- [46] IETF RFC 3486: "Compressing the Session Initiation Protocol (SIP)". +- [47] IETF RFC 3329: "Security Mechanism Agreement for the Session Initiation Protocol (SIP)". +- [48] IETF RFC 3326: "The Reason Header Field for the Session Initiation Protocol (SIP)". +- [49] IETF RFC 6432: "Carrying Q.850 Codes in Reason Header Fields in SIP (Session Initiation Protocol) Responses". +- [50] IETF RFC 3581: "An Extension to the Session Initiation Protocol (SIP) for Symmetric Response Routing". +- [51] IETF RFC 3841: "Caller Preferences for the Session Initiation Protocol (SIP)". +- [52] IETF RFC 4028: "Session Timers in the Session Initiation Protocol (SIP)". +- [53] IETF RFC 3892: "The Session Initiation Protocol (SIP) Referred-By Mechanism". +- [54] IETF RFC 3891: "The Session Initiation Protocol (SIP) 'Replaces' Header". +- [55] IETF RFC 3911: "The Session Initiation Protocol (SIP) 'Join' Header". +- [56] IETF RFC 3840: "Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)". +- [57] IETF RFC 5079: "Rejecting Anonymous Requests in the Session Initiation Protocol (SIP)". +- [58] IETF RFC 4458: "Session Initiation Protocol (SIP) URIs for Applications such as Voicemail and Interactive Voice Response (IVR)". +- [59] IETF RFC 4320: "Actions Addressing Identified Issues with the Session Initiation Protocol's (SIP) Non-INVITE Transaction". +- [60] IETF RFC 4457: "The Session Initiation Protocol (SIP) P-User-Database Private-Header (P-header)". +- [61] IETF RFC 5031: "A Uniform Resource Name (URN) for Emergency and Other Well-Known Services". +- [62] IETF RFC 5627: "Obtaining and Using Globally Routable User Agent (UA) URIs (GRUU) in the Session Initiation Protocol (SIP)". + +- [63] Void. +- [64] IETF RFC 5002: "The Session Initiation Protocol (SIP) P-Profile-Key Private Header (P-Header)". +- [65] IETF RFC 5626: "Managing Client-Initiated Connections in the Session Initiation Protocol (SIP)". +- [66] IETF RFC 5768: "Indicating Support for Interactive Connectivity Establishment (ICE) in the Session Initiation Protocol (SIP)". +- [67] IETF RFC 5365: "Multiple-Recipient MESSAGE Requests in the Session Initiation Protocol (SIP)". +- [68] IETF RFC 6442: "Location Conveyance for the Session Initiation Protocol". +- [69] IETF RFC 5368: "Referring to Multiple Resources in the Session Initiation Protocol (SIP)". +- [70] IETF RFC 5366: "Conference Establishment Using Request-Contained Lists in the Session Initiation Protocol (SIP)". +- [71] IETF RFC 5367: "Subscriptions to Request-Contained Resource Lists in the Session Initiation Protocol (SIP)". +- [72] IETF RFC 4967: "Dial String Parameter for the Session Initiation Protocol Uniform Resource Identifier". +- [73] IETF RFC 4964: "The P-Answer-State Header Extension to the Session Initiation Protocol for the Open Mobile Alliance Push to Talk over Cellular". +- [74] IETF RFC 5009: "Private Header (P-Header) Extension to the Session Initiation Protocol (SIP) for Authorization of Early Media". +- [75] IETF RFC 4694: "Number Portability Parameters for the 'tel' URI". +- [76] Void. +- [77] IETF RFC 4411: "Extending the Session Initiation Protocol (SIP) Reason Header for Preemption Events". +- [78] IETF RFC 4412: "Communications Resource Priority for the Session Initiation Protocol (SIP)". +- [79] IETF RFC 5393: "Addressing an Amplification Vulnerability in Session Initiation Protocol (SIP) Forking Proxies". +- [80] IETF RFC 5049: "Applying Signaling Compression (SigComp) to the Session Initiation Protocol (SIP)". +- [81] IETF RFC 5688: "A Session Initiation Protocol (SIP) Media Feature Tag for MIME Application Sub-Types". +- [82] IETF RFC 5360: "A Framework for Consent-Based Communications in the Session Initiation Protocol (SIP)". +- [83] IETF RFC 7433: "A Mechanism for Transporting User-to-User Call Control Information in SIP". +- [83A] IETF RFC 7434: "Interworking ISDN Call Control User Information with SIP". +- [84] IETF RFC 7316: "The Session Initiation Protocol (SIP) P-Private-Network-Indication Private Header (P-Header)". +- [85] IETF RFC 5502: "The SIP P-Served-User Private-Header (P-Header) for the 3GPP IP Multimedia (IM) Core Network (CN) Subsystem". +- [86] Void. +- [87] IETF RFC 8497: "Marking SIP Messages to Be Logged". +- [88] IETF RFC 6228: "Response Code for Indication of Terminated Dialog". + +- [89] IETF RFC 5621: "Message Body Handling in the Session Initiation Protocol (SIP)". +- [90] IETF RFC 6223: "Indication of support for keep-alive". +- [91] IETF RFC 5552: "SIP Interface to VoiceXML Media Services". +- [92] IETF RFC 3862: "Common Presence and Instant Messaging (CPIM): Message Format". +- [93] IETF RFC 5438: "Instant Message Disposition Notification". +- [94] IETF RFC 5373: "Requesting Answering Modes for the Session Initiation Protocol (SIP)". +- [95] Void. +- [96] IETF RFC 3959: "The Early Session Disposition Type for the Session Initiation Protocol (SIP)". +- [97] Void. +- [98] 3GPP TS 24.183: "Customized Ringing Signal (CRS) using IP Multimedia (IM) Core Network (CN) subsystem". +- [99] 3GPP TS 24.259: "Personal Network Management (PNM) using IP Multimedia (IM) Core Network (CN) subsystem". +- [100] 3GPP TS 24.238: "Session Initiation Protocol (SIP) based user configuration". +- [101] 3GPP TS 24.239: "Flexible Alerting (FA) using IP Multimedia (IM) Core Network (CN) subsystem". +- [102] Void. +- [103] 3GPP TS 24.654: "Closed User Group (CUG) using IP Multimedia (IM) Core Network (CN) subsystem". +- [104] Void. +- [105] 3GPP TS 24.605: "Conference (CONF) using IP Multimedia (IM) Core Network (CN) subsystem". +- [106] 3GPP TS 24.147: "Conferencing using the IP Multimedia (IM) Core Network (CN) subsystem". +- [107] Void. +- [108] Void. +- [109] 3GPP TS 24.642: "Completion of Communications to Busy Subscriber (CCBS) Completion of Communications by No Reply (CCNR) using IP Multimedia (IM) Core Network (CN) subsystem". +- [110] Void. +- [111] Void. +- [112] 3GPP TS 24.606: "Message Waiting Indication (MWI) using IP Multimedia (IM) Core Network (CN) subsystem". +- [113] 3GPP TS 24.608: "Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) using IP Multimedia (IM); Core Network (CN) subsystem". +- [114] 3GPP TS 24.611: "Communication Barring (CB) using IP Multimedia (IM); Core Network (CN) subsystem". +- [115] Void. +- [116] 3GPP TS 24.629: "Explicit Communication Transfer (ECT) using IP Multimedia (IM) Core Network (CN) subsystem". + +- [117] 3GPP TS 24.604: "Communication DIVersion (CDIV) using IP Multimedia (IM) Core Network (CN) subsystem". +- [118] Void. +- [119] Void. +- [120] 3GPP TS 23.292: "IP Multimedia Subsystem (IMS) Centralized Services; Stage 2". +- [121] 3GPP TS 24.292: "IP Multimedia Core Network subsystem Centralized Services (ICS); Stage 3". +- [122] 3GPP TS 24.647: "Advice Of Charge (AOC) using IP Multimedia (IM) Core Network (CN) subsystem". +- [123] Void. +- [124] IETF RFC 7989: "End-to-End Session Identification in IP-Based Multimedia Communication Networks". +- [125] IETF RFC 6026: "Correct Transaction Handling for 2xx Responses to Session Initiation Protocol (SIP) INVITE Requests". +- [126] IETF RFC 5658: "Addressing Record-Route issues in the Session Initiation Protocol (SIP)". +- [127] IETF RFC 5954: "Essential correction for IPv6 ABNF and URI comparison in RFC3261". +- [128] Void. +- [129] 3GPP TS 24.182: "IP Multimedia Subsystem (IMS) Customized Alerting Tones (CAT)". +- [130] 3GPP TS 29.292: "Interworking between the IP Multimedia (IM) Core Network (CN) subsystem and MSC Server for IMS Centralized Services (ICS)". +- [131] 3GPP TS 24.237: "IP Multimedia (IM) Core Network (CN) subsystem; IP Multimedia Subsystem (IMS) Service Continuity". +- [132] 3GPP TS 24.141: "Presence service using the IP Multimedia (IM) Core Network (CN) subsystem". +- [133] IETF RFC 6794: "A Framework for Session Initiation Protocol (SIP) Session Policies". +- [134] IETF RFC 5875: "An Extensible Markup Language (XML) Configuration Access Protocol (XCAP) Diff Event Package". +- [135] IETF RFC 4488: "Suppression of Session Initiation Protocol (SIP) REFER Method Implicit Subscription". +- [136] IETF RFC 7462: "URNs for the Alert-Info Header Field of the Session Initiation Protocol (SIP)". +- [137] Void. +- [138] OMA-TS-Presence\_SIMPLE-V2\_0-20120710-A: "Presence SIMPLE Specification". +- [139] 3GPP TS 24.247: "Messaging service using the IP Multimedia (IM) Core Network (CN) subsystem". +- [140] IETF RFC 4538: "Request Authorization through Dialog Identification in the Session Initiation Protocol (SIP)". +- [141] IETF RFC 5318: "The Session Initiation Protocol (SIP) P-Refused-URI-List Private-Header (P-Header)". +- [142] OMA-TS-Presence\_SIMPLE-V1\_1\_1-20100225-A: "Presence SIMPLE Specification". +- [143] IETF RFC 6809: "Mechanism to Indicate Support of Features and Capabilities in the Session Initiation Protocol (SIP)". + +- [144] IETF RFC 5839: "An Extension to Session Initiation Protocol (SIP) Events for Conditional Event Notification". +- [145] Void. +- [146] IETF RFC 3264: "An Offer/Answer Model with the Session Description Protocol (SDP)". +- [147] IETF RFC 4566: "SDP: Session Description Protocol". +- [148] 3GPP TS 29.079: "Optimal Media Routeing within the IP Multimedia Subsystem; Stage 3". +- [149] 3GPP TS 24.337: "IP Multimedia Subsystem (IMS) inter-UE transfer". +- [150] IETF RFC 3960: "Early Media and Ringing Tone Generation in the Session Initiation Protocol (SIP)". +- [151] IETF RFC 3550: "RTP: A Transport Protocol for Real-Time Applications". +- [152] IETF RFC 768: "User Datagram Protocol". +- [153] IETF RFC 3551: "RTP Profile for Audio and Video Conferences with Minimal Control". +- [154] IETF RFC 3556: "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [155] IETF RFC 4585: "Extended RTP Profile for Real-time Transport Control Protocol (RTCP)-Based Feedback (RTP/AVPF)". +- [156] IETF RFC 793: "Transmission Control Protocol". +- [157] IETF RFC 4733: "RTP Payload for DTMF Digits, Telephony Tones, and Telephony Signals". +- [158] IETF RFC 4916: "Connected Identity in the Session Initiation Protocol (SIP)". +- [159] 3GPP TS 23.237: "IP Multimedia Subsystem (IMS) Service Continuity". +- [160] IETF RFC 6140: "Registration for Multiple Phone Numbers in the Session Initiation Protocol (SIP)". +- [161] IETF RFC 6230: "Media Control Channel Framework". +- [162] IETF RFC 4145: "TCP-Based Media Transport in the Session Description Protocol (SDP)". +- [163] 3GPP TS 24.390: "Unstructured Supplementary Service Data (USSD)". +- [164] IETF RFC 6357: "Design Considerations for Session Initiation Protocol (SIP) Overload Control". +- [165] IETF RFC 7339: "Session Initiation Protocol (SIP) Overload Control". +- [166] IETF RFC 7415: "Session Initiation Protocol (SIP) Rate Control". +- [167] IETF RFC 7200: "A Session Initiation Protocol (SIP) Load-Control Event Package". +- [168] 3GPP TS 29.163: "Interworking between the IP Multimedia (IM) Core Network (CN) subsystem and Circuit Switched (CS) networks". +- [169] IETF RFC 2046: "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types". +- [170] IETF RFC 2387: "The MIME Multipart/Related Content-type". +- [171] IETF RFC 3420: "Internet Media Type message/sipfrag". +- [172] IETF RFC 3842: "A Message Summary and Message Waiting Indication Event Package for the Session Initiation Protocol (SIP)". +- [173] IETF RFC 3858: "An Extensible Markup Language (XML) Based Format for Watcher Information". + +- [174] IETF RFC 3863: "Presence Information Data Format (PIDF)". +- [175] IETF RFC 3994: "Indication of Message Composition for Instant Messaging". +- [176] IETF RFC 4661: "An Extensible Markup Language (XML) Based Format for Event Notification Filtering". +- [177] IETF RFC 4662: "A Session Initiation Protocol (SIP) Event Notification Extension for Resource Lists". +- [178] IETF RFC 4826: "Extensible Markup Language (XML) Formats for Representing Resource Lists". +- [179] IETF RFC 5262: "Presence Information Data Format (PIDF) Extension for Partial Presence". +- [180] IETF RFC 5874: "An Extensible Markup Language (XML) Document Format for Indicating a Change in XML Configuration Access Protocol (XCAP) Resources". +- [181] Void. +- [182] OMA-SUP-XSD\_prs\_suppnotFilter-V1\_0-20120710-A: "Presence - Event notification suppression filter". +- [183] 3GPP TS 32.240: "Telecommunication management; Charging management; Charging architecture and principles". +- [184] IETF RFC 7090: "Public Safety Answering Point (PSAP) Callback". +- [185] IETF RFC 8055: "Session Initiation Protocol (SIP) Via Header Field Parameter to Indicate Received Realm". +- [186] 3GPP TS 29.658: "SIP Transfer of IP Multimedia Service Tariff Information". +- [187] 3GPP TS 22.153: "Multimedia priority service". +- [188] IETF RFC 7549: "3GPP SIP URI Inter Operator Traffic Leg parameter". +- [189] 3GPP TS 24.103: "Telepresence using the IP Multimedia (IM) Core Network (CN) Subsystem (IMS); Stage 3". +- [190] IETF RFC 8841: "Session Description Protocol (SDP) Offer/Answer Procedures for Stream Control Transmission Protocol (SCTP) over Datagram Transport Layer Security (DTLS) Transport". +- [191] 3GPP TS 24.315: "IP Multimedia Subsystem (IMS) Operator Determined Barring (ODB)". +- [192] 3GPP TR 29.949: "Study on Technical aspects on Roaming End-to-end scenarios with VoLTE IMS and other networks". +- [193] IETF RFC 8119: "SIP "cause" URI Parameter for Service Number Translation". +- [194] IETF RFC 7647: "Clarifications for the Use of REFER with RFC6665". +- [195] IETF RFC 7614: "Explicit Subscriptions for the REFER Method". +- [196] IETF RFC 7621: "A Clarification on the Use of Globally Routable User Agent URIs (GRUUs) in the Session Initiation Protocol SIP Event Notification Framework". +- [197] IETF RFC 2646: "The Text/Plain Format Parameter". +- [198] IETF RFC 1866: "Hypertext Markup Language - 2.0". +- [199] 3GPP TS 22.179: "Mission Critical Push To Talk (MCPTT); Stage 1". +- [200] 3GPP TS 23.280: "Common functional architecture to support mission critical services; Stage 2". +- [201] 3GPP TS 24.379: "Mission Critical Push To Talk (MCPTT) call control Protocol specification". + +- [202] 3GPP TS 24.380: "Mission Critical Push To Talk (MCPTT) floor control Protocol specification". +- [203] IETF RFC 8498: "A P-Served-User Header Field Parameter for an Originating Call Diversion (CDIV) Session Case in the Session Initiation Protocol (SIP)". +- [204] IETF RFC 4575: "A Session Initiation Protocol (SIP) Event Package for Conference State". +- [205] IETF RFC 4354: "A Session Initiation Protocol (SIP) Event Package and Data Format for Various Settings in Support for the Push-to-Talk over Cellular (PoC) Service". +- [206] IETF RFC 8224: "Authenticated Identity Management in the Session Initiation Protocol (SIP)". +- [207] IETF RFC 8197: "A SIP Response Code for Unwanted Calls". +- [208] IETF RFC 6910: "Completion of Calls for the Session Initiation Protocol (SIP)". +- [209] 3GPP TS 22.280: "Mission Critical Services Common Requirements". +- [210] 3GPP TS 24.281: "Mission Critical Video (MCVideo) signalling control; Protocol specification". +- [211] 3GPP TS 24.282: "Mission Critical Data (MCData) signalling control; Protocol specification". +- [212] 3GPP TS 24.581: "Mission Critical Video (MCVideo) media plane control; Protocol specification". +- [213] 3GPP TS 24.582: "Mission Critical Data (MCData) media plane control; Protocol specification". +- [214] IETF RFC 8606: "ISDN User Part (ISUP) Cause Location Parameter for the SIP Reason Header Field". +- [215] 3GPP TS 23.167: "IP Multimedia Subsystem (IMS) emergency sessions". +- [216] IETF RFC 8262: "Content-ID Header Field in the Session Initiation Protocol (SIP)". +- [217] 3GPP TS 24.196: "Technical Specification Group Core Network and Terminals; Enhanced Calling Name". +- [218] 3GPP TS 24.174: "Support of Multi-Device and Multi-Identity in IMS; Stage 3". +- [219] 3GPP TS 23.218: "IP Multimedia (IM) Session Handling; IM call model". +- [220] IETF RFC 9410: "Handling of Identity Header Errors for Secure Telephone Identity Revisited (STIR)". +- [221] IETF RFC 9366: "Multiple SIP Reason Header Field Values". + +# --- 3 Definitions, symbols 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]. + +**example:** text used to clarify abstract rules by applying them literally. + +**IM CN subsystem:** (IP Multimedia CN subsystem) comprises of all CN elements for the provision of IP multimedia applications over IP multimedia sessions, as specified in 3GPP TS 22.228 [9]. + +**IP multimedia session:** as specified in 3GPP TS 22.228 [9] an IP multimedia session is a set of multimedia senders and receivers and the data streams flowing from senders to receivers. IP multimedia sessions are supported by the IP multimedia CN Subsystem and are enabled by IP connectivity bearers (e.g. GPRS as a bearer). A user can invoke concurrent IP multimedia sessions. + +**non-roaming II-NNI:** the II-NNI between IMS home networks, or, if the Roaming Architecture for Voice over IMS with Local Breakout is used, alternatively the II-NNI between the caller's visited network and the callee's home network. + +**roaming II-NNI:** the II-NNI between a visited IMS network and the IMS home network; for the Roaming Architecture for Voice over IMS with Local Breakout, the loopback traversal scenario is excluded. + +**loopback traversal scenario:** for the Roaming Architecture for Voice over IMS with Local Breakout, the scenario where the II-NNI between the caller's home network and the caller's visited network is being traversed by an initial INVITE request from the caller's home network to the caller's visited network or any subsequent SIP message within the same dialogue on the same call leg. + +**home-to-visited request on roaming II-NNI:** SIP request being sent from the callee's home network to the callee's visited network. + +**home routeing:** the scenario when the caller's home network routes a dialog creating SIP request directly to the callee's home network without using the loopback traversal scenario. + +**visited-to-home request on roaming II-NNI:** SIP request being sent from the caller's visited network to the caller's home network. + +**home-to-visited response on roaming II-NNI:** SIP response being sent from the caller's home network to the caller's visited network. + +**visited-to-home response on roaming II-NNI:** SIP response being sent from the callee's visited network to the callee's home network. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.292 [120] apply: + +### **MSC Server enhanced for ICS** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.237 [159] apply: + +### **MSC server enhanced for SRVCC** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.237 [131] apply: + +### **MSC server enhanced for dual radio** + +For the purposes of the present document, the following term and definition given in 3GPP TS 23.218 [219] apply: + +### **Standalone transaction** + +## **3.2 Symbols** + +For the purposes of the present document, the following symbols apply: + +| | | +|-----|----------------------------------------------------------------------------------------------------------------------------------------------| +| I2 | Reference point between the MSC Server enhanced for ICS and the home IMS | +| Ici | Reference Point between an IBCF and another IBCF belonging to a different IM CN subsystem network | +| Ix | Reference Point between an IBCF and TrGW | +| Izi | Reference Point between a TrGW and another TrGW or media handling node belonging to a different IM CN subsystem network | +| Mi | Reference Point between a BGCF and CSCF | +| Mm | Reference Point between a CSCF/BGCF/IMS ALG and an IP multimedia network | +| Mw | Reference Point between a CSCF and another CSCF | +| Mx | Reference Point between a CSCF/BGCF/MSC Server enhanced for ICS/ MSC Server enhanced for SRVCC / MSC server enhanced for dual radio and IBCF | + +## 3.3 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]. + +| | | +|---------|-------------------------------------------------| +| 18x | A SIP status-code in the range 180 through 189 | +| 2xx | A SIP status-code in the range 200 through 299 | +| 3PTY | Three-Party | +| 3xx | A SIP status-code in the range 300 through 399 | +| 4xx | A SIP status-code in the range 400 through 499 | +| 5GS | 5G System | +| 5xx | A SIP status-code in the range 500 through 599 | +| 6xx | A SIP status-code in the range 600 through 699 | +| ACR | Anonymous Communication Rejection | +| AOC | Advice Of Charge | +| AS | Application Server | +| ATCF | Access Transfer Control Function | +| B2BUA | Back 2 Back User Agent | +| BGCF | Breakout Gateway Control Function | +| CAT | Customized Alerting Tone | +| CB | Communication Barring | +| CCBS | Completion of Communications to Busy Subscriber | +| CCNL | Completion of Communications on Not Logged-in | +| CCNR | Communication Completion on No Reply | +| CDIV | Communication Diversion | +| CONF | Conference | +| CRS | Customized Ringing Signal | +| CSCF | Call Session Control Function | +| CW | Communication Waiting | +| DRVCC | Dual Radio Voice Call Continuity | +| eCNAM | Enhanced Calling Name | +| E-CSCF | Emergency CSCF | +| ECT | Explicit Communication Transfer | +| FA | Flexible Alerting | +| GRUU | Globally Routable User agent URI | +| HOLD | Communication HOLD | +| IBCF | Interconnection Border Control Function | +| ICB | Incoming Communication Barring | +| ICID | IMS Charging Identifier | +| ICS | IMS Centralized Services | +| I-CSCF | Interrogating CSCF | +| II-NNI | Inter-IMS Network to Network Interface | +| IM | Instant Messaging | +| IMS-ALG | IMS Application Level Gateway | +| IOI | Inter Operator Identifier | +| IUT | Inter UE Transfer | +| MBMS | Multimedia Broadcast Multicast Service | +| MCData | Mission Critical Data | +| MCID | Malicious Communication IDentification | +| MCPTT | Mission Critical Push-To-Talk | +| MCVideo | Mission Critical Video | +| MiD | Multi-iDentity | +| MMTEL | Multimedia Telephony | +| MPS | Multimedia Priority Service | +| MRB | Media Resource Broker | +| MRFC | Media Resource Function Controller | +| MRFP | Multimedia Resource Function Processor | +| MSD | Minimum Set of Data | +| MSRP | Message Session Relay Protocol | +| MTSI | Multimedia Telephony Service for IMS | + +| | | +|-----------|----------------------------------------------------------------------| +| MuD | Multi-Device | +| MWI | Message Waiting Indication | +| NA(P)T-PT | Network Address (Port-Multiplexing) Translation-Protocol Translation | +| NNI | Network to Network Interface | +| OCB | Outgoing Communication Barring | +| OIP | Originating Identification Presentation | +| OIR | Originating Identification Restriction | +| OMA | Open Mobile Alliance | +| OMR | Optimal Media Routeing | +| P-CSCF | Proxy CSCF | +| PCF | Policy Control Function | +| PCRF | Policy and Charging Rules Function | +| PNM | Personal Network Management | +| PRES | Presence | +| PSAP | Public Safety Answering Point | +| PSI | Public Service Identity | +| RLOS | Restricted Local Operator Services | +| RTT | Round-trip Time | +| S-CSCF | Serving CSCF | +| SRVCC | Single Radio Voice Call Continuity | +| STN | Session Transfer Number | +| TIP | Terminating Identification Presentation | +| TIR | Terminating Identification Restriction | +| TRF | Transit and Roaming Function | +| TrGW | Transition Gateway | +| UDM | Unified Data Management | +| vSRVCC | Single Radio Video Call Continuity | + +# 4 Overview + +Interconnection between two different IM CN subsystems shall be guaranteed in order to support end-to-end service interoperability. For this purpose, Inter-IMS Network to Network Interface (II-NNI) between two IM CN subsystem networks is adopted, according to the assumptions coming from 3GPP TS 23.002 [3] and 3GPP TS 23.228 [4]. + +NOTE: The end-to-end service interoperability within one IM CN subsystem over the Mi, Mm, Mw and I2 reference points not passing over the Mx reference point as defined in 3GPP TS 23.228 [4] is outside the scope of this document. + +Aiming to support the delivery of IMS services between two separated IM CN subsystems, protocol interconnection has to occur: + +- at a control plane level, in order that IMS procedures can be supported. In this case the adopted reference point is the Ici; and +- at a user plane level, where media streams are exchanged over the Izi reference point. + +IP multimedia sessions are managed by SIP. The transport mechanism for both SIP session signalling and media transport is IPv4 (IETF RFC 791 [2]) or IPv6 (IETF RFC 2460 [7]). The 3GPP profile of SIP defining the usage of SIP within the IM CN subsystem is specified in 3GPP TS 24.229 [5]. Example call flows are provided in 3GPP TR 24.930 [6]. + +The general interconnection model is shown in figure 4.1. + +![Diagram showing the interconnection model for IM CN subsystems. Two gray ovals, each labeled 'IM CN Subsystem', are connected by a horizontal line. A vertical line segment crosses this horizontal line, and a rectangular box labeled 'II-NNI' is centered on this vertical segment.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +``` +graph LR; A((IM CN Subsystem)) --- II_NNI[II-NNI]; II_NNI --- B((IM CN Subsystem)); +``` + +Diagram showing the interconnection model for IM CN subsystems. Two gray ovals, each labeled 'IM CN Subsystem', are connected by a horizontal line. A vertical line segment crosses this horizontal line, and a rectangular box labeled 'II-NNI' is centered on this vertical segment. + +**Figure 4.1: Interconnection Model for IM CN subsystems** + +The II-NNI traversal scenarios in this document are covered in figure 4.2, figure 4.3 and figure 4.4. + +NOTE 1: Any II-NNI can contain intermediate transit network(s). The intermediate transit network can either be an IMS transit network with or without a transit function as specified in 3GPP TS 24.229 [5] or a non-IMS transit network using standards outside the scope of 3GPP. + +NOTE 2: IMS home network A and IMS home network B represent the IMS home network on originating side and terminating side respectively. + +NOTE 3: IMS visited network X and IMS visited network Y represent the IMS visited network on originating side and terminating side respectively. + +**Figure 4.2: II-NNI traversal scenarios when P-CSCF is located in visited network and when home routing is used** + +- NOTE 1: Any II-NNI can contain intermediate transit network(s). The intermediate transit network can either be an IMS transit network with or without a transit function as specified in 3GPP TS 24.229 [5] or a non-IMS transit network using standards outside the scope of 3GPP. +- NOTE 2: IMS home network A and IMS home network B represent the IMS home network on originating side and terminating side respectively. +- NOTE 3: IMS visited network X and IMS visited network Y represent the IMS visited network on originating side and terminating side respectively. + +**Figure 4.3: II-NNI traversal scenarios when P-CSCF is located in visited network and when the roaming architecture for voice over IMS with local breakout is used** + +- NOTE 1: Originating IMS network O represents the IMS network to which the originating UE is attached to, and terminating IMS network T represents the IMS network which accomodates a PSAP. +- NOTE 2: Originating IMS network O can be a visited IMS network or a home IMS network. +- NOTE 3: The E-CSCF is located in the originating IMS network O. +- NOTE 4: Any II-NNI between originating IMS network O and terminating IMS network T does not use any specific capabilities for roaming II-NNI, and is treated as non-roaming II-NNI. + +**Figure 4.4: IMS emergency session traversal scenario on non-roaming II-NNI** + +The possible functional entities involved in the signalling plane interconnection (IBCF, I-CSCF, P-CSCF, ATCF, S-CSCF, E-CSCF, BGCF, MSC Server enhanced for ICS, MSC server enhanced for SRVCC, MSC server enhanced for dual radio and TRF) and in the user plane interconnection (TrGW) are specified in 3GPP TS 24.229 [5], in 3GPP TS 24.292 [121], 3GPP TS 29.292 [130], 3GPP TS 29.162 [8] and in 3GPP TS 24.237 [131]. + +IP Version interworking is described within 3GPP TS 29.162 [8]. + +Examples of usage of the Inter-IMS Network to Network Interface (II-NNI) for roaming scenarios are described in 3GPP TR 29.949 [192]. + +# 5 Reference model for interconnection between IM CN subsystems + +## 5.1 General + +Figure 5.1.1 illustrates the architecture diagram given in 3GPP TS 23.228 [4] showing the Inter-IMS Network to Network Interface (II-NNI) between two IM CN subsystem networks. + +![Figure 5.1.1: Inter-IMS Network to Network Interface between two IM CN subsystem networks. The diagram shows two separate IM CN subsystem networks connected via an Inter-IMS Network to Network Interface (II-NNI). On the left, a dashed box contains an ATC (Access Terminal Controller) and an MSC Server (which can be a stand-alone entity or combined with another functional entity). The ATC is connected to a central IBCF (Interconnection Border Control Function) via an Mx reference point. The IBCF is connected to the II-NNI via an Ici reference point. The II-NNI is represented by a red arc. On the right, another IBCF is connected to the II-NNI via an Ici reference point. This IBCF is connected to a central TrGW (Traffic Gateway) via an Ix reference point. The TrGW is connected to various external entities via Mx reference points. A NOTE below the diagram states: 'The TRF can reside as a stand-alone entity or can be combined with another functional entity.'](ab846b81e78dbc8da2a6f9511e2f248a_img.jpg) + +Figure 5.1.1: Inter-IMS Network to Network Interface between two IM CN subsystem networks. The diagram shows two separate IM CN subsystem networks connected via an Inter-IMS Network to Network Interface (II-NNI). On the left, a dashed box contains an ATC (Access Terminal Controller) and an MSC Server (which can be a stand-alone entity or combined with another functional entity). The ATC is connected to a central IBCF (Interconnection Border Control Function) via an Mx reference point. The IBCF is connected to the II-NNI via an Ici reference point. The II-NNI is represented by a red arc. On the right, another IBCF is connected to the II-NNI via an Ici reference point. This IBCF is connected to a central TrGW (Traffic Gateway) via an Ix reference point. The TrGW is connected to various external entities via Mx reference points. A NOTE below the diagram states: 'The TRF can reside as a stand-alone entity or can be combined with another functional entity.' + +NOTE: The TRF can reside as a stand-alone entity or can be combined with another functional entity. + +**Figure 5.1.1: Inter-IMS Network to Network Interface between two IM CN subsystem networks** + +The protocols over the two reference points Ici and Izi make up the Inter-IMS Network to Network Interface. + +The Ici reference point allows IBCFs to communicate with each other in order to provide the communication and forwarding of SIP signalling messaging between IM CN subsystem networks. The Izi reference point allows TrGWs to forward media streams between IM CN subsystem networks. + +IMS roaming performed by using II-NNI is considered, when the IBCFs are inserted at the network borders. The applicability of roaming scenario by using II-NNI is based on agreement between the operators. + +Whenever the Inter-IMS Network to Network Interface is used to interconnect two IM CN subsystem networks belonging to different security domains, security procedures apply as described in 3GPP TS 33.210 [10]. + +When an IMS transit network is providing application services and interconnecting two IM CN subsystem networks, as described in 3GPP TS 23.228 [4], interfaces on both sides of the IMS transit network are within the scope of this document. + +When two IM CN subsystem networks are interconnected for IMS emergency session establishment as described in 3GPP TS 23.167 [215], the interface between these IM CN subsystem networks is within the scope of this document. + +NOTE: Implementations of functional entities at the IMS network edge might include functions that are not described in this Release of the specification, for example fault management that sends SIP OPTIONS requests between the two IBCFs over the Ici. IBCF originated SIP OPTIONS standalone transactions and any other features not described in the main body of this specification are out of scope. + +## 5.2 Functionalities performed by entities at the edge of the network + +### 5.2.1 Interconnection Border Control Function (IBCF) + +An IBCF provides application specific functions at the SIP/SDP protocol layer in order to perform interconnection between IM CN subsystem networks by using Iei reference point. According to 3GPP TS 23.228 [4], IBCF can act both as an entry point and as an exit point for the IM CN subsystem network. + +The functionalities of IBCF are indicated in the 3GPP TS 23.228 [4] and specified in 3GPP TS 24.229 [5]. They include: + +- network topology hiding; +- application level gateway (for instance enabling communication between IPv6 and IPv4 SIP applications, or between a SIP application in a private IP address space and a SIP application outside this address space); +- controlling transport plane functions; +- controlling media plane adaptations; +- screening of SIP signalling information; +- selecting the appropriate signalling interconnect; +- generation of charging data records; +- privacy protection; +- additional routing functionality; and +- inclusion of a transit IOI in requests when acting as an entry point for a transit network and in responses when acting as an exit point for a transit network. + +Based on local configuration, the IBCF performs transit routing functions as specified in 3GPP TS 24.229 [5] clause I.2. + +The IBCF acts as a B2BUA when it performs IMS-ALG functionality. + +### 5.2.2 Transition Gateway (TrGW) + +According to 3GPP TS 23.002 [3], the TrGW is located at the network borders within the media path and is controlled by an IBCF. Forwarding of media streams between IM CN subsystem networks is applied over Izi reference point. + +The TrGW provides functions like network address/port translation and IPv4/IPv6 protocol translation. NAT-PT binds addresses in IPv6 network with addresses in IPv4 network and vice versa to provide transparent routing between the two IP domains without requiring any changes to end points. NA(P)T-PT provides additional translation of transport identifier (TCP and UDP port numbers). The approach is similar to that one described also in 3GPP TS 29.162 [8]. + +Further details are described in 3GPP TS 23.228 [4]. + +## 5.3 Identifying II-NNI traversal scenario + +### 5.3.1 General + +The procedures for identifying the II-NNI traversal scenario using the "iotl" SIP URI parameter defined in IETF RFC 7549 [188] is specified in 3GPP TS 24.229 [5]. + +This specification uses the following II-NNI traversal scenarios when describing requirements at II-NNI: + +- the non-roaming II-NNI traversal scenario; +- the roaming II-NNI traversal scenario; and + +- the loopback II-NNI traversal scenario. + +When a requirement at II-NNI is dependent on direction the roaming II-NNI traversal scenario is further divided into: + +- the home-to-visited II-NNI traversal scenario; and +- the visited-to-home II-NNI traversal scenario. + +See figure 4.2 and figure 4.3 for information on how the II-NNI traversal scenarios above are applied between networks. + +### 5.3.2 Mapping of the "iotl" SIP URI parameter to II-NNI traversal scenario + +Table 5.3.2.1 describes how the "iotl" SIP URI parameter shall be used to identify the II-NNI traversal scenario. The table 5.3.2.1 contains the following items: + +- the first column, named "II-NNI traversal scenario", shows the II-NNI traversal scenarios within the scope of this specification; and +- the second column, named "Value of the "iotl" parameter", shows the value of the "iotl" SIP URI parameter as specified in IETF RFC 7549 [188]. + +**Table 5.3.2.1: Mapping of the "iotl" SIP URI parameter to II-NNI traversal scenario** + +| II-NNI traversal scenario | Value of the "iotl" parameter | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------| +| Non-roaming II-NNI traversal scenario
(NOTE 1) | "homeA-homeB" or "visitedA-homeB" | +| Loopback traversal scenario | "homeA-visitedA" | +| Roaming II-NNI traversal scenario | "visitedA-homeA" or "homeB-visitedB"
(NOTE 2) | +| Home-to-visited traversal scenario | "homeB-visitedB" | +| Visited-to-home traversal scenario | "visitedA-homeA" | +| NOTE 1: This is the default II-NNI traversal scenario, if the "iotl" SIP URI parameter is not present in the Request-URI or in any of the Route header fields in the SIP request and if an implementation dependent method of identifying the II-NNI traversal scenario is not used. | | +| NOTE 2: When the requirement at II-NNI is independent on direction any of the "visitedA-homeA" or "homeB-visitedB" can be used to identify the roaming II-NNI traversal scenario. | | + +# 6 Control plane interconnection + +## 6.1 Definition of Inter-IMS Network to Network Interconnection + +### 6.1.1 SIP methods and header fields + +#### 6.1.1.1 General + +The functional entity closest to the border of an II-NNI (see reference model in clause 5) shall provide the capabilities specified for that network element in clause A.2 of 3GPP TS 24.229 [5] with modifications as described in the following clauses. + +#### 6.1.1.2 SIP methods + +3GPP TS 24.229 [5] defines the methods allowing an IBCF to interconnect to an IBCF placed in another IM CN subsystem. + +The following SIP methods are supported on the II-NNI as defined in table 6.1. + +The following table is based on table A.5 and table A.163 of 3GPP TS 24.229 [5] and endorsed for this document: + +**Table 6.1: Supported SIP methods** + +| Item | Method | Ref. | II-NNI | | +|-------|---------------------------------------------------------------------------------|--------------------|---------|-----------| +| | | | Sending | Receiving | +| 1 | ACK request | IETF RFC 3261 [13] | m | m | +| 2 | BYE request | IETF RFC 3261 [13] | m | m | +| 3 | BYE response | IETF RFC 3261 [13] | m | m | +| 4 | CANCEL request | IETF RFC 3261 [13] | m | m | +| 5 | CANCEL response | IETF RFC 3261 [13] | m | m | +| 5A | INFO request | IETF RFC 6086 [39] | o | o | +| 5B | INFO response | IETF RFC 6086 [39] | o | o | +| 8 | INVITE request | IETF RFC 3261 [13] | m | m | +| 9 | INVITE response | IETF RFC 3261 [13] | m | m | +| 9A | MESSAGE request | IETF RFC 3428 [19] | o | o | +| 9B | MESSAGE response | IETF RFC 3428 [19] | o | o | +| 10 | NOTIFY request | IETF RFC 6665 [20] | c1 | c1 | +| 11 | NOTIFY response | IETF RFC 6665 [20] | c1 | c1 | +| 12 | OPTIONS request | IETF RFC 3261 [13] | m | m | +| 13 | OPTIONS response | IETF RFC 3261 [13] | m | m | +| 14 | PRACK request | IETF RFC 3262 [18] | m | m | +| 15 | PRACK response | IETF RFC 3262 [18] | m | m | +| 15A | PUBLISH request | IETF RFC 3903 [21] | c1 | c1 | +| 15B | PUBLISH response | IETF RFC 3903 [21] | c1 | c1 | +| 16 | REFER request | IETF RFC 3515 [22] | o | o | +| 17 | REFER response | IETF RFC 3515 [22] | o | o | +| 18 | REGISTER request | IETF RFC 3261 [13] | c2 | c2 | +| 19 | REGISTER response | IETF RFC 3261 [13] | c2 | c2 | +| 20 | SUBSCRIBE request | IETF RFC 6665 [20] | c1 | c1 | +| 21 | SUBSCRIBE response | IETF RFC 6665 [20] | c1 | c1 | +| 22 | UPDATE request | IETF RFC 3311 [23] | m | m | +| 23 | UPDATE response | IETF RFC 3311 [23] | m | m | +| c1: | In case of roaming II-NNI, the support of the method is m, else o. | | | | +| c2: | In case of roaming II-NNI, the support of the method is m, else n/a. | | | | +| NOTE: | In the above table, m, o and c and n/a have the meanings indicated in table 6.3 | | | | + +#### 6.1.1.3 SIP header fields + +##### 6.1.1.3.0 General + +The IBCF shall provide the capabilities to manage and modify SIP header fields according to clause 5.10 and annex A of 3GPP TS 24.229 [5] with modifications as described in the following clauses. + +##### 6.1.1.3.1 Trust and no trust relationship + +The IBCF acting as exit point applies the procedures described in clause 5.10.2 of 3GPP TS 24.229 [5] before forwarding the SIP signalling to the IBCF acting as entry point. The IBCF acting as entry point applies the procedures described in clause 5.10.3 of 3GPP TS 24.229 [5]. + +Additionally, in case there is no trust relationship between the two IM CN subsystems connected by II-NNI, the IBCF applies the procedures described in clause 4.4 of 3GPP TS 24.229 [5], before forwarding the SIP signalling. + +These procedures may be utilized on a per header field basis to realize overall trust as well as per service level screening of header fields. Trust relationships and trust domains may be defined by inter-operator agreements for individual services and/or individual SIP header fields. + +The management of the SIP header fields (if present) over II-NNI in case of a presence or not of a trust relationship between the two interconnected IM CN subsystems is wrapped up in the following table. + +**Table 6.2: Management of SIP header fields and parameters over II-NNI in presence or not of a trust relationship** + +| Item | Header field or parameter | Reference | Trust relationship | Not trust relationship | +|------|----------------------------------------|-----------------------------------|---------------------------------------------------------|--------------------------------------------------------------------------------------| +| 1 | P-Asserted-Identity | IETF RFC 3325 [44] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 2 | P-Access-Network-Info | IETF RFC 7315 [24] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 3 | Resource-Priority | IETF RFC 4412 [78] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 4 | History-Info | IETF RFC 7044 [25] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in clause 7 of IETF RFC 7044 [25] and in 3GPP TS 24.229 [5], clause 4.4 | +| 5 | P-Asserted-Service | IETF RFC 6050 [26] | As specified in 3GPP TS 24.229 [5], clause 4.4 (NOTE 3) | As specified in 3GPP TS 24.229 [5], clause 4.4 (NOTE 3) | +| 6 | P-Charging-Vector | IETF RFC 7315 [24] | As specified in 3GPP TS 24.229 [5], clause 5.10 | As specified in 3GPP TS 24.229 [5], clause 5.10 | +| 7 | P-Charging-Function-Addresses (NOTE 4) | IETF RFC 7315 [24] | As specified in 3GPP TS 24.229 [5], clause 5.10 | As specified in 3GPP TS 24.229 [5], clause 5.10 | +| 8 | P-Profile-Key (NOTE 2) | IETF RFC 5002 [64] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 9 | P-Private-Network-Indication | IETF RFC 7316 [84] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 10 | P-Served-User (NOTE 1, NOTE 2) | IETF RFC 5502 [85] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 11 | Reason (in a response) | IETF RFC 6432 [49] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 12 | P-Early-Media | IETF RFC 5009 [74] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 13 | Feature-Caps | IETF RFC 6809 [143] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 14 | Priority (NOTE 6) | IETF RFC 7090 [184] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 15 | "iotl" SIP URI parameter (NOTE 7) | IETF RFC 7549 [188] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 16 | "cpc" tel URI parameter (NOTE 5) | 3GPP TS 24.229 [5] clause 7.2A.12 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 17 | "oli" tel URI parameter (NOTE 5) | 3GPP TS 24.229 [5] clause 7.2A.12 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 18 | Restoration-Info (NOTE 2) | 3GPP TS 24.229 [5] clause 7.2.11 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 19 | Relayed-Charge (NOTE 4) | 3GPP TS 24.229 [5] clause 7.2.12 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 20 | Service-Interact-Info | 3GPP TS 24.229 [5] clause 7.2.14 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 21 | Cellular-Network-Info | 3GPP TS 24.229 [5] clause 7.2.15 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|-------------------------------------|------------------------------------------------------|------------------------------------------------------| +| 22 | Response-Source | 3GPP TS 24.229 [5]
clause 7.2.17 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | +| 23 | Attestation-Info
(NOTE 8) | 3GPP TS 24.229 [5]
clause 7.2.18 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | +| 24 | Origination-Id
(NOTE 8) | 3GPP TS 24.229 [5]
clause 7.2.19 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | +| 25 | Additional-Identity | 3GPP TS 24.229 [5]
clause 7.2.20 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | +| 26 | Priority-Verstat
(NOTE 8) | 3GPP TS 24.229 [5]
clause 7.2.21 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | +| NOTE 1: For a roaming II-NNI, a trust relationship with respect to this header field is required. | | | | | +| NOTE 2: This header field is only applicable on a roaming II-NNI. | | | | | +| NOTE 3: In addition, value-dependent operator policies may be applied. | | | | | +| NOTE 4: This header field is not applicable at II-NNI. | | | | | +| NOTE 5: The tel URI parameters "cpc" and "oli" can be included in the URI in the P-Asserted-Identity header field. | | | | | +| NOTE 6: Only the "psap-callback" value is part of the trust domain. | | | | | +| NOTE 7: The "iotl" SIP URI parameter can be transported in the Request-URI, Route header field, Path header field, Service-Route header field, "+g.3gpp.trf" header field parameter, "+g.3gpp.atcf-mgmt-uri" header field parameter and in the "ATU-STI" parameter in the "application/vnd.3gpp.srvcc-info+xml" MIME body. | | | | | +| NOTE 8: This header field is only applicable on non-roaming II-NNI. | | | | | + +##### 6.1.1.3.2 Derivation of applicable SIP header fields from 3GPP TS 24.229 [5] + +For any method in table 6.1, the SIP header fields applicable on the II-NNI are detailed in the corresponding method tables for the UA role and proxy role sending behaviour in annex A of 3GPP TS 24.229 [5]. Unless other information is specified in the normative part of the present specification, the applicability of header fields at the II-NNI can be derived for each method from the corresponding tables in annex A of 3GPP TS 24.229 [5] as follows: + +- All header fields not present in the corresponding tables in annex A of 3GPP TS 24.229 [5] or marked as "n/a" in both the "RFC status" and "profile status" columns for the UA role and proxy role sending behaviour of that tables are not applicable at the II-NNI. + +NOTE 1: Operators could choose to apply header fields for other SIP extensions on an II-NNI based on bilateral agreements, but this is outside the scope of the present specification. + +- All header fields which are marked as "o" in at least one of the "RFC status" or the "profile status" profile columns for the sending behaviour in the corresponding UA role and proxy role tables in annex A of 3GPP TS 24.229 [5] and as "n/a" or "o" in the other such columns are applicable at II-NNI based on bilateral agreement between operators. +- All header fields which are marked as "m" in at least one of the "RFC status" or the "profile status" columns for the sending behaviour in the corresponding UA role or proxy role table in annex A of 3GPP TS 24.229 [5] and as "n/a", "o", or "m" in the other such columns are applicable at the II-NNI. +- If conditions are specified, they are also applicable at the II-NNI and the above rules are applicable to the "n/a", "o" and "m" values within the conditions. + +NOTE 2: In the above rules, the RFC profile columns are taken into account in order to enable interworking with non-3GPP networks. + +An informative summary of SIP header fields to be used over the II-NNI is proposed in annex A. + +##### 6.1.1.3.3 Applicability of SIP header fields on a roaming II-NNI + +The following SIP header fields are applicable on a roaming II-NNI but not on a non-roaming II-NNI: + +- Authentication-Info +- Authorization + +- P-Associated-URI +- P-Called-Party-ID +- P-Preferred-Service +- P-Profile-Key +- P-Served-User +- P-Visited-Network-ID +- Path +- Priority-Share +- Proxy-Authenticate +- Proxy-Authorization +- Resource-Share +- Restoration-Info +- Service-Route +- WWW-Authenticate + +##### 6.1.1.3.4 Applicability of SIP header fields on a non-roaming II-NNI + +The following SIP header fields are only applicable on a non-roaming II-NNI: + +- P-Refused-URI-List; +- Identity; +- Attestation-Info; +- Origination-Id; and +- Priority-Verstat. + +#### 6.1.1.4 Notations of the codes + +In the table 6.1 the status codes "m", "o", "c" and "n/a" have the following meanings: + +**Table 6.3: Key to notation codes for SIP messages** + +| Notation code | Notation name | Sending side | Receiving side | +|----------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| m | mandatory | The message shall be supported at II-NNI.
Supporting sending a SIP message at the II-NNI means that this message shall be sent over the II-NNI if received from the serving network. It does not imply that network elements inside the serving network or user equipment connected to this network shall support this message. | Supporting receiving a SIP message at the II-NNI means that this message shall be forwarded to the serving network unless the operator's policy is applied as defined in clause 5.10.1 of 3GPP TS 24.229 [5]. It does not imply that network elements inside the serving network or user equipment connected to this network are supporting this message. | +| o | optional | The message may or may not be supported at II-NNI. The support of the message is provided based on bilateral agreement between the operators. | Same as for sending side. | +| n/a | not applicable | It is impossible to use/support the message. | It is impossible to use/support the message. This message will be discarded by the IBCF. | +| c
| conditional | The requirement on the message ("m", "o" or "n/a") depends on the support of other optional or conditional items.
is the identifier of the conditional expression. | Same as for sending side. | + +#### 6.1.1.5 Modes of signalling + +Overlap signalling may be used if agreement exists between operators to use overlap and which method to be used, otherwise enbloc shall be used at the II-NNI. + +### 6.1.2 SDP protocol + +#### 6.1.2.1 General + +The functional entity closest to the border of an II-NNI (see reference model in clause 5) shall provide the capabilities specified for that network element in clause A.3 of 3GPP TS 24.229 [5]. + +The "application/sdp" MIME bodies shall be encoded as described in IETF RFC 3261 [13] and in IETF RFC 4566 [147]. + +The offer/answer model with the SDP as defined in IETF RFC 3264 [146] shall be applied. + +The procedures and the SDP rules as defined in IETF RFC 4145 [162] may be applied if media streams with TCP is used. + +### 6.1.3 Major capabilities + +This clause contains the major capabilities to be supported over the II-NNI. + +The table 6.1.3.1 specifies which capabilities are applicable for II-NNI. The profile status codes within table 6.1.3.1 are defined in table 6.1.3.2. + +For the "Basic SIP" capabilities part of table 6.1.3.1, the last column "Profile status over II-NNI" specifies the general status of applicability of the IETF RFC 3261 [13] main mechanisms described in the 2nd column "Capability over the Ici". + +For the "Extensions to basic SIP" capabilities part, the last column "Profile status over II-NNI" specifies the general status of applicability of the RFC referenced in the 2nd column "Capability over the Ici". + +If necessary, the applicability of RFCs at the II-NNI level is further detailed in the present Technical Specification. + +The columns "Reference item in 3GPP TS 24.229 [5] for the profile status" provide informative references for comparison purposes into the UA and Proxy role major capabilities tables in 3GPP TS 24.229 [5], where the capabilities are defined via additional references. + +**Table 6.1.3.1: Major capabilities over II-NNI** + +| Item | Capability over the Ict | Reference item in 3GPP TS 24.229 [5] for the profile status | | Profile status over II-NNI | +|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|----------------------------------------|----------------------------| +| | | UA Role (NOTE 1) | Proxy role (NOTE 2) | | +| | Basic SIP (IETF RFC 3261 [13]) | | | | +| 1 | registrations | 1, 2, 2A | - | c2 | +| 2 | initiating a session | 2B, 3, 4 | - | m | +| 3 | terminating a session | 5 | 3 | m | +| 4 | General proxy behaviour | - | 4, 5, 14, 15 | n/a | +| 5 | Managing several responses due to forking | 9,10 | 6 | m | +| 6 | support of indication of TLS connections in the Record-Route header | - | 7, 8 | n/a | +| 7 | Support of authentication | 7, 8, 8A | 8A | c2 | +| 8 | Timestamped requests (Timestamp header field) | 6 | - | m | +| 9 | Presence of date in requests and responses (Date header field) | 11 | 9 | m | +| 10 | Presence of alerting information data (Alert-info header field) | 12 | 10 | o | +| 11 | Support and handling of the Require header field for REGISTER and other requests or responses for methods other than REGISTER | - | 11, 12, 13 | m | +| 12 | Support and reading of the Supported and Unsupported header fields | - | 16, 17, 18 | m | +| 13 | Support of the Error-Info header field in 3xx - 6xx responses | - | 19 | o | +| 14 | Support and handling of the Organization header field | - | 19A, 19B | m | +| 15 | Support and handling of the Call-Info header field | - | 19C, 19D | m | +| 16 | Support of the Contact header field in 3xx response | - | 19E | m | +| 16A | Proxy reading the contents of a body or including a body in a request or response | - | 19F | n/a | +| | Extensions to basic SIP | | | | +| 16B | 3GPP TS 24.237 [131]: proxy modifying the content of a body | - | 19G | n/a | +| 17 | IETF RFC 6086 [39]: SIP INFO method and package framework | 13 | 20 | o | +| 17A | IETF RFC 6086 [39]: legacy INFO usage | 13A | 20A | o | +| 18 | IETF RFC 3262 [18]: reliability of provisional responses in SIP (PRACK method) | 14 | 21 | m | +| 19 | IETF RFC 3515 [22]: the SIP REFER method | 15 | 22 | o | +| 19A | IETF RFC 7647 [194]: Clarifications for the Use of REFER with RFC6665 | 15A | 22A | n/a | +| 19B | IETF RFC 7614 [195]: Explicit Subscriptions for the REFER Method | 15B | 22B | o | +| 20 | IETF RFC 3312 [40] and IETF RFC 4032 [41]: integration of resource management and SIP (Preconditions framework) | 2C, 16 | 23 | o | +| 21 | IETF RFC 3311 [23]: the SIP UPDATE method | 17 | 24 | m | +| 22 | IETF RFC 3313 [42]: SIP extensions for media authorization (P-Media-Authorization header field) | 19 | 26 | n/a | +| 23 | IETF RFC 6665 [20]: SIP specific event notification (SUBSCRIBE/NOTIFY methods) | 20, 22, 23 | 27 | c1 | +| 23A | IETF RFC 7621 [196]: A Clarification on the Use of Globally Routable User Agent URIs (GRUUs) in the Session Initiation Protocol SIP Event Notification Framework | 22A | 28 | n/a | +| 24 | IETF RFC 3327 [43]: session initiation protocol extension header field for registering non-adjacent contacts (Path header field) | 24 | 29 | c2 | +| 25 | IETF RFC 3325 [44]: private extensions to the Session Initiation Protocol (SIP) for network asserted identity within trusted networks | 25 | 30 | c4 | +| 26 | IETF RFC 3325 [44]: the P-Preferred-Identity header field extension | - | - | n/a | +| 27 | IETF RFC 3325 [44]: the P-Asserted-Identity header field extension | - | - | c4 | +| 28 | IETF RFC 3323 [34], IETF RFC 3325 [44] and IETF RFC 7044 [25]: a privacy mechanism for the Session Initiation Protocol (SIP) (Privacy header field) | 26, 26A, 26B, 26C, 26D, 26E, 26F, 26G, | 31, 31A, 31B, 31C, 31D, 31E, 31F, 31G, | m | + +| | | | | | +|--|--|-----|-----|--| +| | | 26H | 31H | | +|--|--|-----|-----|--| + +| | | | | | +|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|----------------------------------|-----| +| 29 | IETF RFC 3428 [19]: a messaging mechanism for the Session Initiation Protocol (SIP) (MESSAGE method) | 27 | 33 | o | +| 30 | IETF RFC 3608 [45]: session initiation protocol extension header field for service route discovery during registration (Service-Route header field) | 28 | 32 | c2 | +| 31 | IETF RFC 3486 [46]: compressing the session initiation protocol | 29 | 34 | n/a | +| 32 | IETF RFC 7315 [24]: private header extensions to the session initiation protocol for the 3 rd -Generation Partnership Project (3GPP) | 30 | 35 | o | +| 32A | IETF RFC 3325 [44]: act as first entity within the trust domain for asserted identity | 30A | 30A | n/a | +| 32B | IETF RFC 3325 [44]: act as entity within trust network that can route outside the trust network | 30B | 30B | n/a | +| 32C | IETF RFC 3325 [44]: act as entity passing on identity transparently independent of trust domain | 30C | 30C | n/a | +| 33 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Associated-URI header field extension | 31 | 36 | c2 | +| 34 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Called-Party-ID header field extension | 32 | 37 | c2 | +| 35 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Visited-Network-ID header field extension | 33 | 38, 39 | c2 | +| 36 | IETF RFC 7315 [24], IETF RFC 7976 [24A] and IETF RFC 7913 [24B]: the P-Access-Network-Info header field extension | 34 | 41, 42, 43 | c4 | +| 37 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Charging-Function-Addresses header field extension | 35 | 44, 44A | n/a | +| 38 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Charging-Vector header field extension | 36 | 45, 46 | c1 | +| 39 | IETF RFC 3329 [47]: security mechanism agreement for the session initiation protocol | 37 | 47 | n/a | +| 39A | 3GPP TS 24.229 [5] clause 7.2A.7: Capability Exchange for Media Plane Security | 37A | 47A | n/a | +| 40 | IETF RFC 3326 [48]: the Reason header field for the session initiation protocol | 38 | 48 | o | +| 41 | IETF RFC 6432 [49]: carrying Q.850 codes in reason header fields in SIP (Session Initiation Protocol) responses | 38A | 48A | c4 | +| 41A | IETF RFC 8606 [214]: the Location Parameter for the SIP Reason Header Field | 38B | 48B | o | +| 41B | IETF RFC 9410 [220]: Handling of Identity Header Errors for Secure Telephone Identity Revisited (STIR) (carrying STIR codes in Reason header fields in SIP responses) | 38C | 48C | c5 | +| 41C | IETF RFC 9366 [221]: Multiple SIP Reason Header Field Values | 38D | 48D | c5 | +| 42 | IETF RFC 3581 [50]: an extension to the session initiation protocol for symmetric response routing | 39 | 49 | o | +| 43 | IETF RFC 3841 [51]: caller preferences for the session initiation protocol (Accept-Contact, Reject-Contact and Request-Disposition header fields) | 40, 40A, 40B, 40C, 40D, 40E, 40F | 50, 50A, 50B, 50C, 50D, 50E, 50F | m | +| 44 | IETF RFC 3903 [21]: an event state publication extension to the session initiation protocol (PUBLISH method) | 41 | 51 | c1 | +| 45 | IETF RFC 4028 [52]: SIP session timer (Session-Expires and Min-SE headers) | 42 | 52 | m | +| 46 | IETF RFC 3892 [53]: the SIP Referred-By mechanism | 43 | 53 | m | +| 47 | IETF RFC 3891 [54]: the Session Initiation Protocol (SIP) "Replaces" header | 44 | 54 | o | +| 48 | IETF RFC 3911 [55]: the Session Initiation Protocol (SIP) "Join" header | 45 | 55 | o | +| 49 | IETF RFC 3840 [56]: the callee capabilities | 46 | 56 | o | +| 50 | IETF RFC 7044 [25]: an extension to the session initiation protocol for request history information (History-Info header field) | 47 | 57 | o | +| 50A | IETF RFC 7044 [25]: the "mp" header field parameter | 47A | 57A | o | +| 50B | IETF RFC 7044 [25]: the "rc" header field parameter | 47B | 57B | o | +| 50C | IETF RFC 7044 [25]: the "np" header field parameter | 47C | 57C | o | + +| | | | | | +|-----|----------------------------------------------------------------------------------------------------------------------------------------------------|--------------|--------------|-------------------| +| 51 | IETF RFC 5079 [57]: Rejecting anonymous requests in the session initiation protocol | 48 | 58 | o | +| 52 | IETF RFC 4458 [58]: session initiation protocol URIs for applications such as voicemail and interactive voice response (NOTE 3) | 49 | 59 | o | +| 52A | IETF RFC 8119 [193]: Session Initiation Protocol (SIP) Cause URI parameter for Service Number translation | 49A | 59A | o | +| 53 | IETF RFC 4320 [59]: Session Initiation Protocol's (SIP) non-INVITE transactions | 50 | 61 | m | +| 54 | IETF RFC 4457 [60]: the P-User-Database private header field extension | 51 | 60 | n/a | +| 55 | IETF RFC 5031 [61]: A Uniform Resource Name (URN) for Emergency and Other Well-Known Services | 52 | 62 | c7 | +| 56 | IETF RFC 5627 [62]: obtaining and using GRUUs in the Session Initiation Protocol (SIP) | 53 | 63 | c1 | +| 57 | Void | | | | +| 58 | IETF RFC 4168 [27]: the Stream Control Transmission Protocol (SCTP) as a Transport for the Session Initiation Protocol (SIP) | 55 | 65 | o | +| 59 | IETF RFC 5002 [64]: the SIP P-Profile-Key private header field extension | 56 | 66, 66A, 66B | c3 | +| 60 | IETF RFC 5626 [65]: managing client initiated connections in SIP | 57 | 67 | c1 | +| 61 | IETF RFC 5768 [66]: indicating support for interactive connectivity establishment in SIP | 58 | 68 | n/a | +| 62 | IETF RFC 5365 [67]: multiple-recipient MESSAGE requests in the session initiation protocol | 59 | 69 | o if 29, else n/a | +| 63 | IETF RFC 6442 [68]: Location conveyance for the Session Initiation Protocol | 60 | 70, 70A, 70B | m | +| 64 | IETF RFC 5368 [69]: referring to multiple resources in the session initiation protocol | 61 | 71 | o if 19, else n/a | +| 65 | IETF RFC 5366 [70]: conference establishment using request-contained lists in the session initiation protocol | 62 | 72 | o | +| 66 | IETF RFC 5367 [71]: subscriptions to request-contained resource lists in the session initiation protocol | 63 | 73 | o if 23, else n/a | +| 67 | IETF RFC 4967 [72]: dialstring parameter for the session initiation protocol uniform resource identifier | 64 | 74 | c2 | +| 68 | IETF RFC 4964 [73]: the P-Answer-State header extension to the session initiation protocol for the open mobile alliance push to talk over cellular | 65 | 75 | o | +| 69 | IETF RFC 5009 [74]: the SIP P-Early-Media private header field extension for authorization of early media | 66 | 76 | c4 | +| 70 | IETF RFC 4694 [75]: number portability parameters for the 'tel' URI | 67, 67A, 67B | 77, 77A, 77B | o | +| 71 | Void | | | | +| 72 | IETF RFC 4411 [77]: extending the session initiation protocol Reason header for preemption events | 69 | 79 | o | +| 73 | IETF RFC 4412 [78]: communications resource priority for the session initiation protocol (Resource-Priority header field) | 70, 70A, 70B | 80, 80A, 80B | o | +| 74 | IETF RFC 5393 [79]: addressing an amplification vulnerability in session initiation protocol forking proxies | 71 | 81 | m | +| 75 | IETF RFC 5049 [80]: the remote application identification of applying signalling compression to SIP | 72 | 82 | n/a | +| 76 | IETF RFC 5688 [81]: a session initiation protocol media feature tag for MIME application sub-types | 73 | 83 | c1 | +| 77 | IETF RFC 6050 [26]: Identification of communication services in the session initiation protocol | 74 | 84, 84A | o | +| 78 | IETF RFC 5360 [82]: a framework for consent-based communications in SIP | 75, 75A, 75B | 85 | o | +| 79 | IETF RFC 7433 [83]: a mechanism for transporting user-to-user call control information in SIP | 76 | 86 | c1 | +| 79A | IETF RFC 7434 [83A]: interworking ISDN call control user information with SIP | 76A | - | c1 | +| 80 | IETF RFC 7316 [84]: The SIP P-Private-Network-Indication private header (P-Header) | 77 | 87 | c1 | +| 81 | IETF RFC 5502 [85]: the SIP P-Served-User private header | 78 | 88 | c2 | + +| | | | | | +|------|------------------------------------------------------------------------------------------------------------------------------------------|------|---------|-------------------| +| 82 | IETF 8498 [203]: the SIP P-Served-User header extension for Originating CDIV session case | 79 | 89 | n/a | +| 83 | IETF RFC 8497 [87]: marking SIP messages to be logged | 80 | 90 | o | +| 84 | IETF RFC 6228 [88]: the 199 (Early Dialog Terminated) response code | 81 | 91 | m | +| 85 | IETF RFC 5621 [89]: message body handling in SIP | 82 | 92 | m | +| 86 | IETF RFC 6223 [90]: indication of support for keep-alive | 83 | 93 | o | +| 87 | IETF RFC 5552 [91]: SIP Interface to VoiceXML Media Services | 84 | 94 | n/a | +| 88 | IETF RFC 3862 [92]: common presence and instant messaging (CPIM): message format | 85 | 95 | o | +| 89 | IETF RFC 5438 [93]: instant message disposition notification | 86 | 96 | o | +| 90 | IETF RFC 5373 [94]: requesting answering modes for SIP (Answer-Mode and Priv-Answer-Mode header fields) | 87 | 97, 97A | o | +| 91 | Void | | | | +| 92 | IETF RFC 3959 [96]: the early session disposition type for SIP | 89 | 99 | o | +| 93 | Void | | | | +| 94 | IETF RFC 7989 [124]: End-to-End Session Identification in IP-Based Multimedia Communication Networks | 91 | 101 | o | +| 95 | IETF RFC 6026 [125]: correct transaction handling for 200 responses to Session Initiation Protocol INVITE requests | 92 | 102 | m | +| 96 | IETF RFC 5658 [126]: addressing Record-Route issues in the Session Initiation Protocol (SIP) | 93 | 103 | o | +| 97 | IETF RFC 5954 [127]: essential correction for IPv6 ABNF and URI comparison in IETF RFC 3261 [13] | 94 | 104 | m | +| 98 | IETF RFC 4488 [135]: suppression of session initiation protocol REFER method implicit subscription | 95 | 105 | m if 19, else n/a | +| 99 | IETF RFC 7462 [136]: Alert-Info URNs for the Session Initiation Protocol | 96 | 106 | o | +| 100 | 3GPP TS 24.229 [5] clause 3.1: multiple registrations | 97 | 107 | c2 | +| 101 | IETF RFC 5318 [141]: the SIP P-Refused-URI-List private-header | 98 | 108 | c5 | +| 102 | IETF RFC 4538 [140]: request authorization through dialog Identification in the session initiation protocol (Target-Dialog header field) | 99 | 109 | o | +| 103 | IETF RFC 6809 [143]: Mechanism to indicate support of features and capabilities in the Session Initiation Protocol (SIP) | 100 | 110 | o | +| 104 | IETF RFC 6140 [160]: registration of bulk number contacts | 101 | 111 | c3 | +| 105 | IETF RFC 6230 [161]: media control channel framework | 102 | 112 | o | +| 105A | 3GPP TS 24.229 [5] clause 4.14: S-CSCF restoration procedures | 103 | 113 | c3 | +| 106 | IETF RFC 6357 [164]: SIP overload control | 104 | 114 | o | +| 107 | IETF RFC 7339 [165]: feedback control | 104A | 114A | o | +| 108 | IETF RFC 7200 [167]: distribution of load filters | 104B | 114B | o | +| 109 | 3GPP TS 24.229 [5] clauses 5.1.2A.1.1, 5.1.3.1, 5.1.6.8, and 5.2.10: Handling of a 380 (Alternative service) response | 105 | 115 | n/a | +| 110 | IETF RFC 7090 [184]: Public Safety Answering Point (PSAP) Callback | 107 | 117 | o | +| 111 | IETF RFC 8055 [185]: Via header field parameter to indicate received realm | 106 | 116 | n/a | +| 112 | IETF RFC 7549 [188]: SIP URI parameter to indicate traffic leg | 108 | 118 | o
(NOTE 4) | +| 113 | 3GPP TS 24.229 [5] clause 4.14: PCF or PCRF based P-CSCF restoration | 109 | 119 | c3 | +| 114 | 3GPP TS 24.229 [5] clause 4.14: UDM/HSS or HSS based P-CSCF restoration | 110 | 120 | c3 | +| 115 | 3GPP TS 24.229 [5] clause 7.2.12: the Relayed-Charge header extension | 111 | 121 | n/a | +| 116 | 3GPP TS 24.229 [5]: resource sharing | 112 | 122 | c3 | +| 117 | 3GPP TS 24.229 [5] clause 7.2.15: the Cellular-Network-Info header extension | 113 | 123 | c4 | +| 118 | 3GPP TS 24.229 [5] clause 7.2.16: the Priority-Share header field | 114 | 124 | c3 | +| 119 | IETF RFC 8224 [206]: Authenticated Identity Management in | 116 | 126 | c5 | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|-----|-----|----| +| | the Session Initiation Protocol (SIP) | | | | +| 120 | IETF RFC 8197 [207]: A SIP Response Code for Unwanted Calls | 117 | 127 | o | +| 121 | 3GPP TS 24.229 [5] clause 7.2.17: the Response-Source header extension | 115 | 125 | c6 | +| 121A | 3GPP TS 24.229 [5]: the 3GPP PS data off extension | 118 | - | c3 | +| 121B | 3GPP TS 24.229 [5]: Next-Generation Pan-European eCall emergency service | 120 | - | c8 | +| 122 | IETF RFC 8262 [216]: Content-ID Header Field in the Session Initiation Protocol (SIP) | 119 | - | o | +| 123 | 3GPP TS 24.229 [5] clause 7.2.18: the Attestation-Info header field | 121 | 128 | c5 | +| 124 | 3GPP TS 24.229 [5] clause 7.2.19: the Origination-Id | 122 | 129 | c5 | +| 125 | 3GPP TS 24.229 [5] clause 4.18: Dynamic services interactions | 123 | 130 | c6 | +| 126 | 3GPP TS 24.229 [5] clause 7.2.20: the Additional-Identity | 124 | 131 | c6 | +| 127 | 3GPP TS 24.229 [5] clause 4.19: RLOS | 125 | 132 | c3 | +| 128 | 3GPP TS 24.229 [5] clause 7.2.21: the Priority-Verstat header field | 126 | 133 | c6 | +| c1: m in case of roaming II-NNI, else o
c2: m in case of roaming II-NNI, else n/a
c3: o in case of roaming II-NNI, else n/a
c4: m in case of trust relationship between the interconnected networks, else n/a
c5: o in case of non-roaming II-NNI and loopback traversal scenario, else n/a
c6: o in case of trust relationship between the interconnected networks, else n/a
c7: m in case of IMS emergency session traversal scenario on non-roaming II-NNI, else n/a
c8: o in case of IMS emergency session traversal scenario on non-roaming II-NNI, else n/a | | | | | +| NOTE 1: The item numbering corresponds to the one provided in table A.4 in 3GPP TS 24.229 [5]. | | | | | +| NOTE 2: The item numbering corresponds to the one provided in table A.162 in 3GPP TS 24.229 [5]. | | | | | +| NOTE 3: A common URI namespace is required to apply this feature on the II-NNI. | | | | | +| NOTE 4: For the roaming II-NNI the support of this major capability is recommended. | | | | | + +**Table 6.1.3.2: Key to notation codes for major capabilities** + +| Notation code | Notation name | Explanation | +|----------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| m | mandatory | The capability shall be supported at II-NNI.
SIP message relating to this capability shall be sent over the II-NNI if received from the serving network, unless they also make use of other unsupported capabilities.
SIP headers or other information elements relating to this capability shall be passed over the II-NNI if received from the sending side.
This does not imply that network elements inside the serving network or served network or user equipment connected to these networks shall support this capability. | +| o | optional | The capability may or may not be supported at II-NNI. The support of the capability is provided based on bilateral agreement between the operators. | +| n/a | not applicable | It is impossible to use/support the capability at the II-NNI. | +| c
| conditional | The support of the capability ("m", "o" or "n/a") depends on the support of other optional or conditional items. is the identifier of the conditional expression. | + +### 6.1.4 SIP message bodies + +The MIME type "application/sdp" and multipart message bodies (multipart/mixed, multipart/related and multipart/alternative) shall be supported according to IETF RFC 5621 [89] over the II-NNI. Other MIME types may be supported over the II-NNI based on agreement between operators. + +The SDP message bodies contained in the INVITE request shall not be encrypted over the II-NNI. + +NOTE 1: Some MIME types in SIP requests and responses are listed in annex A of 3GPP TS 24.229 [5]. + +NOTE 2: The multipart message bodies are used for carrying two or more message body types as described in IETF RFC 5621 [89]. + +NOTE 3: The IBCF can provide the capabilities to examine the length of a SIP message body and take an appropriate action (e.g. reject the request, remove the body) as specified in clause 5.10.6.3 of 3GPP TS 24.229 [5]. + +NOTE 4: In the INVITE request, the SDP message body is present over the II-NNI, except when the INVITE request without SDP message body is required to provide services (e.g. 3rd party call control). + +#### **Table 6.1.4.1: List of MIME bodies** + +| Item | MIME body name | II-NNI requirements
in ref
(NOTE 1) | Defined in ref
(NOTE 2) | +|------|-------------------------------------------------|-----------------------------------------------------------------------------------------------------|------------------------------------------| +| 1 | application/3gpp-ims+xml | - | 3GPP TS 24.229 [5], clause 7.6 | +| 3 | message/cpim | - | IETF RFC 3862 [92] | +| 4 | message/imdn+xml | - | IETF RFC 5438 [93] | +| 5 | application/im-iscomposing+xml | clause 16.2 | IETF RFC 3994 [175] | +| 6 | multipart/mixed | clause 15.1,
clause 15.4,
clause 15.6.2,
clause 15.6.3,
clause 15.6.4,
clause 18.3.3 | IETF RFC 2046 [169] | +| 7 | multipart/related | clause 15.1,
clause 15.2,
clause 15.6.5 | IETF RFC 2387 [170] | +| 8 | multipart/alternative | - | IETF RFC 2046 [169] | +| 9 | application/pidf+xml | clause 15.1,
clause 28.2.3.2,
clause 28.2.9 | IETF RFC 3863 [174] | +| 10 | application/pidf-diff+xml | clause 15.1 | IETF RFC 5262 [179] | +| 11 | application/resource-lists+xml | clause 12.19,
clause 15.1,
clause 15.6.3,
clause 16.5,
clause 28.2.1,
clause 28.2.7 | IETF RFC 4826 [178] | +| 12 | application/rlmi+xml | clause 15.2,
clause 15.6.5 | IETF RFC 4662 [177] | +| 13 | application/sdp | - | IETF RFC 4566 [147] | +| 14 | application/simple-filter+xml | clause 15.1,
clause 15.6.4,
clause 28.2.3.2 | IETF RFC 4661 [176] | +| 15 | application/simple-message-summary+xml | clause 12.9 | IETF RFC 3842 [172] | +| 16 | message/sipfrag | clause 12.13,
clause 18.2,
clause 18.3.1 | IETF RFC 3420 [171] | +| 17 | application/vnd.3gpp.access-transfer-events+xml | clause 14.5.3 | 3GPP TS 24.237 [131], clause D.5.4 | +| 18 | application/vnd.3gpp.cw+xml | clause 12.7 | 3GPP TS 24.615 [37], clause C.1.1 | +| 19 | application/vnd.3gpp.iut+xml | clause 18.3.2,
clause 18.3.3 | 3GPP TS 24.337 [149], clause C.2.3 | +| 20 | application/vnd.3gpp.mid-call+xml | clause 14.4 | 3GPP TS 24.237 [131], clause D.1.3 | +| 21 | application/
vnd.3gpp.replication+xml | clause 18.4.1,
clause 18.4.2 | 3GPP TS 24.337 [149], clause C.1.3 | +| 22 | application/vnd.3gpp.sms | - | | +| 23 | application/vnd.3gpp.srvcc-ext+xml | clause 14.5.1 | 3GPP TS 24.237 [131], clause D.4.4 | +| 24 | application/vnd.3gpp.srvcc-info+xml | clause 14.2.3 | 3GPP TS 24.237 [131], clause D.3.4 | +| 25 | application/vnd.3gpp.state-and-event-info+xml | clause 14.2.2,
clause 14.4 | 3GPP TS 24.237 [131], clause D.2.4 | +| 26 | application/vnd.3gpp.ussd | clause 12.24 | 3GPP TS 24.390 [163], clause 5.1.3 | +| 27 | application/vnd.etsi.aoc+xml | clause 12.22 | 3GPP TS 24.647 [122], clause E.1.1 | +| 28 | application/vnd.etsi.cug+xml | clause 12.16 | 3GPP TS 24.654 [103], clause 4.4.1 | +| 29 | application/vnd.etsi.mcid+xml | clause 12.2 | 3GPP TS 24.616 [33], clause 4.4 | +| 30 | application/vnd.etsi.pstn+xml | - | 3GPP TS 29.163 [168], clause F.2 | +| 31 | application/
vnd.oma.suppnot+xml | clause 15.6.2,
clause 15.6.3 | OMA-SUP-XSD_prs_suppnotFilter-V1_0 [182] | +| 32 | application/watcherinfo+xml | clause 15.3 | IETF RFC 3858 [173] | +| 33 | application/xcap-diff+xml | clause 15.4,
clause 15.6.5 | IETF RFC 5874 [180] | +| 34 | application/session-info | - | 3GPP TS 29.163 [168], clause G.2 | +| 35 | application/load-control+xml | clause 21 | IETF RFC 7200 [167] | + +| | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| 36 | application/vnd.etsi.sci+xml | clause 11.3 | 3GPP TS 29.658 [186] | +| 37 | text/plain | - | IETF RFC 2646 [197] | +| 38 | application/x-www-form-urlencoded | - | IETF RFC 1866 [198], clause 8.2.1 (NOTE 3) | +| 39 | application/vnd.3gpp.crs+xml | clause 12.15 | 3GPP TS 24.183 [98], clause D.1 | +| 40 | message/sip | - | IETF RFC 3261 [13] | +| 41 | application/vnd.3gpp.mcptt-info+xml | clause 28.2.1,
clause 28.2.3.2,
clause 28.2.3.3,
clause 28.2.4,
clause 28.2.5,
clause 28.2.6,
clause 28.2.7,
clause 28.2.9 | 3GPP TS 24.379 [201], clause F.1 | +| 42 | application/vnd.3gpp.mcptt-mbms-usage-info+xml | clause 28.2.2 | 3GPP TS 24.379 [201], clause F.2 | +| 42A | application/vnd.3gpp.mcvideo-mbms-usage-info+xml | clause 28.2.2 | 3GPP TS 24.281 [210], clause F.2 | +| 43 | application/vnd.3gpp.mcptt-location-info+xml | clause 28.2.2 | 3GPP TS 24.379 [201], clause F.3 | +| 43A | application/vnd.3gpp.mcvideo-location-info+xml | clause 28.2.2 | 3GPP TS 24.281 [210], clause F.3 | +| 44 | application/conference-info+xml | clause 12.19,
clause 28.2.4,
clause 16.5 | IETF RFC 4575 [204] | +| 45 | application/poc-settings+xml | clause 28.2.5 | IETF RFC 4354 [205] | +| 46 | application/vnd.3gpp.mcptt-floor-request+xml | clause 28.2.7 | 3GPP TS 24.379 [201], clause F.5 | +| 47 | application/vnd.3gpp.mcptt-affiliation-command+xml | clause 28.2.3.3 | 3GPP TS 24.379 [201], clause F.4 | +| 47A | application/vnd.3gpp.mcptt-signed+xml | clause 28.2.5,
clause 28.2.6 | 3GPP TS 24.379 [201], clause F.6 | +| 48 | application/call-completion | clause 12.11,
clause 12.12,
clause 12.23 | IETF RFC 6910 [208] | +| 49 | application/vnd.3gpp.mcvideo-info+xml | clause 28.2.1
clause 28.2.3.2,
clause 28.2.3.3,
clause 28.2.5,
clause 28.2.4,
clause 28.2.6, | 3GPP TS 24.281 [210], clause F.1 | +| 50 | application/vnd.3gpp.mcvideo-affiliation-command+xml | clause 28.2.3.3 | 3GPP TS 24.281 [210], clause F.4 | +| 51 | application/vnd.3gpp.mcdata-signalling | clause 28.2.1,
clause 28.2.8 | 3GPP TS 24.282 [211], clause E.1 | +| 52 | application/vnd.3gpp.mcdata-payload | clause 28.2.8 | 3GPP TS 24.282 [211], clause E.2 | +| 53 | application/vnd.3gpp.mcdata-info+xml | clause 28.2.1
clause 28.2.3.2,
clause 28.2.3.3,
clause 28.2.5,
clause 28.2.6,
clause 28.2.8 | 3GPP TS 24.282 [211], clause D.1.4 | +| 54 | application/vnd.3gpp.mcdata-affiliation-command+xml | clause 28.2.3.3 | 3GPP TS 24.282 [211], clause D.3.4 | +| NOTE 1: When no specific II-NNI requirements are defined, the II-NNI requirements may be derived from the additional information about MIME types in SIP requests and responses in annex A of 3GPP TS 24.229 [5]. | | | | +| NOTE 2: This column references the definition of the MIME body for informative purpose only, the usage is defined in other specifications not listed here. | | | | +| NOTE 3 The MIME body contains a string that is coded as described in the IETF RFC 1866 [198]. | | | | + +Applicable characteristics of the SIP message body MIMEs (i.e. the value(s) of Content-Disposition header field and Content-Language header field) over the II-NNI may be a subject of operator agreements. + +## 6.2 Control Plane Transport + +### 6.2.1 General + +The control plane transport of the II-NNI shall comply with clause 4.2A of 3GPP TS 24.229 [5]. + +Support of SCTP as specified in IETF RFC 4168 [27] is optional for an IBCF connected by II-NNI. Nevertheless this option is favourable if the operators would like to improve reliability over the Ici. + +## 6.3 SIP timers + +Table 6.3.1 shows values of SIP timers that should be supported at II-NNI. It contains the following items: + +- the first column, titled "SIP Timer", shows the timer names as defined in IETF RFC 3261 [13] or IETF RFC 6026 [125]; +- the second column reflects the timer meaning as defined in IETF RFC 3261 [13]; +- the third column reflects the reference to the proper clause in the IETF RFC 3261 [13] and in 3GPP TS 24.229 [5] and +- the final column lists the values recommended for the functional entities closest to the border of an II-NNI (see reference model in clause 5). + +Table 6.3.1 reports information from 3GPP TS 24.229 [5], table 7.7.1. Values between IM CN subsystem elements shown in the second column in 3GPP TS 24.229 [5], table 7.7.1 are applicable for the II-NNI and are reported in the fourth column of table 6.3.1. If there are any differences between table 6.3.1 and 3GPP TS 24.229 [5], table 7.7.1, the information within 3GPP TS 24.229 [5], table 7.7.1 is applicable. + +**Table 6.3.1: SIP timers at II-NNI** + +| SIP Timer | Meaning | Reference | Recommended values | +|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|----------------------------------| +| T1 | RTT estimate | [13] clause 17.1.1.1
[5] table 7.7.1 | 500ms default
(see NOTE) | +| T2 | The maximum retransmit interval for non-INVITE requests and INVITE responses | [13] clause 17.1.2.2
[5] table 7.7.1 | 4s
(see NOTE) | +| T4 | Maximum duration a message will remain in the network | [13] clause 17.1.2.2
[5] table 7.7.1 | 5s
(see NOTE) | +| Timer A | INVITE request retransmit interval, for UDP only | [13] clause 17.1.1.2
[5] table 7.7.1 | initially T1 | +| Timer B | INVITE transaction timeout timer | [13] clause 17.1.1.2
[5] table 7.7.1 | 64*T1 | +| Timer C | proxy INVITE transaction timeout | [13] clause 16.6
[5] table 7.7.1 | > 3min | +| Timer D | Wait time for response retransmits | [13] clause 17.1.1.2
[5] table 7.7.1
[13] clause 17.1.1.2
[5] table 7.7.1 | > 32s for UDP
0s for TCP/SCTP | +| Timer E | non-INVITE request retransmit interval, UDP only | [13] clause 17.1.2.2
[5] table 7.7.1 | initially T1 | +| Timer F | non-INVITE transaction timeout timer | [13] clause 17.1.2.2
[5] table 7.7.1 | 64*T1 | +| Timer G | INVITE response retransmit interval | [13] clause 17.2.1
[5] table 7.7.1 | initially T1 | +| Timer H | Wait time for ACK receipt. | [13] clause 17.2.1
[5] table 7.7.1 | 64*T1 | +| Timer I | Wait time for ACK retransmits | [13] clause 17.2.1
[5] table 7.7.1
[13] clause 17.2.1
[5] table 7.7.1 | T4 for UDP
0s for TCP/SCTP | +| Timer J | Wait time for non-INVITE request retransmits | [13] clause 17.2.2
[5] table 7.7.1
[13] clause 17.2.2
[5] table 7.7.1 | 64*T1 for UDP
0s for TCP/SCTP | +| Timer K | Wait time for response retransmits | [13] clause 17.1.2.2
[5] table 7.7.1
[13] clause 17.1.2.2
[5] table 7.7.1 | T4 for UDP
0s for TCP/SCTP | +| Timer L | Wait time for accepted INVITE request retransmits | [125] clause 8.11
[5] table 7.7.1 | 64*T1 | +| Timer M | Wait time for retransmission of 2xx to INVITE or additional 2xx from other branches of a forked INVITE | [125] clause 8.11
[5] table 7.7.1 | 64*T1 | +| Timer N | Wait time for receipt of a NOTIFY request upon sending SUBSCRIBE | [20] clause 4.1.2
[5] table 7.7.1 | 64*T1 | +| NOTE: | As a network option, SIP T1 Timer's value can be extended, along with the necessary modifications of SIP T2 and SIP T4 Timer values, to take into account the specificities of the supported services when the MRFC and the controlling AS are under the control of the same operator and the controlling AS knows, based on local configuration, that the MRFC implements a longer value of SIP T1 Timer. | | | + +# 7 User plane Interconnection + +## 7.1 Media and Codec + +For "end-to-end" media session involving the II-NNI, the SIP/SDP codec negotiation procedure can be applied between IM CN subsystems using different media codecs. It is possible that the end-to-end codec negotiation could fail because no common codec could be supported by the UEs, in particular for voice services. + +To enhance interoperability, the IBCF, the MRFC, or other IMS network entities can interfere with the end-to-end codec negotiation to offer additional codec(s) available via transcoding, or to remove codecs. The IBCF can configure an attached TrGW to transcode, and the MRFC can configure an attached MRFP to transcode. + +Codecs applicable at the II-NNI may be a subject of interworking agreements. + +NOTE 1: Possible codecs which could be used at the II-NNI are described in 3GPP TS 26.114 [11] and ETSI TS 181 005 [12]. + +NOTE 2: As described in 3GPP TS 24.229 [5], the IETF RFC 4733 [157] is used to encode DTMF events and a payload type number associated with the MIME subtype "telephone-event" is included in a SDP message. + +However, to avoid that transcoding is performed several times, applicable codecs at the II-NNI should be restricted as little as possible in the inter-operator agreements. It is not recommended to set only codecs which are not agreed to use by the inter-operator agreement into the SDP of the SIP message at the II-NNI. Whether it is allowed to offer codecs which are not included in the applicable codec list made by inter-operator agreements over the II-NNI is also determined by the inter-operator agreement if necessary. + +NOTE 3: Transcoding can be performed in an IMS network serving an SDP offerer or in an IMS network serving an SDP answerer. To avoid that transcoding is performed multiple times, inter-operator agreements can clarify if it is preferred that IMS network serving an SDP offerer (with respect to the initial offer-answer exchange) or IMS network serving an SDP answerer (with respect to the initial offer-answer exchange) modify an SDP offer to offer transcoding. Furthermore, if transcoding is ongoing then subsequent SDP negotiation should avoid adding transcoding steps as specified in 3GPP TS 24.229 [5] Annex T.2 steps G), H), and I). + +If the IBCF performs media transcoding control, the IBCF shall apply the related procedures in 3GPP TS 24.229 [5]. + +## 7.2 User Plane Transport + +The user plane transport of the II-NNI may use the protocols listed in table 7.2.1. Protocols that use UDP, RTP, SCTP or TCP as the underlying transport protocol may be used based on agreements between operators. The used protocols to transport media are negotiated by means of the SDP offer/answer procedure specified in IETF RFC 3264 [146]. + +**Table 7.2.1: Supported transport-level RFCs to be described in SIP/SDP messages** + +| Item | RFC | Title | Support | +|------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| 1 | IETF RFC 3550 [151] | RTP: A Transport Protocol for Real-Time Applications | Mandatory | +| 2 | IETF RFC 768 [152] | User Datagram Protocol | Mandatory | +| 3 | IETF RFC 3551 [153] | RTP Profile for Audio and Video Conferences with Minimal Control | Mandatory | +| 4 | IETF RFC 3556 [154] | Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth | Mandatory | +| 5 | IETF RFC 4585 [155] | Extended RTP Profile for Real-time Transport Control Protocol (RTCP) - Based Feedback (RTP/AVPF) | Optional
(NOTE 1) | +| 6 | IETF RFC 793 [156] | Transmission Control Protocol | Optional
(NOTE 2) | +| 7 | IETF RFC 8841 [190] | Session Description Protocol (SDP) Offer/Answer Procedures for Stream Control Transmission Protocol (SCTP) over Datagram Transport Layer Security (DTLS) Transport | Optional
(NOTE 3) | + +NOTE 1: Used by MTSI, as indicated in 3GPP TS 26.114 [11]. + +NOTE 2: Used for MSRP service. + +NOTE 3: Used for data channel in telepresence using IMS, as indicated in 3GPP TS 24.103 [189]. + +# 8 Numbering, Naming and Addressing + +## 8.1 Numbering, Naming and Addressing for SIP message + +The following URI formats in SIP messages may be applied at the Icf as standardized in 3GPP TS 24.229 [5]: + +- SIP URI defined in IETF RFC 3261 [13]; +- tel URI defined in IETF RFC 3966 [14]; +- IM URI defined in IETF RFC 3860 [15]; and +- PRES URI defined in IETF RFC 3859 [16]. + +According to 3GPP TS 24.229 [5], the IBCF acting as an exit or entry point in the IMS network supports these URI formats. These URI formats shall be supported at the roaming II-NNI. The SIP URI format shall be supported at the non-roaming II-NNI. For the loopback traversal scenario both the SIP URI and the tel URI shall be supported. The tel URI, IM URI and PRES URI formats may be supported at the non-roaming II-NNI based on agreement between operators. For the loopback traversal scenario the IM URI and PRES URI may be supported based on agreement between operators. Other URI formats may be supported over the II-NNI depending on the operator agreements. + +A global number as defined in IETF RFC 3966 [14] shall be used in a tel URI or in the user portion of a SIP URI with the user=phone parameter when conveyed via a non-roaming II-NNI or for the loopback traversal scenario in the Request-URI and in the P-Asserted-Identity header field, except when agreement exists between the operators to also allow other kinds of numbers. + +NOTE 1: In a SIP URI the user portion of the Request-URI represents a telephone number only if the SIP URI includes the user=phone parameter. + +NOTE 2: Agreements can exist between operators to allow local number (e.g. national service numbers, business trunking numbers, or private numbers) at a non-roaming II-NNI or for the loopback traversal scenario. A SIP URI with such a number, a user=phone parameter, and a phone-context parameter agreed between the operators can then be used. + +NOTE 3: 3GPP TS 24.229 [5] allows to restrict the number within a SIP Request-URI with user=phone parameter at a non-roaming II-NNI or for the loopback traversal scenario to be a global number (i.e. E.164 in international format) via an appropriate Application Server. Suitable configuration by the operator is needed to achieve the desired modification of the format. + +NOTE 4: The allowed phone number formats in the P-Asserted-Identity header field of a served user are configured by the operator. According to 3GPP TS 23.003 [35], international E.164 format is used within a P-Asserted-Identity header field. + +NOTE 5: The global number format usage within a SIP Request-URI with the user=phone parameter at a non-roaming II-NNI or for the loopback traversal scenario allows the terminating network to find the called subscriber, via HSS interrogation, without any further number translation and thus improves the success of the interconnection between IMS operators. + +NOTE 6: According to 3GPP TS 23.003 [35] and 3GPP TS 24.229 [5], public user identity takes the form of either SIP URI or tel URI. + +NOTE 7: Agreements can exist between operators to allow the "Unavailable User Identity" as defined in 3GPP TS 23.003 [35] in the P-Asserted-Identity header field at a non-roaming II-NNI or for the loopback traversal scenario. + +The optional "oli" and "cpc" tel URI parameters associated with a tel URI or a SIP URI with user=phone are described in 3GPP TS 24.229 [5] clause 7.2A.12 and can be part of the P-Asserted-Identity header field. Depending on operator agreements, those URI parameters may be supported at the non-roaming II-NNI or for the loopback traversal scenario. + +The "sos" SIP URI parameter associated with a URI in the Contact header field of a REGISTER request or a 200 (OK) response to REGISTER request is described in 3GPP TS 24.229 [5]. The "sos" SIP URI parameter shall be supported at the roaming II-NNI. + +The "sos" SIP URI parameter associated with the Request-URI for all dialogs and standalone SIP requests described in clause 5.2.10.3 of 3GPP TS 24.229 [5] and shall be supported at the roaming II-NNI. + +The "rn" and "npdi" number portability parameters for the tel URI and the SIP URI with user=phone as described within IETF RFC 4694 [75] can be part of the Request-URI. Depending on operator agreements these parameters may be exchanged over the non-roaming II-NNI or for the loopback traversal scenario. + +NOTE 7: The "rn" and "npdi" parameters can be used to address the entry point of the terminating operator depending on national rules for number portability. + +The "isub" tel URI parameter for the tel URI and the SIP URI with user=phone as described within IETF RFC 3966 [14] can be part of the Request-URI, To header field and P-Asserted-Identity header field. Depending on operator agreements, this URI parameter may be exchanged over the II-NNI. + +The "premium-rate" tel URI parameter for the tel URI and the SIP URI with user=phone as described within 3GPP TS 24.229 [5] clause 7.2A.17 can be part of the Request-URI. Depending on operator agreements, this URI parameter may be exchanged at the roaming II-NNI. + +The public service identity (PSI) that takes a form of a SIP URI without including a port number as described in clause 13.5 of 3GPP TS 23.003 [35] may be exchanged over the II-NNI depending on operator agreements. + +## 8.2 Numbering, Naming and Addressing for SDP + +The following URI format in the SDP exchange may be applied at the Ici as standardized in 3GPP TS 24.229 [5]: + +- MSRP URI for a session of instant messages defined in IETF RFC 4975 [17]. + +This URI format shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI and for the loopback traversal scenario based on agreement between operators. Other URI formats may be supported over the II-NNI depending on the operator's agreements. + +# --- 9 IP Version + +The network elements interconnected by means of the II-NNI may support IPv4 only, IPv6 only or both. + +The support of one or both of the IP versions is an operator option and should be based on bilateral agreement. + +In case IPv4 and IPv6 networks are interconnected, the involved IBCFs and TrGWs shall apply the IP version interworking procedures as indicated in 3GPP TS 29.162 [8]. + +# --- 10 Security + +The supported security mechanisms for IP signalling transport over II-NNI interfaces are described in 3GPP TS 33.210 [10]. + +# --- 11 Charging + +## 11.1 General + +The accounting information to be supported over the Ici is described in 3GPP TS 32.260 [29] and 3GPP TS 32.240 [183]. It shall be configurable by the operator to use or not the accounting mechanisms provided by the IBCF. + +## 11.2 Inter-operator accounting + +For inter-operator accounting, the procedures related to the P-Charging-Vector header field specified in 3GPP TS 24.229 [5] shall be supported over the II-NNI as further specified below. + +NOTE 1: The "icid-value" header field parameter identifying a dialog or a transaction outside a dialog is included in the P-Charging-Vector header field as specified in 3GPP TS 24.229 [5]. The "icid-value" header field parameter value of a SIP response to a SIP request is identical to the "icid-value" of the SIP request. + +For the roaming II-NNI: + +- the P-Charging-Vector header field in the REGISTER requests, initial SIP requests and stand-alone SIP requests, containing the type 1 "orig-ioi" with the entry which identifies the visited network; and +- the P-Charging-Vector header field in the REGISTER responses (except the 100 (Trying) response), SIP responses (except the 100 (Trying) response) to initial SIP requests and SIP stand-alone requests, containing type 1 "orig-ioi" and type 1 "term-ioi" header field parameters with the entries which identify the visited network and the home network respectively; + +shall be supported. + +NOTE 2: Operator network identifiers populated in the type 1 "orig-ioi" and type 1 "term-ioi" header field parameters need to be exchanged by inter-operator agreements in advance. + +For the II-NNI between IMS home networks: + +- the P-Charging-Vector header field in the SIP requests containing the type 2 "orig-ioi" with the entry which identifies the home originating network; and +- the P-Charging-Vector header field in the SIP responses (except the 100 (Trying) response) containing the type 2 "orig-ioi" and type 2 "term-ioi" header field parameters with the entries which identify the home originating network and the home terminating network respectively; + +may be supported based on inter-operator agreements. + +If the roaming architecture for voice over IMS with local breakout is used, for the II-NNI between the caller's visited network and the callee's home network except for the roaming II-NNI: + +- the P-Charging-Vector header field in the SIP requests containing the type 2 "orig-ioi" with the entry which identifies the visited originating network; and +- the P-Charging-Vector header field in the SIP responses (except the 100 (Trying) response) containing the type 2 "orig-ioi" and type 2 "term-ioi" header field parameters with the entries which identify the visited originating network and the home terminating network respectively; + +may be supported based on inter-operator agreements. + +NOTE 3: Operator network identifiers populated in the type 2 "orig-ioi" and type 2 "term-ioi" header field parameters need to be exchanged by inter-operator agreements in advance. + +For the II-NNI for the transit scenario: + +- the P-Charging-Vector header field in the SIP requests and responses (except the 100 (Trying) response) containing the "transit-ioi" header field parameter with the entry(ies) which identify the transit network(s); + +may be supported based on inter-operator agreements. + +NOTE 4: Operator network identifiers populated in the value(s) of "transit-ioi" header field parameter need to be exchanged by inter-operator agreements in advance. + +## 11.3 Transfer of IP multimedia service tariff information + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), transfer of IP multimedia service tariff information as specified in 3GPP TS 29.658 [186] may be supported on the II- + +NNI between two IMS networks. The support of transfer of IP multimedia service tariff information is based on agreement between operators. + +If transfer of IP multimedia service tariff information is supported, the "application/vnd.etsi.sci+xml" MIME body with the Content-Disposition header field set to either "render" with the "handling" parameter set to "optional" or to "signal" with the "handling" parameter set to "required" or "optional" based on operator agreement in 18x responses to the INVITE request and in the INFO request shall be supported at the II-NNI. + +# --- 12 Supplementary services associated with the IMS multimedia telephony communication service + +## 12.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated supplementary services of the multimedia telephony communication service may be supported on the II-NNI between the two IMS networks. + +The MMTEL communication service is identified by means of the "urn:urn-7:3gpp-service.ims.icsi.mmtel" URN. The "urn:urn-7:3gpp-service.ims.icsi.mmtel" can appear in: + +- the media feature tag "g.3gpp.icsi-ref" (specified in 3GPP TS 24.229 [5] clause 7.2A.8) in the Contact header field and the Accept-Contact header field; +- the feature-capability indicator "g.3gpp.icsi-ref" (specified in 3GPP TS 24.229 [5] clause 7.9A.2) in the Feature-Caps header field; and +- the P-Asserted-Service header field. + +The support of each associated supplementary service is based on agreement between operators. + +If a supplementary service is supported, the related procedures from the 3GPP TS 22.173 [30], the protocol details from the 3GPP TS 24.173 [31] and specifications referenced in the 3GPP TS 24.173 [31] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +A classification of the importance of supplementary services applicable over the II-NNI is available in the informative annex Db of 3GPP TS 22.173 [30]. + +NOTE: Agreeing on interworking of entire class of services according to this classification can simplify the cooperation between interconnecting networks but remains optional. + +## 12.2 Malicious Communication IDeNtification (MCID) + +Service specific requirements in accordance with 3GPP TS 24.616 [33] shall be supported over the II-NNI. + +The P-Asserted-Identity header field shall be supported at the II-NNI. + +The INFO request and the 200 (OK) response to the INFO request containing the "application/vnd.etsi.mcid+xml" MIME body defined in 3GPP TS 24.616 [33] may be supported at the II-NNI. + +If a network terminating the dialog supports MCID, the terminating network shall only deliver the MCID request in the "application/vnd.etsi.mcid+xml" MIME body, as specified in the 3GPP TS 24.616 [33], if an agreement to use the MCID supplementary service according to the 3GPP TS 24.616 [33] exists with the network originating the dialog and if the INVITE request received by the terminating network does not contain the information of the originating party. + +NOTE: The IBCF and the AS in the terminating network interact to deliver the MCID request only if an agreement to use the MCID supplementary service exists, as specified in 3GPP TS 24.616 [33] and 3GPP TS 24.229 [5]. + +The originating network and the terminating network shall have a bilateral agreement to support transportation of the minimum information specified in clause 4.5.2.5.0 of the 3GPP TS 24.616 [33] between the networks. + +## 12.3 Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) + +Service specific requirements in accordance with 3GPP TS 24.607 [32] and 3GPP TS 24.229 [5] shall be supported over the II-NNI. + +The P-Asserted-Identity header field and the Privacy header field with values "id", "user", "none", "header" and "critical" shall be supported at the II-NNI. + +NOTE 1: P-Asserted-Identity header fields are intended for end-to-end operation. Removal of such header fields will impact the intended end-to-end operation between the end users. Where a trust relationship exists on the P-Asserted-Identity header field between the two IMS networks, this header field cannot be altered when passing through the II-NNI according to 3GPP TS 24.229 [5]. Where no trust relationship exists on the P-Asserted-Identity header field between the two IMS networks, the IBCF determines whether to remove the P-Asserted-Identity header field according to procedures described in 3GPP TS 24.229 [5] clause 4.4.2 referencing IETF RFC 3325 [44] and local policy rules for using additional screening capabilities as defined in 3GPP TS 24.229 [5] clause 5.10.6. + +NOTE 2: Where a trust relationship exists with the remote domain the From header field will be passed transparently by the IBCF. If a SIP request is received by the terminating network and the application of the OIR service is required with the value "user" for the Privacy header field then the From header field will be anonymised in accordance with IETF RFC 3323 [34] by the terminating network. Where no trust relationship exists with the remote domain, the From header field can be, based on local policy rules, anonymised by the IBCF of the originating network prior passing through the II-NNI using screening capabilities defined in 3GPP TS 24.229 [5] clause 5.10.6 and clause 5.10.8. + +NOTE 3: The privacy level "session" and "critical" are not used in the OIP/OIR service as described in 3GPP TS 24.607 [32]. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.4 Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) + +Service specific requirements in accordance with 3GPP TS 24.608 [113] shall be supported over the II-NNI. + +The P-Asserted-Identity header field and the Privacy header field with values "id", "user", "none", "header" and "critical" shall be supported at the II-NNI. + +NOTE: P-Asserted-Identity header fields are intended for end-to-end operation. Removal of such header fields will impact the intended end-to-end operation between the end users. Where a trust relationship exists on the P-Asserted-Identity header field between the two IMS networks, this header field will be passed transparently through the II-NNI according to 3GPP TS 24.229 [5]. Where no trust relationship exists on the P-Asserted-Identity header field between the two IMS networks, the IBCF determines whether to remove the P-Asserted-Identity header field according to procedures described in 3GPP TS 24.229 [5] clause 4.4.2, referencing IETF RFC 3325 [44] and local policy rules for using additional screening capabilities as defined in 3GPP TS 24.229 [5] clause 5.10.6. + +The option tag "from-change" defined in IETF RFC 4916 [158], in the Supported header field should be supported at II-NNI. + +## 12.5 Anonymous Communication Rejection (ACR) + +Service specific requirements in accordance with 3GPP TS 24.611 [114] shall be supported over the II-NNI. + +The P-Asserted-Identity header field and the Privacy header field shall be supported at the II-NNI. + +Procedures as described in clause 12.21.4 are used to provide announcements. + +The response code 433 (Anonymity Disallowed) shall be supported at the II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.6 Communication DIVersion (CDIV) + +Service specific requirements in accordance with 3GPP TS 24.604 [117] shall be supported over the II-NNI. + +NOTE 1: The support of the Diversion header field not adopted in 3GPP TS 24.604 [117] requires bilateral agreement between the operators. + +Procedures as described in clause 12.21.2 are used to provide announcements. + +The Privacy header field with a priv-value set to "history" included in the hi-targeted-to-uri or as a standalone header field shall be supported at the II-NNI. + +The History-Info header field as described by 3GPP TS 24.604 [117] containing an "mp" header field parameter as defined by IETF RFC 7044 [25] and a "cause" SIP URI parameter with cause values as defined by the IETF RFC 4458 [58] shall be supported over the II-NNI. + +NOTE 2: The networks can have an internal limit in the number of allowed diversions, as described in 3GPP TS 24.604 [117], clause 4.5.2.6.1. To ensure efficiency of this control operators can indicate in their bilateral agreements their own number of allowed communication diversions, the parameter that is used for counting, and the network behavior when the internal limit is reached. + +The response code 181 (Call Is Being Forwarded) shall be supported at the II-NNI. + +The MESSAGE request procedure for indication of communication diversion to the diverting user as specified in 3GPP TS 24.604 [117] and 3GPP TS 24.229 [5] should be supported at the roaming II-NNI. + +NOTE 3: The content of the MESSAGE request is operator specific. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.7 Communication Waiting (CW) + +Service specific requirements in accordance with 3GPP TS 24.615 [37] shall be supported over the II-NNI. + +The "application/vnd.3gpp.cw+xml" MIME body defined in 3GPP TS 24.615 [37] in the INVITE request shall be supported at the roaming II-NNI. + +The Alert-Info header field set to "urn:alert:service:call-waiting" in a 180 (Ringing) response shall be supported at the II-NNI. + +As a network option, in case of expiry of the CW timer, the response code 480 (Temporarily Unavailable) including a Reason header field containing the protocol value "Q.850" and the "cause" header field parameter set to "19" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +Procedures as described in clause 12.21.2 are used to provide announcements. + +## 12.8 Communication HOLD (HOLD) + +Service specific requirements in accordance with 3GPP TS 24.610 [36] shall be supported over the II-NNI. + +NOTE: The support of an alternative method not adopted in 3GPP TS 24.610 [36] requires bilateral agreement between the operators and is outside the scope of the present document. + +Procedures as described in clause 12.21.3 are used to provide announcements. + +## 12.9 Message Waiting Indication (MWI) + +Service specific requirements in accordance with 3GPP TS 24.606 [112] shall be supported over the II-NNI. + +The event package name "message-summary" in the Event header field according to IETF RFC 6665 [20] and 3GPP TS 24.229 [5] in the SUBSCRIBE request shall be supported at the roaming II-NNI. + +The "application/simple-message-summary" MIME body described in 3GPP TS 24.606 [112] in the NOTIFY request shall be supported at the roaming II-NNI. + +## 12.10 Communication Barring (CB) + +### 12.10.1 Incoming Communication Barring (ICB) + +Service specific requirements in accordance with 3GPP TS 24.611 [114] shall be supported over the II-NNI. + +Procedures as described in clause 12.21.4 are used to provide announcements. + +The response code 603 (Decline) including a Reason header field containing the protocol value set to "SIP" and the "cause" header field parameter set to value "603" as described in 3GPP TS 24.611 [114] shall be supported at the II-NNI. + +A Reason header field containing the protocol value set to "SIP" and the "cause" header field parameter set to value "603" as described in 3GPP TS 24.611 [114] included in the BYE request shall be supported at the II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +If the option IIFC (Inhibition of Incoming Forwarded Calls) is supported the transparency of information related to communication diversion (see clause 12.6) shall be supported at II-NNI. + +### 12.10.2 Outgoing Communication Barring (OCB) + +Service specific requirements in accordance with 3GPP TS 24.611 [114] shall be supported over the II-NNI. + +Procedures as described in clause 12.21.4 are used to provide announcements. + +The response code 603 (Decline) including a Reason header field containing the protocol value set to "SIP" and the "cause" header field parameter set to "603" as described in 3GPP TS 24.611 [114] shall be supported at the roaming II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.11 Completion of Communications to Busy Subscriber (CCBS) + +Service specific requirements in accordance with 3GPP TS 24.642 [109] shall be supported over the II-NNI. + +The response code 486 (Busy Here) containing a Call-Info header field with a "purpose" header field parameter set to "call-completion" and the "m" parameter set to "BS" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +For invoking and revoking of the CCBS supplementary service, announcement procedures shall be used to provide announcements and inband-interaction procedures as described in clause 12.21.3 and clause 12.21.4 shall be supported at the roaming II-NNI. + +The response code 199 (Early Dialog Terminated) shall be supported at the roaming II-NNI. + +Basic call procedures and in case of a call-completion recall initiated by a REFER request, normal REFER method handling procedures according to 3GPP TS 24.229 [5] shall be supported at the roaming II-NNI. + +As a network option the special REFER request handling procedures according to 3GPP TS 24.628 [38] should be supported at the roaming II-NNI. + +NOTE 1: 3rd party call control procedures can be used when the REFER request is not supported at the II-NNI. + +NOTE 2: A REFER request can be rejected by IBCF based on operator policy as specified by 3GPP TS 24.229 [5]. + +The SUBSCRIBE and NOTIFY methods according to IETF RFC 6665 [20] and 3GPP TS 24.229 [5] containing the event package name "call-completion" in the Event header field and the Call-Info header field with a purpose parameter set to 'call-completion' and the m parameter set to "BS" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The NOTIFY request containing the "application/call-completion" MIME body as defined in IETF RFC 6910 [208] shall be supported at the non-roaming II-NNI. + +The Request-URI with the "m" SIP URI parameter with a value set to "BS" and the Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "BS" in the INVITE method shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The Date header field in the 486 (Busy Here) response to the INVITE request shall be supported at the roaming II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.12 Completion of Communications by No Reply (CCNR) + +Service specific requirements in accordance with 3GPP TS 24.642 [109] shall be supported over the II-NNI. + +The response code 180 (Ringing) containing a Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NR" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +For invoking and revoking of the CCNR supplementary service, announcement procedures shall be used to provide announcements and inband-interaction procedures as described in clause 12.21.3 and clause 12.21.4 shall be supported at the roaming II-NNI. + +The response code 199 (Early Dialog Terminated) shall be supported at the roaming II-NNI. + +Basic call procedures and in case of a call-completion recall initiated by a REFER request, normal REFER method handling procedures according to 3GPP TS 24.229 [5] shall be supported at the roaming II-NNI. + +As a network option the special REFER request handling procedures according to 3GPP TS 24.628 [38] should be supported at the roaming II-NNI. + +NOTE 1: 3rd party call control procedures can be used when the REFER request is not supported at the II-NNI. + +NOTE 2: A REFER request can be rejected by IBCF based on operator policy as specified by 3GPP TS 24.229 [5]. + +The SUBSCRIBE and NOTIFY methods according to IETF RFC 6665 [20] and 3GPP TS 24.229 [5] containing the event package name "call-completion" in the Event header field and the Call-Info header field with a purpose parameter set to 'call-completion' and the m parameter set to "NR" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The NOTIFY request containing the "application/call-completion" MIME body as defined in IETF RFC 6910 [208] shall be supported at the non-roaming II-NNI. + +The Request-URI with the "m" SIP URI parameter with a value set to "NR" and the Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NR" in the INVITE method shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The Date header field in the 480 (Temporarily Unavailable) response to the INVITE request shall be supported at the roaming II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.13 Explicit Communication Transfer (ECT) + +### 12.13.1 Consultative and blind transfer + +Service specific requirements in accordance with 3GPP TS 24.629 [116] shall be supported over the II-NNI. + +The REFER method, the Referred-By header field and the Replaces header field as specified in 3GPP TS 24.629 [116] and the NOTIFY method containing an "application/sipfrag" MIME body shall be supported at the II-NNI for call transfer without third party call control. + +The REFER method, the Referred-By header field and the Replaces header field as specified in 3GPP TS 24.629 [116] and the NOTIFY method containing an "application/sipfrag" MIME body shall be supported at the roaming II-NNI for call transfer with third party call control. + +The Refer-To URI header parameter in the REFER request containing the Require header field set to "replaces" shall be supported at the roaming II-NNI. + +The Replaces header field in the INVITE request shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +### 12.13.2 Assured transfer + +The requirements for the assured transfer are the same as in clause 12.13.1 with the additional requirements in this clause. + +An Expires header field parameter in the Refer-To URI of the REFER Request shall be supported at the II-NNI for call transfer without third party call control. + +An Expires header field parameter in the Refer-To URI of the REFER Request shall be supported at the roaming II-NNI for call transfer with third party call control. + +The Refer-To header field in the REFER request containing the method parameter set to "CANCEL" shall be supported at the II-NNI for call transfer without third party call control. + +The Refer-To header field in the REFER request containing the method parameter set to "CANCEL" shall be supported at the roaming II-NNI with third party call control. + +## 12.14 Customized Alerting Tone (CAT) + +Service specific requirements in accordance with 3GPP TS 24.182 [129] shall be supported over the II-NNI. + +The P-Early-Media header field as described in 3GPP TS 24.182 [129] shall be supported at the II-NNI. + +The response code 180 (Ringing) and the response code 183 (Session Progress) including a P-Early-Media header field shall be supported over the II-NNI. + +The response code 199 (Early Dialog Terminated) shall be supported over the II-NNI. + +The Supported header field and the Require header field with "early-session" option-tag shall be supported at the II-NNI, if the early session model is supported. + +An "application/sdp" MIME body with the Content-Disposition header field set to "early-session" as specified in IETF RFC 3959 [96] shall be supported at II-NNI, if the early session model is supported. + +A SDP "a=content" attribute with a "g.3gpp.cat" value in the 18x responses shall be supported at the II-NNI. + +The SIP INFO mechanism for DTMF transport, as defined in 3GPP TS 24.229 [5] may be supported at the roaming II-NNI. + +NOTE 1: For telephone-event based DTMF transport, the DTMF digits are sent as media and not visible in the control plane. + +NOTE 2: Multiple methods for DTMF transport are defined in 3GPP TS 24.182 [129]. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.15 Customized Ringing Signal (CRS) + +Service specific requirements in accordance with 3GPP TS 24.183 [98] shall be supported over the II-NNI. + +An Alert-Info header field in the initial INVITE request containing an URI followed by a URN "urn:alert:service:crs" shall be supported at the II-NNI. + +An "application/vnd.3gpp.crs+xml" MIME body in the initial INVITE request shall be supported at the II-NNI. + +A SDP "a=content" attribute with a "g.3gpp.crs" value in the PRACK request or the re-INVITE request may be supported at the II-NNI. + +The Supported header field and the Require header field with "early-session" option-tag may be supported at the II-NNI. + +An "application/sdp" MIME body with the Content-Disposition header field set to "early-session" as specified in IETF RFC 3959 [96] may be supported at II-NNI. + +The SIP INFO mechanism for DTMF transport, as defined in 3GPP TS 24.229 [5] may be supported at the II-NNI. + +NOTE: For telephone-event based DTMF transport, the DTMF digits are sent as media and not visible in the control plane. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.16 Closed User Group (CUG) + +Service specific requirements in accordance with 3GPP TS 24.654 [103] shall be supported over the II-NNI. + +The "application/vnd.etsi.cug+xml" MIME body as specified 3GPP TS 24.654 [103] shall be supported in INVITE requests at the II-NNI. + +NOTE: If no agreement between the originating network and the terminating network exists to support the CUG supplementary service the INVITE request is rejected as described in IETF RFC 5621 [89] when the "handling" parameter in the Content-Disposition header field of the " application/vnd.etsi.cug+xml" MIME body is set to "required". + +The 403 (Forbidden) response, the 603 (Decline) response and the 500 (Server Internal Error) response shall be supported at II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.17 Personal Network Management (PNM) + +Service specific requirements in accordance with 3GPP TS 24.259 [99] shall be supported over the II-NNI. + +A "g.3gpp.iari\_ref" feature tag with the value "urn:urn-7:3gpp-application.ims.iari.pnm-controller" in the Contact header field of the REGISTER request shall be supported at the roaming II-NNI. + +A "g.3gpp.iari\_ref" feature tag with the value "urn:urn-7:3gpp-application.ims.iari.pnm-controller" in the Accept-Contact header field shall be supported at the II-NNI. + +The History-Info header field shall be supported at II-NNI. + +A "histinfo" option tag as described by 3GPP TS 24.259 [99] in the Supported header field shall be supported at II-NNI. + +## 12.18 Three-Party (3PTY) + +Service specific requirements in accordance with 3GPP TS 24.605 [105] shall be supported over the II-NNI. + +NOTE 1: The requirements below can be relaxed by bilateral agreements between operators. + +The requirements for the 3PTY supplementary service are the same as for the CONF supplementary service specified in clause 12.19 with the following additional requirement: + +- If a REFER request is supported at the II-NNI, a Replaces header field in the header portion of the SIP URI of the Refer-to header field of the REFER request shall also be supported at II-NNI. + +NOTE 2: Clause 12.19 describes the conditions for the support of the REFER request. + +## 12.19 Conference (CONF) + +Service specific requirements in accordance with 3GPP TS 24.605 [105] and 3GPP TS 24.147 [106] shall be supported over the II-NNI. + +NOTE 1: The requirements below can be relaxed by bilateral agreements between operators. + +The REFER request shall be supported at the roaming II-NNI in the direction from visited to home network. Based on inter-operator agreement, the REFER request may be supported at the non-roaming II-NNI, for the loopback traversal scenario, and at the roaming II-NNI in the direction from home network to visited network. + +NOTE 2: If the REFER request is not supported at the non-roaming II-NNI, for the loopback traversal scenario, or at the roaming II-NNI in the direction from home network to visited network, an attempt of an UE to send the REFER directly to peers to invite them to a conference without involvement of the conference focus can fail over such an II-NNI. However such failures can also occur if a peer is located in a circuit switched network, or if a peer does not support the REFER method. An operator can avoid such failures by configuring an AS to convert the REFER to an INVITE, as detailed in 3GPP TS 24.628 [38]. Information on security risks associated with the REFER request is provided within the "security consideration" of IETF RFC 3515 [22]. + +NOTE 3: A REFER request can be rejected by IBCF based on operator policy as specified by 3GPP TS 24.229 [5]. + +The "application/resource-lists+xml" MIME body in the INVITE request shall be supported at the roaming II-NNI. + +The Referred-By header field in the INVITE request shall be supported at the II-NNI. + +The "isfocus" feature parameter indicated in Contact header field of the INVITE request and in the 200 (OK) response shall be supported at the II-NNI. + +The SUBSCRIBE request including the "conference" event package name in the Event header field and the Accept header field containing an "application/conference-info+xml" MIME type shall be supported at the II-NNI. + +The NOTIFY request including an "application/conference-info+xml" MIME body shall be supported at the II-NNI. + +NOTE 4: The subscription to "conference event" package does not apply at the roaming II-NNI between the MSC Server enhanced for ICS/MSC Server enhanced for SRVCC/MSC server enhanced for dual radio and the IMS network where the communication is anchored. + +The Allow-Events header field in the INVITE request with the value "conference" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +## 12.20 Flexible Alerting (FA) + +Service specific requirements in accordance with 3GPP TS 24.239 [101] shall be supported over the II-NNI. + +The 486 (Busy Here) response code shall be supported at the II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.21 Announcements + +### 12.21.1 General + +Announcements may be provided during the establishment of a communication session, during an established communication session or when a communication request is rejected. All of them shall be managed over the II-NNI. + +### 12.21.2 Providing announcements during the establishment of a communication session + +Procedures as described in 3GPP TS 24.628 [38] are used to provide announcements during the establishment of a communication session. + +There are two methods defined in 3GPP TS 24.628 [38] to provide the announcement: + +- 1) sending an announcement as an early media; and + +NOTE 1: There are two methods to use early media for sending the announcement in-band. First method is the gateway model defined by IETF RFC 3960 [150] and 3GPP TS 24.628 [38] annex G, second method is described in 3GPP TS 24.628 [38] annex D. + +- 2) sending an Alert-Info header field in 180 (Ringing) response to the INVITE request. + +The P-Early-Media header field authorizing early media as defined in IETF RFC 5009 [74] during the establishment of a communication shall be supported at the II-NNI. + +The Alert-Info header field in the 180 (Ringing) response to the INVITE request during the establishment of a communication, should be supported at the II-NNI. + +NOTE 2: The IBCF can decide to remove the Alert-Info header field if required by local policy. + +### 12.21.3 Providing announcements during an established communication session + +Procedures as described in 3GPP TS 24.628 [38] are used to provide announcements during an established communication session. + +In case of provision of an announcement to a user over the II-NNI during an established communication, the Call-Info header field in a re-INVITE request should be supported at the II-NNI. + +NOTE 1: An alternative method to provide announcements is to use the existing media stream. + +NOTE 2: The IBCF can decide to remove the Call-Info header field if required by local policy. + +### 12.21.4 Providing announcements when communication request is rejected + +Procedures as described in 3GPP TS 24.628 [38] are used to provide announcements when a communication request is rejected. + +There are three methods defined in 3GPP TS 24.628 [38] to provide the announcement: + +- 1) sending an announcement as an early media; + +NOTE 1: There are two methods to use early media for sending the announcement in-band. First method is the gateway model defined by IETF RFC 3960 [150] and 3GPP TS 24.628 [38] annex G, second method is described in 3GPP TS 24.628 [38] annex D. + +- 2) sending an Error-Info header field in the 3xx, 4xx, 5xx or 6xx response to the INVITE request; and +- 3) accept the communication request and then provide the announcement. + +NOTE 2: The II-NNI requirements for accepting the communication request and then provide the announcement is not within the scope of this clause. + +The P-Early-Media header field authorizing early media as defined in IETF RFC 5009 [74] and the Reason header field with the proper cause value shall be supported at the II-NNI. + +The Error-Info header field in the 3xx, 4xx, 5xx or 6xx response to the INVITE request when rejecting the communication request, should be supported at the II-NNI. + +NOTE 3: The IBCF can decide to remove the Error-Info header field if required by local policy. + +## 12.22 Advice Of Charge (AOC) + +Service specific requirements in accordance with 3GPP TS 24.647 [122] shall be supported over the II-NNI. + +The Accept header field with "application/vnd.etsi.aoc+xml" shall be supported at the roaming II-NNI. + +The INVITE method containing an "application/vnd.etsi.aoc+xml" MIME body shall be supported at the roaming II-NNI. + +Non-100 provisional responses and the 200 (OK) response to the initial INVITE request containing an "application/vnd.etsi.aoc+xml" MIME body shall be supported at the roaming II-NNI. + +The INFO method containing an "application/vnd.etsi.aoc+xml" MIME body shall be supported at the roaming II-NNI. + +The response code 504 (Server Time-out) shall be supported at the II-NNI. + +A Reason header field containing the protocol value set to "SIP" and the "cause" header field parameter set to "504" or containing the protocol value set to "Q.850" and the "cause" header field parameter set to "31" in the BYE method shall be supported at the II-NNI. + +An "application/vnd.etsi.aoc+xml" MIME body in the BYE request or the final response to the BYE request shall be supported over the roaming II-NNI. + +## 12.23 Completion of Communications on Not Logged-in (CCNL) + +Service specific requirements in accordance with 3GPP TS 24.642 [109] shall be supported over the II-NNI. + +The response code 480 (Temporarily unavailable) containing a Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NL" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +For invoking and revoking of the CCNL supplementary service, announcement procedures shall be used to provide announcements and inband-interaction procedures as described in clause 12.21.3 and clause 12.21.4 shall be supported at the roaming II-NNI. + +The response code 199 (Early Dialog Terminated) shall be supported at the roaming II-NNI. + +Basic call procedures and in case of a call-completion recall initiated by a REFER request, normal REFER method handling procedures according to 3GPP TS 24.229 [5] shall be supported at the roaming II-NNI. + +As a network option the special REFER request handling procedures according to 3GPP TS 24.628 [38] should be supported at the roaming II-NNI. + +NOTE: 3rd party call control procedures can be used when the REFER request is not supported at the II-NNI. + +The SUBSCRIBE and NOTIFY methods according to IETF RFC 6665 [20] and 3GPP TS 24.229 [5] containing the event package name "call-completion" in the Event header field and the Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NL" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The NOTIFY request containing the "application/call-completion" MIME body as defined in IETF RFC 6910 [208] shall be supported at the non-roaming II-NNI. + +The Request-URI with the "m" SIP URI parameter with a value set to "NL" and the Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NL" in the INVITE method shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The Date header field in the 480 (Temporarily Unavailable) response to the INVITE request shall be supported at the roaming II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.24 Unstructured Supplementary Service Data (USSD) + +Service specific requirements in accordance with 3GPP TS 24.390 [163] shall be supported over the II-NNI. + +The Recv-Info header field containing the "g.3gpp.ussd" info package name and the "application/vnd.3gpp.ussd" MIME body as described in annex B of 3GPP TS 24.390 [163] in the INVITE request shall be supported at the roaming II-NNI. + +The Recv-Info header field containing the "g.3gpp.ussd" info package name in the 200 (OK) response to the INVITE request shall be supported at the roaming II-NNI. + +The INFO request containing "application/vnd.3gpp.ussd" MIME body and the Info-Package header field containing the "g.3gpp.ussd" info package name shall be supported at the roaming II-NNI. + +The "application/vnd.3gpp.ussd" MIME body in the BYE request shall be supported at the roaming II-NNI. + +## 12.25 Enhanced Calling Name (eCNAM) + +Service specific requirements in accordance with 3GPP TS 24.196 [217] shall be supported over the II-NNI. + +An initial INVITE request with: + +- a display-name in a From header field; +- a display-name in a P-Asserted-Identity header field; and +- Call-Info header field(s), + +shall be supported at the roaming II-NNI in the direction from home to visited network. + +## 12.26 Multi-Device and Multi-Identity (MuD and MiD) + +### 12.26.1 Multi-Device (MuD) + +Service specific requirements in accordance with 3GPP TS 24.174 [218] shall be supported over the II-NNI. + +NOTE: No specific SIP signalling requirements exist for MuD over the II-NNI. + +### 12.26.2 Multi-Identity (MiD) + +Service specific requirements in accordance with 3GPP TS 24.174 [218] shall be supported over the II-NNI. + +An initial INVITE request, a REFER request and a MESSAGE request with an Additional-Identity header field (as defined in 3GPP TS 24.229 [5] clause 7.2.20) shall be supported over the roaming II-NNI. + +# 13 Interoperability of IMS Centralized Services (ICS) over II-NNI + +## 13.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated service of the IMS Centralized Services (ICS) may be supported on the II-NNI between two IMS networks. The support of ICS is based on agreement between operators. + +If ICS is supported, the related procedures from the 3GPP TS 24.292 [121] and 3GPP TS 29.292 [130] shall be applied with the requirements in the clause 13.2 due to the crossing of the II-NNI. + +## 13.2 IMS Centralized Services (ICS) + +Service specific requirements in accordance with 3GPP TS 24.292 [121] and 3GPP TS 29.292 [130] shall be supported over the II-NNI. + +The "g.3gpp.ics" media feature tag in the Contact header field as specified in annex B of 3GPP TS 24.292 [121] shall be supported at the roaming II-NNI. + +The "g.3gpp.accesstype" media feature tag in the Contact header field as specified in annex B of 3GPP TS 24.292 [121] shall be supported at the roaming II-NNI. + +The "g.3gpp.icsi-ref" media feature tag as specified in 3GPP TS 24.229 [5] the value for the IMS Multimedia Telephony Communication Service as specified in 3GPP TS 24.173 [31] shall be supported at the roaming II-NNI. + +An Accept-Contact header field and a Reject-Contact header field including the media feature tag "g.3gpp.accesstype" and the media feature tag "g.3gpp.ics" in any combination in the INVITE request shall be supported at the roaming II-NNI. + +The Target-Dialog header field in the INVITE request shall be supported at the roaming II-NNI. + +The P-Early-Media header field in the INVITE request and in non-100 provisional responses to the INVITE request shall be supported on the roaming II-NNI. + +The Reason header field containing the protocol value "Q.850" and the header field parameter "cause" with a various set of values in the CANCEL request, the BYE request and in 4xx responses and 6xx responses to the INVITE request shall be supported at the roaming II-NNI. + +The REFER request with the "method" SIP URI parameter set to the value "BYE" or "INVITE" or without the "method" SIP URI parameter in the Refer-To header field as specified in 3GPP TS 24.292 [121] shall be supported at the roaming II-NNI. + +The Event header field containing the event package name "conference" and the Accept header field with "application/conference-info+xml" in a SUBSCRIBE request shall be supported at the roaming II-NNI. + +The Allow-Event header field with "application/conference-info+xml" in an INVITE request shall be supported at the roaming II-NNI. + +The "application/conference-info+xml" MIME body and the Event header field containing the event package name "conference" in a NOTIFY request shall be supported at the roaming II-NNI. + +NOTE: Supplementary services as specified in clause 12 can be supported based on agreement between operators. + +# 14 Interoperability of IMS Service Continuity over II-NNI + +## 14.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated services of the IMS Service Continuity may be supported on the II-NNI between two IMS networks. The support of each service is based on agreement between operators. + +If a service is supported, the related procedures from the 3GPP TS 24.237 [131] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +## 14.2 PS to CS Single Radio Voice Call Continuity (SRVCC) and Single Radio Video Call Continuity (vSRVCC) + +### 14.2.1 Basic PS to CS SRVCC + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +Media type "video" in SDP m-lines may be supported at the roaming II-NNI. Related SDP can appear in SDP offer answer exchanges within INVITE dialogues at the roaming II-NNI, and in responses to OPTIONS requests at the roaming II-NNI. If media type "video" is supported within INVITE dialogues at the roaming II-NNI, it shall also be supported within responses to OPTIONS requests at the roaming II-NNI. + +The "+g.3gpp.srvcc" header field parameter (specified in 3GPP TS 24.237 [131] annex C) in the Feature-Caps header field of the INVITE request and in non-100 provisional responses or the 2xx response should be supported at the roaming II-NNI. + +The Reason header field containing the protocol value set to "SIP" and "cause" header field parameter set to "487" in the re-INVITE request shall be supported at the roaming II-NNI. + +The Reason header field containing the protocol value set to "SIP" and "cause" header field parameter set to "503" in the BYE request shall be supported at the roaming II-NNI. + +Procedures as described in clause 14.4 are used to provide MSC server assisted mid-call features. + +### 14.2.2 PS to CS SRVCC for calls in alerting phase + +The requirements for the PS to CS transfer for alerting calls are the same as in clause 14.2.1 with the following additional requirements: + +The "g.3gpp.srvcc-alerting" media feature tag (described in 3GPP TS 24.237 [131] annex C) in a Contact header field of the INVITE request and in non-100 provisional responses and the 2xx response to the INVITE request shall be supported at the roaming II-NNI. + +The "+g.3gpp.srvcc-alerting" header field parameter (described in 3GPP TS 24.237 [131] annex C) included in a Feature-Caps header field as described in IETF RFC 6809 [143] in an INVITE request and in non-100 provisional responses and the 2xx response to the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported at the roaming II-NNI. + +The Target-Dialog header field in the INVITE request shall be supported at the roaming II-NNI. + +An INFO request containing the Info-Package header field as specified in IETF RFC 6086 [39] with "3gpp.state-and-event" info package name and an "application/vnd.3gpp.state-and-event-info+xml" XML body shall be supported at the roaming II-NNI. + +### 14.2.3 Using the ATCF based architecture + +The requirements for the ATCF based architecture is the same as in clause 14.2.1 with the following additional requirements: + +The "+g.3gpp.atcf", the "+g.3gpp.atcf-mgmt-uri" and the "+g.3gpp.atcf-path" header field parameters (specified in 3GPP TS 24.237 [131] annex C) in the Feature-Caps header field of the REGISTER request as described in IETF RFC 6809 [143] shall be supported at the roaming II-NNI. + +A MESSAGE request containing the "application/vnd.3gpp.srvcc-info+xml" MIME body as defined in annex D of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The URIs of SCC ASs authorised to provide PS to CS SRVCC information in the MESSAGE request need to be specified in the roaming agreement. + +The Target-Dialog header field in the INVITE request shall be supported at the roaming II-NNI. + +### 14.2.4 PS to CS SRVCC for originating calls in pre-alerting phase + +The requirements for the PS to CS transfer for originating calls in pre-alerting phase are the same as in clause 14.2.1 and in clause 14.2.2 with the additional requirements in this clause. + +NOTE: If PS to CS transfer for originating calls in pre-alerting phase is supported also PS to CS SRVCC for calls in alerting phase specified in clause 14.2.2 is supported. + +The "g.3gpp.ps2cs-srvcc-orig-pre-alerting" media feature tag described in 3GPP TS 24.237 [131] annex C in a Contact header field of the REGISTER request and in the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.ps2cs-srvcc-orig-pre-alerting" feature-capability indicator as described in 3GPP TS 24.237 [131] annex C in the Feature-Caps header field as described in IETF RFC 6809 [143] in non-100 provisional responses and the 2xx response to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +### 14.2.5 PS to CS SRVCC with the MSC server assisted mid-call feature + +The requirements for the PS to CS SRVCC with the assisted mid-call feature are the same as in clause 14.2.1 and in clause 14.4. + +### 14.2.6 PS to CS SRVCC for terminating calls in pre-alerting phase + +The requirements for the PS to CS transfer for terminating calls in pre-alerting phase are the same as in clause 14.2.1 and in clause 14.2.2 with the additional requirements in this clause. + +NOTE: If PS to CS transfer for terminating calls in pre-alerting phase is supported also PS to CS SRVCC for calls in alerting phase specified in clause 14.2.2 is supported. + +The "g.3gpp.ps2cs-srvcc-term-pre-alerting" media feature tag described in 3GPP TS 24.237 [131] annex C in a Contact header field of the REGISTER request and in the INVITE request shall be supported at the roaming II-NNI. + +The g.3gpp.ps2cs-srvcc-term-pre-alerting feature-capability indicator as described in 3GPP TS 24.237 [131] annex C in the Feature-Caps header field as described in IETF RFC 6809 [143] in non-100 provisional responses and the 2xx response to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +## 14.3 Inter UE Transfer (IUT) + +IUT is described in clause 18. + +## 14.4 MSC server assisted mid-call feature + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +The Contact header field of the REGISTER request and the 200 (OK) response containing "g.3gpp.mid-call" media feature tag as described in annex C of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The Feature-Cap header field of the REGISTER request and the 200 (OK) response containing "+g.3gpp.mid-call" header field parameter specified in annex C of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The media feature tag "g.3gpp.accesstype" in the Contact header field of the REGISTER request shall be supported at roaming II-NNI. + +A Contact header field of the INVITE request and the 200 (OK) response containing the "g.3gpp.mid-call" media feature tag as described in annex C of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The "g.3gpp.mid-call" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +The Recv-Info header field containing the "g.3gpp.mid-call" package name in the INVITE request as specified in annex D of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +An Accept header field in the INVITE request containing the MIME type "application/vnd.3gpp.mid-call+xml" as specified in clause D.1 of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The "application/vnd.3gpp.mid-call+xml" MIME body described in clause D.1.3 of 3GPP TS 24.237 [131] in the INVITE request shall be supported at the roaming II-NNI. + +The SUBSCRIBE request containing a "g.3gpp.mid-call" media feature tag in the Contact header field shall be supported at the roaming II-NNI. + +NOTE: The "g.3gpp.mid-call" media feature tag in the Contact header field of the SUBSCRIBE request may appear if the CONF supplementary service is supported at roaming II-NNI as described in clause 12.9. + +An INFO request containing the Info-Package header field as specified in IETF RFC 6086 [39] with "3gpp.state-and-event" info package name and an "application/vnd.3gpp.state-and-event-info+xml" XML body shall be supported at the roaming II-NNI. + +A REFER request sent inside an existing SIP dialog containing the "application/vnd.3gpp.mid-call+xml" MIME body specified in the clause D.1.3 of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The Contact header field of the REFER request and the 2xx response to the request containing "g.3gpp.mid-call" media feature tag as described in annex C of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The Target-Dialog header field in the INVITE request shall be supported at the roaming II-NNI. + +The communication HOLD supplementary service as specified in clause 12.8 for the roaming II-NNI shall be supported. + +The Allow-Event header field with "application/conference-info+xml" in an INVITE request shall be supported at the roaming II-NNI. + +The Event header field containing the event package name "conference" and the Accept header field with "application/conference-info+xml" in a SUBSCRIBE request shall be supported at the roaming II-NNI. + +The "application/conference-info+xml" MIME body and the Event header field containing the event package name "conference" in a NOTIFY request shall be supported at the roaming II-NNI. + +The REFER request with the "method" header field parameter set to the value "BYE" sent in the Refer-To header field shall be supported at the roaming II-NNI. + +## 14.5 CS to PS Single Radio Voice Call Continuity (SRVCC) + +### 14.5.1 Basic CS to PS SRVCC + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +Requirements for the ATCF based architecture at II-NNI as described in clause 14.2.3 shall be supported at the roaming II-NNI. + +Requirements for IMS Centralized Services (ICS) at II-NNI as described in clause 13 shall be supported at the roaming II-NNI. + +The "g.3gpp.cs2ps-srvcc" and "g.3gpp.path" media feature tags in the Contact header field of the REGISTER request shall be supported at the roaming II-NNI. + +The Feature-Caps header field with the "g.3gpp.cs2ps-srvcc" feature-capability indicator in the REGISTER request shall be supported at the roaming II-NNI. + +The MESSAGE request containing the Accept-Contact header field with the "g.3gpp.path" media feature tag and the "application/vnd.3gpp.srvcc-ext+xml" MIME body shall be supported at the roaming II-NNI. + +The URIs of SCC ASs authorised to provide CS to PS SRVCC information in the MESSAGE request need to be specified in the roaming agreement. + +### 14.5.2 CS to PS SRVCC for calls in alerting phase + +The requirements for the CS to PS SRVCC for calls in alerting phase are the same as in clause 14.5.1 with the following additional requirement: + +The "g.3gpp.cs2ps-srvcc-alerting" media feature tag in the Contact header field of the REGISTER request shall be supported at the roaming II-NNI. + +The REFER request sent inside an existing SIP dialog with the Refer-Sub header field and the "application/vnd.3gpp.state-and-event-info+xml" MIME body shall be supported at the roaming II-NNI. + +The INFO request with the Info-Package header field containing the "g.3gpp.state-and-event" package name and the "application/vnd.3gpp.state-and-event-info+xml" MIME body shall be supported at the roaming II-NNI. + +### 14.5.3 CS to PS SRVCC with the assisted mid-call feature + +The requirements for the CS to PS SRVCC with the assisted mid-call feature are the same as in clause 14.5.1 with the following additional requirement: + +The "application/vnd.3gpp.access-transfer-events+xml" MIME body in the REFER request shall be supported at the roaming II-NNI. + +## 14.6 PS to CS dual radio voice call continuity (DRVCC) + +### 14.6.1 Basic PS to CS DRVCC + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +The "g.3gpp.dynamic-stn" media feature tag according to 3GPP TS 24.237 [131] annex C included in the Contact header field of the INVITE request and in responses to the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.dynamic-stn" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +NOTE 1: The g.3gpp.dynamic-stn feature capability indicator from the home network contains an STN. The STN is a tel URI that the UE will use when establishing the call in CS. If the STN is known by the visited network the STN can also be used to identify that a call from a UE is a PS to CS dual radio access transfer allowing the visited network to suppress services and announcement that otherwise is executed during the CS call setup. The value of the tel URI STN needs to be communicated between operators when DRVCC is supported. + +The requirements for providing IMS Centralized Services (ICS) as described in clause 13.2 should be supported at the roaming II-NNI. + +NOTE 2: The support of IMS Centralized Services (ICS) as described in clause 13.2 is only needed if MSC servers in the visited network are enhanced for ICS. + +### 14.6.2 PS to CS DRVCC with the assisted mid-call feature + +The requirements for the PS to CS DRVCC with the assisted mid-call feature are the same as in clause 14.6.1 and in clause 14.4. + +NOTE: Transfer of an additional call requires the use of IMS Centralized Services (ICS). + +### 14.6.3 PS to CS DRVCC for calls in alerting phase + +The requirements for the PS to CS DRVCC for calls in alerting phase are the same as in clause 14.6.1 with the additional requirements in this clause. + +The "g.3gpp.drvcc-alerting" media feature tag according to 3GPP TS 24.237 [131] annex C and IETF RFC 3840 [56] included in the Contact header field of the INVITE request and in responses to the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.drvcc-alerting" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +A 488 (Not Acceptable Here) response to the INVITE request without an SDP body shall be supported at the roaming II-NNI. + +### 14.6.4 PS to CS DRVCC for originating calls in pre-alerting phase + +The requirements for the PS to CS DRVCC for originating calls in pre-alerting phase are the same as in clause 14.6.1 and in clause 14.6.3 with the additional requirements in this clause. + +The "g.3gpp.ps2cs-drvcc-orig-pre-alerting" media feature tag according to 3GPP TS 24.237 [131] annex C and IETF RFC 3840 [56] in the Contact header field of the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.ps2cs-drvcc-orig-pre-alerting" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +## 14.7 CS to PS Dual Radio Voice Call Continuity (DRVCC) + +### 14.7.1 Basic CS to PS DRVCC + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +The requirements for providing IMS Centralized Services (ICS) as described in clause 13.2 should be supported at the roaming II-NNI. + +NOTE: The support of IMS Centralized Services (ICS) as described in clause 13.2 is only needed if MSC servers in the visited network are enhanced for ICS. + +### 14.7.2 CS to PS DRVCC with the assisted mid-call feature + +The requirements for the PS to CS DRVCC with the assisted mid-call feature are the same as in clause 14.7.1 and in clause 14.4. + +### 14.7.3 CS to PS DRVCC for calls in alerting phase + +The requirements for the CS to PS DRVCC for calls in alerting phase are the same as in clause 14.7.1 with the additional requirements in this clause. + +The "g.3gpp.cs2ps-drvcc-alerting" media feature tag as described included in the Contact header field of the INVITE request and in responses to the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.cs2ps-drvcc-alerting" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +A 488 (Not Acceptable Here) response to the INVITE request without an SDP body shall be supported at the roaming II-NNI. + +### 14.7.4 CS to PS DRVCC for originating calls in pre-alerting phase + +The requirements for the CS to PS DRVCC for originating calls in pre-alerting phase are the same as in clause 14.7.1 and in clause 14.7.3 with the following additional requirements: + +The "g.3gpp.cs2ps-drvcc-orig-pre-alerting" media feature tag according to 3GPP TS 24.237 [131] annex C and IETF RFC 3840 [56] in the Contact header field of the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.cs2ps-drvcc-orig-pre-alerting" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +## 14.8 PS to PS access transfer + +Service specific requirements in accordance with 3GPP TS 24.237 [131] clause 10 shall be supported over the roaming II-NNI. + +The "g.3gpp.pstops-sti" media feature tag in the Contact header field of the REGISTER request shall be supported at the roaming II-NNI. + +The INVITE request containing: + +- a) the "g.3gpp.ics" media feature tag; and +- b) either: + - the Replaces header field and the option tag value "replaces" in the Require header field; or + - the Target-Dialog header field and the option tag value "tdialog" in the Require header field, + +shall be supported at the roaming II-NNI. + +A Recv-Info header field containing the "g.3gpp.state-and-event" info package name in the 183 (Session Progress) response shall be supported at the roaming II-NNI. + +The INFO request containing the Info-Package header field as specified in IETF RFC 6086 [39] with the "g.3gpp.state-and-event" info package name and the "application/vnd.3gpp.state-and-event-info+xml" XML body shall be supported at the roaming II-NNI. + +# 15 Presence service + +## 15.0 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated functions of the Presence service may be supported on the II-NNI between two IMS networks. The support of each function is based on agreement between operators. + +If a function is supported, the related procedures from the 3GPP TS 24.141 [132] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +## 15.1 Subscription of presence information + +Service specific requirements in accordance with 3GPP TS 24.141 [132] shall be supported over the II-NNI. + +A PUBLISH request identifying the presentity using a SIP URI, a tel URI or a PRES URI and the Event header field with the value "presence" and containing an "application/pidf+xml" MIME body shall be supported at the roaming II-NNI. + +Additionally to the above and in any combination, a Content-Type header field with the value "multipart/related" and an "application/pidf-diff+xml" MIME body can be included in the PUBLISH request and shall be supported at the roaming II-NNI. + +A SUBSCRIBE request with a Request-URI containing a SIP URI, a tel URI or a pres URI, the Event header field set to "presence" and Accept header fields with values "application/pidf+xml" and "multipart/related" shall be supported at the II-NNI. + +Additionally to the above an "application/simple-filter+xml" MIME body can appear in the SUBSCRIBE request and shall be supported at the II-NNI. + +Additionally to the above and in any combination a Content-Type header field with the value "multipart/mixed" and an "application/resource-lists" MIME body can appear in the SUBSCRIBE request and shall be supported at the roaming II-NNI. + +A NOTIFY request including an Event header field with the value "presence" and an "application/pidf" MIME body shall be supported at the II-NNI. + +NOTE: The NOTIFY request can contain substantial amount of data and TCP is expected to be used as the transport protocol. + +The Allow-Events header field with the value "presence" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI. + +## 15.2 Watcher subscribing to Presence List + +Service specific requirements in accordance with 3GPP TS 24.141 [132] shall be supported over the II-NNI. + +The requirements for the watcher subscribing to the Presence List are the same as subscribing to presence information as specified in clause 15.1 with the following additional requirement: + +- The SUBSCRIBE request containing a Supported header field with the value "eventlist" shall also be supported at the roaming II-NNI; +- The SUBSCRIBE request containing a Accept header field with the value "application/rlmi+xml" shall be supported at the roaming II-NNI; +- A response code 200 (OK) to the SUBSCRIBE request containing the Require header field with the value "eventlist" shall be supported at the roaming II-NNI; and + +- A NOTIFY message containing the "multipart/related" content type and an "application/rlmi+xml" MIME body shall be supported at the roaming II-NNI. + +NOTE: The NOTIFY request can contain substantial amount of data and TCP is expected to be used as the transport protocol. + +## 15.3 Subscription to Watcher Information + +Service specific requirements in accordance with 3GPP TS 24.141 [132] shall be supported over the II-NNI. + +A SUBSCRIBE request containing an Event header field with the value "presence.wininfo" and an Accept header field with value "application/watcherinfo+xml" shall be supported at the roaming II-NNI. + +A NOTIFY request containing the Event header field with the value "presence.wininfo" and an "application/watcherinfo+xml" MIME body shall be supported at the roaming II-NNI. + +NOTE: The NOTIFY request can contain substantial amount of data and TCP is expected to be used as the transport protocol. + +The Allow-Events header field with the value "presence.wininfo" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI. + +## 15.4 Subscription to state changes in XML documents + +Service specific requirements in accordance with 3GPP TS 24.141 [132] shall be supported over the II-NNI. + +A SUBSCRIBE request containing the Event header field with the value "xcap-diff" and parameters specified in IETF RFC 5875 [134], using the updated procedures from IETF RFC 6665 [20], shall be supported at the roaming II-NNI. + +A NOTIFY request containing the Event header field with the value "xcap-diff", the Content-Type header field with the value "multipart/mixed" and any MIME body shall be supported at the roaming II-NNI. + +NOTE: The NOTIFY request can contain substantial amount of data and TCP is expected to be the transport protocol. + +The Allow-Events header field with the value "xcap-diff" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI. + +For backward compatible reasons the Event header field with the value "ua-profile" should be supported at the roaming II-NNI. + +## 15.5 Presence enhancements specified in Open Mobile Alliance (OMA) Release 1.1 + +### 15.5.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated functions of the OMA Presence service may be supported on the II-NNI between two IMS networks. The support of each function is based on agreement between operators. + +If a function of the OMA Presence Release 1.1 is supported, the related procedures from the OMA-TS-Presence\_SIMPLE-V1\_1\_1 [142] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +### 15.5.2 OMA subscription of presence information + +The requirements for the OMA subscription of presence information are the same as clause 15.1. + +### 15.5.3 OMA watcher subscribing to Presence List + +The requirements for the OMA watcher subscribing to Presence List are the same as clause 15.2. + +### 15.5.4 OMA subscription to Watcher Information + +The requirements for the OMA subscription to Watcher Information are the same as clause 15.3. + +## 15.6 Presence enhancements specified in Open Mobile Alliance (OMA) Release 2.0 + +### 15.6.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated functions of the OMA Presence service may be supported on the II-NNI between two IMS networks. The support of each function is based on agreement between operators. + +If a function of the OMA Presence Release 2.0 is supported, the related procedures from the OMA-TS-Presence\_SIMPLE-V2\_0 [138] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +### 15.6.2 OMA subscription of presence information + +The requirements for the OMA subscription of presence information are the same as clause 15.5.2 with the following additional requirement: + +- An Allow header field containing the value "REFER" in a PUBLISH request shall be supported at the II-NNI. +- A Policy-Contact header field defined in IETF RFC 6794 [133] in a 488 (Not Acceptable Here) response to a PUBLISH request shall be supported at the II-NNI. + +NOTE: Conveyance of this header field in a 488 response to a PUBLISH request is not supported by IETF RFC 6794 [133] but is required to support Presence services according to OMA specifications OMA-TS-Presence\_SIMPLE-V2\_0 [138]. + +- A Suppress-If- Match header field in a SUBSCRIBE request shall be supported at the II-NNI. +- An Accept-Encoding header field containing the value "gzip" in a SUBSCRIBE request shall be supported at the II-NNI. +- An "application/vnd.oma.supnot+xml" MIME body in a SUBSCRIBE request shall be supported at the II-NNI. +- A Content-Encoding header field containing the value "gzip" in a NOTIFY request shall be supported at the II-NNI. +- A Content-Type header field with the value "multipart/mixed" in a SUBSCRIBE request shall be supported at the II-NNI. +- A Refer-To header field with the value "method=PUBLISH?event=presence", a Refer-Sub header field and a SIP-If-Match header field in a REFER request shall be supported at the II-NNI. + +### 15.6.3 OMA watcher subscribing to Presence List + +The requirements for the OMA watcher subscribing to Presence List are the same as clause 15.5.3 with the following additional requirements: + +- A Suppress-If-Match header field in a SUBSCRIBE request shall be supported at the II-NNI. +- An Accept-Encoding header field containing the value "gzip" in a SUBSCRIBE request shall be supported at the II-NNI. + +- An "application/vnd.oma.supnot+xml" MIME body in a SUBSCRIBE request shall be supported at the II-NNI. +- An "application/resource-lists+xml" MIME body in a SUBSCRIBE request shall be supported at the II-NNI. +- A Content-Type header field with the value "multipart/mixed" in a SUBSCRIBE request shall be supported at the II-NNI. +- A NOTIFY request with a Content-Encoding header field containing the value "gzip" shall be supported at the II-NNI. + +### 15.6.4 OMA subscription to Watcher Information + +The requirements for the OMA subscription to Watcher Information are the same as clause 15.5.4 with the following additional requirements: + +- Indicating support for "multipart/mixed" and "application/simple-filter+xml" in the Accept header field of the SUBSCRIBE request shall be supported at the II-NNI. +- Multiple "application/simple-filter+xml" MIME bodies in the NOTIFY request shall be supported at the II-NNI. +- A Suppress-If-Match header field in a SUBSCRIBE request shall be supported at the II-NNI. +- An Accept-Encoding header field containing the value "gzip" in the SUBSCRIBE request shall be supported at the II-NNI. +- A Content-Type header field with the value "multipart/mixed" in a NOTIFY request shall be supported at the II-NNI. +- A Content-Encoding header field with the value "gzip" in a NOTIFY request shall be supported at the II-NNI. +- A Refer-To header field with the value "method=SUBSCRIBE?Event=presence.wininfo" and a Refer-Sub header field in a REFER request sent to a Watcher Information Subscriber shall be supported at the II-NNI. + +### 15.6.5 Subscription to state changes in XML documents + +The requirements for the OMA watcher subscribing to Presence List are the same as clause 15.4 with the following additional requirements: + +- An Accept header field indicating the support for "application/xcap-diff+xml", "application/rlmi+xml" and "multipart/related" in a SUBSCRIBE request shall be supported at the II-NNI. +- An Accept-Encoding header field with the value "gzip" in a SUBSCRIBE request shall be supported at the II-NNI. +- A Content-Encoding header field containing the value "gzip" in a NOTIFY request shall be supported at the II-NNI. +- Multiple "multipart/related" MIME bodies in a NOTIFY request shall be supported at the II-NNI. +- An "application/rlmi+xml" MIME bodies in a NOTIFY request shall be supported at the II-NNI. + +15.6.6 Void + +15.6.7 Void + +# --- 16 Messaging service + +## 16.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated function of the messaging service may be supported on the II-NNI between two IMS networks. + +If a function is supported, the related procedures from the 3GPP TS 24.247 [139] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +## 16.2 Page-mode messaging + +Service specific requirements in accordance with clause 5 of 3GPP TS 24.247 [139] shall be supported over the II-NNI. + +A MESSAGE request containing the "application/recipient-list" MIME body specified in IETF RFC 5365 [67], a Required header field with the 'recipient-list-message' option-tag; and a body carrying payload shall be supported at the roaming II-NNI. + +A MESSAGE request containing: + +- a body that carrying payload; or +- the "application/im-iscomposing+xml" MIME body, + +shall be supported at the II-NNI. + +The response code 415 (Unsupported Media Type) and the response code 202 (Accepted) shall be supported at the II-NNI. + +## 16.4 Session-mode messaging + +Service specific requirements in accordance with clause 6 of 3GPP TS 24.247 [139] shall be supported over the II-NNI. + +No restrictions at the II-NNI identified. + +## 16.5 Session-mode messaging conferences + +Service specific requirements in accordance with clause 7 of 3GPP TS 24.247 [139] and 3GPP TS 24.147 [106] shall be supported over the II-NNI. + +The "application/resource-lists+xml" MIME body included in the INVITE request shall be supported at the roaming II-NNI. + +The media feature tag "isfocus" in the Contact header field of the INVITE request and responses to the INVITE request shall be supported at the II-NNI. + +The SUBSCRIBE request including the "conference" event package name in the Event header field and the Accept header field containing an "application/conference-info+xml" MIME type shall be supported at the II-NNI. + +The NOTIFY request including an "application/conference-info+xml" MIME body shall be supported at the II-NNI. + +The REFER request containing a Referred-By header field and NOTIFY requests procedures shall be supported at the II-NNI. + +The REFER request containing the BYE method URI parameter in the Refer-To header field shall be supported at the II-NNI. + +The Referred-By header field in the INVITE request shall be supported at the II-NNI. + +The Allow-Events header field in the INVITE request with the value "conference" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI. + +# --- 17 Optimal Media Routeing + +## 17.1 General + +Based on inter-operator agreement, the Optimal Media Routeing (OMR) procedures may be supported over the II-NNI. + +If OMR procedures are supported, the procedures in 3GPP TS 29.079 [148] shall be applied and the capabilities below shall be provided at the II-NNI. + +## 17.2 OMR related SDP attributes + +The "visited-realm", "secondary-realm", "omr-codecs", "omr-m-att", "omr-s-att", "omr-m-bw", "omr-s-bw", "omr-s-cksum", and "omr-m-cksum" SDP attributes defined in 3GPP TS 24.229 [5] shall be supported at the II-NNI. + +## 17.3 IP realm names + +Operators need to agree on unique names for IP realms (as defined in 3GPP TS 29.079 [148]) used in their own and interconnecting networks to avoid a collision of IP realm names. Operators may choose to share an IP realm, and shall then also assign a single unique name to that realm. As defined in 3GPP TS 24.229 [5], a public IPv4 or IPv6 address reachable from the open internet is associated with the special realm "IN". + +# --- 18 Inter-UE transfer (IUT) + +## 18.1 General + +Inter-UE transfer may be supported over the II-NNI. The IUT consist of several functional blocks, as described in the clauses below. The support of each of these functional blocks is based on agreement between operators. + +If a function is supported, the related procedures from the 3GPP TS 24.337 [149] shall be applied with the requirements in the relevant clause below. + +## 18.2 IUT without establishment of a collaborative session + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The REFER request shall be supported at the roaming II-NNI. + +The Refer-To header field containing a body parameter including a Replaces header field and the Require header field set to "replaces" shall be supported at the roaming II-NNI. + +The Refer-To header field containing a body parameter including a Target-Dialog header field and the Require header field set to "tdialog" shall be supported at the roaming II-NNI. + +The Refer-To header field containing a body parameter including an Accept-Contact header field with the "g.3gpp.icsi-ref" media feature tag and a P-Preferred-Service header field set to the IMS communication service identifier shall be supported at the roaming II-NNI. + +The Contact header field of the REFER request containing a public GRUU or temporary GRUU as specified in 3GPP TS 24.229 [5] shall be supported at the roaming II-NNI. + +The "g.3gpp.icsi-ref" media feature tag in the Accept-Contact header field of the REFER request shall be supported at the roaming II-NNI. + +NOTIFY requests containing a "sipfrag" MIME body as specified in IETF RFC 3515 [22], using the updated procedures from IETF RFC 6665 [20], shall be supported at the roaming II-NNI. + +## 18.3 IUT using a collaborative session + +### 18.3.1 Collaborative session of participants of the same subscription + +This clause describes the requirements at the II-NNI for an ongoing session. Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The "g.3gpp.iut-controller" media feature tag in the Accept-Contact header field in the REGISTER request shall be supported. + +A REFER request sent outside an existing dialog shall be supported at the roaming II-NNI with the following additional requirements: + +- The Refer-To header field containing a body parameter including a MIME sdp body and no method parameter, the method parameter set to "INVITE" or "BYE" shall be supported at the roaming II-NNI. +- The Accept header field containing the MIME type "message/sipfrag" in the REFER request shall be supported at the roaming II-NNI. +- The Target-Dialog header field in the REFER request shall be supported at the roaming II-NNI. +- The Contact header field in the REFER request containing the "g.3gpp.iut-controller" media feature tag as described in annex B of 3GPP TS 24.337 [149] shall be supported at the roaming II-NNI. +- The Contact header field in the REFER request containing the "g.3gpp.current-iut-controller" media feature tag as described in annex B of 3GPP TS 24.337 [149] shall be supported at the roaming II-NNI. +- The "g.3gpp.iut-controller" media feature tag in the Accept-Contact header field shall be supported at the roaming II-NNI. +- The Referred-By header field shall be supported at the roaming II-NNI at the roaming II-NNI. + +The NOTIFY request containing a "sipfrag" MIME body as specified in IETF RFC 3515 [22], using the updated procedures from IETF RFC 6665 [20], shall be supported at the roaming II-NNI. + +Initial INVITE requests and re-INVITE requests as follows: + +- The Referred-By header field included in initial INVITE requests and re-INVITE requests shall be supported at the roaming II-NNI; +- The "g.3gpp.iut-controller" media feature tag as described in annex B of 3GPP TS 24.337 [149] in the Contact header field shall be supported at the roaming II-NNI. + +The "g.3gpp.iut-controller" media feature tag in responses to the INVITE request shall be supported at the roaming II-NNI. + +The SUBSCRIBE request including the Event header field with the "dialog" event package; and including the Accept-Contact header field with the "g.3gpp.iut-focus" media feature shall be supported at the roaming II-NNI. + +The "dialog-info+xml" MIME body in NOTIFY requests shall be supported at the roaming II-NNI. + +### 18.3.2 Establishment of a collaborative session during session setup + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The Accept header field containing the MIME type "application/vnd.3gpp.iut+xml" in initial INVITE requests shall be supported at the roaming II-NNI. + +A Content-Type header field containing the MIME type "application/vnd.3gpp.iut+xml" and an "application/vnd.3gpp.iut+xml" MIME body in the 300 (Multiple Choices) response shall be supported at the roaming II-NNI. + +### 18.3.3 Assignment and transfer of control of a collaborative session + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The "g.3gpp.current-iut-controller" media feature tag in the Contact header field of the 200 (OK) response to INVITE request shall be supported at the roaming II-NNI. + +A "multipart/mixed" MIME body containing the "application/vnd.3gpp.iut+xml" and the "application/sdp" MIME bodies in the INVITE request shall be supported at the roaming II-NNI. + +### 18.3.4 Collaborative session of participants of different subscriptions + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +In addition to the requirements in clause 18.3.1, 18.3.2 or 18.3.3 the following applies: + +- The "g.3gpp.iut-focus" media feature tag (specified in 3GPP TS 24.337 [149] annex B) in the Contact header field shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. +- The "+g.3gpp.iut-focus" header field parameter (specified in 3GPP TS 24.337 [149] annex B) in the Feature-Caps header field as described in IETF RFC 6809 [143] shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +## 18.4 Session replication / media replication + +### 18.4.1 Pull mode + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The Target-Dialog header field and the Accept-Contact header field containing the "g.3gpp.iut-focus" media feature tag of the INVITE request shall be supported at the roaming II-NNI. + +A REFER request including: + +- the method parameter set to "MESSAGE" in the Refer-To header field; +- the In-Reply-To header field; +- the Target-Dialog header field; +- the Require header field populated with the option tag value "tdialog"; and +- the "application/vnd.3gpp.replication+xml" MIME body, + +shall be supported at the roaming II-NNI. + +A MESSAGE request including the In-Reply-To header field and the "application/vnd.3gpp.replication+xml" MIME body shall be supported at the roaming II-NNI. + +### 18.4.2 Push mode + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +A REFER request including: + +- the Accept-Contact header field containing the "g.3gpp.iut-focus" media feature tag with explicit and require tags; +- the Target-Dialog header field; and +- the Refer-To header field containing the Accept-Contact header field, the P-Preferred-Service header field and the "application/sdp" MIME body, + +shall be supported at the roaming II-NNI. + +The "application/vnd.3gpp.replication+xml" MIME body of the REFER request shall be supported at the roaming II-NNI. + +# --- 19 Roaming Architecture for Voice over IMS with Local Breakout + +Based on inter-operator agreement, the roaming architecture for voice over IMS with local breakout procedure may be supported over the II-NNI. + +If the roaming architecture for voice over IMS with local breakout procedure is supported, the procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +The "+g.3gpp.trf" header field parameter (defined in 3GPP TS 24.229 [5] clause 7.9A.3) with a TRF address included in a Feature-Caps header field as described in IETF RFC 6809 [143] in the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported at the roaming II-NNI. + +The "+g.3gpp.loopback" header field parameter (defined in 3GPP TS 24.229 [5] clause 7.9A.4) with the identity of the caller's home network included in the Feature-Caps header field as described in IETF RFC 6809 [143] in the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported for the loopback traversal scenario. + +The "loopback-indication" header field parameter (defined in 3GPP TS 24.229 [5] clause 7.2A.5) included the P-Charging-Vector header field in 18x and 2xx responses to the INVITE request , in subsequent requests and in responses to subsequent requests shall be supported for the loopback traversal scenario and at the roaming II-NNI. + +The procedures in clause 17 shall be supported at the II-NNI. + +# --- 20 Delivery of Media Resource Broker address information + +Based on inter-operator agreement, the procedure to deliver MRB address information may be supported over the roaming II-NNI. + +NOTE: Subsequent interaction between home network MRB and visited network MRB is outside the scope of this document. + +If the procedure to enable optimised allocation of media resources is supported, the procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the roaming II-NNI. + +The "g.3gpp.mrb" feature-capability indicator (defined in 3GPP TS 24.229 [5] clause 7.9A.6) with the MRB address included in the Feature-Caps header field as described in IETF RFC 6809 [143] in the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported at the roaming II-NNI. + +# --- 21 Overload control + +## 21.1 General + +Based on inter-operator agreement, overload control may be supported over the II-NNI. + +The overload control defines two optional mechanisms: + +- a feedback based mechanism; +- and a load filter mechanism. + +The support of either one of the mechanism is based on operator agreements. + +If a mechanism is supported, the related procedures from the 3GPP TS 24.229 [5] shall be applied with the requirements in the relevant clause below. + +Based on regional/national requirements and inter-operator agreement, Multimedia Priority Service (MPS), as specified in 3GPP TS 22.153 [187], shall be exempted from SIP overload controls across II-NNI up to the point where further exemption would cause network instability. + +## 21.2 Feedback based mechanism + +The procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +The feedback based mechanism, defined in IETF RFC 7339 [165], requires no additional support at the II-NNI as it is supported using header field parameters within existing header fields supported at the II-NNI. + +**NOTE:** An algorithm will need to be selected. The IETF RFC 7339 [165] also defines the default algorithm for usage of the feedback based mechanism in the IM CN subsystem. Additional algorithms are either already defined, e.g. the rate-based scheme defined in IETF RFC 7415 [166], or can also be defined in the future. + +## 21.3 The load filter mechanism + +The procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +A SUBSCRIBE request containing the Event header field "load-control" and, optionally, an Accept header field containing the "application/load-control+xml" MIME type as defined in IETF RFC 7200 [167] shall be supported on the II-NNI. + +**NOTE:** The addresses to targets that can be supervised need to form part of the service level agreement. + +A NOTIFY request containing the "application/load-control+xml" MIME body defined in IETF RFC 7200 [167] shall be supported on the II-NNI. + +# --- 22 Delivery of original destination identity + +Based on inter-operator agreement, the procedure to deliver original identity may be supported over the II-NNI. + +**NOTE:** Service requirement related to the procedure is available in 3GPP TS 22.228 [9]. + +If the procedure to enable delivery of original destination identity is supported, the procedures in 3GPP TS 24.229 [5] shall be supported as further specified below. + +The "mp" header field parameter in the History-Info header field of the initial INVITE request, as defined in IETF RFC 7044 [25], shall be supported over the II-NNI. + +# 23 Telepresence using IMS + +Based on inter-operator agreement, the procedure to support telepresence using IMS may be supported over the II-NNI. + +NOTE: Service requirement related to the procedure is available in clause 7.10.2.2 of 3GPP TS 22.228 [9]. + +If the telepresence using IMS is supported, the procedures in 3GPP TS 24.103 [189] shall be applied and the capabilities below shall be provided at the II-NNI. + +The "+sip.clue" header field parameter included in a Contact header field as described in 3GPP TS 24.103 [189] in the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported at the II-NNI. + +# 24 Barring of premium rate numbers + +Based on inter-operator agreement, barring of premium rate numbers as described in 3GPP TS 24.315 [191] may be supported over the II-NNI. + +If barring of premium rate numbers is supported, the "premium-rate" tel URI parameter defined in 3GPP TS 24.229 [5] clause 7.2A.17 shall be supported at the roaming II-NNI. + +# 25 P-CSCF restoration + +## 25.1 General + +Based on inter-operator agreement, P-CSCF restoration may be supported over the II-NNI. + +The P-CSCF restoration defines two optional mechanisms: + +- a PCRF or PCF based mechanism; and + +NOTE 1: In 5GS the mechanism is called "PCF based P-CSCF restoration" since the PCF takes the role of the PCRF. + +- an HSS or UDM/HSS based mechanism. + +NOTE 2: In 5GS the mechanism is called "UDM/HSS based P-CSCF restoration" since the UDM participates in the procedure. + +The support of either one of the mechanisms is based on operator agreements. + +If a mechanism is supported, the related procedures from the 3GPP TS 24.229 [5] shall be applied with the requirements in the relevant clause below. + +## 25.2 PCRF or PCF based P-CSCF restoration + +The procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +The Restoration-Info header field containing IMSI information defined in 3GPP TS 24.229 [5] in the home-to-visited initial INVITE request shall be supported on the roaming II-NNI. + +## 25.3 HSS or UDM/HSS based P-CSCF restoration + +The procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +The Restoration-Info header field containing information about failed node defined in 3GPP TS 24.229 [5] in the 408 (Request Timeout) response to the home-to-visited initial INVITE request and in the 504 (Server Time-out) response to + +the MESSAGE request, NOTIFY request, OPTIONS request, PUBLISH request, REFER request and the SUBSCRIBE request shall be supported on the roaming II-NNI. + +# --- 26 Resource sharing + +Based on inter-operator agreement, resource sharing may be supported over the II-NNI. + +If resource sharing is supported, the related procedures from the 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +The Resource-Share header field shall be supported on the roaming II-NNI in the following SIP requests and SIP responses: + +- the ACK request, the INVITE request, the PRACK request, the REGISTER and UPDATE; +- 18x responses to the INVITE request; and +- 2xx responses to the PRACK request, INVITE request and the UPDATE request. + +# --- 27 Service access number translation + +Based on inter-operator agreement, service access number translation may be supported over the II-NNI. + +If service access number translation is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +The Request-URI containing a "cause" SIP URI parameter, defined in IETF RFC 4458 [58], set to the value "380" defined in IETF RFC 8119 [193] shall be supported at the II-NNI. + +The History-Info header field containing a "cause" SIP URI parameter, defined in IETF RFC 4458 [58], set to the value "380" defined in IETF RFC 8119 [193] shall be supported at the II-NNI. + +# --- 28 Mission critical services + +## 28.1 General + +In order to assure the end-to-end service interoperability through the II-NNI, the associated services of the Mission Critical communication may be supported on the II-NNI. The support of mission critical services is based on the business relationships defined in 3GPP TS 23.280 [200] clause 6. + +II-NNI requirements for SIP signalling related to mission critical services interface SIP-1 and SIP-3 (see figure 7.3.1-2 in 3GPP TS 23.280 [200]) are addressed in the present specification as follows: + +- Apart from differences specified in the present clause 28, the SIP-1 interface is identical to the roaming II-NNI. +- Apart from differences specified in the present clause 28, the SIP-3 interface is identical to the non-roaming II-NNI. + +SIP signalling traversing the NNI between an mission critical services server and a SIP core (interface SIP-2 in figure 7.3.1-2 in 3GPP TS 23.280 [200]) is not considered in the present release of this specification. + +The mission critical services are identified by means of the following IMS Communication Service Identifiers: + +- 1) for MCPTT, the "urn:urn-7:3gpp-service.ims.icsi.mcptt" URN (defined in annex E of 3GPP TS 24.379 [201]) ; +- 2) for mission critical video communications, the "urn:urn-7:3gpp-service.ims.icsi.mcvideo" URN (defined in annex E of 3GPP TS 24.281 [210]); and + +- 3) for mission critical data communications, the "urn:urn-7:3gpp-service.ims.icsi.mcdata" URN (defined in annex C of 3GPP TS 24.282 [211]) and additionally: + - for Short Data Service (SDS), the "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" URN (defined in annex C of 3GPP TS 24.282 [211]); and + - for File Distribution (FD), the "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" URN (defined in annex C of 3GPP TS 24.282 [211]). + +The IMS Communication Service Identifiers listed above can appear in: + +- the media feature tag "g.3gpp.icsi-ref" (specified in 3GPP TS 24.229 [5] clause 7.9.2) in the Contact header field and the Accept-Contact header field; +- the P-Asserted-Service header field; and +- the P-Preferred-Service header field. + +If the mission critical services are supported, the related procedures from 3GPP TS 24.379 [201], 3GPP TS 24.380 [202], 3GPP TS 24.281 [210], 3GPP TS 24.581 [212], 3GPP TS 24.282 [211] and 3GPP TS 24.582 [213] shall be applied with the requirements in the clauses below due to the crossing of the II-NNI. + +## 28.2 Interoperability of mission critical services for communication over II-NNI + +### 28.2.1 Mission Critical services session establishment + +Service specific requirements in accordance with 3GPP TS 22.179 [199], 3GPP TS 22.280 [209], 3GPP TS 24.379 [201], 3GPP TS 24.281 [210] and 3GPP TS 24.282 [211] shall be supported over the II-NNI. + +The INVITE request including: + +#### A) For MCPTT: + +- 1) the "g.3gpp.mcptt" media feature tag (defined in annex C of 3GPP TS 24.379 [201]) in the Contact header field; +- 2) the media feature tag "isfocus" (defined in IETF RFC 3840 [56]) in the Contact header field; +- 3) the Content-Type header field with the value "multipart/mixed"; and +- 4) the "application/vnd.3gpp.mcptt-info+xml" MIME body; + +#### B) For MCVideo: + +- 1) the "g.3gpp.mcvideo" media feature tag (defined in annex D of 3GPP TS 24.281 [210]) in the Contact header field; +- 2) the media feature tag "isfocus" (defined in IETF RFC 3840 [56]) in the Contact header field; +- 3) the Content-Type header field with the value "multipart/mixed"; and +- 4) the "application/vnd.3gpp.mcvideo-info+xml" MIME body; + +#### C) For MCData: + +- 1) the: + - a) "g.3gpp.mcdata.sds" media feature tag; or + - b) "g.3gpp.mcdata.fd" media feature tag,(defined in annex B of 3GPP TS 24.282 [211]) in the Contact header field; + +- 2) the media feature tag "isfocus" (defined in IETF RFC 3840 [56]) in the Contact header field; +- 3) the Content-Type header field with the value "multipart/mixed"; +- 4) the "application/vnd.3gpp.mcdata-info+xml" MIME body; and +- 5) the "application/vnd.3gpp.mcdata-signalling" MIME body; + +shall be supported at the II-NNI. + +Responses to the INVITE request including: + +- 1) the: + - a) "g.3gpp.mcptt"; + - b) "g.3gpp.mcvideo"; + - c) "g.3gpp.mcdata.sds"; or + - d) "g.3gpp.mcdata.fd" + media feature tag in the Contact header field; +- 2) the media feature tag "isfocus" in the Contact header field; +- 3) the Content-Type header field with the value "multipart/mixed"; +- 4) the "application/vnd.3gpp.mcptt-info+xml" for MCPTT or "application/vnd.3gpp.mcvideo-info+xml" for MCVideo or "application/vnd.3gpp.mcdata-info+xml" for MCData MIME body; and +- 5) the Warning header field with the warn-code set to "399" and with the warn-text set to a quoted-string as specified in 3GPP TS 24.379 [201] clause 4.4.2 and 3GPP TS 24.281 [210] clause 4.4.2 and 3GPP TS 24.282 [211] clause 4.9; + +shall be supported at the II-NNI. + +The initial INVITE request including the Priority-Share header field (defined in 3GPP TS 24.229 [5]), the Resource-Share header field (defined in 3GPP TS 24.229 [5]) and the "application/resource-lists+xml" MIME body shall be supported at the roaming II-NNI. + +The Resource-Share header field and the Priority-Share header field in 18x and 2xx responses to the INVITE request shall be supported at the roaming II-NNI. + +The Resource-Share header field and the Priority-Share header field in the PRACK requests, the UPDATE requests, the ACK requests and in 2xx responses to the PRACK requests and the UPDATE requests shall be supported at the roaming II-NNI. + +The REFER request containing an "application/vnd.3gpp.mcptt-info+xml" MIME body in the headers portion in the Refer-To header field shall be supported at the roaming II-NNI. + +NOTE: How the "application/vnd.3gpp.mcptt-info+xml" MIME body is included in the headers portion is described in IETF RFC 3261 [13] clause 19.1.1. + +The "m=" line set to "application UDP MCPTT" and associated parameters in the "a=fmpt:MCPTT" media line attribute shall be supported at the II-NNI. + +An "i=" line set to "speech" in the audio media definition in the SDP offer and SDP answer shall be supported at the II-NNI. + +### 28.2.2 MBMS transmission usage and location procedures + +For MCPTT: + +- a) Service specific requirements in accordance with 3GPP TS 24.379 [201] clauses 13 and 14 shall be supported over the II-NNI. + +- b) The MESSAGE request containing the "application/vnd.3gpp.mcptt-info+xml" MIME body shall be supported over the roaming II-NNI. +- c) The MESSAGE request containing the "application/vnd.3gpp.mcptt-location-info+xml" MIME body shall be supported over the roaming II-NNI. +- d) The MESSAGE request containing the "application/vnd.3gpp.mcptt-mbms-usage-info+xml" MIME body shall be supported over the roaming II-NNI. +- e) The P-Preferred-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcptt" of the MESSAGE request shall be supported at the roaming II-NNI. +- f) The "g.3gpp.mcptt" media feature tag in the Accept-Contact header field of the MESSAGE request from the home network to the visited network shall be supported at the roaming II-NNI. +- g) The "g.3gpp.icsi-ref" media feature tag with the value "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Accept-Contact header field of the MESSAGE request shall be supported at the roaming II-NNI. + +For MCVideo: + +- a) Service specific requirements in accordance with 3GPP TS 24.281 [210] clauses 16 shall be supported over the II-NNI. +- b) The MESSAGE request containing the "application/vnd.3gpp.mcvideo-info+xml" MIME body shall be supported over the roaming II-NNI. +- c) The MESSAGE request containing the "application/vnd.3gpp.mcvideo-location-info+xml" MIME body shall be supported over the roaming II-NNI. +- d) The MESSAGE request containing the "application/vnd.3gpp.mcvideo-mbms-usage-info+xml" MIME body shall be supported over the roaming II-NNI. +- e) The P-Preferred-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcvideo" of the MESSAGE request shall be supported at the roaming II-NNI. +- f) The "g.3gpp.mcvideo" media feature tag in the Accept-Contact header field of the MESSAGE request from the home network to the visited network shall be supported at the roaming II-NNI. +- g) The "g.3gpp.icsi-ref" media feature tag with the value "urn:urn-7:3gpp-service.ims.icsi.mcvideo" in the Accept-Contact header field of the MESSAGE request shall be supported at the roaming II-NNI. + +### 28.2.3 Affiliation procedure + +#### 28.2.3.1 General + +The affiliation consists of two procedures. One mandatory mode procedure and one negotiated mode procedure. + +Both procedures shall be supported over the II-NNI. + +#### 28.2.3.2 Mandatory mode + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 9, 3GPP TS 24.281 [210] clause 8 and 3GPP TS 24.282 [211] clause 8 shall be supported over the II-NNI. + +The SIP PUBLISH request including: + +- 1) an Event header field set to the value "presence"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT, "application/vnd.3gpp.mcvideo-info+xml" for MCVideo or "application/vnd.3gpp.mcdata-info+xml" for MCData MIME body; and +- 3) an "application/pidf+xml" MIME body; + +shall be supported at the II-NNI. + +A SUBSCRIBE request including: + +- 1) an Event header field set to the value "presence"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT or "application/vnd.3gpp.mcvideo-info+xml" for MCVideo or "application/vnd.3gpp.mcdata-info+xml" for MCData MIME body; +- 3) an Accept header field containing the "application/pidf+xml" MIME type; and +- 4) an "application/simple-filter+xml" MIME body according to IETF RFC 4661 [176]; + +shall be supported at the II-NNI. + +An NOTIFY request including: + +- 1) an Event header field set to the value "presence"; and +- 2) an "application/pidf+xml" MIME body + +shall be supported at the II-NNI. + +#### 28.2.3.3 Negotiated mode + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 9, 3GPP TS 24.281 [210] clause 8 and 3GPP TS 24.282 [211] clause 8 shall be supported over the II-NNI. + +A MESSAGE request including: + +- 1) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT, "application/vnd.3gpp.mcvideo-info+xml" for MCVideo or "application/vnd.3gpp.mcdata-info+xml" for MCData MIME body; and +- 2) an "application/vnd.3gpp.mcptt-affiliation-command+xml" for MCPTT, "application/vnd.3gpp.mcvideo-affiliation-command+xml" for MCVideo or "application/vnd.3gpp.mcdata-affiliation-command+xml" for MCData MIME body; + +shall be supported at the II-NNI. + +### 28.2.4 Conference event package subscription + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 10.1.3 shall be supported over the II-NNI. + +The SUBSCRIBE request including: + +- 1) a "conference" event package name in the Event header field; +- 2) an Accept header field containing the "application/conference-info+xml" MIME type; and +- 3) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT or "application/vnd.3gpp.mcvideo-info+xml" for MCVideo MIME body; + +shall be supported at the II-NNI. + +The NOTIFY request including: + +- 1) the "conference" event package name in the Event header field; +- 2) the Content-Type header field with the value "multipart/mixed"; +- 3) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT or "application/vnd.3gpp.mcvideo-info+xml" for MCVideo MIME body; and +- 4) an "application/conference-info+xml" MIME body; + +shall be supported at the II-NNI. + +## 28.2.5 Mission critical services settings + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 7, 3GPP TS 24.281 [210] clause 7 and 3GPP TS 24.282 [211] clause 7 shall be supported over the roaming II-NNI. + +A PUBLISH request including: + +- 1) an Event header field set to the "poc-settings" value; +- 2) one of the following sets of MIME bodies: + - an "application/vnd.3gpp.mcptt-info+xml" for MCPTT; + - an "application/vnd.3gpp.mcvideo-info+xml" MIME body and an "application/vnd.3gpp.mcptt-signed+xml" for MCVideo MIME body; or + - an "application/vnd.3gpp.mcdata-info+xml" MIME body and an "application/vnd.3gpp.mcptt-signed+xml" MIME body for MCData; and +- 3) an "application/poc-settings+xml" MIME body according to IETF RFC 4354 [205]; + +shall be supported at the roaming II-NNI. + +## 28.2.6 Registration procedures + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 7 shall be supported over the roaming II-NNI. + +The REGISTER request including: + +- 1) the: + - a) "g.3gpp.mcptt"; + - b) "g.3gpp.mcvideo"; + - c) "g.3gpp.mcdata.sds"; or + - d) "g.3gpp.mcdata.fd"media feature tag in the Contact header field; +- 2) the Content-Type header field with the value "multipart/mixed"; +- 3) the application/mikey MIME body; +- 4) one of the following sets of MIME bodies: + - an "application/vnd.3gpp.mcptt-info+xml" for MCPTT; + - an "application/vnd.3gpp.mcvideo-info+xml" MIME body and an "application/vnd.3gpp.mcptt-signed+xml" for MCVideo MIME body; or + - an "application/vnd.3gpp.mcdata-info+xml" MIME body and an "application/vnd.3gpp.mcptt-signed+xml" MIME body for MCData; +- 5) the Resource-Share header field (defined in 3GPP TS 24.229 [5]); and +- 6) the "g.3gpp.priority-share" feature-capability indicator (defined in 3GPP TS 24.229 [5] clause 7.9A.10) in the Feature-Caps header field; + +shall be supported at the roaming II-NNI. + +## 28.2.7 Group regrouping + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 10 shall be supported over the non-roaming II-NNI. + +In addition to the requirements in clause 28.2.1 the 403 (Forbidden) response to the INVITE request including a P-Refused-URI-List header field and an "application/resource-lists+xml" MIME body shall be supported at the non-roaming II-NNI. + +The MESSAGE request including: + +- 1) a Content-Type header field with the value "multipart/mixed"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" MIME body; and +- 3) an "application/vnd.3gpp.mcptt-floor-request+xml" MIME body; + +shall be supported at the non-roaming II-NNI. + +## 28.2.8 Signalling plane messages for mission critical data + +Service specific requirements in accordance with 3GPP TS 24.282 [211] clause 9.2.2 shall be supported over the II-NNI. + +A MESSAGE request including: + +- 1) an "application/vnd.3gpp.mcdata-info+xml" MIME body; and +- 2) an "application/vnd.3gpp.mcdata-signalling" MIME body or an "application/vnd.3gpp.mcdata-payload" MIME body or both; + +shall be supported at the II-NNI. + +## 28.2.9 Functional alias management procedure + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 9A shall be supported over the II-NNI. + +A SIP PUBLISH request including: + +- 1) an Event header field set to the value "presence"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" MIME body for MCPTT; and +- 3) an "application/pidf+xml" MIME body; + +shall be supported at the II-NNI. + +A SIP SUBSCRIBE request including: + +- 1) an Event header field set to the value "presence"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" MIME body; and +- 3) an Accept header field containing the "application/pidf+xml" MIME body; + +shall be supported at the II-NNI. + +A SIP NOTIFY request including: + +- 1) an Event header field set to the value "presence"; and +- 2) an "application/pidf+xml" MIME body. + +shall be supported at the II-NNI. + +--- + +## 29 Calling number verification using signature verification and attestation information + +Based on inter-operator agreement, "Calling number verification using signature verification and attestation information" functionality, as described in IETF RFC 8224 [206] and 3GPP TS 24.229 [5], may be supported over the II-NNI. + +If the "Calling number verification using signature verification and attestation information" is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +A 200 (OK) response to a REGISTER request including a "g.3gpp.verstat" feature-capability indicator (defined in 3GPP TS 24.229 [5] clause 7.9A.11) and a "sip.607" feature-capability indicator (defined in IETF RFC 8197 [207]) in a Feature-Caps header field shall be supported at the roaming II-NNI. + +An initial INVITE request and a MESSAGE request containing a P-Asserted-Identity header field and a From header field with a "verstat" tel URI parameter (defined in 3GPP TS 24.229 [5] clause 7.2A.20) in a tel URI or in a SIP URI with a "user=phone" parameter shall be supported at the roaming II-NNI. + +An initial INVITE request and a MESSAGE request containing: + +- an Identity header field (defined in IETF RFC 8224 [206]); +- an Attestation-Info header field (defined in 3GPP TS 24.229 [5] clause 7.2.18); and +- an Origination-id header field (defined in 3GPP TS 24.229 [5] clause 7.2.19), + +shall be supported at the non-roaming II-NNI. + +A 607 (Unwanted) response (defined in IETF RFC 8197 [207]) to an initial INVITE request and a MESSAGE request shall be supported at the II-NNI. + +A Reason header field with a protocol value set to "SIP" and a "cause" header field parameter set to "607" in a BYE request shall be supported at the II-NNI. + +A Reason header field with a protocol value set to "STIR", "cause" and "ppi" header field parameters (specified in IETF RFC 9410 [220]) in a provisional response or a final response to an initial INVITE or a MESSAGE request shall be supported at the non-roaming II-NNI. + +NOTE: Multiple Reason header fields with the protocol value set to "STIR" can be present in a provisional response or a final response to an initial INVITE or a MESSAGE request. + +--- + +## 30 IMS emergency service + +### 30.1 IMS emergency registration + +See clause 8.1 for the signalling requirements of IMS emergency registration regarding the "sos" URI parameter on the roaming II-NNI. + +### 30.2 IMS emergency session + +Based on inter-operator agreements or national requirements, IMS emergency session may be supported over the non-roaming II-NNI. + +NOTE 1: The details of the SIP signalling requirements for IMS emergency session on the non-roaming II-NNI can be defined by inter-operator agreements or national requirements. + +If the IMS emergency session is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +The Request-URI containing a uniform resource name (URN) for emergency services, defined in IETF RFC 5031 [61] and 3GPP TS 24.229 [5], shall be supported for the IMS emergency session traversal scenario on the non-roaming II-NNI. + +NOTE 2: The emergency service URN(s) to use can be defined by inter-operator agreements or national requirements. + +### 30.3 Next-Generation Pan-European eCall emergency service + +Based on inter-operator agreements or national requirements, Next-Generation Pan-European eCall emergency service may be supported over the non-roaming II-NNI. + +If Next-Generation Pan-European eCall emergency service is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +The MSD in an INVITE and INFO request shall be supported over the non-roaming II-NNI as described in 3GPP TS 24.229 [5]. + +--- + +## 31 Restricted Local Operator Services (RLOS) + +Based on inter-operator agreement, RLOS as described in 3GPP TS 24.229 [5] may be supported over the roaming II-NNI. + +If RLOS is supported, a REGISTER request with a "+g.3gpp.rlos" Contact header field parameter, as defined in 3GPP TS 24.229 [5] clause 7.9.9 shall be supported at the roaming II-NNI. + +An initial request for a dialog or a request for a standalone transaction with the Request-URI containing the dummy MSISDN value as defined in 3GPP TS 23.003 [35] or a RLOS service specific dial string and a P-Preferred-Service header field set to "urn:urn-7:3gpp-service.ims.icsi.rlos", as defined in 3GPP TS 24.229 [5] clause 7.11.2 shall be supported at the roaming II-NNI. + +--- + +## 32 3GPP PS data off extension + +Based on inter-operator agreement, 3GPP PS data off extension as described in 3GPP TS 24.229 [5] may be supported over the roaming II-NNI. + +If the 3GPP PS data off extension is supported, "+g.3gpp.ps-data-off" media feature tag in the Contact header field parameter of the REGISTER request shall be supported at the roaming II-NNI. + +--- + +## 33 MTSI Data channel + +Based on inter-operator agreement, data channel as described in 3GPP TS 26.114 [11] may be supported at the II-NNI. + +If MTSI data channel is supported, the procedures specified in 3GPP TS 26.114 [11] shall be applied and the capabilities below shall be provided at the II-NNI. + +The "+sip.app-subtype" media feature tag with a value of "webrtc-datachannel" in the Contact header field parameter of the REGISTER request shall be supported at the roaming II-NNI. + +The "+sip.app-subtype" media feature tag with a value of "webrtc-datachannel" in the Contact header field parameter of INVITE and UPDATE requests and in 18x and 2xx responses to INVITE and UPDATE requests shall be supported at the II-NNI. + +The "m=" line set to "application UDP/DTLS/SCTP webrtc-datachannel" and associated parameters in the media line attributes "a=dcmmap" and "a=3GPP-qos-hint" of the SDP body shall be supported at the II-NNI. For the "bootstrap" data channel as defined in table 6.2.10.1-2 of 3GPP TS 26.114 [11] only stream ID 100 and stream ID 110 shall be supported at the II-NNI. + +NOTE: Stream ID 0 and stream ID 10 "bootstrap" data channels are strictly local between the UE and its local network. + +--- + +## 34 Support for signed attestation for emergency and priority IMS sessions + +### 34.1 General + +Where a network has requirements on a signed attestation for emergency IMS sessions the "Calling number verification using signature verification and attestation information" and "Priority verification using assertion of priority information" features described in 3GPP TS 24.229 [5] need to be supported. + +Where a network has requirements on a signed attestation for priority IMS sessions (e.g., MPS sessions) the "Priority verification using assertion of priority information" feature described in 3GPP TS 24.229 [5] needs to be supported and the "Calling number verification using signature verification and attestation information" feature described in 3GPP TS 24.229 [5] might need to be supported. + +Based on inter-operator agreement, the signed attestation for emergency and priority IMS sessions may be supported over the II-NNI as further specified below. + +### 34.2 Calling number verification using signature verification and attestation information + +The requirements to support the "Calling number verification using signature verification and attestation information" functionality for emergency and priority IMS sessions over the II-NNI are the same as in clause 29. + +### 34.3 Priority verification using assertion of priority information + +"Priority verification using assertion of priority information" functionality, as described in 3GPP TS 24.229 [5], may be supported over the II-NNI. + +If the "Priority verification using assertion of priority information" is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +An initial INVITE request containing: + +- a Resource-Priority header field; and +- optionally, a Priority header field with a "psap-callback" header field value, for emergency call-back cases; + +shall be supported at the II-NNI. + +An initial INVITE request containing: + +- an Identity header field (defined in IETF RFC 8224 [206]); and +- a Priority-Verstat header field (defined in 3GPP TS 24.229 [5] clause 7.2.21) + +shall be supported at the non-roaming II-NNI. + +A re-INVITE request containing a Resource-Priority header field shall be supported at the II-NNI. + +A re-INVITE request containing: + +- an Identity header field (defined in IETF RFC 8224 [206]); and +- a Priority-Verstat header field (defined in 3GPP TS 24.229 [5] clause 7.2.21) + +shall be supported at the non-roaming II-NNI. + +--- + +## Annex A (informative): Summary of SIP header fields + +A summary of the SIP header fields to be used in case of interconnection by using II-NNI is proposed in table A.1. + +The starting point is the sending behaviour described for proxy and UA roles in annex A of 3GPP TS 24.229 [5]: + +- In case of misalignment between table A.1 and the behaviour described in 3GPP TS 24.229 [5], the behaviour in 3GPP TS 24.229 [5] has the precedence. +- In case a header field is not described in table A.1 and it is described in 3GPP TS 24.229 [5], the description in 3GPP TS 24.229 [5] is applicable over II-NNI. +- If a header field is not described in 3GPP TS 24.229 [5], the description in table A.1 is applicable over II-NNI. + +The definition of the notation codes used in table A.1 is provided in table A.2. + +**Table A.1: Supported header fields** + +| Item | Header field | Ref. | II-NNI | +|------|--------------------------|---------------------------------------------------------------------|---------------------------------------------------------------------------------| +| 1 | Accept | [5] | m | +| 2 | Accept-Contact | [5] | m | +| 3 | Accept-Encoding | [5] | m | +| 4 | Accept-Language | [5] | m | +| 4a | Accept-Resource-Priority | [5] | o | +| 4b | Additional-Identity | [5], clause 6.1.1.3.1
(table 6.2, item 25)
and clause 12.26.2 | o in case of a trust relationship between the interconnected networks, else n/a | +| 5 | Alert-Info | [5] | o | +| 6 | Allow | [5] | m | +| 7 | Allow-Events | [5] | m on roaming II-NNI, else o | +| 7a | Attestation-Info | [5], clause 6.1.1.3.1
(table 6.2, item 23)
and clause 29 | o on non-roaming II-NNI, else n/a | +| 8 | Authentication-Info | [5] | m on roaming II-NNI, else n/a | +| 9 | Authorization | [5] | m on roaming II-NNI, else n/a | +| 9a | Answer-Mode | [5] | o | +| 10 | Call-ID | [5] | m | +| 11 | Call-Info | [5] | m | +| 11a | Cellular-Network-Info | clause 6.1.1.3.1
(table 6.2, item 21) | o | +| 12 | Contact | [5] | m | +| 13 | Content-Disposition | [5] | m | +| 14 | Content-Encoding | [5] | m | +| 14a | Content-ID | [5] | o | +| 15 | Content-Language | [5] | m | +| 16 | Content-Length | [5] | m | +| 17 | Content-Type | [5] | m | +| 18 | CSeq | [5] | m | +| 19 | Date | [5] | m | +| 20 | Error-Info | [5] | o | +| 21 | Expires | [5] | m | +| 21a | Flow-Timer | [5] | m on roaming II-NNI, else o | +| 21b | Feature-Caps | clause 6.1.1.3.1
(table 6.2, item 13) | o | +| 22 | Event | [5] | m | +| 23 | From | [5] | m | +| 24 | Geolocation | [5] | m | +| 24a | Geolocation-Error | [5] | m | +| 24b | Geolocation-Routing | [5] | m | +| 25 | History-Info | clause 6.1.1.3.1
(table 6.2, item 4) | o | +| 25b | Identity | [206], clause 29 and
clause 34 | o on non-roaming II-NNI, else n/a | +| 25a | Info-Package | [5] | o | +| 26 | In-Reply-To | [5] | o | +| 27 | Join | [5] | o | +| 27a | Max-Breadth | [5] | m | +| 28 | Max-Forwards | [5] | m | +| 29 | Min-Expires | [5] | m | +| 30 | MIME-Version | [5] | m | +| 31 | Min-SE | [5] | m | +| 32 | Organization | [5] | m | +| 32a | Origination-Id | [5], clause 6.1.1.3.1
(table 6.2, item 24)
and clause 29 | o on non-roaming II-NNI, else n/a | +| 33 | P-Access-Network-Info | clause 6.1.1.3.1
(table 6.2, item 2) | m in case of a trust relationship between the interconnected networks, else n/a | +| 33a | P-Answer-state | [5] | o | +| 34 | P-Asserted-Identity | clause 6.1.1.3.1
(table 6.2, item 1) | m in case of a trust relationship between the interconnected networks, else n/a | +| 35 | P-Asserted-Service | clause 6.1.1.3.1
(table 6.2, item 5) | o | + +| Item | Header field | Ref. | II-NNI | +|------|-------------------------------|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| 35a | P-Associated-URI | [5] | m on roaming II-NNI, else n/a | +| 36 | P-Called-Party-ID | [5] | m on roaming II-NNI, else n/a | +| 37 | P-Charging-Function-Addresses | clause 6.1.1.3.1
(table 6.2, item 7) | n/a | +| 38 | P-Charging-Vector | clause 6.1.1.3.1
(table 6.2, item 6) | m on roaming II-NNI, else o | +| 39 | P-Early-Media | clause 6.1.1.3.1
(table 6.2, item 12) | m in case of a trust relationship between the interconnected networks, else n/a | +| 40 | P-Media-Authorization | [5] | n/a | +| 41 | P-Preferred-Identity | [5] | n/a | +| 42 | P-Preferred-Service | [5] | m on roaming II-NNI, else n/a | +| 43 | P-Private-Network-Indication | clause 6.1.1.3.1
(table 6.2, item 9) | m on roaming II-NNI, else o | +| 44 | P-Profile-Key | clause 6.1.1.3.1
(table 6.2, item 8) | o on roaming II-NNI, else n/a | +| 44a | P-Refused-URI-List | [5] | o on non-roaming II-NNI, else n/a | +| 45 | P-Served-User | clause 6.1.1.3.1
(table 6.2, item 10) | m on roaming II-NNI, else n/a | +| 46 | P-User-Database | [5] | n/a | +| 47 | P-Visited-Network-ID | [5] | m on roaming II-NNI, else n/a | +| 47a | Path | [5] | m on roaming II-NNI, else n/a | +| 47b | Permission-Missing | [5] | o | +| 47c | Policy-Contact | [133] and
clause 15.6.2 | o | +| 48 | Priority | clause 6.1.1.3.1
(table 6.2, item 14) | o | +| 48b | Priority-Share | [5] clause 7.2.16 | o on roaming II-NNI, else n/a | +| 48c | Priority-Verstat | [5], clause 6.1.1.3.1
(table 6.2, item 26)
and clause 34 | o on non-roaming II-NNI, else n/a | +| 48a | Priv-Answer-Mode | [5] | o | +| 49 | Privacy | [5] | m | +| 50 | Proxy-Authenticate | [5] | m on roaming II-NNI, else n/a | +| 51 | Proxy-Authorization | [5] | m on roaming II-NNI, else n/a | +| 52 | Proxy-Require | [5] | m | +| 52a | RAck | [5] | m | +| 53 | Reason | [5] and
clause 6.1.1.3.1
(table 6.2, item 11) | o when in a request.
When in a response, m in case of a trust relationship between the interconnected networks, else n/a | +| 54 | Record-Route | [5] | m | +| 54a | Recv-Info | [5] | o | +| 55 | Referred-By | [5] | m | +| 55a | Refer-Sub | [5] | m in the case the REFER request is supported, else n/a | +| 55b | Refer-To | [5] | m in the case the REFER request is supported, else n/a | +| 56 | Reject-Contact | [5] | m | +| 56a | Relayed-Charge | clause 6.1.1.3.1
(table 6.2, item 19) | n/a | +| 57 | Replaces | [5] | o | +| 58 | Reply-To | [5] | o | +| 59 | Request-Disposition | [5] | m | +| 60 | Require | [5] | m | +| 61 | Resource-Priority | clause 6.1.1.3.1
(table 6.2, item 3) | o | +| 61c | Resource-Share | [5] clause 7.2.13 | o on roaming II-NNI, else n/a | +| 61d | Response-Source | [5] | o in case of a trust relationship between the interconnected networks, else n/a | +| 61b | Restoration-Info | clause 6.1.1.3.1
(table 6.2, item 18) | o on roaming II-NNI, else n/a | +| 61a | Retry-After | [5] | o | +| 62 | Route | [5] | m | + +| Item | Header field | Ref. | II-NNI | +|------|-----------------------|-----------------------------------------------|---------------------------------------------------------------------------------| +| 62a | RSeq | [5] | m | +| 63 | Security-Client | [5] | n/a | +| 63a | Security-Server | [5] | n/a | +| 64 | Security-Verify | [5] | n/a | +| 65 | Server | [5] | o | +| 65c | Service-Interact-Info | [5] and clause 6.1.1.3.1 (table 6.2, item 20) | o in case of a trust relationship between the interconnected networks, else n/a | +| 65a | Service-Route | [5] | m on roaming II-NNI, else n/a | +| 65b | Session-ID | [5] | o | +| 66 | Session-Expires | [5] | m | +| 66a | SIP-ETag | [5] | m in the case the PUBLISH request is supported, else n/a | +| 66b | SIP-If-Match | [5] | m in the case the PUBLISH request is supported, else n/a | +| 67 | Subject | [5] | o | +| 67a | Subscription-State | [5] | m in the case the NOTIFY request is supported, else n/a | +| 67b | Suppress-If-Match | [144] and clause 15.6.4 | o | +| 68 | Supported | [5] | m | +| 68a | Target-Dialog | [5] | o | +| 69 | Timestamp | [5] | m | +| 70 | To | [5] | m | +| 71 | Trigger-Consent | [5] | m | +| 71a | Unsupported | [5] | m | +| 72 | User-Agent | [5] | m | +| 73 | User-to-User | [5] | o | +| 74 | Via | [5] | m | +| 75 | Warning | [5] | o | +| 76 | WWW-Authenticate | [5] | m on roaming II-NNI, else n/a | + +**Table A.2: Key to notation codes for SIP header fields** + +| Notation code | Meaning | +|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| m | The SIP header field is applicable at II-NNI. Supporting a SIP header field at the II-NNI means that this header field is passed through the IBCF. It does not imply that network elements inside the serving and served networks or user equipment connected to these networks shall support this header field, where 3GPP TS 24.229 [5] is applied. If specified in 3GPP TS 24.229 [5], the IBCF modifies the SIP header field. | +| o | The applicability of SIP header field at II-NNI depends on bilateral agreement between the operators. | +| n/a | It is impossible to use the SIP header field at the II-NNI. This header field could be discarded by the IBCF. | + +--- + +## Annex B (informative): Dynamic view of SIP header fields within SIP messages + +### B.1 Scope + +This annex provides the applicability of SIP header fields in SIP messages over II-NNI by using the methodology of a so-called "dynamic view", as used in IETF RFC 3261 [13] and other SIP related RFCs. This methodology documents the presence of SIP header fields in SIP messages over the II-NNI and also takes into account dynamic conditions, for instance the presence of a SIP header field in a SIP request message as condition for the SIP header field in the corresponding SIP response message. + +Specific information about the applicability of SIP header fields in SIP messages in a dynamic view is also provided for cases where an MMTEL supplementary service is supported over the II-NNI between operators. + +The applicability of SIP header fields described in this annex is based on the procedures described in 3GPP TS 24.229 [5] and the list of SIP header fields in annex A of 3GPP TS 24.229 [5]. + +--- + +### B.2 Methodology + +The meaning of the notation codes used in the tables in subsequent clauses is as follows: + +In the "RFC status" column, the notation codes defined in IETF RFC 3261 [13] clause 20 are applied. + +In the "II-NNI condition" column the notation codes defined in table B.2.1 are used. If a capability of a SIP header field is specified as either optional or conditional in table 6.1.3.1, then "II-NNI condition" of the SIP header field is described with conditional expression. + +In each request-related table, the order of SIP header fields inherits that of clause A.2.2 of 3GPP TS 24.229 [5]. + +In each response-related table, the SIP status code for which the header field is applicable is described in the "SIP status code" column. The notation codes for the "where" column as defined in IETF RFC 3261 [13] clause 20 are applied. The notation code "r" in "SIP status code" column corresponds to any SIP status code which is described in annex A of 3GPP TS 24.229 [5] for the corresponding method. Any SIP header field not listed in a table is not applicable for the corresponding SIP message. + +**Table B.2.1: Key to notation codes for SIP header fields in dynamic view for II-NNI** + +| Notation code
(NOTE 1) | Meaning | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dc | The SIP header field is required to be present in a SIP message over II-NNI according to the procedures specified in other specifications e.g. 3GPP TS 24.229 [5]. | +| dm | The SIP header field shall be always present in a SIP message over II-NNI, and if received, it must be handled according to 3GPP TS 24.229 [5]. | +| dm* | The SIP header field should be present in a SIP message over II-NNI, but the IMS network need to be prepared to receive a SIP message without that header field. | +| do | The SIP header field can be present in a SIP message over II-NNI, and if received, it must be handled according to 3GPP TS 24.229 [5]. (NOTE 2) | +| dt | The header field should be present in a SIP message over II-NNI, but the IMS network need to be prepared to receive a SIP message without that header field.
If TCP is used as a transport, then the header field must be present in a SIP message. | +| d* | The SIP header field is required to be present in a SIP message if the message body is not empty. | +| dn/a | The SIP header field is shall not be present in a SIP message over II-NNI. (NOTE 3) | +| dc | The condition for the presence of the SIP header field. is the identifier of the condition.
This notation code is applied only in each request-related or response-related table. | +| NOTE 1: The meaning of the notation codes is same as in IETF RFC 3261 [13] clause 20 and "d" is used to emphasise the dynamic view. | | +| NOTE 2: If specified by local policy rules, the IBCF acting as entry point may omit or modify any received SIP header fields prior to forwarding SIP messages as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | +| NOTE 3: The SIP header field can be removed at the IBCF acting as exit point by using screening functionality defined in 3GPP TS 24.229 [5] clause 5.10.6.2. | | + +## B.3 ACK method + +The table B.3.1 lists the supported header fields within the ACK request. + +**Table B.3.1: Supported header fields within the ACK request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-----------------------|--------------------|------------|----------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept-Contact | [51] | o | do | +| 2 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 3 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 4 | Call-ID | [13] | m | dm | +| 5 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 6 | Content-Disposition | [13] | o | do | +| 7 | Content-Encoding | [13] | o | do | +| 8 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 9 | Content-Language | [13] | o | do | +| 10 | Content-Length | [13] | t | dt | +| 11 | Content-Type | [13] | * | d* | +| 12 | CSeq | [13] | m | dm | +| 13 | Date | [13] | o | do | +| 14 | From | [13] | m | dm | +| 15 | Max-Breadth | [79] | o | do | +| 16 | Max-Forwards | [13] | m | dm | +| 17 | MIME-Version | [13] | o | do | +| 18 | P-Access-Network-Info | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 19 | Priority-Share | [5] | n/a | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE) | +| 20 | Privacy | [34] | o | do | +| 21 | P-Charging-Vector | [24], [24A] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 22 | Proxy-Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 23 | Proxy-Require | [13] | n/a | dn/a | +| 24 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 25 | Record-Route | [13] | o | do | +| 26 | Recv-Info | [39] | n/a | dn/a | +| 27 | Reject-Contact | [51] | o | do | +| 28 | Relayed-Charge | [5] | n/a | dn/a | +| 29 | Request-Disposition | [51] | o | do | +| 30 | Require | [13] | n/a | dn/a | +| 31 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 32 | Resource-Share | [5] | n/a | IF (home-to-visited request on roaming II-NNI OR visited-to-home request on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE) | +| 33 | Route | [13] | c | dc | +| 34 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 35 | Timestamp | [13] | o | do | +| 36 | To | [13] | m | dm | +| 37 | User-Agent | [13] | o | do | +| 38 | Via | [13] | m | dm | + +NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +--- + +## B.4 BYE method + +The table B.4.1 lists the supported header fields within the BYE request. + +**Table B.4.1: Supported header fields within the BYE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------|------------------------------------------------------------------------------| +| 1 | Accept | [13] | o | IF dc1 (AOC: clause 12.22) THEN dm ELSE do | +| 2 | Accept-Contact | [51] | o | do | +| 3 | Accept-Encoding | [13] | o | do | +| 4 | Accept-Language | [13] | o | do | +| 5 | Allow | [13] | o | do | +| 6 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 7 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13] | m | dm | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Content-Disposition | [13] | o | IF dc2 (AOC: clause 12.22) THEN dm ELSE do | +| 11 | Content-Encoding | [13] | o | do | +| 12 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 13 | Content-Language | [13] | o | do | +| 14 | Content-Length | [13] | t | dt | +| 15 | Content-Type | [13] | * | d* | +| 16 | CSeq | [13] | m | dm | +| 17 | Date | [13] | o | do | +| 18 | From | [13] | m | dm | +| 19 | Geolocation | [68] | o | do | +| 20 | Geolocation-Routing | [68] | o | do | +| 21 | Max-Breadth | [79] | o | do | +| 22 | Max-Forwards | [13] | m | dm | +| 23 | MIME-Version | [13] | o | do | +| 24 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 25 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 THEN do (NOTE) | +| 26 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 27 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 28 | P-Preferred-Identity | [44] | o | dn/a | +| 29 | Privacy | [34] | o | do | +| 30 | Proxy-Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 31 | Proxy-Require | [13] | o | do | +| 32 | Reason | [48] | o | IF dc3 (ICB: clause 12.10.1) THEN dm ELSE IF table 6.1.3.1/40 THEN do (NOTE) | +| 33 | Record-Route | [13] | o | do | +| 34 | Referred-By | [53] | o | do | +| 35 | Reject-Contact | [51] | o | do | +| 36 | Relayed-Charge | [5] | n/a | dn/a | +| 37 | Request-Disposition | [51] | o | do | +| 38 | Require | [13] | c | dc | +| 39 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 40 | Route | [13] | c | dc | +| 41 | Security-Client | [47] | o | dn/a | +| 42 | Security-Verify | [47] | o | dn/a | +| 43 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 44 | Supported | [13] | o | do | +| 45 | Timestamp | [13] | o | do | +| 46 | To | [13] | m | dm | +| 47 | User-Agent | [13] | o | do | +| 48 | User-to-User | [83] | o | IF table 6.1.3.1/79 THEN do (NOTE) | +| 49 | Via | [13] | m | dm | +| dc1: | request invoked due to AOC AND visited-to-home request on roaming II-NNI | | | | +| dc2: | request invoked due to AOC AND home-to-visited request on roaming II-NNI | | | | +| dc3: | request invoked due to "dynamic ICB" on a confirmed status | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.4.2 lists the supported header fields within the BYE response. + +**Table B.4.2: Supported header fields within the BYE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|---------------------------------|----------------------|------------|--------------------------------------------| +| 1 | Accept | 415 | [13] | c | dc | +| 2 | Accept-Encoding | 415 | [13] | c | dc | +| 3 | Accept-Language | 415 | [13] | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405 | [13] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13] | m | dm | +| | | others | | | | +| 9 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 10 | Contact | 3xx
485 | [13] | o | do | +| 11 | Content-Disposition | r | [13] | o | IF dc1 (AOC: clause 12.22) THEN dm ELSE do | +| 12 | Content-Encoding | r | [13] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13] | o | do | +| 15 | Content-Length | 100 | [13] | t | dt | +| | | others | | | | +| 16 | Content-Type | r | [13] | * | d* | +| 17 | CSeq | 100 | [13] | m | dm | +| | | others | | | | +| 18 | Date | 100 | [13] | o | do | +| | | others | | | | +| 19 | Error-Info | 3xx-6xx | [13] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | From | 100 | [13] | m | dm | +| | | others | | | | +| 21 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 22 | MIME-version | r | [13] | o | do | +| 23 | P-Access-Network-Info | r | [24], [2 4A], [2 4B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 24 | P-Asserted-Identity | r | [44] | o | IF table 6.1.3.1/27 THEN do (NOTE 2) | +| 25 | P-Charging-Function-Addresses | r | [24], [2 4A] | o | dn/a | +| 26 | P-Charging-Vector | 100 | [24], [2 4A] | o | dn/a | +| | | others | | o | IF table 6.1.3.1/38 THEN do (NOTE 2) | +| 27 | P-Preferred-Identity | r | [44] | o | dn/a | +| 28 | Privacy | r | [34] | o | do | +| 29 | Proxy-Authenticate | 401 (NOTE 1) | [13] | o | do | +| | | 407 (NOTE 1) | | m | dm | +| 30 | Record-Route | 2xx | [13] | o | do | +| 31 | Relayed-Charge | r | [5] | n/a | dn/a | +| 32 | Require | r | [13] | c | dc | +| 33 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 34 | Retry-After | 404
413
480
486
500 | [13] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------------|-------|------------|-----------------------------------------|--|--| +| | | 503
600
603 | | | | | | +| 35 | Security-Server | 421
494 | [47] | o | dn/a | | | +| 36 | Server | r | [13] | o | do | | | +| 37 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | | | +| 38 | Supported | 2xx | [13] | o | do | | | +| 39 | Timestamp | r | [13] | o | do | | | +| 40 | To | 100
others | [13] | m | dm | | | +| 41 | Unsupported | 420 | [13] | m | dm | | | +| 42 | User-Agent | r | [13] | o | do | | | +| 43 | User-to-User | r | [83] | o | IF table 6.1.3.1/79 THEN do
(NOTE 2) | | | +| 44 | Via | 100
others | [13] | m | dm | | | +| 45 | Warning | r | [13] | o | do | | | +| 46 | WWW-Authenticate | 401
(NOTE 1) | [13] | m | dm | | | +| | | 407
(NOTE 1) | | o | do | | | +| dc1: 200 (OK) response invoked due to AOC AND home-to-visited response on roaming II-NNI | | | | | | | | +| NOTE 1: The SIP status code is only applicable over the roaming II-NNI. | | | | | | | | +| NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | | | + +## B.5 CANCEL method + +The table B.5.1 lists the supported header fields within the CANCEL request. + +**Table B.5.1: Supported header fields within the CANCEL request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|-------|------------|--------------------------------------------------------------------------| +| 1 | Accept-Contact | [51] | o | do | +| 2 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 3 | Call-ID | [13] | m | dm | +| 4 | Content-Length | [13] | t | dt | +| 5 | Content-Type | [13] | * | IF table 6.1.3.1/20 THEN do (NOTE) | +| 6 | CSeq | [13] | m | dm | +| 7 | Date | [13] | o | do | +| 8 | From | [13] | m | dm | +| 9 | Max-Breadth | [79] | o | do | +| 10 | Max-Forwards | [13] | m | dm | +| 11 | Privacy | [34] | o | do | +| 12 | Reason | [48] | o | IF dc1 (CW: clause 12.7) THEN dm ELSE IF table 6.1.3.1/40 THEN do (NOTE) | +| 13 | Record-Route | [13] | o | do | +| 14 | Reject-Contact | [51] | o | do | +| 15 | Request-Disposition | [51] | o | do | +| 16 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 17 | Route | [13] | c | dc | +| 18 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 19 | Supported | [13] | o | do | +| 20 | Timestamp | [13] | o | do | +| 21 | To | [13] | m | dm | +| 22 | User-Agent | [13] | o | do | +| 23 | Via | [13] | m | dm | +| dc1: request invoked due to CW at the expiry of the "CW timer" | | | | | +| NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | + +The table B.5.2 lists the supported header fields within the CANCEL response. + +**Table B.5.2: Supported header fields within the CANCEL response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|--------------------------|------------------------------------------------------|-------|------------|-------------------------------------| +| 1 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 2 | Call-ID | r | [13] | m | dm | +| 3 | Content-Length | r | [13] | t | dt | +| 4 | CSeq | r | [13] | m | dm | +| 5 | Date | r | [13] | o | do | +| 6 | Error-Info | 3xx-6xx | [13] | o | IF table 6.1.3.1/13 THEN do (NOTE) | +| 7 | From | r | [13] | m | dm | +| 8 | Privacy | r | [34] | o | do | +| 9 | Record-Route | 2xx | [13] | o | do | +| 10 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE) | +| 11 | Retry-After | 404
413
480
486
500
503
600
603 | [13] | o | do | +| 12 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 13 | Supported | 2xx | [13] | o | do | +| 14 | Timestamp | r | [13] | o | do | +| 15 | To | r | [13] | m | dm | +| 16 | User-Agent | r | [13] | o | do | +| 17 | Via | r | [13] | m | dm | +| 18 | Warning | r | [13] | o | do | + +NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +--- + +## B.6 INFO method + +As described in table 6.1, the support of INFO method over the II-NNI is based on bilateral agreement between the operators. + +The table B.6.1 lists the supported header fields within the INFO request. + +**Table B.6.1: Supported header fields within the INFO request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------|--------------------------------------------| +| 1 | Accept | [13], [39] | o | do | +| 2 | Accept-Encoding | [13], [39] | o | do | +| 3 | Accept-Language | [13], [39] | o | do | +| 4 | Allow | [13], [39] | o | do | +| 5 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 6 | Authorization | [13], [39] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 7 | Call-ID | [13], [39] | m | dm | +| 8 | Call-Info | [13], [39] | o | do | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Content-Disposition | [13], [39] | o | IF dc1 (AOC: clause 12.22) THEN dm ELSE do | +| 11 | Content-Encoding | [13], [39] | o | do | +| 12 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 13 | Content-Language | [13], [39] | o | do | +| 14 | Content-Length | [13], [39] | o | do | +| 15 | Content-Type | [13], [39] | * | d* | +| 16 | CSeq | [13], [39] | m | dm | +| 17 | Date | [13], [39] | o | do | +| 18 | From | [13], [39] | m | dm | +| 19 | Geolocation | [68] | o | do | +| 20 | Geolocation-Routing | [68] | o | do | +| 21 | Info-Package | [39] | m* | IF table 6.1.3.1/17 THEN do (NOTE) | +| 22 | Max-Breadth | [79], [39] | n/a | dn/a | +| 23 | Max-Forwards | [13], [39] | o | do | +| 24 | MIME-Version | [13], [39] | o | do | +| 25 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 26 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 27 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 28 | Privacy | [34], [39] | o | do | +| 29 | Proxy-Authorization | [13], [39] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 30 | Proxy-Require | [13], [39] | o | do | +| 31 | Reason | [48], [39] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 32 | Record-Route | [13], [39] | o | do | +| 33 | Referred-By | [53], [39] | o | do | +| 34 | Relayed-Charge | [5] | n/a | dn/a | +| 35 | Request-Disposition | [51], [39] | o | do | +| 36 | Require | [13], [39] | o | do | +| 37 | Resource-Priority | [78], [39] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 38 | Route | [13], [39] | o | do | +| 39 | Security-Client | [47], [39] | o | dn/a | +| 40 | Security-Verify | [47], [39] | o | dn/a | +| 41 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 42 | Subject | [13], [39] | o | do | +| 43 | Supported | [13], [39] | o | do | +| 44 | Timestamp | [13], [39] | o | do | +| 45 | To | [13], [39] | m | dm | +| 46 | User-Agent | [13], [39] | o | do | +| 47 | Via | [13], [39] | m | dm | +| dc1: | request invoked due to AOC AND home-to-visited request on roaming II-NNI | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.6.2 lists the supported header fields within the INFO response. + +**Table B.6.2: Supported header fields within the INFO response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|--------------------------|--------------------|------------|---------------------------------------| +| 1 | Accept | 2xx
415 | [13], [39] | o | do | +| 2 | Accept-Encoding | 2xx | [13], [39] | o | do | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx
415 | [13], [39] | o | do | +| 4 | Accept-Resource-Priority | 2xx
417 | [78], [39] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405 | [13], [39] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13], [39] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13], [39] | m | dm | +| | | others | | | | +| 9 | Call-Info | r | [13], [39] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Content-Disposition | r | [13], [39] | o | do | +| 12 | Content-Encoding | r | [13], [39] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13], [39] | o | do | +| 15 | Content-Length | 100 | [13], [39] | o | do | +| | | others | | | | +| 16 | Content-Type | r | [13], [39] | * | d* | +| 17 | CSeq | 100 | [13], [39] | m | dm | +| | | others | | | | +| 18 | Date | 100 | [13], [39] | o | do | +| | | others | | | | +| 19 | Error-Info | 3xx-6xx | [13], [39] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | From | 100 | [13], [39] | m | dm | +| | | others | | | | +| 21 | Geolocation-Error | 424 | [68], [39] | m | dm | +| | | others | | o | do | +| 22 | MIME-version | r | [13], [39] | o | do | +| 23 | Organization | r | [13], [39] | n/a | dn/a | +| 24 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 25 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 26 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | others | | o | IF table 6.1.3.1/38 THEN do (NOTE 2) | +| 27 | Privacy | r | [34], [39] | o | do | +| 28 | Proxy-Authenticate | 401 (NOTE 1) | [13], [39] | o | do | +| 29 | Record-Route | 2xx | [13], [39] | o | do | +| 30 | Relayed-Charge | r | [5] | n/a | dn/a | +| 31 | Require | r | [13], [39] | o | do | +| 32 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 33 | Retry-After | 404
413
480
486 | [13], [39] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|------------------|--------------------------|------------|------------|-----------------------------------------| +| | | 500
503
600
603 | | | | +| 34 | Security-Server | 421
494 | [47], [39] | o | dn/a | +| 35 | Server | r | [13], [39] | o | do | +| 36 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | +| 37 | Supported | 2xx | [13], [39] | o | do | +| 38 | Timestamp | r | [13], [39] | o | do | +| 39 | To | 100
others | [13], [39] | m | dm | +| 40 | Unsupported | 420 | [13], [39] | o | do | +| 41 | User-Agent | r | [13], [39] | o | do | +| 42 | Via | 100
others | [13], [39] | m | dm | +| 43 | Warning | r | [13], [39] | o | do | +| 44 | WWW-Authenticate | 401
(NOTE 1) | [13], [39] | m | dm | + +NOTE 1: The SIP status code is only applicable over the roaming II-NNI. + +NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +--- + +## B.7 INVITE method + +The table B.7.1 lists the supported header fields within the INVITE request. + +**Table B.7.1: Supported header fields within the INVITE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13] | o | IF dc1 (AOC: clause 12.22) THEN dm ELSE do | +| 2 | Accept-Contact | [51] | o | IF dc2 (PNM: clause 12.17) THEN dm ELSE do | +| 3 | Accept-Encoding | [13] | o | do | +| 4 | Accept-Language | [13] | o | do | +| 5 | Additional-Identity | [5] | n/a | IF table 6.1.3.1/126 THEN do (NOTE 3) | +| 6 | Alert-Info | [13] | o | IF dc3 (CRS: clause 12.15) THEN dm ELSE IF table 6.1.3.1/10 THEN do (NOTE 3) | +| 7 | Allow | [13] | o | do | +| 8 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 3) | +| 9 | Answer-Mode | [94] | o | IF table 6.1.3.1/90 THEN do (NOTE 3) | +| 10 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 3) | +| 11 | Attestation-Info | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/123 THEN do (NOTE 3) | +| 12 | Call-ID | [13] | m | dm | +| 13 | Call-Info | [13] | o | IF dc4 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) OR dc5 (announcements: clause 12.21) OR dc13 (eCNAM: clause 12.25) THEN dm ELSE do | +| 14 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 3) | +| 15 | Contact | [13] | m | dm | +| 16 | Content-Disposition | [13] | o | IF dc6 (AOC: clause 12.22) THEN dm ELSE do | +| 17 | Content-Encoding | [13] | o | do | +| 18 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 19 | Content-Language | [13] | o | do | +| 20 | Content-Length | [13] | t | dt | +| 21 | Content-Type | [13] | * | d* | +| 22 | CSeq | [13] | m | dm | +| 23 | Date | [13] | o | do | +| 24 | Expires | [13] | o | do | +| 25 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE 3) | +| 26 | From | [13] | m | dm | +| 27 | Geolocation | [68] | o | do | +| 28 | Geolocation-Routing | [68] | o | do | +| 29 | History-Info | [25] | o | IF dc7 (CDIV: clause 12.6) OR dc2 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND initial request THEN do (NOTE 1, NOTE 3) | +| 30 | Identity | [206] | o | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/119 THEN do (NOTE 3) | +| 31 | In-Reply-To | [13] | o | do | +| 32 | Join | [55] | o | IF table 6.1.3.1/48 THEN do (NOTE 3) | +| 33 | Max-Breadth | [79] | o | do | +| 34 | Max-Forwards | [13] | m | dm | +| 35 | MIME-Version | [13] | o | do | +| 36 | Min-SE | [52] | o | do | +| 37 | Organization | [13] | o | do | +| 38 | Origination-Id | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/124 THEN do (NOTE 3) | +| 39 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 3) | +| 40 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 AND initial request THEN dm (NOTE 2, NOTE 3) | +| 41 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND initial request THEN do (NOTE 3) | +| 42 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE 3) | +| 43 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 44 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND initial request THEN | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|--------------|------|------------|------------------| +| | | | | dm (NOTE 3) | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|------------------------------|-------|------------|------------------------------------------------------------------------------------------------------------------------------------| +| 45 | P-Early-Media | [74] | o | IF table 6.1.3.1/69 THEN do (NOTE 3) | +| 46 | P-Media-Authorization | [42] | o | dn/a | +| 47 | P-Preferred-Identity | [44] | o | dn/a | +| 48 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND initial request THEN do (NOTE 3) | +| 49 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND initial request THEN do (NOTE 3) | +| 50 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND initial request THEN do (NOTE 3) | +| 51 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND initial request being sent from "privileged sender" THEN dm (NOTE 3) | +| 52 | P-User-Database | [60] | o | dn/a | +| 53 | P-Visited-Network-ID | [24] | o | dn/a | +| 54 | Priority | [13] | o | do | +| 55 | Priority-Share | [5] | n/a | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE 3) | +| 56 | Priority-Verstat | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/128 THEN do (NOTE 3) | +| 57 | Privacy | [34] | o | IF dc8 (OIP/OIR: clause 12.3) THEN dm ELSE do | +| 58 | Priv-Answer-Mode | [94] | o | IF table 6.1.3.1/90 THEN do (NOTE 3) | +| 59 | Proxy-Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 3) | +| 60 | Proxy-Require | [13] | o | do | +| 61 | Reason | [48] | o | IF table 6.1.3.1/40 AND subsequent request THEN do (NOTE 3) | +| 62 | Record-Route | [13] | o | do | +| 63 | Recv-Info | [39] | m | IF table 6.1.3.1/17 THEN dm (NOTE 3) | +| 64 | Referred-By | [53] | o | IF dc9 (ECT: clause 12.13) OR dc10 (CONF: clause 12.19) THEN dm ELSE do | +| 65 | Reject-Contact | [51] | o | do | +| 66 | Relayed-Charge | [5] | n/a | dn/a | +| 67 | Replaces | [54] | o | IF dc11 (ECT: clause 12.13) OR dc12 (CONF: clause 12.19) THEN dm ELSE IF table 6.1.3.1/47 THEN do (NOTE 3) | +| 68 | Reply-To | [13] | o | do | +| 69 | Request-Disposition | [51] | o | do | +| 70 | Require | [13] | c | IF dc11 (ECT: clause 12.13) THEN dm ELSE dc | +| 71 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 3) | +| 72 | Resource-Share | [5] | n/a | IF (home-to-visited request on roaming II-NNI OR visited-to-home request on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE 3) | +| 73 | Restoration-Info | [5] | n/a | IF home-to-visited request on roaming II-NNI AND initial request AND table 6.1.3.1/113 THEN do (NOTE 3) | +| 74 | Route | [13] | c | dc | +| 75 | Security-Client | [47] | o | dn/a | +| 76 | Security-Verify | [47] | o | dn/a | +| 77 | Service-Interact-Info | [5] | n/a | IF table 6.1.3.1/125 AND initial request THEN do (NOTE 3) | +| 78 | Session-Expires | [52] | o | do | +| 79 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 3) | +| 80 | Subject | [13] | o | do | +| 81 | Supported | [13] | m* | IF dc2 (PNM: clause 12.17) THEN dm ELSE dm* | +| 82 | Target-Dialog | [140] | o | IF table 6.1.3.1/102 THEN do (NOTE 3) | +| 83 | Timestamp | [13] | o | do | +| 84 | To | [13] | m | dm | +| 85 | Trigger-Consent | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 3) | +| 86 | User-Agent | [13] | o | do | +| 87 | User-to-User | [83] | o | IF table 6.1.3.1/79 THEN do (NOTE 3) | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|------------|------------------| +| 88 | Via | [13] | m | dm | +| dc1: | request invoked due to AOC AND visited-to-home request on roaming II-NNI | | | | +| dc2: | initial request invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc3: | initial request invoked due to CRS AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc4: | initial request invoked due to CCBS/CCNR/CCNL AND "CC call" request AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc5: | subsequent request invoked due to announcements using the Call-info header field AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc6: | request invoked due to AOC AND home-to-visited request on roaming II-NNI | | | | +| dc7: | initial request towards the network serving "the diverted-to user" AND CFU/CFB/CFNR/CFNRc/CD/CFNL AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc8: | (initial request invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (initial request invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI)) | | | | +| dc9: | initial request invoked due to ECT AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc10: | (initial request from "conference participant" receiving REFER request with Referred-By header field AND (visited-to-home request on roaming II-NNI OR non-roaming II-NNI OR loopback traversal scenario)) OR (initial request from "conference focus" receiving REFER request AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI)) | | | | +| dc11: | "Consultative transfer" due to ECT AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc12: | initial request from "conference focus" receiving REFER request with Replaces header field escaped in Refer-To header field AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc13: | initial request AND home-to-visited request on roaming II-NNI | | | | +| NOTE 1: | The Privacy header field can be escaped in the header field for CDIV. | | | | +| NOTE 2: | The header field is not included in some exceptional cases. (e.g. when an incoming call from a circuit-switched network has not included the required information to be mapped into the header field) | | | | +| NOTE 3: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.7.2 lists the supported header fields within the INVITE response. + +**Table B.7.2: Supported header fields within the INVITE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|--------------------------|-----------------|-------------|------------|--------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 2 | Accept-Encoding | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do
(NOTE 3) | +| 5 | Alert-Info | 180 | [13] | o | IF dc1 (CW: clause 12.7) OR
dc2 (announcements: clause 12.21)
THEN dm ELSE IF table 6.1.3.1/10
THEN do (NOTE 3) | +| 6 | Allow | 2xx | [13] | m* | dm* | +| | | 405 | | m | dm | +| | | others | | o | do | +| 7 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do
(NOTE 3) | +| 8 | Answer-Mode | 2xx | [94] | o | IF table 6.1.3.1/90 THEN do
(NOTE 3) | +| 9 | Authentication-Info | 2xx | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 3) | +| 10 | Call-ID | 100 | [13] | m | dm | +| | | others | | | | +| 11 | Call-Info | r | [13] | o | IF dc3 (CCBS: clause 12.11) OR
dc4 (CCNR: clause 12.12) OR
dc5 (CCNL: clause 12.23) THEN dm
ELSE do | +| 12 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do
(NOTE 3) | +| 13 | Contact | 18x | [13]
[5] | o | dm | +| | | 199 | | | | +| | | 2xx | | m | dm | +| | | 3xx
485 | | o | do | +| 14 | Content-Disposition | r | [13] | o | IF dc6 (AOC: clause 12.22) THEN dm
ELSE do | +| 15 | Content-Encoding | r | [13] | o | do | +| 16 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 17 | Content-Language | r | [13] | o | do | +| 18 | Content-Length | 100
others | [13] | t | dt | +| 19 | Content-Type | r | [13] | * | IF dc7 (CCBS: clause 12.11) OR
dc8 (CCNR/CCNL:
clause 12.12/12.23) THEN dm ELSE
d* | +| 20 | CSeq | 100 | [13] | m | dm | +| | | others | | | | +| 21 | Date | 100
others | [13] | o | IF dc7 (CCBS: clause 12.11) OR
dc8 (CCNR/CCNL:
clause 12.12/12.23) THEN dm ELSE
do | +| 22 | Error-Info | 3xx-6xx | [13] | o | IF dc9 (announcements:
clause 12.21) THEN dm ELSE IF
table 6.1.3.1/13 THEN do (NOTE 3) | +| 23 | Expires | r | [13] | o | do | +| 24 | Feature-Caps | 18x
2xx | [143] | o | IF table 6.1.3.1/103 THEN do
(NOTE 3) | +| 25 | From | 100
others | [13] | m | dm | +| 26 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 27 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to
initial request THEN do (NOTE 2, | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------------|----------------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | | NOTE 3, NOTE 4) | +| 28 | MIME-version | r | [13] | o | do | +| 29 | Min-SE | 422 | [52] | m | dm | +| 30 | Organization | r | [13] | o | do | +| 31 | P-Access-Network-Info | r | [24], [2 4A], [2 4B] | o | IF table 6.1.3.1/36 THEN do (NOTE 3) | +| 32 | P-Answer-State | 18x
2xx | [73] | o | IF table 6.1.3.1/68 THEN do (NOTE 3) | +| 33 | P-Asserted-Identity | r | [44] | o | IF dc11 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to initial request THEN do (NOTE 3) | +| 34 | P-Charging-Function-Addresses | r | [24], [2 4A] | o | dn/a | +| 35 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | 18x, 2xx | | o | IF (table 6.1.3.1/38 AND response to initial request) OR dc 12(CONF: clause 12.19) THEN dm (NOTE 3) | +| | | 3xx-6xx | | o | do (NOTE 3) | +| 36 | P-Early-Media | 18x | [74] | o | IF dc13 (CAT: clause 12.14) OR dc14 (announcements: clause 12.21) THEN dm ELSE IF table 6.1.3.1/69 THEN do (NOTE 3) | +| 37 | P-Media-Authorization | 18x
2xx | [42] | o | dn/a | +| 38 | P-Preferred-Identity | r | [44] | o | dn/a | +| 39 | P-Refused-URI-List | 403 | [141] | o | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/101 THEN do (NOTE 3) | +| 40 | Permission-Missing | 470 | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 3) | +| 41 | Priority-Share | 18x
2xx | [5] | n/a | IF home-to-visited response on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE 3) | +| 42 | Privacy | r | [34] | o | IF dc15 (TIP/TIR: clause 12.4) THEN dm ELSE do | +| 43 | Priv-Answer-Mode | 2xx | [94] | o | IF table 6.1.3.1/90 THEN do (NOTE 3) | +| 44 | Proxy-Authenticate | 401 (NOTE 1) | [13] | o | do | +| | | 407 (NOTE 1) | | m | dm | +| 45 | Reason | 18x
199
3xx-6xx | [48] | o | IF dc16 (CW: clause 12.7) OR dc17 (ICB: clause 12.10.1) OR dc18 (announcements: clause 12.21) THEN dm ELSE IF table 6.1.3.1/40 OR ((non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/41B) THEN do (NOTE 3) | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-----------------------|------------------------------------------------------|-------|------------|--------------------------------------------------------------------------------------------------------------------------------------| +| | | 2xx | [48] | o | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/41B THEN do (NOTE 3) | +| 46 | Record-Route | 18x
199
2xx | [13] | o | do | +| 47 | Recv-Info | 18x
199
2xx | [39] | c | IF table 6.1.3.1/17 THEN dc (NOTE 3) | +| 48 | Relayed-Charge | r | [5] | n/a | dn/a | +| 49 | Reply-To | r | [13] | o | do | +| 50 | Require | r | [13] | c | IF dc19 (CAT: clause 12.14) THEN dm ELSE dc | +| 51 | Resource-Share | 18x
2xx | [5] | n/a | IF (home-to-visited response on roaming II-NNI OR visited-to-home response on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE 3) | +| 52 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 3) | +| 53 | Restoration-Info | 408 | [5] | n/a | IF table 6.1.3.1/114 AND response to initial request AND visited-to-home response on roaming II-NNI THEN do (NOTE 3) | +| 54 | Retry-After | 404
413
480
486
500
503
600
603 | [13] | o | do | +| 55 | RSeq | 18x
199 | [18] | o | do | +| 56 | Security-Server | 421
494 | [47] | o | dn/a | +| 57 | Server | r | [13] | o | do | +| 58 | Service-Interact-Info | 18x
2xx | [5] | n/a | IF table 6.1.3.1/125 AND response to initial request THEN do (NOTE 3) | +| 59 | Session-Expires | 2xx | [52] | o | do | +| 60 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 3) | +| 61 | Supported | 2xx | [13] | m* | dm* | +| 62 | Timestamp | r | [13] | o | do | +| 63 | To | 100
others | [13] | m | dm | +| 64 | Unsupported | 420 | [13] | m | dm | +| 65 | User-Agent | r | [13] | o | do | +| 66 | User-to-User | r | [83] | o | IF table 6.1.3.1/79 THEN do (NOTE 3) | +| 67 | Via | 100
others | [13] | m | dm | +| 68 | Warning | r | [13] | o | IF dc20 (CDIV: clause 12.6) THEN dm ELSE do | +| 69 | WWW-Authenticate | 401
(NOTE 1) | [13] | m | dm | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------|------------|------------------| +| | | 407
(NOTE 1) | | o | do | +| dc1: | response invoked due to CW AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc2: | response to initial request invoked due to announcements using the Alert-Info header field AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc3: | 486 (Busy Here) response invoked due to CCBS AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc4: | 180 (Ringing) response invoked due to CCNR AND (non-roaming II-NNI OR loopback traversal scenario) | | | | | +| dc5: | 480 (Temporarily Unavailable) response invoked due to CCNL AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc6: | non-100 provisional response /200 (OK) response invoked due to AOC AND home-to-visited response on roaming II-NNI | | | | | +| dc7: | 486 (Busy Here) response invoked due to CCBS AND home-to-visited response on roaming II-NNI | | | | | +| dc8: | 480 (Temporarily Unavailable) response invoked due to CCNR/CCNL AND home-to-visited response on roaming II-NNI | | | | | +| dc9: | response to initial request invoked due to announcements using the Error-Info header field AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc11: | (TIP/TIR AND 2xx response to initial request AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI OR loopback traversal scenario)) OR (TIP/TIR AND response to initial request AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | +| dc12: | first response from "conference focus" to initial request AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc13: | reliable 18x response to initial request invoked due to CAT using ("forking model" OR "gateway model") AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc14: | 18x response to initial request invoked due to announcements authorizing early media AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc15: | (TIP/TIR AND non-100 response to initial request AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to initial request AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI)) | | | | | +| dc16: | 480 (Temporarily Unavailable) response invoked due to CW at the expiry of the "CW timer" | | | | | +| dc17: | 603 (Decline) response invoked due to "dynamic ICB" on an early dialog | | | | | +| dc18: | 183 (Session Progress) response to initial request invoked due to announcements authorizing early media when rejecting a communication request AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc19: | first 18x response to initial request invoked due to CAT using "early session model" AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc20: | 480 (Temporarily Unavailable)/486 (Busy Here) response to initial request AND CFU/CFB/CFNR/CFNRc/CD/CFNL in case "maximum number of diversions" exceeds AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | +| NOTE 2: | The Privacy header field can be escaped in the header field for CDIV. | | | | | +| NOTE 3: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | +| NOTE 4: | History-Info header field is always included, if the AS supporting CDIV requirements is applied to the corresponding initial INVITE request applying CDIV at the home IMS network of the terminating user. | | | | | + +--- + +## B.8 MESSAGE method + +As described in table 6.1, the support of MESSAGE method over the II-NNI is based on bilateral agreement between the operators. + +The table B.8.1 lists the supported header fields within the MESSAGE request. + +**Table B.8.1: Supported header fields within the MESSAGE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 2 | Additional-Identity | [5] | n/a | IF table 6.1.3.1/126 THEN do (NOTE) | +| 3 | Allow | [13], [19] | o | do | +| 4 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 5 | Attestation-Info | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/123 THEN do (NOTE) | +| 6 | Authorization | [13], [19] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 7 | Call-ID | [13], [19] | m | dm | +| 8 | Call-Info | [13], [19] | o | do | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Content-Disposition | [13], [19] | o | do | +| 11 | Content-Encoding | [13], [19] | o | do | +| 12 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 13 | Content-Language | [13], [19] | o | do | +| 14 | Content-Length | [13], [19] | t | dt | +| 15 | Content-Type | [13], [19] | * | d* | +| 16 | CSeq | [13], [19] | m | dm | +| 17 | Date | [13], [19] | o | do | +| 18 | Expires | [13], [19] | o | do | +| 19 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 AND request outside an existing dialog THEN do (NOTE) | +| 20 | From | [13], [19] | m | dm | +| 21 | Geolocation | [68] | o | do | +| 22 | Geolocation-Routing | [68] | o | do | +| 23 | History-Info | [25] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 24 | Identity | [206] | o | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/119 THEN do (NOTE) | +| 25 | In-Reply-To | [13], [19] | o | do | +| 26 | Max-Breadth | [79] | o | do | +| 27 | Max-Forwards | [13], [19] | m | dm | +| 28 | MIME-Version | [13] | o | do | +| 29 | Organization | [13], [19] | o | do | +| 30 | Origination-Id | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/124 THEN do (NOTE) | +| 31 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 32 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 AND request outside an existing dialog THEN dm (NOTE) | +| 33 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 34 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 35 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 36 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND request outside an existing dialog THEN dm (NOTE) | +| 37 | P-Preferred-Identity | [44] | o | dn/a | +| 38 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 39 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND request outside an existing dialog THEN do (NOTE) | +| 40 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND request outside an existing dialog THEN do (NOTE) | +| 41 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND request outside an existing dialog being sent from "privileged sender" THEN dm (NOTE) | +| 42 | P-User-Database | [60] | o | dn/a | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------------|----------------------------------------------------------------------------| +| 43 | P-Visited-Network-ID | [24] | o | dn/a | +| 44 | Priority | [13], [19] | o | do | +| 45 | Privacy | [34] | o | IF dc2 (OIP/OIR: clause 12.3) THEN dm ELSE do | +| 46 | Proxy-Authorization | [13], [19] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 47 | Proxy-Require | [13], [19] | o | do | +| 48 | Reason | [48] | o | IF table 6.1.3.1/40 AND request inside an existing dialog THEN do (NOTE) | +| 49 | Referred-By | [53] | o | do | +| 50 | Reject-Contact | [51] | o | do | +| 51 | Relayed-Charge | [5] | n/a | dn/a | +| 52 | Reply-To | [13], [19] | o | do | +| 53 | Request-Disposition | [51] | o | do | +| 54 | Require | [13], [19] | c | dc | +| 55 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 56 | Route | [13], [19] | c | dc | +| 57 | Security-Client | [47] | o | dn/a | +| 58 | Security-Verify | [47] | o | dn/a | +| 59 | Service-Interact-Info | [5] | n/a | IF table 6.1.3.1/125 AND request outside an existing dialog THEN do (NOTE) | +| 60 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 61 | Subject | [13], [19] | o | do | +| 62 | Supported | [13] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 63 | Timestamp | [13], [19] | o | do | +| 64 | To | [13], [19] | m | dm | +| 65 | Trigger-Consent | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE) | +| 66 | User-Agent | [13], [19] | o | do | +| 67 | Via | [13], [19] | m | dm | +| dc1: | request outside an existing dialog invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | (request outside an existing dialog invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (request outside an existing dialog invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.8.2 lists the supported header fields within the MESSAGE response. + +**Table B.8.2: Supported header fields within the MESSAGE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------|--------------------|------------|------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [19] | m* | dm* | +| 2 | Accept-Encoding | 415 | [13], [19] | m* | dm* | +| 3 | Accept-Language | 415 | [13], [19] | m* | dm* | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405 | [13], [19] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13], [19] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13], [19] | m | dm | +| | | others | | | | +| 9 | Call-Info | r | [13], [19] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Contact | 3xx
485 | [13], [19] | o | do | +| 12 | Content-Disposition | r | [13], [19] | o | do | +| 13 | Content-Encoding | r | [13], [19] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13], [19] | o | do | +| 16 | Content-Length | 100 | [13], [19] | t | dt | +| | | others | | | | +| 17 | Content-Type | r | [13], [19] | * | d* | +| 18 | CSeq | 100 | [13], [19] | m | dm | +| | | others | | | | +| 19 | Date | 100 | [13], [19] | o | do | +| | | others | | | | +| 20 | Error-Info | 3xx-6xx | [13], [19] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 21 | Expires | r | [13], [19] | o | do | +| 22 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 23 | From | 100 | [13], [19] | m | dm | +| | | others | | | | +| 24 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 25 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 26 | MIME-version | r | [13] | o | do | +| 27 | Organization | r | [13], [19] | o | do | +| 28 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 29 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 30 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 31 | P-Charging-Vector | 100 | [24], | o | dn/a | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-----------------------|------------------------------------------------------|------------|------------|-----------------------------------------------------------------------------------------------| +| | | 18x, 2xx | [24A] | o | IF table 6.1.3.1/38 AND response to request outside an existing dialog THEN dm (NOTE 2) | +| | | 3xx-6xx | | o | do (NOTE 3) | +| 32 | P-Preferred-Identity | r | [44] | o | dn/a | +| 33 | Permission-Missing | 470 | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 2) | +| 34 | Privacy | r | [34] | o | IF dc2(TIP/TIR: clause 12.4) THEN dm ELSE do | +| 35 | Proxy-Authenticate | 401 (NOTE 1) | [13], [19] | o | do | +| | | 407 (NOTE 1) | | m | dm | +| 36 | Reason | 18x
199
2xx
3xx-6xx | [48] | o | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/41B THEN do (NOTE 2) | +| 37 | Relayed-Charge | r | [5] | n/a | dn/a | +| 38 | Reply-To | r | [13], [19] | o | do | +| 39 | Require | r | [13], [19] | c | dc | +| 40 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 41 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | +| 42 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [19] | o | do | +| 43 | Security-Server | 421
494 | [47] | o | dn/a | +| 44 | Server | r | [13], [19] | o | do | +| 45 | Service-Interact-Info | 18x
2xx | [5] | n/a | IF table 6.1.3.1/125 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 46 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 2) | +| 47 | Supported | 2xx | [13] | o | do | +| 48 | Timestamp | r | [13], [19] | o | do | +| 49 | To | 100
others | [13], [19] | m | dm | +| 50 | Unsupported | 420 | [13], [19] | o | do | +| 51 | User-Agent | r | [13], [19] | o | do | +| 52 | Via | 100
others | [13], [19] | m | dm | +| 53 | Warning | r | [13], [19] | o | do | +| 54 | WWW-Authenticate | 401 (NOTE 1) | [13], [19] | m | dm | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------|------------|------------------| +| | | 407
(NOTE 1) | | o | do | +| dc1: | (TIP/TIR AND 2xx response to request outside an existing dialog AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to request outside an existing dialog AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | +| dc2: | (TIP/TIR AND non-100 response to request outside an existing dialog AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to request outside an existing dialog AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | +| NOTE 2: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | + +--- + +## B.9 NOTIFY method + +As described in table 6.1, the support of NOTIFY method over the non-roaming II-NNI is based on bilateral agreement between the operators. + +The table B.9.1 lists the supported header fields within the NOTIFY request. + +**Table B.9.1: Supported header fields within the NOTIFY request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------| +| 1 | Accept | [13], [20] | o | do | +| 2 | Accept-Contact | [51] | o | do | +| 3 | Accept-Encoding | [13], [20] | o | do | +| 4 | Accept-Language | [13], [20] | o | do | +| 5 | Allow | [13], [20] | o | do | +| 6 | Allow-Events | [20] | o | do | +| 7 | Authorization | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13], [20] | m | dm | +| 9 | Call-Info | [13] | o | do | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13], [20] | m | dm | +| 12 | Content-Disposition | [13], [20] | o | do | +| 13 | Content-Encoding | [13], [20] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13], [20] | o | do | +| 16 | Content-Length | [13], [20] | t | dt | +| 17 | Content-Type | [13], [20] | * | d* | +| 18 | CSeq | [13], [20] | m | dm | +| 19 | Date | [13], [20] | o | do | +| 20 | Event | [20] | m | dm | +| 21 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 22 | From | [13], [20] | m | dm | +| 23 | Geolocation | [68] | o | do | +| 24 | Geolocation-Routing | [68] | o | do | +| 25 | History-Info | [25] | o | IF table 6.1.3.1/50 THEN do (NOTE) | +| 26 | Max-Breadth | [79] | o | do | +| 27 | Max-Forwards | [13], [20] | m | dm | +| 28 | MIME-Version | [13], [20] | o | do | +| 29 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 THEN do (NOTE) | +| 31 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 32 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN dm (NOTE) | +| 33 | P-Preferred-Identity | [44] | o | dn/a | +| 34 | Privacy | [34] | o | do | +| 35 | Proxy-Authorization | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 36 | Proxy-Require | [13], [20] | o | do | +| 37 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 38 | Record-Route | [13], [20] | o | do | +| 39 | Referred-By | [53] | o | do | +| 40 | Reject-Contact | [51] | o | do | +| 41 | Relayed-Charge | [5] | n/a | dn/a | +| 42 | Request-Disposition | [51] | o | do | +| 43 | Require | [13], [20] | o | do | +| 44 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 45 | Route | [13], [20] | c | dc | +| 46 | Security-Client | [47] | o | dn/a | +| 47 | Security-Verify | [47] | o | dn/a | +| 48 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 49 | Subscription-State | [20] | m | dm | +| 50 | Supported | [13], [20] | o | do | +| 51 | Timestamp | [13], [20] | o | do | +| 52 | To | [13], [20] | m | dm | +| 53 | User-Agent | [13], [20] | o | do | +| 54 | Via | [13], [20] | m | dm | +| 55 | Warning | [13], [20] | o | do | + +NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +The table B.9.2 lists the supported header fields within the NOTIFY response. + +**Table B.9.2: Supported header fields within the NOTIFY response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|------------------------------|--------------------|-------------|--------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [20] | o | do | +| 2 | Accept-Encoding | 415 | [13], [20] | o | do | +| 3 | Accept-Language | 415 | [13], [20] | o | do | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405
others | [13], [20] | m
o | dm
do | +| 6 | Allow-Events | 2xx
489 | [20] | o
m | do
dm | +| 7 | Authentication-Info | 2xx | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
others | [13], [20] | m | dm | +| 9 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 10 | Contact | 2xx
3xx
485 | [13], [20] | o
m
o | do
dm
do | +| 11 | Content-Disposition | r | [13], [20] | o | do | +| 12 | Content-Encoding | r | [13], [20] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13], [20] | o | do | +| 15 | Content-Length | 100
others | [13], [20] | t | dt | +| 16 | Content-Type | r | [13], [20] | * | d* | +| 17 | CSeq | 100
others | [13], [20] | m | dm | +| 18 | Date | 100
others | [13], [20] | o | do | +| 19 | Error-Info | 3xx-6xx | [13], [20] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE 2) | +| 21 | From | 100
others | [13], [20] | m | dm | +| 22 | Geolocation-Error | 424
others | [68] | m
o | dm
do | +| 23 | MIME-version | r | [13], [20] | o | do | +| 24 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 25 | P-Asserted-Identity | r | [44] | o | IF table 6.1.3.1/27 THEN do (NOTE 2) | +| 26 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 27 | P-Charging-Vector | 100
18x, 2xx
3xx-6xx | [24], [24A] | o
o
o | dn/a
IF table 6.1.3.1/38 THEN dm (NOTE 2)
do (NOTE 3) | +| 28 | P-Preferred-Identity | r | [44] | o | dn/a | +| 29 | Privacy | r | [34] | o | do | +| 30 | Proxy-Authenticate | 401 (NOTE 1)
407 (NOTE 1) | [13], [20] | o
m | do
dm | +| 31 | Record-Route | 2xx | [13], [20] | o | do | +| 32 | Relayed-Charge | r | [5] | n/a | dn/a | +| 33 | Require | r | [13], [20] | o | do | +| 34 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 35 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | +| 36 | Retry-After | 404 | [13], [20] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|------------------|-----------------------------------------------|------------|------------|-----------------------------------------| +| | | 413
480
486
500
503
600
603 | | | | +| 37 | Security-Server | 421
494 | [47] | o | dn/a | +| 38 | Server | r | [13], [20] | o | do | +| 39 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | +| 40 | Supported | 2xx | [13], [20] | o | do | +| 41 | Timestamp | r | [13], [20] | o | do | +| 42 | To | 100
others | [13], [20] | m | dm | +| 43 | Unsupported | 420 | [13], [20] | o | do | +| 44 | User-Agent | r | [13], [20] | o | do | +| 45 | Via | 100
others | [13], [20] | m | dm | +| 46 | Warning | r | [13], [20] | o | do | +| 47 | WWW-Authenticate | 401
(NOTE 1) | [13], [20] | m | dm | +| | | 407
(NOTE 1) | | o | do | + +NOTE 1: The SIP status code is only applicable over the roaming II-NNI. + +NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +--- + +## B.10 OPTIONS method + +The table B.10.1 lists the supported header fields within the OPTIONS request. + +**Table B.10.1: Supported header fields within the OPTIONS request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13] | m* | dm* | +| 2 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 3 | Accept-Encoding | [13] | o | do | +| 4 | Accept-Language | [13] | o | do | +| 5 | Allow | [13] | o | do | +| 6 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 7 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13] | m | dm | +| 9 | Call-Info | [13] | o | do | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13] | o | do | +| 12 | Content-Disposition | [13] | o | do | +| 13 | Content-Encoding | [13] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13] | o | do | +| 16 | Content-Length | [13] | t | dt | +| 17 | Content-Type | [13] | * | d* | +| 18 | CSeq | [13] | m | dm | +| 19 | Date | [13] | o | do | +| 20 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 AND request outside an existing dialog THEN do (NOTE) | +| 21 | From | [13] | m | dm | +| 22 | Geolocation | [68] | o | do | +| 23 | Geolocation-Routing | [68] | o | do | +| 24 | History-Info | [25] | o | IF (dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 25 | Max-Breadth | [79] | o | do | +| 26 | Max-Forwards | [13] | m | dm | +| 27 | MIME-Version | [13] | o | do | +| 28 | Organization | [13] | o | do | +| 29 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 AND request outside an existing dialog THEN dm (NOTE) | +| 31 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 32 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 33 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 34 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND request outside an existing dialog THEN dm (NOTE) | +| 35 | P-Preferred-Identity | [44] | o | dn/a | +| 36 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 37 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND request outside an existing dialog THEN do (NOTE) | +| 38 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND request outside an existing dialog THEN do (NOTE) | +| 39 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND request outside an existing dialog being sent from "privileged sender" THEN dm (NOTE) | +| 40 | P-User-Database | [60] | o | dn/a | +| 41 | P-Visited-Network-ID | [24] | o | dn/a | +| 42 | Privacy | [34] | o | IF dc2 (OIP/OIR: clause 12.3) THEN dm ELSE do | +| 43 | Proxy-Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 44 | Proxy-Require | [13] | o | do | +| 45 | Reason | [48] | o | IF table 6.1.3.1/40 AND request inside an existing dialog THEN do (NOTE) | +| 46 | Record-Route | [13] | o | do | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------------|--------------------------------------------| +| 47 | Recv-Info | [39] | n/a | dn/a | +| 48 | Referred-By | [53] | o | do | +| 49 | Reject-Contact | [51] | o | do | +| 50 | Relayed-Charge | [5] | n/a | dn/a | +| 51 | Request-Disposition | [51] | o | do | +| 52 | Require | [13] | c | dc | +| 53 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 54 | Route | [13] | c | dc | +| 55 | Security-Client | [47] | o | dn/a | +| 56 | Security-Verify | [47] | o | dn/a | +| 57 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 58 | Supported | [13] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 59 | Timestamp | [13] | o | do | +| 60 | To | [13] | m | dm | +| 61 | User-Agent | [13] | o | do | +| 62 | Via | [13] | m | dm | +| dc1: | request outside an existing dialog invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | (request outside an existing dialog invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (request outside an existing dialog invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.10.2 lists the supported header fields within the OPTIONS response. + +**Table B.10.2: Supported header fields within the OPTIONS response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------------|----------------------|------------|------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 2xx | [13] | m* | dm* | +| | | 415 | | c | dc | +| 2 | Accept-Encoding | 2xx | [13] | m* | dm* | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx | [13] | m* | dm* | +| | | 415 | | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 2xx | [13] | m* | dm* | +| | | 405 | | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13] | m | dm | +| | | others | | | | +| 9 | Call-Info | r | [13] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Contact | 2xx
3xx
485 | [13] | o | do | +| 12 | Content-Disposition | r | [13] | o | do | +| 13 | Content-Encoding | r | [13] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13] | o | do | +| 16 | Content-Length | 100 | [13] | t | dt | +| | | others | | | | +| 17 | Content-Type | r | [13] | * | d* | +| 18 | CSeq | 100 | [13] | m | dm | +| | | others | | | | +| 19 | Date | 100 | [13] | o | do | +| | | others | | | | +| 20 | Error-Info | 3xx-6xx | [13] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 21 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 22 | From | 100 | [13] | m | dm | +| | | others | | | | +| 23 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 24 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 25 | MIME-version | r | [13] | o | do | +| 26 | Organization | r | [13] | o | do | +| 27 | P-Access-Network-Info | r | [24], [2 4A], [2 4B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 28 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 29 | P-Charging-Function-Addresses | r | [24], [2 4A] | o | dn/a | +| 30 | P-Charging-Vector | 100 | [24], | o | dn/a | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|-------|------------|-----------------------------------------------------------------------------------------|--| +| | | 18x, 2xx | [24A] | o | IF table 6.1.3.1/38 AND response to request outside an existing dialog THEN dm (NOTE 2) | | +| | | 3xx-6xx | | o | do (NOTE 2) | | +| 31 | P-Preferred-Identity | r | [44] | o | dn/a | | +| 32 | Privacy | r | [34] | o | IF dc2 (TIP/TIR: clause 12.4) THEN dm ELSE do | | +| 33 | Proxy-Authenticate | 401 (NOTE 1) | [13] | o | do | | +| | | 407 (NOTE 1) | | m | dm | | +| 34 | Record-Route | 2xx | [13] | o | do | | +| 35 | Recv-Info | 2xx
others | [39] | n/a | dn/a | | +| 36 | Relayed-Charge | r | [5] | n/a | dn/a | | +| 37 | Require | r | [13] | c | dc | | +| 38 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | | +| 39 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | | +| 40 | Retry-After | 404
413
480
486
500
503
600
603 | [13] | o | do | | +| 41 | Security-Server | 421
494 | [47] | o | dn/a | | +| 42 | Server | r | [13] | o | do | | +| 43 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 2) | | +| 44 | Supported | 2xx | [13] | m* | dm* | | +| 45 | Timestamp | r | [13] | o | do | | +| 46 | To | 100
others | [13] | m | dm | | +| 47 | Unsupported | 420 | [13] | m | dm | | +| 48 | User-Agent | r | [13] | o | do | | +| 49 | Via | 100
others | [13] | m | dm | | +| 50 | Warning | r | [13] | o | do | | +| 51 | WWW-Authenticate | 401 (NOTE 1) | [13] | m | dm | | +| | | 407 (NOTE 1) | | o | do | | +| dc1: | (TIP/TIR AND 2xx response to request outside an existing dialog AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to request outside an existing dialog AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | | +| dc2: | (TIP/TIR AND non-100 response to request outside an existing dialog AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to request outside an existing dialog AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | | +| NOTE 2: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | + +--- + +## B.11 PRACK method + +The table B.11.1 lists the supported header fields within the PRACK request. + +**Table B.11.1: Supported header fields within the PRACK request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------|----------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13], [18] | o | do | +| 2 | Accept-Contact | [51] | o | do | +| 3 | Accept-Encoding | [13], [18] | o | do | +| 4 | Accept-Language | [13], [18] | o | do | +| 5 | Allow | [13], [18] | o | do | +| 6 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 7 | Authorization | [13], [18] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13], [18] | m | dm | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Content-Disposition | [13], [18] | o | do | +| 11 | Content-Encoding | [13], [18] | o | do | +| 12 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 13 | Content-Language | [13], [18] | o | do | +| 14 | Content-Length | [13], [18] | t | dt | +| 15 | Content-Type | [13], [18] | * | d* | +| 16 | CSeq | [13], [18] | m | dm | +| 17 | Date | [13], [18] | o | do | +| 18 | From | [13], [18] | m | dm | +| 19 | Max-Breadth | [79] | o | do | +| 20 | Max-Forwards | [13], [18] | m | dm | +| 21 | MIME-Version | [13], [18] | o | do | +| 22 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 23 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 24 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 25 | P-Early-Media | [74] | o | IF dc1 (CAT: clause 12.14) THEN dm ELSE IF table 6.1.3.1/69 THEN do (NOTE) | +| 26 | Priority-Share | [5] | n/a | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE) | +| 27 | Privacy | [34] | o | do | +| 28 | Proxy-Authorization | [13], [18] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 29 | Proxy-Require | [13], [18] | o | do | +| 30 | RAck | [18] | m | dm | +| 31 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 32 | Record-Route | [13], [18] | o | do | +| 33 | Recv-Info | [39] | o | IF table 6.1.3.1/17 THEN do (NOTE) | +| 34 | Referred-By | [53] | o | do | +| 35 | Reject-Contact | [51] | o | do | +| 36 | Relayed-Charge | [5] | n/a | dn/a | +| 37 | Request-Disposition | [51] | o | do | +| 38 | Require | [13], [18] | c | dc | +| 39 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 40 | Resource-Share | [5] | n/a | IF (home-to-visited request on roaming II-NNI OR visited-to-home request on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE) | +| 41 | Route | [13], [18] | c | dc | +| 42 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 43 | Supported | [13], [18] | o | do | +| 44 | Timestamp | [13], [18] | o | do | +| 45 | To | [13], [18] | m | dm | +| 46 | User-Agent | [13], [18] | o | do | +| 47 | Via | [13], [18] | m | dm | +| dc1: | request invoked due to CAT to first 18x response with P-Early-Media header field cancelling "CAT service" provided by terminating AS AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.11.2 lists the supported header fields within the PRACK response. + +**Table B.11.2: Supported header fields within the PRACK response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------|--------------------|------------|--------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [18] | c | dc | +| 2 | Accept-Encoding | 415 | [13], [18] | c | dc | +| 3 | Accept-Language | 415 | [13], [18] | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405 | [13], [18] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13], [18] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13], [18] | m | dm | +| | | r | | | | +| 9 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 10 | Contact | 3xx
485 | [13], [18] | o | do | +| 11 | Content-Disposition | r | [13], [18] | o | do | +| 12 | Content-Encoding | r | [13], [18] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13], [18] | o | do | +| 15 | Content-Length | 100 | [13], [18] | t | dt | +| | | others | | | | +| 16 | Content-Type | r | [13], [18] | * | d* | +| 17 | CSeq | 100 | [13], [18] | m | dm | +| | | others | | | | +| 18 | Date | 100 | [13], [18] | o | do | +| | | others | | | | +| 19 | Error-Info | 3xx-6xx | [13], [18] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | From | 100 | [13], [18] | m | dm | +| | | others | | | | +| 21 | MIME-version | r | [13], [18] | o | do | +| 22 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 23 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 24 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | others | | o | IF table 6.1.3.1/38 THEN do (NOTE 2) | +| 25 | P-Early-Media | 2xx | [74] | o | IF table 6.1.3.1/69 THEN do (NOTE 2) | +| 26 | Priority-Share | 2xx | [5] | n/a | IF home-to-visited response on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE 2) | +| 27 | Privacy | r | [34] | o | do | +| 28 | Proxy-Authenticate | 401 (NOTE 1) | [13], [18] | o | do | +| | | 407 (NOTE 1) | | m | dm | +| 29 | Record-Route | 2xx | [13], [18] | o | do | +| 30 | Recv-Info | 2xx | [39] | c | IF table 6.1.3.1/17 THEN dc (NOTE 2) | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|------------------|------------------------------------------------------|------------|------------|--------------------------------------------------------------------------------------------------------------------------------------| +| | | others | | o | IF table 6.1.3.1/17 THEN do (NOTE 2) | +| 31 | Relayed-Charge | r | [5] | n/a | dn/a | +| 32 | Require | r | [13], [18] | c | dc | +| 33 | Resource-Share | 2xx | [5] | n/a | IF (home-to-visited response on roaming II-NNI OR visited-to-home response on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE 2) | +| 34 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 35 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [18] | o | do | +| 36 | Security-Server | 421
494 | [47] | n/a | dn/a | +| 37 | Server | r | [13], [18] | o | do | +| 38 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 2) | +| 39 | Supported | 2xx | [13], [18] | o | do | +| 40 | Timestamp | r | [13], [18] | o | do | +| 41 | To | 100
others | [13], [18] | m | dm | +| 42 | Unsupported | 420 | [13], [18] | m | dm | +| 43 | User-Agent | r | [13], [18] | o | do | +| 44 | Via | 100
others | [13], [18] | m | dm | +| 45 | Warning | r | [13], [18] | o | do | +| 46 | WWW-Authenticate | 401
(NOTE 1) | [13], [18] | m | dm | +| | | 407
(NOTE 1) | | o | do | + +NOTE 1: The SIP status code is only applicable over the roaming II-NNI. + +NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +--- + +## B.12 PUBLISH method + +As described in table 6.1, the support of PUBLISH method over the non-roaming II-NNI is based on bilateral agreement between the operators. + +The table B.12.1 lists the supported header fields within the PUBLISH request. + +**Table B.12.1: Supported header fields within the PUBLISH request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 2 | Allow | [13], [21] | o | do | +| 3 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 4 | Authorization | [13], [21] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 5 | Call-ID | [13], [21] | m | dm | +| 6 | Call-Info | [13], [21] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) THEN dm ELSE do | +| 7 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 8 | Contact | [13], [21] | n/a | dn/a | +| 9 | Content-Disposition | [13], [21] | o | do | +| 10 | Content-Encoding | [13], [21] | o | do | +| 11 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 12 | Content-Language | [13], [21] | o | do | +| 13 | Content-Length | [13], [21] | t | dt | +| 14 | Content-Type | [13], [21] | * | d* | +| 15 | CSeq | [13], [21] | m | dm | +| 16 | Date | [13], [21] | o | do | +| 17 | Event | [20] | m | dm | +| 18 | Expires | [13], [21] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) THEN dm ELSE do | +| 19 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 AND request outside an existing dialog THEN do | +| 20 | From | [13], [21] | m | dm | +| 21 | Geolocation | [68] | o | do | +| 22 | Geolocation-Routing | [68] | o | do | +| 23 | History-Info | [25] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 24 | In-Reply-To | [13], [21] | n/a | dn/a | +| 25 | Max-Breadth | [79] | o | do | +| 26 | Max-Forwards | [13], [21] | m | dm | +| 27 | MIME-Version | [13], [21] | o | do | +| 28 | Organization | [13], [21] | o | do | +| 29 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Asserted-Identity | [44] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) OR table 6.1.3.1/27 AND request outside an existing dialog THEN dm (NOTE) | +| 31 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 32 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 33 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 34 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND request outside an existing dialog THEN dm (NOTE) | +| 35 | P-Preferred-Identity | [44] | o | dn/a | +| 36 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 37 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND request outside an existing dialog THEN do (NOTE) | +| 38 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND request outside an existing dialog THEN do (NOTE) | +| 39 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND request outside an existing dialog being sent from "privileged sender" THEN dm (NOTE) | +| 40 | P-User-Database | [60] | o | dn/a | +| 41 | P-Visited-Network-ID | [24] | o | dn/a | +| 42 | Priority | [13], [21] | o | do | +| 43 | Privacy | [34] | o | IF dc3 (OIP/OIR: clause 12.3) THEN dm ELSE do | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------------|--------------------------------------------------------------------------| +| 44 | Proxy-Authorization | [13], [21] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 45 | Proxy-Require | [13], [21] | o | do | +| 46 | Reason | [48] | o | IF table 6.1.3.1/40 AND request inside an existing dialog THEN do (NOTE) | +| 47 | Referred-By | [53] | o | do | +| 48 | Reject-Contact | [51] | o | do | +| 49 | Relayed-Charge | [5] | n/a | dn/a | +| 50 | Reply-To | [13], [21] | n/a | dn/a | +| 51 | Request-Disposition | [51] | o | do | +| 52 | Require | [13], [21] | o | do | +| 53 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 54 | Route | [13], [21] | c | dc | +| 55 | Security-Client | [47] | o | dn/a | +| 56 | Security-Verify | [47] | o | dn/a | +| 57 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 58 | SIP-If-Match | [21] | o | do | +| 59 | Subject | [13], [21] | o | do | +| 60 | Supported | [13], [21] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 61 | Timestamp | [13], [21] | o | do | +| 62 | To | [13], [21] | m | dm | +| 63 | User-Agent | [13], [21] | o | do | +| 64 | Via | [13], [21] | m | dm | +| dc1: | request outside an existing dialog invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | (request inside an existing dialog invoked due to CCBS/CCNR/CCNL suspending the "CC request" AND (non-roaming II-NNI OR loopback traversal scenario) OR (request inside an existing dialog invoked due to CCBS/CCNR/CCNL resuming the "CC request" AND (non-roaming II-NNI OR loopback traversal scenario))) | | | | +| dc3: | (request outside an existing dialog invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (request outside an existing dialog invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.12.2 lists the supported header fields within the PUBLISH response. + +**Table B.12.2: Supported header fields within the PUBLISH response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------|--------------------|------------|------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [21] | m* | dm* | +| 2 | Accept-Encoding | 415 | [13], [21] | m* | dm* | +| 3 | Accept-Language | 415 | [13], [21] | m* | dm* | +| 4 | Accept-Resource-Priority | 200
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405
others | [13], [21] | m
o | dm
do | +| 6 | Allow-Events | 489 | [20] | m | dm | +| 7 | Authentication-Info | 2xx | [13], [21] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
others | [13], [21] | m | dm | +| 9 | Call-Info | r | [13], [21] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Contact | 3xx
485 | [13], [21] | o | do | +| 12 | Content-Disposition | r | [13], [21] | o | do | +| 13 | Content-Encoding | r | [13], [21] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13], [21] | o | do | +| 16 | Content-Length | 100
others | [13], [21] | t | dt | +| 17 | Content-Type | r | [13], [21] | * | d* | +| 18 | CSeq | 100
others | [13], [21] | m | dm | +| 19 | Date | 100
others | [13], [21] | o | do | +| 20 | Error-Info | 3xx-6xx | [13], [21] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 21 | Expires | 2xx
others | [13], [21] | m
o | dm
do | +| 22 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 AND response to request outside an existing dialog THEN do | +| 23 | From | 100
others | [13], [21] | m | dm | +| 24 | Geolocation-Error | 424
others | [68] | m
o | dm
do | +| 25 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 26 | MIME-version | r | [13], [21] | o | do | +| 27 | Min-Expires | 423 | [13], [21] | m | dm | +| 28 | Organization | r | [13], [21] | o | do | +| 29 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 30 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 31 | P-Charging-Function-Addresses | r | [24], [24A], [24B] | o | dn/a | +| 32 | P-Charging-Vector | 100 | [24], | o | dn/a | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------|------------|-----------------------------------------------------------------------------------------|--| +| | | 18x, 2xx | [24A] | o | IF table 6.1.3.1/38 AND response to request outside an existing dialog THEN dm (NOTE 2) | | +| | | 3xx-6xx | | o | do (NOTE 2) | | +| 33 | P-Preferred-Identity | r | [44] | o | dn/a | | +| 34 | Privacy | r | [34] | o | IF dc2 (TIP/TIR: clause 12.4) THEN dm ELSE do | | +| 35 | Proxy-Authenticate | 401 (NOTE 1) | [13], [21] | o | do | | +| | | 407 (NOTE 1) | | m | dm | | +| 36 | Relayed-Charge | r | [5] | n/a | dn/a | | +| 37 | Require | r | [13], [21] | o | do | | +| 38 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | | +| 39 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | | +| 40 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [21] | o | do | | +| 41 | Security-Server | 421
494 | [47] | o | dn/a | | +| 42 | Server | r | [13], [21] | o | do | | +| 43 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 2) | | +| 44 | SIP-Etag | 2xx | [21] | m | dm | | +| 45 | Supported | 2xx | [13], [21] | o | do | | +| 46 | Timestamp | r | [13], [21] | o | do | | +| 47 | To | 100
others | [13], [21] | m | dm | | +| 48 | Unsupported | 420 | [13], [21] | o | do | | +| 49 | User-Agent | r | [13], [21] | o | do | | +| 50 | Via | 100
others | [13], [21] | m | dm | | +| 51 | Warning | r | [13], [21] | o | do | | +| 52 | WWW-Authenticate | 401 (NOTE 1) | [13], [21] | m | dm | | +| | | 407 (NOTE 1) | | o | do | | +| dc1: | (TIP/TIR AND 2xx response to request outside an existing dialog AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to request outside an existing dialog AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | | +| dc2: | (TIP/TIR AND non-100 response to request outside an existing dialog AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to request outside an existing dialog AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | | +| NOTE 2: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | + +--- + +## B.13 REFER method + +As described in table 6.1, the support of REFER method over the II-NNI is based on bilateral agreement between the operators. + +The table B.13.1 lists the supported header fields within the REFER request. + +**Table B.13.1: Supported header fields within the REFER request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13], [22] | o | do | +| 2 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 3 | Accept-Encoding | [13], [22] | o | do | +| 4 | Accept-Language | [13], [22] | o | do | +| 5 | Additional-Identity | [5] | n/a | IF table 6.1.3.1/126 THEN do (NOTE) | +| 6 | Allow | [13], [22] | o | do | +| 7 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 8 | Authorization | [13], [22] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 9 | Call-ID | [13], [22] | m | dm | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13], [22] | m | dm | +| 12 | Content-Disposition | [13], [22] | o | do | +| 13 | Content-Encoding | [13], [22] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13], [22] | o | do | +| 16 | Content-Length | [13], [22] | o | do | +| 17 | Content-Type | [13], [22] | * | d* | +| 18 | CSeq | [13], [22] | m | dm | +| 19 | Date | [13], [22] | o | do | +| 20 | Expires | [13], [22] | o | do | +| 21 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 AND request outside an existing dialog THEN do (NOTE) | +| 22 | From | [13], [22] | m | dm | +| 23 | Geolocation | [68] | o | do | +| 24 | Geolocation-Routing | [68] | o | do | +| 25 | History-Info | [25] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 26 | Max-Breadth | [79] | o | do | +| 27 | Max-Forwards | [13], [22] | m | dm | +| 28 | MIME-Version | [13], [22] | o | do | +| 29 | Organization | [13], [22] | o | do | +| 30 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 31 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 AND request outside an existing dialog THEN dm (NOTE) | +| 32 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 33 | P-Called-Party-ID | [24], [24A] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 34 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 35 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND request outside an existing dialog THEN dm (NOTE) | +| 36 | P-Preferred-Identity | [44] | o | dn/a | +| 37 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 38 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND request outside an existing dialog THEN do (NOTE) | +| 39 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND request outside an existing dialog THEN do (NOTE) | +| 40 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND request outside an existing dialog being sent from "privileged sender" THEN dm (NOTE) | +| 41 | P-User-Database | [60] | o | dn/a | +| 42 | P-Visited-Network-ID | [24] | o | dn/a | +| 43 | Privacy | [34] | o | IF dc2 (OIP/OIR: clause 12.3) OR dc3 (ECT: clause 12.13) THEN dm ELSE do | +| 44 | Proxy-Authorization | [13], [22] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 45 | Proxy-Require | [13], [22] | o | do | +| 46 | Reason | [48] | o | IF table 6.1.3.1/40 AND request inside an existing dialog THEN do (NOTE) | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------------|--------------------------------------------| +| 47 | Record-Route | [13], [22] | o | do | +| 48 | Refer-Sub | [135] | o | do | +| 49 | Refer-To | [22] | dm | dm | +| 50 | Referred-By | [53] | o | IF dc4 (ECT: clause 12.13) THEN dm ELSE do | +| 51 | Reject-Contact | [51] | o | do | +| 52 | Relayed-Charge | [5] | n/a | dn/a | +| 53 | Request-Disposition | [51] | o | do | +| 54 | Require | [13], [22] | c | dc | +| 55 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 56 | Route | [13], [22] | c | dc | +| 57 | Security-Client | [47] | o | dn/a | +| 58 | Security-Verify | [47] | o | dn/a | +| 59 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 60 | Supported | [13], [22] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 61 | Target-Dialog | [140] | o | IF table 6.1.3.1/102 THEN do (NOTE) | +| 62 | Timestamp | [13], [22] | o | do | +| 63 | To | [13], [22] | m | dm | +| 64 | Trigger-Consent | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE) | +| 65 | User-Agent | [13], [22] | o | do | +| 66 | Via | [13], [22] | m | dm | +| dc1: | request outside an existing dialog invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | (request outside an existing dialog invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (request outside an existing dialog invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| dc3: | request inside an existing dialog invoked due to ECT including Referred-By header field with privacy requested in the "original communication" | | | | +| dc4: | request inside an existing dialog invoked due to ECT AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.13.2 lists the supported header fields within the REFER response. + +**Table B.13.2: Supported header fields within the REFER response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|----------------------------|--------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [22] | c | dc | +| 2 | Accept-Encoding | 415 | [13], [22] | c | dc | +| 3 | Accept-Language | 415 | [13], [22] | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405
others | [13], [22] | m
o | dm
do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13], [22] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
others | [13], [22] | m | dm | +| 9 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 10 | Contact | 2xx
3xx-6xx | [13], [22] | m
o | dm
do | +| 11 | Content-Disposition | r | [13], [22] | o | do | +| 12 | Content-Encoding | r | [13], [22] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13], [22] | o | do | +| 15 | Content-Length | 100
others | [13], [22] | t | dt | +| 16 | Content-Type | r | [13], [22] | * | d* | +| 17 | CSeq | 100
others | [13], [22] | m | dm | +| 18 | Date | 100
others | [13], [22] | o | do | +| 19 | Error-Info | 3xx-6xx | [13], [22] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 21 | From | 100
others | [13], [22] | m | dm | +| 22 | Geolocation-Error | 424
others | [68] | m
o | dm
do | +| 23 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 24 | MIME-version | r | [13], [22] | o | do | +| 25 | Organization | r | [13], [22] | o | do | +| 26 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 27 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 28 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 29 | P-Charging-Vector | 100
18x, 2xx
3xx-6xx | [24], [24A] | o
o
o | dn/a
IF dc2 (CONF: clause 12.19) OR (table 6.1.3.1/38 AND response to request outside an existing dialog) THEN dm (NOTE 2)
do (NOTE 2) | +| 30 | P-Preferred-Identity | r | [44] | o | dn/a | +| 31 | Permission-Missing | 470 | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 2) | +| 32 | Privacy | r | [34] | o | IF dc3 (TIP/TIR: clause 12.4) THEN dm ELSE do | +| 33 | Proxy-Authenticate | 401 (NOTE 1) | [13], [22] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------|------------|--------------------------------------------------------------------------------------|--| +| | | 407
(NOTE 1) | | m | dm | | +| 34 | Record-Route | 2xx | [13], [22] | o | do | | +| 35 | Refer-Sub | 2xx | [135] | o | IF table 6.1.3.1/98 THEN do
(NOTE 2) | | +| 36 | Relayed-Charge | r | [5] | n/a | dn/a | | +| 37 | Require | r | [13], [22] | c | dc | | +| 38 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do
(NOTE 2) | | +| 39 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | | +| 40 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [22] | o | do | | +| 41 | Security-Server | 421
494 | [47] | o | dn/a | | +| 42 | Server | r | [13], [22] | o | do | | +| 43 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | | +| 44 | Supported | 2xx | [13], [22] | o | do | | +| 45 | Timestamp | r | [13], [22] | o | do | | +| 46 | To | 100
others | [13], [22] | m | dm | | +| 47 | Unsupported | 420 | [13], [22] | o | do | | +| 48 | User-Agent | r | [13], [22] | o | do | | +| 49 | Via | 100
others | [13], [22] | m | dm | | +| 50 | Warning | r | [13], [22] | o | do | | +| 51 | WWW-Authenticate | 401
(NOTE 1) | [13], [22] | m | dm | | +| | | 407
(NOTE 1) | | o | do | | +| dc1: | (TIP/TIR AND 2xx response to request outside an existing dialog AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to request outside an existing dialog AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | | +| dc2: | first response from "conference focus" to request outside an existing dialog AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI) | | | | | | +| dc3: | (TIP/TIR AND non-100 response to request outside an existing dialog AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to request outside an existing dialog AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | | +| NOTE 2: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | + +--- + +## B.14 REGISTER method + +As described in table 6.1, the REGISTER method is supported only over the roaming II-NNI. + +The table B.14.1 lists the supported header fields within the REGISTER request. + +**Table B.14.1: Supported header fields within the REGISTER request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-----------------------------------------------------------------------------------| +| 1 | Accept | [13] | o | do | +| 2 | Accept-Encoding | [13] | o | do | +| 3 | Accept-Language | [13] | o | do | +| 4 | Allow | [13] | o | do | +| 5 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 6 | Authorization | [13] | o | IF using IMS AKA OR using SIP digest THEN dm ELSE do | +| 7 | Call-ID | [13] | m | dm | +| 8 | Call-Info | [13] | o | do | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Contact | [13] | o | dm | +| 11 | Content-Disposition | [13] | o | do | +| 12 | Content-Encoding | [13] | o | do | +| 13 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | [13] | o | do | +| 15 | Content-Length | [13] | t | dt | +| 16 | Content-Type | [13] | * | d* | +| 17 | CSeq | [13] | m | dm | +| 18 | Date | [13] | o | do | +| 19 | Expires | [13] | o | do | +| 20 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 21 | From | [13] | m | dm | +| 22 | Geolocation | [68] | o | do | +| 23 | Geolocation-Routing | [68] | o | do | +| 24 | History-Info | [25] | o | IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 25 | Max-Breadth | [79] | o | do | +| 26 | Max-Forwards | [13] | m | dm | +| 27 | MIME-Version | [13] | o | do | +| 28 | Organization | [13] | o | do | +| 29 | P-Access-Network-Info | [24] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Charging-Function-Addresses | [24], [24B] | o | dn/a | +| 31 | P-Charging-Vector | [24] | o | dm | +| 32 | P-User-Database | [60] | o | dn/a | +| 33 | P-Visited-Network-ID | [24] | o | dm | +| 34 | Path | [43] | o | dm | +| 35 | Privacy | [34] | o | dn/a | +| 36 | Proxy-Authorization | [13] | o | do | +| 37 | Proxy-Require | [13] | o | do | +| 38 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 39 | Recv-Info | [39] | o | IF table 6.1.3.1/17 THEN do (NOTE) | +| 40 | Referred-By | [53] | o | do | +| 41 | Relayed-Charge | [5] | n/a | dn/a | +| 42 | Request-Disposition | [51] | o | do | +| 43 | Require | [13] | c | dm | +| 44 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 45 | Resource-Share | [5] | n/a | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/116 THEN do (NOTE) | +| 46 | Route | [13] | c | dn/a | +| 47 | Security-Client | [47] | o | dn/a | +| 48 | Security-Verify | [47] | o | dn/a | +| 49 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 50 | Supported | [13] | o | dm | +| 51 | Timestamp | [13] | o | do | +| 52 | To | [13] | m | dm | +| 53 | User-Agent | [13] | o | do | +| 54 | Via | [13] | m | dm | + +NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +The table B.14.2 lists the supported header fields within the REGISTER response. + +**Table B.14.2: Supported header fields within the REGISTER response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------|--------------------|------------|---------------------------------------------------------------------------------------| +| 1 | Accept | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 2 | Accept-Encoding | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 5 | Allow | 405 | [13] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 7 | Authentication-Info | 2xx | [13] | o | do | +| 8 | Call-ID | 100 | [13] | m | dm | +| | | others | | o | do | +| 9 | Call-Info | r | [13] | o | do | +| 10 | Contact | 2xx | [13] | o | dm | +| | | 3xx | | o | do | +| | | 485 | | o | do | +| 11 | Content-Disposition | r | [13] | o | do | +| 12 | Content-Encoding | r | [13] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13] | o | do | +| 15 | Content-Length | 100 | [13] | t | dt | +| | | others | | o | do | +| 16 | Content-Type | r | [13] | * | d* | +| 17 | CSeq | 100 | [13] | m | dm | +| | | others | | o | do | +| 18 | Date | 100 | [13] | o | do | +| | | others | | o | do | +| 19 | Error-Info | 3xx-6xx | [13] | o | IF table 6.1.3.1/13 THEN do (NOTE) | +| 20 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 21 | Flow-Timer | 2xx | [65] | o | do | +| 22 | From | 100 | [13] | m | dm | +| | | others | | o | do | +| 23 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 24 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE) | +| 25 | MIME-version | r | [13] | o | do | +| 26 | Min-Expires | 423 | [13] | m | dm | +| 27 | Organization | r | [13] | o | do | +| 28 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 29 | P-Associated-URI | 2xx | [24] | o | dm | +| 30 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 31 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | 18x, 2xx | | o | dm | +| | | 3xx-6xx | | o | do | +| 32 | Path | 2xx | [43] | o | dm | +| 33 | Privacy | r | [34] | o | do | +| 34 | Proxy-Authenticate | 401 | [13] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|-------|------------|-------------------------------------| +| | | 407 | | m | dm | +| 35 | Relayed-Charge | r | [5] | n/a | dn/a | +| 36 | Require | r | [13] | c | dc | +| 37 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE) | +| 38 | Retry-After | 404
413
480
486
500
503
600
603 | [13] | o | do | +| 39 | Security-Server | 2xx
401 | [47] | n/a | dn/a | +| | | 421
494 | | o | dn/a | +| 40 | Server | r | [13] | o | do | +| 41 | Service-Route | 2xx | [45] | o | dm | +| 42 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 43 | Supported | 2xx | [13] | o | do | +| 44 | Timestamp | r | [13] | o | do | +| 45 | To | 100
others | [13] | m | dm | +| 46 | Unsupported | 420 | [13] | m | dm | +| 47 | User-Agent | r | [13] | o | do | +| 48 | Via | 100
others | [13] | m | dm | +| 49 | Warning | r | [13] | o | do | +| 50 | WWW-Authenticate | 401 | [13] | m | dm | +| | | 407 | | o | do | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | + +--- + +## B.15 SUBSCRIBE method + +As described in table 6.1, the support of SUBSCRIBE method over the non-roaming II-NNI is based on bilateral agreement between the operators. + +The table B.15.1 lists the supported header fields within the SUBSCRIBE request. + +**Table B.15.1: Supported header fields within the SUBSCRIBE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13], [20] | o | do | +| 2 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 3 | Accept-Encoding | [13], [20] | o | do | +| 4 | Accept-Language | [13], [20] | o | do | +| 5 | Allow | [13], [20] | o | do | +| 6 | Allow-Events | [20] | o | do | +| 7 | Authorization | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13], [20] | m | dm | +| 9 | Call-Info | [13], [20] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) THEN dm ELSE dn/a | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13], [20] | m | dm | +| 12 | Content-Disposition | [13], [20] | o | do | +| 13 | Content-Encoding | [13], [20] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13], [20] | o | do | +| 16 | Content-Length | [13], [20] | t | dt | +| 17 | Content-Type | [13], [20] | * | d* | +| 18 | CSeq | [13], [20] | m | dm | +| 19 | Date | [13], [20] | o | do | +| 20 | Event | [20] | m | dm | +| 21 | Expires | [13], [20] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) OR using reg event package THEN dm ELSE do | +| 22 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 23 | From | [13], [20] | m | dm | +| 24 | Geolocation | [68] | o | do | +| 25 | Geolocation-Routing | [68] | o | do | +| 26 | History-Info | [25] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND initial request THEN do (NOTE) | +| 27 | Max-Breadth | [79] | o | dn/a | +| 28 | Max-Forwards | [13], [20] | m | dm | +| 29 | MIME-Version | [13], [20] | o | do | +| 30 | Organization | [13], [20] | o | do | +| 31 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 32 | P-Asserted-Identity | [44] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) OR table 6.1.3.1/27 AND initial request THEN dm (NOTE) | +| 33 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND initial request THEN do (NOTE) | +| 34 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 35 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 36 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND initial request THEN dm (NOTE) | +| 37 | P-Preferred-Identity | [44] | o | dn/a | +| 38 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND initial request THEN do (NOTE) | +| 39 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND initial request THEN do (NOTE) | +| 40 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND initial request THEN do (NOTE) | +| 41 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND initial request being sent from "privileged sender" THEN dm (NOTE) | +| 42 | P-User-Database | [60] | o | dn/a | +| 43 | P-Visited-Network-ID | [24] | o | dn/a | +| 44 | Priority | [13], [20] | o | do | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------------|-----------------------------------------------------------| +| 45 | Privacy | [34] | o | IF dc3 (OIP/OIR: clause 12.3) THEN dm ELSE do | +| 46 | Proxy-Authorization | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 47 | Proxy-Require | [13], [20] | o | do | +| 48 | Reason | [48] | o | IF table 6.1.3.1/40 AND subsequent request THEN do (NOTE) | +| 49 | Record-Route | [13], [20] | o | do | +| 50 | Referred-By | [53] | o | do | +| 51 | Reject-Contact | [51] | o | do | +| 52 | Relayed-Charge | [5] | n/a | dn/a | +| 53 | Request-Disposition | [51] | o | do | +| 54 | Require | [13], [20] | o | do | +| 55 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 56 | Route | [13], [20] | c | dc | +| 57 | Security-Client | [47] | o | dn/a | +| 58 | Security-Verify | [47] | o | dn/a | +| 59 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 60 | Supported | [13], [20] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 61 | Target-Dialog | [140] | o | IF table 6.1.3.1/102 THEN do (NOTE) | +| 62 | Timestamp | [13], [20] | o | do | +| 63 | To | [13], [20] | m | dm | +| 64 | Trigger-Consent | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE) | +| 65 | User-Agent | [13], [20] | o | do | +| 66 | Via | [13], [20] | m | dm | +| dc1: | initial request invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | ("CC invocation request" due to CCBS/CCNR/CCNL AND non-roaming II-NNI) OR ("CC revocation request" due to CCBS/CCNR/CCNL AND non-roaming II-NNI) | | | | +| dc3: | (initial request invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (initial request invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.15.2 lists the supported header fields within the SUBSCRIBE response. + +**Table B.15.2: Supported header fields within the SUBSCRIBE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|----------------------------|--------------------|-------------|-----------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [20] | o | do | +| 2 | Accept-Encoding | 415 | [13], [20] | o | do | +| 3 | Accept-Language | 415 | [13], [20] | o | do | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405
others | [13], [20] | m
o | dm
do | +| 6 | Allow-Events | 2xx
489 | [20] | o
m | do
dm | +| 7 | Authentication-Info | 2xx | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
r | [13], [20] | m | dm | +| 9 | Call-Info | r | [13], [20] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Contact | 2xx
3xx
485 | [13], [20] | m
o | dm
do | +| 12 | Content-Disposition | r | [13], [20] | o | do | +| 13 | Content-Encoding | r | [13], [20] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13], [20] | o | do | +| 16 | Content-Length | 100
others | [13], [20] | t | dt | +| 17 | Content-Type | r | [13], [20] | * | d* | +| 18 | CSeq | 100
others | [13], [20] | m | dm | +| 19 | Date | 100
others | [13], [20] | o | do | +| 20 | Error-Info | 3xx-6xx | [13], [20] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 21 | Expires | 2xx | [13], [20] | m | dm | +| 22 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE 2) | +| 23 | From | 100
others | [13], [20] | m | dm | +| 24 | Geolocation-Error | 424
others | [68] | m
o | dm
do | +| 25 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to initial request THEN do (NOTE 2) | +| 26 | MIME-version | r | [13], [20] | o | do | +| 27 | Min-Expires | 423 | [13], [20] | m | dm | +| 28 | Organization | r | [13], [20] | o | do | +| 29 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 30 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to initial request THEN do (NOTE 2) | +| 31 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 32 | P-Charging-Vector | 100
18x, 2xx
3xx-6xx | [24], [24A] | o
o
o | dn/a
IF table 6.1.3.1/38 AND response to initial request THEN dm (NOTE 2)
do | +| 33 | P-Preferred-Identity | r | [44] | o | dn/a | +| 34 | Permission-Missing | 470 | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 2) | +| 35 | Privacy | r | [34] | o | IF dc2 (TIP/TIR: clause 12.4) THEN dm ELSE do | +| 36 | Proxy-Authenticate | 401 (NOTE 1)
407 | [13], [20] | o
m | do
dm | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------|------------|--------------------------------------------------------------------------------------|--|--|--|--|--|--| +| | | (NOTE 1) | | | | | | | | | | +| 37 | Record-Route | 2xx | [13], [20] | o | do | | | | | | | +| 38 | Relayed-Charge | r | [5] | n/a | dn/a | | | | | | | +| 39 | Require | r | [13], [20] | o | do | | | | | | | +| 40 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | | | | | | | +| 41 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | | | | | | | +| 42 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [20] | o | do | | | | | | | +| 43 | Security-Server | 421
494 | [47] | o | dn/a | | | | | | | +| 44 | Server | r | [13], [20] | o | do | | | | | | | +| 45 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 2) | | | | | | | +| 46 | Supported | 2xx | [13], [20] | o | do | | | | | | | +| 47 | Timestamp | r | [13], [20] | o | do | | | | | | | +| 48 | To | 100
others | [13], [20] | m | dm | | | | | | | +| 49 | Unsupported | 420 | [13], [20] | o | do | | | | | | | +| 50 | User-Agent | r | [13], [20] | o | do | | | | | | | +| 51 | Via | 100
others | [13], [20] | m | dm | | | | | | | +| 52 | Warning | r | [13], [20] | o | do | | | | | | | +| 53 | WWW-Authenticate | 401
(NOTE 1) | [13], [20] | m | dm | | | | | | | +| | | 407
(NOTE 1) | | o | do | | | | | | | +| dc1: | (TIP/TIR AND 2xx response to initial request AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to initial request AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | | | | | | | +| dc2: | (TIP/TIR AND non-100 response to initial request AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to initial request AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | | | | | | | +| NOTE 1: The SIP status code is only applicable over the roaming II-NNI. | | | | | | | | | | | | +| NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | | | | | | | + +--- + +## B.16 UPDATE method + +The table B.16.1 lists the supported header fields within the UPDATE request. + +**Table B.16.1: Supported header fields within the UPDATE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|----------------------------------------------------------------------------------------------------------|-------------|------------|----------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13], [23] | o | do | +| 2 | Accept-Contact | [51] | o | do | +| 3 | Accept-Encoding | [13], [23] | o | do | +| 4 | Accept-Language | [13], [23] | o | do | +| 5 | Allow | [13], [23] | o | do | +| 6 | Allow-Events | [20] | n/a | dn/a | +| 7 | Authorization | [13], [23] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13], [23] | m | dm | +| 9 | Call-Info | [13], [23] | o | do | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13], [23] | m | dm | +| 12 | Content-Disposition | [13], [23] | o | do | +| 13 | Content-Encoding | [13], [23] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13], [23] | o | do | +| 16 | Content-Length | [13], [23] | t | dt | +| 17 | Content-Type | [13], [23] | * | d* | +| 18 | CSeq | [13], [23] | m | dm | +| 19 | Date | [13], [23] | o | do | +| 20 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 21 | From | [13], [23] | m | dm | +| 22 | Geolocation | [68] | o | do | +| 23 | Geolocation-Routing | [68] | o | do | +| 24 | Max-Breadth | [79] | o | dn/a | +| 25 | Max-Forwards | [13], [23] | m | dm | +| 26 | MIME-Version | [13], [23] | o | do | +| 27 | Min-SE | [52] | o | do | +| 28 | Organization | [13], [23] | o | do | +| 29 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 31 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 32 | P-Early-Media | [74] | o | IF dc1 (CAT: clause 12.14) OR dc2 (announcements: clause 12.21) THEN dm ELSE IF table 6.1.3.1/69 THEN do (NOTE) | +| 33 | Priority-Share | [5] | n/a | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE) | +| 34 | Privacy | [34] | o | do | +| 35 | Proxy-Authorization | [13], [23] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 36 | Proxy-Require | [13], [23] | o | do | +| 37 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 38 | Record-Route | [13], [23] | o | do | +| 39 | Recv-Info | [39] | o | IF table 6.1.3.1/17 THEN do (NOTE) | +| 40 | Referred-By | [53] | o | do | +| 41 | Reject-Contact | [51] | o | do | +| 42 | Relayed-Charge | [5] | n/a | dn/a | +| 43 | Request-Disposition | [51] | o | do | +| 44 | Require | [13], [23] | c | dc | +| 45 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 46 | Resource-Share | [5] | n/a | IF (home-to-visited request on roaming II-NNI OR visited-to-home request on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE) | +| 47 | Route | [13], [23] | c | dc | +| 48 | Security-Client | [47] | o | dn/a | +| 49 | Security-Verify | [47] | o | dn/a | +| 50 | Session-Expires | [52] | o | do | +| 51 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 52 | Supported | [13], [23] | o | do | +| 53 | Timestamp | [13], [23] | o | do | +| 54 | To | [13], [23] | m | dm | +| 55 | User-Agent | [13], [23] | o | do | +| 56 | Via | [13], [23] | m | dm | +| dc1: | request invoked due to stopping or restarting CAT early media on an existing dialog AND (non-roaming II- | | | | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|------------|------------------| +| dc2: | NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI)
request invoked due to stopping or restarting announcement early media AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.16.2 lists the supported header fields within the UPDATE response. + +**Table B.16.2: Supported header fields within the UPDATE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------|--------------------|------------|--------------------------------------------------------------------------------------------| +| 1 | Accept | 2xx | [13], [23] | o | do | +| | | 415 | | c | dc | +| 2 | Accept-Encoding | 2xx | [13], [23] | o | do | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx | [13], [23] | o | do | +| | | 415 | | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do
(NOTE 2) | +| 5 | Allow | 405 | [13], [23] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | n/a | dn/a | +| 7 | Authentication-Info | 2xx | [13], [23] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13], [23] | m | dm | +| | | others | | | | +| 9 | Call-Info | r | [13], [23] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do
(NOTE 2) | +| 11 | Contact | 2xx | [13], [23] | m | dm | +| | | 3xx
485 | | o | do | +| | | others | | o | do | +| 12 | Content-Disposition | r | [13], [23] | o | do | +| 13 | Content-Encoding | r | [13], [23] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13], [23] | o | do | +| 16 | Content-Length | 100 | [13], [23] | t | dt | +| | | others | | | | +| 17 | Content-Type | r | [13], [23] | * | d* | +| 18 | CSeq | 100 | [13], [23] | m | dm | +| | | others | | | | +| 19 | Date | 100 | [13], [23] | o | do | +| | | others | | | | +| 20 | Error-Info | 3xx-6xx | [13], [23] | o | IF table 6.1.3.1/13 THEN do
(NOTE 2) | +| 21 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 THEN do
(NOTE 2) | +| 22 | From | 100 | [13], [23] | m | dm | +| | | others | | | | +| 23 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 24 | MIME-version | r | [13], [23] | o | do | +| 25 | Min-SE | 422 | [52] | m | dm | +| 26 | Organization | r | [13], [23] | o | do | +| 27 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do
(NOTE 2) | +| 28 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 29 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | others | | o | IF table 6.1.3.1/38 THEN do
(NOTE 2) | +| 30 | P-Early-Media | 2xx | [74] | o | IF table 6.1.3.1/69 THEN do
(NOTE 2) | +| 31 | Priority-Share | 2xx | [5] | n/a | IF home-to-visited response on
roaming II-NNI AND table 6.1.3.1/118
THEN do (NOTE 2) | +| 32 | Privacy | r | [34] | o | do | +| 33 | Proxy-Authenticate | 401
(NOTE 1) | [13], [23] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|------------------|------------------------------------------------------|------------|------------|--------------------------------------------------------------------------------------------------------------------------------------| +| | | 407
(NOTE 1) | | m | dm | +| 34 | Record-Route | 2xx | [13], [23] | o | do | +| 35 | Recv-Info | 2xx | [39] | c | IF table 6.1.3.1/17 THEN dc
(NOTE 2) | +| | | others | | o | IF table 6.1.3.1/116 THEN do
(NOTE 2) | +| 36 | Relayed-Charge | r | [5] | n/a | dn/a | +| 37 | Require | r | [13], [23] | c | dc | +| 38 | Resource-Share | 2xx | [5] | n/a | IF (home-to-visited response on roaming II-NNI OR visited-to-home response on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE 2) | +| 39 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do
(NOTE 2) | +| 40 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [23] | o | do | +| 41 | Security-Server | 421
494 | [47] | o | dn/a | +| 42 | Server | r | [13], [23] | o | do | +| 43 | Session-Expires | 2xx | [52] | o | do | +| 44 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | +| 45 | Supported | 2xx | [13], [23] | o | do | +| 46 | Timestamp | r | [13], [23] | o | do | +| 47 | To | 100 | [13], [23] | m | dm | +| | | others | | | | +| 48 | Unsupported | 420 | [13], [23] | m | dm | +| 49 | User-Agent | r | [13], [23] | o | do | +| 50 | Via | 100 | [13], [23] | m | dm | +| | | others | | | | +| 51 | Warning | r | [13], [23] | o | do | +| 52 | WWW-Authenticate | 401
(NOTE 1) | [13], [23] | m | dm | +| | | 407
(NOTE 1) | | o | do | + +NOTE 1: The SIP status code is only applicable over the roaming II-NNI. + +NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +--- + +## Annex C (informative): The list of option items for II-NNI + +### C.1 Scope + +This annex provides a list of items that are recommended to be selected by inter-operator agreements for the interconnection between IMS operators using the II-NNI. The items in this annex have an influence on the service interconnection. + +For the purposes of this annex, these items are called "option items". The option items are extracted from the present document other than this annex, and are categorized from the aspect of service provisioning by IMS operators. + +If an option item is used based on inter-operator agreements, then relating capabilities described in the references are used over the II-NNI. In case of misalignment between the normative part of the present document and this annex, the normative part of the present document takes precedence. + +--- + +### C.2 Format of option item table + +The format of option item table used in the subsequent clauses is as follows: + +- The 2nd column "Option item" shows the option item. +- The 3rd column "References" shows the relevant clauses of the present document for each option item. +- The 4th column "Applicability at the II-NNI" shows the selectable patterns for each option item. +- The 5th column "Details for operator choice" shows the details for the inter-operator agreements in case the corresponding pattern is chosen. This column intends to be used to exchange each detailed conditions of the II-NNI by means of filling the conditions in the columns corresponding to the selected pattern. Blank row intends to be used as a place holder for describing additional detailed II-NNI conditions specific to the operator network not associated with the explicit descriptions in this annex. + +--- + +### C.3 Option item table + +#### C.3.0 Supported II-NNI traversal scenarios + +In this clause the table C.3.0.1 shows the supported II-NNI traversal scenarios option items. + +**Table C.3.0.1: Supported II-NNI traversal scenarios** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------|------------------------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Roaming II-NNI support | entire present specification | Yes | Option items in clauses C.3.1 and C.3.2. | +| | | | | Applicability of "Roaming Architecture for Voice over IMS with Local Breakout" (Clause 19). | +| | | | | If "Roaming Architecture for Voice over IMS with Local Breakout" is applicable:
+ option items in clause C.3.3;
and
+ the default TRF address to use when not included in the "g.3gpp.trf" feature-capability indicator. | +| | | | No | | +| 2 | Non-roaming II-NNI support | entire present specification | Yes | Option items in clauses C.3.1 and C.3.3. | +| | | | | | +| | | | No | | + +### C.3.1 Option item table common to roaming, non-roaming II-NNI and loopback traversal scenario + +This clause describes the option item tables common to the roaming II-NNI, the loopback traversal scenario, and the non-roaming II-NNI as follows: + +- Table C.3.1.1 shows the SIP methods option items. +- Table C.3.1.1A shows the SIP overload control option items. +- Table C.3.1.2 shows the SIP negotiation of resource reservation option item. +- Table C.3.1.2A shows the periodic refresh of SIP sessions option item. +- Table C.3.1.3 shows the replacing of SIP dialogs option item. +- Table C.3.1.4 shows the session participation option item. +- Table C.3.1.5 shows the conveying capabilities of UE option item. +- Table C.3.1.5A shows the authorization of early media option item. +- Table C.3.1.6 shows the asserting the service of authenticated users option item. +- Table C.3.1.7 shows the mode of signalling. +- Table C.3.1.7A shows the SIP message bodies option item. +- Table C.3.1.7B shows the SIP message body size option item. +- Table C.3.1.8 shows the control plane transport option item. +- Table C.3.1.9 shows the user plane transport, media, and codec option items. +- Table C.3.1.10 shows the dual tone multi frequency (DTMF) option item. +- Table C.3.1.10A shows the numbering, naming and addressing option item. +- Table C.3.1.11 shows the IP version option item. + +- Table C.3.1.12 shows the supplementary services option items. +- Table C.3.1.13 shows the additional functions option items. +- Table C.3.1.14 shows the SDP lines option items. +- Table C.3.1.15 shows the emergency services option items. +- Table C.3.1.16 shows indicating the II-NNI traversal scenario option items. +- Table C.3.1.17 shows the Mission critical services option items. +- Table C.3.1.18 shows the Calling number verification using signature verification and attestation information option items. +- Table C.3.1.19 shows the Signed attestation for emergency and priority IMS sessions option items. + +**Table C.3.1.1: SIP method** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------|------------------------------|-----------------------------|--------------------------------------------------------------------| +| 1 | INFO method | table 6.1/5A
table 6.1/5B | Yes | Info package name to use. | +| | | | No | | +| 2 | MESSAGE method | table 6.1/9A
table 6.1/9B | Yes | Inside or outside existing dialog, and content of MESSAGE request. | +| | | | No | | +| 3 | REFER method | table 6.1/16
table 6.1/17 | Yes | Inside or outside existing dialog. | +| | | | No | | + +**Table C.3.1.1A: SIP overload control** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------|----------------------------------|-----------------------------|-----------------------------------------------------------------------------| +| 1 | SIP overload control | table 6.1.3.1/106
clause 21.1 | Yes | Mechanisms to be used.
Whether to exempt MPS from SIP overload controls. | +| | | | No | | +| 2 | Feedback control | table 6.1.3.1/107
clause 21.2 | Yes | Algorithm to be used if not default (see clause 21.2). | +| | | | No | | +| 3 | Event control | table 6.1.3.1/108
clause 21.3 | Yes | Addresses to targets that can be supervised. | +| | | | No | | + +**Table C.3.1.2: Negotiation of resource reservation** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Negotiation of resource reservation (precondition) | table 6.1.3.1/20 | Yes | | +| | | | No | | + +**Table C.3.1.2A: Periodic refresh of SIP sessions** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|---------------------------|------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------| +| 1 | SIP session timer (timer) | table 6.1.3.1/45 | Yes | Use conditions (Possible restriction on range of times and whether SIP session timer is applied in all sessions). | + +**Table C.3.1.3: Replacing of SIP dialogs** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Replacing of SIP dialogs (replaces) | table 6.1.3.1/47 | Yes | | +| | | | No | | + +**Table C.3.1.4: Session participation** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Session participation (join) | table 6.1.3.1/48 | Yes | | +| | | | No | | + +**Table C.3.1.5: Conveying capabilities of UE** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Conveying capabilities of UE | table 6.1.3.1/49 | Yes | | +| | | | No | | + +**Table C.3.1.5A: Authorization of early media** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------|------------------|-----------------------------|------------------------------------------------------------------------------------------------------| +| 1 | Authorization of early media | table 6.1.3.1/69 | Yes | Whether to use authorization request of early media generated by the entity outside the IMS network. | +| | | | No | | + +**Table C.3.1.6: Asserting the service of authenticated users** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------------------------------------------------|------------------|-----------------------------|-----------------------------------| +| 1 | Managing the indication of the asserted service (P-Asserted-Service header field) | table 6.1.3.1/77 | Yes | Service identifier values to use. | +| | | | No | | + +**Table C.3.1.7: Mode of signalling** + +| No. | Option item | | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------|------------------|----------------|-----------------------------|-----------------------------| +| 1 | Overlap signalling | In-dialog method | clause 6.1.1.5 | Yes | | +| | | | | No | | +| | | Multiple-INVITE | | Yes | | + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|------------|-----------------------------|-----------------------------| +| | method | | No | | + +**Table C.3.1.7A: SIP message bodies** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|--------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | MIME type | clause 6.1.4 | Yes | MIME types to use.
Applicable characteristics of the SIP message body MIMEs (i.e. the value(s) of Content-Disposition header field and Content-Language header field) if necessary. | + +**Table C.3.1.7B: SIP message body size** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------|--------------|-----------------------------|-----------------------------| +| 1 | Limitation on maximum length of a SIP message body | clause 6.1.4 | Yes | Maximum length accepted. | +| | | | No | | + +**Table C.3.1.8: Control plane transport** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| 1 | TCP | clause 6.2 | Yes | Use conditions (e.g. port number to accept, number of simultaneous connections in case of reuse of the existing connections). | +| | | | No | | +| 2 | UDP | clause 6.2 | Yes | Use conditions (e.g. port number to accept). | +| | | | No | | +| 3 | SCTP | clause 6.2 | Yes | Use conditions (e.g. port number to accept). | +| | | | No | | + +**Table C.3.1.9: User plane transport, media, and codec** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------------------------|------------------------------|-----------------------------|---------------------------------------------------------------------------------------------------------------| +| 1 | Speech media (m=audio) | clause 7.1 | Yes | Names of speech codecs to use.
(NOTE 1, NOTE 2) | +| | | | No | | +| 2 | Video media (m=video) | clause 7.1 | Yes | Names of video codecs to use.
(NOTE 1, NOTE 2) | +| | | | No | | +| 3 | Other media | clause 7.1 | Yes | Media type (m=line of SDP) to use
(e.g. application, image, message). | +| | | | No | | +| 4 | RTP/AVPF | clause 7.2 | Yes | Media type (m=line of SDP) that
uses the protocol. | +| | | | No | | +| 5 | Transmission Control Protocol | clause 6.1.2.1
clause 7.2 | Yes | Media type (m=line of SDP) that
uses the protocol. | +| | | | No | | +| 6 | Other user plane protocols | clause 7.2 | Yes | Protocols to use (e.g. udptl,
TCP/MSRP) and media types
(m=line of SDP) that describe the
protocols. | +| | | | No | | + +NOTE 1: Codecs which are included in the applicable codec list made by inter-operator agreements are guaranteed to be supported at the II-NNI by the peer operators. + +NOTE 2: Whether it is allowed to offer codecs which are not included in the applicable codec list made by inter-operator agreements over the II-NNI is also determined by the inter-operator agreement if necessary. + +**Table C.3.1.10: Dual tone multi frequency (DTMF)** + +| No. | Option item | | References | Applicability at the II-NNI | Details for operator choice | | +|-----|----------------|----------------------------------------|----------------------------------------------------------------------------|-----------------------------|-----------------------------|--| +| 1 | DTMF transport | "telephone-event" based DTMF transport | clause 7.1
table 6.1/5A
table 6.1/5B
clause 12.14
clause 12.15 | Yes | Sampling rate to use. | | +| | | The SIP INFO mechanism | | No | | | +| | | | | Yes | | | +| | | | | No | | | + +**Table C.3.1.10A: Numbering, naming and addressing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------|------------|-----------------------------|-----------------------------| +| 1 | Subaddress
("isub" tel URI parameter) | clause 8.1 | Yes | | +| | | | No | | + +**Table C.3.1.11: IP version** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|------------|-----------------------------|----------------------------------------------------------| +| 1 | IPv4 | clause 9 | Yes | Use conditions (e.g. for control plane, for user plane). | +| | | | No | | +| 2 | IPv6 | clause 9 | Yes | Use conditions (e.g. for control plane, for user plane). | +| | | | No | | + +**Table C.3.1.12: Supplementary services** + +| No. | Option item | | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------------------------------------------------|---------------------------------------------|----------------|-----------------------------|--------------------------------------------------------------------------| +| 1 | Malicious Communication Identification (MCID) | | clause 12.2 | Yes | Minimum information exchanged over the II-NNI. | +| | | | | No | | +| 2 | Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) | | clause 12.3 | Yes | | +| | | | | No | | +| 3 | Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) | | clause 12.4 | Yes | | +| | | | | No | | +| 4 | Anonymous Communication Rejection (ACR) | | clause 12.5 | Yes | | +| | | | | No | | +| 5 | Communication DIVersion (CDIV) | | clause 12.6 | Yes | | +| | | | | No | | +| 6 | Communication Waiting (CW) | | clause 12.7 | Yes | | +| | | | | No | | +| 7 | Communication HOLD (HOLD) | | clause 12.8 | Yes | | +| | | | | No | | +| 8 | Message Waiting Indication (MWI) | | clause 12.9 | Yes | | +| | | | | No | | +| 9 | Incoming Communication Barring (ICB) | | clause 12.10.1 | Yes | | +| | | | | No | | +| 10 | Completion of Communications to Busy Subscriber (CCBS) | | clause 12.11 | Yes | | +| | | | | No | | +| 11 | Completion of Communications by No Reply (CCNR) | | clause 12.12 | Yes | | +| | | | | No | | +| 12 | Explicit Communication Transfer (ECT) | | clause 12.13 | Yes | Type of explicit communication transfer to support. | +| | | | | No | | +| 13 | Customized Alerting Tone (CAT) | | clause 12.14 | Yes | CAT model to use (Gateway model, forking model and early session model). | +| | | | | | Media type (m=line of SDP) applicable to CAT. | +| | | | | No | | +| 14 | Customized Ringing Signal (CRS) | | clause 12.15 | Yes | | +| | | | | No | | +| 15 | Closed User Group (CUG) | | clause 12.16 | Yes | | +| | | | | No | | +| 16 | Personal Network Management (PNM) | | clause 12.17 | Yes | | +| | | | | No | | +| 17 | Three-Party (3PTY) | | clause 12.18 | Yes | | +| | | | | No | | +| 18 | Conference (CONF) | | clause 12.19 | Yes | | +| | | | | No | | +| 19 | Flexible Alerting (FA) | | clause 12.20 | Yes | | +| | | | | No | | +| 20 | Announcements | During the establishment of a session | clause 12.21.2 | Yes | Methods for sending announcement. | +| | | No | | | | +| | | During an established communication session | clause 12.21.3 | Yes | Methods for sending announcement. | +| | | No | | | | +| | | Providing announcements | clause 12.21.4 | Yes | Methods for sending announcement. | + +| No. | Option item | | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------|----------------------------------------|---------------------------------------------------------|-----------------------------|-----------------------------------------------------------------------------| +| | | when communication request is rejected | | No | | +| | | | | | | +| 21 | Advice Of Charge (AOC) | | clause 12.22 | Yes | | +| | | | | No | | +| 22 | Completion of Communications on Not Logged-in (CCNL) | | clause 12.23 | Yes | | +| | | | | No | | +| 23 | Presence service | | clause 15 | Yes | Presence services to use (TS 24.141 [132], OMA 1.1 [142] or OMA 2.0 [138]). | +| | | | | No | | +| 24 | Messaging service | Page-mode messaging | clause 16.2 | Yes | | +| | | | | No | | +| | | Session-mode messaging | clause 16.4 | Yes | | +| | | | | No | | +| | | Session-mode messaging conferences | clause 16.5 | Yes | | +| | | | | No | | +| 24A | Delivery of original destination identity | | clause 22 | Yes | Services to apply the function. | +| | | | | No | | +| 24B | Service access number translation | | table 6.1.3.1/52A
clause 27 | Yes | | +| | | | | No | | +| 25 | Other additional service using other SIP extensions | | clause 6.1.1.3.2
clause 12.6 | Yes | The SIP extensions to use and the service that uses the extensions. | +| | | | | No | | +| 26 | Multi-Identity (MiD) | | clause 6.1.1.3.1
table 6.1.3.1/126
clause 12.26.2 | Yes | Types of non-native identities to support. (NOTE) | +| | | | | No | | + +NOTE: The non-native identities, as defined in 3GPP TS 24.174 [218] are: + an alternative identity, an external alternative identity and a virtual identity. + +**Table C.3.1.13: Additional functions** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------|-------------------|-----------------------------|-------------------------------------------------------------------------------------------------| +| 1 | Optimal Media Routeing | clause 17 | Yes | | +| | | | No | | +| 2 | Applying forking (NOTE 1) | table 6.1.3.1/5 | Yes | Usage of Request-Disposition header field with value "no-fork". (NOTE 3) | +| | | | No (NOTE 2) | | +| 3 | Transfer of IP multimedia service tariff information | clause 11.3 | Yes | The value of the Content-Disposition header field. | +| | | | No | | +| 4 | Telepresence using IMS | clause 23 | Yes | The value of "+sip.clue" media feature tag in Contact header field. | +| | | | No | | +| 5 | Dynamic services interactions | table 6.1.3.1/125 | Yes | The identities of the services in the Service-Interact-Info header field. | +| | | | No | | +| 6 | MTSI Data channel | clause 33 | Yes | The value "webrtc-datachannel" of "+sip.app-subtype" media feature tag in Contact header field. | +| | | | No | | + +NOTE 1: Support of handling of several responses due to forking and of the Request-Disposition header field, is mandated on the II-NNI. + +NOTE 2: In case the operator interconnects with IMS non-compliant networks, and wishes to use the II-NNI anyway, then the operators might want to negotiate if the forking procedures are applicable. + +NOTE 3: The Request-Disposition header field with value "no-fork" can be used to suppress that forking occurs. However, a peer operator might require the usage of forking e.g. to implement certain services. + +**Table C.3.1.14: SDP lines** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|--------------|-----------------------------|----------------------------------------------------| +| 1 | m=line | clause 6.1.2 | Yes | Used static RTP payload type numbers. | +| | | | | | +| 2 | b=line | clause 6.1.2 | Yes | Used bandwidth modifier types. | +| | | | | | +| 3 | a=line | clause 6.1.2 | Yes | Used attributes. | +| | | | | For the "rtpmap" attribute, used "encoding names". | + +**Table C.3.1.15: Emergency services** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------------|-------------------|-----------------------------|-------------------------------| +| 1 | Public Safety Answering Point (PSAP) Callback | table 6.1.3.1/110 | Yes | Used PSAP callback indicator. | +| | | | No | | + +**Table C.3.1.16: Indicating the II-NNI traversal scenario** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------------------------------------|---------------------------------|-----------------------------|-----------------------------| +| 1 | Support of the "iotl" SIP URI parameter indicating the II-NNI traversal scenario | table 6.1.3.1/112
clause 5.3 | Yes | | +| | | | No | | + +**Table C.3.1.17: Mission critical services** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------|---------------|-----------------------------|----------------------------------------------------------| +| 1 | Support of Mission critical services | clause 28.2.2 | Yes | MBMS transmission usage and location procedures support. | +| | | | No | | + +**Table C.3.1.18: Calling number verification using signature verification and attestation information** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|-----------------------------|-----------------------------| +| 1 | Calling number verification using signature verification and attestation information | table 6.1.3.1/119
table 6.1.3.1/120
table 6.1.3.1/123
table 6.1.3.1/124
clause 29 | Yes | | +| | | | No | | + +**Table C.3.1.19: Signed attestation for emergency and priority IMS sessions** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|-----------------------------|-------------------------------------------------------------------------| +| 1 | Calling number verification using signature verification and attestation information | table 6.1.3.1/119
table 6.1.3.1/120
table 6.1.3.1/123
table 6.1.3.1/124
clause 34.2 | Yes | Support for emergency, emergency callback and/or priority IMS sessions. | +| | | | No | | +| 2 | Priority verification using assertion of priority information | table 6.1.3.1/73
table 6.1.3.1/110
table 6.1.3.1/119
table 6.1.3.1/128
clause 34.3 | Yes | Support for emergency, emergency callback and/or priority IMS sessions. | +| | | | No | | + +## C.3.2 Option item table specific to roaming II-NNI + +This clause describes the option item tables specific to roaming II-NNI as follows: + +- Table C.3.2.1 shows the mechanism for authentication option items. +- Table C.3.2.1A shows the charging option items. +- Table C.3.2.2 shows the key of service profile for HSS query option item. +- Table C.3.2.3 shows the numbering, naming and addressing option items. +- Table C.3.2.4 shows the supplementary services option items. +- Table C.3.2.5 shows the access transfer services option items. +- Table C.3.2.6 shows the registration of bulk number contacts option items. + +- Table C.3.2.7 shows the P-CSCF restoration option items. +- Table C.3.2.8 shows the resource sharing option items. +- Table C.3.2.9 shows the Priority sharing option items. +- Table C.3.2.9A shows the PS data off extension option items. +- Table C.3.2.10 shows the RLOS option items. + +**Table C.3.2.1: Mechanism for authentication** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------|-----------------|-----------------------------|-----------------------------| +| 1 | IMS AKA plus Ipsec ESP | table 6.1.3.1/7 | Yes | | +| | | | No | | +| 2 | SIP digest plus check of IP association | table 6.1.3.1/7 | Yes | | +| | | | No | | +| 3 | SIP digest plus Proxy Authentication | table 6.1.3.1/7 | Yes | | +| | | | No | | +| 4 | SIP digest with TLS | table 6.1.3.1/7 | Yes | | +| | | | No | | + +**Table C.3.2.1A: Charging** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------|---------------------------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Inter-operator accounting | table 6.1.3.1/38
clause 11.2 | Yes | Operator network identifiers populated in the type 1 "orig-ioi" and "term-ioi" header field parameters of the P-Charging-Vector header field. | +| | | | No | | +| 2 | Inter-operator accounting for the transit scenario | clause 11.2 | Yes | Operator network identifiers populated in the "transit-ioi" header field parameters of the P-Charging-Vector header field. | +| | | | No | | + +**Table C.3.2.2: The key of service profile for HSS query** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | The key of service profile for HSS query (P-Profile-Key header field) | table 6.1.3.1/59 | Yes | | +| | | | No | | + +**Table C.3.2.3: Numbering, naming and addressing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|---------------------------------------------------------------|--------------------------|-----------------------------|-----------------------------| +| 1 | Dial string ("user=dialstring" SIP URI parameter) | table 6.1.3.1/67 | Yes | | +| | | | No | | +| 2 | Barring of premium numbers ("premium-rate" tel URI parameter) | clause 8.1,
clause 24 | Yes | | +| | | | No | | + +**Table C.3.2.4: Supplementary services** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------|----------------|-----------------------------|-----------------------------| +| 1 | Outgoing Communication Barring (OCB) | clause 12.10.2 | Yes | | +| | | | No | | +| 2 | Unstructured Supplementary Service Data | clause 12.24 | Yes | | +| | | | No | | +| 3 | Enhanced Calling Name | clause 12.25 | Yes | | +| | | | No | | + +**Table C.3.2.5: Access transfer services** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------------------|-------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | IMS Centralized Services (ICS) | clause 13 | Yes | | +| | | | No | | +| 2 | PS to CS Single Radio Voice Call Continuity (SRVCC) | clause 14 | Yes | Additional use conditions (PS to CS SRVCC for calls in alerting phase, support of ATCF architecture, PS to CS SRVCC for calls in pre-alerting phase and PS to CS SRVCC with the MSC server assisted mid-call feature).
If the ATCF architecture applies, the URIs of SCC ASs authorised to provide PS to CS SRVCC information in the MESSAGE request. | +| | | | No | | +| | | | Yes | Additional use condition (transfer in alerting phase). | +| | | | No | | +| 3 | Single Radio Video Call Continuity (vSRVCC) | clause 14 | Yes | | +| | | | No | | +| 4 | Inter UE Transfer (IUT) | clause 18 | Yes | | +| | | | No | | +| 5 | CS to PS Single Radio Voice Call Continuity (SRVCC) | clause 14.5 | Yes | The URIs of SCC ASs authorised to provide CS to PS SRVCC information in the MESSAGE request.
Additional use conditions (support of CS to PS SRVCC for calls in alerting phase and support of CS to PS SRVCC with the assisted mid-call feature). | +| | | | No | | +| | | | Yes | | +| | | | No | | +| 6 | PS to CS Dual Radio Voice Call Continuity (DRVCC) | clause 14.6 | Yes | Additional use conditions (PS to CS DRVCC for calls in alerting phase, PS to CS DRVCC for originating calls in pre-alerting phase, PS to CS DRVCC with the MSC server assisted mid-call feature and the use of IMS Centralized Services (ICS) and the tel URI in STN). | +| | | | No | | +| | | | Yes | | +| | | | No | | +| 7 | CS to PS Dual Radio Voice Call Continuity (DRVCC) | clause 14.7 | Yes | Additional use conditions (CS to PS DRVCC for calls in alerting phase, CS to PS DRVCC for originating calls in pre-alerting phase, CS to PS DRVCC with the MSC server assisted mid-call feature) and the use of IMS Centralized Services (ICS). | +| | | | No | | +| | | | Yes | | +| | | | No | | + +**Table C.3.2.6: Registration of bulk number contacts** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------|-------------------|-----------------------------|-----------------------------| +| 1 | Registration of bulk number contacts | table 6.1.3.1/104 | Yes | | +| | | | No | | + +**Table C.3.2.7: P-CSCF restoration** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------|-------------|-----------------------------|-----------------------------| +| 1 | PCRF or PCF based P-CSCF restoration | clause 25.2 | Yes | | +| | | | No | | +| 2 | HSS or UDM/HSS based P-CSCF restoration | clause 25.3 | Yes | | +| | | | No | | + +**Table C.3.2.8: Resource sharing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------|------------|-----------------------------|-----------------------------| +| 1 | Resource sharing | clause 26 | Yes | | +| | | | No | | + +**Table C.3.2.9: Priority sharing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------|---------------------------------|-----------------------------|-----------------------------| +| 1 | Priority sharing | clause 28,
table 6.1.3.1/118 | Yes | | +| | | | No | | + +**Table C.3.2.9A: 3GPP PS data off extension** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------|----------------------------------|-----------------------------|-----------------------------| +| 1 | 3GPP PS data off extension | clause 32,
table 6.1.3.1/121A | Yes | | +| | | | No | | + +**Table C.3.2.10: RLOS** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|---------------------------------|-----------------------------|-----------------------------| +| 1 | RLOS | clause 31,
table 6.1.3.1/127 | Yes | | +| | | | No | | + +### C.3.3 Option item table specific to non-roaming II-NNI and loopback traversal scenario + +This clause describes the option item tables specific to the non-roaming II-NNI and the loopback traversal scenario as follows: + +- Table C.3.3.1 shows the SIP method option items. +- Table C.3.3.2 shows the charging option items. +- Table C.3.3.3 shows the GRUU option items. +- Table C.3.3.4 shows the media feature tags option items. +- Table C.3.3.5 shows the ISDN interworking option items. +- Table C.3.3.6 shows the corporate network option items. +- Table C.3.3.7 shows the numbering, naming and addressing option items. +- Table C.3.3.8 shows the additional functions option item. + +- Table C.3.3.9 shows IMS emergency session traversal scenario option item. + +**Table C.3.3.1: SIP method** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------|--------------------------------|-----------------------------|-----------------------------| +| 1 | NOTIFY method | table 6.1/10
table 6.1/11 | Yes | Event package name to use. | +| | | | No | | +| 2 | SUBSCRIBE method | table 6.1/20
table 6.1/21 | Yes | Event package name to use. | +| | | | No | | +| 3 | PUBLISH method | table 6.1/15A
table 6.1/15B | Yes | Event package name to use. | +| | | | No | | + +**Table C.3.3.2: Charging** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------|---------------------------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Inter-operator accounting | table 6.1.3.1/38
clause 11.2 | Yes | Operator network identifiers populated in the type 2 "orig-ioi" and "term-ioi" header field parameters of the P-Charging-Vector header field. | +| | | | No | | +| 2 | Inter-operator accounting for the transit scenario | clause 11.2 | Yes | Operator network identifiers populated in the "transit-ioi" header field parameters of the P-Charging-Vector header field. | +| | | | No | | + +**Table C.3.3.3: Globally routable user agent URIs (GRUU)** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Globally Routable User Agent URIs (gruu) | table 6.1.3.1/56 | Yes | | +| | | | No | | + +**Table C.3.3.4: Media feature tags** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------|-----------------------------------------------------------------------------------|-----------------------------|-------------------------------------| +| 1 | Media feature tags | table 6.1.3.1/76
clause 12
clause 13
clause 14
clause 16
clause 18 | Yes | Names of media feature tags to use. | +| | | | No | | + +**Table C.3.3.5: ISDN interworking** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | User to User Call Control Information in SIP for ISDN Interworking (uui) | table 6.1.3.1/79 | Yes | | +| | | | No | | + +**Table C.3.3.6: Corporate network** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|---------------------------------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Private network traffic (P-Private-Network-Indication header field) | table 6.1.3.1/80 | Yes | | +| | | | No | | + +**Table C.3.3.7: Numbering, naming and addressing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------------------------|------------|-----------------------------|---------------------------------------------------------------------------------------| +| 0 | SIP URI | clause 8.1 | Yes | Any local numbers that are allowed in addition to global numbers. | +| | | | | Domain name(s) and/or IP address(es) of hostportion to accept. | +| | | | | Applicability of PSI to use. | +| | | | | Applicability of "Unavailable User Identity" in the P-Asserted-Identity header field. | +| | | | | | +| 0A | tel URI (NOTE) | clause 8.1 | Yes | Any local numbers that are allowed in addition to global numbers. | +| | | | | Applicability of the URI in the P-Asserted-Identity header field and/or Request-URI. | +| | | | No | | +| 0B | IM URI | clause 8.1 | Yes | | +| | | | No | | +| 0C | PRES URI | clause 8.1 | Yes | | +| | | | No | | +| 1 | Number Portability Routing Number ("rn" and "npdi" tel URI parameters) | clause 8.1 | Yes | | +| | | | No | | +| 2 | Calling Party's Category ("cpc" tel URI parameter) | clause 8.1 | Yes | cpc-values to use. | +| | | | No | | +| 3 | Originating Line Information ("oli" tel URI parameter) | clause 8.1 | Yes | oli-values to use. | +| | | | No | | + +NOTE: The option item is only for the non-roaming II-NNI. + +**Table C.3.3.8: Additional functions** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------|------------------------------|-----------------------------|-----------------------------| +| 1 | Support of out-of-dialog OPTIONS method | table 6.1/12
table 6.1/13 | Yes | The purpose of the method. | +| | | | No | | + +**Table C.3.3.9: IMS emergency session traversal scenario** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------|------------------------------------------------|-----------------------------|---------------------------------------------------------------| +| 1 | IMS emergency session traversal scenario | table 6.1.3.1/55
clause 30.1
clause 30.2 | Yes | The emergency service URN(s) to use. | +| | | | | The PSAP URI to use in the Route header field, if applicable. | +| | | | No | | +| 2 | Next-Generation Pan-European eCall emergency service | clause 30.3 | Yes | | +| | | | No | | + +## Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|------|-----|-----------------------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 03/2015 | CT-67 | CP-150129 | 736 | 1 | Addition of an optional capability regarding a new cause-param value for service number translation | 12.7.0 | 13.0.0 | +| 03/2015 | CT-67 | CP-150130 | 719 | | Correction of a minor error in subclause C.3.1 | 12.7.0 | 13.0.0 | +| 03/2015 | CT-67 | CP-150130 | 723 | | Annex A corrections | 12.7.0 | 13.0.0 | +| 03/2015 | CT-67 | CP-150130 | 726 | 3 | Applying drafting rules | 12.7.0 | 13.0.0 | +| 03/2015 | CT-67 | CP-150130 | 729 | 1 | Adding missing abbreviations | 12.7.0 | 13.0.0 | +| 06/2015 | CT-68 | CP-150339 | 0741 | - | Reference Update: RFC 7462 (alert-info urns) | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150341 | 0746 | - | Condition on usage of Refer-Sub header field | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150356 | 0747 | 3 | Introducing resource sharing | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150346 | 0749 | 1 | Correcting errors in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150347 | 0751 | - | draft-holmberg-dispatch-iottl-parameter-04 updated to RFC 7549 | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150350 | 0753 | 1 | Additional RFC 6665 related IETF drafts added | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150357 | 0754 | 1 | Correcting inconsistencies in the major capability table | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0756 | 1 | Correction of Record-Route header field applicability in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0758 | - | Correction of applicable SIP status code for SIP header fields in PUBLISH response in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0760 | - | Addition of missing text referring to an option item table in annex C | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0762 | 1 | Correction of the P-Charging-Vector header field in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0763 | 1 | Correction of the P-Early-Media header field within the PRACK response in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0765 | - | Correction of the Server header field within the SUBSCRIBE response in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0766 | - | Correction of the Allow header field in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0767 | - | Clarifications on NNI impacts due to CAT service | 13.0.0 | 13.1.0 | +| 06/2015 | - | - | - | - | MCC Correction of implementation of CR0765 | 13.1.0 | 13.1.1 | +| 09/2015 | CT-69 | CP-150486 | 0768 | 3 | The privacy level "session" and "critical" are not used in OIP/OIR | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150479 | 0769 | 1 | Service access number translation | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150471 | 0771 | 1 | Reference update: draft-ietf-mmusic-sctp-sdp | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150475 | 0773 | - | Missing SIP request in HSS based P-CSCF restoration | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150479 | 0774 | - | draft-mohali-dispatch-cause-for-service-number updated to latest version | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150486 | 0775 | 1 | The Service-Interact-Info header field | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150478 | 0776 | 1 | Plain text message body missing in table 6.1.4.1 | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150478 | 0777 | 1 | application/x-www-form-urlencoded missing in table 6.1.4.1 | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150486 | 0778 | 1 | application/vnd.3gpp.crs+xml MIME body missing in CRS | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150478 | 0779 | - | message/sip MIME body missing in table 6.1.4.1 | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150478 | 0780 | - | Applicability of SIP header fields on a roaming II-NNI | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150469 | 0783 | - | Reference update: RFC 7415 | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150465 | 0787 | 1 | Correction for the II-NNI conditions | 13.1.1 | 13.2.0 | +| 12/2015 | CT-70 | CP-150796 | 0790 | 2 | Clarification on the II-NNI specifications of announcement | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150796 | 0791 | 2 | Updating for annex B | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150654 | 0795 | - | Telepresence IETF draft update | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150659 | 0796 | 3 | Introducing MCPTT | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150657 | 0797 | 2 | Reference update of draft-mohali-dispatch-cause-for-service-number | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150664 | 0800 | 2 | Adding the "loopback-indication" to RAVEL | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150731 | 0804 | 1 | ICS and the conference service | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150660 | 0805 | - | SRVCC and subscription to conference package | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150660 | 0806 | 1 | ICS and subscription to conference package | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150656 | 0807 | 1 | Clarification of applicable URI formats for public user identity | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150796 | 0808 | - | Miscellaneous editorial modification | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150671 | 0810 | 1 | Update of UP6665 references | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150662 | 0812 | 1 | P-CSCF restoration corrections | 13.2.0 | 13.3.0 | + +| Change history | | | | | | | | +|----------------|-------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2016-03 | CT#71 | CP-160088 | 0813 | 2 | B | Adding MBMS usage info and location info procedure | 13.4.0 | +| 2016-03 | CT#71 | CP-160088 | 0814 | 2 | F | Adding "application/vnd.3gpp.mcptt-info" MIME body | 13.4.0 | +| 2016-03 | CT#71 | CP-160088 | 0815 | 2 | B | Adding MCPTT as option item in annex C | 13.4.0 | +| 2016-03 | CT#71 | CP-160088 | 0816 | 1 | B | Adding affiliation | 13.4.0 | +| 2016-03 | CT#71 | CP-160098 | 0817 | 1 | F | Adding "Timer N" in the timer table | 13.4.0 | +| 2016-03 | CT#71 | CP-160096 | 0819 | 1 | A | Updating "Details for operator choice" in DRVCC to include the STN | 13.4.0 | +| 2016-03 | CT#71 | CP-160088 | 0821 | 1 | F | Addressed MCPTT SIP interfaces | 13.4.0 | +| 2016-06 | CT#72 | CP-160262 | 0822 | 2 | F | Some error corrections and removing an editor's note | 13.5.0 | +| 2016-06 | CT#72 | CP-160262 | 0823 | 2 | F | Group regrouping | 13.5.0 | +| 2016-06 | CT#72 | CP-160262 | 0824 | 1 | F | Conference event package subscription | 13.5.0 | +| 2016-06 | CT#72 | CP-160262 | 0825 | 1 | F | MCPTT service settings | 13.5.0 | +| 2016-06 | CT#72 | CP-160262 | 0826 | - | F | Clarifying the Accept-Contact header field in MBMS usage info | 13.5.0 | +| 2016-06 | CT#72 | CP-160262 | 0827 | 2 | F | The affiliation procedure update | 13.5.0 | +| 2016-06 | CT#72 | CP-160259 | 0828 | 1 | F | Adding the Cellular-Network-Info header field | 13.5.0 | +| 2016-06 | CT#72 | CP-160258 | 0834 | 1 | A | Adding draft-mohali-dispatch-originating-cdiv-parameter | 13.5.0 | +| 2016-06 | CT#72 | CP-160258 | 0840 | 1 | A | Updates to RFC 7315 P-header extensions usage in SIP requests/responses | 13.5.0 | +| 2016-06 | CT#72 | CP-160258 | 0843 | 1 | A | P-Access-Network-Info ABNF Update | 13.5.0 | +| 2016-06 | CT#72 | CP-160261 | 0844 | 1 | F | Update ref to draft-mohali-dispatch-cause-for-service-number-06 | 13.5.0 | +| 2016-06 | CT#72 | CP-160273 | 0830 | 1 | F | Clarification of the note about forking | 14.0.0 | +| 2016-06 | CT#72 | CP-160273 | 0831 | - | F | Changing content type to correct terminology | 14.0.0 | +| 2016-06 | CT#72 | CP-160273 | 0835 | 1 | F | Clarification of Public Service Identity at II-NNI | 14.0.0 | +| 2016-06 | CT#72 | CP-160273 | 0836 | 1 | F | Correcting the subscription to the conference package for CONF and the session-mode messaging service | 14.0.0 | +| 2016-06 | CT#72 | CP-160273 | 0837 | 1 | F | Clarification on the applicability of P-Early-Media header field and early media over the II-NNI | 14.0.0 | +| 2016-09 | CT#73 | CP-160446 | 0846 | 1 | A | Usage of the Resource-Share header field | 14.1.0 | +| 2016-09 | CT#73 | CP-160447 | 0852 | 1 | A | Reference update: RFC 7913 | 14.1.0 | +| 2016-09 | CT#73 | CP-160449 | 0855 | 1 | A | Updated ref to draft-mohali-dispatch-cause-for-service-number-07 | 14.1.0 | +| 2016-12 | CT#74 | CP-160624 | 0857 | 1 | A | Updated ref to draft-mohali-dispatch-cause-for-service-number-09 | 14.2.0 | +| 2016-12 | CT#74 | CP-160620 | 0861 | 1 | A | Updated ref to draft-mohali-dispatch-originating-cdiv-parameter-02 | 14.2.0 | +| 2016-12 | CT#74 | CP-160620 | 0865 | - | A | Reference update: RFC 7976 | 14.2.0 | +| 2016-12 | CT#74 | CP-160621 | 0875 | - | A | Reference update: RFC 7989 | 14.2.0 | +| 2016-12 | CT#74 | CP-160623 | 0877 | 2 | A | Missing support of priority sharing | 14.2.0 | +| 2016-12 | CT#74 | CP-160631 | 0878 | - | F | Additional routeing functionality at the IBCF | 14.2.0 | +| 2017-03 | CT#75 | CP-170087 | 0882 | 1 | A | Correction on PSAP callback indicator option item | 14.3.0 | +| 2017-03 | CT#75 | CP-170087 | 0883 | 1 | A | Correction on the architecture diagram of II-NNI | 14.3.0 | +| 2017-03 | CT#75 | CP-170087 | 0884 | 1 | A | Addition of application/call-completion MIME Type | 14.3.0 | +| 2017-03 | CT#75 | CP-170080 | 0886 | 1 | A | Update ref to draft-mohali-dispatch-cause-for-service-number | 14.3.0 | +| 2017-03 | CT#75 | CP-170078 | 0890 | 2 | A | Update ref to draft-mohali-dispatch-originating-cdiv-parameter | 14.3.0 | +| 2017-03 | CT#75 | CP-170079 | 0894 | - | A | Reference update: RFC 8055 | 14.3.0 | +| 2017-03 | CT#75 | CP-170077 | 0896 | - | A | Applicability of Resource-Share header field | 14.3.0 | +| 2017-03 | CT#75 | CP-170085 | 0897 | 1 | B | Support of "Calling number verification" | 14.3.0 | +| 2017-06 | CT#76 | CP-171134 | 0872 | 5 | F | Clarification of II-NNI for IMS emergency session | 14.4.0 | +| 2017-06 | CT#76 | CP-171130 | 0898 | 2 | B | Addition of the location parameter | 14.4.0 | +| 2017-06 | CT#76 | CP-171128 | 0900 | - | A | MIME body types used by MCPTT | 14.4.0 | +| 2017-06 | CT#76 | CP-171126 | 0901 | - | F | Modifying references to align with rel-14 MCPTT stage 1 and stage 2 restructuring | 14.4.0 | +| 2017-06 | CT#76 | CP-171134 | 0902 | 1 | F | Missing support of Response-Source header field | 14.4.0 | +| 2017-06 | CT#76 | CP-171124 | 0904 | 1 | A | Reference Update RFC8119 | 14.4.0 | +| 2017-06 | CT#76 | CP-171123 | 0908 | 1 | A | Update ref to new naming of draft-mohali-sipcore-originating-cdiv-parameter | 14.4.0 | +| 2017-06 | CT#76 | CP-171131 | 0909 | 2 | F | Support of feature capability indicator "sip.607" | 14.4.0 | +| 2017-06 | CT#76 | CP-171122 | 0913 | - | A | Reference update: draft-ietf-mmusic-sctp-sdp | 14.4.0 | +| 2017-06 | CT#76 | CP-171131 | 0914 | - | F | Reference update: draft-ietf-stir-rfc4474bis | 14.4.0 | +| 2017-06 | CT#76 | CP-171125 | 0915 | 3 | B | IMS Trace (ISAT) Procedures | 14.4.0 | +| 2017-06 | CT#76 | CP-171127 | 0916 | 3 | B | Adding other Mission Critical services | 14.4.0 | +| 2017-06 | CT#76 | CP-171135 | 0910 | 1 | F | Added unspecified abbreviations | 15.0.0 | +| 2017-06 | CT#76 | CP-171135 | 0918 | 2 | F | Misalignment regarding transcoding between TS 24.229 and TS 29.165 | 15.0.0 | +| 2017-06 | CT#76 | | | | | Editorial changes by MCC | 15.0.1 | +| 2017-09 | CT#77 | CP-172049 | 0919 | 1 | A | Added the profile status in proxy role regarding "A SIP Response Code for Unwanted Calls" | 15.1.0 | +| 2017-09 | CT#77 | CP-172040 | 0920 | 1 | B | Support of IETF draft-ietf-sipcore-content-id | 15.1.0 | +| 2017-09 | CT#77 | CP-172045 | 0922 | 1 | A | Reference Update for the ISUP location parameter | 15.1.0 | +| 2017-09 | CT#77 | CP-172049 | 0925 | - | A | Reference update from draft-ietf-sipcore-status-unwanted-06 to | 15.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------------------|--------| +| | | | | | | RFC 8197 | | +| 2017-12 | CT#78 | CP-173099 | 0928 | 1 | A | Reference Update for the ISUP location parameter | 15.2.0 | +| 2017-12 | CT#78 | CP-173091 | 0933 | 1 | A | Update draft ref for Originating-CDIV param in P-Served-User | 15.2.0 | +| 2017-12 | CT#78 | CP-173090 | 0934 | - | D | Editorial modification | 15.2.0 | +| 2017-12 | CT#78 | CP-173095 | 0935 | 1 | A | Adding MCData related MIME bodies | 15.2.0 | +| 2017-12 | CT#78 | CP-173098 | 0938 | 1 | A | Correction of II-NNI condition related to P-Early-Media header field | 15.2.0 | +| 2017-12 | CT#78 | CP-173102 | 0940 | - | A | Correction of II-NNI condition related to P-Early-Media header field for the UPDATE request | 15.2.0 | +| 2017-12 | CT#78 | CP-173096 | 0943 | - | A | Addition of sign XML MIME body | 15.2.0 | +| 2017-12 | CT#78 | CP-173092 | 0945 | - | F | Reference update: RFC 8262 | 15.2.0 | +| 2018-03 | CT#79 | CP-180038 | 0946 | 1 | B | Support of "Enhanced calling name" service | 15.3.0 | +| 2018-03 | CT#79 | CP-180048 | 0947 | - | F | bSRVCC-MT NNI | 15.3.0 | +| 2018-03 | CT#79 | CP-180048 | 0948 | 1 | F | Operator choice of DTMF sampling rate | 15.3.0 | +| 2018-03 | CT#79 | CP-180042 | 0950 | - | A | Reference Update for the ISUP location parameter | 15.3.0 | +| 2018-03 | CT#79 | CP-180048 | 0951 | - | F | Updating the title of referenced TS 22.179 | 15.3.0 | +| 2018-03 | CT#79 | CP-180044 | 0953 | - | A | Reference update: RFC 8224 | 15.3.0 | +| 2018-03 | CT#79 | CP-180048 | 0955 | - | F | Correction on the terminology of non-global number | 15.3.0 | +| 2018-03 | CT#79 | CP-180048 | 0956 | - | F | Correction of the option item name for Calling number verification | 15.3.0 | +| 2018-03 | CT#79 | CP-180048 | 0957 | 1 | F | Operator choice of CAT media type | 15.3.0 | +| 2018-06 | CT#80 | CP-181022 | 0958 | 1 | F | Missing explanation of abbreviation "5xx" | 15.4.0 | +| 2018-06 | CT#80 | CP-181016 | 0959 | 1 | B | Calling number verification using signature verification and attestation information | 15.4.0 | +| 2018-06 | CT#80 | CP-181170 | 0960 | 4 | F | MBMS transmission and location procedures for MCVideo service | 15.4.0 | +| 2018-09 | CT#81 | CP-182021 | 0961 | 1 | B | Functional Alias Management over II-NNI | 15.5.0 | +| 2018-09 | CT#81 | CP-182020 | 0966 | 1 | A | Update draft ref for Originating-CDIV param in P-Served-User | 15.5.0 | +| 2018-09 | CT#81 | CP-182018 | 0967 | 1 | F | Correction of NOTE numbering for trust relationship | 15.5.0 | +| 2018-09 | CT#81 | CP-182024 | 0969 | - | A | Reference Update for the ISUP Q.850 location parameter | 15.5.0 | +| 2018-12 | CT#82 | CP-183113 | 0974 | 2 | A | Update draft ref for Originating-CDIV param in P-Served-User | 15.6.0 | +| 2018-12 | CT#82 | CP-183114 | 0977 | 1 | A | Removal of editor's note on Service-Interact-Info | 15.6.0 | +| 2018-12 | CT#82 | CP-183111 | 0978 | - | F | Support of Origination-Id in INVITE and MESSAGE methods | 15.6.0 | +| 2019-03 | CT#83 | CP-190124 | 0980 | 2 | A | References update for ISAT after related RFC completed in IETF | 15.7.0 | +| 2019-03 | CT#83 | CP-190126 | 0982 | 2 | A | Reference Update for the ISUP Cause Location Parameter Draft | 15.7.0 | +| 2019-03 | CT#83 | CP-190123 | 0988 | 1 | A | P-Served-User case orig-cdiv is now RFC 8498 | 15.7.0 | +| 2019-06 | CT#84 | CP-191094 | 0989 | - | A | Reference Update for the ISUP Cause Location Parameter Draft | 15.8.0 | +| 2019-09 | CT#85 | CP-192166 | 0992 | 1 | A | Reference Update RFC8606 | 15.9.0 | +| 2019-09 | CT#85 | CP-192174 | 0990 | 3 | F | Clarification of the usage restriction of P-Asserted-Identity header field over the II-NNI. | 16.0.0 | +| 2019-09 | CT#85 | CP-192162 | 0993 | 1 | B | Support of "Multi-Device" and "Multi-Identity" services | 16.0.0 | +| 2019-12 | CT#86 | CP-193190 | 0995 | 2 | A | P-CSCF restoration in 5GS | 16.1.0 | +| 2019-12 | CT#86 | CP-193205 | 0996 | - | B | Additional-Identity header in REFER request | 16.1.0 | +| 2019-12 | CT#86 | CP-193207 | 1004 | 1 | A | Correction for setting condition of the Contact header field | 16.1.0 | +| 2020-03 | CT#87e | CP-200229 | 1005 | 2 | F | Clarification of the scope | 16.2.0 | +| 2020-06 | CT#88e | CP-201329 | 1006 | - | F | Corrections on the II-NNI specifications on the P-Charging-Vector header field | 16.3.0 | +| 2020-06 | CT#88e | CP-201240 | 1007 | 1 | F | Re-structure of subclause for MuD/MiD service | 16.3.0 | +| 2020-06 | CT#88e | CP-201242 | 1008 | 1 | F | Adding the RLOS requirements over the II-NNI | 16.3.0 | +| 2020-09 | CT#89e | CP-202076 | 1011 | 1 | A | Addition of missing capability | 16.4.0 | +| 2020-09 | CT#89e | CP-202075 | 1015 | - | A | Support of P-Charging-Vector header field in BYE and PRACK | 16.4.0 | +| 2020-12 | CT#90e | CP-203145 | 1016 | 2 | F | Adding the description of Ix reference point. | 17.0.0 | +| 2021-03 | CT#91e | CP-210213 | 1017 | 1 | F | Correction of the dynamic view status for History-Info header field. | 17.1.0 | +| 2021-03 | CT#91e | CP-210242 | 1023 | - | A | Reference update: RFC 8841 | 17.1.0 | +| 2021-06 | CT#92e | CP-211236 | 1024 | 3 | A | IMS data channel at the II-NNI | 17.2.0 | +| 2021-06 | CT#92e | CP-211222 | 1028 | - | A | Correction on Calling number verification using signature verification and attestation information | 17.2.0 | +| 2021-06 | CT#92e | CP-211258 | 1029 | 1 | B | Support for signed attestation for emergency and priority IMS sessions | 17.2.0 | +| 2021-09 | CT#93e | CP-212227 | 1030 | 1 | B | IBCF RPH signing for MPS | 17.3.0 | +| 2022-09 | CT#97e | CP-222124 | 1032 | 2 | F | Support of Reason header for handling of Identity header errors | 17.4.0 | +| 2022-12 | CT#98e | CP-223195 | 1033 | - | F | Capability alignment: Identity Header Error Handling | 17.5.0 | +| 2022-12 | CT#98e | CP-223195 | 1034 | 1 | F | Reference update: draft-ietf-stir-identity-header-errors-handling | 17.5.0 | +| 2022-12 | CT#98e | CP-223182 | 1035 | - | B | Support of IETF draft-ietf-sipcore-multiple-reasons | 18.0.0 | +| 2023-06 | CT#100 | CP-231187 | 1036 | - | F | Reference update: RFC 9366 | 18.1.0 | +| 2023-09 | CT#101 | CP-232117 | 1038 | - | A | Reference update: RFC 9410 | 18.2.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29172/raw.md b/raw/rel-18/29_series/29172/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..9d3ef22c26ea74f0565a21f3559705eabc886c44 --- /dev/null +++ b/raw/rel-18/29_series/29172/raw.md @@ -0,0 +1,1708 @@ + + +# 3GPP TS 29.172 V18.1.0 (2023-06) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Location Services (LCS); Evolved Packet Core (EPC) LCS Protocol (ELP) between the Gateway Mobile Location Centre (GMLC) and the Mobile Management Entity (MME); SLg interface (Release 18)** + +![LTE Advanced Pro logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for LTE Advanced Pro, featuring the word "lte" in black lowercase letters, with "Advanced" in green and "Pro" in red above the "e". A green signal icon is above the word "Advanced". A small "TM" symbol is at the bottom right. + +LTE Advanced Pro logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized black font. The "3" has a red signal icon below it. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, all-caps font. A small "TM" symbol is at the bottom right of the logo. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 9 | +| 4 Functional Overview..... | 9 | +| 4.1 General ..... | 9 | +| 5 ELP Message Transport..... | 10 | +| 5.1 General ..... | 10 | +| 5.2 Use of Diameter base protocol..... | 10 | +| 5.3 Securing Diameter Messages ..... | 11 | +| 5.4 Accounting functionality..... | 11 | +| 5.5 Use of sessions ..... | 11 | +| 5.6 Transport protocol..... | 11 | +| 5.7 Routing considerations..... | 11 | +| 5.8 Advertising Application Support ..... | 11 | +| 6 ELP Procedures..... | 12 | +| 6.1 General ..... | 12 | +| 6.2 Provide Subscriber Location ..... | 12 | +| 6.2.1 General ..... | 12 | +| 6.2.2 Successful Operation..... | 12 | +| 6.2.3 Unsuccessful Operation..... | 17 | +| 6.3 Subscriber Location Report..... | 17 | +| 6.3.1 General ..... | 17 | +| 6.3.2 Successful Operation..... | 17 | +| 6.3.3 Unsuccessful Operation..... | 21 | +| 7 ELP Messages and Message Formats ..... | 21 | +| 7.1 General ..... | 21 | +| 7.2 Message Formats..... | 22 | +| 7.3 ELP Messages ..... | 22 | +| 7.3.1 Provide-Location-Request (PLR) Command ..... | 22 | +| 7.3.2 Provide-Location-Answer (PLA) Command ..... | 23 | +| 7.3.3 Location-Report-Request (LRR) Command ..... | 24 | +| 7.3.4 Location-Report-Answer (LRA) Command..... | 24 | +| 7.4 Information Elements..... | 25 | +| 7.4.1 General ..... | 25 | +| 7.4.2 SLG-Location-Type ..... | 27 | +| 7.4.3 LCS-EPS-Client-Name..... | 27 | +| 7.4.4 LCS-Requestor-Name ..... | 28 | +| 7.4.5 LCS-Priority ..... | 28 | +| 7.4.6 LCS-QoS ..... | 28 | +| 7.4.7 Horizontal-Accuracy ..... | 28 | +| 7.4.8 Vertical-Accuracy..... | 28 | +| 7.4.9 Vertical-Requested ..... | 28 | +| 7.4.10 Velocity-Requested ..... | 29 | +| 7.4.11 Response-Time ..... | 29 | +| 7.4.12 Supported-GAD-Shapes ..... | 29 | +| 7.4.13 LCS-Codeword..... | 29 | +| 7.4.14 LCS-Privacy-Check..... | 29 | +| 7.4.15 Accuracy-Fulfilment-Indicator ..... | 30 | +| 7.4.16 Age-Of-Location-Estimate ..... | 30 | + +| | | | +|---------|-------------------------------------------------------------|----| +| 7.4.17 | Velocity-Estimate ..... | 30 | +| 7.4.18 | EUTRAN-Positioning-Data ..... | 30 | +| 7.4.19 | ECGI..... | 30 | +| 7.4.20 | Location-Event ..... | 30 | +| 7.4.21 | Pseudonym-Indicator..... | 31 | +| 7.4.22 | LCS-Service-Type-ID ..... | 31 | +| 7.4.23 | LCS-Privacy-Check-Non-Session..... | 31 | +| 7.4.24 | LCS-Privacy-Check-Session ..... | 31 | +| 7.4.25 | Feature-List-ID ..... | 31 | +| 7.4.26 | Feature-List..... | 31 | +| 7.4.27 | LCS-QoS-Class ..... | 31 | +| 7.4.28 | Serving-Node..... | 32 | +| 7.4.29 | GERAN-Positioning-Info ..... | 32 | +| 7.4.30 | GERAN-Positioning-Data ..... | 32 | +| 7.4.31 | GERAN-GNSS-Positioning-Data ..... | 32 | +| 7.4.32 | UTRAN-Positioning-Info..... | 32 | +| 7.4.33 | UTRAN-Positioning-Data ..... | 32 | +| 7.4.34 | UTRAN-GNSS-Positioning-Data ..... | 32 | +| 7.4.35 | LRR-Flags ..... | 33 | +| 7.4.36 | Deferred-Location-Type..... | 33 | +| 7.4.37 | LCS-Reference-Number..... | 33 | +| 7.4.38 | Area-Event-Info ..... | 33 | +| 7.4.39 | Area-Definition..... | 34 | +| 7.4.40 | Area ..... | 34 | +| 7.4.41 | Area-Type..... | 34 | +| 7.4.42 | Area-Identification ..... | 35 | +| 7.4.43 | Occurrence-Info..... | 35 | +| 7.4.44 | Interval-Time ..... | 35 | +| 7.4.45 | Periodic-LDR-Info ..... | 35 | +| 7.4.46 | Reporting-Amount..... | 35 | +| 7.4.47 | Reporting-Interval ..... | 35 | +| 7.4.48 | Reporting-PLMN-List ..... | 35 | +| 7.4.49 | PLMN-ID-List..... | 36 | +| 7.4.50 | Periodic-Location-Support-Indicator..... | 36 | +| 7.4.51 | Prioritized-List-Indicator ..... | 36 | +| 7.4.52 | PLR-Flags..... | 36 | +| 7.4.53 | PLA-Flags..... | 37 | +| 7.4.54 | Deferred-MT-LR-Data ..... | 37 | +| 7.4.55 | Termination-Cause ..... | 38 | +| 7.4.56 | LRA-Flags ..... | 38 | +| 7.4.57 | ESMLC-Cell-Info..... | 38 | +| 7.4.58 | Cell-Portion-ID ..... | 39 | +| 7.4.59 | 1xRTT-RCID..... | 39 | +| 7.4.60 | Delayed-Location-Reporting-Data ..... | 39 | +| 7.4.61 | Civic-Address ..... | 39 | +| 7.4.62 | Barometric-Pressure ..... | 39 | +| 7.4.63 | UTRAN-Additional-Positioning-Data ..... | 39 | +| 7.4.64 | Motion-Event-Info..... | 39 | +| 7.4.65 | Linear-Distance ..... | 40 | +| 7.4.66 | Maximum-Interval..... | 40 | +| 7.4.67 | Sampling-Interval ..... | 40 | +| 7.4.68 | Reporting-Duration..... | 40 | +| 7.4.69 | Reporting-Location-Requirements ..... | 40 | +| 7.4.70 | Additional-Area ..... | 40 | +| 7.4.71 | AMF-Instance-Id ..... | 41 | +| 7.5 | Result-Code AVP and Experimental-Result AVP Values ..... | 41 | +| 7.5.1 | General ..... | 41 | +| 7.5.2 | Success ..... | 41 | +| 7.5.3 | Permanent Failures ..... | 41 | +| 7.5.3.1 | DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 41 | +| 7.5.3.2 | DIAMETER_ERROR_UNAUTHORIZED_REQUESTING_NETWORK (5490) ..... | 41 | +| 7.5.4 | Transient Failures ..... | 41 | + +7.5.4.1 DIAMETER\_ERROR\_UNREACHABLE\_USER (4221)..... 41 +7.5.4.2 DIAMETER\_ERROR\_SUSPENDED\_USER (4222) ..... 41 +7.5.4.3 DIAMETER\_ERROR\_DETACHED\_USER (4223) ..... 42 +7.5.4.4 DIAMETER\_ERROR\_POSITIONING\_DENIED (4224)..... 42 +7.5.4.5 DIAMETER\_ERROR\_POSITIONING\_FAILED (4225) ..... 42 +7.5.4.6 DIAMETER\_ERROR\_UNKNOWN\_UNREACHABLE LCS\_CLIENT (4226) ..... 42 +**Annex A (informative): Change history..... 43** + +# --- Foreword + +This Technical Specification has been produced by the 3rd 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. + +# --- 1 Scope + +The present document specifies the procedures and information coding for the EPC LCS Protocol (ELP) that is needed to support the location services in E-UTRAN, UTRAN and GERAN. The ELP message set is applicable to the SLg interface between the MME and the GMLC and the Lgd interface between the SGSN and the GMLC. ELP is developed in accordance to the general principles stated in 3GPP TS 23.271 [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.271: "Functional stage 2 description of Location Services (LCS)". +- [3] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". +- [4] Void. +- [5] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [6] 3GPP TS 23.003: "Numbering, addressing and identification". +- [7] 3GPP TS 29.171: "LCS Application Protocol (LCS-AP) between the MME and E-SMLC". +- [8] 3GPP TS 29.274: "Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C)". +- [9] Void +- [10] 3GPP TS 32.299: "Charging management; Diameter charging applications". +- [11] 3GPP TS 29.272: "Evolved Packet System; MME and SGSN Related Interfaces Based on Diameter Protocol". +- [12] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol". +- [13] 3GPP TS 33.210: "3G Security; Network Domain Security; IP Network Layer Security". +- [14] IETF RFC 4960: "Stream Control Transmission Protocol". +- [15] 3GPP TS 22.071: "Location Services (LCS); Service description". +- [16] IETF RFC 5778: "Diameter Mobile IPv6: Support for Home Agent to Diameter Server Interaction". +- [17] 3GPP TS 29.229: "Cx and Dx Interfaces based on the Diameter protocol; protocol details". +- [18] 3GPP TS 29.173: "Location Services; Diameter-based SLh interface for Control Plane LCS". +- [19] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". + +- [20] 3GPP TS 49.031: "Location Services (LCS) – Base Station System Application Part LCS Extension – (BSSAP-LE)". +- [21] 3GPP TS 25.413: "UTRAN Iu Interface RANAP signalling". +- [22] 3GPP2 A.S0014-D v5.0: "Interoperability Specification (IOS) for cdma2000 Access Network Interfaces – Part 4 (A1, A1p, A2, and A5 Interfaces) UTRAN Iu Interface RANAP signalling". +- [23] IETF RFC 6733: "Diameter Base Protocol". +- [24] 3GPP TS 24.080: "Mobile radio interface layer 3 Supplementary services specification; Formats and coding". +- [25] IETF RFC 7944: "Diameter Routing Message Priority". +- [26] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 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 TR 21.905 [1]. + +**EPC-MO-LR:** EPC Mobile Originating Location Request + +**EPC-MT-LR:** EPC Mobile Terminating Location Request + +**EPC-NI-LR:** EPC Network Induced Location Request + +**PS-MO-LR:** Packet Switched Mobile Originating Location Request + +**PS-MT-LR:** Packet Switched Mobile Terminating Location Request + +**PS-NI-LR:** Packet Switched Network Induced Location Request + +**LCS:** LoCation Services + +**LCS Client:** software and/or hardware entity that interacts with a LCS Server (in this case, the GMLC) for the purpose of obtaining location information for one or more Mobile Stations. LCS Clients subscribe to LCS in order to obtain location information. LCS Clients may or may not interact with human users. The LCS Client is responsible for formatting and presenting data and managing the user interface (dialogue). The LCS Client may reside in the Mobile Station (UE). + +**LCS QoS:** The QoS class determines the degree of adherence to the quality of service information as required by the source of a location request. + +**Target:** UE being positioned + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|-----|---------------------------------| +| SLg | Interface between GMLC and MME | +| Lgd | Interface between GMLC and SGSN | + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 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 TR 21.905 [1]. + +| | | +|------|--------------------------------------------------| +| DRMP | Diameter Routing Message Priority | +| EPC | Enhanced Packet Core | +| GMLC | Gateway Mobile Location Centre | +| IMEI | International Mobile Equipment Identity | +| IMS | IP Multimedia Subsystem | +| IMSI | International Mobile Subscriber Identity | +| MME | Mobility Management Entity | +| TTTP | Transfer To Third Party | +| UE | User Equipment, as defined in 3GPP TS 23.032 [3] | + +# 4 Functional Overview + +## 4.1 General + +This document defines the EPC LCS Protocol (ELP) used on the SLg interface between the GMLC and the MME and on the Lgd interface between the GMLC and the SGSN in the Evolved Packet Core (EPC). + +The location of the SLg interface within the LCS logical architecture is shown in Figure 4.1-1. + +![Diagram of the SLg interface in the LCS Architecture](99bae07626f60f9ede10e2e387ef7051_img.jpg) + +The diagram illustrates the LCS logical architecture. On the left, a 'UE' (User Equipment) is connected to an 'eNB' (evolved NodeB). The 'eNB' is connected to an 'MME' (Mobility Management Entity). The 'MME' is connected to an 'HSS' (Home Subscriber Server) above it and an 'E-SMLC' (Evolved SMLC) below it. The 'E-SMLC' is connected to a 'Serving Gateway' (SGW), which is connected to a 'PDN Gateway' (PDN-GW). The 'PDN-GW' is connected to an 'IMS' (IP Multimedia Subsystem), which is connected to a 'PSAP' (Packet Switched Application Processor). The 'MME' is connected to a 'GMLC' (Gateway Mobile Location Centre) via an 'SLg' interface. The 'GMLC' is connected to an 'LRF' (Location Retrieval Function). The 'GMLC' and 'LRF' are enclosed in a dashed box. The 'LRF' is connected to the 'IMS' and the 'PSAP'. + +Diagram of the SLg interface in the LCS Architecture + +Figure 4.1-1 SLg interface in the LCS Architecture + +The location of the Lgd interface within the LCS logical architecture is shown in Figure 4.1-2. + +![Diagram of the LCS Architecture showing the Lgd interface. The diagram illustrates the flow of location information from a UE through various network elements. A UE is connected to an RNC/BSS, which is connected to an SGSN. The SGSN is connected to an HSS and a Serving Gateway. The Serving Gateway is connected to a PDN Gateway, which is connected to an IMS. The IMS is connected to a PSAP. A GMLC and an LRF are shown in a dashed box, with the GMLC connected to the SGSN via the Lgd interface. The LRF is connected to the IMS and the PSAP.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +graph LR + UE[UE] --> RNC[RNC/BSS] + RNC --> SGSN[SGSN] + SGSN --> HSS[HSS] + SGSN --> LGD[Lgd] + LGD --> GMLC[GMLC] + GMLC --> LRF[LRF] + LRF --> IMS((IMS)) + IMS --> PSAP((PSAP)) + SGSN --> SG[Serving Gateway] + SG --> PG[PDN Gateway] + PG --> IMS + +``` + +Diagram of the LCS Architecture showing the Lgd interface. The diagram illustrates the flow of location information from a UE through various network elements. A UE is connected to an RNC/BSS, which is connected to an SGSN. The SGSN is connected to an HSS and a Serving Gateway. The Serving Gateway is connected to a PDN Gateway, which is connected to an IMS. The IMS is connected to a PSAP. A GMLC and an LRF are shown in a dashed box, with the GMLC connected to the SGSN via the Lgd interface. The LRF is connected to the IMS and the PSAP. + +**Figure 4.1-2 Lgd interface in the LCS Architecture** + +The high level functions of the ELP protocol are described in 3GPP TS 23.271 [2]. + +The main functions of the protocol are: + +- To allow the GMLC to request position estimates for a particular target UE from the MME or SGSN in order to support the EPC-MT-LR or PS-MT-LR positioning procedures. This is achieved using the Provide Subscriber Location message; +- To allow the MME or SGSN to return a position estimate or an error report to the GMLC in response to a Provide Subscriber Location request as part of an EPC-MT-LR or PS-MT-LR positioning procedure; +- To allow the MME to forward an unsolicited position estimate to the GMLC as part of the EPC-MO-LR or EPC-NI-LR procedures. This is achieved using the Subscriber Location Report message; +- To allow the SGSN to forward an unsolicited position estimate to the GMLC as part of the PS-MO-LR, PS-NI-LR or periodic MO-LR TTTP procedures. This is achieved using the Subscriber Location Report message; +- To allow the GMLC to acknowledge receipt of an unsolicited position estimate as part of the EPC-MO-LR, EPC-NI-LR, PS-MO-LR, PS-NI-LR or periodic MO-LR TTTP procedures; +- To allow the GMLC to request position estimates for a particular target UE from the SGSN or MME as part of the deferred MT-LR procedure. This is achieved using the Provide Subscriber Location message; +- To allow the SGSN or MME to acknowledge receipt of position estimate request to the GMLC as part of a deferred MT-LR procedure; +- To support the procedures for handover of an IMS emergency call with EPS/GPRS access. + +# 5 ELP Message Transport + +## 5.1 General + +The ELP protocol is defined as a Vendor Specific diameter application (SLg application). It reuses the basic mechanisms defined by the Diameter base protocol as specified in IETF RFC 6733 [23], and it defines a number of additional commands and AVPs to implement the SLg, Lgd specific procedures. + +## 5.2 Use of Diameter base protocol + +The Diameter base protocol as specified in IETF RFC 6733 [23] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as described in this + +specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +## 5.3 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [13]. + +## 5.4 Accounting functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the SLg, Lgd interfaces. + +## 5.5 Use of sessions + +Between the MME and the GMLC and between the SGSN and the GMLC, Diameter sessions shall be implicitly terminated. An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol as specified in IETF RFC 6733 [23] includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [23]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +## 5.6 Transport protocol + +Diameter messages over the SLg and Lgd interfaces shall make use of SCTP (see IETF RFC 4960 [14]). + +## 5.7 Routing considerations + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host. + +Destination-Realm AVP shall always be included in all diameter requests, and therefore is declared as mandatory in the ABNF for all commands. + +When a request is initiated by the GMLC, the name of the MME or SGSN shall be determined by querying the HSS over the SLh interface, and retrieve the specific MME or SGSN that is currently serving the UE. Therefore, Destination-Host AVP shall always be included in the commands originated at the GMLC, and is declared as mandatory in the ABNF. + +When a request is initiated by the MME or SGSN, the name of the GMLC may be either locally configured in the MME/SGSN (e.g., in the intra-domain scenario, when the GMLC belongs to the same PLMN as the MME/SGSN), or it is known from a previously received location procedure initiated at the GMLC. Therefore, the Destination-Host AVP is declared as mandatory in the ABNF of the commands originated at the MME or SGSN. + +If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +## 5.8 Advertising Application Support + +The MME, SGSN and GMLC shall advertise support of the Diameter SLg Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [23]. + +# 6 ELP Procedures + +## 6.1 General + +The ELP procedures, between the GMLC and the MME over SLg interface and between GMLC and SGSN over Lgd interface, are used to exchange messages related to location services. The ELP can be divided into the following sub-procedures. + +- Provide Subscriber Location +- Subscriber Location Report + +## 6.2 Provide Subscriber Location + +### 6.2.1 General + +The Provide Subscriber Location operation is used by a GMLC to request the location of a target UE from the MME or SGSN at any time, as part of EPC-MT-LR or PS-MT-LR positioning procedures. The response contains a location estimate of the target UE and other additional information. + +The Provide Subscriber Location operation is also used by a GMLC to request the location of the target UE from the SGSN or MME at any time, as part of deferred MT-LR procedure. The response contains the acknowledgment of the receipt of the request and other additional information. + +### 6.2.2 Successful Operation + +![Sequence diagram showing the successful operation of the Provide Subscriber Location procedure. The GMLC sends a PROVIDE SUBSCRIBER LOCATION REQUEST to the MME/SGSN, and the MME/SGSN responds with a PROVIDE SUBSCRIBER LOCATION RESPONSE.](426efb7efdc753a13f2fa16f7bff9429_img.jpg) + +``` +sequenceDiagram + participant GMLC + participant MME_SGSN as MME/SGSN + Note left of MME_SGSN: + GMLC->>MME_SGSN: PROVIDE SUBSCRIBER LOCATION REQUEST + MME_SGSN-->>GMLC: PROVIDE SUBSCRIBER LOCATION RESPONSE + Note right of GMLC: +``` + +Sequence diagram showing the successful operation of the Provide Subscriber Location procedure. The GMLC sends a PROVIDE SUBSCRIBER LOCATION REQUEST to the MME/SGSN, and the MME/SGSN responds with a PROVIDE SUBSCRIBER LOCATION RESPONSE. + +**Figure 6.2.2-1: Provide Subscriber Location procedure. Successful operation.** + +The GMLC initiates the procedure by sending a PROVIDE SUBSCRIBER LOCATION REQUEST message to the MME or SGSN. This message carries the type of location information requested (e.g. current location and optionally, velocity), the UE subscriber's IMSI, LCS QoS information (e.g. accuracy, response time), an indication of whether the LCS client has the override capability, and an indication of whether delayed location reporting for UEs transiently not reachable (e.g. UEs in extended idle mode DRX or Power Saving Mode) is supported as specified in clauses 9.1.6 and 9.1.15 of 3GPP TS 23.271 [2]. The message also carries an LCS reference number, if delayed location reporting is supported. For deferred MT-LR procedure, additionally, the message carries Deferred location type, LCS reference number, H-GMLC address, periodic LDR info, triggered LDR info, etc. + +Upon reception of PROVIDE SUBSCRIBER LOCATION REQUEST message, the MME or SGSN shall perform authentication privacy verification on the location request. After that, for EPC-MT-LR or PS-MT-LR procedures the MME or SGSN shall retrieve the location information of the target UE from E-UTRAN or UTRAN/GERAN according to the procedures described in 3GPP TS 23.271 [2]. For a deferred EPC-MT-LR procedure, the MME shall wait until the UE becomes reachable before performing authentication privacy verification on the location request and instigating periodic or triggered location in the UE. + +The MME or SGSN returns a PROVIDE SUBSCRIBER LOCATION RESPONSE to the GMLC. For EPC-MT-LR or PS-MT-LR procedures, if the target UE is transiently not reachable and delayed location reporting for UEs transiently not reachable is supported, the message shall contain an indication that the UE is transiently not reachable; otherwise the message shall contain the location estimate, its age and obtained accuracy. If the MME or SGSN failed to get the current location and the LCS client is requesting the current or last known location, the MME or SGSN may return the last known location of the target UE if this is known. + +For a deferred EPC-MT-LR procedure for periodic or triggered location, the MME returns a PROVIDE SUBSCRIBER LOCATION RESPONSE to the GMLC to indicate that the MME is able and willing to support the procedure. After the MME has performed successful authentication privacy verification on the location request and successfully instigated periodic or triggered location in the UE, the MME returns a SUBSCRIBER LOCATION REPORT to the GMLC to indicate that periodic or triggered location has been activated in the UE. The MME (or a different MME) returns additional SUBSCRIBER LOCATION REPORT messages to the GMLC (or possibly to a different GMLC if not the HGMLC) for each periodic or triggered location event detected by the UE. For details, refer to 3GPP TS 23.271 [2]. + +If the GMLC has received indication from the HSS indicating the combined MME/SGSN node supporting the optimized LCS procedure (see 3GPP TS 29.173 [18] clause 5.2.1.2) and if the GMLC also supports optimized LCS procedure, the GMLC shall set the "Optimized-LCS-Proc-Req" bit within the PLR-Flags of the PROVIDE SUBSCRIBER LOCATION REQUEST message during EPC-MT-LR and/or PS-MT-LR procedures. When the combined MME/SGSN receives this message with "Optimized-LCS-Proc-Req" bit within the PLR-Flags set, the combined MME/SGSN shall perform EPC-MT-LR or PS-MT-LR procedure depending upon the knowledge of the current RAT type of the UE. E.g. if the UE is in active mode in E-UTRAN, the combined MME/SGSN shall perform only EPC-MT-LR procedure; if the ISR activated UE is in idle mode, the combined MME/SGSN shall perform the paging followed by either EPC-MT-LR or PS-MT-LR procedure (depending upon the RAT where the UE is active). Hence, the combined MME/SGSN shall perform optimized LCS procedure to retrieve the location information of the target UE from either E-UTRAN or UTRAN/GERAN. + +The combined MME/SGSN shall return a PROVIDE SUBSCRIBER LOCATION RESPONSE to the GMLC. If the target UE is transiently not reachable and delayed location reporting for UEs transiently not reachable is supported, the message shall contain an indication that the UE is transiently not reachable; otherwise the message shall contain the location estimate, its age and obtained accuracy. If the combined MME/SGSN failed to get the current location and the LCS client is requesting the current or last known location, the combined MME/SGSN should return the latest of the last known EPS or UTRAN/GERAN location of the target UE if this is known. In both the cases, the combined MME/SGSN may set "Optimized-LCS-Proc-Performed" bit within PLA-Flags, if it has performed optimized LCS procedure. + +This procedure is mapped to the commands Provide-Location-Request/Answer in the Diameter application specified in clauses 7.3.1 and 7.3.2. + +Table 6.2.2-1: Provide Subscriber Location Request + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------------|-------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location Type | SLg-Location-Type | M | This Information Element shall contain the type of location measurement requested, such as current location, initial location, last known location, etc. (see 3GPP TS 22.071 [15]). | +| IMSI | User-Name | C | If present, this Information Element shall contain the IMSI of the user whose UE is to be positioned (see Note 1). | +| MSISDN | MSISDN | C | If present, this Information Element shall contain the MSISDN of the user whose UE is to be positioned (see Note 1). | +| IMEI | IMEI | C | If present, this Information Element shall contain the IMEI of the UE to be positioned (see Note 1). | +| Client Name | LCS-EPS-Client-Name | M | This Information Element shall contain the name of the LCS client issuing the positioning request. | +| Client Type | LCS-Client-Type | M | This Information Element shall contain the type of LCS client (Emergency, Lawful Interception ...) issuing the positioning request (see 3GPP TS 23.271 [2] and 3GPP TS 32.299 [10]). | +| Requestor Name | LCS-Requestor-Name | O | If present, this Information Element contains the identity of the originating entity which has requested the location of the target UE from the LCS Client. | +| Priority | LCS-Priority | O | If present, this Information Element shall contain the priority of the LCS client issuing the positioning request. | +| QoS | LCS-QoS | O | If present, this Information Element shall contain the quality of service requested, such as the accuracy of the positioning measurement and the response time of the positioning operation. | +| Velocity Requested | Velocity-Requested | O | If present, this information element shall contain an indication of whether or not the Velocity of the target UE is requested. | +| Supported GAD Shapes | LCS-Supported-GAD-Shapes | O | If present, this Information Element shall contain the list of supported GAD shapes by the LCS client. | +| Service Type ID | LCS-Service-Type-ID | O | If present, this Information Element shall contain the service type associated for the particular positioning request (the meaning of the different service types is defined in 3GPP TS 22.071 [15]). | +| Codeword | LCS-Codeword | O | If present, this Information Element shall contain the Codeword to be used between an LCS client and a target UE in order to check and accept or reject the positioning request. | +| APN | Service-Selection | C | If present, this Information Element shall contain the Access Point Name (APN) Network Identifier of the LCS client, as used by the target UE. It shall only be included in session-related location requests. | +| Session-Related Privacy Check | LCS-Privacy-Check-Session | O | If present, this Information Element shall contain an indication of how the positioning operation should proceed in the relation to the checking of the session-related privacy settings of the user. | +| Non-Session-Related Privacy Check | LCS-Privacy-Check-Non-Session | O | If present, this Information Element shall contain an indication of how the positioning operation should proceed in the relation to the checking of the non-session-related privacy settings of the user. | +| Deferred Location Type | Deferred-Location-Type | O | If present, this Information Element shall contain the type of the event until when the location estimation is deferred. Applicable event types are: UE available, UE entering or leaving or being in a pre-defined geographical area, periodic location, UE moving by more than a minimum linear distance (NOTE). This Information Element is applicable only for the deferred MT-LR procedure.
NOTE: this value is only applicable to a deferred EPC-MT-LR. | +| LCS-Reference Number | LCS-Reference-Number | O | If present, this Information Element shall contain the reference number identifying the deferred location request or identifying the request for which delayed location reporting for UEs transiently not reachable is supported. This Information Element is applicable only when:
- the deferred MT-LR procedure is initiated; or
- an EPC-MT-LR or PS-MT-LR procedure is initiated and the message includes the indication that delayed location reporting for UEs transiently not reachable is supported. | +| Area Event Info | Area-Event-Info | O | If present, this Information Element shall contain area definition, type of area event, occurrence info and minimum interval time. For a deferred EPC-MT-LR, this Information Element may also contain the duration of event reporting, the maximum time interval between event reports, the maximum event sampling interval, and whether location | + +| | | | | +|--------------------------------------------------------------------|--------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | estimates shall be included in event reports. This Information Element is applicable only when the deferred MT-LR is initiated for the area event (UE entering or leaving or being in a pre-defined geographical area). | +| H-GMLC Address | GMLC-Address | O | If present, this Information Element shall contain the address identifying the H-GMLC which initiated the deferred MT-LR procedure. This Information Element is applicable only when the deferred MT-LR procedure is performed. | +| PLR Flags | PLR-Flags | O | This Information Element contains a bit mask. See 7.4.52 for the meaning of the bits. | +| Periodic LDR Information | Periodic-LDR-Information | O | If present, this Information Element shall contain reporting amount and reporting interval of deferred periodic location. This Information Element is applicable only when the deferred MT-LR procedure is initiated for the periodic location event. | +| Reporting PLMN List | Reporting-PLMN-List | O | If present, this Information Element shall contain a list of PLMNs in which the subsequent location estimates must be obtained, or the subsequent triggered or periodic events must be reported, by the UE as part of a periodic MO-LR TTTP or periodic MT-LR procedure. | +| Supported Features (See 3GPP TS 29.229 [17]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Motion Event Info | Motion-Event-Info | O | If present, this Information Element shall contain information for motion event reporting. This information includes the minimum linear distance for a motion event report, the duration of event reporting, the minimum and maximum time intervals between event reports, the maximum event sampling interval, whether location estimates shall be included in event reports, and whether only one location report is required or more than one. This Information Element is applicable only for a deferred EPC-MT-LR. | +| NOTE 1: At least one of these IEs shall be present in the message. | | | | + +Table 6.2.2-2: Provide Subscriber Location Answer + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This Information Element shall contain the result of the operation. The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [23]). The Experimental-Result AVP shall be used for ELP errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Location Estimate | Location-Estimate | O | If present, this Information Element shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate.
This Information Element shall not be included if the PLA Flags Information Element is present and if the bit corresponding to the "UE-Transiently-Not-Reachable-Indicator" is set. | +| Accuracy Fulfilment Indicator | Accuracy-Fulfilment-Indicator | O | If present, this Information Element shall contain an indication of whether the requested accuracy (as indicated in the LCS-QoS IE in the request message) was fulfilled or not. | +| Age of Location Estimate | Age-of-Location-Estimate | O | If present, this Information Element shall contain an indication of how long ago the location estimate was obtained. | +| Velocity Estimate | Velocity-Estimate | O | If present, this Information Element shall contain an estimate of the velocity of the target UE, composed by horizontal speed, vertical speed, and their respective uncertainty (see 3GPP TS 23.032 [3]). | +| EUTRAN Positioning Data | EUTRAN-Positioning-Data | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. The internal structure and encoding is defined in 3GPP TS 29.171 [7]. This Information Element is applicable only when the UE is attached to E-UTRAN access and when the message is sent by the MME or the combined MME/SGSN. | +| ECGI | ECGI | O | If present, this Information Element shall contain the current cell location of the target UE as delivered by the eNB to the MME. The E-UTRAN Cell Global Identifier (ECGI) is used to globally identify a cell. This Information Element is applicable only when the UE is attached to E-UTRAN access and when the message is sent by the MME or combined MME/SGSN. | +| GERAN Positioning Info | GERAN-Positioning-Info | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. This Information Element is applicable only when the UE is attached to GERAN access and when the message is sent by the SGSN or combined MME/SGSN. | +| CGI | Cell-Global-Identity | O | If present, this Information Element shall contain the current cell location of the target UE. The Cell Global Identifier (CGI) is used to globally identify a cell. This Information Element is applicable only when the UE is attached to GERAN access and when the message is sent by the SGSN or combined MME/SGSN. | +| UTRAN Positioning Info | UTRAN-Positioning-Info | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. This Information Element is applicable only when the UE is attached to UTRAN access and when the message is sent by the SGSN or combined MME/SGSN. | +| SAI | Service-Area-Identity | O | If present, this Information Element shall contain the current service area of the target UE. The Service Area Identifier (SAI) is used to globally identify a service area. This Information Element is applicable only when the UE is attached to UTRAN access and when the message is sent by the SGSN or combined MME/SGSN. | +| Target Serving Node Identity | Serving-Node | O | If present, this information element shall contain the address of the target side serving node for handover of an IMS Emergency Call. | +| PLA Flags | PLA-Flags | O | This Information Element contains a bit mask. See 7.4.53 for the meaning of the bits.
If this Information Element is present and if the bit corresponding to the "Deferred-MT-LR-Response-Indicator" is set, the "Location-Estimate" Information Element is ignored in this message. | + +| | | | | +|----------------------------------------------|---------------------|---|----------------------------------------------------------------------------------------------------------------------| +| E-SMLC provided Cell Info | ESMLC-Cell-Info | O | If present, this Information Element shall contain the current cell information of the target UE as known by E-SMLC. | +| Civic Address | Civic-Address | O | If present, this Information Element contains a location estimate for the target UE expressed as a Civic address. | +| Barometric Pressure | Barometric-Pressure | O | If present, this Information Element contains the barometric pressure measurement as reported by the target UE. | +| Supported Features (See 3GPP TS 29.229 [17]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +### 6.2.3 Unsuccessful Operation + +On receipt of a PROVIDE SUBSCRIBER LOCATION RESPONSE with a Result-Code or Experimental-Result AVP indicating failure the GMLC considers the positioning request as failed. + +If the GMLC receives "Optimized-LCS-Proc-Performed" bit within PLA-Flags set, it shall assume that the combined MME/SGSN has either performed EPC-MT-LR or PS-MT-LR procedure to retrieve the location of the target UE. And hence, it need not send another PROVIDE SUBSCRIBER LOCATION REQUEST message to the combined MME/SGSN. + +## 6.3 Subscriber Location Report + +### 6.3.1 General + +The Subscriber Location Report operation is used by an MME or SGSN to provide the location of a target UE to a GMLC, when a request for location has been implicitly issued or when a Delayed Location Reporting is triggered after receipt of a request for location for a UE transiently not reachable. + +### 6.3.2 Successful Operation + +![Sequence diagram showing the successful operation of the Subscriber Location Report procedure. The MME/SGSN sends a SUBSCRIBER LOCATION REPORT message to the GMLC, and the GMLC responds with a SUBSCRIBER LOCATION REPORT ACK message.](b0d4609bc46c2d88a8318706bb5321f7_img.jpg) + +``` + +sequenceDiagram + participant MME/SGSN + participant GMLC + Note left of MME/SGSN: + MME/SGSN->>GMLC: SUBSCRIBER LOCATION REPORT + Note right of GMLC: + GMLC-->>MME/SGSN: SUBSCRIBER LOCATION REPORT ACK + Note left of MME/SGSN: + +``` + +Sequence diagram showing the successful operation of the Subscriber Location Report procedure. The MME/SGSN sends a SUBSCRIBER LOCATION REPORT message to the GMLC, and the GMLC responds with a SUBSCRIBER LOCATION REPORT ACK message. + +**Figure 6.3.2-1: Subscriber Location Report procedure. Successful operation.** + +The MME or SGSN initiates the procedure by sending a SUBSCRIBER LOCATION REPORT message to the GMLC. The message may carry the identity of the UE, the location estimate and its age, and the event causing the location report. + +Upon reception of SUBSCRIBER LOCATION REPORT message, the GMLC shall return a SUBSCRIBER LOCATION REPORT ACK to the MME or SGSN and process the location report accordingly, e.g. transfer of the location estimate to an external LCS Client according to procedure described in 3GPP TS 23.271 [2]. + +If the Location-Event indicates a DEFERRED\_LR\_RESPONSE then the Location-Estimate shall not be sent if the LCS-Supported-GAD-Shapes had been received in Provide Subscriber Location request and the shape encoded in Location-Estimate was not marked as supported in LCS-Supported-GAD-Shapes. In such a case Termination-Cause in Deferred-MT-LR-Data shall be present with value SHAPE\_OF\_LOCATION\_ESTIMATE\_NOT\_SUPPORTED. + +If the Location-Event indicates a HANDOVER\_TO\_5GC, the Subscriber Location Report shall include Location-Event, UE identifies and AMF ID as target node information, EPC-GMLC identifies the handover by Location-Event and target AMF. + +This procedure is mapped to the commands Location-Report-Request/Answer in the Diameter application specified in clauses 7.3.3 and 7.3.4. + +Table 6.3.2-1: Subscriber Location Report + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------|-------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location Event | Location-Event | M | This Information Element shall contain the type of event that caused the location procedure to be initiated. | +| IMSI | User-Name | C | If present, this Information Element shall contain the IMSI of the user whose UE is to be positioned (see Note 1). | +| MSISDN | MSISDN | C | If present, this Information Element shall contain the MSISDN of the user whose UE is to be positioned (see Note 1). | +| IMEI | IMEI | C | If present, this Information Element shall contain the IMEI of the UE to be positioned (see Note 1). | +| Client Name | LCS-EPS-Client-Name | O | If present, this Information Element shall contain the name of the LCS client where the result of the positioning operation should be sent. | +| Location Estimate | Location-Estimate | O | If present, this Information Element shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate. | +| Accuracy Fulfilment Indicator | Accuracy-Fulfilment-Indicator | O | If present, this Information Element shall contain an indication of whether the requested accuracy was fulfilled or not. | +| Age of Location Estimate | Age-of-Location-Estimate | O | If present, this Information Element shall contain an indication of how long ago the location estimate was obtained. | +| Velocity Estimate | Velocity-Estimate | O | If present, this Information Element shall contain an estimate of the velocity of the UE, composed by horizontal speed, vertical speed, and their respective uncertainty (see 3GPP TS 23.032 [3]). | +| EUTRAN Positioning Data | EUTRAN-Positioning-Data | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. The internal structure and encoding is defined in 3GPP TS 29.171 [7]. This Information Element is applicable only when the UE is attached to E-UTRAN access and when the message is sent by the MME or the MME part of the combined MME/SGSN. | +| ECGI | ECGI | O | If present, this Information Element shall contain the current cell location of the target UE as delivered by the eNB to the MME. The E-UTRAN Cell Global Identifier (ECGI) is used to globally identify a cell. This Information Element is applicable only when the UE is attached to E-UTRAN access and when the message is sent by the MME or the MME part of the combined MME/SGSN. | +| GERAN Positioning Info | GERAN-Positioning-Info | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. This Information Element is applicable only when the UE is attached to GERAN access and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| CGI | Cell-Global-Identity | O | If present, this Information Element shall contain the current cell location of the target UE. The Cell Global Identifier (CGI) is used to globally identify a cell. This Information Element is applicable only when the UE is attached to GERAN access and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| UTRAN Positioning Info | UTRAN-Positioning-Info | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. This Information Element is applicable only when the UE is attached to UTRAN access and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| SAI | Service-Area-Identity | O | If present, this Information Element shall contain the current service area of the target UE. The Service Area Identifier (SAI) is used to globally identify a service area. This Information Element is applicable only when the UE is attached to UTRAN access and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| Service Type ID | LCS-Service-Type-ID | O | If present, this Information Element shall contain the service type associated for the particular positioning report identifying the service at the receiving LCS Client (the meaning of the different service types is defined in 3GPP TS 22.071 [15]). | +| Pseudonym Indicator | Pseudonym-Indicator | O | If present, this Information Element shall contain an indication of whether or not a pseudonym must be allocated by the network and | + +| | | | | +|----------------------------------------------------|-----------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | transferred to the LCS client as the identity of the UE. | +| Supported Features
(See 3GPP TS
29.229 [17]) | Supported-
Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| LCS QoS Class | LCS-QoS-Class | O | If present, this Information Element shall contain the LCS-QoS-Class requested by the target UE. | +| Target Serving
Node Identity | Serving-Node | O | If present, this information element shall contain the address of the target side serving node for handover of an IMS Emergency Call. | +| LRR Flags
(See 7.4.35) | LRR-Flags | C | This Information Element contains a bit mask. See 7.4.35 for the meaning of the bits.
It shall be present when the message is sent over Lgd interface. | +| LCS-Reference
Number | LCS-Reference-
Number | O | If present, this Information Element shall contain the reference number identifying the deferred location request or identifying the request for which Delayed Location Reporting is triggered. This is same as the reference number included in the Provide Subscriber Location request for the deferred MT-LR procedure or for the EPC-MT-LR or PS-MT-LR with the Delayed-Location-Reporting-Support indication, or the reference number included in the Subscriber Location Report Ack for periodic MO-LR TTTP procedure. This Information Element shall be included if the Location-Event is set to:
- "DEFERRED_MT_LR_RESPONSE"; or
- "DELAYED_LOCATION_REPORTING". | +| Deferred MT-LR
Data | Deferred-MT-LR-
Data | O | If present, this Information Element is used to report the deferred location event type, the location information and optionally a reason why the serving node or UE aborted monitoring the event to the GMLC. The deferred location event type may correspond to the location event type requested in the Provide Subscriber Location Request. For a deferred EPC-MT-LR, the deferred location event type may also indicate LDR activation in the UE or expiration of the maximum time interval between event reports. This Information Element shall be included when the Location-Event is set to "DEFERRED_MT_LR_RESPONSE". | +| H-GMLC Address | GMLC-Address | O | If present, this Information Element shall contain the address identifying the H-GMLC which should receive location estimates. This is the same as the H-GMLC address included in the Provide Subscriber Location request for the deferred MT-LR procedure or the H-GMLC address included in the Subscriber Location Report Ack for periodic MO-LR TTTP procedure. | +| Sequence Number | Reporting-
Amount | O | If present, this parameter contains the number of the periodic location reports completed. The sequence number would be set to 1 in the first location report and increment by 1 for each new report. When the number reaches the reporting amount value, the H-GMLC (for a periodic MT-LR or a periodic MO-LR TTTP) will know the procedure is complete. This Information Element is applicable only when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| Periodic LDR
Information | Periodic-LDR-
Information | O | If present, this Information Element shall contain the UE requested reporting amount and reporting interval of deferred periodic location reporting. This Information Element is applicable only when the periodic MO-LR TTTP procedure is initiated by the UE and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| E-SMLC provided
Cell Info | ESMLC-Cell-Info | O | If present, this Information Element shall contain the current cell information of the target UE as known by E-SMLC. | +| 1xRTT Reference
Cell ID | 1xRTT-RCID | O | If present, this Information Element shall contain the 1xRTT Reference Cell ID uniquely identifying of the target cell location for handover of an IMS emergency call. This Information Element is applicable only when the UE is making handover to a cdma2000 1xRTT access and when the message is sent by the MME or the MME part of the combined MME/SGSN. | +| Delayed Location
Reporting Data | Delayed-
Location-
Reporting-Data | O | If present, this Information Element is used to report to the GMLC the reason why the serving node ended an earlier EPC-MT-LR or PS-MT-LR with the Delayed-Location-Reporting-Support indication received for a UE transiently not reachable.
This Information Element shall be included when the Location-Event is set to "DELAYED_LOCATION_REPORTING". | + +| | | | | +|--------------------------------------------------------------------|---------------------|---|-------------------------------------------------------------------------------------------------------------------| +| Civic Address | Civic-Address | O | If present, this Information Element contains a location estimate for the target UE expressed as a Civic address. | +| Barometric Pressure | Barometric-Pressure | O | If present, this Information Element contains the barometric pressure measurement as reported by the target UE. | +| AMF Instance ID | AMF-Instance-Id | | If present, this Information Element contains the AMF ID for LCS Handover to 5GC. | +| NOTE 1: At least one of these IEs shall be present in the message. | | | | + +Table 6.3.2-2: Subscriber Location Report Ack + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|-----------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This Information Element shall contain the result of the operation. The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [23]). The Experimental-Result AVP shall be used for ELP errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| H-GMLC Address | GMLC-Address | O | If present, this Information Element shall contain the address identifying the H-GMLC which should receive location estimates as part of periodic MO-LR TTTP procedure. This Information Element is applicable only when the message is sent towards the SGSN or the SGSN part of the combined MME/SGSN. | +| LRA Flags | LRA-Flags | O | This Information Element contains a bit mask. See 7.4.56 for the meaning of the bits. | +| Reporting PLMN List | Reporting-PLMN-List | O | If present, this Information Element shall contain a list of PLMNs in which the subsequent location estimates must be obtained as part of periodic MO-LR TTTP procedure. This Information Element is applicable only when the message is sent towards the SGSN or the SGSN part of the combined MME/SGSN. | +| LCS Reference Number | LCS-Reference-Number | O | If present, this Information Element shall contain the reference number identifying the deferred location request or identifying the request for which Delayed Location Reporting was triggered. This Information Element is applicable only when the message is sent towards the SGSN or the SGSN part of the combined MME/SGSN. | +| Supported Features (See 3GPP TS 29.229 [17]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +### 6.3.3 Unsuccessful Operation + +If for some reason the GMLC does not accept the SUBSCRIBER LOCATION REPORT APDU, the GMLC shall send a SUBSCRIBER LOCATION REPORT ACK message with a Result-Code or Experimental-Result AVP indicating failure. + +# 7 ELP Messages and Message Formats + +## 7.1 General + +The Diameter base protocol as specified in IETF RFC 6733 [23] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +This clause specifies a Diameter application that allows a Diameter server and a Diameter client: + +- to retrieve the location information of a target UE +- to report the location information of a target UE + +The SLg/Lgd interface protocol is defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the SLg interface application is 16777255 (allocated by IANA). + +The Lgd interface uses the Diameter application identifier defined for the SLg interface application. + +## 7.2 Message Formats + +This clause defines Command-Code values for the SLg interface application. These Command-Code values are applicable for the SLg and Lgd interfaces. + +Every command is defined by means of the ABNF syntax IETF RFC 2234 [5], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [23]. If the definition and use of an AVP is not specified in this document, the guidelines IETF RFC 6733 [23] shall apply. + +For these commands, the Application-ID field shall be set to 16777255 (application identifier of the SLg interface application). + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with IETF RFC 6733 [23]. + +The following Command Codes are defined in this specification: + +**Table 7.2-1: Command-Code values** + +| Command-Name | Abbreviation | Code | Clause | +|--------------------------|--------------|---------|--------| +| Provide-Location-Request | PLR | 8388620 | 7.3.1 | +| Provide-Location -Answer | PLA | 8388620 | 7.3.2 | +| Location-Report-Request | LRR | 8388621 | 7.3.3 | +| Location-Report-Answer | LRA | 8388621 | 7.3.4 | + +## 7.3 ELP Messages + +### 7.3.1 Provide-Location-Request (PLR) Command + +The Provide-Location-Request (PLR) command, indicated by the Command-Code field set to 8388620 and the 'R' bit set in the Command Flags field, is sent by the GMLC in order to request subscriber location to the MME or SGSN. + +Message Format + +``` +< Provide-Location-Request > ::= < Diameter Header: 8388620, REQ, PXY, 16777255 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { SLg-Location-Type } + [ User-Name ] + [ MSISDN ] + [ IMEI ] + { LCS-EPS-Client-Name } +``` + +``` + +{ LCS-Client-Type } +[ LCS-Requestor-Name ] +[ LCS-Priority ] +[ LCS-QoS ] +[ Velocity-Requested ] +[ LCS-Supported-GAD-Shapes ] +[ LCS-Service-Type-ID ] +[ LCS-Codeword ] +[ LCS-Privacy-Check-Non-Session ] +[ LCS-Privacy-Check-Session ] +[ Service-Selection ] +[ Deferred-Location-Type ] +[ LCS-Reference-Number ] +[ Area-Event-Info ] +[ GMLC-Address ] +[ PLR-Flags ] +[ Periodic-LDR-Information ] +[ Reporting-PLMN-List ] +[ Motion-Event-Info ] +*[ Supported-Features ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +### 7.3.2 Provide-Location-Answer (PLA) Command + +The Provide-Location-Answer (PLA) command, indicated by the Command-Code field set to 8388620 and the 'R' bit cleared in the Command Flags field, is sent by the MME or SGSN to the GMLC in response to the Provide-Location-Request command. + +Message Format + +``` + +< Provide-Location-Answer > ::= < Diameter Header: 8388620, PXY, 16777255 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Location-Estimate ] +[ Accuracy-Fulfilment-Indicator ] +[ Age-Of-Location-Estimate ] +[ Velocity-Estimate ] +[ EUTRAN-Positioning-Data ] +[ ECGI ] +[ GERAN-Positioning-Info ] +[ Cell-Global-Identity ] +[ UTRAN-Positioning-Info ] +[ Service-Area-Identity ] +[ Serving-Node ] +[ PLA-Flags ] +[ ESMLC-Cell-Info ] +[ Civic-Address ] +[ Barometric-Pressure ] +*[ Supported-Features ] +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +### 7.3.3 Location-Report-Request (LRR) Command + +The Location-Report-Request (LRR) command, indicated by the Command-Code field set to 8388621 and the 'R' bit set in the Command Flags field, is sent by the MME or SGSN in order to provide subscriber location data to the GMLC. + +#### Message Format + +``` +< Location-Report-Request > ::= < Diameter Header: 8388621, REQ, PXY, 16777255 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +{ Destination-Host } +{ Destination-Realm } +{ Location-Event } +[ LCS-EPS-Client-Name ] +[ User-Name ] +[ MSISDN ] +[ IMEI ] +[ Location-Estimate ] +[ Accuracy-Fulfilment-Indicator ] +[ Age-Of-Location-Estimate ] +[ Velocity-Estimate ] +[ EUTRAN-Positioning-Data ] +[ ECGI ] +[ GERAN-Positioning-Info ] +[ Cell-Global-Identity ] +[ UTRAN-Positioning-Info ] +[ Service-Area-Identity ] +[ LCS-Service-Type-ID ] +[ Pseudonym-Indicator ] +[ LCS-QoS-Class ] +[ Serving-Node ] +[ LRR-Flags ] +[ LCS-Reference-Number ] +[ Deferred-MT-LR-Data ] +[ GMLC-Address ] +[ Reporting-Amount ] +[ Periodic-LDR-Information ] +[ ESMLC-Cell-Info ] +[ 1xRTT-RCID ] +[ Delayed-Location-Reporting-Data ] +[ Civic-Address ] +[ Barometric-Pressure ] +*[ Supported-Features ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +``` + +### 7.3.4 Location-Report-Answer (LRA) Command + +The Location-Report-Answer (LRA) command, indicated by the Command-Code field set to 8388621 and the 'R' bit cleared in the Command Flags field, is sent by the GMLC to the MME or SGSN in response to the Location-Report-Request command. + +#### Message Format + +``` +< Location-Report-Answer > ::= < Diameter Header: 8388621, PXY, 16777255 > +< Session-Id > +[ DRMP ] +``` + +[ Vendor-Specific-Application-Id ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ GMLC-Address ] +[ LRA-Flags ] +[ Reporting-PLMN-List ] +[ LCS-Reference-Number ] +\*[ Supported-Features ] +\*[ AVP ] +[ Failed-AVP ] +\*[ Proxy-Info ] +\*[ Route-Record ] + +## 7.4 Information Elements + +### 7.4.1 General + +The following table describes the Diameter AVPs defined for the SLg interface protocol, their AVP Code values, types, possible flag values and whether the AVP may or not be encrypted. + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +Table 7.4.1-1: Diameter ELP Application AVPs + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | | +|-------------------------------------|----------|----------------|-------------|----------------|-----|------------|----------|-------------| +| | | | | Must | May | Should not | Must not | May Encrypt | +| SLG-Location-Type | 2500 | 7.4.2 | Enumerated | M, V | | | | No | +| LCS-EPS-Client-Name | 2501 | 7.4.3 | Grouped | M, V | | | | No | +| LCS-Requestor-Name | 2502 | 7.4.4 | Grouped | M, V | | | | No | +| LCS-Priority | 2503 | 7.4.5 | Unsigned32 | M, V | | | | No | +| LCS-QoS | 2504 | 7.4.6 | Grouped | M, V | | | | No | +| Horizontal-Accuracy | 2505 | 7.4.7 | Unsigned32 | M, V | | | | No | +| Vertical-Accuracy | 2506 | 7.4.8 | Unsigned32 | M, V | | | | No | +| Vertical-Requested | 2507 | 7.4.9 | Enumerated | M, V | | | | No | +| Velocity-Requested | 2508 | 7.4.10 | Enumerated | M, V | | | | No | +| Response-Time | 2509 | 7.4.11 | Enumerated | M, V | | | | No | +| Supported-GAD-Shapes | 2510 | 7.4.12 | Unsigned32 | M, V | | | | No | +| LCS-Codeword | 2511 | 7.4.13 | UTF8String | M, V | | | | No | +| LCS-Privacy-Check | 2512 | 7.4.14 | Enumerated | M, V | | | | No | +| Accuracy-Fulfilment-Indicator | 2513 | 7.4.15 | Enumerated | M, V | | | | No | +| Age-Of-Location-Estimate | 2514 | 7.4.16 | Unsigned32 | M, V | | | | No | +| Velocity-Estimate | 2515 | 7.4.17 | OctetString | M, V | | | | No | +| EUTRAN-Positioning-Data | 2516 | 7.4.18 | OctetString | M, V | | | | No | +| ECGI | 2517 | 7.4.19 | OctetString | M, V | | | | No | +| Location-Event | 2518 | 7.4.20 | Enumerated | M, V | | | | No | +| Pseudonym-Indicator | 2519 | 7.4.21 | Enumerated | M, V | | | | No | +| LCS-Service-Type-ID | 2520 | 7.4.22 | Unsigned32 | M, V | | | | No | +| LCS-Privacy-Check-Non-Session | 2521 | 7.4.23 | Grouped | M, V | | | | No | +| LCS-Privacy-Check-Session | 2522 | 7.4.24 | Grouped | M, V | | | | No | +| LCS-QoS-Class | 2523 | 7.4.27 | Enumerated | M, V | | | | No | +| GERAN-Positioning-Info | 2524 | 7.4.29 | Grouped | V | | | M | No | +| GERAN-Positioning-Data | 2525 | 7.4.30 | OctetString | V | | | M | No | +| GERAN-GANSS-Positioning-Data | 2526 | 7.4.31 | OctetString | V | | | M | No | +| UTRAN-Positioning-Info | 2527 | 7.4.32 | Grouped | V | | | M | No | +| UTRAN-Positioning-Data | 2528 | 7.4.33 | OctetString | V | | | M | No | +| UTRAN-GANSS-Positioning-Data | 2529 | 7.4.34 | OctetString | V | | | M | No | +| LRR-Flags | 2530 | 7.4.35 | Unsigned32 | V | | | M | No | +| LCS-Reference-Number | 2531 | 7.4.37 | OctetString | V | | | M | No | +| Deferred-Location-Type | 2532 | 7.4.36 | Unsigned32 | V | | | M | No | +| Area-Event-Info | 2533 | 7.4.38 | Grouped | V | | | M | No | +| Area-Definition | 2534 | 7.4.39 | Grouped | V | | | M | No | +| Area | 2535 | 7.4.40 | Grouped | V | | | M | No | +| Area-Type | 2536 | 7.4.41 | Unsigned32 | V | | | M | No | +| Area-Identification | 2537 | 7.4.42 | Grouped | V | | | M | No | +| Occurrence-Info | 2538 | 7.4.43 | Enumerated | V | | | M | No | +| Interval-Time | 2539 | 7.4.44 | Unsigned32 | V | | | M | No | +| Periodic-LDR-Information | 2540 | 7.4.45 | Grouped | V | | | M | No | +| Reporting-Amount | 2541 | 7.4.46 | Unsigned32 | V | | | M | No | +| Reporting-Interval | 2542 | 7.4.47 | Unsigned32 | V | | | M | No | +| Reporting-PLMN-List | 2543 | 7.4.48 | Grouped | V | | | M | No | +| PLMN-ID-List | 2544 | 7.4.49 | Grouped | V | | | M | No | +| PLR-Flags | 2545 | 7.4.52 | Unsigned32 | V | | | M | No | +| PLA-Flags | 2546 | 7.4.53 | Unsigned32 | V | | | M | No | +| Deferred-MT-LR-Data | 2547 | 7.4.54 | Grouped | V | | | M | No | +| Termination-Cause | 2548 | 7.4.55 | Unsigned32 | V | | | M | No | +| LRA-Flags | 2549 | 7.4.56 | Unsigned32 | V | | | M | No | +| Periodic-Location-Support-Indicator | 2550 | 7.4.50 | Enumerated | V | | | M | No | +| Prioritized-List-Indicator | 2551 | 7.4.51 | Enumerated | V | | | M | No | +| ESMLC-Cell-Info | 2552 | 7.4.57 | Grouped | V | | | M | No | +| Cell-Portion-ID | 2553 | 7.4.58 | Unsigned32 | V | | | M | No | +| 1xRTT-RCID | 2554 | 7.4.59 | OctetString | V | | | M | No | +| Delayed-Location-Reporting-Data | 2555 | 7.4.60 | Grouped | V | | | M | No | + +| | | | | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|--------|-------------|---|--|--|---|----| +| Civic-Address | 2556 | 7.4.61 | UTF8String | V | | | M | No | +| Barometric-Pressure | 2557 | 7.4.62 | Unsigned32 | V | | | M | No | +| UTRAN-Additional-Positioning-Data | 2558 | 7.4.63 | OctetString | V | | | M | No | +| Motion-Event-Info | 2559 | 7.4.64 | Grouped | V | | | M | No | +| Linear-Distance | 2560 | 7.4.65 | Unsigned32 | V | | | M | No | +| Maximum-Interval | 2561 | 7.4.66 | Unsigned32 | V | | | M | No | +| Sampling-Interval | 2562 | 7.4.67 | Unsigned32 | V | | | M | No | +| Reporting-Duration | 2563 | 7.4.68 | Unsigned32 | V | | | M | No | +| Reporting-Location-Requirements | 2564 | 7.4.69 | Unsigned32 | V | | | M | No | +| Additional-Area | 2565 | 7.4.70 | Grouped | V | | | M | No | +| AMF-Instance-Id | 2566 | 7.4.71 | UTF8String | V | | | M | No | +| Note: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [23]. | | | | | | | | | + +Table 7.4.1-2: Diameter ELP Application reused AVPs + +| Attribute Name | AVP Code | Reference | Value Type | Comment | +|-------------------------|----------|-----------------------------------------|-------------|---------------------------------------| +| LCS-Format-Indicator | 1237 | 3GPP TS 32.299 [10] | Enumerated | | +| LCS-Name-String | 1238 | 3GPP TS 32.299 [10] | UTF8String | | +| LCS-Client-Type | 1241 | 3GPP TS 32.299 [10] | Enumerated | | +| LCS-Requestor-Id-String | 1240 | 3GPP TS 32.299 [10] | UTF8String | | +| Location-Estimate | 1242 | 3GPP TS 32.299 [10] | OctetString | | +| IMEI | 1402 | 3GPP TS 29.272 [11] | UTF8String | | +| MSISDN | 701 | 3GPP TS 29.329 [12] | OctetString | | +| Service-Selection | 493 | 3GPP TS 29.272 [11], IETF RFC 5778 [16] | UTF8String | It is used to define the APN | +| User-Name | 1 | IETF RFC 6733 [23] | UTF8String | It is used to include the user's IMSI | +| Supported-Features | 628 | 3GPP TS 29.229 [17] | Grouped | | +| Feature-List-ID | 629 | 3GPP TS 29.229 [17] | Unsigned32 | See clause 7.4.25 | +| Feature-List | 630 | 3GPP TS 29.229 [17] | Unsigned32 | See clause 7.4.26 | +| Serving-Node | 2401 | 3GPP TS 29.173 [18] | Grouped | See clause 6.4.3 | +| Cell-Global-Identity | 1604 | 3GPP TS 29.272 [11] | OctetString | See clause 7.3.119 | +| Service-Area-Identity | 1607 | 3GPP TS 29.272 [11] | OctetString | See clause 7.3.122 | +| GMLC-Address | 2405 | 3GPP TS 29.173 [18] | Address | See clause 6.4.7 | +| Visited-PLMN-Id | 1407 | 3GPP TS 29.272 [11] | OctetString | See clause 7.3.9 | +| DRMP | 301 | IETF RFC 7944 [25] | Enumerated | DRMP | + +### 7.4.2 SLg-Location-Type + +The SLg-Location-Type AVP is of type Enumerated. The following values are defined: + +CURRENT\_LOCATION (0) + +CURRENT\_OR\_LAST\_KNOWN\_LOCATION (1) + +INITIAL\_LOCATION (2) + +ACTIVATE\_DEFERRED\_LOCATION (3) + +CANCEL\_DEFERRED\_LOCATION (4) + +NOTIFICATION\_VERIFICATION\_ONLY (5) + +### 7.4.3 LCS-EPS-Client-Name + +The LCS-EPS-Client-Name AVP is of type Grouped. + +AVP format: + +LCS-EPS-Client-Name ::= + +[ LCS-Name-String ] +[ LCS-Format-Indicator ] + +The details of the LCS-Name-String AVP and the LCS-Format-Indicator AVP are described in 3GPP TS 32.299 [10]. + +### 7.4.4 LCS-Requestor-Name + +The LCS-Requestor-Name AVP is of type Grouped. + +AVP format: + +LCS-Requestor-Name ::= + +[ LCS-Requestor-Id-String ] +[ LCS-Format-Indicator ] + +The details of the LCS-Requestor-Id-String AVP and the LCS-Format-Indicator AVP are described in 3GPP TS 32.299 [10]. + +### 7.4.5 LCS-Priority + +The LCS-Priority AVP is of type Unsigned32. It indicates the priority of the location request. The value 0 shall indicate the highest priority, and the value 1 shall indicate normal priority. All other values shall be treated as 1 (normal priority). For details, refer to 3GPP TS 22.071 [15]. + +### 7.4.6 LCS-QoS + +The LCS-QoS AVP is of type Grouped. + +AVP format: + +LCS-QoS ::= + +[ LCS-QoS-Class ] +[ Horizontal-Accuracy ] +[ Vertical-Accuracy ] +[ Vertical-Requested ] +[ Response-Time ] + +### 7.4.7 Horizontal-Accuracy + +The Horizontal-Accuracy AVP is of type Unsigned32. Bits 6-0 corresponds to Uncertainty Code defined in 3GPP TS 23.032 [3]. The horizontal location error should be less than the error indicated by the uncertainty code with 67% confidence. Bits 7 to 31 shall be ignored. + +### 7.4.8 Vertical-Accuracy + +The Vertical-Accuracy AVP is of type Unsigned32. Bits 6-0 corresponds to Uncertainty Code defined in 3GPP TS 23.032 [3]. The vertical location error should be less than the error indicated by the uncertainty code with 67% confidence. Bits 7 to 31 shall be ignored. + +### 7.4.9 Vertical-Requested + +The Vertical-Requested AVP is of type Enumerated. The following values are defined: + +VERTICAL\_COORDINATE\_IS\_NOT\_REQUESTED (0) + +VERTICAL\_COORDINATE\_IS\_REQUESTED (1) + +Default value if AVP is not present is: VERTICAL\_COORDINATE\_IS\_NOT\_REQUESTED (0). + +### 7.4.10 Velocity-Requested + +The Velocity-Requested AVP is of type Enumerated. The following values are defined: + +VELOCITY\_IS\_NOT\_REQUESTED (0) + +VELOCITY\_IS\_REQUESTED (1) + +Default value if AVP is not present is: VELOCITY\_IS\_NOT\_REQUESTED (0). + +### 7.4.11 Response-Time + +The Response-Time AVP is of type Enumerated. The following values are defined: + +LOW\_DELAY (0) + +DELAY\_TOLERANT (1) + +### 7.4.12 Supported-GAD-Shapes + +The Supported-GAD-Shapes AVP is of type Unsigned32 and it shall contain a bitmask. + +A node shall mark in the BIT STRING all Shapes defined in 3GPP TS 23.032 [3] it supports. + +Bits 10-0 in shall indicate the supported Shapes defined in 3GPP TS 23.032 [3]. Bits 11 to 31 shall be ignored. + +ellipsoidPoint (0) + +ellipsoidPointWithUncertaintyCircle (1) + +ellipsoidPointWithUncertaintyEllipse (2) + +polygon (3) + +ellipsoidPointWithAltitude (4) + +ellipsoidPointWithAltitudeAndUncertaintyEllipsoid (5) + +ellipsoidArc (6) + +highAccuracyEllipsoidPointWithUncertaintyEllipse (7) + +highAccuracyEllipsoidPointWithAltitudeAndUncertaintyEllipsoid (8) + +highAccuracyEllipsoidPointWithScalableUncertaintyEllipse (9) + +highAccuracyEllipsoidPointWithAltitudeAndScalableUncertaintyEllipsoid (10) + +### 7.4.13 LCS-Codeword + +The LCS-Codeword AVP is of type UTF8String. It indicates the potential codeword string to send in a notification message to the UE. + +### 7.4.14 LCS-Privacy-Check + +The LCS-Privacy-Check AVP is of type Enumerated. The following values are defined: + +ALLOWED\_WITHOUT\_NOTIFICATION (0) + +ALLOWED\_WITH\_NOTIFICATION (1) + +ALLOWED\_IF\_NO\_RESPONSE (2) + +RESTRICTED\_IF\_NO\_RESPONSE (3) + +NOT\_ALLOWED (4) + +Default value if AVP is not present is: ALLOWED\_WITHOUT\_NOTIFICATION (0). + +### 7.4.15 Accuracy-Fulfilment-Indicator + +The Accuracy-Fulfilment-Indicator AVP is of type Enumerated. The following values are defined: + +REQUESTED\_ACCURACY\_FULFILLED (0) + +REQUESTED\_ACCURACY\_NOT\_FULFILLED (1) + +### 7.4.16 Age-Of-Location-Estimate + +The Age-Of-Location-Estimate AVP is of type Unsigned32. It indicates how long ago the location estimate was obtained in minutes, as indicated in 3GPP TS 29.002 [19]. + +### 7.4.17 Velocity-Estimate + +The Velocity-Estimate AVP is of type OctetString. It is composed of 4 or more octets with an internal structure according to 3GPP TS 23.032 [3]. + +### 7.4.18 EUTRAN-Positioning-Data + +The EUTRAN-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "Positioning-Data" Information Element as defined in 3GPP TS 29.171 [7]. + +### 7.4.19 ECGI + +The ECGI AVP is of type OctetString. It indicates the E-UTRAN Cell Global Identifier. It is coded according to clause 8.21.5, in 3GPP TS 29.274 [8]. + +### 7.4.20 Location-Event + +The Location-Event AVP is of type Enumerated. The following values are defined: + +EMERGENCY\_CALL\_ORIGINATION (0) + +EMERGENCY\_CALL\_RELEASE (1) + +MO\_LR (2) + +EMERGENCY\_CALL\_HANDOVER (3) + +DEFERRED\_MT\_LR\_RESPONSE (4) + +DEFERRED\_MO\_LR\_TTTP\_INITIATION (5) + +DELAYED\_LOCATION\_REPORTING (6) + +HANDOVER\_TO\_5GC (7) + +DEFERRED\_MT\_LR\_RESPONSE is applicable to the delivery of an event report and/or a location estimate for an LDR initiated earlier by either the network (via an MT-LR activate deferred location) or the UE (via a periodic MO-LR TTTP initiation for a UE with UTRAN access). + +DELAYED\_LOCATION\_REPORTING is applicable to the delivery of a location estimate for an EPC-MT-LR or PS-MT-LR initiated earlier by the network for a UE which was transiently not reachable. + +### 7.4.21 Pseudonym-Indicator + +The Pseudonym-Indicator AVP is of type Enumerated. It defines if a pseudonym is requested. The following values are defined: + +PSEUDONYM\_NOT\_REQUESTED (0) + +PSEUDONYM\_REQUESTED (1) + +Default value if AVP is not present is: PSEUDONYM\_NOT\_REQUESTED (0). + +### 7.4.22 LCS-Service-Type-ID + +The LCS-Service-Type-ID is of type Unsigned32. It defines the identifier associated to one of the Service Types for which the LCS client is allowed to locate the particular UE. + +### 7.4.23 LCS-Privacy-Check-Non-Session + +The LCS-Privacy-Check-Non-Session AVP is of type Grouped. + +AVP format: + +LCS-Privacy-Check-Non-Session ::= +{ LCS-Privacy-Check } + +Default value if AVP is not present is that AVP LCS-Privacy-Check take value: ALLOWED\_WITHOUT\_NOTIFICATION (0). + +### 7.4.24 LCS-Privacy-Check-Session + +The LCS-Privacy-Check-Session AVP is of type Grouped. + +AVP format: + +LCS-Privacy-Check-Session ::= +{ LCS-Privacy-Check } + +Default value if AVP is not present is that AVP LCS-Privacy-Check take value: NOT\_ALLOWED (4). + +### 7.4.25 Feature-List-ID + +The syntax of this AVP is defined in 3GPP TS 29.229 [17]. For this release, the Feature-List-ID AVP value shall be set to 1. + +### 7.4.26 Feature-List + +The syntax of this AVP is defined in 3GPP TS 29.229 [17]. A null value indicates that there is no feature used by the application. + +NOTE: There are no features defined for this release. + +### 7.4.27 LCS-QoS-Class + +The LCS-QoS-Class AVP is of the type Enumerated. The following values are defined. + +ASSURED (0) + +BEST EFFORT (1) + +### 7.4.28 Serving-Node + +The Serving-Node AVP is of type Grouped. This AVP shall contain the information about the network node serving the targeted user. + +### 7.4.29 GERAN-Positioning-Info + +The GERAN-Positioning-Info AVP is of type Grouped. + +AVP format: + +``` +GERAN-Positioning-Info ::= + [ GERAN-Positioning-Data ] + [ GERAN-GNSS-Positioning-Data ] + *[ AVP ] +``` + +### 7.4.30 GERAN-Positioning-Data + +The GERAN-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "Positioning Data" Information Element as defined in 3GPP TS 49.031 [20]. + +### 7.4.31 GERAN-GNSS-Positioning-Data + +The GERAN-GNSS-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "GNSS Positioning Data" Information Element as defined in 3GPP TS 49.031 [20]. + +### 7.4.32 UTRAN-Positioning-Info + +The UTRAN-Positioning-Info AVP is of type Grouped. + +AVP format: + +``` +UTRAN-Positioning-Info ::= + [ UTRAN-Positioning-Data ] + [ UTRAN-GNSS-Positioning-Data ] + [ UTRAN-Additional-Positioning-Data ] + *[ AVP ] +``` + +### 7.4.33 UTRAN-Positioning-Data + +The UTRAN-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "positioningDataDiscriminator" and the "positioningDataSet" included in the "positionData" Information Element as defined in 3GPP TS 25.413 [21]. + +### 7.4.34 UTRAN-GNSS-Positioning-Data + +The UTRAN-GNSS-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "GNSS-PositioningDataSet" only, included in the "positionData" Information Element as defined in 3GPP TS 25.413 [21]. + +### 7.4.35 LRR-Flags + +The LRR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.4.35/1: + +**Table 7.4.35/1: LRR-Flags** + +| Bit | Name | Description | +|-----|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Lgd/SLg-Indicator | This bit, when set, indicates that the Location Report Request message is sent on the Lgd interface, i.e. the source node is an SGSN (or a combined MME/SGSN to which the UE is attached via UTRAN or GERAN).
This bit, when cleared, indicates that the Location Report Request message is sent on the SLg interface, i.e. the source node is an MME (or a combined MME/SGSN to which the UE is attached via E-UTRAN). | +| 1 | MO-LR-ShortCircuit-Indicator | This bit, when set, indicates that the MO-LR short circuit feature is used by the UE for location estimate. This bit is applicable only when for deferred MT-LR procedure and when the message is sent over Lgd interface. | +| 2 | MO-LR-ShortCircuit-Requested | This bit, when set, indicates that the UE is requesting to use MO-LR short circuit feature for location estimate. This bit is applicable only when periodic MO-LR TTTP procedure is initiated by the UE and when the message is sent over Lgd interface. | + +NOTE1: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving GMLC. + +### 7.4.36 Deferred-Location-Type + +The Deferred-Location-Type AVP is of type Unsigned32 and it shall contain a bit mask. Each bit indicates a type of event, until when the location estimation is deferred. For details, please refer to 3GPP TS 23.271 [3] clause 4.4.2. The meaning of the bits shall be as defined in table 7.4.36/1: + +**Table 7.4.36/1: Deferred-Location-Type** + +| Bit | Event Type | Description | +|-----|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| 0 | UE-Available | Any event in which the SGSN has established a contact with the UE. | +| 1 | Entering-Into-Area | An event where the UE enters a pre-defined geographical area. | +| 2 | Leaving-From-Area | An event where the UE leaves a pre-defined geographical area. | +| 3 | Being-Inside-Area | An event where the UE is currently within the pre-defined geographical area. | +| 4 | Periodic-LDR | An event where a defined periodic timer expires in the UE and activates a location report or a location request. | +| 5 | Motion-Event | An event where the UE moves by more than a minimum linear distance. This event is applicable to a deferred EPC-MT-LR only. | +| 6 | LDR-Activated | An event where deferred location reporting has been activated in the UE. This event is applicable to a deferred EPC-MT-LR only. | +| 7 | Maximum-Interval-Expiration | An event where the maximum reporting interval has expired. This event is applicable to a deferred EPC-MT-LR only. | + +### 7.4.37 LCS-Reference-Number + +The LCS-Reference-Number AVP is of type OctetString of length 1. It shall contain the reference number identifying the deferred location request. + +### 7.4.38 Area-Event-Info + +The Area-Event-Info AVP is of type Grouped. + +AVP format: + +``` +Area-Event-Info ::= + { Area-Definition } + [ Occurrence-Info ] + [ Interval-Time ] + [ Maximum-Interval ] + [ Sampling-Interval ] + [ Reporting-Duration ] + [ Reporting-Location-Requirements ] + *[ AVP ] +``` + +If not included, the default value of Occurrence-Info shall be considered as "ONE\_TIME\_EVENT" (0). Interval-Time and Maximum-Interval AVPs are only applicable when the Occurrence-Info is set to "MULTIPLE\_TIME\_EVENT" (1). If not included, the default value of Interval-Time shall be considered as one and the default values of Maximum-Interval, Sampling-Interval and Reporting-Duration shall each be considered as the maximum value. + +### 7.4.39 Area-Definition + +The Area-Definition AVP is of type Grouped. + +AVP format: + +``` +Area-Definition ::= + 1*10{ Area } + *240[ Additional-Area ] + *[ AVP ] +``` + +For a PS-MT-LR over the Lgd interface, the Additional-Area AVP shall not be included. + +### 7.4.40 Area + +The Area AVP is of type Grouped. + +AVP format: + +``` +Area ::= + { Area-Type } + { Area-Identification } + *[ AVP ] +``` + +### 7.4.41 Area-Type + +The Area-Type AVP is of type Unsigned32. The following values are defined: + +``` +"Country Code" 0 +"PLMN ID" 1 +"Location Area ID" 2 +"Routing Area ID" 3 +``` + +"Cell Global ID" 4 +"UTRAN Cell ID" 5 +"Tracking Area ID" 6 +"E-UTRAN Cell Global ID" 7 + +### 7.4.42 Area-Identification + +The Area-Identification AVP is of type OctetString and shall contain the identification of the area applicable for the change of area event based deferred location reporting. For Area-Type 0 to 5, octets are coded as described in 3GPP TS 29.002 [24]. For Area-Type 6, octets are coded as defined for the Tracking Area Identity area identification in 3GPP TS 24.080 [24]. For Area-Type 7, octets are coded as defined for the ECGI area identification in 3GPP TS 24.080 [24]. For a deferred EPC-MT-LR for the area event, only Area-Type 6 and 7 are applicable. + +### 7.4.43 Occurrence-Info + +The Occurrence-Info AVP is of type Enumerated. The following values are defined: + +ONE\_TIME\_EVENT (0) +MULTIPLE\_TIME\_EVENT (1) + +### 7.4.44 Interval-Time + +The Interval-Time AVP is of type Unsigned32 and it contains the minimum time interval between area reports or motion reports, in seconds. The minimum value shall be 1 second and the maximum value 32767 seconds. + +### 7.4.45 Periodic-LDR-Info + +The Periodic-LDR-Info AVP is of type Grouped. + +AVP format: + +Periodic-LDR-Info ::= +                          { Reporting-Amount } +                          { Reporting-Interval } +                          \*[ AVP ] + +Reporting-Interval x Reporting-Amount shall not exceed 8639999 (99 days, 23 hours, 59 minutes and 59 seconds) for compatibility with OMA MLP and RLP. + +### 7.4.46 Reporting-Amount + +The Reporting-Amount AVP is of type Unsigned32 and it contains reporting frequency. Its minimum value shall be 1 and maximum value shall be 8639999. + +### 7.4.47 Reporting-Interval + +The Interval-Time AVP is of type Unsigned32 and it contains reporting interval in seconds. Its minimum value shall be 1 and maximum value shall be 8639999. + +### 7.4.48 Reporting-PLMN-List + +The Reporting-PLMN-List AVP is of type Grouped. + +AVP format: + +Reporting-PLMN-List ::= +                          1\*20{ PLMN-ID-List } +                          [ Prioritized-List-Indicator ] +                          \*[ AVP ] + +If not included, the default value of Prioritized-List-Indicator shall be considered as "NOT\_PRIORITIZED" (0). + +### 7.4.49 PLMN-ID-List + +The PLMN-ID-List AVP is of type Grouped. + +AVP format: + +PLMN-ID-List ::= +                          { Visited-PLMN-Id } +                          [ Periodic-Location-Support-Indicator ] +                          \*[ AVP ] + +If not included, the default value of Periodic-Location-Support-Indicator shall be considered as "NOT\_SUPPORTED" (0). + +### 7.4.50 Periodic-Location-Support-Indicator + +The Periodic-Location-Support-Indicator AVP is of type Enumerated and it indicates if the given PLMN-ID (indicated by Visited-PLMN-Id) supports periodic location or not. The following values are defined: + +NOT\_SUPPORTED (0) +SUPPORTED (1) + +### 7.4.51 Prioritized-List-Indicator + +The Prioritized-List-Indicator AVP is of type Enumerated and it indicates if the PLMN-ID-List is provided in prioritized order or not. The following values are defined: + +NOT\_PRIORITIZED (0) +PRIORITIZED (1) + +### 7.4.52 PLR-Flags + +The PLR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.4.52/1: + +**Table 7.4.52/1: PLR-Flags** + +| Bit | Name | Description | +|-----|----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | MO-LR-ShortCircuit-Indicator | This bit, when set, indicates that the MO-LR short circuit feature is requested for the periodic location. This bit is applicable only when the deferred MT-LR procedure is initiated for a periodic location event and when the message is sent over Lgd interface. | +| 1 | Optimized-LCS-Proc-Req | This bit, when set, indicates that the GMLC is requesting the optimized LCS procedure for the combined MME/SGSN. This bit is applicable only when the MT-LR procedure is initiated by the GMLC over the Lgd interface. The GMLC shall set this bit only when the HSS indicates the combined MME/SGSN node supporting the optimized LCS procedure. | +| 2 | Delayed-Location-Reporting-Support-Indicator | This bit, when set, indicates that the GMLC supports delayed location reporting for UEs transiently not reachable (e.g. UEs in extended idle mode DRX or Power Saving Mode) as specified in clauses 9.1.6 and 9.1.15 of 3GPP TS 23.271 [2], i.e. that the GMLC supports
- receiving a PROVIDE SUBSCRIBER LOCATION RESPONSE with the UE-Transiently-Not-Reachable-Indicator set in the PLA-Flags IE; and
- receiving the location information in a subsequent SUBSCRIBER LOCATION REPORT when the UE becomes reachable. | + +NOTE1: Bits not defined in this table shall be cleared by the sending GMLC and discarded by the receiving MME or SGSN. + +### 7.4.53 PLA-Flags + +The PLA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.4.53/1: + +**Table 7.4.53/1: PLA-Flags** + +| Bit | Name | Description | +|-----|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Deferred-MT-LR-Response-Indicator | This bit, when set, indicates that the message is sent in response to the deferred-MT location request. | +| 1 | MO-LR-ShortCircuit-Indicator | This bit, when set, indicates that the MO-LR short circuit feature is accepted by the UE, for periodic location reporting. This bit is applicable only when the message is sent over Lgd interface. | +| 2 | Optimized-LCS-Proc-Performed | This bit, when set, indicates that the combined MME/SGSN has performed the optimized LCS procedure to retrieve the location of the target UE. This bit is applicable only when the message is sent for the MT-LR procedure over the Lgd interface. | +| 3 | UE-Transiently-Not-Reachable-Indicator | This bit, when set, indicates that the UE is transiently not reachable due to power saving (e.g. UE is in extended idle mode DRX or in Power Saving Mode), and that the location information will be returned in a subsequent Subscriber Location Report when the UE becomes reachable. | + +NOTE1: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving GMLC. + +### 7.4.54 Deferred-MT-LR-Data + +The Deferred-MT-LR-Data AVP is of type Grouped. + +AVP format: + +``` +Deferred-MT-LR-Data ::= + { Deferred-Location-Type } + [ Termination-Cause ] +``` + +[ Serving-Node ] + +\*[ AVP ] + +Serving-Node may be included only when the Termination-Cause is present indicating MT\_LR\_RESTART. + +The Serving-Node refers to the node where the UE has moved to and shall be included, if available. + +### 7.4.55 Termination-Cause + +The Termination-Cause AVP is of type Unsigned32. The following values are defined: + +| | | +|--------------------------------------------|---| +| "Normal" | 0 | +| "Error Undefined" | 1 | +| "Internal Timeout" | 2 | +| "Congestion" | 3 | +| "MT_LR_Restart" | 4 | +| "Privacy Violation" | 5 | +| "Shape of Location Estimate Not Supported" | 6 | +| "Subscriber Termination" | 7 | +| "UE Termination" | 8 | +| "Network Termination" | 9 | + +"MT\_LR\_Restart" cause code shall be used to trigger the GMLC to restart the location procedure, either because the sending node knows that the terminal has moved under coverage of another SGSN or MME, or because the subscriber has been deregistered due to a Cancel Location received from HSS. + +Any unrecognized value of Termination-Cause shall be treated the same as value 1 ("Error Undefined"). + +### 7.4.56 LRA-Flags + +The LRA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.4.56/1: + +**Table 7.4.56/1: LRA-Flags** + +| Bit | Name | Description | +|------------------------------------------------------------------------------------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | MO-LR-ShortCircuit-Indicator | This bit, when set, indicates that the MO-LR short circuit feature is used for obtaining location estimate. This bit is applicable only when the message is sent over Lgd interface. | +| NOTE1: Bits not defined in this table shall be cleared by the sending GMLC and discarded by the receiving MME or SGSN. | | | + +### 7.4.57 ESMLC-Cell-Info + +The ESMLC-Cell-Info AVP is of type Grouped. + +AVP format: + +ESMLC-Cell-Info ::= + +[ ECGI ] + +[ Cell-Portion-ID ] + +\*[ AVP ] + +### 7.4.58 Cell-Portion-ID + +The Cell-Portion-ID AVP is of type Unsigned32. It indicates the current Cell Portion location of the target UE as provided by the E-SMLC. It shall contain the value of the "Cell Portion ID" Information Element as defined in 3GPP TS 29.171 [7]. + +### 7.4.59 1xRTT-RCID + +The 1xRTT-RCID AVP is of type OctetString. It indicates the 1xRTT Reference Cell Id that consists of a Cell Identification Discriminator and a Cell Identification and shall be formatted according to octets 3 through the end of the Cell Identifier element defined in clause 4.2.17 in 3GPP2 A.S0014-D [22]. The allowable cell discriminator values are "0000 0010", and "0000 0111". + +### 7.4.60 Delayed-Location-Reporting-Data + +The Delayed-Location-Reporting-Data AVP is of type Grouped. + +AVP format: + +``` +Delayed-Location-Reporting-Data ::= + [ Termination-Cause ] + [ Serving-Node ] + *[ AVP ] +``` + +Serving-Node may be included only when the Termination-Cause is present indicating MT\_LR\_RESTART. + +The Serving-Node refers to the node where the UE has moved to and shall be included, if available. + +### 7.4.61 Civic-Address + +The Civic-Address AVP is of type UTF8String. It contains the XML document carried in the "Civic Address" Information Element as defined in 3GPP TS 29.171 [7]. + +### 7.4.62 Barometric-Pressure + +The Barometric-Pressure AVP is of type Unsigned32. It contains the "Barometric Pressure" Information Element as defined in 3GPP TS 29.171 [7]. + +### 7.4.63 UTRAN-Additional-Positioning-Data + +The UTRAN-Additional-Positioning-Data AVP is of type OctetString. It contains the "UTRAN Additional Positioning Data" Information Element as defined in 3GPP 25.413 [21]. + +### 7.4.64 Motion-Event-Info + +The Motion-Event-Info AVP is of type Grouped. + +AVP format: + +``` +Motion-Event-Info ::= + { Linear-Distance } + [ Occurrence-Info ] + [ Interval-Time ] + [ Maximum-Interval ] +``` + +[ Sampling-Interval ] + +[ Reporting-Duration ] + +[ Reporting-Location-Requirements ] + +\*[ AVP ] + +If not included, the default value of Occurrence-Info shall be considered as "ONE\_TIME\_EVENT" (0). Interval-Time and Maximum-Interval AVPs are only applicable when the Occurrence-Info is set to "MULTIPLE\_TIME\_EVENT" (1). If not included, the default value of Interval-Time shall be considered as one and the default values of Maximum-Interval, Sampling-Interval and Reporting-Duration shall each be considered as the maximum value. The Motion-Event-Info AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.65 Linear-Distance + +The Linear-Distance AVP is of type Unsigned32 and it contains the minimum linear (straight line) distance for motion event reports, in meters. The minimum value shall be 1 and maximum value shall be 10,000. The Linear-Distance AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.66 Maximum-Interval + +The Maximum-Interval AVP is of type Unsigned32 and it contains the maximum time interval between consecutive event reports, in seconds. The minimum value shall be 1 second and the maximum value 86400 seconds. The Maximum-Interval AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.67 Sampling-Interval + +The Sampling-Interval AVP is of type Unsigned32 and it contains the maximum time interval between consecutive evaluations by a UE of an area event or motion event, in seconds. The minimum value shall be 1 second and the maximum value 3600 seconds. The Sampling-Interval AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.68 Reporting-Duration + +The Reporting-Duration AVP is of type Unsigned32 and it contains the maximum duration of event reporting, in seconds. Its minimum value shall be 1 and maximum value shall be 8640000. The Reporting-Duration AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.69 Reporting-Location-Requirements + +The Reporting-Location-Requirements AVP is of type Unsigned32 and it shall contain a bit string indicating requirements on location provision for a deferred EPC-MT-LR. When a bit is set to one, the corresponding requirement is present. When a bit is set to zero or when the AVP is omitted, the corresponding requirement is not present. For support of backward compatibility, a receiver shall ignore any bits that are set to one but are not supported + +The meaning of the bits shall be as defined in table 7.4.69/1: + +**Table 7.4.69/1: Reporting-Location-Requirements** + +| Bit | Requirement | Description | +|------|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Location-Estimate | A location estimate is required for each area event, motion event report or expiration of the maximum time interval between event reports. | +| 1-31 | None | Spare | + +### 7.4.70 Additional-Area + +The Additional-Area AVP is of type Grouped. + +AVP format: + +``` +Additional-Area ::= + { Area-Type } + { Area-Identification } + *[ AVP ] +``` + +#### 7.4.7.1 AMF-Instance-Id + +The AMF-Instance-Id AVP is of type UTF8String and contain the AMF Instance ID. It is coded as the NfInstanceId according to clause 5.3.2-1, in 3GPP TS 29.571 [26]. + +## 7.5 Result-Code AVP and Experimental-Result AVP Values + +### 7.5.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 7.5.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [23] shall be applied. + +### 7.5.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [23] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 7.5.3.1 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the MME/SGSN to indicate that the user is unknown. This error code is defined in 3GPP TS 29.229 [17] + +#### 7.5.3.2 DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_NETWORK (5490) + +This result code shall be sent by the MME/SGSN to indicate that the requesting GMLC's network is not authorized to request UE location information. This error code is defined in 3GPP TS 29.173 [18] + +### 7.5.4 Transient Failures + +Errors that fall within the transient failures category are those used to inform a peer that the request could not be satisfied at the time that it was received. The request may be able to be satisfied in the future. + +#### 7.5.4.1 DIAMETER\_ERROR\_UNREACHABLE\_USER (4221) + +This result code shall be sent by the MME/SGSN to indicate that the user could not be reached in order to perform positioning procedure. + +#### 7.5.4.2 DIAMETER\_ERROR\_SUSPENDED\_USER (4222) + +This result code shall be sent by the MME/SGSN to indicate that the user is suspended in the MME. + +#### 7.5.4.3 DIAMETER\_ERROR\_DETACHED\_USER (4223) + +This result code shall be sent by the MME/SGSN to indicate that the user is detached in the MME. + +#### 7.5.4.4 DIAMETER\_ERROR\_POSITIONING\_DENIED (4224) + +This result code shall be sent by the MME/SGSN to indicate that the positioning procedure was denied. + +#### 7.5.4.5 DIAMETER\_ERROR\_POSITIONING\_FAILED (4225) + +This result code shall be sent by the MME/SGSN to indicate that the positioning procedure failed. + +#### 7.5.4.6 DIAMETER\_ERROR\_UNKNOWN\_UNREACHABLE LCS\_CLIENT (4226) + +This result code shall be sent by the GMLC to indicate that the LCS Client was not known or could not be reached. + +# Annex A (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|--------|-----------|------|-----|-----|----------------------------------------------------------------------------------------|--------| +| 2010-03 | CT-47 | CP-100055 | | | | 3GPP TS presented for approval in CT#47 | 9.0.0 | +| 2010-06 | CT-48 | CP-100286 | 0001 | | | Velocity-Requested IE | 9.1.0 | +| 2010-09 | CT-49 | CP-100463 | 0002 | 1 | | Addition of Command Codes | 9.2.0 | +| 2010-09 | CT-49 | CP-100463 | 0003 | 1 | | Notification Verification Only in Location Type | | +| 2010-09 | CT-49 | CP-100463 | 0004 | 1 | | SLg for Inter Domain Scenarios | | +| 2010-09 | CT-49 | CP-100463 | 0005 | | | Editorial Updates | | +| 2010-09 | CT-49 | CP-100463 | 0007 | | | Definition of EUTRAN-Positioning-Data | | +| 2010-12 | CT-50 | CP-100681 | 0009 | | | Clarification of LCS-priority AVP | 9.3.0 | +| 2010-12 | CT-50 | CP-100681 | 0010 | | | Correction of error code assignment | | +| 2010-12 | CT-50 | CP-100681 | 0011 | | | Correction of bit numbering in Horizontal and Vertical Accuracy IEs in SLg | | +| 2010-12 | CT-50 | CP-100681 | 0012 | | | Units of Age of Location Estimate IE in SLg | | +| 2011-03 | CT-51 | CP-110054 | 0013 | 1 | | Add missing Vendor Specific Application Id | 9.4.0 | +| 2011-03 | CT-51 | CP-110054 | 0014 | 2 | | Essential correction on the value type of the ELP Application AVPs | | +| 2011-03 | | | | | | Update to Rel-10 version (MCC) | 10.0.0 | +| 2011-09 | CT-53 | CP-110565 | 0015 | 2 | | Correction to references | 10.1.0 | +| 2012-09 | CT-57 | | | | | Update to Rel-11 version (MCC) | 11.0.0 | +| 2013-03 | CT-59 | CP-130156 | 0016 | 1 | | Definition of Lgd interface between SGSN and GMLC (Clause 1, 3, 4, 5) | 12.0.0 | +| 2013-03 | CT-59 | CP-130156 | 0017 | 1 | | Definition of Lgd interface between SGSN and GMLC (Clause 2, 6, 7) | | +| 2013-06 | CT-60 | CP-130291 | 0018 | 2 | | Support of deferred MT-LR and periodic MO-LR TTTP procedures over Lgd interface | 12.1.0 | +| 2013-09 | CT-61 | CP-130458 | 0019 | 1 | | Addressing the editor's note of the Location-Event AVP | 12.2.0 | +| 2013-12 | CT-62 | CP-130631 | 0024 | 1 | | Adding E-SMLC provided Cell info and Cell Portion | 12.3.0 | +| 2013-12 | CT-62 | CP-130624 | 0023 | 3 | | Optimized LCS procedure between GMLC and combined MME/SGSN | | +| 2014-03 | CT-63 | CP-140032 | 0025 | 2 | | E-SMLC provided Cell info and Cell Portion | 12.4.0 | +| 2015-03 | CT-67 | CP-150015 | 0031 | - | | Renaming of Location-Type AVP | 12.5.0 | +| 2015-03 | CT-67 | CP-150018 | 0027 | 1 | | Location reporting in emergency 1xSRVCC | | +| 2015-12 | CT-70 | CP-150776 | 0032 | 1 | | EPC-MT-LR and PS-MT-LR procedure for UEs transiently not reachable due to power saving | 13.0.0 | +| 2015-12 | CT-70 | CP-150776 | 0034 | 2 | | Indoor Positioning support in SLg/Lgd | | +| 2016-06 | CT-72 | CP-160226 | 0035 | 1 | | Delayed Location Reporting Data in Subscriber Location Report | 13.1.0 | +| 2017-03 | CT#75 | CP-170036 | 0037 | 1 | | Bit ordering in Diameter AVPs used as bit-masks | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0038 | - | | Update of reference for the Diameter base protocol | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0039 | - | | Handling of the Vendor-Specific-Application-Id AVP | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0040 | 1 | | Cardinality of the Failed-AVP AVP in answer | 14.0.0 | +| 2017-06 | CT#76 | CP-171030 | 0036 | 3 | | Enhancements to Location Services for CLoT | 14.1.0 | +| 2018-03 | CT#79 | CP-180016 | 0041 | 1 | | Deferred location for the UE availability event with EPC Access | 14.2.0 | +| 2018-06 | CT#80 | - | - | - | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2019-09 | CT#85 | CP-192095 | 0042 | 1 | | Addition of High Accuracy location estimates | 15.1.0 | +| 2019-12 | CT#86 | CP-193018 | 0046 | - | | Missing AVPs in Provide-Location-Request Command | 15.2.0 | +| 2019-12 | CT#86 | CP-193022 | 0048 | - | | Motion-Event-Info AVP | 15.2.0 | +| 2020-07 | CT#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | +| 2022-03 | CT#95e | CP-220085 | 0049 | 1 | F | High Accuracy GAD Shape with Scalable Uncertainty | 16.1.0 | +| 2022-03 | CT#95e | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 | +| 2022-09 | CT#97e | CP-222022 | 0050 | - | B | Diameter message priority over SLg and Lgd | 18.0.0 | +| 2023-06 | CT#100 | CP-231031 | 0052 | 1 | B | Support of Location service bi-directional continuity from EPS to 5GS | 18.1.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29500/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29500/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..015c8267d46cf4da13380056056b02ac35f03d48 --- /dev/null +++ b/raw/rel-18/29_series/29500/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:24871118debb5d4656eb78371b0001446acf735a8900127c489098e49c03b5a3 +size 9419 diff --git a/raw/rel-18/29_series/29500/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29500/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fb5c10146673d603cddd74e4dcaeec7f6743b88d --- /dev/null +++ b/raw/rel-18/29_series/29500/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f3a43598fc9364f01429d93e8cfc1221019726feff7053e1d9c870474c7bd84a +size 5660 diff --git a/raw/rel-18/29_series/29500/66c2bf11a8f117cddf67eff92d4c736c_img.jpg b/raw/rel-18/29_series/29500/66c2bf11a8f117cddf67eff92d4c736c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dafa061daf102f50aaf24980257451caa1599bbc --- /dev/null +++ b/raw/rel-18/29_series/29500/66c2bf11a8f117cddf67eff92d4c736c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:685b3158bcf1d7950f69c63b420cf9deadf143a8e1c10cedcf147ab6f310bc68 +size 12709 diff --git a/raw/rel-18/29_series/29500/b2a75beaa7e485cd651c2a83b30a4adc_img.jpg b/raw/rel-18/29_series/29500/b2a75beaa7e485cd651c2a83b30a4adc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4c9981e6fabfd09a15548dc1cf5756cbd7705b18 --- /dev/null +++ b/raw/rel-18/29_series/29500/b2a75beaa7e485cd651c2a83b30a4adc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae3f141a824a44685efb73dc62ec8fb59c26426d92ecd4fb66229b32a887d103 +size 41379 diff --git a/raw/rel-18/29_series/29500/raw.md b/raw/rel-18/29_series/29500/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e82e64990a71b863a2017cb845efae777c4a38c5 --- /dev/null +++ b/raw/rel-18/29_series/29500/raw.md @@ -0,0 +1,5580 @@ + + +# 3GPP TS 29.500 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Technical Realization of Service Based Architecture; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------|----| +| Foreword ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions and abbreviations ..... | 11 | +| 3.1 Definitions..... | 11 | +| 3.2 Abbreviations ..... | 12 | +| 3.3 Special characters, operators and delimiters ..... | 12 | +| 3.3.1 General ..... | 12 | +| 3.3.2 ABNF operators..... | 12 | +| 3.3.3 URI – reserved and special characters..... | 12 | +| 3.3.4 SBI specific usage of delimiters..... | 12 | +| 4 Service Based Architecture Overview ..... | 13 | +| 4.1 NF Services ..... | 13 | +| 4.2 Service Based Interfaces ..... | 13 | +| 4.3 NF Service Framework ..... | 13 | +| 4.3.1 General ..... | 13 | +| 4.3.2 NF Service Advertisement URI..... | 13 | +| 5 Protocols Over Service Based Interfaces ..... | 14 | +| 5.1 Protocol Stack Overview..... | 14 | +| 5.2 HTTP/2 Protocol ..... | 14 | +| 5.2.1 General ..... | 14 | +| 5.2.2 HTTP standard headers ..... | 14 | +| 5.2.2.1 General..... | 14 | +| 5.2.2.2 Mandatory to support HTTP standard headers ..... | 15 | +| 5.2.3 HTTP custom headers ..... | 17 | +| 5.2.3.1 General..... | 17 | +| 5.2.3.2 Mandatory to support custom headers ..... | 18 | +| 5.2.3.2.1 General ..... | 18 | +| 5.2.3.2.2 3gpp-Sbi-Message-Priority ..... | 23 | +| 5.2.3.2.3 3gpp-Sbi-Callback..... | 23 | +| 5.2.3.2.4 3gpp-Sbi-Target-apiRoot ..... | 24 | +| 5.2.3.2.5 3gpp-Sbi-Routing-Binding..... | 24 | +| 5.2.3.2.6 3gpp-Sbi-Binding..... | 25 | +| 5.2.3.2.7 3gpp-Sbi-Discovery ..... | 29 | +| 5.2.3.2.8 3gpp-Sbi-Producer-Id..... | 30 | +| 5.2.3.2.9 3gpp-Sbi-Oci ..... | 31 | +| 5.2.3.2.10 3gpp-Sbi-Lci..... | 33 | +| 5.2.3.2.11 3gpp-Sbi-Client-Credentials..... | 35 | +| 5.2.3.2.12 3gpp-Sbi-Nrf-Uri..... | 36 | +| 5.2.3.2.13 3gpp-Sbi-Target-Nf-Id ..... | 37 | +| 5.2.3.2.14 3gpp-Sbi-Max-Forward-Hops ..... | 37 | +| 5.2.3.2.15 3gpp-Sbi-Originating-Network-Id ..... | 38 | +| 5.2.3.2.16 3gpp-Sbi-Access-Scope ..... | 38 | +| 5.2.3.2.17 3gpp-Sbi-Access-Token..... | 39 | +| 5.2.3.2.18 Void..... | 39 | +| 5.2.3.2.19 3gpp-Sbi-Target-Nf-Group-Id..... | 39 | +| 5.2.3.2.20 3gpp-Sbi-Nrf-Uri-Callback ..... | 39 | +| 5.2.3.2.21 3gpp-Sbi-NF-Peer-Info ..... | 40 | +| 5.2.3.2.22 3gpp-Sbi-Source-NF-Client-Credentials..... | 40 | +| 5.2.3.3 Optional to support custom headers..... | 41 | +| 5.2.3.3.1 General ..... | 41 | +| 5.2.3.3.2 3gpp-Sbi-Sender-Timestamp ..... | 44 | +| 5.2.3.3.3 3gpp-Sbi-Max-Rsp-Time ..... | 44 | +| 5.2.3.3.4 3gpp-Sbi-Correlation-Info..... | 44 | + +| | | | +|------------|------------------------------------------------------------------------|----| +| 5.2.3.3.5 | 3gpp-Sbi-Alternate-Chf-Id ..... | 46 | +| 5.2.3.3.6 | 3gpp-Sbi-Notif-Accepted-Encoding ..... | 46 | +| 5.2.3.3.7 | 3gpp-Sbi-Consumer-Info ..... | 46 | +| 5.2.3.3.8 | 3gpp-Sbi-Response-Info..... | 48 | +| 5.2.3.3.9 | Void..... | 49 | +| 5.2.3.3.10 | 3gpp-Sbi-Selection-Info ..... | 49 | +| 5.2.3.3.11 | 3gpp-Sbi-Interplmn-Purpose..... | 50 | +| 5.2.3.3.12 | 3gpp-Sbi-Request-Info ..... | 50 | +| 5.2.3.3.13 | 3gpp-Sbi-Retry-Info ..... | 52 | +| 5.2.3.3.14 | 3gpp-Sbi-Other-Access-Scopes ..... | 52 | +| 5.2.4 | HTTP error handling ..... | 53 | +| 5.2.4 | HTTP error handling ..... | 53 | +| 5.2.5 | HTTP/2 server push..... | 53 | +| 5.2.6 | HTTP/2 connection management..... | 53 | +| 5.2.7 | HTTP status codes..... | 54 | +| 5.2.7.1 | General..... | 54 | +| 5.2.7.2 | NF as HTTP Server..... | 55 | +| 5.2.7.3 | NF as HTTP Client ..... | 60 | +| 5.2.7.4 | SCP/SEPP ..... | 61 | +| 5.2.8 | HTTP/2 request retries ..... | 64 | +| 5.2.9 | Handling of unsupported query parameters..... | 65 | +| 5.2.10 | URL Encoding of data ..... | 66 | +| 5.2.10.1 | General..... | 66 | +| 5.2.10.2 | URL Encoding of URI components..... | 66 | +| 5.2.10.3 | URL Encoding of HTTP/2 request bodies..... | 67 | +| 5.3 | Transport Protocol..... | 67 | +| 5.4 | Serialization Protocol..... | 68 | +| 5.5 | Interface Definition Language ..... | 68 | +| 6 | General Functionalities in Service Based Architecture ..... | 68 | +| 6.1 | Routing Mechanisms..... | 68 | +| 6.1.1 | General ..... | 68 | +| 6.1.2 | Identifying a target resource ..... | 68 | +| 6.1.3 | Connecting inbound..... | 68 | +| 6.1.4 | Pseudo-header setting..... | 69 | +| 6.1.4.1 | General..... | 69 | +| 6.1.4.2 | Routing within a PLMN ..... | 69 | +| 6.1.4.3 | Routing across PLMN ..... | 69 | +| 6.1.4.3.1 | General ..... | 69 | +| 6.1.4.3.2 | Use of telescopic FQDN between NFs and SEPP within a PLMN ..... | 70 | +| 6.1.4.3.3 | Use of 3gpp-Sbi-Target-apiRoot between NFs and SEPP within a PLMN..... | 70 | +| 6.1.4.3.4 | Routing between SEPPs..... | 71 | +| 6.1.5 | Host header..... | 71 | +| 6.1.6 | Message forwarding ..... | 71 | +| 6.2 | Server-Initiated Communication ..... | 72 | +| 6.2.1 | General ..... | 72 | +| 6.2.2 | Subscription on behalf of NF Service Consumer ..... | 72 | +| 6.2.3 | Notification error handling ..... | 73 | +| 6.3 | Load Control ..... | 73 | +| 6.3.1 | General ..... | 73 | +| 6.3.2 | Load Control based on load signalled via the NRF..... | 73 | +| 6.3.3 | Load Control based on LCI Header..... | 74 | +| 6.3.3.1 | General..... | 74 | +| 6.3.3.2 | Conveyance of Load Control Information..... | 74 | +| 6.3.3.3 | Frequency of Conveyance ..... | 75 | +| 6.3.3.4 | Load Control Information..... | 75 | +| 6.3.3.4.1 | General Description..... | 75 | +| 6.3.3.4.2 | Load Control Timestamp ..... | 75 | +| 6.3.3.4.3 | Load Metric ..... | 76 | +| 6.3.3.4.4 | Scope of LCI ..... | 76 | +| 6.3.3.4.5 | S-NSSAI/DNN Relative Capacity ..... | 78 | +| 6.3.3.5 | LC-H feature support..... | 78 | + +| | | | +|-----------|----------------------------------------------------------------------|-----| +| 6.3.3.5.1 | Indicating supports for the LC-H feature ..... | 78 | +| 6.3.3.5.2 | Utilizing the LC-H feature support indication ..... | 78 | +| 6.4 | Overload Control..... | 78 | +| 6.4.1 | General ..... | 78 | +| 6.4.2 | Overload Control based on HTTP status codes..... | 79 | +| 6.4.2.1 | General..... | 79 | +| 6.4.2.2 | HTTP Status Code "503 Service Unavailable"..... | 79 | +| 6.4.2.3 | HTTP Status Code "429 Too Many Requests"..... | 80 | +| 6.4.2.4 | HTTP Status Code "307 Temporary Redirect"..... | 80 | +| 6.4.3 | Overload Control based on OCI Header..... | 80 | +| 6.4.3.1 | General..... | 80 | +| 6.4.3.2 | Conveyance of Overload Control Information ..... | 81 | +| 6.4.3.3 | Frequency of Conveyance ..... | 81 | +| 6.4.3.4 | Overload Control Information ..... | 81 | +| 6.4.3.4.1 | General Description..... | 81 | +| 6.4.3.4.2 | Overload Control Timestamp..... | 82 | +| 6.4.3.4.3 | Overload Reduction Metric..... | 83 | +| 6.4.3.4.4 | Overload Control Period of Validity ..... | 83 | +| 6.4.3.4.5 | Scope of OCI..... | 83 | +| 6.4.3.5 | Overload Control Enforcement..... | 87 | +| 6.4.3.5.1 | Message Throttling..... | 87 | +| 6.4.3.5.2 | Loss Algorithm..... | 88 | +| 6.4.3.6 | OLC-H feature support ..... | 88 | +| 6.4.3.6.1 | Indicating supports for the OLC-H feature ..... | 88 | +| 6.5 | Support of Stateless NFs ..... | 88 | +| 6.5.1 | General ..... | 88 | +| 6.5.2 | Stateless AMFs..... | 88 | +| 6.5.2.1 | General..... | 88 | +| 6.5.2.2 | AMF as service consumer..... | 88 | +| 6.5.2.3 | AMF as service producer..... | 89 | +| 6.5.3 | Stateless NFs (for any 5GC NF type)..... | 90 | +| 6.5.3.1 | General..... | 90 | +| 6.5.3.2 | Stateless NF as service consumer ..... | 90 | +| 6.5.3.3 | Stateless NF as service producer ..... | 92 | +| 6.6 | Extensibility Mechanisms ..... | 93 | +| 6.6.1 | General ..... | 93 | +| 6.6.2 | Feature negotiation ..... | 93 | +| 6.6.3 | Vendor-specific extensions ..... | 94 | +| 6.6.4 | Extensibility for Query parameters..... | 95 | +| 6.7 | Security Mechanisms ..... | 96 | +| 6.7.1 | General ..... | 96 | +| 6.7.2 | Transport layer security protection of messages ..... | 96 | +| 6.7.3 | Authorization of NF service access ..... | 96 | +| 6.7.4 | Application layer security across PLMN ..... | 97 | +| 6.7.4.1 | General..... | 97 | +| 6.7.4.2 | N32 Procedures..... | 97 | +| 6.7.5 | Client credentials assertion and authentication ..... | 98 | +| 6.7.5.1 | General..... | 98 | +| 6.7.5.2 | Authorization of NF Service Consumers for data access via DCCF ..... | 98 | +| 6.8 | SBI Message Priority Mechanism..... | 99 | +| 6.8.1 | General ..... | 99 | +| 6.8.2 | Message level priority ..... | 99 | +| 6.8.3 | Stream priority ..... | 99 | +| 6.8.4 | Recommendations when defining SBI Message Priorities ..... | 99 | +| 6.8.5 | HTTP/2 client behaviour ..... | 100 | +| 6.8.6 | HTTP/2 server behaviour ..... | 101 | +| 6.8.7 | HTTP/2 proxy behaviour..... | 101 | +| 6.8.8 | DSCP marking of messages ..... | 101 | +| 6.9 | Discovering the supported communication options ..... | 101 | +| 6.9.1 | General ..... | 101 | +| 6.9.2 | Discoverable communication options ..... | 102 | +| 6.9.2.1 | Content-encodings supported in HTTP requests ..... | 102 | + +| | | | +|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| 6.9.2.2 | Content-encodings supported in HTTP responses..... | 102 | +| 6.10 | Support of Indirect Communication..... | 102 | +| 6.10.1 | General ..... | 102 | +| 6.10.2 | Routing Mechanisms with SCP Known to the NF ..... | 103 | +| 6.10.2.1 | General..... | 103 | +| 6.10.2.2 | HTTP/2 connection management ..... | 103 | +| 6.10.2.3 | Connecting inbound..... | 103 | +| 6.10.2.4 | Pseudo-header setting ..... | 103 | +| 6.10.2.5 | 3gpp-Sbi-Target-apiRoot header setting..... | 105 | +| 6.10.2.6 | Cache key (ck) query parameter ..... | 106 | +| 6.10.2A | Routing Mechanism with SCP Unknown to the NF ..... | 106 | +| 6.10.2A.1 | Connecting inbound..... | 106 | +| 6.10.2A.2 | HTTP/2 connection management ..... | 106 | +| 6.10.2A.3 | Pseudo-header setting ..... | 106 | +| 6.10.3 | NF Discovery and Selection for indirect communication with Delegated Discovery ..... | 107 | +| 6.10.3.1 | General..... | 107 | +| 6.10.3.2 | Conveyance of NF Discovery Factors ..... | 107 | +| 6.10.3.3 | Notifications corresponding to default notification subscriptions ..... | 108 | +| 6.10.3.4 | Returning the Producer's NF Instance ID and NF Group ID to the NF Service Consumer ..... | 108 | +| 6.10.3.5 | Returning an Alternate CHF instance ID to the NF Service Consumer ..... | 109 | +| 6.10.4 | Authority and/or deployment-specific string in apiRoot of resource URI..... | 110 | +| 6.10.5 | NF / NF service instance selection for Indirect Communication without Delegated Discovery ..... | 110 | +| 6.10.5.1 | General..... | 110 | +| 6.10.5.2 | Notifications corresponding to default notification subscriptions..... | 112 | +| 6.10.6 | Feature negotiation for Indirect Communication with Delegated Discovery..... | 112 | +| 6.10.7 | Notification and callback requests sent with Indirect Communication..... | 113 | +| 6.10.8 | Error Handling ..... | 113 | +| 6.10.8.1 | General..... | 113 | +| 6.10.8.2 | Requirements for the originator of an HTTP error response ..... | 114 | +| 6.10.8.3 | Requirements for an SCP or SEPP relaying an HTTP error response..... | 115 | +| 6.10.9 | HTTP redirection..... | 115 | +| 6.10.9.1 | General..... | 115 | +| 6.10.10 | Detection and handling of loop path when relaying message with indirect communication ..... | 116 | +| 6.10.10.1 | General..... | 116 | +| 6.10.10.2 | Message Forwarding Depth Control..... | 116 | +| 6.10.10.3 | Loop Detection with Via header..... | 116 | +| 6.10.11 | Authorization of NF service access ..... | 117 | +| 6.10.11.1 | General..... | 117 | +| 6.10.11.2 | Authorization for indirect communication with delegated discovery ..... | 117 | +| 6.10.11.2.1 | General ..... | 117 | +| 6.10.11.2.2 | Error handling when the SCP fails to obtain an access token..... | 118 | +| 6.10.11.2.2A | Error handling when the SCP obtains an access token without all the scopes required for access authorization of the incoming service request ..... | 119 | +| 6.10.11.2.3 | Error handling when SCP receives a "401 Unauthorized" response or a "403 Forbidden" response with a "WWW-Authenticate" header..... | 119 | +| 6.10.11.3 | Authorization for indirect communication without delegated discovery ..... | 119 | +| 6.11 | Detection and handling of late arriving requests..... | 120 | +| 6.11.1 | General ..... | 120 | +| 6.11.2 | Detection and handling of requests which have timed out at the HTTP client..... | 120 | +| 6.11.2.1 | General..... | 120 | +| 6.11.2.2 | Principles ..... | 120 | +| 6.12 | Binding between an NF Service Consumer and an NF Service Resource..... | 120 | +| 6.12.1 | General ..... | 120 | +| 6.12.2 | Binding created as part of a service response..... | 123 | +| 6.12.3 | Binding created as part of a service request ..... | 123 | +| 6.12.4 | Binding for explicit or implicit subscription requests ..... | 124 | +| 6.12.5 | Binding for service requests creating a callback resource..... | 126 | +| 6.13 | SBI messages correlation for network troubleshooting ..... | 126 | +| 6.13.1 | General ..... | 126 | +| 6.13.2 | SBI messages correlation using UE identifier..... | 126 | +| 6.13.2.1 | General..... | 126 | +| 6.13.2.2 | Principles ..... | 127 | + +| | | | +|-------------------------------|------------------------------------------------------------------|------------| +| 6.13.3 | SBI messages correlation using NF Peer Information ..... | 127 | +| 6.13.3.1 | General..... | 127 | +| 6.13.3.2 | Principles ..... | 127 | +| 6.14 | Indicating the purpose of Inter-PLMN signaling ..... | 128 | +| 6.14.1 | General ..... | 128 | +| 6.14.2 | Inclusion of the intended purpose..... | 128 | +| 6.14.3 | Evaluating the intended purpose ..... | 128 | +| Annex A (informative): | Client-side Adaptive Throttling for Overload Control..... | 129 | +| Annex B (normative): | 3gpp-Sbi-Callback Types..... | 130 | +| Annex C (informative): | Internal NF Routing of HTTP Requests ..... | 131 | +| Annex D (Normative): | ABNF grammar for 3GPP SBI HTTP custom headers..... | 132 | +| D.1 | General..... | 132 | +| D.2 | ABNF definitions (Filename: "TS29500_CustomHeaders.abnf")..... | 133 | +| Annex E (informative): | Change history..... | 143 | + +# Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the technical realization of the 5GC Service Based Architecture, protocols supported over the Service Based Interfaces, and the functionalities supported in the Service Based Architecture. + +The service requirements for the 5G system are defined in 3GPP TS 22.261 [2]. The system architecture requirements are defined in 3GPP TS 23.501 [3] and the procedures and flows in 3GPP TS 23.502 [4]. + +The design principles and documentation guidelines for 5GC SBI APIs are specified in 3GPP TS 29.501 [5]. + +# --- 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 22.261: "Service requirements for the 5G system; Stage 1". +- [3] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [4] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] IETF RFC 793: "Transmission Control Protocol". +- [7] IETF RFC 9113: "HTTP/2". +- [8] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [9] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [10] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [11] IETF RFC 9110: "HTTP Semantics". +- [12] Void. +- [13] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [14] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". + +- [15] 3GPP TS 23.003: "Numbering, addressing and identification". +- [16] IETF RFC 5681: "TCP Congestion Control". +- [17] 3GPP TS 33.501: "Security Architecture and Procedures for 5G System". +- [18] IANA: "SMI Network Management Private Enterprise Codes", . +- [19] IETF RFC 7944: "Diameter Routing Message Priority". +- [20] IETF RFC 9111: " HTTP Caching". +- [21] Void. +- [22] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [23] IETF RFC 6750: "The OAuth 2.0 Authorization Framework: Bearer Token Usage". +- [24] Void. +- [25] IETF RFC 7516: "JSON Web Encryption (JWE)". +- [26] IETF RFC 7515: "JSON Web Signature (JWS)". +- [27] 3GPP TS 29.573: "5G System: Public Land Mobile Network (PLMN) Interconnection; Stage 3". +- [28] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". +- [29] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [30] Void. +- [31] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [32] 3GPP TS 29.531: "5G System; Network Slice Selection Services; Stage 3". +- [33] Void. +- [34] IETF RFC 1952: "GZIP file format specification version 4.3". +- [35] 3GPP TS 29.525: "5G System; UE Policy Control Service; Stage 3". +- [36] IETF RFC 3040: "Internet Web Replication and Caching Taxonomy". +- [37] IETF RFC 5322: "Internet Message Format". +- [38] 3GPP TS 23.527: "5G System; Restoration Procedures". +- [39] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3". +- [40] 3GPP TS 29.515: "5G System; GMLC Services; Stage 3". +- [41] IETF RFC 7519: "JSON Web Token (JWT)". +- [42] 3GPP TS 32.291: "5G System; charging service; Stage 3". +- [43] IETF RFC 5234: "Augmented BNF for Syntax Specifications: ABNF". +- [44] 3GPP TS 29.526: "5G System; Network Slice-Specific Authentication and Authorization (NSSAA) Services; Stage 3". +- [45] 3GPP TS 29.562: " 5G System; Home Subscriber Server (HSS) Services for interworking with the IP Multimedia Subsystem (IMS); Stage 3". +- [46] 3GPP TS 29.555: "5G System; 5G Direct Discovery Name Management Services; Stage 3". +- [47] IETF RFC 4122: "A Universally Unique Identifier (UUID) URN Namespace". + +- [48] IETF RFC 1866: "Hypertext Markup Language - 2.0". +- [49] IETF RFC 1738: "Uniform Resource Locators (URL)". + +# --- 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], 3GPP TS 23.501 [3] 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]. + +**Binding indication (consumer):** Binding can be used by the NF Service Consumer to indicate suitable NF Service Consumer instance(s) for notification target instance selection, reselection and routing of subsequent notification requests associated with a specific notification subscription. Binding indication needs to be stored by the NF Service Producer. Binding indication may also be used later if the NF Service Consumer starts acting as NF Service Producer, so that service requests can be sent to this NF Service Producer. See clauses 3.1 and 6.3.1.0 in 3GPP TS 23.501 [3]. See also **Routing binding indication**. + +**Binding indication (producer):** Binding can be used to indicate suitable target NF Service Producer instance(s) for an NF service instance selection, reselection and routing of subsequent requests associated with a specific NF Service Producer resource (context) and NF service. Binding allows the NF Service Producer to indicate to the NF Service Consumer if a particular context should be bound to an NF service instance, NF instance, NF service set or NF set. Binding indication needs to be stored by the NF Service Consumer. See clauses 3.1 and 6.3.1.0 in 3GPP TS 23.501 [3]. See also **Routing binding indication**. + +**Binding entity:** Either of the following identifiers: NF Service Instance, NF Service Set, NF Instance or an NF Set. The relation between these are explained below. + +**Binding entity ID:** An identification of a binding entity, i.e. NF Service Instance ID, NF Service Set ID, NF Instance ID or an NF set ID. + +**Binding level:** A parameter (bl) in "3gpp-Sbi-Routing-Binding" and "3gpp-Sbi-Binding" HTTP custom headers, which indicates the binding entity towards which a preferred binding exists (i.e. either to NF Service Instance, NF Service Set, NF Instance or an NF Set). Other binding entities in these headers, which do not correspond to the binding level indicate alternative binding entities that can be reselected and that share the same resource contexts (see Table 6.3.1.0-1 in 3GPP TS 23.501 [3]). + +**Callback URI:** URI to be used by an NF Service Producer to send notification or callback requests. + +**Endpoint address:** An address in the format of an IP address, transport and port information, or FQDN, which is used to determine the host/authority part of the target URI. This Target URI is used to access an NF service (i.e. to invoke service operations) of an NF service producer or for notifications to an NF service consumer. See clauses 3.1 and 6.3.1.0 of 3GPP TS 23.501 [3]. + +**NF Instance:** An identifiable instance of the NF. An NF Instance may provide services offered by one or more NF Service instances. + +**NF Service Instance:** An identifiable instance of the NF service. + +**NF Service Set:** A group of interchangeable NF service instances of the same service type within an NF instance. The NF service instances in the same NF Service Set have access to the same context data. + +**NF Set:** A group of interchangeable NF instances of the same type, supporting the same services and the same Network Slice(s). The NF instances in the same NF Set may be geographically distributed but have access to the same context data. + +**Notification endpoint:** Notification endpoint is a destination URI of the network entity where the notification is sent. See clause 6.3.1.0 in 3GPP TS 23.501 [3]. + +**Routing binding indication:** Information included in a request or notification and that can be used by the SCP for discovery and associated selection to of a suitable target. See clauses 3.1, 6.3.1.0 and 7.1.2 in 3GPP TS 23.501 [3]. + +Routing binding indication has similar syntax as a binding indication, but it has different purpose. Routing binding indication provides the receiver (i.e. SCP) with information enabling to route an HTTP request to an HTTP server that can serve the request. Routing binding indication is not stored by the receiver. + +## 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]. + +| | | +|-------|--------------------------------------| +| GZIP | GNU ZIP | +| LC-H | Load Control based on LCI Header | +| LCI | Load Control Information | +| MCX | Mission Critical Service | +| MPS | Multimedia Priority Service | +| OCI | Overload Control Information | +| OLC-H | Overload Control based on OCI Header | +| SCP | Service Communication Proxy | +| SEPP | Security and Edge Protection Proxy | +| SMP | SBI Message Priority | + +## 3.3 Special characters, operators and delimiters + +### 3.3.1 General + +A number of characters have special meaning and are used as delimiters in this document and also in other stage 3 SBI specifications. Below clauses specify the usage of a selected set of the special characters. Full set of these special characters are specified in the respective IETF specifications. + +### 3.3.2 ABNF operators + +| | | +|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| / | Operator. The forward slash character separates alternatives. See clause 3.2 in IETF RFC 5234 [43]. | +| # | Operator. The number sign character allows for compact definition of comma-separated lists, similar to the "*" operator. See clause 2.1 in IETF RFC 9110 [11]. | +| = | Special character. The equal sign character separates an ABNF rule name from the rule elements. See clause 2.2 in IETF RFC 5234 [43]. | +| [] | Operator. The square bracket characters enclose an optional element sequence. See clause 3.8 in IETF RFC 5234 [43]. | +| <> | Special characters. The angle bracket characters typically enclose an ABNF rule element (they are optional). See clause 2.1 in IETF RFC 5234 [43]. | +| * | Operator. The star character precedes an element and indicates the elements repetition. See clause 3.6 in IETF RFC 5234 [43]. | +| ; | Operator. Semicolon character indicates the start of a comment that continues to the end of line. See clause 3.9 in IETF RFC 5234 [43]. | + +NOTE: The same characters, like "/", "#", etc. lead to different processing in ABNF and URI grammars. For instance, in URI syntax, ";" character separates parameter and its value, while in ABNF ";" starts a comment. Besides, unlike URI syntax, neither "?", nor ":" operators are specified for ABNF. + +### 3.3.3 URI – reserved and special characters + +Special characters that are used as delimiters in URI syntax have somewhat different purpose from the same characters when used by ABNF syntax. See clause 3.3.3 in 3GPP TS 29.501 [5]. + +### 3.3.4 SBI specific usage of delimiters + +See clause 3.3.4 in 3GPP TS 29.501 [5]. + +# 4 Service Based Architecture Overview + +## 4.1 NF Services + +3GPP TS 23.501 [3] defines the 5G System Architecture as a Service Based Architecture, i.e. a system architecture in which the system functionality is achieved by a set of NFs providing services to other authorized NFs to access their services. + +Control Plane (CP) Network Functions in the 5G System architecture shall be based on the service based architecture. + +A NF service is one type of capability exposed by a NF (NF Service Producer) to other authorized NF (NF Service Consumer) through a service based interface. A NF service may support one or more NF service operation(s). See clause 7 of 3GPP TS 23.501 [3]. + +Network Functions may offer different functionalities and thus different NF services. Each of the NF services offered by a Network Function shall be self-contained, acted upon and managed independently from other NF services offered by the same Network Function (e.g. for scaling, healing). + +## 4.2 Service Based Interfaces + +A service based interface represents how the set of services is provided or exposed by a given NF. This is the interface where the NF service operations are invoked. + +The service based Control Plane interfaces within the 5G Core Network are specified in 3GPP TS 23.501 [3]. + +## 4.3 NF Service Framework + +### 4.3.1 General + +The Service Based Architecture shall support the NF Service Framework that enable the use of NF services as specified in clause 7.1 of 3GPP TS 23.501 [3]. + +The NF Service Framework includes the following mechanisms: + +- NF service registration and de-registration: to make the NRF aware of the available NF instances and supported services (see clause 7.1.5 of 3GPP TS 23.501 [3]); +- NF service discovery: to enable a NF Service Consumer to discover NF Service Producer instance(s) which provide the expected NF service(s) (see clause 7.1.3 of 3GPP TS 23.501 [3]); +- NF service authorization: to ensure the NF Service Consumer is authorized to access the NF service provided by the NF Service Producer (see clause 7.1.4 of 3GPP TS 23.501 [3]); +- Inter service communication: NF Service Consumers and NF Service Producers may communicate directly or indirectly via a Service Communication Proxy (SCP). Whether a NF uses Direct Communication or Indirect Communication via an SCP is based on configuration of the NF. + +The stage 3 procedures for NF service registration and de-registration, NF service discovery and NF service authorization are defined in 3GPP TS 29.510 [8]. + +### 4.3.2 NF Service Advertisement URI + +When invoking a service operation of a NF Service Producer that use HTTP methods with a message body (i.e. PUT, POST and PATCH), the NF Service Consumer may provide NF Service Advertisement URI(s) in the service operation request, based on operator policy, if it expects that the NF Service Producer may subsequently consume NF service(s) which the NF Service Consumer can provide (as a NF Service Producer). + +When receiving NF Service Advertisement URI(s) in a service operation request, the NF Service Producer may store and use the Service Advertisement URI(s) to discover NF services produced by the NF Service Consumer in subsequent procedures, based on operator policy. + +The NF Service Advertisement URI identifies the nfInstance resource(s) in the NRF which are registered by NF Service Producer(s). + +An example of NF Service Advertisement URI could be represented as: + +"{apiRoot}/nnrf-disc/nf-instances?nfInstanceId={nfInstanceId}". + +NOTE: The NF Service Advertisement URI can be used e.g. when different NRFs are deployed in the PLMN. + +When applicable, the NF Service Advertisement URI(s) shall be carried in HTTP message body. + +# 5 Protocols Over Service Based Interfaces + +## 5.1 Protocol Stack Overview + +The protocol stack for the service-based interfaces is shown on Figure 5.1-1. + +![Figure 5.1-1: SBI Protocol Stack diagram showing a vertical stack of six layers: Application, HTTP/2, TLS, TCP, IP, and L2.](66c2bf11a8f117cddf67eff92d4c736c_img.jpg) + +| | +|-------------| +| Application | +| HTTP/2 | +| TLS | +| TCP | +| IP | +| L2 | + +Figure 5.1-1: SBI Protocol Stack diagram showing a vertical stack of six layers: Application, HTTP/2, TLS, TCP, IP, and L2. + +Figure 5.1-1: SBI Protocol Stack + +The service-based interfaces use HTTP/2 protocol (see clause 5.2) with JSON (see clause 5.4) as the application layer serialization protocol. For the security protection at the transport layer, all 3GPP NFs shall support TLS and TLS shall be used within a PLMN if network security is not provided by other means, as specified in 3GPP TS 33.501 [17]. + +## 5.2 HTTP/2 Protocol + +### 5.2.1 General + +HTTP/2 as described in IETF RFC 9113 [7] shall be used in Service based interface. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +This clause lists the HTTP standard headers that shall be supported on SBI, other HTTP standard headers defined in IETF RFCs may be supported by NF. + +#### 5.2.2.2 Mandatory to support HTTP standard headers + +The HTTP request standard headers and the HTTP response standard headers that shall be supported on SBI are defined in Table 5.2.2.2-1 and in Table 5.2.2.2-2 respectively. Mandatory to support HTTP standard headers does not mean all the HTTP requests and responses carry the identified request and response headers respectively. It only means it is mandatory to support the processing of the identified headers in request and response message. + +**Table 5.2.2.2-1: Mandatory to support HTTP request standard headers** + +| Name | Reference | Description | +|-------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Accept | IETF RFC 9110 [11] | This header is used to specify response media types that are acceptable. | +| Accept-Encoding | IETF RFC 9110 [11] | This header may be used to indicate what response content-encodings (e.g. gzip) are acceptable in the response. | +| Content-Length | IETF RFC 9110 [11] | This header is used to provide the anticipated size, as a decimal number of octets, for a potential content. | +| Content-Type | IETF RFC 9110 [11] | This header is used to indicate the media type of the associated representation. | +| Content-Encoding | IETF RFC 9110 [11] | This header may be used in some requests to indicate the content encodings (e.g. gzip) applied to the resource representation beyond those inherent in the media type. | +| User-Agent | IETF RFC 9110 [11] |

This header shall be mainly used to identify the NF type of the HTTP/2 client. This header should be included in every HTTP/2 request sent over any SBI; This header shall be included in every HTTP/2 request sent using indirect communication when target NF (re-)selection is to be performed at SCP.

For Indirect communications, the User-Agent header in a request that is:

  • - forwarded by the SCP (with or without delegated discovery) shall identify the NF type of the original NF that issued the request (i.e. the SCP shall forward the header received in the incoming request);
  • - originated by the SCP towards the NRF (e.g. NF Discovery or Access Token Request) shall identify the SCP.

The pattern of the content should start with the value of NF type (e.g. "UDM", see NOTE 1) or "SCP" (for a request originated by an SCP) and followed by a "-" and any other specific information if needed afterwards.

| +| Cache-Control | IETF RFC 9111 [20] | This header may be used in some HTTP/2 requests to provide the HTTP cache-control directives that the client is willing to accept from the server. | +| If-Modified-Since | IETF RFC 9110 [11] | This header may be used in a conditional GET request, for server revalidation. This is used in conjunction with the Last-Modified server response header, to fetch content only if the content has been modified from the cached version. | +| If-None-Match | IETF RFC 9110 [11] | This header may be used in a conditional GET request. This is used in conjunction with the ETag server response header, to fetch content only if the tag value of the resource on the server differs from the tag value in the If-None-Match header. | +| If-Match | IETF RFC 9110 [11] | This header may be used in a conditional POST or PUT or DELETE or PATCH request. This is used in conjunction with the ETag server response header, to update / delete content only if the tag value of the resource on the server matches the tag value in the If-Match header. | +| Via | IETF RFC 9110 [11] | This header shall be inserted by HTTP proxies and it shall be inserted by an SCP and SEPP when relaying an HTTP request. When inserted by an SCP or SEPP, the header field value should be formatted as defined for the Via header in Table 5.2.2.2-2. | +| Authorization | IETF RFC 9110 [11] | This header shall be used if OAuth 2.0 based access authorization with "Client Credentials" grant type is used as specified in clause 13.4.1 of 3GPP TS 33.501 [17], clause 7 of IETF RFC 6749 [22] and IETF RFC 6750 [23]. | + +NOTE 1: The value of NF type in the User-Agent header shall comply with the enumeration value of Table 6.1.6.3.3-1 in 3GPP TS 29.510 [8]. + +**Table 5.2.2.2-2: Mandatory to support HTTP response standard headers** + +| Name | Reference | Description | +|------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Content-Length | IETF RFC 9110 [11] | This header may be used to provide the anticipated size, as a decimal number of octets, for a potential content. | +| Content-Type | IETF RFC 9110 [11] | This header shall be used to indicate the media type of the associated representation. | +| Location | IETF RFC 9110 [11] | This header may be used in some responses to refer to a specific resource in relation to the response. | +| Retry-After | IETF RFC 9110 [11] | This header may be used in some responses to indicate how long the user agent ought to wait before making a follow-up request. | +| Content-Encoding | IETF RFC 9110 [11] | This header may be used in some responses to indicate to the HTTP/2 client the content encodings (e.g. gzip) applied to the resource representation beyond those inherent in the media type. | +| Cache-Control | IETF RFC 9111 [20] | This header may be used in some responses (e.g. NRF responses to queries) to provide HTTP response cache control directives. The cache directives "no-cache", "no-store", "max-age" and "must-revalidate" values shall be supported. | +| Age | IETF RFC 9111 [20] | This header may be inserted by HTTP proxies when returning a cached response. The "Age" header field conveys the sender's estimate of the amount of time since the response was generated or successfully validated at the origin server. The presence of an Age header field implies that the response was not generated or validated by the origin server for this request. | +| Last-Modified | IETF RFC 9110 [11] | This header may be sent to allow for conditional GET with the If-Modified-Since header. | +| ETag | IETF RFC 9110 [11] | This header may be sent to allow for conditional GET with the If-None-Match header or a conditional POST / PUT / PATCH / DELETE with the If-Match header. | +| Via | IETF RFC 9110 [11] | This header shall be inserted by HTTP proxies.
This header shall be inserted by an SCP or SEPP when relaying an HTTP error response (see clause 6.10.8). It may be inserted when relaying other HTTP responses.
When inserted by an SCP or SEPP, the received-protocol portion of the header field value should be set to "HTTP/2.0" or "2.0" and the received-by portion of the header field value should be formatted as follows:
- "SCP-" for an SCP
- "SEPP-" for a SEPP

See examples in clause 6.10.8. | +| Allow | IETF RFC 9110 [11] | This header field shall be used to indicate methods supported by the target resource. | +| WWW-Authenticate | IETF RFC 9110 [11] | This header field shall be included when an NF service producer rejects a request with a "401 Unauthorized" status code (e.g. when a request is sent without an OAuth 2.0 access token or with an invalid OAuth 2.0 access token). | +| Accept-Encoding | IETF RFC 9110 [11] | See clause 6.9 for the use of this header. | +| Server | IETF RFC 9110 [11] | This header should be inserted by the originator of an HTTP error response (see clause 6.10.8). It may be inserted otherwise. When inserted by an NF, an SCP or a SEPP, the pattern of the header should be formatted as follows:
- "SCP-" for an SCP
- "SEPP-" for a SEPP
- "-" for an NF | + +### 5.2.3 HTTP custom headers + +#### 5.2.3.1 General + +The list of custom HTTP headers applicable to 3GPP Service Based NFs are specified below. + +The ABNF definition of these custom headers is expressed in the following clauses using common syntax components defined in IETF RFC 9110 [11], clauses 5.6.2 - 5.6.5, such as and . As indicated there, the following characters (expressed by their UNICODE name) shall not be used as part of a , or as a : + +- QUOTATION MARK (U+0022): " +- LEFT PARENTHESIS (U+0028): ( +- RIGHT PARENTHESIS (U+0029): ) +- COMMA (U+002C): , +- SOLIDUS (U+002F): / +- COLON (U+003A): : +- SEMICOLON (U+003B): ; +- LESS-THAN SIGN (U+003C): < +- EQUALS SIGN (U+003D): = +- GREATER-THAN SIGN (U+003E): > +- QUESTION MARK (U+003F): ? +- COMMERCIAL AT (U+0040): @ +- LEFT SQUARE BRACKET (U+005B): [ +- REVERSE SOLIDUS (U+005C): \ +- RIGHT SQUARE BRACKET (U+005D): ] +- LEFT CURLY BRACKET (U+007B): { +- RIGHT CURLY BRACKET (U+007D): } + +If a 3GPP custom HTTP header, whose ABNF syntax definition uses the or components, needs to include a value containing a character outside of the character set allowed for or , such character shall be encoded using percent-encoding, as follows: + +pct-encoded = "%" HEXDIG HEXDIG + +The HEXDIG ABNF production rule, originally defined in IETF RFC 5234 [43], shall be considered as if the uppercase hexadecimal digits 'A' through 'F' are equivalent to the lowercase digits 'a' through 'f', respectively. + +The literal "%" character shall also be encoded as above (i.e. %25). + +Percent encoding shall not be used for characters that are in the or allowed character set. + +EXAMPLE: 3GPP Custom Header "3gpp-Sbi-Oci" (see clause 5.2.3.2.9) can include an optional parameter "snssai". If this parameter takes the value: + +``` +{"sst": 1, "sd": "A08923"} +``` + +it will be formatted, when included in this custom header, as: + +``` +S-NSSAI: %7B%22sst%22%3A%201%2C%20%22sd%22%3A%20%22A08923%22%7D +``` + +#### 5.2.3.2 Mandatory to support custom headers + +##### 5.2.3.2.1 General + +The 3GPP NF Services shall support the HTTP custom headers specified in Table 5.2.3.2.1-1 below. A description of each custom header and the normative requirements on when to include them are also provided in Table 5.2.3.2-1. + +**Table 5.2.3.2.1-1: Mandatory HTTP custom headers** + +| Name | Reference | Description | +|---------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3gpp-Sbi-Message-Priority | Clause 5.2.3.2.2 | This header is used to specify the HTTP/2 message priority for 3GPP service based interfaces. This header shall be included in HTTP/2 messages when a priority for the message needs to be conveyed (e.g. HTTP/2 messages related to Multimedia Priority Sessions). | +| 3gpp-Sbi-Callback | Clause 5.2.3.2.3 | This header is used to indicate if a HTTP/2 message is a callback (e.g. notification).
This header shall be included in HTTP POST messages for callbacks towards NF service consumer(s) in another PLMN via the SEPP (See 3GPP TS 29.573 [27]).
This header shall also be included in HTTP POST messages for callbacks in indirect communication (See clause 6.10.7).
This header should also be included in the HTTP POST message of any event notification request for direct communications.

If the header is included in received HTTP request, the SEPP or SCP shall include this header in the HTTP request forwarded to next hop. (NOTE 1) | +| 3gpp-Sbi-Target-apiRoot | Clause 5.2.3.2.4 | This header is used by an HTTP client to indicate the apiRoot of the target URI when communicating indirectly with the HTTP server via an SCP. This header is also used by SCP to indicate the apiRoot of the target URI, if a new HTTP server is selected or reselected and there is no Location header included in the response.
This header may also be used by an HTTP client towards its local SEPP to indicate the apiRoot of the target URI towards HTTP server in another PLMN.
This header may also be used between SEPPs to indicate the apiRoot of the target URI towards HTTP server in another PLMN, when TLS security with the 3gpp-Sbi-Target-apiRoot header is used between the SEPPs. | +| 3gpp-Sbi-Routing-Binding | Clause 5.2.3.2.5 | This header is used in a service request to signal binding information to direct the service request to an HTTP server which has the targeted NF Service Resource context (see clause 6.12). | +| 3gpp-Sbi-Binding | Clause 5.2.3.2.6 | This header is used to signal binding information related to an NF Service Resource to a future consumer (HTTP client) of that resource (see clause 6.12). | +| 3gpp-Sbi-Discovery-* | Clause 5.2.3.2.7 | Headers beginning with the prefix 3gpp-Sbi-Discovery- are used in indirect communication mode to allow the discovery and selection of a suitable NF service producer (e.g. in case of service requests) or NF service consumer (e.g. in case of notifications or callbacks) by the SCP, as specified in clause 5.2.3.2.7, clause 6.5.3 and clause 6.10. Such headers may be included in any SBI message and include information allowing an SCP to find a suitable NF service producer or NF service consumer, as per the discovery and selection parameters provided respectively by the NF service consumer or the NF service producer. | +| 3gpp-Sbi-Producer-Id | Clause 5.2.3.2.8 | This header is used in a service response from the SCP to the NF Service Consumer, when using indirect communication, to identify the NF service producer. See clause 6.10.3.4.

This header may also be used in a resource creation response from the NF Service Producer to the NF consumer (or SCP), when the resource is created in a different NF Service Producer (e.g. UE Context Create with AMF relocation during inter-PLMN N2 handover procedure). | + +| | | | +|---------------------------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3gpp-Sbi-Oci | Clause 5.2.3.2.9 |

This header may be used by an overloaded NF Service Producer in a service response, or in a notification request to signal Overload Control Information (OCI) to the NF Service Consumer.

This header may also be used by an overloaded NF Service Consumer in a notification response or in a service request to signal Overload Control Information (OCI) to the NF Service Producer.

| +| 3gpp-Sbi-Lci | Clause 5.2.3.2.10 |

This header may be used by a NF Service Producer to send Load Control Information (LCI) to the NF Service Consumer.

| +| 3gpp-Sbi-Client-Credentials | Clause 5.2.3.2.11 |

This header may be used by an NF Service Consumer to send Client Credentials Assertion to the NRF or to the NF Service Producer. See clause 6.7.5.

| +| 3gpp-Sbi-Source-NF-Client-Credentials | Clause 5.2.3.2.22 |

This header may be used by an NF Service Consumer (e.g., DCCF) to send Client Credentials Assertion of the source NF (e.g. NWDAF) to the NF Service Producer (e.g. AMF, SMF). The purpose is to enable the authorization of NF service consumers for data access via DCCF as specified in Annex X of 3GPP TS 33.501 [17]. See clause 6.7.5.

| +| 3gpp-Sbi-Nrf-Uri | Clause 5.2.3.2.12 |

This header may be used to indicate the NRF API URIs to be used for a given service request, e.g. in indirect communication with delegated discovery as a result of an NSSF query. It may also indicate whether OAuth2 based authorization is required for accessing the NRF services.

This header may also be used to indicate the NRF API URI to be used for a given notification request, e.g. if the NF service producer has received NRF API URI from the NF service consumer and the NF producer delegates NF consumer reselection to the SCP in indirect communication,

| +| 3gpp-Sbi-Target-Nf-Id | Clause 5.2.3.2.13 |

This header is used in a 307 Temporary Redirect or 308 Permanent Redirect response, to identify the target NF (service) instance towards which the request is redirected. See clause 6.10.9.1.

| +| 3gpp-Sbi-Max-Forward-Hops | Clause 5.2.3.2.14 |

This header may be used to indicate the maximum number of allowed hops with specified node type to relay the request message to the target HTTP server.

If node type is "scp", its value indicates the maximum number of allowed SCP hops to relay the request message to the target NF as HTTP server when indirect communication is used.

| + +| | | | +|---------------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3gpp-Sbi-Originating-Network-Id | Clause 5.2.3.2.15 |

This header shall be inserted by an NF service consumer or an NF service producer originating an HTTP request message towards a different PLMN or SNPN.

It should be inserted by the sending SCP in SBI HTTP request messages towards the SEPP, only if the header is not present in the SBI HTTP request message and the SCP can determine which PLMN-ID value should be included in the header.

It shall be inserted by the sending SEPP or the receiving SEPP in SBI HTTP request messages towards the target PLMN or SNPN, only if the header is not present in the SBI HTTP request message and the sending SEPP or the receiving SEPP (respectively) can determine the PLMN ID or SNPN ID of the source PLMN or SNPN.

If the SEPP cannot uniquely determine the PLMN-ID or SNPN-ID, it is a configuration/deployment aspect to determine which PLMN-ID or SNPN-ID value should be included in the header by these entities. In such case, the message should either be dropped, or the SEPP shall indicate to the peer that the header is derived based on configuration

It shall indicate the PLMN-ID or the SNPN-ID of the source PLMN or SNPN of the HTTP request message (i.e., the PLMN ID or the SNPN ID of the NF Service Consumer or NF Service Producer).

See clause 5.9.3.2 of 3GPP TS 33.501 [17] for the handling of this header by the sending NF, the sending SCP, the sending SEPP and the receiving SEPP. (NOTE 2)

| +| 3gpp-Sbi-Access-Scope | Clause 5.2.3.2.16 |

This header is used in a service request for Indirect Communication to indicate the access scope of the service request for NF service access authorization. See clauses 6.7.3 and 6.10.11.

| +| 3gpp-Sbi-Access-Token | Clause 5.2.3.2.17 |

This header is used in a service response forwarded by the SCP to an NF service consumer to provide an access token for possible re-use in subsequent service requests. See clause 6.10.1.

| +| 3gpp-Sbi-Target-Nf-Group-Id | Clause 5.2.3.2.19 |

This header is used in a service response from the SCP to the NF Service Consumer, when using indirect communication with delegated discovery, to indicate the NF Group ID of the NF service producer selected by the SCP. See clause 6.10.3.4.

| +| 3gpp-Sbi-Nrf-Uri-Callback | Clause 5.2.3.2.20 |

This header may be included in service request (e.g. subscription creation request) from the NF service consumer to the NF service producer, to indicate:

  • - the NRF NFDiscovery API URI to be used to discover an alternative NF service consumer for callback, e.g. during NF service consumer reselection for callback when the original NF service consumer is no longer available; and
  • - if available, the NRF NFManagement API URI to be used to subscribe to NF status change of the NF service consumer.

For indirect communication, if the NF service producer delegates NF service consumer reselection to the SCP, the NF service producer should include 3gpp-Sbi-Nrf-Uri header with received NRF API URI (which was received in the 3gpp-Sbi-Nrf-Uri-Callback from the NF service consumer) in the notification requests to the NF service consumer.

| + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3gpp-Sbi-NF-Peer-Info | Clause 5.2.3.2.21 |

This header is used in HTTP requests and responses to indicate the sender and receiver of the message.

The HTTP client and server should include this header in every HTTP request and response messages.

HTTP intermediaries (e.g. SCP) should forward this header, when relaying HTTP messages to next hop, and may update the destination in the header if the receiver NF of the message is (re)selected. The parameters defined for the source and destination of SCPs or SEPPs (as defined in clause 5.2.3.2.21) may also need to be updated according to the source and destination of the HTTP message.

| +| NOTE 1: The callback URI for event subscription may receive event notifications from different NF producers, e.g. UDM may subscribe to AMF/SMF on behalf of NEF with directly reporting mode for certain UDM events in the subscription, which should be inspected with corresponding OpenAPI schema where the notification is defined. For both direct and indirect communications, to include this header in all event notification requests can help NF consumer to identify the type of event notification and select corresponding schema to perform OpenAPI inspection. | | | +| NOTE 2: The value of this header shall be verified by the sending SEPP and receiving SEPP (see clause 5.9.3.2 of 3GPP TS 33.501 [17]) | | | + +##### 5.2.3.2.2 3gpp-Sbi-Message-Priority + +The header contains the HTTP/2 message priority value from 0 to 31, as defined in clause 6.8.4. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Message-Priority-Header = "3gpp-Sbi-Message-Priority:" OWS ( DIGIT / %x31-32 DIGIT / "3" %x30-31 ) OWS +``` + +A message with 3gpp-Sbi-Message-Priority "0" has the highest priority. + +EXAMPLE: 3gpp-Sbi-Message-Priority: 10 + +##### 5.2.3.2.3 3gpp-Sbi-Callback + +The header contains the type of notification. The value for the notification type is a string used identifying a particular type of callback (e.g. a notification, typically the name of the notify service operation). + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Callback-Header = "3gpp-Sbi-Callback:" OWS cbtype *( ";" OWS "apiversion=" majorversion ) OWS +cbtype = 1*cbchar +cbchar = "-" / "_" / DIGIT / ALPHA +majorversion = *DIGIT +``` + +EXAMPLE 1: 3gpp-Sbi-Callback: Nnrf\_NFManagement\_NFStatusNotify + +EXAMPLE 2: 3gpp-Sbi-Callback: Nudm\_SDM\_Notification; apiversion=2 + +The list of valid values for the cbtype is specified in Annex B. + +The apiversion parameter should be present if the major version is higher than 1. + +NOTE: The apiversion parameter can be used by the SEPP to identify the protection and modification policies applicable to the API version of a notification or callback request, or by the SCP to select a notification endpoint of a NF Service Consumer that supports the API version when forwarding a notification request issued for a default notification subscription. + +##### 5.2.3.2.4 3gpp-Sbi-Target-apiRoot + +The header contains the apiRoot of the target URI (see clause 4.4 of 3GPP TS 29.501 [5]) in a request sent to an SCP when using Indirect Communication. This header contains the apiRoot of the selected or changed target URI in a response sent to an HTTP client, when SCP selected or reselected a new HTTP server to route the request and no Location HTTP header is included in the HTTP response. It may also be used in a request sent to a SEPP and in a request between SEPPs (see clause 6.1.4.3.2). + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Target-apiRoot-Header = "3gpp-Sbi-Target-apiRoot" ":" OWS sbi-scheme "://" sbi-authority +[ prefix ] OWS + +sbi-scheme = "http" / "https" + +sbi-authority = host [ ":" port ] + +port = *DIGIT + +prefix = path-absolute ; path-absolute production rule from IETF RFC 3986, clause 3.3 +``` + +EXAMPLE: 3gpp-Sbi-Target-apiRoot: https://example.com/a/b/c + +##### 5.2.3.2.5 3gpp-Sbi-Routing-Binding + +This header contains a Routing Binding Indication used to direct a service request to an HTTP server which has the targeted NF service resource context (see clause 6.12). + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Routing-Binding-Header = "3gpp-Sbi-Routing-Binding:" OWS "bl=" blvalue 1*( ";" OWS parameter ) +[ ";" OWS callback-uri-prefix ] OWS +blvalue = "nf-instance" / "nf-set" / "nfservice-instance" / "nfservice-set" + +parameter = parametername "=" token + +parametername = "nfinst" / "nfset" / "nfservinst" / "nfserviceset" / "servname" / "backupamfinst" / +"backupnfinst" +``` + +The following parameters are defined: + +- bl (binding level): the value of this parameter (blvalue) indicates a preferred binding to a binding entity, i.e. either to an NF Instance, an NF set, an NF Service Instance or an NF Service Set. If the binding level is set to an NF Service Instance (nfservice-instance), then either NF Service Set ID or NF Instance ID shall also be present to unambiguously identify the NF Service Instance. +- nfinst (NF instance): indicates an NF Instance ID, as defined in clause 5.2.2.2.2 in 3GPP TS 29.510 [8]. This parameter shall be present if the binding level is set to "nf-instance", or if the binding level is set to "nfservice-instance" and the nfserviceset parameter is not included. +- nfset (NF set): indicates an NF Set ID, as defined in clause 28.12 in 3GPP TS 23.003 [15]. This parameter shall be present if the binding level is set to "nf-set". It may be present otherwise (see clause 6.12.1). +- nfservinst (NF service instance): indicates an NF Service Instance ID. This parameter shall be present if the binding level is set to "nfservice-instance". +- nfserviceset (NF service set): indicates an NF Service Set ID as defined in clause 28.13 in 3GPP TS 23.003 [15]. This parameter shall be present if the binding level is set to "nfservice-set". It shall also be present if the binding level is set to "nfservice-instance" and the NF service instance indicated by the nfservinst parameter is part of an NF service set (see clause 6.12.1). +- servname (service name): indicates the name of a service, as defined in 3GPP TS 29.510 [8], or a custom service that handles a notification or a callback request. It may be present in a Routing Binding Indication in a notification or a callback request. + +- backupamfirst (backup NF Instance): indicates the NF Instance ID (as defined in clause 5.2.2.2.2 in 3GPP TS 29.510 [8]) of the backup NF, i.e. the backup AMF as specified in 3GPP TS 23.501 [3]. The backupamfirst may be present only when the binding level is nf-instance or nfservice-instance or nfservice-set. When backupamfirst is present, no binding entity corresponding to NF set shall be present. When the binding level is nf-set, backupamfirst shall not be present. +- for the definition and encoding of the backupnf see clause 5.2.3.2.6. +- for the definition and encoding of the callback-uri-prefix see clause 5.2.3.2.6. The ABNF is defined in clause 5.2.3.3.7. + +See clause 5.6.2 of IETF RFC 9110 [11] for the "token" type definition. A token's value is a string, which contains a binding entity ID or a service name. + +EXAMPLE 1: Binding to SMF set 1 of MCC 345 and MNC 012: + +3gpp-Sbi-Routing-Binding: bl=nf-set; nfset=set1.smfset.5gc.mnc012.mcc345 + +EXAMPLE 2: Binding to an SMF instance within SMF set of Example 1: + +3gpp-Sbi-Routing-Binding: bl=nf-instance; nfinst=54804518-4191-46b3-955c-ac631f953ed8; nfset=set1.smfset.5gc.mnc012.mcc345 + +EXAMPLE 3: Binding to a SMF Service Set "xyz" within an SMF instance within SMF set of Example 1: + +3gpp-Sbi-Routing-Binding: bl=nfservice-set; nfserviceset=setxyz.snnsmf-pdusession.nfi54804518-4191-46b3-955c-ac631f953ed8.5gc.mnc012.mcc345; nfset=set1.smfset.5gc.mnc012.mcc345 + +EXAMPLE 4: Binding to AMF set 1 within AMF region 48 (hexadecimal): + +3gpp-Sbi-Routing-Binding: bl=nf-set; nfset=set1-region48.amfset.5gc.mnc012.mcc345 + +EXAMPLE 5: Binding for a subscription (i.e. notification requests) to AMF set 1 within AMF region 48 (hexadecimal) and Namf\_Communication service: + +3gpp-Sbi-Routing-Binding: bl=nf-set; nfset=set1-region48.amfset.5gc.mnc012.mcc345; servname=namf-comm + +EXAMPLE 6: Binding to the AMF Instance in addition with backup AMF, where the nfinst carries the Identity of the AMF to which the resource is bound and whose backup AMF is indicated in backupamfirst: +3gpp-Sbi-Routing-Binding: bl=nf-instance; nfinst=54804518-4191-46b3-955c-ac631f953ed7; backupamfirst=54804518-4191-46b3-955c-ac631f953ed8 + +##### 5.2.3.2.6 3gpp-Sbi-Binding + +This header contains a comma-delimited list of Binding Indications from an HTTP server for storage and subsequent use by an HTTP client (see clause 6.12). + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Binding-Header = "3gpp-Sbi-Binding:" OWS 1#( "bl=" blvalue 1*( ";" OWS parameter ) [ ";" OWS recoverytime ] [ ";" OWS notif-receiver ] [ ";" OWS "group=" groupvalue ] [ 1*( ";" OWS groupparameter ) ] [ ";" OWS "no-redundancy=" no-red-value ] [ ";" OWS "callback-uri-prefix" ] ) OWS + +blvalue = "nf-instance" / "nf-set" / "nfservice-instance" / "nfservice-set" + +parameter = parameternam "=" token + +parameternam = "nfinst" / "nfset" / "nfservinst" / "nfserviceset" / "servname" / "scope" / "backupamfirst" / "backupnf" + +recoverytime = "recoverytime=" OWS DQUOTE date-time DQUOTE + +notif-receiver = "nr=" URI ; URI production rule from IETF RFC 3986, Appendix A + +groupvalue = "true" / "false" + +groupparameter = groupparameternam "=" token +``` + +``` +groupparameternam = "oldgroupid" / "groupid" / "uribase" / "oldnfinst" / "oldservset" / +"oldservinst" / "guami" +no-red-value = "true" +``` + +The following parameters are defined: + +- **scope**: indicates the applicability of a Binding Indication in a service request other than a notification request, or in a notification or callback response. This may take one of the following values: + - "other-service": the binding information applies to other service(s) that the NF Service Consumer may later on provide as an NF Service Producer (see clause 6.12.3); + - "subscription-events": the binding information applies to subscription change event notifications (see clause 6.12.4); + - "callback": the binding information applies to notification or callback requests (see clauses 6.12.4 and 6.12.5). + +The absence of this parameter in a Binding Indication in a service request other than a notification request, or in a notification or callback response, shall be interpreted as "callback". + +Two scope parameters may be present in a Binding Indication if the binding information applies to notification/callback requests and to other services. + +- **servname** (service name): indicates the name of a service, as defined in 3GPP TS 29.510 [8], or a custom service, i.e.: + - the name of the service that handles a notification or a callback request, when present in a Binding Indication for a subscription or a callback, i.e. with a scope parameter absent or set to "callback"; or + - the name of the other service(s) for which the binding applies, when present in a Binding Indication in a service request for the other services the NF Service Consumer can provide later on as an NF Service Producer, i.e. with the scope parameter set to "other-service". More than one servname parameter may be present to represent multiple such services. The absence of this parameter in a Binding Indication with the scope parameter set to "other-service" shall be interpreted as binding information that applies to all the services that the NF Service Consumer may provide later as an NF Service Producer. +- **recoverytime**: indicates the recovery timestamp of the entity corresponding to the highest resiliency level supported for the resource, that is, the higher level binding entity indicated in the Binding Indication. See Table 6.3.1.0-1 of 3GPP TS 23.501 [3] and clause 6.1 of 3GPP TS 23.527 [38]. The date-time type is specified in IETF RFC 5322 [37] and clause 5.6.7 of IETF RFC 9110 [11]. +- **nr**: indicates the URI of the notification endpoint when this binding information is applicable; it applies to callback requests (see clause 6.12.4); if the notification URI does not contain a correlationID in the path (i.e. it is a common notification URI for multiple subscriptions), the correlationID shall be added as a fragment component of the URI (i.e. following the "#" character) at the end of the URI. +- for the definition and encoding of the blvalue, nfinst, backupamfinst, nffset, nfservinst and nfserviceset see clause 5.2.3.2.5. +- **backupnf**: indicates the backup NF service instance identifier and/or the backup NF identifier as defined in clause 5.2.2.2.2 or in 3GPP TS 29.510 [8], which shall be used when preferred binding entity is not reachable if supported. +- **group**: it is a boolean indicating if the binding indication is for a group of resource/session contexts. +- **groupid** (group id): indicates the group identifier allocated by the NF (service) instance, one or more resource/session contexts are sharing the same groupid. The groupid is optional and it may be allocated when the resource/session context is created and then be updated afterwards. The groupid is globally unique and it may be encoded using the same mechanism for the NFInstanceId as specified in 3GPP TS 29.571 [13]. +- **oldgroupid** (old group id): indicates the group identifier allocated by the NF (service) instance previously and to be replaced by the groupid, hence it shall only be present when to update a Binding Indication for multiple + +contexts. When the if the oldgroupid is present, the groupid shall also be present to indicate the new groupid allocated. + +- uribase: identify the apiroot and path segments part in the resource URI or notification/callback URI which is common to multiple contexts. This parameter may only be present when to update a Binding Indication for multiple contexts and when the "group" is set to "true". When included, it indicates that all resources or notification contexts with this uribase will use the updated Binding Indication subsequently. More than one uribase may be present. +- oldnfinst: indicates the NF Instance ID of the NF instance where the group of resource/session contexts are currently served (i.e. the Binding Indication allocated previously for the group of resource/session contexts includes the information of the NF instance), as defined in clause 5.2.2.2.2 in 3GPP TS 29.510 [8]. When included, it indicates that all the resource/session contexts served by this NF instance will use the updated Binding Indication subsequently. +- oldservset: indicates the NF Service Set ID of the NF Service Set where the group of resource/session contexts are currently served (i.e. the Binding Indication allocated previously for the group of resource/session contexts includes the information of the NF Service Set), as defined in clause 5.2.2.2.2 in 3GPP TS 29.510 [8]. When included, it indicates that all the resource/session contexts served by this NF Service Set will use the updated Binding Indication subsequently. +- oldservinst: indicates the NF Service Instance ID of the NF service instance where the group of resource/session contexts are currently served (i.e. the Binding Indication allocated previously for the group of resource/session contexts includes the information of the NF service instance), as defined in clause 5.2.2.2.2 in 3GPP TS 29.510 [8]. When included, it indicates that all the resource/session contexts served by this NF service instance will use the updated Binding Indication subsequently. +- guami (GUAMI): indicates the GUAMI of the AMF currently serving UE contexts, as defined in clause 5.3.4.1 of 3GPP TS 29.571 [13]. When included, it indicates that all the UE contexts associated with the GUMAI will use the updated Binding Indication subsequently. +- no-redundancy: it is a boolean set to true indicating that the resource is exclusively bound to the NF service instance identified in the binding indication. It may be present in a binding with any scope, i.e. "other-service", "subscription-events" or "callback", or with no scope parameter. When this parameter is present, the blvalue shall be set to "nfservice-instance", the nfinst parameter shall be present and either the nfserviceset parameter or the nfinst parameter shall be present. The nfserviceset or nfinst parameter included in the binding indication shall only be used to identify the NF service instance and shall not be considered as a binding entity for reselection. The no-redundancy parameter shall only be signaled if the receiver of this information is known to support this parameter (see clause 6.12.1). Subsequently, when sending further requests targeting a resource with no-redundancy, the HTTP client shall not include any routing binding indication in the request message (to prevent the SCP from performing any reselection). +- callback-uri-prefix: The NF service consumer may include this parameter when providing a Callback URI when the Callback URI contains a prefix. When present, the "callback-uri-prefix" shall be a path-absolute as specified IETF RFC 3986 [14] (i.e. the first path segment(s) after the authority) which is part of the Callback URI provided by a NF service consumer in the corresponding service request message sent to a NF service producer. The authority and "callback-uri-prefix" in the Callback URI shall uniquely identify a consumer service instance. This parameter is relevant when the "scope" parameter is either "subscription-events" or "callback". See clauses 6.12.4 and 6.12.5 for the usage of this parameter. The ABNF is defined in clause 5.2.3.3.7. + +EXAMPLES 1 to 5: Same as EXAMPLES 1 to 5 defined in clause 5.2.3.2.5, with the header name "3gpp-Sbi-Binding" instead of "3gpp-Sbi-Routing-Binding". + +EXAMPLE 6: Subscription request from one NF on behalf of another NF, with 2 binding indications: + +3gpp-Sbi-Binding: bl=nf-set; nffset=set1.udmset.5gc.mnc012.mcc345; servname=nudm-ee;scope=subscription-events +3gpp-Sbi-Binding: bl=nf-set; nffset=set1.nefset.5gc.mnc012.mcc345; servname=nnef-event-exposure + +EXAMPLE 7: Service request with 2 binding indications, for callback requests and for other services the NF Service Consumer may provide later as an NF Service Producer: + +3gpp-Sbi-Binding: bl=nf-instance; nfinst=54804518-4191-46b3-955c-ac631f953ed8; +nfset=set1.smfset.5gc.mnc012.mcc345; servname=nsmf-pdusession +3gpp-Sbi-Binding: bl=nf-instance; nfinst=54804518-4191-46b3-955c-ac631f953ed8; +nfset=set1.smfset.5gc.mnc012.mcc345; scope=other-service; servname=nsmf-event-exposure + +EXAMPLE 8: Service request with one binding indication applying to notification/callback requests and to any other services the NF Service Consumer may provide later as an NF Service Producer: + +3gpp-Sbi-Binding: bl=nf-set; nfset=set1-region48.amfset.5gc.mnc012.mcc345; scope=callback; +scope=other-service + +EXAMPLE 9: Service request with one binding indication applying to notification/callback requests together with a recovery time stamp associated with the NF Set indicated in the binding indication and with the binding level set to "nfset": +3gpp-Sbi-Binding: bl=nf-set; nfset=set1-region48.amfset.5gc.mnc012.mcc345; scope=callback; +recoverytime= "Tue, 04 Feb 2020 08:49:37 GMT" + +EXAMPLE 10: Service response with one binding indication applying to the session context with a recovery time stamp associated with the NF Set indicated in "nfset" in the binding indication and with the binding level set to "nfinstance": + +3gpp-Sbi-Binding: bl=nf-instance; nfinst=54804518-4191-46b3-955c-ac631f953ed8; +nfset=set1.smfset.5gc.mnc012.mcc345; recoverytime= "Tue, 04 Feb 2020 08:49:37 GMT" + +EXAMPLE 11: Service response with one binding indication applying to the session context with a recovery time stamp associated with the NF Instance included the binding indication and with the binding level set to nfserviceinstance: + +3gpp-Sbi-Binding: bl=nfservice-instance; nfservinst=xyz; nfinst=54804518-4191-46b3-955c-ac631f953ed8; recoverytime= "Tue, 04 Feb 2020 08:49:37 GMT" + +EXAMPLE 12: Service response with one binding indication applying to the resource context pertaining to a group identified by "54804518-4191-46b3-955c-ac631f953ed1" together with a backup nf: + +3gpp-Sbi-Binding: bl=nf-instance; nfinst=54804518-4191-46b3-955c-ac631f953ed0; +nfset=set1.smfset.5gc.mnc012.mcc345; backupnf=54804519-4191-46b3-955c-ac631f953ed2; +groupid=54804518-4191-46b3-955c-ac631f953ed1 + +EXAMPLE 13: A notification request message with one binding indication applying to the resource contexts with the oldgroup identifier "54804518-4191-46b3-955c-ac631f953ed1", where the preferred binding entity is changed to "nfinst=54804519-4191-46b3-955c-ac631f953ed0" together with a new group identifier "54804519-4191-46b3-955c-ac631f953ed3" allocated. + +3gpp-Sbi-Binding: bl=nf-instance; nfinst=54804519-4191-46b3-955c-ac631f953ed0; +nfset=set1.smfset.5gc.mnc012.mcc345; group=true; oldgroupid=54804518-4191-46b3-955c-ac631f953ed1; groupid=54804519-4191-46b3-955c-ac631f953ed3 + +EXAMPLE 14: A notification request message with one binding indication applying to the resource contexts identified by an uribase, where the preferred binding entity is changed to "nfinst=54804519-4191-46b3-955c-ac631f953ed0": + +3gpp-Sbi-Binding: bl=nf-instance; nfinst=54804519-4191-46b3-955c-ac631f953ed0; +nfset=set1.smfset.5gc.mnc012.mcc345; group=true; +uribase=http%3A%2F%2F10.10.10.10%2Fstringxyz + +EXAMPLE 15: A notification request message with one binding indication applying to the resource contexts served by the NF instance identified by "64804518-4191-46b3-955c-ac631f953ed8" where the preferred binding entity is changed to "ninst=74804519-4191-46b3-955c-ac631f953ed0". + +3gpp-Sbi-Binding: bl=nf-instance; ninst=74804519-4191-46b3-955c-ac631f953ed0; +nfset=set1.smfset.5gc.mnc012.mcc345; group=true; oldninst=64804518-4191-46b3-955c-ac631f953ed8 + +EXAMPLE 16: Service request message with an updated binding indication applying to the UE contexts for GUAMI" where the backupaminst is changed. + +3gpp-Sbi-Binding: bl=nf-instance; ninst=54804518-4191-46b3-955c-ac631f953ed7; +backupaminst=54804520-4191-46b3-955c-ac631f953ed8; scope=other-service; group=true; +guami=%7B%22plmnId%22%3A%7B%22mnc%22%3A%22012%22%2C%22mcc%22%3A%22345%22%7D%2C%22amfld%22%3A%22abcd12%22%7D + +EXAMPLE 17: Service response with a binding indication applying to the resource context which is exclusively bound to a specific NF service instance. + +3gpp-Sbi-Binding: bl=nfservice-instance; nfservinst=xyz; ninst=54804518-4191-46b3-955c-ac631f953ed8; no-redundancy=true + +EXAMPLE 18: Subscription request with a Callback URI containing a prefix "/abc": + +3gpp-Sbi-Binding: bl=nf-set; nfset=set1.nefset.5gc.mnc012.mcc345; servname=nnef-event-exposure; callback-uri-prefix="/abc" + +NOTE: Examples 6 and 7 are formatted as two distinct headers (which improves the readability), but they can also be formatted as a single header with two Binding Indication values separated by a comma. + +##### 5.2.3.2.7 3gpp-Sbi-Discovery + +These headers shall be used to convey NF service discovery factors to the SCP in indirect communication models. They contain discovery parameters to be conveyed by an NF service consumer or an NF service producer to the SCP or by an SCP to the next hop SCP and they shall be used by the SCP to select or reselect a suitable NF service producer instance to create or update a (existing) resource context, or a suitable NF service consumer instance towards which to send a notification or a callback request, e.g. by performing the NF service discovery procedure with the NRF on behalf of the NF consumer in case of indirect communication with delegated discovery model. + +The name of each NF service discovery factors header shall be constructed by concatenating the string "3gpp-Sbi-Discovery-" with the name of the conveyed discovery parameter, i.e. "3gpp-Sbi-Discovery-". + +The discovery headers shall be used to include any of the discovery query parameters listed in 3GPP TS 29.510 [8], Table 6.2.3.2.3.1-1. The value of each NF service discovery header shall be encoded in the same way as the corresponding discovery parameter (i.e. with the same data type, cardinality and format). Thus, the values of these headers may be validated with the same data model as that of the corresponding discovery parameters. The discovery headers shall comply with the condition of presence of the discovery parameters defined in Table 6.2.3.2.3.1-1 of 3GPP TS 29.510 [8], e.g. discovery headers shall be included for discovery parameters defined as mandatory in this table. Table 5.2.3.2.7-1 lists examples of NF service discovery headers. + +**Table 5.2.3.2.7-1: NF service discovery factors headers examples** + +| Header name | Discovery parameter | Header value | Data Model | +|------------------------------------------|------------------------------------------------------------|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------| +| 3gpp-Sbi-Discovery-target-nf-type | target-nf-type (TS 29.510 [8], Table 6.2.3.2.3.1-1) | AMF | NFType: Enumeration as of TS 29.510 [8], Table 6.1.6.3.3-1. | +| 3gpp-Sbi-Discovery-snssais | snssais (TS 29.510 [8], Table 6.2.3.2.3.1-1) | [{"sst": 1, "sd": "A08923"}, {"sst": 1, "sd": "0023F1"}] | array(Snssai), where Snssai is a structured data type as of TS 29.571 [13], Table 5.4.4.2-1 | +| 3gpp-Sbi-Discovery-target-nf-instance-id | target-nf-instance-id (TS 29.510 [8], Table 6.2.3.2.3.1-1) | e553cf50-f32b-4638-8a7e-0d416cc60952 | NfInstanceId: simple data type as of TS 29.571 [13], Table 5.3.2-1 | +| 3gpp-Sbi-Discovery-pdu-session-types | pdu-session-types (TS 29.510 [8], Table 6.2.3.2.3.1-1) | IPv6,IPv4V6 | array(PduSessionType), where PduSessionType is a simple data type as of TS 29.571 [13], Table 5.4.3.3-1. | + +The 3gpp-Sbi-Discovery-\* header is not documented in OpenAPI specification files. It shall comply with the following OpenAPI definition: + +- for parameters defined with a "content:" block and specifying the "application/json" media type" in clause A.3 of 3GPP TS 29.510 [8]: + +``` +parameters: + - name: 3gpp-Sbi-Discovery-: + in: header + description: Discovery parameter defined in Table 6.2.3.2.3.1-1 of 3GPP TS 29.510 + content: + application/json: + schema: + type: +``` + +- for other parameters: + +``` +parameters: + - name: 3gpp-Sbi-Discovery-: + in: header + description: Discovery parameter defined in Table 6.2.3.2.3.1-1 of 3GPP TS 29.510 + schema: + type: +``` + +3gpp-Sbi-Discovery-\* headers corresponding to query parameters defined with the "style" keyword set to "form" and the "explode" keyword set to false in clause A.3 of 3GPP TS 29.510 [8] shall be formatted using the style "simple", i.e. as comma-separated values. + +NOTE 1: The style "form" is not available for header parameters, thus the corresponding 3gpp-Sbi-Discovery-\* headers use the default style "simple" defined for header parameters in the OpenAPI Specification [9]. + +NOTE 2: The percent-encoding described in clause 5.2.3.1 is not applicable to the 3gpp-Sbi-Discovery-\* headers since their syntax is not defined using ABNF; such encoding is only applicable to headers whose ABNF syntax is defined in terms of and common components. + +##### 5.2.3.2.8 3gpp-Sbi-Producer-Id + +This header contains the NF Service Producer Instance ID (see clause 6.10.3.4). + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Producer-Id-Header = "3gpp-Sbi-Producer-Id:" OWS "nfinst=" nfinst [ OWS ";" OWS "nfservinst=" +nfsvinst ] [ OWS ";" OWS "nfset=" nfset ] [ OWS ";" OWS "nfserviceset=" nfserviceset ] OWS +``` + +``` + +nfinst = 8HEXDIG "-" 4HEXDIG "-" 4HEXDIG "-" 4HEXDIG "-" 12HEXDIG +nfservinst = token +nfset = token +nfserviceset = token + +``` + +The following parameters are defined: + +- nfinst (NF instance): indicates a NF Instance ID, as defined in 3GPP TS 29.510 [8]; +- nfservinst (NF service instance): indicates a NF Service Instance ID, as defined in 3GPP TS 29.510 [8]; +- nfset (NF set): indicates an NF Set ID, as defined in clause 28.12 in 3GPP TS 23.003 [15]; +- nfserviceset (NF service set): indicates an NF Service Set ID as defined in clause 28.13 in 3GPP TS 23.003 [15]. + +EXAMPLE 1: 3gpp-Sbi-Producer-Id: nfinst=54804518-4191-46b3-955c-ac631f953ed8 + +EXAMPLE 2: 3gpp-Sbi-Producer-Id: nfinst=54804518-4191-46b3-955c-ac631f953ed8; nfservinst=xyz + +EXAMPLE 3: 3gpp-Sbi-Producer-Id: nfinst=54804518-4191-46b3-955c-ac631f953ed8; nfservinst=xyz; nfset=set1.smfset.5gc.mnc012.mcc345 + +##### 5.2.3.2.9 3gpp-Sbi-Oci + +The header contains a comma-delimited list of Overload Control Information (OCI). See clause 6.4.3. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` + +Sbi-Oci-Header = "3gpp-Sbi-Oci:" OWS 1#( timestamp ";" RWS validityPeriod ";" RWS olcMetric ";" RWS olcScope ) OWS + +timestamp = "Timestamp:" RWS DQUOTE date-time DQUOTE + +validityPeriod = "Period-of-Validity:" RWS 1*DIGIT "s" + +olcMetric = "Overload-Reduction-Metric:" RWS ( DIGIT / %x31-39 DIGIT / "100" ) "%" + +olcScope = nfProducerScope / nfConsumerScope / scpScope / seppScope + +nfProducerScope = ( ( "NF-Instance:" RWS nfinst ) + / ( "NF-Set:" RWS nfset ) + / ( "NF-Service-Instance:" RWS nfservinst [ ";" RWS "NF-Inst:" RWS nfinst ] ) + / ( "NF-Service-Set:" RWS nfserviceset ) + ) [ ";" RWS sNssaiList ";" RWS dnnList ] + +nfConsumerScope = ( "NF-Instance:" RWS nfinst [ ";" RWS "Service-Name:" RWS servname ] ) + / ( "NF-Set:" RWS nfset [ ";" RWS "Service-Name:" RWS servname ] ) + / ( "NF-Service-Instance:" RWS nfservinst [ ";" RWS "NF-Inst:" RWS nfinst ] ) + / ( "NF-Service-Set:" RWS nfserviceset ) + / ( "Callback-Uri:" RWS DQUOTE URI DQUOTE *( RWS "&" RWS DQUOTE URI DQUOTE ) ) + +scpScope = "SCP-FQDN:" RWS fqdn + +seppScope = "SEPP-FQDN:" RWS fqdn + +dnnList = "DNN:" RWS 1*tchar *( RWS "&" RWS 1*tchar ) + +sNssaiList = "S-NSSAI:" RWS snssai *( RWS "&" RWS snssai ) + +snssai = 1*tchar + +``` + +"Timestamp" (Mandatory parameter): The date-time type is specified in IETF RFC 5322 [37] and clause 5.6.7 of IETF RFC 9110 [11]. It indicates the timestamp at which the overload control information was generated. + +"Period-of-Validity" (Mandatory parameter): Period of validity is a timer that is measured in seconds. Once the timer expires, the OCI becomes invalid. + +"Overload-Reduction-Metric" (Mandatory parameter): Overload-Reduction-Metric up to 3 digits long decimal string and the value range shall be from 0 to 100. + +The Overload Control Scope is a mandatory header component, and it shall contain one of the parameters: "NF-Instance", "NF-Set", "NF-Service-Instance" or "NF-Service-Set" (for NF consumers or NF producers), "Callback-URI" (for NF consumers), "SCP-FQDN" (for SCP), or "SEPP-FQDN" (for SEPP). + +See clause 6.4.3.4.5. The nfinst, nfset, nfservinst, nfserviceset and servname parameters are defined in clause 5.2.3.2.8. fqdn shall encode an FQDN. URI is defined in clause 3 of IETF RFC 3986 [14]. + +When signaling overload control information of an NF service instance, the "NF-Inst" parameter shall be present to identify the NF service instance unambiguously. If the "NF-Inst" parameter is absent, the receiving NF should assume the last known NF instance ID of NF service producer or consumer, if available. + +NOTE 1: Implementations complying with earlier versions of the specification can signal overload control information of an NF service instance without including the NF-Inst parameter. + +"DNN" (Optional parameter): Used for S-NSSAI/DNN based overload control by SMF, see clause 6.4.3.4.5.2.2, that refers to one or more specific DNN(s). DNN format is defined in 3GPP TS 23.003 [15]. + +"S-NSSAI" (Optional parameter): Used for S-NSSAI/DNN based overload control by SMF, see clause 6.4.3.4.5.2.2, that refers to one or more specific S-NSSAI(s). + +S-NSSAI format is defined in clause 5.4.4.2 of 3GPP TS 29.571 [13]. It shall be encoded as the object format (i.e. not converted to the string pattern defined in clause 5.4.4.2 of 3GPP TS 29.571 [13]). + +EXAMPLE 1: Overload Control Information for an NF Instance: + +3gpp-Sbi-Oci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Period-of-Validity: 75s; Overload-Reduction-Metric: 50%; NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8 + +EXAMPLE 2: Overload Control Information for an NF Service Set: + +3gpp-Sbi-Oci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Period-of-Validity: 120s; Overload-Reduction-Metric: 50%; NF-Service-Set: setxyz.snnsmf-pdusession.nfi54804518-4191-46b3-955c-ac631f953ed8.5gc.mnc012.mcc345 + +EXAMPLE 3: Overload Control Information for an SMF instance related to a particular DNN of an S-NSSAI: + +3gpp-Sbi-Oci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Period-of-Validity: 600s; Overload-Reduction-Metric: 50%; NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8; S-NSSAI: %7B%22sst%22%3A%201%2C%20%22sd%22%3A%20%22A08923%22%7D; DNN: internet.mnc012.mcc345.gprs + +NOTE 2: The S-NSSAI parameter corresponds to the JSON encoding: {"sst": 1, "sd": "A08923"} (see clause 5.2.3.1) + +EXAMPLE 4: Overload Control Information for an SMF instance related to a particular DNN shared by two S-NSSAIs: + +3gpp-Sbi-Oci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Period-of-Validity: 240s; Overload-Reduction-Metric: 50%; NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8; S-NSSAI: %7B%22sst%22%3A%201%2C%20%22sd%22%3A%20%22A08923%22%7D & %7B%22sst%22%3A%201%2C%20%22sd%22%3A%20%22A08924%22%7D; DNN: internet.mnc012.mcc345.gprs + +NOTE 3: The S-NSSAI parameter corresponds to the JSON encoding: {"sst": 1, "sd": "A08923"} & {"sst": 1, "sd": "A08924"} (see clause 5.2.3.1) + +EXAMPLE 5: Overload Control Information sent by a NF service consumer with a scope set to a Callback-Uri: + +3gpp-Sbi-Oci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Period-of-Validity: 120s; Overload-Reduction-Metric: 25%; Callback-Uri: "https://pcf12.operator.com/serviceY" + +EXAMPLE 6: Overload Control Information sent by a NF service consumer with a scope set to a specific NF Instance and service: + +3gpp-Sbi-Oci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Period-of-Validity: 120s; + Overload-Reduction-Metric: 25%; NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8; + Service-Name: nsmf-pdusession + +EXAMPLE 7: Overload Control Information sent by an SCP: + +3gpp-Sbi-Oci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Period-of-Validity: 120s; + Overload-Reduction-Metric: 25%; SCP-FQDN: scp1.example.com + +EXAMPLE 8: Example with two OCI values, one for an SMF Instance and another one for a specific DNN of an S-NSSAI for the same SMF Instance: + +3gpp-Sbi-Oci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Period-of-Validity: 75s; Overload-Reduction-Metric: 50%; NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8 + 3gpp-Sbi-Oci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Period-of-Validity: 600s; + Overload-Reduction-Metric: 40%; NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8; S-NSSAI: %7B%22sst%22%3A%201%2C%20%22sd%22%3A%20%22A08923%22%7D; DNN: internet.mnc012.mcc345.gprs + +NOTE 4: The S-NSSAI parameter corresponds to the JSON encoding: {"sst": 1, "sd": "A08923"} (see clause 5.2.3.1) + +EXAMPLE 9: Overload Control Information sent by an SEPP: + +3gpp-Sbi-Oci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Period-of-Validity: 120s; + Overload-Reduction-Metric: 25%; SEPP-FQDN: sepp1.example.com + +NOTE 5: Example 8 is formatted as two distinct headers (which improves the readability), but it can also be formatted as a single header with two OCI values separated by a comma. + +EXAMPLE 10: Overload Control Information for an NF Service Instance: + +3gpp-Sbi-Oci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Period-of-Validity: 75s; Overload-Reduction-Metric: 50%; NF-Service-Instance: xyz; NF-Inst: 54804518-4191-46b3-955c-ac631f953ed8 + +##### 5.2.3.2.10 3gpp-Sbi-Lci + +The header contains a comma-delimited list (see IETF RFC 9110 [11]) of Load Control Information (LCI). See clause 6.3.3. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Lci-Header = "3gpp-Sbi-Lci:" OWS 1#( timestamp ";" RWS lcMetric ";" RWS lcScope ) OWS +timestamp = "Timestamp:" RWS DQUOTE date-time DQUOTE +lcMetric = "Load-Metric:" RWS (DIGIT / %x31-39 DIGIT / "100") "%" +lcScope = lcNfProducerScope / scpScope / seppScope +lcNfProducerScope = ( ( "NF-Instance:" RWS nfinst ) + / ( "NF-Set:" RWS nfset ) + / ( "NF-Service-Instance:" RWS nfservinst [ ";" RWS "NF-Inst:" RWS nfinst ] ) + / ( "NF-Service-Set:" RWS nfserviceset ) + [ ";" RWS sNssaiList ";" RWS dnnList ";" RWS relativeCapacity ] ) +dnnList = "DNN:" RWS 1*tchar *( RWS "&" RWS 1*tchar ) +sNssaiList = "S-NSSAI:" RWS snssai *( RWS "&" RWS snssai ) +snssai = 1*tchar +relativeCapacity = "Relative-Capacity:" RWS ( 1*2DIGIT / "100" ) "%" +``` + +"Timestamp" (Mandatory parameter): The date-time type is specified in IETF RFC 5322 [37] and clause 5.6.7 of IETF RFC 9110 [11]. It indicates the timestamp associated with the load control information. + +"Load-Metric" (Mandatory parameter): Load-Metric is up to 3 digits long decimal string and the value range shall be from 0 to 100. + +The Load Control Scope is a mandatory header component, and it shall contain one of the parameters: "NF-Instance", "NF-Set", "NF-Service-Instance" or "NF-Service-Set" (for NF producers), "SCP-FQDN" (for SCP), or "SEPP-FQDN" (for SEPP). + +See clause 6.3.3.4.4. The nfinst, nfset, nfservinst and nfserviceset parameters are defined in clause 5.2.3.2.5. fqdn shall encode an FQDN. + +When signaling load control information of an NF service instance, the NF-Inst parameter shall be present to identify the NF service instance unambiguously. If the NF-Inst parameter is absent, the receiving NF should assume the last known NF instance ID of the NF service producer, if available. + +NOTE 1: Implementations complying with earlier versions of the specification can signal load control information of an NF service instance without including the NF-Inst parameter. + +"DNN" (Optional parameter): Used for S-NSSAI/DNN based load control by SMF, see clause 6.3.3.4.4.2.2, that refers to one or more specific DNN(s). DNN format is defined in 3GPP TS 23.003 [15]. + +"S-NSSAI" (Optional parameter): Used for S-NSSAI/DNN based load control by SMF, see clause 6.3.3.4.4.2.2, that refers to one or more specific S-NSSAI(s). + +S-NSSAI format is defined in clause 5.4.4.2 of 3GPP TS 29.571 [13]. It shall be encoded as the object format (i.e. not converted to the string pattern defined in clause 5.4.4.2 of 3GPP TS 29.571 [13]). + +"Relative-Capacity" (Optional parameter): Used for S-NSSAI/DNN based load control by SMF, see clause 6.3.3.4.5. Up to 3 digits long decimal string with value range from 0 to 100. The value applies to all combinations of S-NSSAIs and DNNs indicated in the LCI. + +EXAMPLE 1: Load Control Information for an NF Instance: + +3gpp-Sbi-Lci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Load-Metric: 25%; NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8 + +EXAMPLE 2: Load Control Information for an NF Service Set: + +3gpp-Sbi-Lci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Load-Metric: 25%; NF-Service-Set: setxyz.snsmf-pdusession.nfi54804518-4191-46b3-955c-ac631f953ed8.5gc.mmc012.mcc345 + +EXAMPLE 3: Load Control Information for an SMF instance related to a particular DNN of an S-NSSAI (SST=1, SD="A08923"): + +3gpp-Sbi-Lci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Load-Metric: 25%; NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8; S-NSSAI: %7B%22sst%22%3A%201%2C%20%22sd%22%3A%20%22A08923%22%7D; DNN: internet.mmc012.mcc345.gprs; Relative-Capacity: 20% + +EXAMPLE 4: Load Control Information for an SMF instance related to a particular S-NSSAI (SST=1, SD="A08923"): + +3gpp-Sbi-Lci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Load-Metric: 25%; NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8; S-NSSAI: %7B%22sst%22%3A%201%2C%20%22sd%22%3A%20%22A08923%22%7D; DNN: internet.mmc012.mcc345.gprs; Relative-Capacity: 20% + +NOTE 2: The S-Nssai parameter corresponds to the JSON encoding: {"sst": 1, "sd": "A08923"} (see clause 5.2.3.1) + +EXAMPLE 5: Load Control Information for SCP: + +3gpp-Sbi-Lci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Load-Metric: 25%; SCP-FQDN: sep1.example.com + +EXAMPLE 6: Example with two LCI values, for different DNNs of a same S-NSSAI (SST=1, SD="A08923"): + +3gpp-Sbi-Lci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Load-Metric: 40%; NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8; S-NSSAI: %7B%22sst%22%3A%201%2C%20%22sd%22%3A%20%22A08923%22%7D; DNN: internet.mnc012.mcc345.gprs; Relative-Capacity: 30% + 3gpp-Sbi-Lci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Load-Metric: 70%; NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8; S-NSSAI: %7B%22sst%22%3A%201%2C%20%22sd%22%3A%20%22A08923%22%7D; DNN: ciot.mnc012.mcc345.gprs; Relative-Capacity: 20% + +NOTE: The S-Nssai parameter corresponds to the JSON encoding: {"sst": 1, "sd": "A08923"} (see clause 5.2.3.1) + +EXAMPLE 7: Load Control Information for SEPP: + +3gpp-Sbi-Lci: Timestamp: "Tue, 04 Apr 2021 08:36:42 GMT"; Load-Metric: 25%; SEPP-FQDN: sepp1.example.com + +NOTE 3: Example 6 is formatted as two distinct headers (which improves the readability), but it can also be formatted as a single header with two LCI values separated by a comma. + +EXAMPLE 8: Load Control Information for an NF Service Instance: + +3gpp-Sbi-Lci: Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Load-Metric: 25%; NF-Service-Instance: xyz; NF-Inst: 54804518-4191-46b3-955c-ac631f953ed8 + +##### 5.2.3.2.11 3gpp-Sbi-Client-Credentials + +The header contains client credentials assertion (see clause 13.3.8.1 of 3GPP TS 33.501 [17]). + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Client-Credentials-Header = "3gpp-Sbi-Client-Credentials:" OWS jwt OWS + +jwt = 1*b64urlchar "." 1*b64urlchar "." 1*b64urlchar + +b64urlchar = ALPHA / DIGIT / "-" / "_" +``` + +The client credentials assertion shall be a JSON Web Token (JWT) as specified in IETF RFC 7519 [41], digitally signed using JWS as specified in IETF RFC 7515 [26] and in clause 13.3.8.1 of 3GPP TS 33.501 [15]. It shall include: + +- the claims defined in Table 5.2.3.2.11-1 encoded as a JSON object; and +- one of the following JOSE headers: + - the X.509 URL (x5u) header (see clause 4.1.5 of IETF RFC 7515 [26]) referring to a resource for the X.509 public key certificate or certificate chain used for signing the client authentication assertion, or + - the X.509 Certificate Chain (x5c) header (see clause 4.1.5 of IETF RFC 7515 [26]) including the X.509 public key certificate or certificate chain used for signing the client authentication assertion. + +The digitally signed client credentials assertion shall be converted to the JWS Compact Serialization encoding as a string as specified in clause 7.1 of IETF RFC 7515 [26]. + +Table 5.2.3.2.11 -1: Definition of type ClientCredentialsAssertion + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sub | NfInstanceId | M | 1 | This IE shall contain the NF instance ID of the NF service consumer, corresponding to the standard "Subject" claim described in IETF RFC 7519 [41], clause 4.1.2. | +| iat | integer | M | 1 | This IE shall indicate the time at which the JWT was issued, corresponding to the standard "Issued At" claim described in IETF RFC 7519 [41], clause 4.1.6. This claim may be used to determine the age of the JWT. | +| exp | integer | M | 1 | This IE shall contain the expiration time after which the client credentials assertion is considered to be expired, corresponding to the standard "Expiration Time" claim described in IETF RFC 7519 [41], clause 4.1.4. | +| aud | array(NFType) | M | 1..N | This IE shall contain the NF type of the NF service producer and/or "NRF", for which the claim is applicable, corresponding to the standard "Audience" claim described in IETF RFC 7519 [41], clause 4.1.3. | + +The JSON object containing the client credentials assertion shall comply with the following OpenAPI definition: + +``` + +ClientCredentialsAssertion: + description: The data structure for the client credentials assertion + type: object + required: + - sub + - iat + - exp + - aud + properties: + sub: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + iat: + type: integer + exp: + type: integer + aud: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + minItems: 1 + +``` + +##### 5.2.3.2.12 3gpp-Sbi-Nrf-Uri + +The header contains a list of NRF API URIs. See clauses 6.10.3.2 and 6.10.5.1. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` + +Sbi-Nrf-Uri-Header = "3gpp-Sbi-Nrf-Uri:" OWS nrfUriParam *( OWS ";" OWS nrfUriParam ) OWS +nrfUriParam = nrfUriParamName ":" RWS ( nrfUriParamValue1 / nrfUriParamValue2 ) +nrfUriParamName = "nnrf-disc" / "nnrf-nfm" / "nnrf-oauth2" / "oauth2-requested-services" / token +nrfUriParamValue1 = DQUOTE URI DQUOTE +nrfUriParamValue2 = ( nrfServiceName *( RWS "&" RWS nrfServiceName ) ) +nrfServiceName = "nnrf-disc" / "nnrf-nfm" + +``` + +NOTE: token is defined for future extensibility. + +- for the nnrf-disc, nnrf-nfm and nnrf-oauth2 parameters: + +URI shall comply with the URI definition in IETF RFC 3986 [14]. + +- for the oauth2-requested-services parameter: + +nrfServiceName shall encode an NRF API name, e.g. "nnrf-disc" or "nnrf-nfm". + +When present, the oauth2-requested-services parameter shall indicate the list of NRF services for which OAuth2 based authorization is required for accessing the respective NRF services. + +If OAuth2 based authorization is required for accessing the respective NRF services, the nnrf-oauth2 parameter shall be present and shall be used to request access token for NRF services. + +The absence of the oauth2-requested-services parameter means that no indication is provided about the potential usage of OAuth2 for authorization. + +EXAMPLE 1: Header with NRF NF Discovery, NF Management and Access Token API URIs, without indication on whether OAuth2-based authorization is required to access the NRF services: + +3gpp-Sbi-Nrf-Uri: nnrf-disc: "https://nrf1.operator.com/nnrf-disc/v1"; nnrf-nfm: "https://nrf1.operator.com/nnrf-nfm/v1"; nnrf-oauth2: "https://nrf1.operator.com/oauth2" + +EXAMPLE 2: Header with NRF NF Discovery, NF Management and Access Token API URIs, indication on whether OAuth2-based authorization is required to access the NRF services: + +3gpp-Sbi-Nrf-Uri: nnrf-disc: "https://nrf1.operator.com/nnrf-disc/v1"; nnrf-nfm: "https://nrf1.operator.com/nnrf-nfm/v1"; nnrf-oauth2: "https://nrf1.operator.com/oauth2"; oauth2-requested-services: nnrf-disc & nnrf-nfm + +##### 5.2.3.2.13 3gpp-Sbi-Target-Nf-Id + +This header contains the target NF (Service) Instance ID in an HTTP 307/308 response (see clause 6.10.9). + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Target-Nf-Id-Header = "3gpp-Sbi-Target-Nf-Id:" OWS "nfinst=" nfinst [ ";" OWS "nfservinst=" +nf.servinst ] OWS +``` + +The following parameters are defined: + +- nfinst (NF instance): indicates a NF Instance ID, as defined in 3GPP TS 29.510 [8]; the ABNF is defined in clause 5.2.3.2.8. +- nfservinst (NF service instance): indicates a NF Service Instance ID, as defined in 3GPP TS 29.510 [8]; the ABNF is defined in clause 5.2.3.2.8. + +EXAMPLE: 3gpp-Sbi-Target-Nf-Id: nfinst=54804518-4191-46b3-955c-ac631f953ed8; nfservinst=xyz + +##### 5.2.3.2.14 3gpp-Sbi-Max-Forward-Hops + +The header contains the value of maximum number of allowed hops with specified node type to relay the request message to the target NF. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Max-Forward-Hops-Header = "3gpp-Sbi-Max-Forward-Hops:" OWS (DIGIT / %x31-39 DIGIT) ";" OWS +"nodetype=" nodetypevalue OWS +``` + +``` +nodetypevalue = "scp" +``` + +EXAMPLE: Allowed up to 5 SCP hops to relay the request: + +3gpp-Sbi-Max-Forward-Hops: 5; nodetype=scp + +##### 5.2.3.2.15 3gpp-Sbi-Originating-Network-Id + +The header contains the PLMN Identity (MCC-MNC) of the source PLMN or the SNPN ID (MCC-MNC-NID) of the source SNPN of the received HTTP messages. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Originating-Network-Id-Header = "3gpp-Sbi-Originating-Network-Id:" OWS 3DIGIT "-" 2*3DIGIT [ "-" +11HEXDIGIT ] [ ";" OWS srcinfo ] OWS + +srcinfo = "src" ":" RWS srcotype "-" srcfqdn + +srcotype = "SCP" / "SEPP" + +srcfqdn = 4*( ALPHA / DIGIT / "-" / "." ) +``` + +The srcinfo shall only be present when SCP or SEPP was unable to uniquely determine the value, i.e. PLMN ID, and has decided to insert the header with the value derived by configuration as described in Table 5.2.3.2.1-1. + +The srcfqdn shall indicate FQDN of SCP or SEPP that inserted the header when srcinfo is present. + +EXAMPLE 1: For a source PLMN: + +3gpp-Sbi-Originating-Network-Id: 123-45 + +EXAMPLE 2: For a source PLMN and the header included by SEPP under the condition when the value of the header is derived based on the configuration and inserted by the SEPP: + +3gpp-Sbi-Originating-Network-Id: 123-45; src: SEPP-sepp001.sepp.5gc.mnc045.mcc123.3gppnetwork.org + +EXAMPLE 3: For a source SNPN: + +3gpp-Sbi-Originating-Network-Id: 123-45-000007ed9d5 + +##### 5.2.3.2.16 3gpp-Sbi-Access-Scope + +The header indicates the access scope of the service request for NF service access authorization, as defined in clauses 6.7.3 and 6.10.11. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Access-Scope-Header = "3gpp-Sbi-Access-Scope:" OWS scope-token *(SP scope-token) OWS + +scope-token = 1*NQCHAR +``` + +Scope-token shall consist of a list of space-delimited, case-sensitive strings, containing the NF service name of the NF service producer corresponding to the service request and, if defined for the specific resource/operation in the corresponding API, the additional resource/operation-level scope. + +NQCHAR is defined in Appendix A of IETF RFC 6749 [22]. + +NOTE 1: This corresponds to the "scope" syntax defined for OAuth in clauses 3.3 and A.4 of IETF RFC 6749 [22] and also to the syntax of the "scope" parameter in AccessTokenReq in 3GPP TS 29.510 [8]. This enables the SCP to set the scope parameter in the Nnrf\_Get Access Token Request to the value of the 3gpp-Sbi-Access-Scope header received in an incoming service request, or to a list of scopes that is the intersection of the scopes indicated in the 3gpp-Sbi-Access-Scope header and the scopes expected by the NF Service producer (as registered in its NF profile). + +NOTE 2: For indirect communication with delegated discovery (see clause 6.10.11.2), for a specific resource / operation for which the API defines a resource/operation-level scope, the NF service consumer does not and need not know whether the NF service producer is configured to require the resource/operation level scope or not. The setting of the 3gpp-Sbi-Access-Scope header is the same regardless of whether the NF service producer is configured to require the resource/operation level scope or not. + +EXAMPLE: 3gpp-Sbi-Access-Scope: nhss-ims-uecm nhss-ims-uecm:authorize:invoke + +##### 5.2.3.2.17 3gpp-Sbi-Access-Token + +The header contains an Access Token in a service response, for possible re-use in subsequent service requests, as defined in clause 6.10.11. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Access-Token = "3gpp-Sbi-Access-Token:" OWS credentials OWS +``` + +See clause 11.4 of IETF RFC 9110 [11] for the definition of "credentials". + +NOTE: The 3gpp-Sbi-Access-Token header is encoded as the Authorization header. + +##### 5.2.3.2.18 Void + +##### 5.2.3.2.19 3gpp-Sbi-Target-Nf-Group-Id + +This header contains the NF Group ID (e.g. UDM, HSS, AUSF, UDR, CHF, PCF Group ID) of the NF service producer. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Target-Nf-Group-Id-Header = "3gpp-Sbi-Target-Nf-Group-Id:" OWS "nfgid=" nfGroupIdValue OWS +nfGroupIdValue = DQUOTE token DQUOTE +``` + +The following parameter is defined: + +- nfgid (NF Group ID): indicates a NF Group ID, as defined in 3GPP TS 29.571 [13]. + +EXAMPLE: 3gpp-Sbi-Target-Nf-Group-Id: nfgid="udm-group-15" + +##### 5.2.3.2.20 3gpp-Sbi-Nrf-Uri-Callback + +The header contains the NRF API URI of the NF discovery service and may contain the NRF API URI of the NF management service. See clauses 6.5.3.2. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Nrf-Uri-Callback-Header = "3gpp-Sbi-Nrf-Uri-Callback:" OWS nrfUriCallbackParam *( OWS ";" +nrfUriCallbackParam ) OWS +nrfUriCallbackParam = nrfUriCallbackParamName ":" RWS nrfUriCallbackParamValue +nrfUriCallbackParamName = "nnrf-disc" / "nnrf-nfm" / token ; token is defined for future +extensibility +nrfUriCallbackParamValue = DQUOTE URI DQUOTE +``` + +URI shall comply with the URI definition in IETF RFC 3986 [14]. + +EXAMPLE 1: Header with NRF NF Discovery Service: + +3gpp-Sbi-Nrf-Uri-Callback: nnrf-disc: "https://nrf1.operator.com/nnrf-disc/v1" + +EXAMPLE 2: Header with NRF NF Discovery and NF Management Services: + +3gpp-Sbi-Nrf-Uri-Callback: nnrf-disc: "https://nrf1.operator.com/nnrf-disc/v1"; nnrf-nfm: "https://nrf1.operator.com/nnrf-nfm/v1" + +##### 5.2.3.2.21 3gpp-Sbi-NF-Peer-Info + +This header contains the IDs of the NF (service) instance as HTTP client and the NF (service) instance as HTTP server. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-NF-Peer-Info-Header = "3gpp-Sbi-NF-Peer-Info" ":" OWS peerinfo *( ";" OWS peerinfo ) OWS +peerinfo = peertype "=" token +peertype = "srcinst" / "srcservinst" / "srcscp" / "srcsepp" / "dstinst" / "dstservinst" / "dstscp" / +"dstsepp" +``` + +The following peertype are defined: + +- srcinst (Source NF instance): indicates the Source NF Instance ID, as defined in 3GPP TS 29.510 [8]; +- srcservinst (Source NF service instance): indicates the Source NF Service Instance ID, as defined in 3GPP TS 29.510 [8]; if this parameter is present, srcinst shall also be present; +- srcscp (Source SCP): indicates the FQDN of the Source SCP, the format is "SCP-"; this parameter shall only be included by an SCP, i.e. when the HTTP request or response message is originated or relayed by an SCP; +- srcsepp (Source SEPP): indicates the FQDN of the Source SEPP, the format is "SEPP-"; this parameter shall only be included by a SEPP, i.e. when the HTTP request or response message is originated or relayed by a SEPP; +- dstinst (Destination NF instance): indicates the Destination NF Instance ID, as defined in 3GPP TS 29.510 [8]; +- dstservinst (Destination NF service instance): indicates the Destination NF Service Instance ID, as defined in 3GPP TS 29.510 [8]; if this parameter is present, dstinst shall also be present; +- dstscp (Destination SCP): indicates the FQDN of the Destination SCP, the format is "SCP-"; this parameter shall contain the next-hop SCP of the HTTP request or response message to be included by an SCP or SEPP or by clients/servers sending requests/responses to an SCP; +- dstsepp (Destination SEPP): indicates the FQDN of the Destination SEPP, the format is "SEPP-"; this parameter shall be included by an SCP or by clients/servers sending requests/responses to a SEPP; it may also be included by a SEPP, based on operator's policy. + +The header shall contain the source peer information, and should contain the destination peer information if available. + +EXAMPLE: 3gpp-Sbi-NF-Peer-Info: srcinst=54804518-4191-46b3-955c-ac631f953ed8; dstinst=54804518-4191-4453-569c-ac631f74765cd + +##### 5.2.3.2.22 3gpp-Sbi-Source-NF-Client-Credentials + +The header contains client credentials assertion of a source NF instance (e.g. NWDAF) in a service request that is sent from an NF Service Consumer (e.g., DCCF) to an NF Service Producer (e.g. AMF, SMF). The purpose is to enable the authorization of NF service consumers for data access via DCCF (see clause 13.3.8.1 and Annex X of 3GPP TS 33.501 [17]). + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Source-NF-Client-Credentials-Header = "3gpp-Sbi-Source-NF-Client-Credentials:" OWS jwt OWS +``` + +The client credentials assertion shall be a JSON Web Token (JWT) as defined in clause 5.2.3.2.11, with the sub claim identifying the source NF instance, i.e. corresponding to the sourceNfInstanceId claim specified in Table 6.3.5.2.4-1 of 3GPP TS 29.510 [8]. + +The ABNF of the JSON Web Token (JWT) is defined in clause 5.2.3.2.11. + +NOTE: The 3gpp-Sbi-Source-NF-Client-Credentials header in the service request sent from the NF Service Consumer (e.g., DCCF) to an NF Service Producer (e.g. AMF, SMF) has the same contents as the 3gpp-Sbi-Client-Credentials header received by the NF Service Consumer (e.g. DCCF) from the source NF instance (e.g. NWDAF). + +#### 5.2.3.3 Optional to support custom headers + +##### 5.2.3.3.1 General + +The 3GPP NF Services may support the HTTP custom headers specified in Table 5.2.3.3-1 below. A description of each custom header and the normative requirements on when to include them are also provided in Table 5.2.3.3-1. + +**Table 5.2.3.3-1: Optional HTTP custom headers** + +| Name | Reference | Description | +|----------------------------------|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3gpp-Sbi-Sender-Timestamp | Clause 5.2.3.3.2 | This header may be used to indicate the date and time (with a millisecond granularity) at which an HTTP request or response is originated. This may be used e.g. for measuring signalling delays between different NF service instances. | +| 3gpp-Sbi-Max-Rsp-Time | Clause 5.2.3.3.3 | This header may be used in a HTTP request to indicate the duration during which the HTTP client waits for a response. See clause 6.11.2. | +| 3gpp-Sbi-Correlation-Info | Clause 5.2.3.3.4 | This header may be used to contain correlation information (e.g. UE identity), that may be used by an operator in various offline network management, performance analysis and troubleshooting tools/applications to identify messages (requests, responses, subscriptions, notifications) related to a particular subscriber. See clause 6.13. | +| 3gpp-Sbi-Alternate-Chf-Id | Clause 5.2.3.3.5 | This header may be used to indicate a primary or secondary CHF instance, e.g. when using indirect communication with delegated discovery. See clause 6.10.3.5. | +| 3gpp-Sbi-Request-Info | Clause 5.2.3.3.12 |

This header may be used to indicate additional information related to a HTTP request, e.g. if the request is involving a reselection towards an alternative NF, and/or if the request is a retransmission of a request towards an (alternative) NF.

This header may be used in a non-idempotent HTTP request message to include an idempotency key to enable the receiver to detect possible duplicated request messages. See clause 5.2.8.

This header may also be used in notification requests to indicate to the SCP a prefix of the Callback URI when binding procedures are not supported.

| +| 3gpp-Sbi-Notif-Accepted-Encoding | Clause 5.2.3.3.6 | This header may be used to indicate the content encodings supported by the NF service Consumer when receiving notifications related to the subscriptions data conveyed by the HTTP request in which the header is included. See clause 6.9.2.1. | +| 3gpp-Sbi-Consumer-Info | Clause 5.2.3.3.7 |

This header is used in a service request to create a subscription to indicate the API version(s) and feature(s) of the corresponding NF service(s) for the subscribed event(s) and the accepted encodings for notifications of the subscribed event(s), which are supported by the NF consumer.

The NF consumer may include this header when subscribing to an intermediate NF for event(s) which may be detected and reported directly by a target NF, e.g. subscribe to Location Reporting event at AMF via UDM with AMF directly reporting the notifications to the NF consumer. See clause 6.2.2.

The NF service consumer may include this header when providing a Callback URI when the authority part of the Callback URI is shared by several NF service consumer instances. See clause 6.12.1 for the usage of this parameter. The NF service consumer may also include this header when providing a Callback URI including a prefix, for use during NF service consumer reselection, when binding procedures are not supported.

| +| 3gpp-Sbi-Response-Info | Clause 5.2.3.3.8 |

This header may be used to provide additional information related to an HTTP response, e.g. in a 4xx or 5xx response sent:

  • - by an SCP to indicate whether it attempted to retransmit the request to alternative HTTP server instances (see clause 6.10.8.1); or
  • - by an alternative HTTP server instance to indicate whether the resource/context has been transferred to the instance sending the response, or by an HTTP server instance to indicate that the failed request shall not be retried (see clause 6.10.3.4, 6.10.5.1 and 6.10.8.1).
| + +| | | | +|------------------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3gpp-Sbi-Selection-Info | Clause 5.2.3.3.10 | This header may be included in a HTTP request message for indirect communication and may be used by the SCP when performing the (re)selection of the target NF.

See clauses 6.10.3.2 and 6.10.5.1. | +| 3gpp-Sbi-Interplmn-Purpose | Clause 5.2.3.3.11 | This header is used in HTTP request to indicate the intended purpose for inter-PLMN signaling.

The HTTP client may include this header in HTTP request when the target NF is in a different PLMN, and if included shall set the intended purpose of the HTTP request.

SEPP shall evaluate the contents of this header against the local policy and continue or reject the request if received. (see clause 6.14.3) | +| 3gpp-Sbi-Retry-Info | Clause 5.2.3.3.13 | This header may be included in a HTTP request message for indirect communication to indicate that the request shall only be sent once and shall not be retried. | +| 3gpp-Sbi-Other-Access-Scopes | Clause 5.2.3.3.14 | This header may be included in a service request for Indirect communication with delegated discovery to indicate other access scopes that are desired to be obtained for the access token, in addition to the scopes indicated in the 3gpp-Sbi-Access-Scope, that are not required for the service request itself but that may be required for further service requests. See clauses 5.2.3.3.14 and 6.10.11. | + +##### 5.2.3.3.2 3gpp-Sbi-Sender-Timestamp + +The header contains the date and time (with a millisecond granularity) at which an HTTP request or response is originated. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Sender-Timestamp-Header = "3gpp-Sbi-Sender-Timestamp:" OWS day-name "," SP date1 SP time-of-day +"." milliseconds SP "GMT" OWS + +milliseconds = 3DIGIT +``` + +day-name, date1, time-of-day shall comply with the definition in clause 5.6.7 of IETF RFC 9110 [11]. + +When a 3gpp-Sbi-Sender-Timestamp header field is generated, the sender should generate its field value as the best available approximation of the date and time of message generation. + +NOTE: This is the same format as the Date header of clause 5.6.7 of IETF RFC 9110 [11], but with the time expressed with a millisecond granularity. + +EXAMPLE: 3gpp-Sbi-Sender-Timestamp: Sun, 04 Aug 2019 08:49:37.845 GMT + +##### 5.2.3.3.3 3gpp-Sbi-Max-Rsp-Time + +The header indicates the duration, expressed in milliseconds since the request was originated, during which the HTTP client waits for a response. See clause 6.11.2. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Max-Rsp-Time-Header = "3gpp-Sbi-Max-Rsp-Time:" OWS 1*5DIGIT OWS + +EXAMPLE: 3gpp-Sbi-Max-Rsp-Time: 10000 +``` + +##### 5.2.3.3.4 3gpp-Sbi-Correlation-Info + +The header contains correlation information e.g. UE identifier related to the HTTP request or response. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Correlation-Info-Header = "3gpp-Sbi-Correlation-Info:" OWS correlationinfo *( ";" OWS +correlationinfo ) OWS +``` + +``` +correlationinfo = ctype "-" cvalue +``` + +``` +ctype = "imsi" / "impi" / "suci" / "nai" / "gci" / "gli" / "impu" / "msisdn" / "extid" / "imei" / +"imeisv" / "mac" / "eui" / extension-token +``` + +``` +extension-token = 1*( "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "," / "-" / "_" / "`" / "|" / +"~" / DIGIT / ALPHA ) +``` + +``` +cvalue = 1*( tchar / "@" ) +``` + +NOTE 1: Only one of each ctype can be included in the 3gpp-Sbi-Correlation-Info header; the possibility to include more than one of the same ctype is kept for future extensibility. + +NOTE 2: extension-token is defined for future extensibility, defined as one or more occurrences of any of the characters allowed for "tchar", except for the HYPHEN-MINUS ("-") character. See clause 5.6.2 of IETF RFC 9110 [11] for the definition of "tchar". + +The format of cvalue shall comply with the data type description provided in Table 5.2.3.3.4-1. + +**Table 5.2.3.3.4-1: cvalue format** + +| ctype | Description | +|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| imsi | VarUeld format defined in Table 5.2.2-1 of TS 29.571 [13] for IMSI and starting after the string "imsi-" | +| impi | imsUeld format defined in Table 6.1.3.2.2-1 of TS 29.562 [45] for IMPI and starting after the string "impi-" | +| suci | SupiOrSuci format defined in Table 5.3.2-1 of TS 29.571 [13] for SUCI and starting after the string "suci-" | +| nai | VarUeld format defined in Table 5.2.2-1 of TS 29.571 [13] for NAI and starting after the string "nai-" | +| gci | VarUeld format defined in Table 5.2.2-1 of TS 29.571 [13] for GCI and starting after the string "gci-" | +| gli | VarUeld format defined in Table 5.2.2-1 of TS 29.571 [13] for GLI and starting after the string "gli-" | +| impu | imsUeld format defined in Table 6.1.3.2.2-1 of TS 29.562 [45] for IMPU and starting after the string "impu-". Depending on whether the IMPU contains a SIP URI or a TEL URI, the corresponding pattern from the definition of imsUeld in Table 6.1.3.2.2-1 of TS 29.562 [45] shall be used. | +| msisdn | VarUeld format defined in Table 5.2.2-1 of TS 29.571 [13] for MSISDN and starting after the string "msisdn-" | +| extid | VarUeld format defined in Table 5.2.2-1 of TS 29.571 [13] for External Identifier and starting after the string "extid-" | +| imei | Pei format defined in Table 5.3.2-1 of TS 29.571 [13] for IMEI and starting after the string "imei-" | +| imeisv | Pei format defined in Table 5.3.2-1 of TS 29.571 [13] for IMEISV and starting after the string "imeisv-" | +| mac | Pei format defined in Table 5.3.2-1 of TS 29.571 [13] for MAC address and starting after the string "mac-" | +| eui | Pei format defined in Table 5.3.2-1 of TS 29.571 [13] for IEEE Extended Unique Identifier (EUI-64) and starting after the string "eui-" | + +EXAMPLE 1: When UE identifier used is SUPI and SUPI type is an IMSI: + +``` +3gpp-Sbi-Correlation-Info: imsi-345012123123123 +``` + +EXAMPLE 2: When UE identifier used is PEI and PEI type is an IMEISV: + +``` +3gpp-Sbi-Correlation-Info: imeisv-3550121231231230 +``` + +EXAMPLE 3: When UE identifier used is PEI and PEI type is a MAC address: + +3gpp-Sbi-Correlation-Info: mac-00-00-5E-00-53-00 + +EXAMPLE 4: When UE identifier used is GPSI and GPSI type is an MSISDN: + +3gpp-Sbi-Correlation-Info: msisdn-1234567890 + +EXAMPLE 5: When UE identifier used is GPSI and GPSI type is an External Identifier: + +3gpp-Sbi-Correlation-Info: extid-123456789@domain.com + +EXAMPLE 6: When UE identifiers used are SUPI and GPSI where SUPI type is an IMSI and GPSI type is an MSISDN: + +3gpp-Sbi-Correlation-Info: imsi-345012123123123; msisdn-1234567890 + +##### 5.2.3.3.5 3gpp-Sbi-Alternate-Chf-Id + +The header indicates a primary or a secondary CHF Instance ID. See clause 6.10.3.5. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Alternate-Chf-Id-Header = "3gpp-Sbi-Alternate-Chf-Id:" OWS "nfinst=" nfinst ";" OWS ( "primary" / "secondary" ) OWS +``` + +Parameter "nfinst" shall indicate an NF Instance ID, as defined in clause 5.2.2.2.2 in 3GPP TS 29.510 [8]; the ABNF is defined in clause 5.2.3.2.8. + +EXAMPLE 1: Service response from a primary CHF instance signalling a secondary CHF instance Id: + +3gpp-Sbi-Alternate-Chf-Id: nfinst=54804518-4191-46b3-955c-ac631f953ed8; secondary + +EXAMPLE 2: Service response from a secondary CHF instance signalling a primary CHF instance Id: + +3gpp-Sbi-Alternate-Chf-Id: nfinst=54804518-4191-46b3-955c-ac631f953ed8; primary + +##### 5.2.3.3.6 3gpp-Sbi-Notif-Accepted-Encoding + +The header indicates the content encodings supported when receiving notifications related to the subscriptions data conveyed by the HTTP request in which the header is included. + +This header shall be compliant with Accept-Encoding header defined in IETF RFC 9110 [11] clause 12.5.3. + +Example: 3gpp-Sbi-Notif-Accepted-Encoding: gzip;q=1.0, identity;q=0.5, \*;q=0 + +##### 5.2.3.3.7 3gpp-Sbi-Consumer-Info + +This header contains a comma-delimited list of NF service consumer information from an HTTP client (as NF service consumer). + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Consumer-Info-Header = "3gpp-Sbi-Consumer-Info:" OWS 1# ( supportedService ";" OWS supportedVersions [ ";" OWS supportedFeatures ] [ ";" OWS acceptEncoding ] [ ";" OWS callback-uri-prefix ] [ ";" OWS intraPlmnCallbackRoot ";" OWS interPlmnCallbackRoot ] ) OWS + +supportedService = "service=" servicename +servicename = 1*( "-" / %x30-39 / %x41-5A / "_" / %x61-7A ) +supportedVersions = "apiversion=" "(" OWS [ apimajorversion *( RWS apimajorversion ) OWS ] ")" +apimajorversion = %x31-39 [ *DIGIT ] +supportedFeatures = "supportedfeatures=" features +features = *HEXDIG +``` + +``` + +acceptEncoding = "acceptencoding=" %x22 encodingList %x22 + +encodingList = #( codings [ weight ] ) + +intraPlmnCallbackRoot = "intraPlmnCallbackRoot=" DQUOTE sbi-scheme "://" sbi-authority +[ prefix ] DQUOTE + +interPlmnCallbackRoot = "interPlmnCallbackRoot=" DQUOTE sbi-scheme "://" sbi-authority +[ prefix ] DQUOTE + +sbi-scheme = "http" / "https" + +sbi-authority = host [ ":" port ] + +port = *DIGIT + +prefix = path-absolute ; path-absolute production rule from IETF RFC 3986, clause 3.3 + +callback-uri-prefix = "callback-uri-prefix=" DQUOTE prefix DQUOTE + +``` + +"service" (Mandatory parameter): Supported Service parameter indicates the name of a service, as defined in 3GPP TS 29.510 [8], which is supported by the sender as NF service consumer. + +"apiversion" (Mandatory parameter): Supported Versions parameter indicates the major version(s) of the service API that are supported by the sender as NF service consumer. + +"supportedfeatures" (Optional parameter): Supported Features parameter carries a string containing a bitmask in hexadecimal representation, as specified for SupportedFeatures data type in 3GPP TS 29.571 [13], to indicate the feature(s) of the service API that are supported by the sender as NF service consumer. + +"acceptencoding" (Optional parameter): Accept Encoding carries a string indicating the accepted content encodings supported by the sender as NF service consumer, when receiving notifications defined by the service. In the ABNF definition, "codings" and "weight" are defined in IETF RFC 9110 [11] clauses 12.5.3 and 12.4.2. + +"intraPlmnCallbackRoot", "interPlmnCallbackRoot" (Optional parameters): intra plmn callback root and inter plmn callback root supported by the sender as NF service consumer, for the indicated service. + +"callback-uri-prefix" (Optional parameter): The NF service consumer may include this parameter when providing a Callback URI when the authority part of the Callback URI is shared by several NF service consumer instances. The NF service consumer may also include this header when providing a Callback URI including a prefix, for use during NF service consumer reselection, when binding procedures are not supported. When present, the "callback-uri-prefix" shall be a path-absolute as specified IETF RFC 3986 [14] (i.e. the first path segment(s) after the authority) which is part of the Callback URI provided by a NF service consumer in the corresponding service request message sent to a NF service producer. The authority and "callback-uri-prefix" in the Callback URI shall uniquely identify a consumer service instance. See clause 6.12.1 for the usage of this parameter. + +EXAMPLE 1: The NF consumer supports Namf\_EventExposure OpenAPI "v1" without any optional feature: + +3gpp-Sbi-Consumer-Info: service=namf-evts; apiversion=(1) + +EXAMPLE 2: The NF consumer supports Nsmf\_EventExposure OpenAPI "v1" and "v2" with optional feature number 1 and accepted encoding "gzip": + +3gpp-Sbi-Consumer-Info: service=nsmf-event-exposure; apiversion=(1 2); supportedfeatures=01; acceptencoding="gzip; q=1.0, \*;q=0.5" + +EXAMPLE 3: The NF consumer supports both Namf\_EventExposure OpenAPI "v1" and Nsmf\_EventExposure OpenAPI "v2": + +3gpp-Sbi-Consumer-Info: service=namf-evts; apiversion=(1), service=nsmf-event-exposure; apiversion=(2) + +EXAMPLE 4: An AMF service instance supports Nsmf\_PDUSession OpenAPI "v1", provides the callback URI , whereby the authority is shared by more than one AMF service instance, while the prefix "/servinst123" uniquely identifies a specific AMF service instance: + +3gpp-Sbi-Consumer-Info: service=nsmf-pdusession; apiversion=(1); callback-uri-prefix="/servinst123" + +EXAMPLE 5: The NF consumer supports Namf\_EventExposure OpenAPI "v1" and sends intra PLMN callback root "https://operator.com" and inter PLMN callback root "https://5gc.mnc012.mcc345.3gppnetwork.org" in the header: + +3gpp-Sbi-Consumer-Info: service=namf-evts; apiversion=(1); +intraPlmnCallbackRoot="https://operator.com"; +interPlmnCallbackRoot="https://5gc.mnc012.mcc345.3gppnetwork.org" + +##### 5.2.3.3.8 3gpp-Sbi-Response-Info + +The header contains a list of additional information related to an HTTP response. It may be included e.g. in a 4xx or 5xx response sent: + +- by an SCP to indicate whether it attempted to retransmit the request to alternative HTTP server instances; or +- by an alternative HTTP server instance to indicate whether the corresponding resource or context has been transferred to the alternative HTTP server instance, or by an HTTP server instance to indicate that the failed request shall not be retried. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Response-Info-Header = "3gpp-Sbi-Response-Info:" OWS resp-info-param *( ";" OWS resp-info-param +) OWS + +resp-info-param = resp-info-param-name "=" OWS resp-info-param-value + +resp-info-param-name = "request-retransmitted" / "nfinst" / "nfset" / "nfservinst" / "nfserviceset" +/ "context-transferred" / "no-retry" / token + +resp-info-param-value = token +``` + +The following parameters are defined: + +- "request-retransmitted": this parameter indicates, in an error response, whether the SCP attempted to (re)transmit the request to alternative HTTP server instances. When present, it shall be set to "true" if so, and to "false" otherwise. See clause 6.10.8.1. +- "nfinst", "nfset", "nfservinst", "nfserviceset": one or more of these parameters may be present in an error response, when the request-retransmitted is set to "true". When present, it shall indicate the NF Instances, NF Sets, NF Service Instances or NF Service Sets that were attempted to serve the request. See clause 6.10.8.1. The value of the nfinst, nfset, nfservinst and nfserviceset parameters shall be encoded as defined for the corresponding parameters in clause 5.2.3.2.5. +- "context-transferred": this parameter indicates, in an error response, whether the corresponding resource or context has been transferred to the HTTP server instance sending the response. When present, it shall be set to "true" if the request has been transferred, i.e. the subsequent requests towards the resource or context shall be sent to the HTTP server instance sending the response, and to "false" otherwise. +- "no-retry": this parameter indicates, in an error response, whether the failed request can be retried at other alternative HTTP server instance or not. When present, it shall be set to "true" if the failed request shall not be retried at other alternative NF instances, and to "false" otherwise. + +NOTE: Additional parameters can be defined in future versions of the specification. + +EXAMPLE 1: 3gpp-Sbi-Response-Info: request-retransmitted=true + +EXAMPLE 2: 3gpp-Sbi-Response-Info: request-retransmitted=true; nfinst=54804518-4191-46b3-955c-ac631f953ed8; nfinst=54804518-4191-46b3-955c-ac631f953456; nfinst=54804518-4191-46b3-955c-ac631f953780 + +EXAMPLE 3: 3gpp-Sbi-Response-Info: context-transferred=false; no-retry=true + +##### 5.2.3.3.9 Void + +##### 5.2.3.3.10 3gpp-Sbi-Selection-Info + +The header contains a comma-delimited list of additional (re)selection information for an HTTP request message. It may be included by a NF service consumer or a NF service producer in a HTTP request message for indirect communication. If the header is received by the SCP and the SCP supports the header, the SCP shall: + +- avoid forwarding the request message to the target NF as indicated in the 3gpp-Sbi-Target-apiRoot (if present in the request) or the request URI (otherwise) if reselection is set "true", i.e., the SCP shall perform a reselection; and +- use the selection-criteria included in this header together with 3gpp-Sbi-Routing-Binding or 3gpp-Sbi-Discovery-\* headers whichever available, when the SCP performs the (re)selection of the target NF. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Selection-Info-Header = "3gpp-Sbi-Selection-Info:" OWS 1#( selection-info-element ) OWS + +selection-info-element = ( "reselection=" reselectionvalue *( ";" OWS selection-criteria ) ) + / ( selection-criteria *( ";" OWS selection-criteria ) ) + +reselectionvalue = "true" / "false" + +selection-criteria = selection-action "=" token + +selection-action = "not-select-nfservinst" / "not-select-nfserviceset" / "not-select-nfinst" / "not-select-nfset" +``` + +- reselection: it is a boolean and set to "false" by default. When it is set to "true", it indicates that the SCP shall perform a reselection, i.e., the SCP shall not forward the request message towards the target as indicated in the target uri or in the 3gpp-Sbi-Target-ApiRoot. When this parameter occurs multiple times in the comma-delimited list, all parameters shall have the same value. +- not-select-nfservinst (the NF service instance(s) that shall not be selected): indicates an NF Service Instance ID. This parameter shall be present if the sender of the request message knows that the target NF or other potential target NF service instance that shall not be selected, e.g., when the target NF service instance is overloaded, or some NF service instances are out of service. (see also clause 6.4.3.4.5.2.1) When this parameter is present, one of not-select-nfserviceset or not-select-nfinst shall be present to enable the SCP to identify the nfservinst. +- not-select-nfserviceset (the NF service instance pertaining to a NF service set in a NF instance that shall not be selected): indicates an NF Service Set ID as defined in clause 28.13 in 3GPP TS 23.003 [15]. This parameter shall be present if the sender of the request message knows that all NF service instances in the NF service set shall not be selected, e.g., when target NF service instance has indicated its overload and the overload scope is NF service set level, in this case, not-select-nfservinst shall not be present. (see also clause 6.4.3.4.5.2.1) +- not-select-nfinst (the NF instance(s) that shall not be selected): indicates an NF Instance ID, as defined in clause 5.2.2.2.2 in 3GPP TS 29.510 [8]. This parameter shall be present if the sender of the request message knows the target NF instance or other potential target NF instance that shall not be selected, e.g., when the target NF instance is overloaded, or other NF instance(s) is out of service, in this case, not-select-nfservinst shall not be present. (see also clause 6.4.3.4.5.2.1) +- not-select-nfset (the NF set that shall not be selected): indicates an NF Set ID, as defined in clause 28.12 in 3GPP TS 23.003 [15]. This parameter may be present, e.g., during an initial resource creation with Delegated Discovery (Indirect Communication Mode D), the NF service consumer knows certain NF set shall not be selected. + +EXAMPLE 1: The SCP may or may not perform reselection, but when doing reselection, it shall not select NF instance as identified by 87654321-4191-46b3-955c-ac631f953ed8. + +3gpp-Sbi-Selection-Info: not-select-nfinst=87654321-4191-46b3-955c-ac631f953ed8 + +EXAMPLE 2: The SCP may or may not perform reselection, but when doing reselection, it shall not select NF service set in the NF instance (as identified in nfi87654321-4191-46b3-955c-ac631f953ed8). + +3gpp-Sbi-Selection-Info: not-select-nfserviceset=setxyz.snnsmf-pdusession.nfi87654321-4191-46b3-955c-ac631f953ed8.5gc.mnc012.mcc345 + +EXAMPLE 3: The SCP shall perform reselection; and when doing reselection, it shall not select NF instance as identified by 87654321-4191-46b3-955c-ac631f953ed8. + +3gpp-Sbi-Selection-Info: reselection=true; not-select-nfinst=87654321-4191-46b3-955c-ac631f953ed8 + +EXAMPLE 4: The SCP shall perform reselection; and when doing reselection, the SCP shall not select NF service instance xyz1 and xyz2 in the NF instance identified by 87654321-4191-46b3-955c-ac631f953ed8, and NF service instance abc1 and abc2 in the NF instance identified by 12345678-4191-46b3-955c-ac631f953ed8. + +3gpp-Sbi-Selection-Info: reselection=true; not-select-nfservinst=xyz1; not-select-nfservinst=xyz2; not-select-nfinst=87654321-4191-46b3-955c-ac631f953ed8, reselection=true; not-select-nfservinst=abc1; not-select-nfservinst=abc2; not-select-nfinst=12345678-4191-46b3-955c-ac631f953ed8 + +##### 5.2.3.3.11 3gpp-Sbi-Interplmn-Purpose + +The header contains the intended purpose for inter-PLMN signaling. See clauses 6.14. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +Sbi-Interplmn-Purpose-Header = "3gpp-Sbi-Interplmn-Purpose:" OWS N32Purpose ":" OWS additional-info +OWS + +N32Purpose = "ROAMING" + / "INTER\_PLMN\_MOBILITY" + / "SMS\_INTERCONNECT" + / "ROAMING\_TEST" + / "INTER\_PLMN\_MOBILITY\_TEST" + / "SMS\_INTERCONNECT\_TEST" + / "SNPN\_INTERCONNECT" + / "SNPN\_INTERCONNECT\_TEST" + / "DISASTER\_ROAMING" + / "DISASTER\_ROAMING\_TEST" + / token + +additional-info = token + +- N32Purpose: The parameter for N32Purpose indicates the intended purpose of inter-PLMN signaling, and values specified in 3GPP TS 29.573 [27] clause 6.1.5.3.9 are used. + +EXAMPLE: 3gpp-Sbi-Interplmn-Purpose: ROAMING: usecaseA + +##### 5.2.3.3.12 3gpp-Sbi-Request-Info + +The header contains a list of additional information related to a HTTP request which may be included by a NF or a SCP, to indicate e.g.: + +- whether the HTTP request message is involving a reselection of an alternative NF; +- whether the HTTP request message is a retransmission of the message, i.e. the request message has been sent but being rejected with a temporary failure or timeout; + +When the header is included by a NF acting as a HTTP client, an idempotency-key may be included for a non-idempotent request to enable the receiver to detect possible duplicated request messages as specified in clause 5.2.8. + +The receiving NF may use the header, e.g. to determine whether to accept the request. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Request-Info-Header = "3gpp-Sbi-Request-Info:" OWS req-param *( ";" OWS req-param ) OWS +``` + +``` +req-param = req-param-name "=" OWS req-param-value +``` + +``` +req-param-name = "retrans" / "redirect" / "reason" / "idempotency-key" / "receivedrejectioncause" / +"callback-uri-prefix" / token +``` + +``` +req-param-value = token +``` + +The following parameters are defined: + +- "reason": indicates the reason for which the NF resends or redirects the HTTP request message. This may take one of the following values: + - "unreachable": indicates that the HTTP request is redirected to an alternative NF due to the request URI (e.g. the resource URI or Notification/callback URI) is not reachable; + - "overloaded": indicates that the HTTP request is redirected to an alternative NF as result of overload control enforcement, by doing redirection towards an alternative NF (see clause 6.4.3.5.1); + - "3xx-redirect": indicates that the HTTP request is redirected to an alternative NF as result of receiving a 3xx status code. + - "temporary-rejection-cause": indicates the HTTP request is retransmitted towards the same or alternative NF due to a temporary rejection. +- "receivedrejectioncause": indicates a temporary rejection application cause received from the NF or SCP (for last attempt) as defined in clause 5.2.7.2, when the "retrans" parameter is set to "true" and the reason is set to "temporary-rejection-cause". The cause data type is specified in clause 5.2.4.1 of 3GPP TS 29.571 [13]. +- "retrans": it is a boolean and shall be set to "true" to indicate that the request message has been retransmitted e.g. when the request didn't get any response or get a temporary failure cause, otherwise the "retrans" shall not be present. +- "redirect": it is a boolean and shall be set to "true" to indicate that the request message has been redirected to an alternative NF. +- "idempotency-key": it is a string and may be encoded using Universally Unique Identifier (UUID), as described in IETF RFC 4122 [47], to uniquely identify a request message (to be received) in the target NF. See clause 5.2.8. +- "callback-uri-prefix": path-absolute as specified IETF RFC 3986 [14] (i.e. the first path segment(s) after the authority) which is part of the Callback URI. The ABNF is defined in clause 5.2.3.3.7. + +EXAMPLE 1: For a request retransmitted to an alternative NF due to the rejection by the original target NF with a temporary rejection cause: + +``` +3gpp-Sbi-Request-Info: retrans=true; redirect=true; reason=temporary-rejection-cause; +receivedrejectioncause=INSUFFICIENT_RESOURCES +``` + +EXAMPLE 2: For a request sent towards an alternative NF due to the original target NF not reachable: + +``` +3gpp-Sbi-Request-Info: redirect=true; reason=unreachable +``` + +EXAMPLE 3: For a non-idempotent request: + +``` +3gpp-Sbi-Request-Info: idempotency-key=54804518-4191-46b3-955c-ac631f953ed8 +``` + +EXAMPLE 4: For a notification request with a callback URI containing the prefix "/abc": + +3gpp-Sbi-Request-Info: callback-uri-prefix="/abc" + +##### 5.2.3.3.13 3gpp-Sbi-Retry-Info + +The header may be included in a HTTP request message for indirect communication to indicate that the request shall only be sent once and shall not be retried. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Retry-Info-Header = "3gpp-Sbi-Retry-Info:" OWS retriesindication OWS +retriesindication = "no-retries" +``` + +The following value is defined: + +- "no-retries" indicates that the request shall only be sent once and shall not be retried to the same nor alternative endpoints of the same target NF service instance nor towards another target NF service instance once the request has been forwarded once. + +EXAMPLE 1: NF service consumer instructing the SCP to not perform any retries: + +3gpp-Sbi-Retry-Info: no-retries + +EXAMPLE 2: NF service consumer instructing the SCP to perform an NF reselection, not reselecting the NF instance identified by 87654321-4191-46b3-955c-ac631f953ed8, and to not perform any retries then if no successful response is received from the reselected NF instance. + +``` +3gpp-Sbi-Selection-Info: reselection=true; not-select-nfinst=87654321-4191-46b3-955c-ac631f953ed8 +3gpp-Sbi-Retry-Info: no-retries +``` + +##### 5.2.3.3.14 3gpp-Sbi-Other-Access-Scopes + +The header indicates other access scopes that are desired to be obtained for the access token, in addition to the scopes indicated in the 3gpp-Sbi-Access-Scope, that are not required for the service request itself but that may be required for further service requests. It enables the SCP to request access tokens that can be reused in further service requests, for NF service access authorization as defined in clauses 6.7.3 and 6.10.11. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [11]. + +``` +Sbi-Other-Access-Scopes-Header = "3gpp-Sbi-Other-Access-Scopes:" OWS scope-token *(SP scope-token) +OWS +``` + +Scope-token shall consist of a list of space-delimited, case-sensitive strings, containing one or more NF service name(s) of the NF service producer and/or additional resource/operation-level scope(s) for these API(s) that are not already contained in the 3gpp-Sbi-Access-Scope header. The ABNF is defined in clause 5.2.3.2.16. + +NQCHAR is defined in Appendix A of IETF RFC 6749 [22]. + +NOTE: This corresponds to the "scope" syntax defined for OAuth in clauses 3.3 and A.4 of IETF RFC 6749 [22] and also to the syntax of the "scope" parameter in AccessTokenReq in 3GPP TS 29.510 [8]. This enables the SCP to include in the scope parameter in the Nnrf\_Get Access Token Request, in addition to the scopes required for an incoming service request determined from the 3gpp-Sbi-Access-Scope header (see clause 5.2.3.2.16), the value of the 3gpp-Sbi-Other-Access-Scopes header received in the service request, or a list of scopes that is the intersection of the scopes indicated in the 3gpp-Sbi-Other-Access-Scopes header and the scopes expected by the NF Service producer (as registered in its NF profile). + +EXAMPLE 1: 3gpp-Sbi-Access-Scope: nudm-uecm nudm-uecm:amf-registration:write + 3gpp-Sbi-Other-Access-Scopes: nudm-sdm nudm-sdm:am-data:read nudm-sdm:smf-select-data:read + +EXAMPLE 2: 3gpp-Sbi-Access-Scope: namf-comm namf-comm:n1-n2-messages +3gpp-Sbi-Other-Access-Scopes: namf-comm:ue-contexts:assign-ebi + +### 5.2.4 HTTP error handling + +HTTP/2 connection error and stream error shall be supported as specified in clause 5.4 of IETF RFC 9113 [7]. + +Guidelines for error responses to the invocation of APIs of NF services are specified in clause 4.8 of 3GPP TS 29.501 [3]. API specific error responses are specified in the respective technical specifications. + +### 5.2.4 HTTP error handling + +HTTP/2 connection error and stream error shall be supported as specified in clause 5.4 of IETF RFC 9113 [7]. + +Guidelines for error responses to the invocation of APIs of NF services are specified in clause 4.8 of 3GPP TS 29.501 [3]. API specific error responses are specified in the respective technical specifications. + +### 5.2.5 HTTP/2 server push + +HTTP/2 Server Push as specified in clause 8.4 of IETF RFC 9113 [7] may be supported and may be used by a NF Service Producer to proactively push resources to a NF Service Consumer, see clause 4.9.5 of 3GPP TS 29.501 [5]. + +A NF Service Consumer may choose to disable HTTP/2 Server Push by setting SETTINGS\_ENABLE\_PUSH to 0, as specified in clause 8.4 of IETF RFC 9113 [7]. + +### 5.2.6 HTTP/2 connection management + +The HTTP request / response exchange mechanism as specified in clause 8.1 of IETF RFC 9113 [7] shall be supported between the 3GPP NFs. An HTTP/2 endpoint shall support establishing multiple HTTP/2 connections (at least two) towards a peer HTTP/2 endpoint. The peer HTTP/2 endpoint is identified by host and port pair where the host is derived from the target URI (see clause 6.1.1). + +NOTE 1: HTTP/2 connection redundancy allows transporting messages through diverse IP paths and improve 5GC resiliency. + +As per clause 8.1 of IETF RFC 9113 [7] a HTTP request / response exchange fully consumes a single stream. When the HTTP/2 Stream IDs on a given HTTP/2 connection is exhausted, an HTTP/2 endpoint, shall establish another HTTP/2 connection towards that peer HTTP/2 endpoints. + +NOTE 2: As per IETF RFC 9113 [7], a stream ID once closed cannot be reused on the same HTTP/2 connection. + +The 3GPP NF shall take care to avoid simultaneous stream ID exhaustion on all the available HTTP/2 connections towards each peer. + +The 3GPP NF shall support gracefully shutdown of a HTTP/2 connection by sending a GOAWAY frame with "Error Code" field set to "NO\_ERROR (0x0)". The HTTP connection should remain "open" (by the sender and receiver of GOAWAY frame) until all in-progress streams numbered lower or equal to the last stream identifier indicated by the "Last-Stream-Id" field in the GOAWAY frame are completed. See clause 6.8 of IETF RFC 9113 [7]. + +An NF acting as an HTTP/2 client shall support testing whether a connection is still active by sending a PING frame. An NF acting as an HTTP/2 server may test whether a connection is still active by sending a PING frame. An NF acting as an HTTP/2 client or server shall respond to received PING frames as specified in clause 6.7 of IETF RFC 9113 [7]. When and how often a PING frame may be sent is implementation specific but shall be configurable by operator policy. When HTTP server detects the connection failure, it shall follow connection error handling as defined in clause 5.4.1 of RFC 9113 [7]. + +NOTE 1: The above requirement also applies to network entities such as SCP and SEPP. + +A PING frame shall not be sent more often than every 60 s on each path. + +### 5.2.7 HTTP status codes + +#### 5.2.7.1 General + +This clause describes the HTTP status codes usage on SBI. + +HTTP status codes are carried in ":status" pseudo header field in HTTP/2, as defined in clause 8.1.2.4 in IETF RFC 9113 [7]. + +Table 5.2.7.1-1 specifies HTTP status codes per HTTP method which shall be supported on SBI. Support of an HTTP status code shall be: + +- mandatory, which is marked in table as "M". This means that all 3GPP NFs shall support the processing of the specific HTTP status code for the specific HTTP method, when received in a HTTP response message. In such cases the 3GPP NF shall also support the handling of the "ProblemDetails" JSON object with the Content-Type header field set to the value "application/problem+json" for HTTP status codes 4xx and 5xx, if the corresponding API definition in the related technical specification does not specify another response body for the corresponding status code; +- service specific, which is marked in table as "SS" and means that the requirement to process the HTTP status code depends on the definition of the specific API; or +- not applicable, which is marked in table as "N/A". This means that the specific HTTP status code shall not be used for the specific HTTP method within the 3GPP NFs. + +Table 5.2.7.1-1: HTTP status code supported on SBI + +| HTTP status code | HTTP method | | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-------------|-------|------|-----|---------| +| | DELETE | GET | PATCH | POST | PUT | OPTIONS | +| 100 Continue | N/A | N/A | N/A | N/A | N/A | N/A | +| 200 OK (NOTE 1, NOTE 2) | SS | M | SS | SS | SS | M | +| 201 Created | N/A | N/A | N/A | SS | SS | N/A | +| 202 Accepted | SS | N/A | SS | SS | SS | N/A | +| 204 No Content (NOTE 2) | M | N/A | SS | SS | SS | SS | +| 300 Multiple Choices | N/A | N/A | N/A | N/A | N/A | N/A | +| 303 See Other | SS | SS | N/A | SS | SS | N/A | +| 307 Temporary Redirect | SS | SS | SS | SS | SS | SS | +| 308 Permanent Redirect | SS | SS | SS | SS | SS | SS | +| 400 Bad Request | M | M | M | M | M | M | +| 401 Unauthorized | M | M | M | M | M | M | +| 403 Forbidden | M | M | M | M | M | M | +| 404 Not Found | M | M | M | M | M | M | +| 405 Method Not Allowed | SS | SS | SS | SS | SS | SS | +| 406 Not Acceptable | N/A | M | N/A | N/A | N/A | SS | +| 408 Request Timeout | SS | SS | SS | SS | SS | SS | +| 409 Conflict | N/A | SS | SS | SS | SS | N/A | +| 410 Gone | SS | SS | SS | SS | SS | SS | +| 411 Length Required | N/A | N/A | M | M | M | SS | +| 412 Precondition Failed | SS | SS | SS | SS | SS | N/A | +| 413 Content Too Large | N/A | N/A | M | M | M | SS | +| 414 URI Too Long | N/A | SS (NOTE 3) | N/A | N/A | SS | N/A | +| 415 Unsupported Media Type | N/A | N/A | M | M | M | SS | +| 429 Too Many Requests | M | M | M | M | M | M | +| 500 Internal Server Error | M | M | M | M | M | M | +| 501 Not Implemented | SS | SS | SS | SS | SS | SS | +| 502 Bad Gateway | M | M | M | M | M | M | +| 503 Service Unavailable | M | M | M | M | M | M | +| 504 Gateway Timeout (NOTE 4) | SS | SS | SS | SS | SS | SS | +| NOTE 1: "200 OK" response used on SBI shall contain body. | | | | | | | +| NOTE 2: If the NF acting as an HTTP Client receives 2xx response code not appearing in table, the NF shall treat the received 2xx response:
- as "204 No Content" if 2xx response does not contain body; and
- as "200 OK" if 2xx response contains body. | | | | | | | +| NOTE 3: If GET method includes any query parameter, the NF acting as an HTTP Client shall support "414 URI Too Long" status code. | | | | | | | +| NOTE 4: A 5GC Network Function acting as an HTTP Client and supporting indirect communications shall support "504 Gateway Timeout" status code with "ProblemDetails" (see clause 6.10.8.2). | | | | | | | + +#### 5.2.7.2 NF as HTTP Server + +A NF acting as an HTTP server shall be able to generate HTTP status codes specified in clause 5.2.7.1 per indicated HTTP method. + +A request using an HTTP method which is not supported by any resource of a given 5GC SBI API shall be rejected with the HTTP status code "501 Not Implemented". + +NOTE 1: In this case, the NF does not need to include in the HTTP response the "cause" attribute indicating corresponding error since the HTTP status code "501 Not Implemented" itself provides enough information of the error, i.e. the NF does not recognize the HTTP method. + +If the specified target resource does not exist, the NF shall reject the HTTP method with the HTTP status code "404 Not Found". + +If the NF supports the HTTP method for several resources in the API, but not for the target resource of a given HTTP request, the NF shall reject the request with the HTTP status code "405 Method Not Allowed" and shall include in the response an Allow header field containing the supported method(s) for that resource. + +NOTE 2: In this case, the NF does not need to include in the HTTP response the "cause" attribute indicating corresponding error since the HTTP status code "405 Method Not Allowed" itself provides enough information of the error and hence the Allow header field lists HTTP method(s) supported by the target resource. + +If a received HTTP request contains unknown IEs, i.e. Information Elements within the JSON body, the NF may discard such IEs and shall process the rest of the request message, unless the schema definition of the received message prohibits the presence of additional IEs or constrains their types. There are cases (e.g. Nnrf\_NFManagement API) where the receiver of certain HTTP requests needs to process unknown IEs (e.g. to store in NRF an NF Profile containing vendor-specific attributes, and send them in NFDiscovery results). + +If a received HTTP request contains IEs or query parameters not compliant with the schema defined in the corresponding OpenAPI specification, the NF should reject the request with the appropriate error code, e.g. "400 Bad Request (INVALID\_MSG\_FORMAT)", even when the failed IEs are defined as optional by the schema. + +If a received HTTP PATCH request contains a body with modification instruction(s) for unknown attribute(s) in addition to modification instruction(s) for known attribute(s), the NF shall: + +- a) implement all the modification(s) for known attribute(s) and unknown attribute(s) if explicitly specified in the corresponding specification of the API; or +- b) otherwise, implement the modification(s) for known attribute(s) and discard those modification instruction(s) for unknown attribute(s). The NF may additionally indicate in the response the result of the execution of the PATCH request, i.e. which modification(s) are implemented and/or which modification(s) are discarded, using the "PatchResult" JSON object as defined in 3GPP TS 29.571 [13]. + +If the NF supports the HTTP method by a target resource but the NF cannot successfully fulfil the received request, the following requirements apply. + +A NF as HTTP Server should map status codes to the most similar 3xx/4xx/5xx HTTP status code specified in table 5.2.7.1-1. If no such code is applicable, it should use "400 Bad Request" status code for errors caused by client side or "500 Server Internal Error" status code for errors caused on server side. + +If the received HTTP request contains unsupported content format, the NF shall reject the HTTP request with the HTTP status code "415 Unsupported Media Type". If the HTTP PATCH method is rejected due to unsupported patch document, the NF shall include the Accept-Patch header field set to the value of supported patch document media types for a target resource i.e. to "application/merge-patch+json" if the NF supports "JSON Merge Patch" and to "application/json-patch+json" if the NF supports "JSON Patch". If the received HTTP PATCH request contains both "JSON Merge Patch" and "JSON Patch" documents and the NF supports only one of them, the NF shall ignore unsupported patch document. + +NOTE 3: The format problem might be due to the request's indicated Content-Type or Content-Encoding header fields, or as a result of inspecting the content directly. + +If the received HTTP request contains content larger than the NF is able to process, the NF shall reject the HTTP request with the HTTP status code "413 Content Too Large". + +If the result of the received HTTP POST request used for a resource creation would be equivalent to the existing resource, the NF shall reject the HTTP request with the HTTP status code "303 See Other" and shall include in the HTTP response a Location header field set to the URI of the existing resource. + +Protocol and application errors common to several 5GC SBI API specifications for which the NF shall include in the HTTP response content a "ProblemDetails" data structure or application specific error data structure with the "cause" attribute indicating corresponding error are listed in table 5.2.7.2-1. + +**Table 5.2.7.2-1: Protocol and application errors common to several 5GC SBI API specifications (HTTP server)** + +| Protocol or application Error | HTTP status code | Description | +|------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| INVALID_API | 400 Bad Request | The HTTP request contains an unsupported API name or API version in the URI. | +| INVALID_MSG_FORMAT | 400 Bad Request | The HTTP request has an invalid format. | +| INVALID_QUERY_PARAM | 400 Bad Request | The HTTP request contains an unsupported query parameter in the URI. (NOTE 1) | +| MANDATORY_QUERY_PARAM_INCORRECT | 400 Bad Request | A mandatory query parameter, or a conditional query parameter but mandatory required, for an HTTP method was received in the URI with semantically incorrect value. (NOTE 1) | +| OPTIONAL_QUERY_PARAM_INCORRECT | 400 Bad Request | An optional query parameter for an HTTP method was received in the URI with a semantically incorrect value that prevents successful processing of the service request. (NOTE 1) | +| MANDATORY_QUERY_PARAM_MISSING | 400 Bad Request | Query parameter which is defined as mandatory, or as conditional but mandatory required, for an HTTP method is not included in the URI of the request. (NOTE 1) | +| MANDATORY_IE_INCORRECT | 400 Bad Request | A mandatory IE (within the JSON body or within a variable part of an "apiSpecificResourceUriPart" or within an HTTP header), or conditional IE but mandatory required, for an HTTP method was received with a semantically incorrect value. (NOTE 1) | +| OPTIONAL_IE_INCORRECT | 400 Bad Request | An optional IE (within the JSON body or within an HTTP header) for an HTTP method was received with a semantically incorrect value that prevents successful processing of the service request. (NOTE 1) | +| MANDATORY_IE_MISSING | 400 Bad Request | A mandatory IE (within the JSON body or within the variable part of an "apiSpecificResourceUriPart" or within an HTTP header), or conditional IE but mandatory required, for an HTTP method is not included in the request. (NOTE 1) | +| UNSPECIFIED_MSG_FAILURE | 400 Bad Request | The request is rejected due to unspecified client error. (NOTE 2) | +| RESOURCE_CONTEXT_NOT_FOUND | 400 Bad Request | The notification request is rejected because the callback URI still exists in the receiver of the notification, but the specific resource context identified within the notification content is not found in the NF service consumer. | +| CCA_VERIFICATION_FAILURE | 403 Forbidden | The request is rejected due to a failure to verify the 3gpp-Sbi-Client-Credentials at the receiving entity (e.g. NRF or NF service producer). | +| SOURCE_NF_CCA_VERIFICATION_FAILURE | 403 Forbidden | The request is rejected due to a failure to verify the 3gpp-Sbi-Source-NF-Client-Credentials at the receiving entity (e.g. NRF or NF service producer). | +| TOKEN_CCA_MISMATCH | 403 Forbidden | The request is rejected due to a mismatch between the subject claim in the access token and subject claim in the 3gpp-Sbi-Client-Credentials . | +| TOKEN_SOURCE_NF_CCA_MISMATCH | 403 Forbidden | The request is rejected due to a mismatch between the sourceNFInstanceId claim in the access token and subject claim in the 3gpp-Sbi-Source-NF-Client-Credentials. | +| MODIFICATION_NOT_ALLOWED | 403 Forbidden | The request is rejected because the contained modification instructions attempt to modify IE which is not allowed to be modified. | + +| | | | +|----------------------------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SUBSCRIPTION_NOT_FOUND | 404 Not Found | The request for modification or deletion of a subscription, or the notification request, is rejected because the subscription is not found in the NF. | +| RESOURCE_URI_STRUCTURE_NOT_FOUND | 404 Not Found | The request is rejected because a fixed part after the first variable part of an "apiSpecificResourceUriPart" (as defined in clause 4.4.1 of 3GPP TS 29.501 [5]) is not found in the NF.
This fixed part of the URI may represent a sub-resource collection (e.g. contexts, subscriptions, policies) or a custom operation. (NOTE 5) | +| INCORRECT_LENGTH | 411 Length Required | The request is rejected due to incorrect value of a Content-length header field. | +| NF_CONGESTION_RISK | 429 Too Many Requests | The request is rejected due to excessive traffic which, if continued over time, may lead to (or may increase) an overload situation of the NF instance. (NOTE 7) | +| NF_SERVICE_CONGESTION_RISK | 429 Too Many Requests | The request is rejected due to excessive traffic which, if continued over time, may lead to (or may increase) an overload situation of the NF service instance. (NOTE 7) | +| INSUFFICIENT_RESOURCES | 500 Internal Server Error | The request is rejected due to insufficient resources. | +| UNSPECIFIED_NF_FAILURE | 500 Internal Server Error | The request is rejected due to unspecified reason at the NF. (NOTE 3) | +| SYSTEM_FAILURE | 500 Internal Server Error | The request is rejected due to generic error condition in the NF. | +| NF_FAILOVER | 500 Internal Server Error | The request is rejected due to the unavailability of the NF, and the requester may trigger an immediate re-selection of an alternative NF based on this information. (NOTE 6) (NOTE 8). | +| NF_SERVICE_FAILOVER | 500 Internal Server Error | The request is rejected due to the unavailability of the NF service, and the requester may trigger an immediate re-selection of an alternative NF service based on this information. (NOTE 6) (NOTE 8). | +| INBOUND_SERVER_ERROR | 502 Bad Gateway | The request is rejected due to the receipt of an 5xx error from an inbound server that the NF Service Producer accessed while attempting to fulfil the request (see clause 6.4.2.1). | +| NF_CONGESTION | 503 Service Unavailable | The NF instance experiences congestion and performs overload control, which does not allow the request to be processed. (NOTE 4) (NOTE 7) | +| NF_SERVICE_CONGESTION | 503 Service Unavailable | The NF service instance experiences congestion and performs overload control, which does not allow the request to be processed. (NOTE 4) (NOTE 7) | +| TARGET_NF_NOT_REACHABLE | 504 Gateway Timeout | The request is not served as the target NF is not reachable. (NOTE 6) | +| TIMED_OUT_REQUEST | 504 Gateway Timeout | The request is rejected due a request that has timed out at the HTTP client (see clause 6.11.2). | + +- NOTE 1: "invalidParams" attribute shall be included in the "ProblemDetails" data structure indicating unsupported, missing or incorrect IE(s) or query parameter(s) or 3gpp-Sbi-Discovery-\* header(s). +- NOTE 2: This application error indicates error in the HTTP request and there is no other application error value that can be used instead. +- NOTE 3: This application error indicates error condition in the NF and there is no other application error value that can be used instead. +- NOTE 4: If the reason for rejection is a temporary overload, the NF may include in the response a Retry-After header field to indicate how long the service is expected to be unavailable. +- NOTE 5: If the request is rejected because of an error in an URI before the first variable part of an "apiSpecificResourceUriPart", the "404 Not Found" HTTP status code may be sent without "ProblemDetails" data structure indicating protocol or application error. +- NOTE 6: The NF service consumer (as receiver of the cause code) should stop sending subsequent requests addressing the resource contexts in the producer's NF instance (for NF\_FAILOVER) or NF service instance (for NF\_SERVICE\_FAILOVER) to avoid massive rejections. The NF service consumer may reselect an alternative NF service producer as specified clause 6.5 of 3GPP TS 23.527 [38], e.g. using the Binding Indication of resource context. It is implementation specific for the NF service consumer to determine when and whether the NF producer becomes available again, e.g. when there is no other alternative available or at expiry of a local configured timer. +- NOTE 7: When a NF service producer receives NF\_CONGESTION\_RISK, NF\_SERVICE\_CONGESTION\_RISK, NF\_CONGESTION and NF\_SERVICE\_CONGESTION from a NF service consumer when sending a request message towards a callback/notification URI, the NF service producer shall identify the NF service consumer that is congested using either the authority of the notification/callback URI or together with the "callback-uri-prefix" if it is provided in 3gpp-Sbi-consumer-info as specified in clause 5.2.3.3.7. +- NOTE 8: The NF service producer (as receiver of the cause code) should stop sending subsequent notification requests addressing the session contexts towards the consumer NF (service) instance to avoid massive rejections, where the consumer NF (service) instance shall be identified by either the authority of the notification/callback URI or together with the "callback-uri-prefix" if it is provided in 3gpp-Sbi-consumer-info as specified in clause 5.2.3.3.7. The NF service producer may reselect an alternative NF service consumer as specified in clause 6.6 of 3GPP TS 23.527 [38], e.g. using the Binding Indication of the session context. It is implementation specific for the NF service producer to determine when and whether the NF consumer becomes available again, e.g. when there is no other alternative available or at expiry of a local configured timer. Note that if a consumer NF service instance complying with an earlier version of the specification shares the same authority with other consumer NF service instances and sends the NF\_FAILOVER and NF\_SERVICE\_FAILOVER causes to a NF service producer while not supporting the new callback-uri-prefix parameter in 3gpp-Sbi-consumer-info, this can result in the NF service producer no longer sending traffic to these consumer NF service instances sharing the same authority. + +#### 5.2.7.3 NF as HTTP Client + +Besides the HTTP Status Codes defined in the API specification, a NF as HTTP client should support handling of 1xx, 3xx, 4xx and 5xx HTTP Status Codes specified in table 5.2.7.1-1, following the client behaviour in corresponding IETF RFC where the received HTTP Status Code is defined. + +When receiving a not recommended or not recognized 1xx, 3xx, 4xx or 5xx HTTP Status Code, a NF as HTTP client should treat it as x00 status code of the class, as described in clause 15 of IETF RFC 9110 [11]. + +If 100, 200/204, 300, 400 or 500 response code is not defined by the API specification, the client may follow guidelines below: + +- a) For 1xx (Informational): + - 1) Discard the response and wait for final response. +- b) For 2xx (Successful): + - 1) Consider the service operation is successful if no mandatory information is expected from the response content in subsequent procedure. + - 2) If mandatory information is expected from response content in subsequent procedure, parse the content following description in clause 15.2.1 of IETF RFC 9110 [11]. If parse is successful and mandatory information is extracted, continue with subsequent procedure. + - 3) Otherwise, consider service operation has failure and start failure handling. +- c) For 3xx (Redirection): + +- 1) Retry the request towards the directed resource referred in the Location header, using same request method. +- d) For 4xx (Client Error): + - 1) Validate the request message and make correction before resending. Otherwise, stop process and go to error handling procedure. +- e) For 5xx (Server Error): + - 1) Stop process and go to error handling process. + +The handling of unknown, unexpected or erroneous HTTP request message IEs shall provide for the forward compatibility of the HTTP APIs used for the service-based interfaces. Therefore, the sending HTTP entity shall be able to safely include in a message a new optional IE. Such an IE may also have a new type. A receiving HTTP entity shall behave as specified in clause 5.2.7.2. + +If a received HTTP response message contains unknown IEs (Information Elements within the JSON body), the NF may discard those IEs and it shall process the rest of the response message, as long as it is compliant with the OpenAPI schema definition of such response message. + +If a received HTTP response message contains IEs not compliant with the schema defined in the corresponding OpenAPI specification (e.g., because the schema of the response body prohibits the presence of additional IEs or constrains their types), the NF shall stop processing such response message and go to error handling process. + +#### 5.2.7.4 SCP/SEPP + +The SCP or SEPP shall be able to forward the HTTP status codes defined in Table 5.2.7.1-1 and Table 5.2.7.2-1 from HTTP Server to HTTP client. In addition, it shall be able to generate HTTP status codes to indicate failures during indirect communication (e.g. see clauses 6.10.3.2 and 6.10.6), error handling (see clause 6.10.8), detection and handling of loop path (see clause 6.10.10) and SCP or SEPP overload control (see clause 6.4) as defined in Table 5.2.7.4-1 and Table 5.2.7.4-2. + +If the SCP or SEPP detects a loop in the routing path of an HTTP request, it should reject the request with the HTTP status code "400 Bad Request (MSG\_LOOP\_DETECTED)". + +If the received HTTP request contains content larger than the SCP or SEPP is able to process, the SCP or SEPP shall reject the HTTP request with the HTTP status code "413 Content Too Large". + +An HTTP status code "429 Too Many Requests (NF\_CONGESTION\_RISK)" is sent, when the SCP or SEPP detects that a given NF Service Consumer is sending excessive traffic which, if continued over time, may lead to (or may increase) an overload situation in the SCP or SEPP. If the SCP or SEPP decides to redirect HTTP requests to another less loaded SCP or SEPP, it may send the HTTP status code "307 Temporary Redirect" or "308 Permanent Redirect" with the cause attribute set to "SCP\_REDIRECTION" (see clause 6.10.9) / "SEPP\_REDIRECTION" as defined in Table 5.2.7.4-2. + +The SCP or SEPP should map status codes to the most similar 3xx/4xx/5xx HTTP status code specified in Table 5.2.7.4-1 and Table 5.2.7.4-2. If no such code is applicable, it should use "400 Bad Request" status code for errors caused by client side or "500 Server Internal Error" status code for errors caused on server side. + +**Table 5.2.7.4-1: Protocol and application errors generated by the SCP/SEPP** + +| Protocol or application Error | HTTP status code | Description | +|---------------------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| INVALID_API | 400 Bad Request | The HTTP request contains an unsupported API name or API version in the URI. | +| INVALID_MSG_FORMAT | 400 Bad Request | The HTTP request has an invalid format. | +| INVALID_QUERY_PARAM | 400 Bad Request | The HTTP request contains an unsupported query parameter in the URI. (NOTE 1) | +| MANDATORY_QUERY_PARAM_INCORRECT | 400 Bad Request | A mandatory query parameter, or a conditional query parameter but mandatory required, for an HTTP method was received in the URI with semantically incorrect value. (NOTE 1) | +| OPTIONAL_QUERY_PARAM_INCORRECT | 400 Bad Request | An optional query parameter for an HTTP method was received in the URI with a semantically incorrect value that prevents successful processing of the service request. (NOTE 1) | +| MANDATORY_QUERY_PARAM_MISSING | 400 Bad Request | Query parameter which is defined as mandatory, or as conditional but mandatory required, for an HTTP method is not included in the URI of the request. (NOTE 1) | +| MANDATORY_IE_INCORRECT | 400 Bad Request | A mandatory IE (within a variable part of an "apiSpecificResourceUriPart" or within an HTTP header), or conditional IE but mandatory required, for an HTTP method was received with a semantically incorrect value. (NOTE 1) | +| OPTIONAL_IE_INCORRECT | 400 Bad Request | An optional IE (within an HTTP header) for an HTTP method was received with a semantically incorrect value that prevents successful processing of the service request. (NOTE 1) | +| MANDATORY_IE_MISSING | 400 Bad Request | A mandatory IE (within the variable part of an "apiSpecificResourceUriPart" or within an HTTP header), or conditional IE but mandatory required, for an HTTP method is not included in the request. (NOTE 1) | +| UNSPECIFIED_MSG_FAILURE | 400 Bad Request | The request is rejected due to unspecified client error. (NOTE 2) | +| NF_DISCOVERY_FAILURE | 400 Bad Request | The request is rejected by the SCP because no NF Service Producer can be found matching the NF service discovery factors (see clause 6.10.6). | +| INVALID_DISCOVERY_PARAM | 400 Bad Request | The request is rejected by the SCP because it contains an unsupported discovery parameter (i.e. unknown 3gpp-Sbi-Discovery-* header) (see clause 6.10.3.2). (NOTE 1) | +| MSG_LOOP_DETECTED | 400 Bad Request | The request is rejected because message loop is detected. | +| MISSING_ACCESS_TOKEN_INFO | 400 Bad Request | The request is rejected due to missing information in the service request that prevents the SCP from requesting an access token to the Authorization Server. See clause 6.10.3.5. | +| ACCESS_TOKEN_DENIED | 403 Forbidden | The request is rejected due to the Authorization Server rejecting to grant an access token to the SCP. See clause 6.10.3.5. | +| PLMNID_MISMATCH | 403 Forbidden | The request is rejected by the SEPP due to the PLMN ID in the bearer token carried in the "Authorization" header of the reconstructed message does not match the PLMN ID of the N32-f context. | +| REQUESTED_PURPOSE_NOT_ALLOWED | 403 Forbidden | The request is rejected due to requested purpose provided in the HTTP request is not allowed by the policy. See clause 6.14. | +| INCORRECT_LENGTH | 411 Length Required | The request is rejected due to incorrect value of a Content-length header field. | +| NF_CONGESTION_RISK | 429 Too Many Requests | The request is rejected due to excessive traffic which, if continued over time, may lead to (or may increase) an overload situation. | +| INSUFFICIENT_RESOURCES | 500 Internal Server Error | The request is rejected due to insufficient resources. | + +| | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UNSPECIFIED_NF_FAILURE | 500 Internal Server Error | The request is rejected due to unspecified reason at the SCP or SEPP. (NOTE 3) | +| SYSTEM_FAILURE | 500 Internal Server Error | The request is rejected due to generic error condition in the SCP or SEPP. | +| NF_FAILOVER | 500 Internal Server Error | The request is rejected by the SCP due to the unavailability of the NF, and the requester may trigger an immediate re-selection of an alternative NF based on this information. | +| NF_SERVICE_FAILOVER | 500 Internal Server Error | The request is rejected by the SCP due to the unavailability of the NF service, and the requester may trigger an immediate re-selection of an alternative NF service based on this information. | +| MAX_SCP_HOPS_REACHED | 502 Bad Gateway | The request is rejected due to the maximum number of allowed SCP hops has been reached when relaying the request message to the target NF. | +| NF_DISCOVERY_ERROR | 502 Bad Gateway | The request is rejected due to the receipt of an 5xx or 429 response from the NRF during an NF Discovery procedure the SCP initiated to fulfil the request. | +| NF_CONGESTION | 503 Service Unavailable | The SCP or SEPP experiences congestion and performs overload control, which does not allow the request to be processed. (NOTE 4) | +| TIMED_OUT_REQUEST | 504 Gateway Timeout | The request is rejected due a request that has timed out at the HTTP client (see clause 6.11.2). | +| TARGET_NF_NOT_REACHABLE | 504 Gateway Timeout | The request is not served as the target NF is not reachable (see clause 6.10.8.2). | +| NRF_NOT_REACHABLE | 504 Gateway Timeout | The request is not served due to the NRF being unreachable (see clause 6.10.8.2). | +| TARGET_PLMN_NOT_REACHABLE | 504 Gateway Timeout | The request is not delivered due to issues on interconnect with another PLMN (e.g. issues on N32 connection including contractual reasons). | +| NOTE 1: "invalidParams" attribute shall be included in the "ProblemDetails" data structure indicating unsupported, missing or incorrect IE(s) or 3gpp-Sbi-Discovery-* header(s). | | | +| NOTE 2: This application error indicates error in the HTTP request and there is no other application error value that can be used instead. | | | +| NOTE 3: This application error indicates error condition in the SCP/SEPP and there is no other application error value that can be used instead. | | | +| NOTE 4: If the reason for rejection is a temporary overload, the SCP/SEPP may include in the response a Retry-After header field to indicate how long the service is expected to be unavailable. | | | + +**Table 5.2.7.4-2: Redirect responses generated by the SCP/SEPP** + +| Cause value | HTTP status code | Description | +|---------------|--------------------------------------------------|--------------------------------------------------------------------| +| SCP_REDIRECT | 307 Temporary Redirect
308 Permanent Redirect | The request is redirected to a different SCP (see clause 6.10.9). | +| SEPP_REDIRECT | 307 Temporary Redirect
308 Permanent Redirect | The request is redirected to a different SEPP (see clause 6.10.9). | + +### 5.2.8 HTTP/2 request retries + +All NF services expose APIs across the service based interfaces and the APIs operate on resources. Invocation of an API though a HTTP method may result in the change of state of a resource depending of the request type. When a HTTP/2 client sends a request and it does not receive a response or it experiences a delay, it does not guarantee that the HTTP/2 request has not been processed by the HTTP/2 server. + +A HTTP/2 client may retry the same request that uses an idempotent method any time (see IETF RFC 9110 [11] clause 9.2.2). + +Retrying a non-idempotent HTTP/2 request on the same resource before a response for the previous request is received may lead to state changes on the resource with unspecified behaviour. HTTP conditional requests, as specified in IETF RFC 9110 [11] may be used to avoid such situations. + +An NF acting as an HTTP/2 client should also retry non-idempotent request if the request has not been processed, i.e. if the identifier of the stream corresponding to the request is larger than the Last-Stream-Id in a GOAWAY frame, or the REFUSED\_STREAM error code is included in a RST\_STREAM frame for the stream corresponding to the request as specified in clause 8.7 of IETF RFC 9113 [7]. API specific mechanisms as specified in respective technical specifications may be used for reconciling the state of resources, if the retry is attempted through a new TCP connection after a TCP connection failure. + +The number of retry shall be limited. A client should always prefer to retry requests to an alternative server if the initial server is overloaded. In case of general overload situation where all possible servers are overloaded retry mechanisms should be disabled automatically. + +The support of "detection of duplicated request message" is optional for HTTP clients and servers. When it is supported: + +- the NF acting as an HTTP/2 client shall: + - include an idempotency key (which shall uniquely identify the request message towards the target NF) in the 3gpp-Sbi-Request-Info header for a non-idempotent request message, e.g. a POST request; + - include the same idempotency key in the 3gpp-Sbi-Request-Info header when subsequently the NF acting as an HTTP/2 client decides to retry the same request towards the same NF acting as an HTTP/2 server or an alternative NF (e.g. from the same NF (service) Set); +- the NF acting as an HTTP/2 server, upon receiving a request message containing an idempotency key in the 3gpp-Sbi-Request-Info header, may: + +use the idempotency key to determine if it is a duplicated request message; and if so + +- produce a proper response based on the current state of the resource/session context considering the original request has been processed. The SCP shall forward the idempotency key received from the HTTP client unmodified towards the target NF, regardless of whether the SCP performs (re)selection of the target NF. + +The idempotency key that is supplied as part of every non-idempotent request shall be unique and shall not be reused with another request other than a retransmission of the same request. The server may consider an idempotency key as expired after an operator configurable timer. + +### 5.2.9 Handling of unsupported query parameters + +Unless specified otherwise for an API, a NF Service Producer that receives an HTTP request with one or more unsupported (i.e. not comprehended) query parameters shall: + +- a) for safe HTTP methods (e.g. HTTP GET request): + - ignore the unsupported query parameters and respond to the request based on the rest of the request (e.g. other supported query parameters); or + - reject the HTTP request as specified below for non-safe HTTP methods, e.g. based on other query parameters in the request or based on a response becoming very large; +- b) for non-safe HTTP methods: + - reject the request with a 400 Bad Request including a ProblemDetails IE with: + - the cause attribute set to INVALID\_QUERY\_PARAM; + - the invalidParams attribute indicating the unsupported query parameters; + - the supportedFeatures attribute listing the features supported by the NF Service Producer, if any, set as specified for HTTP responses in clause 6.6.2. + +### 5.2.10 URL Encoding of data + +#### 5.2.10.1 General + +As indicated in IETF RFC 3986 [14], the URI syntax defines a set of characters (a subset of the URI allowed characters) as delimiters of syntax components; those characters are called "reserved" and should not be used in URI fields intended to convey generic data (e.g., in the value part of a query parameter, or in the URI path segments), since this would interfere with the original meaning (syntax) of those reserved characters. + +In addition, HTTP/2 request body parts encoded with media type "application/x-www-form-urlencoded" shall also escape reserved and unsafe characters, as described in OpenAPI Specification [9]. + +#### 5.2.10.2 URL Encoding of URI components + +When a URI is composed in the 3GPP 5G APIs, the different components (e.g., path segments, values of query parameters, etc.) shall percent-encode the following "reserved" characters (see IETF RFC 3986 [14], section 2.1): + +- EXCLAMATION MARK (U+0021): ! +- NUMBER SIGN (U+0023): # +- DOLLAR SIGN (U+0024): \$ +- AMPERSAND (U+0026): & +- APOSTROPHE (U+0027): ' +- LEFT PARENTHESIS (U+0028): ( +- RIGHT PARENTHESIS (U+0029): ) +- ASTERISK (U+002A): \* +- PLUS SIGN (U+002B): + +- COMMA (U+002C): , +- SOLIDUS (U+002F): / +- COLON (U+003A): : +- SEMICOLON (U+003B): ; +- EQUALS SIGN (U+003D): = +- QUESTION MARK (U+003F): ? +- COMMERCIAL AT (U+0040): @ +- LEFT SQUARE BRACKET (U+005B): [ +- RIGHT SQUARE BRACKET (U+005D): ] + +The following characters (not listed as "reserved" in IETF RFC 3986 [14]) shall be percent-encoded: + +- QUOTATION MARK (U+0022): " +- PERCENT SIGN (U+0025): % + +SPACE (U+0020) character shall be escaped, either by percent-encoding it (as %20), or by replacing it with character PLUS SIGN (U+002B). + +The encoding of query parameters consisting of arrays of strings shall follow the guidelines indicated in 3GPP TS 29.501 [5], clause 5.3.13, for the escaping of the COMMA (U+002C) characters. + +In addition, implementations may percent-encode other characters, such as: + +- LEFT CURLY BRACKET (U+007B): { +- RIGHT CURLY BRACKET (U+007D): } + +The receiving entity shall percent-decode the received URI as specified in IETF RFC 3986 [14], section 2.4. + +Percent-encoding of reserved characters in the URI fields as described in this clause shall also apply to JSON attributes defined as URI and to HTTP header parameters whose ABNF definition uses production rules defined as URI or path-absolute (e.g. prefix parameter of the 3gpp-Sbi-Target-apiRoot header). + +#### 5.2.10.3 URL Encoding of HTTP/2 request bodies + +When composing an HTTP/2 request body with media type "application/x-www-form-urlencoded", the OpenAPI Specification [9] requires that the encoding shall follow IETF RFC 1866 [48], section 8.2.1, which indicates: + +- a) the "reserved" character set described in IETF RFC 1738 [49], section 2.2, shall be percent-encoded: + - AMPERSAND (U+0026): & + - SOLIDUS (U+002F): / + - COLON (U+003A): : + - SEMICOLON (U+003B): ; + - EQUALS SIGN (U+003D): = + - QUESTION MARK (U+003F): ? + - COMMERCIAL AT (U+0040): @ +- b) SPACE (U+0020) character shall be escaped by replacing it with character PLUS SIGN (U+002B). + +The following characters (not listed as "reserved" in IETF RFC 1738 [49]) shall be percent-encoded: + +- QUOTATION MARK (U+0022): " +- PERCENT SIGN (U+0025): % +- COMMA (U+002C): , +- LEFT SQUARE BRACKET (U+005B): [ +- RIGHT SQUARE BRACKET (U+005D): ] +- LEFT CURLY BRACKET (U+007B): { +- RIGHT CURLY BRACKET (U+007D): } + +In addition, implementations may also percent-encode any of the characters listed in clause 5.2.10.2. + +## 5.3 Transport Protocol + +The Transmission Control Protocol as described in IETF RFC 793 [6] shall be used as transport protocol as required by HTTP/2 (see IETF RFC 9113 [7]). + +NOTE: When using TCP as the transport protocol, an HTTP/2 connection is mapped to a TCP connection. + +If a Network Function does not register any port number to the NRF then it shall be prepared to receive connections on default port numbers, i.e. TCP port 80 for "http" URIs and TCP port 443 for "https" URIs as specified in IETF RFC 9113 [7]. + +## 5.4 Serialization Protocol + +The JavaScript Object Notation (JSON) format as described in IETF RFC 8259 [10] shall be used as serialization protocol. + +The content of JSON attributes of string type shall be encoded as UTF-8. + +For transmitting large parts of opaque binary data along with JSON format, multipart messages shall be supported using: + +- A multipart/related media type; +- 3gpp vendor specific content subtype; and +- Cross-referencing from the JSON content using the Content-ID field. + +Use of multipart messages is documented in specific specifications. + +## 5.5 Interface Definition Language + +OpenAPI Specification [9] shall be used as Interface Definition Language (IDL) of SBI. + +# --- 6 General Functionalities in Service Based Architecture + +## 6.1 Routing Mechanisms + +### 6.1.1 General + +This clause specifies the generic routing mechanisms in the 5GC. Specific requirements to support Indirect Communication are further defined in clause 6.10. + +For HTTP message routing between Network Functions, the message routing mechanism as specified in clause 7 of IETF RFC 9110 [11] is almost followed with some differences due to the adoption of HTTP/2 and to some 5G system specificities. + +NOTE: The term "inbound" are defined in clause 3.7 of IETF RFC 9110 [11]. It describes a directional requirement in relation to the request route: "inbound" means toward the origin server. + +### 6.1.2 Identifying a target resource + +The target resource is identified by a target URI (e.g. a Resource URI, a Custom operation URI or a Callback URI as defined in clause 4.4 of 3GPP TS 29.501 [5]). + +### 6.1.3 Connecting inbound + +If the request is not satisfied by a local cache, then the client shall connect to an authority server for the target resource or to a proxy. + +If a proxy is applicable for the target URI, the client connects inbound by establishing (or reusing) a connection to that proxy as defined in clause 7.3.2 of IETF RFC 9110 [11]. For connecting inbound to an authority not in the same PLMN, the client connects to the Security Edge Protection Proxy. + +If no proxy is applicable, then the client connects directly to an authority server for the target resource as defined in IETF RFC 9110 [11]. + +### 6.1.4 Pseudo-header setting + +### 6.1.4.1 General + +Once an inbound connection is obtained, the client sends a request message over the wire. The message starts with a HEADERS frame containing the Pseudo-Header Fields identifying the request target. The ":method" pseudo-header is always present. + +When sending a request directly to an origin server or to a proxy, other than a CONNECT or server-wide OPTIONS request, a client shall include the below pseudo-headers: + +- ":scheme". +- ":authority". +- ":path" includes the path and query components of the target URI. The path includes the optional deployment-specific string of the Resource URI or Custom operation URI "apiRoot" part. + +When sending a CONNECT request to a proxy, a client shall include the ":authority" pseudo-header. The ":scheme" and ":path" ones shall be absent. + +When sending a server-wide OPTIONS request to an origin server or to a proxy, a client shall include the below pseudo-headers: + +- ":scheme". +- ":authority". +- ":path" set with the value "\*". + +### 6.1.4.2 Routing within a PLMN + +For HTTP/2 request messages where the target URI authority component designates an origin server in the same PLMN as the client, the ":authority" HTTP/2 pseudo-header field shall be set to: + +"":authority" = uri-host [":" port] as specified in clause 8.3.1 of IETF RFC 9113 [7], excluding the [userinfo "@"] information as specified in clause 3.2 of IETF RFC 3986 [14]. + +Where the uri-host shall be: + +- FQDN of the target NF service; or +- IP address of the target NF service + +The FQDN of the target NF service need not contain the PLMN identifier. + +### 6.1.4.3 Routing across PLMN + +#### 6.1.4.3.1 General + +In order to reach the correct target NF service in the right PLMN and for HTTP/2 request messages where the target URI authority component designates an origin server not in the same PLMN as the client, the ":authority" HTTP/2 pseudo-header shall contain the FQDN including the PLMN ID. + +The ":authority" pseudo-header field in the HTTP/2 request message shall be set to: + +"":authority" = uri-host [":" port] as specified in clause 8.3.1 of IETF RFC 9113 [7], excluding the [userinfo "@"] information as specified in clause 3.2 of IETF RFC 3986 [14]. + +Where the uri-host shall be: + +- FQDN of the target NF service or the FQDN (authority) part of a callback URI or a specified link relation + +The FQDN of the target NF service or the FQDN (authority) part of a callback URI or a specified link relation shall contain the PLMN identifier. + +The format of the FQDN of target NF service is specified in clause 28.5 of 3GPP TS 23.003 [15]. + +To allow for TLS protection between the SEPP and Network Functions within a PLMN, the SEPP shall support: + +- TLS wildcard certificate for its domain name and generation of telescopic FQDN, as specified in clause 13.1 of 3GPP TS 33.501 [17] and in clause 6.1.4.3.2; and +- forwarding HTTP requests originated by NFs within the SEPP's PLMN towards the remote PLMN using the 3gpp-Sbi-Target-apiRoot header as specified in clause 6.1.4.3.3. + +NOTE: Whether the SEPP and NFs within the SEPP's PLMN use telescopic FQDN or the 3gpp-Sbi-Target-apiRoot header is based on PLMN operator's policy and is independent from the method supported and used in the remote PLMN. + +Both solutions for TLS protection between the SEPP and Network Functions within a PLMN may be used concurrently in a PLMN, e.g. in the transient phase where not all NFs of the PLMN have been upgraded to support the 3gpp-Sbi-Target-apiRoot header but when the PLMN operator would like to use the solution based on the 3gpp-Sbi-Target-apiRoot header with upgraded NFs. In this case, the SEPP should skip converting URLs into telescopic FQDNs (and use the solution based on 3gpp-Sbi-Target-apiRoot header) in: + +- HTTP responses received from the remote PLMN (e.g. including the FQDN of the target NF service) when the corresponding HTTP request contains a 3gpp-Sbi-Target-apiRoot header; +- HTTP requests received from the remote PLMN (e.g. including callback URIs) using SEPP policies based on the target URI (i.e. target FQDN). + +#### 6.1.4.3.2 Use of telescopic FQDN between NFs and SEPP within a PLMN + +When using TLS wildcard certificate and telescopic FQDN between the SEPP and NFs within the SEPP's PLMN, the SEPP on the HTTP/2 client side shall form the telescopic FQDN, as specified in 3GPP TS 23.003 [15], for the following cases: + +- FQDN of the target NF service in HPLMN is modified into a telescopic FQDN by the SEPP in the VPLMN; +- FQDN of the target NF service in VPLMN is modified into a telescopic FQDN by the SEPP in the HPLMN; +- FQDN (authority) part of callback URI of NF service resources in VPLMN is modified into a telescopic FQDN by the SEPP in the HPLMN; +- FQDN (authority) part of callback URI of NF service resources in HPLMN is modified into a telescopic FQDN by the SEPP in the VPLMN; +- FQDN (authority) part of link relation URI of NF service resources in VPLMN is modified into a telescopic FQDN by the SEPP in the HPLMN; +- FQDN (authority) part of link relation URI of NF service resources in HPLMN is modified into a telescopic FQDN by the SEPP in the VPLMN. + +#### 6.1.4.3.3 Use of 3gpp-Sbi-Target-apiRoot between NFs and SEPP within a PLMN + +When using the 3gpp-Sbi-Target-apiRoot header between the SEPP and NFs within the SEPP's PLMN, HTTP requests between the NFs and the SEPP shall be routed as specified in clause 6.10.2 for indirect communications, with the SEPP taking the role of the SCP. + +When sending an HTTP request targeting a URI with an authority of a remote PLMN, NFs shall include the 3gpp-Sbi-Target-apiRoot header in the HTTP request, containing the apiRoot of the target URI in the remote PLMN, and shall set the apiRoot in the request URI to the apiRoot of the SEPP (or to the apiRoot of the SCP if the communication between the NF and SEPP goes through an SCP). The apiRoot of the SEPP (or SCP) may include an optional deployment-specific string of the SEPP (or SCP). + +An SCP that receives an HTTP request targeting a URI with an authority of a remote PLMN shall route the HTTP request towards the SEPP as specified in clause 6.10.2 for indirect communications, i.e. the SCP shall forward the 3gpp- + +Sbi-Target-apiRoot header in the HTTP request it forwards to the SEPP, containing the apiRoot of the target URI in the remote PLMN, and it shall set the apiRoot in the request URI to the apiRoot of the SEPP. + +If the SEPP receives an HTTP request from a NF with a request URI containing a telescopic FQDN and with a 3gpp-Sbi-Target-apiRoot header, the SEPP shall ignore the 3gpp-Sbi-Target-apiRoot header and route the request using the telescopic FQDN. + +NOTE 1: This is to address the case of a potentially malicious or misbehaving NF that would include the 3gpp-Sbi-Target-apiRoot header and a request URI containing a telescopic FQDN when communicating with the SEPP. + +NOTE 2: This solution does not require the SEPP to support TLS wildcard certificate for its domain name, nor the SEPP to modify URI attributes in HTTP request and response contents with telescopic FQDNs. + +NOTE 3: The communication between the NF and SEPP can be direct or go through an SCP. + +#### 6.1.4.3.4            Routing between SEPPs + +The 3gpp-Sbi-Target-apiRoot header shall not be used between SEPPs if PRINS security is negotiated between the SEPPs. The apiRoot of the Request URI of the HTTP request encapsulating the protected message shall be set to the apiRoot of the remote SEPP. See clause 5.3.2.4 of 3GPP TS 29.573 [27]. + +If TLS security is negotiated between the SEPPs and at least one SEPP does not indicate support of the 3gpp-Sbi-Target-apiRoot header when negotiating the security policy, the SEPP shall use a pre-established TLS connection towards the other SEPP to forward the HTTP/2 messages sent by the NF service producers and NF service consumers, as is without reformatting. Additionally, + +- if the NF uses the 3gpp-Sbi-Target-apiRoot HTTP header in the HTTP Request to convey the target apiRoot to the sending SEPP, the sending SEPP shall remove the 3gpp-Sbi-Target-apiRoot header and set the apiRoot of the request URI it forwards on the N32-f interface to the apiRoot received in the 3gpp-Sbi-Target-apiRoot header from the HTTP client; +- if the NF uses a telescopic FQDN in the HTTP Request to convey the target apiRoot to the sending SEPP, or if TLS is not used between the NF and the sending SEPP, the sending SEPP shall set the apiRoot of the Request URI in the HTTP Request towards the remote SEPP to the apiRoot of the target NF derived from the telescopic FQDN or from the request URI respectively. + +If TLS security is negotiated between the SEPPs and both SEPPs indicate support of the 3gpp-Sbi-Target-apiRoot header when negotiating the security policy, HTTPS shall be used to forward messages between SEPPs. The sending SEPP shall replace the apiRoot of the Request URI in the HTTP Request with the apiRoot of the receiving SEPP before forwarding the HTTP Request on the N32 interface. Additionally, + +- if the NF uses the 3gpp-Sbi-Target-apiRoot HTTP header in the HTTP Request to convey the target apiRoot to the sending SEPP, the sending SEPP shall forward the 3gpp-Sbi-Target-apiRoot header unmodified in the HTTP request towards the remote SEPP; +- if the NF uses a telescopic FQDN in the HTTP Request to convey the target apiRoot to the sending SEPP, or if TLS is not used between the NF and the sending SEPP, the sending SEPP shall insert the 3gpp-Sbi-Target-apiRoot header in the HTTP request towards the remote SEPP and set it to the apiRoot of the target NF derived from the telescopic FQDN or from the request URI respectively. + +NOTE: Rel-15 compliant NFs and SEPP do not support the 3gpp-Sbi-Target-apiRoot header. + +### 6.1.5    Host header + +Clients that generate HTTP/2 requests shall use the ":authority" pseudo-header field instead of the Host header field. + +### 6.1.6    Message forwarding + +An HTTP/2 proxy shall use the ":authority" pseudo-header field to connect inbound to the origin server or another proxy if the request cannot be satisfied by the proxy cache. + +An HTTP/2 proxy may also use other headers and/or content to connect inbound to the origin server or another proxy if the request cannot be satisfied by the proxy cache. + +## 6.2 Server-Initiated Communication + +### 6.2.1 General + +The Subscribe-Notify service operations shall be supported between NFs as specified in clause 7.1.2 of 3GPP TS 23.501 [3]. + +Subscribe-Notify service operations require bidirectional communication between the NFs when the server needs to initiate communication with the client. + +Subscribe-Notify service operations shall be supported with two TCP connections, one per direction, as follows: + +- NF service consumer acts as an HTTP client and NF service producer acts as an HTTP server when NF service consumer subscribes to NF service producer's notifications; +- NF service producer acts as an HTTP client and NF service consumer acts as an HTTP server when NF service producer delivers notifications to NF service consumer. + +As described in 3GPP TS 23.501 [3], the Subscribe-Notify interaction requires the NF Service Consumer to provide a "notification endpoint" and a "notification correlation ID"; those are also called "callback URI" in the context of the present Technical Specification, and the authority of the "callback URI" is the HTTP endpoint where the notifications shall be delivered by the NF Service Producer. As indicated in 3GPP TS 23.501 [3], the interaction between NF Service Consumer and NF Service Producer may not occur, or may occur via interactions on a different service or API, prior to the notification sent by the NF Service Producer (e.g. for Implicit Subscriptions, or for Default Notifications); in that case, the notification is called "standalone notification", and shall be specified as described in 3GPP TS 29.501 [5], clause 5.3.7. + +For notifications sent in Direct Communication scenarios, if the authority of the callback URI contains an FQDN, the NF Service Producer shall use DNS as resolution mechanism in order to setup the TCP connection with the NF Service Consumer; for notifications sent in Indirect Communication scenarios, see clause 6.10.7. + +### 6.2.2 Subscription on behalf of NF Service Consumer + +When an NF service consumer subscribes to an intermediate NF for events which may be detected and reported directly by target NF (e.g. an NEF subscribes to Location Reporting event at AMF via UDM and AMF directly reports to the NEF), the NF service consumer may include the "3gpp-Sbi-Consumer-Info" header in the subscription creation request to indicate the supported API versions, features and accepted encodings of the service on the target NF. + +When subscribing to the target NF and requiring the target NF to directly report to NF service consumer, the intermediate NF shall invoke the highest API version at the target NF which is supported by the NF service consumer (if indicated) and the intermediate NF. The intermediate NF shall include all received "3gpp-Sbi-Consumer-Info" header(s) in the subscription creation request sent to the target NF. + +If the target NF received this header in event subscription creation, the target NF shall generate the request body according to the supported feature(s) and accepted encodings of the NF service consumer for notifications directly sent to the NF service consumer. + +Based on operator policy, the NF service consumer may provide a default inter-PLMN or intra-PLMN callback URI in a subscription request to the intermediate NF. + +The NF Service Consumer may also include, for each provided service, the following information in the "3gpp-Sbi-Consumer-Info" header(s): + +- the intraPlmnCallbackRoot parameter containing the callback root for receiving intra-PLMN notifications, and +- the interPlmnCallbackRoot parameter containing the callback root for receiving inter-PLMN notifications. + +Upon receiving a subscription request including the above information in the "3gpp-Sbi-Consumer-Info" header, the intermediate NF should check if the target NF is in VPLMN or HPLMN and adapt the callback Root of the callback + +URI according to the information received from the NF service consumer. For instance, if the NF service consumer included an inter-PLMN callback URI in the subscription request: + +- if the target NF is in HPLMN, then the intermediate NF should replace the callback Root of the callback URI in the subscription request with the provided intraPlmnCallbackRoot while sending the subscription creation request to the target NF; and +- if the target NF is in VPLMN, then the intermediate NF shall not change the notification/callback URI. + +In either case, the Intermediate NF should then forward the "3gpp-Sbi-Consumer-Info" header in the subscription creation request sent to the target NF. + +When the target NF is an AMF, the source AMF should forward the information in the received "3gpp-Sbi-Consumer-Info" header to the target AMF during inter-AMF mobility. If the target AMF received intraPlmnCallbackRoot and interPlmnCallbackRoot parameters in the "3gpp-Sbi-Consumer-Info" header information from the source AMF, the target AMF should determine the PLMN of the NF Service Consumer and adapt the callback root of the callback URI correspondingly. + +## 6.2.3 Notification error handling + +The following requirements apply unless specified otherwise for a given API, + +An NF Service Producer that sends a notification request should consider that the subscription is no longer valid and terminate the subscription, if it receives any of the following response codes and application errors: + +- "400 Bad Request" with the application error "RESOURCE\_CONTEXT\_NOT\_FOUND"; or +- "404 Not Found" with the application error "SUBSCRIPTION\_NOT\_FOUND". + +An NF Service Producer should not keep on sending notification requests to an NF service consumer and may consider that the subscription is no longer valid and terminate the subscription, if it receives one or more "404 Not Found" responses without application errors or with other application errors. + +## 6.3 Load Control + +### 6.3.1 General + +Load control enables an NF Service Producer to signal its load information to NF Service Consumers, either via the NRF (as defined in clause 6.3.2) or directly to the NF Service Consumer (as defined in clause 6.3.3). The load information reflects the operating status of the resources of the NF Service Producer. + +Load control allows for better balancing of the load across NF Service Producers, so as to attempt to prevent their overload in first place (preventive action). Load control does not trigger overload mitigation actions, even if the NF Service Producer reports a high load. + +NOTE: the load information can be used along similar principles as those described for node-level load control in clause 4A.2 in 3GPP TS 29.303 [39], but with the priority and capacity parameters of candidate NFs obtained from the NRF. + +### 6.3.2 Load Control based on load signalled via the NRF + +This clause specifies details of the Load Control based on load signalled via the NRF solution. + +During NF discovery procedures (see clause 4.17.4 and 4.17.5 of 3GPP TS 23.502 [4]), the NRF may provide the NF instance and/or the NF service instance information with the NF capacity information advertised during NF Service Registration and/or NF Service Update procedures (see clause 4.17.1 and 4.17.2 of 3GPP TS 23.502 [4] and clause 6.2.6 of 3GPP TS 23.501 [3]). The NRF may also provide load information of the NF instance and/or the NF service instance in NF discovery response. + +The NF service consumer that is discovering the NF service producer, may use the available information (e.g. NF capacity information, load information) to select the appropriate NF instance as specified in 3GPP TS 29.510 [8]. + +### 6.3.3 Load Control based on LCI Header + +#### 6.3.3.1 General + +This clause specifies details of the Load Control based on LCI Header solution (LC-H). The solution extends the Load Control based on load signalled via the NRF solution by enabling a direct exchange of the LCI between the NF Service Producer and NF Service Consumer. + +Support for the LC-H solution is optional, but if the feature is supported, the requirements specified in the following clauses shall apply. + +NOTE 1: Load control and overload control can be supported and activated independently in the network, based on operator policy. + +An NF Service Producer that supports the LC-H feature shall signal its load information as further specified in this clause. An NF Service Consumer supporting the LC-H feature shall utilize the load information, for a given scope, that is received with the most recent timestamp from the NRF or from the NF Service Producer via direct signalling, to adaptively balance the load across the candidate NF Service Producers according to their effective load e.g. when creating a resource at an NF Service Producer. + +NOTE 2: An NF Service Consumer supporting the LC-H feature can receive the load information without a timestamp from the NRF and an LCI (with a timestamp) from the NF Service Producer. It is an implementation matter how the NF Service Consumer determines which of these contains the most recent load information. + +An SCP/SEPP that supports the LC-H feature may additionally piggyback its LCI with a scope set to the SCP FQDN/SEPP FQDN, in HTTP request or response messages, as further specified in this clause. An HTTP client supporting the LC-H feature shall utilize the load information of the SCP/SEPP, which is received with the most recent timestamp, to adaptively balance the load across the available SCPs/SEPPs to reach the HTTP server. + +In scenarios with multiple SCPs or with SCP(s) and SEPPs between the NF service producer and the NF service consumer, an SCP or SEPP that receives in a service response or in a notification request an LCI with a scope set to an SCP or SEPP FQDN, shall remove this LCI header when forwarding the message to the next hop, and shall perform load control to adaptively balance the load across the available next hop SCPs/SEPPs for the subsequent service requests according to the received LCI information. + +NOTE 3: An NF service consumer can only receive LCI with a scope set to an SCP or SEPP FQDN from its next hop SCP or SEPP. + +The SCPs and SEPPs shall forward LCI headers with a scope set to NF Producer received in a service response or notification request when forwarding the message to the next hop. The NF consumer shall perform the load control to adaptively balance the load across the available NF Producers for the subsequent service requests according to the received LCI information. + +A SEPP may advertize its own LCI information to a next hop NF or SCP in the same PLMN, and/or to the peer SEPP based on operator's policy. In the latter case, LCI may be advertized in N32-f signalling; when PRINS is used over N32-f, the LCI header for the SEPP FQDN shall be inserted in the outer N32-f message, i.e. not within the N32-f content. + +#### 6.3.3.2 Conveyance of Load Control Information + +LCI shall be conveyed within the 3gpp-Sbi-Lci HTTP header. When conditions for generating an LCI are met, an NF Service Producer, SCP or SEPP shall include the 3gpp-Sbi-Lci header, or LCI header, see clause 5.2.3.2.10) to its peer entities (NF Service Consumers). The LCI header shall be piggybacked on a signalling message that is sent to the NF Service Consumer. + +The NF Service Producer, SCP or SEPP shall send the 3gpp-Sbi-Lci header, regardless of whether the peer NF Service Consumer supports the feature (see clause 6.3.3.5). The header is ignored by the NF Service Consumer if the latter does not support the LC-H feature. + +### 6.3.3.3 Frequency of Conveyance + +How often or when the sender conveys the LCI is implementation specific. The sender shall ensure that new or updated Load Control Information is conveyed to the target receivers with an acceptable delay, such that the purpose of the information (i.e. the effective load balancing) is achieved. + +Considering the processing requirement of the receiver of the LCI (e.g. handling of the new information), the sender should refrain from advertising every small variation (e.g. with the granularity of 1 or 2), in the Load Metric which does not result in useful improvement in NF service producer selection logic at the receiver. A larger variation in the Load Metric, e.g. 5 or more units, should be considered as reasonable enough for advertising the new Load Control Information. + +### 6.3.3.4 Load Control Information + +#### 6.3.3.4.1 General Description + +A NF Service Producer may include one or more LCI header(s) in a service response or in a notification/callback request message sent to a NF Service Consumer. An NF Service Producer may report LCI with different scopes, e.g.: + +- to report LCIs for an NF service instance, an NF service set and/or an NF instance; +- to report LCIs at the level of an SMF (service) instance or SMF (service) set, and for specific S-NSSAI/DNNs; +- to report LCIs for different S-NSSAI/DNNs of an SMF (service) instance or SMF (service) set. + +A NF Service Producer may also include LCI header(s) with different scopes in different messages, e.g. an SMF may report LCI for the SMF instance first, and then report LCI for both the SMF instance and for specific S-NSSAI/DNN(s), if S-NSSAI/DNN based load control is enabled. + +An NF Service Consumer that receives LCI headers with different scopes, in the same message or in different messages, shall handle each LCI independently from each other. For instance, if an NF Service Consumer receives one LCI with the scope of an NF (Service) Set and then another LCI with the scope of an NF (Service) instance that pertains to the NF (Service) Set, the NF Service Consumer shall store the latter LCI and also consider that the former LCI is still valid for the NF (Service) Set. + +For S-NSSAI/DNN based load control (see clause 6.3.3.4.4.2.2), when signalling LCI for an SMF (service) instance or an SMF (service) set in a message, the SMF shall always include the full set of load control information applicable to the SMF (service) instance or SMF (service) set, i.e. LCI for the SMF (service) instance or the SMF (service) set level and/or LCI for specific S-NSSAI/DNNs, even if only a subset of the LCI has changed; these LCIs shall contain the same Load Control Timestamp. + +An SCP or SEPP may additionally include one LCI in a service request or response, or in a notification request or response, sent towards a NF Service Consumer or NF Service Producer. + +Each LCI shall always include the Timestamp, Load Metric and Scope parameters (see clause 5.2.3.2.10 for the complete list of parameters). + +#### 6.3.3.4.2 Load Control Timestamp + +The Timestamp parameter indicates the time when the LCI was generated. It shall be used by the receiver of the LCI to properly collate out-of-order LCI, e.g. due to HTTP/2 stream multiplexing, prioritization and flow control, and to determine whether the newly received load control information has changed compared to load control information previously received for the same scope. + +The receiver shall overwrite any stored load control information of a peer NF, NF set, NF service, NF service set, SCP or SEPP (according to the scope of the new received LCI) with the newly received load control information, if the new load control information is more recent than the stored information. For instance, for S-NSSAI/DNN based load control, if the receiver had stored LCI for a peer SMF instance and LCI for a specific S-NSSAI/DNN of that SMF instance, it shall overwrite these LCIs with the new LCI received in a message carrying LCI for the same SMF instance. + +If the newly received LCI has the same or an older Timestamp as the previously received LCI for the same scope (e.g. from the same NF, NF Set, NF Service, NF Service Set, SCP or SEPP), then the receiver shall discard the newly received LCI whilst continuing to apply the load control procedures according to the previously stored value. + +NOTE: An NF Service Consumer can receive LCI for the same target scope from different NF service producers, when the scope of the LCI corresponds to an NF set or NF service set. + +#### 6.3.3.4.3 Load Metric + +The Load Metric shall indicate the current load level for the scope of the LCI, e.g. current load level of the NF instance if the scope indicated in the LCI indicates an NF instance, as a percentage within the range of 0 to 100, where 0 means no or 0% load and 100 means maximum or 100% load reached (i.e. no further load is desirable). The computation of the load metric is implementation specific. + +#### 6.3.3.4.4 Scope of LCI + +##### 6.3.3.4.4.1 Introduction + +The scope of LCI indicates the applicability of the LCI, i.e. it identifies the components of the LCI sender to which the LCI relates to. + +The following clauses provide a detailed description of the parameters that define the scope of the LCI header. + +##### 6.3.3.4.4.2 Scope of LCI signalled by an NF Service Producer + +###### 6.3.3.4.4.2.1 General + +The LCI sent by an NF Service Producer shall include one of the parameters defined in Table 6.3.3.4.4.2.1-1. + +**Table 6.3.3.4.4.2.1-1: Supported scopes for LCI signalled by an NF Service Producer** + +| Parameter | Value | LCI scope (i.e. LCI applies to) | Examples | +|-----------------------------------|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| +| NF-Instance | NF Instance ID | All services of the NF instance identified by the NF Instance ID. | NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8 | +| NF-Set | NF Set ID | All services of all NF instances of the NF set identified by the NF Set ID. | NF-Set: set1.udmset.5gc.mnc012.mcc345 | +| NF-Service-Instance (and NF-Inst) | NF Service Instance ID (and NF Instance ID) | The service instance identified by the NF Service Instance ID and the NF instance Id (if available) or the last known NF instance ID. | NF-Service-Instance: serv1.smf1; NF-Inst: 54804518-4191-46b3-955c-ac631f953ed8 | +| NF-Service-Set | NF Service Set ID | All service instances of the NF service set identified by the NF service set ID. | NF-Service-Set: setxyz.snnsmf-pdusession.nfi54804518-4191-46b3-955c-ac631f953ed8.5gc.mnc012.mcc345 | + +If an NF Service Consumer receives more than one LCI with overlapping scopes, i.e. one with NF (service) instance scope and another with NF (service) Set scope, the NF Service Consumer should perform load balancing considering the LCI received with the finer scope for each candidate NF instance or NF service instance (i.e. in this example the load of the NF (service) instance). + +###### 6.3.3.4.4.2.2 Additional scope parameters for S-NSSAI/DNN based load control by SMF + +It is optional for the SMF to support S-NSSAI/DNN based load control. When supported, the following requirements shall apply. + +S-NSSAI/DNN level load control refers to advertising of the load information at S-NSSAI and DNN level granularity and selection of the target SMF service instance based on this information. It helps to achieve an evenly load balanced network at S-NSSAI/DNN granularity by the use of the dynamic load information provided within the Load Control Information with the S-NSSAI/DNN scope. Only an SMF may advertise S-NSSAI/DNN level load information. + +NOTE 1: When all the resources of an SMF (service) instance are available for all the S-NSSAI/DNNs served by that SMF (service) instance, load control at SMF (service) set or SMF (service) instance level is exactly the same as S-NSSAI/DNN level overload information of that SMF, for each of its S-NSSAIs/DNNs, and hence, performing load control at SMF (service) set or SMF (service) instance level is sufficient. + +The "Load Metric" shall indicate the current resource utilization for the indicated S-NSSAI/DNN(s), as a percentage, as compared to the total resources configured for the indicated S-NSSAI/DNNs at the SMF. + +When performing S-NSSAI/DNN based load control, the LCI scope shall indicate, in addition to either an NF-Instance, NF-Set, NF-Service-Instance or NF-Service-Set (see Table 6.3.3.4.2.2.1-1), the combinations of S-NSSAI and DNN for which the LCI sender wants to advertise the load information using the following parameters: + +- the S-NSSAI parameter, indicating one or more S-NSSAI values; and +- the DNN parameter, indicating one or more DNN values from the indicated S-NSSAI(s). + +NOTE 2: It is not allowed to report LCI for a DNN only or for an S-NSSAI only. + +See Table 6.3.3.4.4.2.2.1-1. + +**Table 6.3.3.4.4.2.2.1-1: Additional scope parameters for S-NSSAI/DNN based load control by SMF** + +| Parameter | Value | LCI scope (i.e. LCI applies to) | Examples | +|-----------|----------------------------|-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| +| S-NSSAI | One or more S-NSSAI values | DNN(s) from indicated S-NSSAI(s), for the service(s) of NF instance(s) as defined in Table 6.3.3.4.4.2.1-1. | S-NSSAI: %7B%22sst%22%3A%201%2C%20%22sd%22%3A%20%22A08923%22%7D; DNN: internet.mnc012.mcc345.gprs | +| DNN | One or more DNN values | | | + +NOTE 1: Both the S-NSSAI and DNN parameters shall be present. The S-NSSAI and DNN parameters shall be provided with either the NF-Instance, NF-Set, NF-Service-Instance or NF-Service-Set parameter (see Table 6.3.3.4.4.2.1-1). +NOTE 2: The S-NSSAI parameter in the Example corresponds to the JSON encoding: {"sst": 1, "sd": "A08923"} (see clause 5.2.3.1). + +An SMF shall advertise S-NSSAI/DNN based load control for at most 10 DNNs. + +NOTE 3: Considering various aspects such as the processing and storage requirements at the overloaded SMF entity and the receiver, the number of important DNNs for which overload control advertisement could be necessary, interoperability between the NFs of different vendors, it was chosen to define a limit on the maximum number of DNNs for advertising the load control information. + +The SMF may advertise load information for different DNNs of one or more S-NSSAIs in a single LCI header (if the same LCI information, e.g. load metric or relative capacity, applies to all the DNNs of the S-NSSAI(s)) or in up to 10 LCI headers (if different LCI information needs to be advertised for different DNNs). + +#### 6.3.3.4.4.3 Scope of LCI signalled by an SCP + +The LCI sent by an SCP shall include one of the parameters defined in Table 6.3.3.4.4.3-1. + +**Table 6.3.3.4.4.3-1: Supported scopes for LCI signalled by an SCP** + +| Parameter | Value | LCI scope (i.e. LCI applies to) | Examples | +|-----------|----------|---------------------------------|----------------------------| +| SCP-FQDN | SCP FQDN | SCP identified by the SCP FQDN | SCP-FQDN: scp1.example.com | + +#### 6.3.3.4.4.4 Scope of LCI signalled by an SEPP + +The LCI sent by an SEPP shall include one of the parameters defined in Table 6.3.3.4.4.4-1. + +**Table 6.3.3.4.4.4-1: Supported scopes for LCI signalled by an SEPP** + +| Parameter | Value | LCI scope (i.e. LCI applies to) | Examples | +|-----------|-----------|----------------------------------|------------------------------| +| SEPP-FQDN | SEPP FQDN | SEPP identified by the SEPP FQDN | SEPP-FQDN: sepp1.example.com | + +#### 6.3.3.4.5 S-NSSAI/DNN Relative Capacity + +When applying S-NSSAI/DNN based load control (see clause 6.3.3.4.4.2.2), the LCI shall include the S-NSSAI/DNN relative capacity indicating the resources configured for the combinations of S-NSSAIs and DNNs reported in the LCI, compared to the total resources configured at the SMF (service) instance or SMF (service) set, as a percentage. + +This parameter enables the NF selecting an SMF service instance to determine the available resources for a given S-NSSAI/DNN for different candidate SMF service instances (considering the static capacity of the SMF service instance, the S-NSSAI/DNN relative capacity and the load of the S-NSSAI/DNN). + +#### 6.3.3.5 LC-H feature support + +##### 6.3.3.5.1 Indicating supports for the LC-H feature + +When registering with the NRF (NFRegister) or updating the NRF (NFUpdate), an NF that supports the LC-H feature shall indicate the feature support (see clause 6.1.6.2.2 in 3GPP TS 29.510 [8]). + +When an NF Service Consumer queries an NRF (NFDiscover) to discover services offered by NF Service Producers, the NRF shall indicate to the NF Service Consumer, if the NF Service Producers support the LC-H feature (see clause 6.2.6.2.3 in 3GPP TS 29.510 [8]). + +##### 6.3.3.5.2 Utilizing the LC-H feature support indication + +When selecting an NF Service Producer that supports the LC-H feature, the NF Service Consumer should not subscribe at the NRF to notifications triggered by the changes in the load of the selected NF Service Producer (see clause 5.2.2.5 in 3GPP TS 29.510 [8]). + +### 6.4 Overload Control + +#### 6.4.1 General + +Service Based Interfaces use HTTP/2 over TCP for communication between the NF Services. TCP provides transport level congestion control mechanisms as specified in IETF RFC 5681 [16], which may be used for congestion control between two TCP endpoints (i.e., hop by hop). HTTP/2 also provides flow control mechanisms and limitation of stream concurrency that may be configured for connection level congestion control, as specified in IETF RFC 9113 [7]. + +In addition to TCP and HTTP/2 congestion control mechanisms, the following end to end application-level overload control mechanisms are defined. + +Overload control enables an NF Service Producer, an NF Service Consumer, an SCP or an SEPP becoming or being overloaded to gracefully reduce its incoming signalling load, by instructing NF Service Consumers to reduce sending service requests or by instructing NF Service Producers to reduce sending notification requests respectively, according to its available signalling capacity to successfully process the requests. An NF Service Producer, NF Service Consumer, SCP or an SEPP is in overload when it operates over its signalling capacity. + +When being instructed by a NF Service Consumer to apply overload control, the NF Service Producer shall perform the signaling reduction towards the NF Service Consumer only for the notifications or callback requests according to the overload scope, and not for any NF services which may be produced by the same NF (for which separate OCI may be advertised by the NF when acting as NF producer), even when the overload scope is on NF Instance level or NF Set level. + +Overload control aims at shedding the incoming traffic as close to the traffic source as possible generally when an overload has occurred (reactive action), so to avoid spreading the problem inside the network and to avoid using resources of intermediate entities in the network for signalling that cannot anyhow be served by the overloaded entity. + +Overload control should continue to allow for preferential treatment of priority users (e.g. MPS) and emergency services. + +Overload control may be performed based on HTTP status codes returned in HTTP responses (as defined in clause 6.4.2) or based on Overload Control Information (OCI) signalled in HTTP request or response (as defined in clause 6.4.3). + +The NF that performs overload control enforcement may either reject a fraction of request messages, or redirect some request messages towards an alternative NF if possible, to reduce sending HTTP requests towards an overloaded NF. (see clause 6.4.3.5). + +## 6.4.2 Overload Control based on HTTP status codes + +### 6.4.2.1 General + +Overload control based on HTTP status code shall be supported per NF service / API according to the principles defined in this clause. + +An NF Service Producer may mitigate a potential overload status by sending the NF Service Consumer the following HTTP status codes as a response to requests received during, or close to reaching, an overload situation: + +- 503 Service Unavailable; +- 429 Too Many Requests; or +- 307 Temporary Redirect + +The first 2 status codes (503 and 429) are intended to inform the NF Service Consumer that the server cannot handle the current received traffic rate, so it shall abate the traffic sent to the NF Service Producer by throttling part of this traffic locally at the NF Service Consumer, or diverting it to an alternative destination (another NF Service Producer where an alternative resource exists) that is not overloaded. If possible, traffic diversion shall always be preferred to throttling; the result of the throttling is a permanent rejection of the transaction. + +If the client needs to abate a certain part of the available traffic, it shall do it based on the determined priority of each message. + +Depending on regional/national requirements and network operator policy, requests related to priority traffic (e.g. MPS) and emergency shall be the last to be throttled by the client, and shall be exempted from throttling due to overload control up to the point where the required traffic reduction cannot be achieved without throttling the priority requests. + +When an NF Service Consumer (e.g. AMF) issues a service request to an NF Service Producer (e.g. SMF), but the NF Service Producer cannot fulfil the request due to receiving a 503 or 429 status code from another NF Service Producer (e.g. PCF), the former NF Service Producer shall reject the service request from the NF Service Consumer with a 502 Bad Gateway HTTP error response including the "problemDetails" with the "cause" attribute set to "INBOUND\_SERVER\_ERROR". As an exception, the 503 or 429 status code shall be relayed by a V-SMF/I-SMF between AMF and H-SMF/SMF with the remoteError attribute set to "true" as specified in clause 6.1.7.1 of 3GPP TS 29.502 [28]. The last status code (307) is intended to inform the NF Service Consumer about the availability of other endpoints where the service offered by the NF Service Producer is available, so the NF Service Consumer does not need to discard traffic locally. + +### 6.4.2.2 HTTP Status Code "503 Service Unavailable" + +This status code should be sent when the NF Service Producer undergoes an overload situation, and it needs to reject HTTP requests. The NF Service Producer may include detailed information about its status in the ProblemDetails JSON element, in the HTTP response body. Also, the HTTP header field "Retry-After" may be added in the response to convey an estimated time (in number of seconds) for the recovery of the service. + +As for all 5xx status codes, this indicates a server-related issue (not limited to a specific client, or HTTP method), and it indicates that the server is incapable of performing the request. + +Upon receipt of a "503 Service Unavailable" status code, the NF Service Consumer shall monitor the amount of rejected and timed-out traffic, in comparison to the accepted traffic by the NF Service Producer, and it shall abate (by diversion or throttling) the traffic sent to the NF Service Producer in such a way that the rate between accepted and rejected traffic improves with time, and eventually reaches a situation where the server accepts all requests once the overload status ceases at the server. The mechanism to achieve this is implementation-specific; Annex A contains a description of an + +example algorithm based on "adaptive throttling" of the traffic sent by the NF Service Consumer towards an NF Service Producer. + +#### 6.4.2.3 HTTP Status Code "429 Too Many Requests" + +This status code may be sent, if supported by the server, when the NF Service Producer detects that NF Service Consumers are sending excessive traffic which, if continued over time, may lead to (or may increase) an overload situation in the NF Service Producer. + +The HTTP header field "Retry-After" may be added in the response to indicate how long the NF Service Consumer has to wait before making a new request. + +As for all 4xx status codes, this indicates a client-related issue (not limited to a specific HTTP method), and it indicates that the client seems to be misbehaving. + +#### 6.4.2.4 HTTP Status Code "307 Temporary Redirect" + +This status code should be sent when the NF Service Producer decides to redirect HTTP requests to another less loaded server, or HTTP/2 end point, to offload some part of the incoming traffic, with the goal to avoid entering (or to mitigate) an overload situation. The NF Service Producer shall not use it if it does not know the load status of the alternative server. + +How the NF Service Producer becomes aware of the load levels of other servers or HTTP/2 end points is deployment-specific, and out of the scope of this specification. The URI for the temporary redirection shall be given by the Location header field of the response. + +This status code should also be sent when the SCP or SEPP decides to redirect HTTP requests to another less loaded SCP or SEPP to offload some part of the incoming traffic if it knows the load status of the alternative SCP or SEPP. + +As for all 3xx status codes (redirection), this indicates a client-related action; the client shall be responsible of the detection of infinite redirection loops. + +### 6.4.3 Overload Control based on OCI Header + +#### 6.4.3.1 General + +This clause specifies details of the Overload Control based on OCI Header (OLC-H) solution. The solution is independent from the Overload Control based on HTTP status codes solution. + +Support of OLC-H is optional, but if the feature is supported, the requirements specified in the following clauses shall apply. + +Overload conditions are detected by an NF Service Producer/Consumer when the number of incoming service requests exceeds the maximum number of messages supported by the receiving entity, e.g. when the internally available resources of the NF Service Producer/Consumer, such as processing power or memory, are not sufficient to serve the number of incoming requests. How an NF Service Producer/Consumer identifies that it is overloaded is implementation specific. + +When an NF Service Producer/Consumer reaches an implementation dependent overload threshold, the NF Service Producer/Consumer shall convey the Overload Control Information (OCI, see clause 6.4.3.4) to its peer entity (Consumer or Producer, respectively). Based on the received OCI, the peer shall adjust the signaling it sends to the overloaded entity according to the OCI as specified in clause 6.4.3.5. The OCI is piggybacked in HTTP request or response messages such that the exchange of the OCI does not trigger extra signaling. + +An SCP/SEPP experiencing an overload may additionally piggyback OCI with a scope set to the SCP FQDN/SEPP FQDN in HTTP request or response messages, so as to adapt the signaling traffic sent towards the SCP/SEPP. + +NOTE 1: Overload control and load control can be supported and activated independently in the network, based on operator policy. + +In scenarios with multiple SCPs or with SCP(s) and SEPPs between the NF service producer and the NF service consumer, an SCP or SEPP that receives in an HTTP request or response an OCI with a scope set to an SCP or SEPP + +FQDN, shall remove this OCI header when forwarding the message to the next hop, and shall perform overload control to reduce sending subsequent service requests or notification requests to the next hop overloaded SCP or SEPP according to the received LCI information. + +NOTE 2: An NF service consumer can only receive OCI with a scope set to an SCP or SEPP FQDN from its next hop SCP or SEPP. + +The SCPs and SEPPs shall forward OCI headers with a scope set to NF Service Producer or NF Service Consumer received in an HTTP request or response when forwarding the message to the next hop. The NF consumer shall perform overload control to reduce sending subsequent service requests to the overloaded NF Service Producer according to the received OCI information. The NF Service Producer shall perform overload control to reduce sending subsequent notification requests to the overloaded NF Service Consumer according to the received OCI information. + +A SEPP may advertize its own OCI information to a next hop NF or SCP in the same PLMN, and/or to the peer SEPP based on operator's policy. In the latter case, OCI may be advertized in N32-f signalling; when PRINS is used over N32-f, the OCI header for the SEPP FQDN shall be inserted in the outer N32-f message, i.e. not within the N32-f content. + +### 6.4.3.2 Conveyance of Overload Control Information + +OCI shall be conveyed within the 3gpp-Sbi-Oci HTTP header. When an NF Service Producer/Consumer/SCP/SEPP detects overload conditions, it shall send OCI within the 3gpp-Sbi-Oci HTTP header (i.e. OCI header, see clause 5.2.3.2.9) to the peer entity (Consumer or Producer, respectively). The OCI header shall be piggybacked on a signalling message that is sent to the peer. + +The NF Service Producer/Consumer/SCP/SEPP shall send the "3gpp-Sbi-Oci" header, regardless of whether the peer supports the feature (see clause 6.4.3.6). The header is ignored by the receiver if the latter does not support the OLC-H feature. + +### 6.4.3.3 Frequency of Conveyance + +How often or when the sender conveys the OCI is implementation specific. The sender shall ensure that new or updated OCI is conveyed to the target receivers with an acceptable delay, such that the purpose of the information (i.e. effective overload control protection) is achieved. The following are some of the potential approaches the sender may implement for conveying the OCI: + +- the sender may convey the OCI towards a receiver only when the new/changed value has not already been conveyed to the given receiver; +- the sender may convey the OCI periodically; +- the sender may convey the OCI towards a receiver to restart the OCI period of validity. + +The sender may also implement a combination of one or more of the above approaches. + +### 6.4.3.4 Overload Control Information + +#### 6.4.3.4.1 General Description + +A NF Service Producer may include one or more OCI header(s) in a service response with any HTTP status code (e.g. 2xx, 3xx, 4xx), or in a notification request message sent to a NF Service Consumer. An NF Service Producer may report OCI for different scopes, e.g.: + +- to report OCIs for an NF service instance, an NF service set and/or an NF instance; +- to report OCIs at the level of an SMF (service) instance or SMF (service) set, and for specific S-NSSAI/DNNs; +- to report OCIs for different S-NSSAI/DNNs of an SMF (service) instance or SMF (service) set. + +A NF Service Producer may also include OCI header(s) with different scopes in different messages, e.g. an SMF may report OCI for the entire SMF instance first, and then for a specific S-NSSAI/DNN only, if the overload conditions have changed and the SMF ends up with an overload only affecting a specific S-NSSAI/DNN. + +An NF that receives OCI headers with different scopes, in the same message or in different messages, shall handle each OCI independently from each other. For instance, if an NF service consumer receives one OCI with the scope of an NF (Service) Set and then another OCI with the scope of an NF (Service) instance that pertains to the NF (Service) Set, the NF shall store the latter OCI and also consider that the former OCI is still valid for the NF (Service) Set until the related period of validity expires. + +If an NF Service Consumer receives more than one OCI with overlapping scopes, e.g. one OCI with NF (service) instance scope and another OCI with NF (service) Set scope, the NF Service Consumer should perform overload control towards a target NF service instance considering the OCI received with the finer scope (i.e. in this example the overload of the NF (service) instance). For instance, if an AMF receives one OCI with an SMF instance scope and with an overload reduction metric of 20%, and one OCI with the scope of a specific SMF service set of the same SMF instance and with an overload reduction of 50%, the AMF should throttle 50% of the traffic targeting the specific SMF service set and 20% of the traffic targeting other SMF services instances of the SMF instance (if no valid OCI is available for the other SMF service instances). + +For S-NSSAI/DNN based overload control (see clause 6.4.3.4.5.2.2), when signalling OCI for an SMF (service) instance or an SMF (service) set in a message, the SMF shall always include the full set of overload control information applicable to the SMF (service) instance or SMF (service) set, i.e. OCI for the SMF (service) instance or an SMF (service) set level and/or OCI for specific S-NSSAI/DNNs, even if only a subset of the OCI has changed; these OCIs shall contain the same Overload Control Timestamp. When including OCI for some S-NSSAI/DNN(s), the SMF should not provide any OCI for the SMF (service) instance or an SMF (service) set level unless OCI for such level is also applicable. + +If an NF Service Consumer receives OCIs with overlapping scopes for an SMF (service) instance or an SMF (service) set level and for specific S-NSSAI/DNNs, the NF Service Consumer should perform overload control towards a target SMF service instance and S-NSSAI/DNN considering the OCI received with the finer scope. For instance, if an AMF receives an OCI for an SMF instance with an overload reduction metric of 20%, and one OCI for a specific S-NSSAI/DNN of the same SMF instance with an overload reduction of 50%, the AMF should throttle 50% of the traffic targeting the specific S-NSSAI/DNN and 20% of the traffic targeting other S-NSSAI/DNNs of the SMF instance (if no valid OCI is available for the other S-NSSAI/DNN). + +A NF Service Consumer may include one OCI header in a notification response sent with any HTTP status code (e.g. 2xx, 3xx, 4xx), or in a service request sent to a NF Service Producer. + +An SCP/SEPP may additionally include one OCI in any service request or response, or notification request or response, sent towards a NF Service Consumer or NF Service Producer. + +The OCI shall always include the Overload Timestamp, Overload Reduction Metric, OCI Period of Validity and Scope parameters (see clause 6.4.3.4.2 for the complete list of parameters). + +#### 6.4.3.4.2 Overload Control Timestamp + +The Timestamp parameter indicates the time when the OCI was generated. It shall be used by the receiver of the OCI to properly collate out-of-order OCI headers, e.g. due to HTTP/2 stream multiplexing, prioritization and flow control, and to determine whether the newly received OCI has changed compared to the OCI previously received for the same scope. + +The receiver shall overwrite any stored OCI for a peer NF, NF set, NF service, NF service set, Callback URI, SCP or SEPP (according to the scope of the new received OCI) with the newly received OCI, if the new OCI is more recent than the stored information. For instance, for S-NSSAI/DNN based overload control, if the receiver had stored OCI for a peer SMF instance and OCI for a specific S-NSSAI/DNN of that SMF instance, it shall overwrite these OCIs with the new OCI received in a message carrying OCI for the same SMF instance. + +If the newly received OCI has the same or an older Timestamp than the previously received OCI for the same scope (e.g. for the same NF, NF Set, NF Service, NF Service Set, Callback URI, SCP or SEPP), then the receiver shall discard the newly received OCI and continue to apply the overload control procedures based on the previously received OCI values with the most recent Timestamp value. + +NOTE: An NF Service Producer/Consumer can receive OCI for the same target scope from different NF service Consumers/Producers, when the scope of the OCI corresponds to an NF set or NF service set. + +An entity generating an OCI shall update the Overload Control Timestamp whenever it modifies some information in the OCI or whenever it wants to extend the period of validity of the OCI. The Overload Control Timestamp shall not be updated otherwise. + +#### 6.4.3.4.3 Overload Reduction Metric + +The Overload Reduction Metric parameter shall have a value in the range from 0 to 100 and shall indicate the percentage of traffic reduction the OCI sender requests the receiver to apply. An Overload Reduction Metric of "0" indicates that the OCI sender is not overloaded (i.e. overload control enforcement procedures are not necessary). The computation of the overload metric is implementation specific. + +Considering the processing requirement of the OCI receiver, e.g. to perform overload control enforcement based on the updated Overload Reduction Metric, the sender should refrain from advertising every small variation, e.g. with the granularity up to 5 percentage units. Larger variations should be considered as reasonable enough for advertising a new Overload Reduction Metric and thus justifying the processing requirement (to handle the new information) of the receiver. The exact granularity of the Overload Reduction Metric is an implementation matter. + +The conveyance of the OCI signals that an overload situation is occurring, unless the Overload Reduction Metric is set to "0", which signals that the overload condition has ceased. Conversely, the absence of the OCI header in a message does not mean that the overload has abated. + +#### 6.4.3.4.4 Overload Control Period of Validity + +The Period of Validity parameter is a timer, which shall indicate the length of time during which the overload condition specified by the OCI header shall be considered as valid (unless overridden by subsequent new OCI). + +An overload condition shall be considered as valid from the time the OCI is received until the Overload Control Period of Validity expires or until another OCI with a new set of information (identified by a more recent Timestamp) is received for the same scope. The timer corresponding to the Period of Validity shall be restarted each time an OCI with a new set of information is received for the same scope. When this timer expires, the last received OCI shall be considered outdated and obsolete (i.e. any associated overload condition shall be considered to have ceased) and the overload control enforcement shall be stopped. + +The Period of Validity parameter achieves the following: + +- it avoids the need for the overloaded NF Service Producer/Consumer/SCP/SEPP to convey the OCI frequently to its peers when the overload state does not change. Therefore, this minimizes the processing required at the overloaded NF Service Producer/Consumer/SCP/SEPP and its peers upon sending/receiving HTTP/2 signalling; +- it allows to reset the overload condition after some time the NF Service Consumer/Producer having received an overload indication from the overloaded peer, e.g. if no signalling traffic takes place between these HTTP peers for some time due to overload mitigation actions. This also removes the need for the overloaded NF Service Producer/Consumer/SCP/SEPP to remember the list of its peers to which it has sent a non-null overload reduction percentage and to which it would subsequently need to convey when the overload condition ceases. + +#### 6.4.3.4.5 Scope of OCI + +##### 6.4.3.4.5.1 Introduction + +The scope of OCI indicates the service requests or notification requests to which the OCI applies, i.e. it identifies the traffic that the OCI sender requests the receiver to process in accordance with the OCI. + +The following clauses provide a detailed description of the parameters that define the scope of the OCI header. + +##### 6.4.3.4.5.2 Scope of OCI signalled by an NF Service Producer + +###### 6.4.3.4.5.2.1 General + +The OCI sent by an NF Service Producer shall include one and only one of the parameters defined in Table 6.4.3.4.5.2-1. + +**Table 6.4.3.4.5.2-1: Supported scopes for OCI signalled by an NF Service Producer** + +| Parameter | Value | OCI scope (i.e. OCI applies to) | Examples | +|-----------------------------------|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| +| NF-Instance | NF Instance ID | All services of the NF instance identified by the NF Instance ID. | NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8 | +| NF-Set | NF Set ID | All services of all NF instances of the NF set identified by the NF Set ID. | NF-Set:
set1.udmset.5gc.mnc012.mcc345 | +| NF-Service-Instance (and NF-Inst) | NF Service Instance ID (and NF Instance ID) | The service instance identified by the NF Service Instance ID and the NF instance Id (if available) or the last known NF instance ID. | NF-Service-Instance: serv1.smf1;
NF-Inst: 54804518-4191-46b3-955c-ac631f953ed8 | +| NF-Service-Set | NF Service Set ID | All service instances of the NF service set identified by the NF service set ID. | NF-Service-Set: setxyz.snsmf-pdusession.nfi54804518-4191-46b3-955c-ac631f953ed8.5gc.mnc012.mcc345 | + +#### 6.4.3.4.5.2.2 Additional scope parameters for S-NSSAI/DNN based overload control by SMF + +It is optional for the SMF to support S-NSSAI/DNN based overload control. When supported, the following requirements shall apply. + +S-NSSAI/DNN level overload control refers to advertising of the overload information at S-NSSAI and DNN level granularity and hence applying the mitigation policies based on this information to the signalling traffic related to this S-NSSAI and DNN only. Only an SMF may advertise S-NSSAI/DNN level overload information when it detects overload for certain S-NSSAI/DNNs, e.g. based on shortage of internal or external resources for an S-NSSAI/DNN (e.g. IP address pool). + +NOTE 1: When all the internal and external resources, applicable to the S-NSSAI/DNNs, are available for all the S-NSSAI/DNNs served by an SMF, overload control at SMF (service) set or SMF (service) instance level is exactly the same as S-NSSAI/DNN level overload information of that SMF, for each of its S-NSSAIs/DNNs, and hence, performing overload control at SMF (service) set or SMF (service) instance level is sufficient. + +When performing S-NSSAI/DNN based overload control, the OCI scope shall indicate, in addition to either an NF-Instance, NF-Set, NF-Service-Instance or NF-Service-Set (see Table 6.4.3.4.5.2-1), the combinations of S-NSSAI and DNN for which the OCI sender wants to advertise the overload information using the following parameters: - the S-NSSAI parameter, indicating one or more S-NSSAI values; and + +- the DNN parameter, indicating one or more associated DNN values from the indicated S-NSSAI(s). + +NOTE 2: It is not allowed to report OCI for a DNN only or for an S-NSSAI only. + +See Table 6.4.3.4.5.2.2-1. + +**Table 6.4.3.4.5.2.2-1: Additional scope parameters for S-NSSAI/DNN based overload control by SMF** + +| Parameter | Value | OCI scope (i.e. OCI applies to) | Examples | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| +| S-NSSAI | One or more S-NSSAI values | DNN(s) from indicated S-NSSAI(s), for the service(s) of NF instance(s) as defined in Table 6.4.3.4.5.2-1. | S-NSSAI: %7B%22sst%22%3A%201%2C%20%22sd%22%3A%20%22A08923%22%7D; DNN: internet.mnc012.mcc345.gprs | +| DNN | One or more DNN values | | | +| NOTE 1: Both the S-NSSAI and DNN parameters shall be present. The S-NSSAI and DNN parameters shall be provided with either the NF-Instance, NF-Set, NF-Service-Instance or NF-Service-Set parameter (see Table 6.4.3.4.5.2-1).
NOTE 2: The S-NSSAI parameter in the Example corresponds to the JSON encoding: {"sst": 1, "sd": "A08923"} (see clause 5.2.3.1). | | | | + +An SMF shall advertise S-NSSAI/DNN based overload control for at most 10 DNNs. + +NOTE 3: Considering various aspects such as the processing and storage requirements at the overloaded SMF entity and the receiver, the number of important DNNs for which overload control advertisement could be necessary, interoperability between the NFs of different vendors, it was chosen to define a limit on the maximum number of DNNs for advertising the overload control information. + +The SMF may advertise overload information for different DNNs of one or more S-NSSAIs in a single OCI header (if the same OCI information, e.g. overload reduction metric, applies to all the DNNs of the S-NSSAI(s)) or in up to 10 OCI headers (if different OCI information needs to be advertised for different DNNs). + +An NF selecting an SMF service instance for a given S-NSSAI/DNN shall apply the S-NSSAI/DNN level overload information, if available for that S-NSSAI/DNN. + +#### 6.4.3.4.5.3 Scope of OCI signalled by an NF Service Consumer + +The OCI sent by an NF Service Consumer shall include one and only one of the parameters defined in Table 6.4.3.4.5.3-1. + +**Table 6.4.3.4.5.3-1: Supported scopes for OCI signalled by an NF Service Consumer** + +| Parameter | Value | OCI scope (i.e. OCI applies to) | Examples | +|------------------------------------------------------|--------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Callback-Uri | One or more URI(s) including a scheme, authority and an optional path | All notifications (or callbacks) with a notification (or callback) URI matching the Callback-Uri parameter value.

(NOTE 1) | Callback-Uri:
"https://pcf12.operator.com"

Callback-Uri:
"https://pcf12.operator.com/serviceY"

Callback-Uri:
"https://pcf12.operator.com/serviceY/abc" &
"https://pcf12.operator.com/serviceY/def" | +| NF-Instance | NF Instance ID | All notifications (or callbacks) bound to:
- the NF Instance ID; or

- an NF service instance or an NF service set of this NF Instance ID.

(NOTE 2) | NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8 | +| NF-Set | NF Set ID | All notifications (or callbacks) bound to:
- the NF Set ID;

- an NF instance of the NF Set ID; or

- an NF service instance or an NF service set of an NF Instance of the NF Set ID.

(NOTE 2) | NF-Set:
set1.udmset.5gc.mnc012.mcc345 | +| NF-Service-Instance (and NF-Inst) | NF Service Instance ID (and NF Instance ID) | All notifications (or callbacks) bound to:
- the NF service instance identified by the NF Service Instance ID and the NF instance Id (if available) or the last known NF instance ID.

(NOTE 2) | NF-Service-Instance: serv1.smf1;
NF-Inst: 54804518-4191-46b3-955c-ac631f953ed8 | +| NF-Service-Set | NF Service Set ID | All notifications (or callbacks) bound to:
- the NF Service Set ID; or

- an NF service instance of the NF Service Set ID.

(NOTE 2) | NF-Service-Set: setxyz.snsmf-pdusession.nf54804518-4191-46b3-955c-ac631f953ed8.5gc.mnc012.mcc345 | +| NF-Instance or NF-Set

and

Service-Name | As defined above

and

as defined for servname in clause 5.2.3.2.5 | All notifications (or callbacks) bound to the service indicated in Service-Name within the NF instance ID or NF Set ID, as defined above

(NOTE 2) | NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8; Service-Name:def | + +NOTE 1: A notification (or callback) URI matches the Callback-Uri parameter value if the former contains the same scheme, the same authority and has a path that encompasses the path of the latter. + +NOTE 2: Notification (or callbacks) may be bound to an NF instance, an NF set, an NF service instance or an NF service set by a request creating a subscription or a callback resource with a Binding Indication as specified in clauses 6.12.4 and 6.12.5. + +EXAMPLE 1: Assuming that a PCF has created the following subscriptions in an AMF: + +- subscription 1: notification URI=https://pcf12.example.com/serviceX/1234 +- subscription 2: notification URI=https://pcf12.example.com/serviceY/abc + +- subscription 3: notification URI=https://pcf12.example.com/serviceY/def + +When experiencing overload, if the PCF signals the following OCI scope: + +- Callback-Uri: "https://pcf12.example.com", the OCI applies to notifications of all the subscriptions; +- Callback-Uri: "https://pcf12.example.com/serviceY", the OCI applies to notifications of subscriptions 2 and 3; +- Callback-Uri: "https://pcf12.example.com/serviceY/abc", the OCI applies to notifications of subscription 2. + +EXAMPLE 2: Assuming that a PCF has created the following subscriptions in an AMF: + +- subscription 1: notifications bound to PCF service set X, within PCF12 Instance ID, within PCF Set Z +- subscription 2: notifications bound to PCF service set Y, within PCF12 Instance ID, within PCF Set Z +- subscription 3: notifications bound to PCF12 Instance ID and service "def", within PCF Set Z + +When experiencing overload, if the PCF signals the following OCI scope: + +- NF-Instance=PCF12 Instance ID, the OCI applies to notifications of all the subscriptions; +- NF-Service-Set=Service Set Y of PCF12 Instance ID, the OCI applies to notifications of subscription 2; +- NF-Instance=PCF12 Instance ID and Service="def", the OCI applies to notifications of subscription 3. + +#### 6.4.3.4.5.4 Scope of OCI signalled by an SCP + +The OCI sent by an SCP shall include one and only one of the parameters defined in Table 6.4.3.4.5.4-1. + +**Table 6.4.3.4.5.4-1: Supported scopes for OCI signalled by an SCP** + +| Parameter | Value | OCI scope (i.e. OCI applies to) | Examples | +|-----------|----------|----------------------------------------------------------|----------------------------| +| SCP-FQDN | SCP FQDN | All requests towards the SCP identified by the SCP FQDN. | SCP-FQDN: scp1.example.com | + +#### 6.4.3.4.5.5 Scope of OCI signalled by an SEPP + +The OCI sent by an SEPP shall include one of the parameters defined in Table 6.4.3.4.5.5-1. + +**Table 6.4.3.4.5.5-1: Supported scopes for OCI signalled by an SEPP** + +| Parameter | Value | LCI scope (i.e. LCI applies to) | Examples | +|-----------|-----------|------------------------------------------------------------|------------------------------| +| SEPP-FQDN | SEPP FQDN | All requests towards the SEPP identified by the SEPP FQDN. | SEPP-FQDN: sepp1.example.com | + +### 6.4.3.5 Overload Control Enforcement + +#### 6.4.3.5.1 Message Throttling + +As part of the overload mitigation, the overload control enforcement NF, i.e. an entity that receives OCI (with a non-null overload reduction metric), shall reduce the total number of request messages, which would have been sent otherwise, towards the overloaded peer(s) corresponding to the received scope, e.g. towards all the NF instances of the NF Set when the scope indicates an NF Set ID and shall not redirect its requests to another entity pertaining to the same scope. + +This shall be achieved by discarding a fraction of the request messages in proportion to the overload level of the peer, which is called request message throttling. The message throttling shall be achieved either by rejecting the request messages, or by redirecting some of request messages to an alternative NF if possible, e.g. when a binding indication + +was received for the target resource/session context containing binding entities which have not been reported as overloaded. + +When sending (i.e. redirecting) the request towards an alternative NF to address an existing resource/session context, the sending NF may include a 3gpp-Sbi-Request-Info header in the request to indicate whether the request is redirected to an alternative NF as result of overload enforcement (see clause 5.2.3.3.12). The alternative NF may use this header to determine whether to accept the request, e.g. when accepting the request will not further overload the overloaded NF. + +Message throttling shall apply to HTTP requests only (any service request including notification request). + +Network Functions shall support and use the "Loss" algorithm as specified in clause 6.4.3.5.2. + +#### 6.4.3.5.2 Loss Algorithm + +An overloaded NF Service Producer/Consumer/SCP/SEPP shall ask its peers to reduce the number of HTTP requests they would otherwise send by conveying in the OCI header the requested traffic reduction percentage within the Overload Reduction Metric parameter, as specified in clause 6.4.3.4.3. + +The recipients of the Overload Reduction Metric shall reduce the number of request messages by that percentage, either by redirecting them to an alternate destination if possible (e.g. an HTTP POST request for the Nsmf\_PDUSession\_CreateSMContext service operation can be sent to an alternate SMF in the same SMF set, if the oleScope is at the NF instance level and the binding indication of the service resource is for an SMF set), or by failing the request and treating it as if it was rejected by the destination entity. + +NOTE: For example, if an NF Service Producer/Consumer/SCP/SEPP requests a peer to reduce the traffic by 10%, then that peer throttles 10% of the traffic that would have otherwise been sent to this NF Service Producer/Consumer/SCP/SEPP. + +#### 6.4.3.6 OLC-H feature support + +##### 6.4.3.6.1 Indicating supports for the OLC-H feature + +When registering with the NRF (NFRegister) or updating the NRF (NFUpdate), an NF that supports the OLC-H feature shall indicate the feature support (see clause 6.1.6.2.2 in 3GPP TS 29.510 [8]). + +When an NF Service Consumer queries an NRF (NFDiscover) to discover services offered by NF Service Producers, the NRF shall indicate to the NF Service Consumer, if the NF Service Producers support the OLC-H feature (see clause 6.2.6.2.3 in 3GPP TS 29.510 [8]). + +### 6.5 Support of Stateless NFs + +#### 6.5.1 General + +A NF may become stateless by decoupling the "compute" resource and "storage" resource as specified in clause 4.1 of 3GPP TS 23.501 [3]. + +#### 6.5.2 Stateless AMFs + +##### 6.5.2.1 General + +AMF may become stateless by storing the UE related information in the UDSF. Procedures for AMF planned removal or the AMF auto-recovery are specified in clauses 5.21.2.2 and 5.21.2.3 of 3GPP TS 23.501 [3]. + +##### 6.5.2.2 AMF as service consumer + +1. When the AMF subscribes to notifications from another NF Service Producer, the AMF shall provide its GUAMI to the NF Service Producer to enable the latter to discover AMFs within the AMF set, or information about a backup AMF, in addition to Callback URI in the subscription resource. + +The AMF may also provide the name of the AMF service to which these notifications are to be sent (this service shall be one of the service produced by the AMF and registered in the NRF or a custom service registered in the NRF for the purpose of receiving these notifications); + +NOTE 1: Providing an AMF service name allows the NF Service Producer to find the endpoint address and callback URI prefix (if any) to deliver the notifications (see bullet 2). The provided AMF service might not use itself the information received in these notifications. + +2. A NF service producer may also use the Nnrf\_NFDiscovery service to discover AMFs within an AMF set or backup AMF. + +If the AMF provided the name of its service (see bullet 1), the NF Service Producer shall look up for the same AMF service from the AMFs within the AMF set or from backup AMF, and use endpoint addresses (i.e. IP addresses, transport and port information, or FQDN) and callback URI prefix (if any) of that service to send notifications (see bullet 6). Otherwise, the notifications shall be sent to an endpoint address registered in the NF Profile of the AMF. + +NOTE 2: The AMF can register different endpoint addresses in the NRF for different services. + +3. An NF service producer may subscribe to GUAMI changes using the AMFStatusChange service operation of the Namf\_Communication service. +4. An NF service producer may become aware of AMF changes (at the time of the AMF change or subsequently when sending signalling to the AMF) via Namf\_Communication service AMFStatusChange Notifications, via HTTP Error response from the old or a wrongly selected new AMF, via link level failures (e.g. no response from the AMF), or via a notification from the NRF that the AMF has deregistered. The HTTP error response may be a 3xx redirect response pointing to a new AMF. + +NOTE 3:. AMFs are identified by GUAMIs. A GUAMI can point to an individual AMF or to some or all AMFs within an AMF set. If a GUAMI points to several AMFs, and the UE is served by one of those, all those AMFs can immediately handle communication for that service, and the NF service producer does not need to be aware which of those AMFs is serving a UE. + +5. When becoming aware of an AMF change, and the new AMF is not known, the NF service producer shall select an AMF within the AMF set or the possibly earlier received backup AMF. +6. When becoming aware of an AMF change, the NF service producer shall + - use the default notification URI of the default notification subscription of the reselected AMF (as specified in clause 6.10.5.2), if this is a default notification from a default notification subscription; otherwise + - replace the authority part and callback URI prefix (if any) of the Notification URI with new AMF information; when replacing the authority, if the port number or and callback URI prefix are not available for the new AMF, e.g. when the NF instance level information of the new AMF is to be used, the port number and callback URI prefix (if any) in old Notification URI should be reused in the alternative notification URI. + +The NF service producer shall then use that URI in subsequent communication. + +7. Each AMF within the AMF set shall be prepared to receive notifications from the NF service producer, by either handling the notification to the Notification URI constructed according to bullet 6 with the own address as authority part and callback URI prefix (if any), or by replying with an HTTP 3xx redirect pointing to a new AMF, or by replying with another HTTP error. +8. The NF service producer shall be prepared to receive updates to resources of the related service from any AMF within the set. +9. If the UE moves to an AMF from a different AMF Set, or to an AMF from the same AMF set that does not support handling the notification as specified in bullet 7, the new AMF should update peer NFs with the new callback URI for the notification. + +### 6.5.2.3 AMF as service producer + +1. When AMF receives request to establish a service, it may provide information about a backup AMF in a suitable resource. + +2. NF service consumer may also use the Nnrf\_NFDiscovery service to discover AMFs within an AMF set. +3. An NF service consumer may subscribe to GUAMI changes using the AMFStatusChange service operation of the Namf\_Communication service. +4. An NF service consumer may become aware of AMF changes (at the time of the AMF change or subsequently when sending signalling to the AMF) via Namf\_Communication service AMFStatusChange Notifications, via Error response from the old or a wrongly selected new AMF, via link level failures (e.g. no response from the AMF), or via a notification from the NRF that the AMF has deregistered. The HTTP error response may be a 3xx redirect response pointing to a new AMF. + +NOTE. AMFs are identified by GUAMIs. A GUAMI can point to an individual AMF or to some or all AMFs within an AMF set. If a GUAMI points to several AMFs, and the UE is served by one of those, all those AMFs can immediately handle communication for that service, and the NF service consumer does not need to be aware which of those AMFs is serving a UE. + +5. When becoming aware of an AMF change, and the new AMF is not known, the NF service consumer shall select an AMF within the AMF set or the possibly earlier received backup AMF. +6. When becoming aware of an AMF change, the NF service consumer shall exchange the apiRoot of resource URIs with new AMF's apiRoot and shall use that URI in subsequent communication. +7. Each AMF within the AMF set shall be prepared to receive updates for resources from the NF service consumer, by either handling the updates to the resource URIs constructed according to step 6 with its own apiRoot, or by replying with an HTTP 3xx redirect pointing to a new AMF, or by replying with another HTTP error. +8. For a service that includes notifications from the AMF, the NF service consumer shall be prepared to receive for the service notifications from any AMF within the set. + +NOTE: If the UE moves to an AMF from a different AMF Set, or to an AMF from the same AMF set that does not support handling the updates as specified in bullet 7, but mechanisms exist to transfer information related to the resource to the AMF, service specific mechanism can exist to notify the NF service consumer about the resource at the AMF. For instance, for the Namf\_EventExposure service, information and an event subscription is transferred to the new AMF in such a manner and the new AMF will then report an event-change event. + +### 6.5.3 Stateless NFs (for any 5GC NF type) + +#### 6.5.3.1 General + +An NF may become stateless by storing its contexts as unstructured data in the UDSF. An UDM, PCF and NEF may also store own structured data in the UDR. An UDR and UDSF cannot become stateless. + +An NF may also be deployed such that several stateless network function instances are present within a set of NF instances. Additionally, within an NF, an NF service may have multiple instances grouped into a NF Service Set if they are interchangeable with each other because they share the same context data. See clause 5.21 of 3GPP TS 23.501 [3]. + +A UDM / AUSF / UDR / PCF group may consist of one or multiple UDM / AUSF / UDR / PCF sets. + +#### 6.5.3.2 Stateless NF as service consumer + +1. When the NF service consumer subscribes (explicitly or implicitly) to notifications from another NF service producer, the NF service consumer may provide a binding indication to the NF service producer as specified in clause 6.3.1.0 of 3GPP TS 23.501 [3] and clause 4.17.12.4 of 3GPP TS 23.502 [4], to enable the related notifications to be sent to an alternative NF service consumer within the NF (service) set, in addition to providing the Callback URI in the subscription resource. The NF service consumer may provide the NRF API URI(s) in 3gpp-Sbi-Nrf-Uri-Callback header which can be used for reselection of NF service consumer. +2. A NF service producer or SCP may use the Nnrf\_NFDiscovery service to discover NF service consumers within an NF (service) set. If the NRF API URI(s) was received in the 3gpp-Sbi-Nrf-Uri-Callback header in bullet 1, the NRF NFDIscovery API URI should be used for the reselection. + +3. An NF service producer may become aware of a NF service consumer change, via receiving an updated binding information (i.e. when the binding entity corresponding to the binding level is changed) in a HTTP request message, or via an Error response to a notification, via link level failures (e.g. no response from the NF), or via a notification from the NRF that the NF service consumer has deregistered. The HTTP error response may be a 3xx redirect response pointing to a new NF service consumer. +- NOTE 1: When the binding entity other than the one corresponding to the binding level is changed, it indicates the resilience information of the session is changed, i.e. more or less consumer instances are able to handle the Notification/Callback request message; the NF service producer is not expected to change Notification/Callback URI. +- NOTE 2: When a Binding Indication is included in an acceptance response message, the NF service producer stores the Binding Indication, but does not check it to determine whether there is a NF service consumer change. Accordingly, the NF service producer continues to use its current Notification/Callback URI for subsequent requests, until it becomes aware of an NF service consumer change, at which point in time it uses the last received binding information to reselect a different instance. +4. When becoming aware of an NF service consumer change, and if the new NF service consumer is not known, the NF service producer shall select a new NF service consumer as specified in clause 6.6 of 3GPP TS 23.527 [38]. If binding information is available and the binding mechanism is supported by the NF service producer, the reselection should be based on the binding information, as specified in clause 6.6.2 of 3GPP TS 23.527 [38], in clause 6.3.1.0 of 3GPP TS 23.501 [3] and in clause 4.17.12.4 of 3GPP TS 23.502 [4]. If binding information is not available or the binding mechanism is not supported by the NF service producer, the reselection is performed as specified in clause 6.6.3 of 3GPP TS 23.527 [38]. + 5. When becoming aware of an NF service consumer change, the NF service producer or SCP shall + - use the default notification URI of the default notification subscription of the reselected NF service consumer (as specified in clause 6.10.5.2), if this is a default notification from a default notification subscription; otherwise + - replace the authority and callback URI Prefix (if any) part of the Notification/Callback URI with the new NF service consumer information; when replacing the authority, if the port number or and callback URI prefix are not available for the new NF service consumer, e.g. when the NF instance level information of the new NF service consumer is to be used, the port number and callback URI prefix (if any) in old Notification URI should be reused in the alternative notification URI. + +The NF service producer or SCP shall then use that URI in subsequent communications, as specified in clause 6.6 of 3GPP TS 23.527 [38]. + +6. When the NF service consumer is changed, and if the new NF service consumer does not support handling notifications as specified in the above bullet 5, the new NF service consumer should update the NF service producers with the new Notification URI. For explicit subscriptions, this is achieved by updating the existing subscription or creating a new subscription, depending on the NF service producer's API. For implicit subscriptions, this is carried out via a service update request message. +7. The new NF service consumer may include an updated binding indication in a service request or notification response message to the NF service producer. +8. Each NF service consumer within the NF (service) set shall be prepared to receive notifications from the NF service producer, either by handling the notifications to the Notification URI constructed according to the above bullet 5 with its own address as authority part and callback URI Prefix (if any), by handling the notifications to the Notification URI notified in the above bullet 6, or by replying with an HTTP 3xx redirect pointing to a new NF service consumer or with another HTTP error. +9. The NF service producer shall be prepared to receive updates to resources of the related service from any NF service consumer within the NF (service) set. +10. If an SCP detects that the target NF service consumer of a notification/callback request is not available, the SCP shall reselect a new NF service consumer based on the Routing Binding Indication and/or 3gpp-Sbi-Discovery headers, if such information has been provided by the NF service producer in the notification/callback request. See clause 6.6 in 3GPP TS 23.527 [38]. + +### 6.5.3.3 Stateless NF as service producer + +1. When the NF service producer receives a request to establish a service, it may provide binding information as specified in clause 6.3.1.0 of 3GPP TS 23.501 [3] and clause 4.17.12 of 3GPP TS 23.502 [4] to establish a binding between the NF service consumer and the NF service producer for subsequent related requests. +2. The NF service consumer or SCP may use the Nnrf\_NFDiscovery service to discover NF service producers within an NF (service) set. +3. An NF service consumer may become aware of a NF service producer change, by receiving an updated binding information (i.e. when the binding entity corresponding to the binding level is changed) in a HTTP request message, or via an Error response from the old or a selected new NF service producer, via link level failures (e.g. no response from the NF), or via a notification from the NRF that the NF has deregistered. The HTTP error response may be a 3xx redirect response pointing to a new NF. + +NOTE 1: When the binding entity other than the one corresponding to the binding level is changed, it indicates the resilience information of the resource context is changed, i.e. more or less service instances are able to handle the service request message; the NF service consumer is not expected to change the Location of the resource context in the NF service producer. + +NOTE 2: When a Binding Indication is included in an acceptance response message, the NF service consumer stores the Binding Indication, but does not check it to determine whether there is a NF service producer change. Accordingly, the NF service consumer continues to use its current Resource URI for subsequent requests, until it becomes aware of an NF service producer change, at which point in time it uses the last received binding information to reselect a different instance. + +4. When becoming aware of an NF service producer change, and if the new NF service producer is not known, the NF service consumer shall select a new NF service producer, as specified in clause 6.5 of 3GPP TS 23.527 [38]. If binding information is available and the binding mechanism is supported by the NF service consumer, the reselection should be based on the binding information, as specified in clause 6.12 of this specification (see also clause 6.5.2 of 3GPP TS 23.527 [38]) and in clause 6.3.1.0 of 3GPP TS 23.501 [3]. If binding information is not available or the binding mechanism is not supported by the NF service consumer, the reselection is performed as specified in clause 6.5.3 of 3GPP TS 23.527 [38]. +5. When becoming aware of an NF service producer change, the NF service consumer or SCP shall replace the apiRoot of the resource URI with the new NF service producer's apiRoot and shall use that URI in subsequent communications as specified in clause 6.5 of 3GPP TS 23.527 [38]. +6. When the NF service producer changes, the new NF service producer may include an updated binding indication in a notification/callback request sent to the NF service consumer. The new NF service producer may also generate a new resource URI and return it to the NF service consumer upon reception of a service request related to the resource from that NF service consumer, e.g. the new NF service producer may reply with an HTTP 3xx redirect status code pointing to the new location of the resource. +7. Each NF service producer within the NF (service) set shall be prepared to receive updates for resources from the NF service consumer, either by handling the updates to the resource URIs constructed according to the above bullet 5 with its own apiRoot, by handling the updates to the resource URIs notified in the above bullet 6, by replying with an HTTP 3xx redirect pointing to a new NF service producer, or by replying with another HTTP error. +8. For a service that includes notifications from the NF service producer, the NF service consumer shall be prepared to receive for that service notifications from any NF service producer within the NF (service) set. +9. If an SCP detects that the target NF service producer is not available, the SCP shall reselect a new NF service producer based on the Routing Binding Indication and/or 3gpp-Sbi-Discovery headers, if such information has been provided by the NF service consumer in the request. See clause 6.5 in 3GPP TS 23.527 [38]. + +## 6.6 Extensibility Mechanisms + +### 6.6.1 General + +This clause describes the extensibility mechanisms supported in the Service-Based Architecture in 3GPP 5GC, such as feature negotiation, vendor-specific extensions, etc. + +### 6.6.2 Feature negotiation + +A versioning of services in the request URI shall be supported by 3GPP 5G APIs, but version upgrades shall only be applied for non-backward compatible changes or the introduction of new mandatory features. + +The following mechanism to negotiate applicable optional features shall be used by 5G APIs. This supported feature mechanism shall be applied separately for each API. + +For any API that defines resources, suitable resources associated to or representing the NF Service Consumer (e.g. a top-level resource or a sub-resource representing the NF Service Consumer) shall be identified in each API to support the negotiation of the applicable optional features between the NF Service Consumer and NF Service Producer for this resource. Each such resource for a 5G API shall contain an attribute (e.g. "supportedFeatures") of the SupportedFeatures data type defined in 3GPP TS 29.571 [13] containing a bitmask to indicate supported features. The features and their positions in that bitmask are defined separately for each API. + +The HTTP client acting as NF service consumer shall include the attribute of the SupportedFeatures data type defined in 3GPP TS 29.571 [13] in the HTTP PUT or POST requests to create the resource associated to or representing the NF Service Consumer of 5G API. This attribute indicates which of the optional features defined for the corresponding service are supported by the HTTP client. The HTTP server shall determine the supported features for the corresponding resource by comparing the supported features indicated by the client with the supported features the HTTP server supports. Features that are supported both by the client and the server are supported for that resource. The HTTP server shall include the attribute of the SupportedFeatures data type defined in 3GPP TS 29.571 [13] indicating those features in the representation of the resource it returns to the HTTP client in the HTTP response confirming the creation of the resource. + +The HTTP client acting as NF service consumer may include a query parameter (e.g. "supported-features") of the SupportedFeatures data type defined in 3GPP TS 29.571 [13] in HTTP GET requests to fetch resource(s) associated to the NF Service Consumer of 5G API. This query parameter indicates which of the optional features defined for the corresponding service are supported by the HTTP client. The HTTP server shall determine the supported features for the corresponding resource(s) by comparing the supported features indicated by the client with the supported features the HTTP server supports. Features that are supported both by the client and the server are supported for the resource(s); attributes or enumerated values that are only of relevance to a feature unsupported by the requested resource(s) should be omitted from the representation sent in the response. The HTTP Server shall include the attribute of the SupportedFeatures data type defined in 3GPP TS 29.571 [13] indicating those features in the HTTP GET response, if supported by the API definition. + +The supported features for a resource associated to or representing the NF Service Consumer shall also be applicable to all subordinate resources of that resource, and for all custom operations related to any of those resources. If any of those resources is used for the subscription to notifications (see clause 4.6.2 of 3GPP TS 29.501 [5]), the supported features shall also apply to those notifications. For default notification subscriptions, the supported features shall be determined by comparing the supported features if registered by the NF Service Consumer for the corresponding default notification subscription in NRF with the features supported by the NF Service Producer. Features that are supported by both are supported for the default notification subscription, which shall also apply to related default notifications. + +When an NF service consumer subscribes to notifications from an NF service producer via an intermediate NF (see Figure 7.1.2-3 of 3GPP TS 23.501 [5]), the NF service consumer may indicate, to the intermediate NF and the NF service producer, the API version(s) and the optional features it supports for the corresponding NF service producer's service by including the 3gpp-Sbi-Consumer-Info header in its request as described in clauses 5.2.3.3.7 and 6.2.2. When required by a given API, the NF service producer may then indicate the features supported by both the NF service consumer and NF service producer for the subscription and its notifications by including an attribute of the SupportedFeatures data type in the notification request it sends towards the NF service consumer. + +NOTE 1: The above principles can also apply in scenarios where: + +- a) the intermediate NF creates the subscription at the NF service producer by other means than a subscribe service operation (e.g. AF using the PCC framework to indicate its subscriptions to SMF events), by passing the 3gpp-Sbi-Consumer-Info header value within an attribute to the NF service producer (e.g. in a PCC rule); or +- b) the NF service consumer's subscription is indicated to the NF service producer as a service parameter data stored in the UDR (acting as the intermediate NF) by passing the 3gpp-Sbi-Consumer-Info header value within an attribute to the UDR. + +Details are to be specified by each such API. + +Attributes used for the representation of a resource, particular values in enumerated data types, and/or procedural description can be marked to relate to a particular supported feature. Such attributes shall not be mandated in data structures. Such attributes or enumerated values shall only be sent and such procedures shall only be applied if the corresponding feature is supported. + +Unknown attributes and values shall be ignored by the receiving entity. Unsupported query parameters shall be handled as specified in clause 5.2.9. + +NOTE 2: The sender can send such information before the supported features for a resource have been determined. + +For an API that does not define any resources, only custom operations without associated resources or notifications without subscription will be used. For such APIs, if a feature negotiation is desired, the request and response bodies of a suitable custom operation or notification need to be defined in such a manner that an attribute of the SupportedFeatures data type defined in 3GPP TS 29.571 [13] is included. The client invoking that custom operation or notification shall indicate its supported features for that API within the corresponding HTTP request. The data structures to be included in the HTTP request as defined for that API, shall include the attribute of the SupportedFeatures data type defined in 3GPP TS 29.571 [13], preferably in the outermost data structure for cases where the body contains a complex structure with several layers of JSON objects. The server shall determine the supported features by comparing the supported features indicated by the client with its own supported features. Features that are supported both by the client and the server are supported for subsequent custom operations and notifications of that API. The server shall include the attribute of the SupportedFeatures data type defined in 3GPP TS 29.571 [13] indicating those features in the successful response to the custom operation or notification. The data structures to be included in the HTTP response as defined for that API, shall include the attribute of the SupportedFeatures data type defined in 3GPP TS 29.571 [13], preferably in the outermost data structure for cases where the body contains a complex structure with several layers of JSON objects. The client and server shall only use those supported features in subsequent communication of that API between each other until the supported feature negotiation performed as part of that communication yields a new result. + +Additionally, a NF instance should register all the features it supports to the NRF, to enable NF Service Consumers to discover NF Service Producers supporting specific features. A NF instance should register all the features it supports as NF Service Consumer in the corresponding default notification subscription in its NF profile to the NRF, to enable NF Service Producer to select NF Service Consumer supporting specific features. + +Specific requirements for support of Indirect Communication with Delegated Discovery are specified in clause 6.10.6. + +### 6.6.3 Vendor-specific extensions + +Information elements sent on the 3GPP 5GC APIs should be extensible with vendor-specific data. The definition of JSON data structures using OpenAPI as Interface Definition Language (see OpenAPI Specification [9]) allows to extend by default any JSON object with additional member elements, as long as no specific directives are included in the schema definition preventing such extension (e.g., by setting "additionalProperties" to false). + +NOTE 1: The only JSON data types that can be extended, by defining additional members, are JSON objects; simple data types (and arrays of items of simple data types) cannot be extended in this way. + +However, in order to avoid duplication of member names inside a same object (see 3GPP TS 29.501 [5], clause 5.2.4.2, for the requirement of uniqueness of member names in JSON objects), it is necessary to comply with a naming scheme for vendor-specific data elements, to avoid clashing names between vendors. + +Vendor-specific member names in JSON objects shall be named in the following manner: + +``` +"vendorSpecific-nnnnnn": { +``` + +``` +} ... +``` + +where the value "nnnnnn" is a fixed 6-digit string, using the IANA-assigned "SMI Network Management Private Enterprise Codes" [18] value associated to a given vendor, and padding with leading digits "0" to complete a 6-digit value. + +NOTE 2: The content (value) of those vendor-specific member elements, and their usage, is not to be defined by any of the 3GPP Technical Specifications. Also, the type of value assigned to these members is not defined by 3GPP, and therefore, they can be any of the types allowed in the JSON specification: objects, arrays, or simple types (string, number, Boolean, etc.). However, to allow future extensibility of these values, it is recommended that they are defined as objects. + +EXAMPLE: The vendor-specific member name for vendor "3GPP" would be: + +``` +"vendorSpecific-010415": { + ... +} +``` + +## 6.6.4 Extensibility for Query parameters + +New query parameters may be defined after the OpenAPI freeze of the first 3GPP release that contains an API. + +A new feature should be defined in the API for any query parameter added in a new version of the API or for any new functionality resulting in defining new query parameter(s). A single feature may be defined, if appropriate, when adding multiple query parameters in a new version of the API. + +Prior to using such a query parameter in an HTTP request, the NF Service Consumer should determine, if possible, whether the query parameter is supported by the NF Service Producer, using the feature negotiation mechanism specified in clause 6.6.2. + +NOTE 1: Not doing so could result in the NF Service Producer rejecting the request if it does not support the query parameters, see clause 5.2.9. + +NOTE 2: A NF Service Consumer can discover the features (and therefore the query parameters) supported by a NF Service Producer using the NRF, if the latter has registered the features it supports to the NRF. + +If the NF Service Consumer includes the query parameter (e.g. "supported-features") of the SupportedFeatures data type defined in 3GPP TS 29.571 [13] in an HTTP GET request (see clause 6.6.2), the NF Service Producer shall include the attribute (e.g. "supportedFeatures") of the SupportedFeatures data type defined in 3GPP TS 29.571 [13] in the HTTP GET response, set as defined for HTTP responses in clause 6.6.2, if supported by the API definition. + +NOTE 3: This allows a NF Service Consumer to discover the features (and therefore the query parameters) supported by the NF Service Producer when the first interaction with the NF Service Producer is an HTTP GET request and the service was not discovered via the NRF, e.g. for a NF Discovery Request sent to the NRF. + +NOTE 4: Some APIs are designed to allow returning the attribute of the SupportedFeatures data type defined in 3GPP TS 29.571 [13] in the HTTP GET response, regardless of whether the query parameter of the SupportedFeatures data type defined in 3GPP TS 29.571 [13] is present in the request. + +If a NF Service Consumer uses such a query parameter in an HTTP GET request without prior knowledge of whether it is supported by the NF Service Producer, the NF Service Consumer shall be prepared to receive a successful response that may not match all the query parameters sent in the request, and to act accordingly. The NF Service Consumer may use the attribute of the SupportedFeatures data type defined in 3GPP TS 29.571 [13] returned by the NF Service Producer in the HTTP GET response, if available, to determine the features (and thus query parameters) not supported by the NF Service Producer. + +When defining new query parameters in a new version of an API, it needs to be checked that the addition of the query parameter does not cause backward compatibility problems with NF Service Producers complying with an earlier version of the API, e.g. if the query parameter is ignored in a HTTP GET request. Otherwise, it needs to be ascertained that the NF Service Consumer does not use such a query parameter without prior knowledge that it is supported by the NF Service Producer. + +## 6.7 Security Mechanisms + +### 6.7.1 General + +The security mechanisms for service based interfaces are specified in clause 13 of 3GPP TS 33.501 [17]. + +Security Protection Edge Proxy (SEPP), as specified in 3GPP TS 33.501 [17], shall be used between service based interfaces across PLMNs. The NFs in a PLMN shall use the SEPP as a HTTP/2 proxy for the HTTP/2 messages that carry ":authority" pseudo header with a uri-host formatted as specified in clause 6.1.4.3. + +### 6.7.2 Transport layer security protection of messages + +As specified in clause 13.1 of 3GPP TS 33.501 [17], TLS shall be used for the security protection of messages at the transport layer for the service based interfaces if network security is not provided by other means. + +### 6.7.3 Authorization of NF service access + +Clause 13 in 3GPP TS 33.501 [17] specifies two alternative authorization mechanisms: + +- Static authorization, which is based on local authorization policy at the NRF and the NF Service Producer (see clause 13.3.0); +- Token based authorization, when NRF acts as the Authorization Server and provides access (see clause 13.3.1). + +As specified in clause 13.4.1 of 3GPP TS 33.501 [17] OAuth 2.0 (see IETF RFC 6749 [22]) may be used for authorization of NF service access. All NFs and the NRF shall support the OAuth 2.0 authorization framework with "Client Credentials" grant type as specified in clause 4.4 of IETF RFC 6749 [22], except that there is no "Authorization" HTTP request header in the access token request. + +The NRF shall act as the Authorization Server providing "Bearer" access tokens (IETF RFC 6750 [23]) to the NF service consumers to access the services provided by the NF service providers. + +If an NF service (i.e. API) receives an OAuth 2.0 access token in the "Authorization" HTTP request header field, the NF service shall validate the access token, its expiry and its access scope before allowing access to the requested resource, as specified in clause 7 of IETF RFC 6749 [22]. + +The access scope required to get access to a given resource may be, based on local configuration of the NF service producer, either: + +- the service name of the NF Service; this scope grants generic access to a given API, for those operations on resources that don't require a specific authorization, or +- both, the service name of the NF Service, and a string that uniquely represents the type of operation (e.g. create/modify/read), the resource and the service; those two scopes, together, grant access to those operations on resources that require a specific authorization. + +An NF service consumer shall support OAuth 2.0. + +For request/response semantics service operations and for the subscribe and unsubscribe operations of subscribe/notify semantics service operations, an NF service consumer may use OAuth 2.0 for the authorization of the API access, based on local configuration. The NF service consumer discovers the additional scopes (resource/operation-level scopes) that might be required to invoke a certain service operation, based on the authorization information registered in NRF by the NF service producer in its NF profile. + +When OAuth2 authorization is used, the NF service consumer shall use the token received from NRF as a "Bearer" token and include it in the Authorization header of the HTTP service requests, as described in IETF RFC 6750 [23] clause 2.1. + +An NF service producer shall decide to accept or reject an API request without the OAuth2.0 access token in the "Authorization" HTTP request header field, based on local configuration. + +If an NF service producer rejects an API request without the OAuth2.0 access token or an API request with an invalid OAuth2.0 access token, it shall return the HTTP "401 Unauthorized" status code together with the "WWW-Authenticate" header as specified in IETF RFC 9110 [11], where: + +- the scheme for challenge in the "WWW-Authenticate" header shall be set to "Bearer" (IETF RFC 6750 [23]), +- the "realm" attribute shall be set to the URI of the service (i.e. API URI) for which the access failed, in the case of request / response service operations, +- the "error" attribute shall be set to "invalid\_token", as described in IETF RFC 6750 [23], if the request contained a token which was deemed as invalid by the NF service producer (e.g. it is expired, malformed...); if the request did not contain a token, the "error" attribute shall not be included. + +If an NF service producer rejects an API request with an OAuth2.0 access token not having the required scopes to invoke the service operation, it shall return the HTTP "403 Forbidden" status code together with the "WWW-Authenticate" header, where: + +- the scheme for challenge in the "WWW-Authenticate" header shall be set to "Bearer", +- the "realm" attribute shall be set to the URI of the service (i.e. API URI) for which the access failed, in the case of request / response service operations, +- the "error" attribute shall be set to "insufficient\_scope" as described in IETF RFC 6750 [23], +- the "scope" attribute shall be set with the scope(s) necessary to access the protected resource. + +For the notify operation of subscribe/notify semantics service operations, in this release of this specification OAuth 2.0 access token is not used. + +When an NF service consumer receives a "401 Unauthorized" or a "403 Forbidden" status code with a "WWW-Authenticate" header containing "Bearer" as the scheme for challenge it shall not repeat the same request without an OAuth2.0 access token or with an access token that has been already used. The NF service consumer may repeat the same request with a new OAuth 2.0 access token. + +NOTE: If a NF service producer accepts a request without the OAuth 2.0 access token, based on local policy, it is assumed that such accesses are allowed based on trust relationships and hence full access to the resource as it would have been otherwise allowed, is provided. + +## 6.7.4 Application layer security across PLMN + +### 6.7.4.1 General + +HTTP/2 messages sent across the PLMN between the SEPPs shall follow the application layer security procedures specified in clause 13.2 of 3GPP TS 33.501 [17]. + +### 6.7.4.2 N32 Procedures + +As specified in clause 13.2 of 3GPP TS 33.501 [17], the following procedures shall be supported across N32 + +- Capability Negotiation Request and Response; +- Parameter Exchange Request and Response; +- forwarding of the JOSE (see IETF RFC 7516 [25] and IETF RFC 7515 [26]) protected messages over N32. + +Based on the capability negotiation and parameters exchanged between the SEPPs, the service based interface messages sent across N32 interface shall be subjected to JOSE based protection (see IETF RFC 7516 [25] and IETF RFC 7515 [26]) as specified in clause 13.2.4 of 3GPP TS 33.501 [17]. + +3GPP TS 29.573 [27] specifies protocol for the exchange of the messages described above over N32, the format of the JOSE (see IETF RFC 7516 [25] and IETF RFC 7515 [26]) protected messages and the procedure for forwarding of the JOSE protected messages over N32. + +## 6.7.5 Client credentials assertion and authentication + +### 6.7.5.1 General + +The Client credentials assertion (CCA) and authentication procedure specified in clause 13.3.8 of 3GPP TS 33.501 [17] may be used to enable the NRF or the NF Service Producer to authenticate the NF Service Consumer, when using indirect communication. + +If so, an HTTP request shall include the 3gpp-Sbi-Client-Credentials header (see clause 5.2.3.2.11) containing the client credentials assertion. The verification of the client credentials assertion shall be performed by the receiving entity as specified in clause 13.3.8.3 of 3GPP TS 33.501 [17]. + +If the verification of the CCA fails at the receiving entity (e.g. NRF or NF service producer), a "403 Forbidden" response shall be returned with the cause attribute set to "CCA\_VERIFICATION\_FAILURE". + +If the subject claim (i.e., the NF Instance Id of the NF Service Consumer) in the access token does not match the subject claim in the CCA at the receiving entity (e.g. NRF or NF service producer), a "403 Forbidden" response shall be returned with the cause attribute set to "TOKEN\_CCA\_MISMATCH". + +### 6.7.5.2 Authorization of NF Service Consumers for data access via DCCF + +Requirements for authentication and authorization of NF Service Consumers for data access via DCCF are specified in clause X.2 of 3GPP TS 33.501 [17]. + +From the perspective of the NF Service Producer, the NF Service Consumer defined in clause X.2 of 3GPP TS 33.501 [17] correspond to the Source NF Instance, and the DCCF corresponds to the NF Service Consumer, defined in 3GPP TS 29.510 [8] and in this specification. + +The following requirements shall apply when the source NF Instance and/or the DCCF need to signal their own respective CCAs towards the NF Service Producer: + +- In the service request from the source NF instance to the DCCF: + - the 3gpp-Sbi-Client-Credentials shall convey the client credentials assertion of the source NF Instance. +- In the service request from the DCCF to the NF Service Producer: + - the 3gpp-Sbi-Client-Credentials shall convey the client credentials assertion of the DCCF; and + - the 3gpp-Sbi-Source-NF-Client-Credentials shall convey the client credentials assertion of the source NF Instance. + +If the verification of the 3gpp-Sbi-Client-Credentials fails at the receiving entity (e.g. NRF or NF service producer), a "403 Forbidden" response shall be returned with the cause attribute set to "CCA\_VERIFICATION\_FAILURE". + +If the verification of the 3gpp-Sbi-Source-NF-Client-Credentials fails at the receiving entity (e.g. NRF or NF service producer), a "403 Forbidden" response shall be returned with the cause attribute set to "SOURCE\_NF\_CCA\_VERIFICATION\_FAILURE". + +If the subject claim (i.e., the NF Instance Id of the NF Service Consumer) in the access token does not match the subject claim in the 3gpp-Sbi-Client-Credentials at the receiving entity (e.g. NRF or NF service producer), a "403 Forbidden" response shall be returned with the cause attribute set to "TOKEN\_CCA\_MISMATCH". + +If the sourceNfInstanceId claim (i.e., the NF Instance Id of the Source NF Instance) in the access token does not match the subject claim in the 3gpp-Sbi-Source-NF-Client-Credentials at the receiving entity (e.g. NRF or NF service producer), a "403 Forbidden" response shall be returned with the cause attribute set to "TOKEN\_SOURCE\_NF\_CCA\_MISMATCH". + +## 6.8 SBI Message Priority Mechanism + +### 6.8.1 General + +The primary usage of SBI Message Priority (SMP) is to provide guidance to 5GC NF acting as HTTP/2 clients or servers and HTTP/2 proxies when making throttling decisions related to overload control. The priority information may also be used for routing in proxies. Eventually a server may use the priority information to process higher-priority requests before lower-priority requests. + +The SMP mechanism defined in this clause uses the "3gpp-Sbi-Message-Priority" custom HTTP header defined in clause 5.2.3.2.1 to set and carry the message priority between the client and the server. + +NOTE: The custom HTTP header enforces the message priority end to end between the client and the server through one or more proxies. + +The SMP mechanism should not use the stream priority mechanism, because that is deprecated in IETF RFC 9113 [7] clause 5.3. + +HTTP/2 clients, servers and proxies implementing SBIs shall support the custom HTTP header and may support the stream priority. + +### 6.8.2 Message level priority + +A client, proxy and server shall use the "3gpp-Sbi-Message-Priority" value (see clause 5.2.3.2.1) when setting or evaluating the priority of a message. + +The client shall assign the request priority by adding the "3gpp-Sbi-Message-Priority" custom HTTP header (see clause 5.2.3.2.1) to the message and setting its value. + +If the "3gpp-Sbi-Message-Priority" custom HTTP header is not present in a response message then the HTTP nodes shall use the priority indicated in the "3gpp-Sbi-Message-Priority" of the associated request message. + +If the server wants to assign a different priority to the response message than the request one then the server shall assign the response priority by adding the "3gpp-Sbi-Message-Priority" custom HTTP header to the message and setting its value. + +### 6.8.3 Stream priority + +The purpose of HTTP/2 stream priority is to allow an endpoint to prioritize streams for transmitting frames when there is limited capacity for sending and to express how it would prefer its peer to allocate resources when managing concurrent streams. Setting the stream priority indicates a priority treatment to a message between the two endpoints of an HTTP/2 connection. + +Clause 5.3 of the IETF RFC 9113 [7] deprecates the HTTP/2 stream priority signaling. + +For interoperability with implementations complying with earlier releases, 5GC NFs shall support receiving priority info in HEADER or PRIORITY frames to the extent that headers or frames containing stream priority information shall not be rejected, but processed as if they contained no stream priority information, i.e. the stream priority information is ignored. + +NOTE: Server implementations can alternatively use the stream priority information as specified in clause 5.3.2 of IETF RFC 9113 [7], but it is recommended to use the SBI Message Priorities instead. + +### 6.8.4 Recommendations when defining SBI Message Priorities + +The recommendations provided in this clause are compliant with clause 10 of IETF RFC 7944 [19]. The priority value range defined over SBIs spans from 0 to 31 (decimal), where 0 indicates the highest priority and 31 indicates the lowest priority. The recommendations have been adapted to 5G services and Service Based Architecture. + +The priorities defined for all messages across all SBIs used in an HTTP/2 administrative domain must be defined in a consistent and coordinated fashion, taking the default priority (see below for default priority values) into account. + +The following are some guidelines to be considered when defining the SMPs to be used in SBA networks that support HTTP/2 nodes handling multiple services. + +- As with any prioritization scheme, it is possible for higher-priority messages to block lower-priority messages from ever being handled. In 5GC, this will often result in the messages being retried. This may result in more traffic than the network would have handled without use of the SMP mechanism. + +One potential guideline to prevent unwanted starving of lower-priority messages is to have higher-priority messages represent a relatively small portion of messages handled by the 5GC under normal scenarios. The Multimedia Priority Service (see 3GPP TS 23.501 [5] clause 5.16.5) and the Mission Critical Service (see 3GPP TS 23.501 [5] clause 5.16.6) typically generate little traffic compared to the total traffic of a 5GC. + +The Multimedia Priority Service (MPS) and the Mission Critical Service (MCX) require the blocking of lower-priority services. + +- A network entity (e.g., the AMF) that has received an RRC Establishment Cause associated with priority service (e.g., mps-PriorityAccess, mcs-PriorityAccess, or highPriorityAccess) or has determined that the UE has a priority subscription (e.g., MPS, MCX) in the UDM/UDR, shall select an SMP value appropriate for the priority service (e.g., MPS, MCX) for use in requests and responses. + +NOTE 1: Other situations (e.g., certain ARP, 5QI Priority Level or 5QI values) and/or other network elements (e.g., UDM, PCF, etc.) can also set the SMP to an appropriate level for a priority service. + +- When setting priorities for Multimedia Priority Services, Mission Critical Services or Emergency calls, it is important to use the same priority values across all APIs and services exposed by the 5GC. For instance, if the MPS priority levels of [1; n] are assigned the values of [k; k+n-1], then the same values shall be defined in the same order on all SBIs for the same service. +- Messages related to MPS, MCX and Emergency calls may be ranked according to their priority (e.g., based on ARP priority level, 5QI priority level, MPS Priority) based on regional/national regulatory and operator policies when it is known by the application sending the message. Otherwise MPS and MCX should have higher priorities than Emergency calls. Emergency call related messages should have higher priority than the rest of the messages. The ranking can be used to select SMP values. + +NOTE 2: In some situations (e.g. REGISTRATION or SERVICE REQUEST procedure); it is possible to identify that the message belongs to a procedure of a high priority user without knowing the identity of the priority service. In such a case, all the messages sent over an SBI of these high priority procedures should be given the same SBI message priority. + +The following are general requirements: + +- Requests without the "3gpp-Sbi-Message-Priority" header shall be assigned the default priority value of "24". +- When defining priorities of the messages of a service, the same rules apply independently of the application, the SBI and the service: + - When there is a series of request/response required to complete a procedure, it is appropriate to mark request/responses that occur later in the series at a higher priority than those that occur early in the series. + - The requests that establish new sessions should have a lower priority than the requests that update or end a session. + - The requests that will result in deregistering users if they failed (e.g., due to authentication vector retrieval, or update location) shall have a higher priority than the requests of a non-registered user. + - Request/responses of optional procedures and of delay tolerant services should have lower priority than those of mandatory procedures. + +## 6.8.5 HTTP/2 client behaviour + +The client sending a request shall determine its required priority according to 6.8.4. It shall include a "3gpp-Sbi-Message-Priority" header (see clause 5.2.3.2.1) indicating the required priority level in the request and shall prioritise the requests according to the required priority level. If the client also uses the stream priority at the HTTP/2 connection level then it shall map the header value into a Weight and include it in the HEADERS of the request message. + +When the client receives a response with the "3gpp-Sbi-Message-Priority" header, it shall prioritise the received response according to the priority level received, otherwise according to the priority level of the corresponding request. This includes determining the order in which responses are handled and resources that are applied to the handling of the responses. + +## 6.8.6 HTTP/2 server behaviour + +The server should use the "3gpp-Sbi-Message-Priority" header (see clause 5.2.3.2.1) to determine how to handle the request. This includes determining the order in which requests are handled and resources that are applied to the handling of the request. + +Servers should use "3gpp-Sbi-Message-Priority" value when making overload throttling decisions. + +Servers should not use stream priority information when making overload throttling decisions at the connection level. + +When the priority of the response message needs to have a different value than the request, a server shall include a "3gpp-Sbi-Message-Priority" header in the response message which value is set to the response required priority level. + +A server should not set the stream priority as described in IETF RFC 9113 [7], via priority information in the HEADERS frame or in a PRIORITY frame. + +## 6.8.7 HTTP/2 proxy behaviour + +A proxy should forward request and response without removing the "3gpp-Sbi-Message-Priority" header or changing its value. + +While done only in exceptional circumstances, a proxy may modify priority information when relaying request and response by changing the "3gpp-Sbi-Message-Priority" value. For example, a SEPP may modify the priority set by a roaming partner. + +Proxies should use the request priority information (respectively response priority information) according to the "3gpp-Sbi-Message-Priority" value when making overload throttling decisions to a request (respectively a response). + +Proxies may use the priority information according to the "3gpp-Sbi-Message-Priority" value when relaying a request or a response messages. This includes the selection of routes (only for the requests) and the ordering of messages relayed. + +## 6.8.8 DSCP marking of messages + +A client, proxy or server may prioritize traffic at IP level by placing messages into different traffic classes and marking them with an appropriate Differentiated Services Code Point (DSCP). + +Multiple HTTP/2 connections between two HTTP/2 end points are necessary: one per DSCP value. All messages sent over a connection are assigned the same traffic class and receive the same DSCP marking. The "3gpp-Sbi-Message-Priority" value shall be considered in the selection of the appropriate connection to send the message. + +# 6.9 Discovering the supported communication options + +## 6.9.1 General + +The OPTIONS method, as described in clause 9.3.7 of IETF RFC 9110 [11], may be used by a NF Service Consumer to determine the communication options supported by a NF Service Producer for a target resource. + +Clause 6.9.2.1 describes example communication options that may be discovered using the OPTIONS method. + +The Accept-Encoding header, as described in clause 12.5.3 of IETF RFC 9110 [11], may be used by a NF Service Producer to determine the communication options supported by a NF Service Consumer. + +Clause 6.9.2.2 describes example communication options that may be discovered using the Accept-Encoding header. + +## 6.9.2 Discoverable communication options + +### 6.9.2.1 Content-encodings supported in HTTP requests + +Certain service operations may result in large HTTP request contents, e.g. to register NF profiles in the NRF (see 3GPP TS 29.510 [8]) or to update the NSSF with the available S-NSSAIs supported by Tracking Areas (see 3GPP TS 29.531 [32]). Gzip coding (see IETF RFC 1952 [34]) may be supported to optimally reduce the content size of HTTP requests in this case. + +A NF Service Consumer may determine the content-encodings supported by the NF Service Producer in HTTP requests targeting a particular resource by: + +- sending an HTTP OPTIONS request targeting the resource of the NF Service Producer; and/or +- receiving an "Accept-Encoding" header in HTTP responses from the NF Service Producer for requests targeting the resource. + +A NF Service Producer that receives an HTTP OPTIONS request for a target resource shall include an "Accept-Encoding" header in the HTTP 200 OK response (see IETF RFC 9110 [11]), if specific content-encodings, e.g. Gzip coding (e.g. see IETF RFC 1952 [34]) are supported in HTTP requests targeting the resource. + +A NF Service Producer that receives an HTTP request with a content-encoding that it does not support shall reject the request with the status code "415 Unsupported Media Type" and include an "Accept-Encoding" header in the response indicating the supported encodings in HTTP requests, as described in clause 12.5.3 of IETF RFC 9110 [11]. + +A NF Service Producer may include an "Accept-Encoding" header in the HTTP 2xx response for requests other than HTTP OPTIONS if specific content-encodings, e.g. Gzip coding (e.g. see IETF RFC 1952 [34]), are supported in HTTP requests targeting the resource, to optimize future interactions, e.g. when the request content was big enough to justify use of a compression coding but the client did not do so. + +For notification requests, a NF Service Producer may determine the content-encodings supported by the NF Service Consumer from the 3gpp-Sbi-Notif-Accepted-Encoding HTTP header, defined in clause 5.2.3.3.6, included in the received subscription request. + +### 6.9.2.2 Content-encodings supported in HTTP responses + +Certain service operations may result in large HTTP response contents, e.g. to send NF profiles by the NRF (see 3GPP TS 29.510 [8]) or to send the available S-NSSAIs supported by Tracking Areas by the NSSF (see 3GPP TS 29.531 [32]). Gzip coding (see IETF RFC 1952 [34]) may be supported to optimally reduce the content size of HTTP responses in this case (see "Content-Encoding" header in Table 5.2.2.2-2). + +A NF Service Consumer may include an "Accept-Encoding" header in HTTP requests to indicate the content-encodings, e.g. Gzip coding (e.g. see IETF RFC 1952 [34]), that are supported for the associated HTTP responses, as specified in Table 5.2.2.2-1 and in clause 12.5.3 of IETF RFC 9110 [11]. + +A NF Service Producer may determine the content-encodings supported by the NF Service Consumer in HTTP responses by receiving an "Accept-Encoding" header in the associated HTTP requests from the NF Service Consumer. + +## 6.10 Support of Indirect Communication + +### 6.10.1 General + +NF Service Consumers and NF Service Producers may support or be configured to use Indirect Communication models via SCP as specified in clauses 6.3 and 7.1 of 3GPP TS 23.501 [3]. This clause defines specific requirements to support Indirect Communication models. + +An SCP may be known to the NF (e.g. SCP based on independent deployment units) or not (e.g. SCP based on service mesh, with co-located NF and SCP within the same deployment unit). If the SCP is known to the NF, the NF shall be configured with a scheme, authority, and optionally a deployment-specific prefix of the SCP. The scheme may be "http" or "https". If the scheme is "https" then the authority shall contain an FQDN and not a literal IP address. If the scheme is "http" then the authority shall contain either an FQDN or a literal IP address. In either case, the authority may optionally + +contain a port number. If the SCP is known to the NF, but the NF is not configured with a deployment-specific prefix of the SCP, the NF shall consider the deployment-specific prefix of the SCP to be empty. If the SCP is unknown to the NF, the NF may still be configured to use delegated discovery through the unknown SCP as detailed in Clause 6.10.2A. + +NOTE: See Annex G of 3GPP TS 23.501 [3] for SCP deployment examples. + +Indirect Communication models shall support the same level of security as Direct Communication ones. Security requirements for Indirect Communications are specified in clauses 5.9.2.4 and 13.3 of 3GPP TS 33.501 [17]. TLS shall be used between the SCP and NFs, if network security is not provided by other means. When co-located, the NF and associated SCP may interact using HTTP. Clause 6.7.5 specifies how to support the client credentials assertion and authentication procedure specified in clause 13.3.8 of 3GPP TS 33.501 [17]. + +More than one SCP may be present in the communication path between an NF Service Consumer and an NF Service Producer. Clauses 6.2.19 and 6.3.16 of 3GPP TS 23.501 [3] describe how to route messages through SCPs. + +## 6.10.2 Routing Mechanisms with SCP Known to the NF + +### 6.10.2.1 General + +The routing mechanisms specified in clause 6.1 shall apply for Indirect Communication models with the additions or modifications specified in this clause. This routing mechanism shall be used when TLS is used between the NF and the SCP, or between two SCPs. This routing mechanism may also be used when TLS is not used, i.e. when network security is provided by other means. + +### 6.10.2.2 HTTP/2 connection management + +Separate HTTP(S) connections shall be set up between the HTTP client and the SCP, between SCPs (if there is more than one SCP in the communication path between the HTTP client and the HTTP server), and between the SCP and the HTTP server. HTTP CONNECT requests shall not be used for Indirect Communication models. + +The NFs and the SCP shall manage the HTTP/2 connections as defined in clause 5.2.6. + +### 6.10.2.3 Connecting inbound + +If the request is not satisfied by a local cache, the NF (acting as an HTTP/2 client) shall connect inbound by establishing (or reusing) a connection to an available SCP as defined in clause 7.3.2 of IETF RFC 9110 [11] when sending HTTP/2 request. + +When forwarding a request to another SCP, an SCP shall connect inbound by establishing (or reusing) a connection to the next hop SCP. + +When the SCP forwards the request to the HTTP server, the SCP (acting as an HTTP/2 client) shall connect inbound to an authority server for the target resource. For connecting inbound to an authority not in the same PLMN, the SCP shall connect to the Security Edge Protection Proxy. + +### 6.10.2.4 Pseudo-header setting + +For Indirect Communications with or without delegated discovery, when sending a request to the SCP, the HTTP client shall set the pseudo-headers as follows: + +- ":scheme" set to "http" or "https"; +- ":authority" set to the FQDN or IP address of the SCP (if the scheme is "http"), or to the FQDN of the SCP (if the scheme is "https"); +- ":path" including the optional deployment-specific string of the SCP and the path and query components of the target URI excluding the optional deployment-specific string of the target URI. + +An HTTP client which has not received information whether the callback URI contains any deployment specific string or not shall behave assuming that there is no deployment specific string in the callback (i.e. target) URI. If the HTTP client has previously received the prefix of the callback URI it shall include it, if available, in the 3gpp-Sbi-Target-apiRoot header (see clause 6.10.2.5). + +When an HTTP client sending a notification request corresponding to default notification subscription where the target URI is unknown (e.g. for Indirect Communication with Delegated Discovery, as specified in clause 6.10.3.3), it shall include the optional deployment-specific string of the SCP and the pseudo target URI for default subscription ("/scp-default-sub-notify-uri") in the ":path". + +Additionally, for HTTP requests for which an HTTP client may cache responses (e.g. GET request), the HTTP client should include the cache key (ck) query parameter set to an implementation specific value that is bound to the target NF (see clause 6.10.2.6). + +The HTTP client shall include the apiRoot of an authority server for the target resource (including the optional deployment-specific string of the target URI), if available, in the 3gpp-Sbi-Target-apiRoot header (see clause 6.10. 2.5). + +When forwarding a request to another SCP, an SCP shall replace the apiRoot of the SCP received in the request URI of the incoming request by the apiRoot of the next hop SCP. The SCP shall include a 3gpp-Sbi-Target-apiRoot header set to the apiRoot of an authority server for the target resource (including the optional deployment-specific string of the target URI), if available, e.g. if the 3gpp-Sbi-Target-apiRoot header was received in the request. The SCP shall set the pseudo-headers as specified in clause 6.1, with the following additions: + +- the SCP shall modify the ":authority" HTTP/2 pseudo-header field to the FQDN or IP address of the next hop SCP (if the scheme is "http"), or to the FQDN of the SCP (if the scheme is "https"). +- the SCP shall remove any optional deployment-specific string of the SCP in the ":path" HTTP/2 pseudo-header and add any optional deployment-specific string of the next hop SCP; +- the SCP shall remove the cache key query parameter, if this parameter was received in the request; +- if the pseudo target URI for default subscription ("/scp-default-sub-notify-uri") is present in the ":path", the SCP shall replace it with the real path of the target URI registered in the selected default subscription. + +When forwarding a request to the HTTP server, the SCP shall replace the apiRoot of the SCP received in the request URI of the incoming request by the apiRoot of the target NF service instance. If the 3gpp-Sbi-Target-apiRoot header was received in the request, the SCP shall use it as the apiRoot of the target NF service instance, if the SCP does not (re)select a different HTTP server, and regardless shall remove it from the forwarded request. The SCP shall set the pseudo-headers as specified in clause 6.1, with the following additions: + +- the SCP shall modify the ":authority" HTTP/2 pseudo-header field to the FQDN or IP address of the target NF service instance (if the scheme is "http"), or to the FQDN of the target NF service instance (if the scheme is "https"). +- the SCP shall remove any optional deployment-specific string of the SCP in the ":path" HTTP/2 pseudo-header and add any optional deployment-specific string of the target URI; +- the SCP shall remove the cache key query parameter, if this parameter was received in the request; +- if the pseudo target URI for default subscription ("/scp-default-sub-notify-uri") is present in the ":path", the SCP shall replace it with the real path of the target URI registered in the selected default subscription. + +EXAMPLE 1: For indirect communication without delegated discovery, if the NF Service Consumer needs to send the request "GET https://example.com/a/b/c/nudm-sdm/v1/{supi}/nssai" to the NF Service Producer (represented by the FQDN "example.com" and where "/a/b/c" is the "apiPrefix" of the NF service producer figured out from NRF discovery): + +- the NF service consumer shall send the request "GET https://scp.com/1/2/3/nudm-sdm/v1/{supi}/nssai" to the SCP (where "/1/2/3" is the "apiPrefix" of the SCP), with the "3gpp-sbi-target-apiRoot" header set to "https://example.com/a/b/c". +- the SCP shall send the request "GET https://example.com/a/b/c/nudm-sdm/v1/{supi}/nssai" to the NF Service Producer, without any "3gpp-sbi-target-apiRoot" header. + +EXAMPLE 2: For indirect communication, if the NF Service Producer needs to send a notification request "POST https://example.com/a/b/c/notification" to the NF Service Consumer (represented by the FQDN "example.com", i.e. the host part of the callback URI): + +- the NF service producer shall send the request "POST https://scp.com/1/2/3/a/b/c/notification" to the SCP (where "1/2/3" is the "apiPrefix" of the SCP), with the "3gpp-sbi-target-apiRoot" header set to "https://example.com". +- the SCP shall send the request "POST https://example.com/a/b/c/notification" to the NF Service Consumer, without any "3gpp-sbi-target-apiRoot" header. + +EXAMPLE 3: For indirect communication with Delegated Discovery, if the NF Service Producer needs to send a notification request to a default subscription and SCP selects a target default notification subscription (with callback URI "https://example.com/a/b/c/notification" registered): + +- the NF service producer shall send the request "POST https://scp.com/1/2/3/scp-default-sub-notify-uri" to the SCP (where "1/2/3" is the "apiPrefix" of the SCP). +- the SCP shall send the request "POST https://example.com/a/b/c/notification" to the selected NF Service Consumer. + +EXAMPLE 4: For indirect communication, if the NF Service Producer needs to send a notification request "POST https://example.com/prefix123/a/b/c/notification" to the NF Service Consumer with a callback URI Prefix "/prefix123": + +- the NF service producer shall send the request "POST https://scp.com/1/2/3/a/b/c/notification" to the SCP (where "1/2/3" is the Prefix of the SCP), with the "3gpp-sbi-target-apiRoot" header set to "https://example.com/prefix123". +- the SCP shall send the request "POST https://example.com/prefix123/a/b/c/notification" to the NF Service Consumer, without any "3gpp-sbi-target-apiRoot" header. + +### 6.10.2.5 3gpp-Sbi-Target-apiRoot header setting + +For Indirect Communications with or without delegated discovery, the HTTP client shall include a 3gpp-Sbi-Target-apiRoot header set to the apiRoot of an authority server for the target resource, if available, in requests it sends to the SCP. In particular: + +- for Indirect Communication without Delegated Discovery, a service request sent to the SCP to create a resource shall include a 3gpp-Sbi-Target-apiRoot header set to the apiRoot of the selected NF service instance of the NF Service Producer, if the NF Service Consumer has indeed selected a specific NF service instance; +- after a resource has been created, subsequent service requests sent to the SCP and targeting the resource shall include a 3gpp-Sbi-Target-apiRoot header set to the apiRoot received earlier in Location header of service responses from the NF Service Producer; +- notifications or callbacks sent via the SCP shall include a 3gpp-Sbi-Target-apiRoot header set to the apiRoot of the notification or callback URI (i.e. "http" or "https" scheme, the fixed string "://" and authority (host and optional port) as defined in IETF RFC 3986 [14] followed by the Callback URI prefix when available). + +An SCP shall include a 3gpp-Sbi-Target-apiRoot header set to the apiRoot of an authority server for the target resource, if available, in requests it sends to the next hop SCP. In particular: + +- if the received request does not include a 3gpp-Sbi-Target-apiRoot header containing the apiRoot of a selected NF service instance, and NF service discovery is not delegated to a next hop SCP, then the SCP shall select a target NF service instance (performing an NF service discovery with the NRF or based on local configuration (i.e. without interacting with NRF) according to the received "3gpp-Sbi-Discovery-\*" request header(s)) and insert a 3gpp-Sbi-Target-apiRoot header set to the apiRoot of the selected target NF service instance; +- if the received request includes a 3gpp-Sbi-Target-apiRoot header containing the apiRoot of a selected NF service instance, but the SCP needs to reselect a different NF service instance, the SCP shall modify and set the 3gpp-Sbi-Target-apiRoot header to the apiRoot of the newly selected target NF service instance; +- if the received request includes a 3gpp-Sbi-Target-apiRoot header containing the apiRoot of a selected NF service instance and the SCP does not reselect a different NF service instance, the SCP shall forward the received 3gpp-Sbi-Target-apiRoot header to the next hop SCP. + +When forwarding the request to the HTTP server, the SCP shall set the pseudo-headers as specified in clause 6.10.2.4. + +### 6.10.2.6 Cache key (ck) query parameter + +The cache key (ck) query parameter may be used by cache systems in the NF service consumer and/or in the SCP in order to distinguish cache objects. + +It shall be set to a string value that is linked to the apiRoot of the target NF, i.e. the same apiRoot shall always produce the same value for the content of the ck parameter. The ck parameter may contain e.g. a short compact hash value of the whole apiRoot of the target NF. + +The ck parameter shall only be used in HTTP requests between the NF service consumer and the SCP, it shall not be sent to the actual NF service producer. + +The ck parameter is not part of the actual service definition and therefore it is not documented in OpenAPI specification files. It shall comply with the following OpenAPI definition: + +``` +paths: + /: + : + parameters: + - name: ck + in: query + description: cache key parameter + schema: + type: string +``` + +## 6.10.2A Routing Mechanism with SCP Unknown to the NF + +### 6.10.2A.1 Connecting inbound + +When indirect communication models are used and a NF sends an HTTP/2 request, this NF (acting as an HTTP/2 client) shall connect directly to an authority for the target resource via an available SCP, which then acts as an "interception proxy" as defined in clause 2.5 of IETF RFC 3040 [36] and also referred to in clause 3.7 of IETF RFC 9110 [11]. This routing mechanism is incompatible with and shall not be used when TLS is used between the NF and the SCP. + +### 6.10.2A.2 HTTP/2 connection management + +The NF shall manage the HTTP/2 connections as defined in clause 5.2.6. + +### 6.10.2A.3 Pseudo-header setting + +The NF service consumer shall set the following pseudo-headers: + +- ":scheme" pseudo-header shall be set to "http"; + +NOTE: When the SCP is implemented using service mesh technologies (e.g. as described in Annex G.2 in 3GPP TS 23.501 [3]), the SCP needs to be able to read the start line and the header fields of HTTP/2 messages, and https cannot be used by NFs. In this case, mutual authentication and TLS between a NF and its associated SCP can be implicit by physical security; mutual authentication and TLS is then set up between SCP interfaces. + +- ":authority" pseudo-header shall be set as follows: + - if delegated discovery is used and has not yet been performed by the SCP, or if the NF Service Consumer only selects a target NF (service) set when in Indirect Communication without delegated discovery: set based on local configuration. + - if delegated discovery is not used or has already been performed by the SCP: set as specified in clause 6.1.4. +- ":path" pseudo-header shall include the path and query components of the target URI as specified in clause 6.1.4. + +## 6.10.3 NF Discovery and Selection for indirect communication with Delegated Discovery + +### 6.10.3.1 General + +This clause specifies the requirements that shall apply when the discovery and associated selection of NF instances or NF service instances is delegated to an SCP (see clause 6.3 and Model D in Annex E of 3GPP TS 23.501 [3]). + +### 6.10.3.2 Conveyance of NF Discovery Factors + +When the NF service consumer is configured to use delegated service discovery, it shall include in the HTTP/2 request message the necessary NF service discovery factors to be used by the SCP to perform the NF service discovery procedures and the Service access authorization procedures (see clause 13.4.1.3.2 of 3GPP TS 33.501 [17]) on behalf of the NF service consumer. The latter shall convey these NF service discovery factors using the "3gpp-Sbi-Discovery-\*" request headers. How to set the values of these "3gpp-Sbi-Discovery-\*" request headers is detailed in clause 5.2.3.2.7. The NF service consumer should also include at least the target NF type and service name in the corresponding "3gpp-Sbi-Discovery-\*" request header(s) in its request to the SCP. The NF service consumer may indicate the NRF to use, e.g. as a result of an NSSF query, by including the 3gpp-Sbi-Nrf-Uri header with the NRF API URIs. + +If the NF service consumer delegates the reselection of a target NF service instance to the SCP (see clause 6.5 of 3GPP TS 23.527 [38]), the NF service consumer shall also include "3gpp-Sbi-Discovery-\*" headers in an HTTP/2 request targeting an existing resource context in the NF service producer, if the "3gpp-Sbi-Routing-Binding" header is not included in the HTTP/2 request message (e.g. when no binding information was received from the NF service producer during the resource creation, or if the NF service consumer does not support the binding procedures), to enable the SCP to reselect an NF service producer instance, e.g. if the NF service producer instance indicated in the "3gpp-Sbi-Target-apiRoot" header or target URI is not reachable. Additionally, regardless of whether a 3gpp-Sbi-Routing-Binding" header is included or not in the HTTP/2 request message, the NF service consumer should include at least the target NF type and the service name in the corresponding "3gpp-Sbi-Discovery-\*" request header(s) in its request to the SCP. + +NOTE 1: Other 3gpp-Sbi-Discovery-\*" request header(s) can also be included in any service request sent to an SCP, regardless of whether the 3gpp-Sbi-Routing-Binding" header is included or not in the HTTP/2 request message, to convey requester's information necessary for the NRF to validate whether the requester is allowed to discover and access a given NF (see NOTE 12 of Table 6.2.3.2.3.1-1 of 3GPP TS 29.510 [8]). + +NOTE 2: A request including a 3gpp-Sbi-Routing-Binding header needs not include the requested S-NSSAI in the corresponding 3gpp-Sbi-Discovery-\*" request header, since if the NF service producer supports different sets of NF service instances serving different network slices, the NF Service Set ID in the binding indication is available for reselecting an NF service instance (see clauses 5.2.3.2.5 and 6.12.1). + +If the NF service consumer includes more than one service name in the 3gpp-Sbi-Discovery-service-names header, the service name corresponding to the service request shall be listed as the first service name in the header. + +NOTE 3: The SCP can assume that the service request corresponds to the first service name in the header. + +An NF service consumer should also include "3gpp-Sbi-Discovery-\*" headers in an HTTP/2 request targeting an existing resource context in the NF service producer to enable the SCP to perform the Service access authorization procedures (see clause 13.4.1.3.2 of 3GPP TS 33.501 [17]). + +Likewise, an NF service producer may also include 3gpp-Sbi-Discovery-\*" headers in a notification or callback request, if the "3gpp-Sbi-Routing-Binding" header is not included in the HTTP/2 request message, to enable the SCP to reselect a different NF service consumer instance, e.g. if the NF service consumer instance indicated in the "3gpp-Sbi-Target-apiRoot" header or target URI is not reachable. Additionally, regardless of whether a 3gpp-Sbi-Routing-Binding header is included or not in the HTTP/2 request message, the NF service producer should include at least the target NF type (i.e. the type of the NF service consumer) in the corresponding "3gpp-Sbi-Discovery-\*" request header(s) in its request to the SCP, if available. See clause 6.6 of 3GPP TS 23.527 [38]. + +When the 3gpp-Sbi-Selection-Info header is included in a HTTP request message and if the SCP supports this header, the SCP shall use it together with 3gpp-Sbi-Routing-Binding or 3gpp-Sbi-Discovery-\* heads whichever available. + +Based on SCP configuration, an SCP deciding to address a next-hop SCP for a service request may delegate the NF instance and/or service instance discovery and selection to subsequent SCPs, in which case it shall forward the "3gpp-Sbi-Discovery-\*" request headers to the next-hop SCP. + +When receiving a request containing "3gpp-Sbi-Discovery-\*" request headers and a selection/reselection of the target NF service instance is required, the SCP shall take into account all the NF service discovery factors contained in the "3gpp-Sbi-Discovery-\*" request headers to perform the selection or reselection. The SCP should use the NRF indicated in the 3gpp-Sbi-Nrf-Uri header if this header is present in the request. It is also possible for the SCP to be internally configured to fulfil these service discovery tasks without interacting with the NRF. + +If the service request contains "3gpp-Sbi-Discovery-\*" request header(s) that are not supported by the SCP, the latter should include the corresponding query parameters in the discovery request to the NRF. Based on operator policy, the SCP may alternatively reject the request and return a response with the status code "400 Bad Request" to the NF service consumer with an "INVALID\_DISCOVERY\_PARAM" error. + +If the service request does not contain the 3gpp-Sbi-Discovery-preferred-api-versions header, the SCP shall select an NF instance and/or service instance that supports the MAJOR version received in the request URI of the service request message. Otherwise, the preferred API MAJOR version included in the 3gpp-Sbi-Discovery-preferred-api-versions header shall be the same as the MAJOR version of the request URI of the service request message. The SCP shall reject the request and return a response with the status code "400 Bad Request" to the NF service consumer with an "INVALID\_API" error if no NF profile is found matching the MAJOR version; in this case, the SCP may indicate in the problem details the MAJOR API version(s) known to be supported by NF service producers for the corresponding service. + +### 6.10.3.3 Notifications corresponding to default notification subscriptions + +An NF may register default notification subscriptions in its NF profile or NF services in the NRF for notifications the NF is prepared to consume, including for each type of notification the corresponding notification endpoint (i.e. callback URI). + +NOTE: This can be used e.g. by an AMF to discover the notification endpoint of other AMFs to forward N1 or N2 messages, or by an AMF to notify location information to a GMLC, or by an UDR to notify data change or removal to an UDM. + +A NF producer may be configured with the types of notifications corresponding to default notification subscriptions it needs to generate, and send such notifications using indirect communication with delegated discovery, i.e. with an SCP discovering and selecting an NF service consumer with a corresponding default notification subscription. In this case, the NF producer shall include in the notification request: + +- the 3gpp-Sbi-Callback header including the name of the notify or callback service operation and the API major version if higher than 1, (see also clause 6.10.7); +- the 3gpp-Sbi-Discovery-notification-type header set to the type of notification being set; +- the 3gpp-Sbi-Discovery-n1-msg-class header set to the N1 Message Class of the target default subscription if notification type is "N1\_MESSAGE", or the 3gpp-Sbi-Discovery-n2-info-class header set to the N2 Information Class of the target default subscription if the notification type is "N2\_INFORMATION"; +- the 3gpp-Sbi-Discovery-target-nf-type header indicating the type of the consumer NF; and +- optionally, additional NF service discovery factors header to be used by the SCP to discover and select the consumer NF. + +The SCP shall use these 3gpp-Sbi-Discovery\* headers to select/reselect a notification endpoint. + +### 6.10.3.4 Returning the Producer's NF Instance ID and NF Group ID to the NF Service Consumer + +The following requirements shall apply when using indirect communication with delegated discovery, or indirect communication without delegated discovery when the NF service consumer only selects an NF set and delegates the selection of the NF service instance to the SCP (see clause 6.10.5.1): + +- an SCP that (re)selected the target NF service instance shall include the 3gpp-Sbi-Producer-Id header and, for indirect communication with delegated discovery, if the target NF service instance pertains to an NF Group, the 3gpp-Sbi-Target-Nf-Group-Id header, in the 2xx HTTP response it forwards towards the NF Service Consumer. + +The 3gpp-Sbi-Producer-Id header shall contain the NF Instance ID and it should contain the NF Service Instance ID and, if the NF service instance pertains to an NF set and/or an NF service set, the NF set ID and/or NF service set ID of the NF Service Producer selected by the SCP. + +The 3gpp-Sbi-Target-Nf-Group-Id shall contain the NF Group ID of the NF Service Producer selected by the SCP (see clause 6.10.3.2); if the SCP received a 4xx/5xx HTTP response including a 3gpp-Sbi-Response-Info header with "context-transferred" parameter set to value "true" from the reselected target NF service instance, which indicates the corresponding resource or context has been transferred to the reselected target NF service instance, the SCP shall also insert a 3gpp-Sbi-Producer-Id header and conditionally a 3gpp-Sbi-Target-Nf-Group-Id header in the HTTP response it forwards to the NF Service Consumer. + +If the SCP receives a service request including the 3gpp-Sbi-Retry-Info header set to "no-retries", and no successful response is received by the SCP after forwarding the request once, the SCP should include the 3gpp-Sbi-Producer-Id header, indicating the NF (service) instance ID that the SCP selected, in a 4xx/5xx HTTP response it sends towards the NF Service Consumer. + +- If the 3gpp-Sbi-Producer-Id header or the 3gpp-Sbi-Target-Nf-Group-Id header is already present in an HTTP response (e.g. in scenarios with multiple SCPs between the NF service consumer and NF service producer), the SCP shall forward the respective header unmodified in the response towards the HTTP client (without adding any new such respective header). + +NOTE 1: This allows to support deployments where not all NF Service Producers or NF Service Consumers have been upgraded to support the binding procedures. + +NOTE 2: In scenarios where the same NF Service Producer needs to be selected when creating new resources, e.g. when the AMF needs to establish a new PDU session towards the same SMF as the one selected for a previous PDU session, the NF Service Consumer can include the 3gpp-Sbi-Discovery-target-nf-instance-id header set to the NF Instance ID of the NF Service Producer in the request creating the new resource. + +NOTE 3: An SCP needs not insert a 3gpp-Sbi-Producer-Id header nor a 3gpp-Sbi-Target-Nf-Group-Id header in an HTTP response if it received a 3gpp-Sbi-Target-apiRoot header in the related HTTP request and it did not reselect a different NF Service Producer. + +NOTE 4: Inserting the NF Service Instance ID, NF Set ID and/or NF Service Set ID in the 3gpp-Sbi-Producer-Id header enables NF service consumers to perform overload control towards a specific NF producer service instance, NF set or NF service set when the NF service producer advertises overload control with a scope set to a specific NF service instance, NF set or NF service set (see clause 6.4.3). It also enables NF service consumers to reselect another NF service instance in the same NF instance, NF set or NF service set when so required (see e.g. clause 6.12.1 and clause 6.5.3 of 3GPP TS 23.527 [38]). + +NOTE 5: If the NF Service Consumer sends a service request including the 3gpp-Sbi-Retry-Info header set to "no-retries" and receives a 4xx/5xx HTTP response from the SCP including the 3gpp-Sbi-Producer-Id header, the NF Service Consumer can retransmit the request to the SCP requesting the SCP to reselect an NF service producer possibly excluding the NF (service) instance ID that was indicated in the 3gpp-Sbi-Producer-Id header, by including corresponding instructions in the 3gpp-Sbi-Selection-Info (see clause 5.2.3.3.10). + +### 6.10.3.5 Returning an Alternate CHF instance ID to the NF Service Consumer + +The CHF may include the 3gpp-Sbi-Alternate-Chf-Id header in an HTTP response towards its NF Service Consumer, containing an alternate charging server identity (i.e. secondary CHF Instance ID of a primary CHF instance, or primary CHF Instance ID of a secondary CHF instance). + +The following requirements apply when using indirect communication with delegated discovery, or indirect communication without delegated discovery when the NF service consumer only selects an NF set and delegates the selection of the NF service instance to the SCP (see clause 6.10.5.1): + +- an SCP that selected a target CHF service instance may include the 3gpp-Sbi-Alternate-Chf-Id header in the HTTP response it forwards towards the NF Service Consumer, containing either the secondary CHF Instance ID + +of the primary CHF instance selected by the SCP, or containing the primary CHF Instance ID of the secondary CHF instance selected by the SCP; + +- If the 3gpp-Sbi-Alternate-Chf-Id header is already present in an HTTP response (e.g. in scenarios with multiple SCPs between the NF service consumer and CHF service producer, or in scenarios where the header is already included by the CHF producer), the SCP shall forward the header unmodified in the response towards the HTTP client (without adding any new such header). + +NOTE 1: Subsequently, if the CHF service consumer needs to reselect the alternate CHF instance, it can send its request with the 3gpp-Sbi-Discovery-target-nf-instance-id set to the alternate CHF instance ID and with no 3gpp-Sbi-Target-apiRoot header. This leads the SCP to route the request towards the secondary CHF instance, and the SCP includes in the response the 3gpp-Sbi-Target-apiRoot header set to the apiRoot of the alternate CHF instance as specified in clause 6.10.4. + +NOTE 2: The SCP remains agnostic of applicative requirements on failure handling and retry handling. Accordingly, failure handling and retry handling is controlled by CHF's consumers. + +## 6.10.4 Authority and/or deployment-specific string in apiRoot of resource URI + +For Indirect Communications with or without delegated discovery, the SCP may select or reselect the specific NF (service) instance towards which to send a request. + +NOTE 1: For Indirect Communications without delegated discovery, the SCP selects for instance a specific (service) instance within a NF (Service) Set that was selected by the NF Service Consumer. + +Consequently, NF as HTTP client shall be capable to receive and process an authority and/or deployment-specific string in the apiRoot of the created or updated resource URI that differs from the authority and/or deployment-specific string of the apiRoot of the Request URI. + +If the NF Service Producer includes a relative URI (see IETF RFC 3986 [14]) in the "Location" header of an HTTP response creating a resource, the SCP shall resolve the URI reference using the target URI included in the HTTP POST request sent to the NF Service Producer as base URI, and return an absolute URI in the "Location" header in the HTTP response sent to the NF Service consumer, unless the SCP did not change the target URI when forwarding the HTTP POST request from the NF Service Consumer to the NF Service Producer. + +NOTE 2: The target URI can remain unchanged when forwarding an HTTP POST request from the NF Service Consumer to the NF Service Producer if indirect communication without delegated discovery and without TLS is used between the NF Service Consumer and the SCP, and the SCP uses the NF (service) instance of the NF Service Producer that is selected by the NF Service Consumer. + +If the SCP changed the target URI when forwarding the request from the HTTP client to HTTP server and no "Location" header is included in the HTTP response (e.g. subsequent service request towards a created resource), the SCP shall include a "3gpp-Sbi-Target-apiRoot" header with value set to the apiRoot of the target HTTP server when forwarding the 2xx HTTP response, or an 4xx/5xx HTTP response including a 3gpp-Sbi-Response-Info header with "context-transferred" parameter set to value "true", to the NF as HTTP client. + +NOTE 3: To avoid further reselection of HTTP server by SCP, the NF as HTTP client updates the locally stored URI (e.g. resource URI or notification callback URI) used in the request with the target apiRoot received in the HTTP response, and thus send subsequent request to the updated target URI. + +## 6.10.5 NF / NF service instance selection for Indirect Communication without Delegated Discovery + +### 6.10.5.1 General + +For Indirect Communication without Delegated Discovery, the NF Service Consumer performs the discovery procedure by querying the NRF and the selection of a NF (Service) Set or a specific NF (service) instance. The selection of the target NF service instance may hence be done either by the NF Service Consumer or the SCP (e.g. based on NF (Service) Set information received from the NF Service Consumer). + +The NF Service Consumer shall send its request to the SCP containing: + +- the 3gpp-Sbi-Target-apiRoot header set to the apiRoot of the selected NF service instance, if the SCP is known to the NF Service Consumer and if the NF Service Consumer has selected a specific NF service instance; +- the identity of the selected NF (Service) Set in the associated "3gpp-Sbi-Discovery-\*" request header(s) (see clause 6.10.3.2), if the NF Service Consumer has selected a target NF (Service) Set ID. + +If the NF Service Consumer only selected an NF (service) Set, it should also include at least the following information in its request to the SCP: + +- the target NF type, the service name, and the requested S-NSSAI in the corresponding 3gpp-Sbi-Discovery-\*" request header(s) (see clause 6.10.3.2). + +NOTE 1: This is to allow the SCP to discover and select a target NF service instance from the target NF (service) set for the corresponding service request and supporting the requested S-NSSAI, e.g. when the NF service producer supports different NF service instances serving different network slices. Likewise, other "3gpp-Sbi-Discovery-\*" request header(s), e.g. target-plmn-list, requester-plmn-list, can also be included for the same purpose. + +The NF service consumer may indicate the NRF to use, e.g. as a result of an NSSF query, by including the 3gpp-Sbi-Nrf-Uri header with the NRF API URIs. + +If the NF service consumer includes more than one service name in the 3gpp-Sbi-Discovery-service-names header, the service name corresponding to the service request shall be listed as the first service name in the header. + +NOTE 2: The SCP can assume that the service request corresponds to the first service name in the header. + +SCPs shall support Indirect Communication without Delegated Discovery, which requires support for the following: + +- discovering and selecting a target NF service instance from the target NF (service) set identified in the 3gpp-Sbi-Discovery-target-nf-set-id, 3gpp-Sbi-Discovery-target-nf-service-set-id, 3gpp-Sbi-Discovery-amf-region-id and/or 3gpp-Sbi-Discovery-amf-set-id; and +- at least the following additional discovery headers: 3gpp-Sbi-Discovery-target-nf-type, 3gpp-Sbi-Discovery-service-names, 3gpp-Sbi-Discovery-snssais, 3gpp-Sbi-Discovery-target-plmn-list, 3gpp-Sbi-Discovery-requester-plmn-list. + +NOTE 3: The SCP can derive the requester NF type from the User-Agent header. + +SCPs shall additionally support reselecting an alternative target NF service instance when a (Routing) Binding Indication is not available, as specified in clauses 6.5.3 and 6.6.3 of 3GPP TS 23.527 [38] and shall also support the 3gpp-Sbi-Discovery-target-nf-instance-id. + +NOTE 4: The inclusion of the 3gpp-Sbi-Discovery-target-nf-instance-id in an HTTP request enables the SCP to discover the profile of the target NF instance and to possibly reselect a different target NF service instance from the same NF instance or from a different NF instance in the same set, e.g. when the target NF instance is not reachable, as specified in 3GPP TS 23.527 [38]. + +If the request does not include the apiRoot of a selected NF service instance, or if the SCP needs to reselect a different NF service instance, the SCP shall select an NF service instance using the NF (Service) Set ID and any additional information (e.g. S-NSSAI, service name, target NF type) received in the corresponding "3gpp-Sbi-Discovery-\*" request header(s), if available. If the SCP is to invoke NF service discovery towards the NRF to fulfil this task, the SCP should use the NRF indicated in the 3gpp-Sbi-Nrf-Uri header, if this header is present in the request. The SCP that reselected the target NF service instance shall include the 3gpp-Sbi-Producer-Id header in the 2xx HTTP response it forwards towards the NF Service Consumer, containing the NF Instance ID and the NF Service Instance ID of the NF Service Producer selected by the SCP, as specified in clause 6.10.3.4; if the SCP received a 4xx/5xx HTTP response including a 3gpp-Sbi-Response-Info header with "context-transferred" parameter set to value "true" from the reselected target NF service instance, which indicates the corresponding resource or context has been transferred to the reselected target NF service instance, the SCP shall also insert a 3gpp-Sbi-Producer-Id header in the HTTP response it forwards to the NF Service Consumer. + +The SCP shall then route the request to the selected NF service instance of the target NF service producer. + +NOTE 5: For Indirect Communication without Delegated Discovery, the NF Service Consumer decides if it will perform the reselection or delegate the SCP to perform the reselection as specified in clause 6.5 of 3GPP TS 23.527 [38]. + +When the 3gpp-Sbi-Selection-Info header is included in a HTTP request message and if the SCP supports this header, the SCP shall use it together with 3gpp-Sbi-Routing-Binding or 3gpp-Sbi-Discovery-\* heads whichever available. + +### 6.10.5.2 Notifications corresponding to default notification subscriptions + +An NF may register default notification subscriptions in its NF profile or NF services in the NRF for notifications the NF is prepared to consume, including for each type of notification the corresponding notification endpoint (i.e. callback URI). + +NOTE: This can be used e.g. by an AMF to discover the notification endpoint of other AMFs to forward N1 or N2 messages, or by an AMF to notify location information to a GMLC, or by an UDR to notify data change or removal to an UDM. + +The following procedures may be used to support notifications corresponding to default notification subscriptions with indirect communication without delegated discovery. + +An NF producer may perform a discovery request towards the NRF (possibly through an SCP) to discover default notification subscriptions of an NF consumer, and if so, send notifications to the corresponding notification endpoints, using routing mechanisms specified in clause 6.10.2 / 6.10.2A. The NF producer shall include in the notification request: + +- the 3gpp-Sbi-Callback header including the name of the notify or callback service operation and the API major version if higher than 1, (see also clause 6.10.7); +- the 3gpp-Sbi-Target-apiRoot which is set to the notification uri, or the target URI is set to the notification uri as specified in clause 6.10.2 or 6.10.2A respectively; + +If the NF producer does not perform reselection, i.e. the reselection is to be done by SCP, the NF producer shall further include in the notification request: + +- the 3gpp-Sbi-Discovery-notification-type header set to the type of notification being set; and +- the 3gpp-Sbi-Discovery-n1-msg-class header set to the N1 Message Class of the target default subscription if notification type is "N1\_MESSAGE", or the 3gpp-Sbi-Discovery-n2-info-class header set to the N2 Information Class of the target default subscription if the notification type is "N2\_INFORMATION"; and +- the 3gpp-Sbi-Routing-Binding header for the default notification based on the Binding Indication value in the NF profile of the NF Service Consumer if available (see also clause 6.12.4); or when the 3gpp-Sbi-Routing-Binding header is not available, the 3gpp-sbi-discovery\* headers containing the NF service discovery factors header to be used by the SCP to reselect a consumer NF (to receive the notification request) and the Callback URI Prefix (if any) included in the 3gpp-Sbi-Request-Info header. + +The NF producer or SCP may perform a reselection if it cannot reach the target NF as indicated in the 3gpp-Sbi-Target-apiRoot or the target URI, and if a reselection is performed, the entity responsible for reselection (either SCP or NF producer) shall perform reselection as below: + +- the NF producer may use the Binding Information that is associated to the default notification; +- The SCP shall use, if available, the Routing Binding Indication (that is associated to the default notification) or alternatively 3gpp-Sbi-discovery\* and the 3gpp-Sbi-Request-Info headers to reselect an alternative NF Service Consumer. + +After reselection is performed, the NF producer or the SCP shall fetch the alternative notification endpoint from the corresponding default notification subscription registered by the alternative NF Service Consumer. The SCP shall use the 3gpp-Sbi-Discovery-notification-type header and additionally the 3gpp-Sbi-Discovery-n1-msg-class header (for "N1\_MESSAGE" notification type) or the 3gpp-Sbi-Discovery-n2-info-class header (for "N2\_INFORMATION" notification type) to locate the corresponding default notification subscription of the alternative NF Service Consumer. + +### 6.10.6 Feature negotiation for Indirect Communication with Delegated Discovery + +The requirements specified in clause 6.6.2 for feature negotiation shall apply with the following additions. + +With Indirect Communications with Delegated Discovery, the NF Service Consumer cannot discover the features supported by the NF Service Producer via the NRF. + +The NF Service Consumer shall include in HTTP PUT or POST requests to create a resource that requires specific features to be supported by the NF Service Producer, the 3gpp-Sbi-Discovery-required-features header set to the required features to be supported. + +The SCP shall reject the request with the HTTP status code "400 Bad Request" and the protocol error "NF\_DISCOVERY\_FAILURE" if no NF Service Producer supporting the required features can be discovered. + +## 6.10.7 Notification and callback requests sent with Indirect Communication + +Notification and callback requests that are sent using indirect communication shall include a 3gpp-Sbi-Callback header including the name of the notification or callback service operation (see Annex B) and the API major version if higher than 1. + +The SCP shall derive from the presence of this header that a service request is a notification or callback request. + +NOTE: This can be used by the SCP to apply differentiated treatments for notification and callback requests compared to other service requests, e.g. for authorization (access token is not used in notification / callback, see clause 6.7.3). + +The NF service producer should include the NRF API URI(s) for NF service consumer reselection in 3gpp-Sbi-Nrf-Uri header, if previously received from the NF service consumer in 3gpp-Sbi-Nrf-Uri-Callback header (see clause 6.5.3.2) and the NF service producer delegates the NF service consumer reselection to the SCP. + +If the Callback URI included a prefix and binding procedures are not supported, the NF service producer should include the callback URI Prefix in the 3gpp-Sbi-Request-Info header. + +**Editor's Note:** NRF API URI usage for NF service consumer reselection in inter-PLMN scenarios are FFS. + +## 6.10.8 Error Handling + +### 6.10.8.1 General + +A request from an HTTP client (i.e. a service request from an NF service consumer, or a notification request from an NF service producer) may traverse one or more SCPs and/or SEPPs and may fail at an SCP, SEPP or at the HTTP server. + +The HTTP client should be able to figure out whether the request failed at its next hop SCP or SEPP, or at the HTTP server, e.g. to be able to adapt its behaviour for the on-going request or subsequent request accordingly. For instance, the HTTP client may retry the request or send subsequent requests towards the same HTTP server via a different SCP or SEPP if an SCP or SEPP rejected a request due to insufficient resources, or towards a different HTTP server (via the same or a different SCP or SEPP) if the HTTP server rejected the request due to insufficient resources. + +NOTE: An SCP or SEPP can also retry a request towards a different SCP or SEPP, or towards a different HTTP server, instead of relaying the response back to the originator, if a next hop SCP or SEPP or if the HTTP server rejected a request e.g. due to insufficient resources. + +If the SCP or HTTP client receives an error response including the 3gpp-Sbi-Response-Info header with the "no-retry" parameter set to "true", the SCP or HTTP client shall consider that the request cannot be served anywhere and should not retry the request at the original HTTP server instance or at any other alternative HTTP server instance; the SCP shall forward the error response to the HTTP client including the 3gpp-Sbi-Response-Info header. + +When receiving an error response, the HTTP client should be able to figure out whether the SCP attempted to retransmit the request to an alternative HTTP server instance. To enable so, if the SCP attempted to retransmit the request to an alternative HTTP server instance, it shall indicate so in the error response by including the 3gpp-Sbi-Response-Info header with the "request-retransmitted" parameter set to "true" and by optionally including the list of NF instances, NF sets, NF service instances or NF service sets that it attempted. The SCP may indicate in the error response that it did not attempt to retransmit the request to an alternative HTTP server instance by including the 3gpp-Sbi-Response-Info header with the "request-retransmitted" parameter set to "false". The HTTP client may use this information to determine whether it may retransmit the request to an alternative HTTP server instance. + +If an SCP or SEPP receives an error response including the 3gpp-Sbi-Response-Info header with the "request-retransmitted" parameter set to "true" (e.g. in a scenario with two SCPs between the HTTP client and HTTP server), the SCP (if it does not reselect a target NF) or SEPP shall forward the error response with the the 3gpp-Sbi-Response-Info header unmodified towards the HTTP client; alternatively, the SCP may reselect a target NF and, if the NF reselection fails, the SCP may add the list of of NF instances, NF sets, NF service instances or NF service sets that it attempted in the 3gpp-Sbi-Response-Info header returned in the error response towards the HTTP client. + +NOTE 1: This can correspond to errors originated by the SCP or by an HTTP server. + +NOTE 2: Rel-17 onwards compliant SCPs support and can be configured (or not) to reselect a different NF service producer or consumer, e.g. when the target URI of a service request (or notification request) is not reachable, as specified in 3GPP TS 23.527 [38]. + +## 6.10.8.2 Requirements for the originator of an HTTP error response + +To enable an HTTP client to determine the originator of an HTTP error response, the originator of an error (e.g. HTTP server, SCP or SEPP) should include a Server header in the HTTP error response with the following information: + +- the type of the NF or network entity generating the error, set to the NFType value as defined in clause 6.1.6.3.3 of 3GPP TS 29.510 [8], e.g. "SCP", "SEPP", "SMF"; +- the identity of the NF or network entity generating the error, set to the FQDN of the SCP or SEPP, or to the NF Instance ID of the HTTP server. + +NOTE: The information carried in the Server header can also be useful for trouble-shooting. + +EXAMPLE 1: Error generated by an SCP: Server: SCP-scp1.operator.com + +EXAMPLE 2: Error generated by a SEPP: Server: SEPP-sepp1.operator.com + +EXAMPLE 3: Error generated by an SMF: Server: SMF-54804518-4191-46b3-955c-ac631f953ed8 + +The presence of a Server header set to the next hop SCP or SEPP or to the HTTP server in an HTTP error response shall be an indication for the HTTP client that the next hop SCP or SEPP or the HTTP server is the originator of the error. + +If neither the target NF nor alternative NFs that the SCP tries to (re)select based on the Routing Binding Indication or Discovery headers are reachable, the SCP shall return a HTTP 504 Gateway Timeout response including the "problemDetails" with the "cause" attribute set to "TARGET\_NF\_NOT\_REACHABLE" and the Server header which is set to the FQDN of the SCP. + +If the cSEPP receives the HTTP request from the NF with "encBlockIndex" included as specified in clause 5.9.3.2 of 3GPP TS 33.501 [17], the cSEPP shall return a HTTP 400 Bad Request response including the "problemDetails" with the "cause" attribute set to "MANDATORY\_IE\_INCORRECT" or "OPTIONAL\_IE\_INCORRECT" and the "invalidParams" attribute indicates the incorrect IE. The Server header which is set to the FQDN of the cSEPP shall also be returned. + +If the SCP cannot fulfill a service request due to NRF related errors, the SCP shall originate an error towards the HTTP client as follows: + +- If the NRF is not reachable, the SCP shall reject the request with a 504 Gateway Timeout including the "problemDetails" with the "cause" attribute set to "NRF\_NOT\_REACHABLE"; +- If the NRF rejected an NF discovery request with a 5xx or 429 response, the SCP shall reject the request with a 502 Bad Gateway including the "problemDetails" with the "cause" attribute set to "NF\_DISCOVERY\_ERROR"; +- If the NRF rejected an NF discovery request with a 4xx response, the SCP shall reject the request with a 4xx response including the "problemDetails" with an appropriate "cause" attribute (e.g. same response code and cause as received from the NRF). +- If the NRF returned a NF Discovery 200 OK response without any NF service producer matching the query parameters, the SCP shall reject the request with a "400 Bad Request" and the protocol error "NF\_DISCOVERY\_FAILURE" as specified in clause 6.10.6; +- see also clause 6.10.11.2 for SCP error handling requirements for errors due to NF service access authorization. + +In either case, the SCP shall include the Server header in the error response set with its own identity (i.e. SCP FQDN) as specified in this clause. + +### 6.10.8.3 Requirements for an SCP or SEPP relaying an HTTP error response + +To enable an HTTP client to determine the originator of an HTTP error response, e.g. when an HTTP server does not include a Server header in an HTTP error response, the SCP or SEPP that forwards the HTTP error response towards the HTTP client shall include a Via header in the HTTP error response with the following information: + +- the received-protocol portion of the Via header as defined in clause 7.6.3 of IETF RFC 9110 [11]; +- the type of the network entity forwarding the error, in the received-by portion formatted according to Table 5.2.2.2-2, set to the NFType value as defined in clause 6.1.6.3.3 of 3GPP TS 29.510 [8], i.e. "SCP" or "SEPP"; +- the identity of the network entity forwarding the error, in the received-by portion formatted according to Table 5.2.2.2-2, set to the FQDN of the SCP or SEPP. + +NOTE: The information carried in the Via header can also be useful for trouble-shooting. + +EXAMPLE 1: Error forwarded by an SCP: Via: HTTP/2.0 SCP-sep1.operator.com or Via: 2.0 SCP-sep1.operator.com + +EXAMPLE 2: Error forwarded by a SEPP: Via: HTTP/2.0 SEPP-sep1.operator.com or Via: 2.0 SEPP-sep1.operator.com + +The presence of a Via header set to the next hop SCP or SEPP in an HTTP error response shall be an indication for the HTTP client that the next hop SCP or SEPP is not the originator of the error. + +A SEPP shall forward unmodified HTTP status codes and application errors that it receives. + +NOTE: When PRINS in N32-f communication is used, an error might also be received from IPX with a HTTP status code identified in Table 5.2.7.1-1, along with the application errors. These errors are handled by the receiving SEPP like any errors from remote SEPP or target NF. + +## 6.10.9 HTTP redirection + +### 6.10.9.1 General + +An HTTP request sent using indirect communication may be redirected either to a different target NF service instance (from a same NF service set or NF set) or to a different SCP. + +When an HTTP server or SCP redirects an HTTP request (i.e. service request or notification/callback request) to a different target NF service instance, the URI of the target NF service instance towards which the request is redirected shall be given by the Location header field of the 307 Temporary Redirect or 308 Permanent Redirect response. When redirecting a request to a different NF instance (e.g. in a same NF set), the NF (service) instance ID of the target NF (service) instance towards which the request is redirected should be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response; it may be indicated otherwise (e.g. when redirecting a request to a different NF service instance of the same NF instance and overload control is to be performed per NF service instance). The HTTP client should then send the HTTP request towards the new target NF service instance using the same or a different SCP. Based on local policies, when appropriate (e.g. HTTP request creating a resource), the SCP may send the HTTP request towards the new target NF service instance instead of forwarding the 307/308 response to the HTTP client. + +An SCP may redirect an HTTP request towards a different SCP by sending a 307 Temporary Redirect or 308 Permanent Redirect response to the HTTP client including a RedirectResponse data structure (see 3GPP TS 29.571 [13]) with the cause attribute set to "SCP\_REDIRECTION" and with the targetScp attribute indicating the apiRoot of the SCP towards which the request is redirected. In this scenario, the 307 Temporary Redirect or 308 Permanent Redirect response shall include a Location header field where the content of the Location header field is implementation specific. The HTTP client should then send the HTTP request towards the target NF service instance using the SCP indicated in the 307 or 308 response; when doing so, the HTTP client shall ignore the information received in the Location header field if it receives a 307 Temporary Redirect or 308 Permanent Redirect response with the cause attribute set to + +"SCP\_REDIRECT" and including a Location header field, and it shall use the apiRoot included in targetScp IE as the apiRoot of the request URI to retransmit the HTTP request message via the alternative SCP. + +NOTE 1: The SCP can alternatively forward the request message to another SCP when there is a failure between the SCP and the target NF, and if the SCP knows that another SCP can reach the target NF and the 3gpp-Sbi-Max-Rsp-Time included the request message has not expired. + +NOTE 2: An SCP implementation can set the content of the Location header field e.g. to the request URI received in the service request but with the apiRoot of the SCP to which the request is redirected. + +A SEPP may redirect an HTTP request towards a different SEPP over a non-N32 interface by sending a 307 Temporary Redirect or 308 Permanent Redirect response to the HTTP client including a RedirectResponse data structure (see 3GPP TS 29.571 [13]) with the cause attribute set to "SEPP\_REDIRECT" and with the targetSepp attribute indicating the apiRoot of the SEPP towards which the request is redirected. In this scenario, the 307 Temporary Redirect or 308 Permanent Redirect response shall include a Location header field where the content of the Location header field is implementation specific. The HTTP client should then send the HTTP request towards the target NF service instance using the SEPP indicated in the 307 or 308 response; when doing so, the HTTP client shall ignore the information received in the Location header field if it receives a 307 Temporary Redirect or 308 Permanent Redirect response with the cause attribute set to "SEPP\_REDIRECT" and including a Location header field, and it shall use the apiRoot included in targetSepp IE as the apiRoot of the request URI to retransmit the HTTP request message via the alternative SEPP. + +NOTE 3: A SEPP implementation can set the content of the Location header field e.g. to the request URI received in the service request but with the apiRoot of the SEPP to which the request is redirected. + +NOTE 4: See clause 6.1.8 of 3GPP TS 29.573 [27] for the redirection of an N32 HTTP request from a SEPP to a different SEPP. + +## 6.10.10 Detection and handling of loop path when relaying message with indirect communication + +### 6.10.10.1 General + +For indirect communications, request messages may be forwarded through multiple SCPs. In case of misconfiguration or error processing on intermediate SCPs, request messages may be relayed via unexpected paths or trapped in loops. + +The following two optional solutions may be used to enable the SCPs to detect and handle dead looping when relaying request messages in the network with indirect communication. + +### 6.10.10.2 Message Forwarding Depth Control + +If Message Forwarding Depth Control is enabled, an HTTP client, or an SCP if the 3gpp-Sbi-Max-Forward-Hops header is not received in an incoming request, shall include in the request the 3gpp-Sbi-Max-Forward-Hops header with the node type "scp" indicating the maximum number of allowed intermediate SCPs to relay the message, before reaching the target HTTP server. + +When forwarding a request that includes the 3gpp-Sbi-Max-Forward-Hops header with node type "scp" to a next hop SCP, the SCP shall check whether the value of the header is zero or not, then + +- if the value of 3gpp-Sbi-Max-Forward-Hops header with node type "scp" is zero, the SCP shall reject the request with the HTTP status code "502 Bad Gateway" and the protocol error "MAX\_SCP\_HOPS\_REACHED"; +- otherwise, the SCP shall decrement the value of the 3gpp-Sbi-Max-Forward-Hops header with node type "scp" by 1 before forwarding the request. + +### 6.10.10.3 Loop Detection with Via header + +The Via header shall be inserted by HTTP proxies, SCPs and SEPPs when relaying an HTTP message (see clause 5.2.2.2). + +Upon receiving a request message, if Loop Detection through Via header is enabled, the SCP shall check the presence of itself, i.e. whether an "SCP-" with its own FQDN is included in the Via headers received. If present, + +the SCP shall reject the request with the HTTP status code "400 Bad Request" and the protocol error "MSG\_LOOP\_DETECTED". + +NOTE: If topology hiding is applied within the network, entities in Via header may be replaced at domain borders. + +## 6.10.11 Authorization of NF service access + +### 6.10.11.1 General + +Service access authorization for indirect communication shall be supported as specified in clause 13.4.1.3 of 3GPP TS 33.501 [17]. + +### 6.10.11.2 Authorization for indirect communication with delegated discovery + +#### 6.10.11.2.1 General + +When the NF service consumer is configured to use delegated service discovery, requirements in clause 13.4.1.3.2 of 3GPP TS 33.501 [17] shall apply with the following additions. + +If the NF service consumer received an access token in a previous service response that is valid for the new service request, the NF service consumer should include the access token in the Authorization header in the service request. An access token received in a previous service response is valid for the new service request if: + +- it has a matching scope, or it has a matching service-level scope only (i.e. the new service request also requires a resource/operation-level scope that is not present in the scope of the access token received in the previous service response); +- it has a matching audience (i.e. matching producer's NF type or NF instance ID); +- it has a matching producer's NF set ID, S-NSSAI, NSI and PLMN ID, if the access token contains a producer NF set ID, S-NSSAI, NSI and PLMN ID respectively; and +- the access token has not expired. + +NOTE 1: If the NF service consumer has multiple cached access tokens that are valid for a service request, it is left for implementation how to select the access token to include in the request. Access tokens with a matching scope, if any, are to be used in preference to access tokens with a matching service-level scope only. + +NOTE 2: Including an access token that has a matching service-level scope only but not a matching resource/operation-level scope enables the reuse of the access token when the NF service producer is not configured to require the resource/operation-level scope. + +If the NF service consumer does not include an access token in the service request, or if it does but the access token has a matching service-level scope only but not a matching resource/operation-level scope, or if it does but the access token is NF instance specific and reselection of a different producer instance may apply at the SCP (e.g. a routing binding header or a discovery header provides the producer's NF set ID), the NF service consumer shall include in the service request: + +- the necessary NF service discovery factors to be used by the SCP for the Service access authorization procedures, as specified in clause 6.10.3.2; and +- the 3gpp-Sbi-Access-Scope header indicating the access scope of the service request for access authorization, as defined for the specific resource/operation in the corresponding API (see clause 5.2.3.2.16). + +In service requests including the 3gpp-Sbi-Access-Scope header, the NF service consumer may also include the 3gpp-Sbi-Other-Access-Scopes header indicating other access scopes that are desired to be obtained for the access token, in addition to the scopes indicated in the 3gpp-Sbi-Access-Scope, that are not required for the service request itself but that may be required for further service requests, when requesting an access token to the NRF. + +NOTE 3: Indicating other access scopes in the service request can allow obtaining an access token that can be reused in subsequent service requests requiring different scopes than those required for the current service request. + +The NF service consumer may also include its Client Credentials Assertion as specified in clause 6.7.5. + +The SCP should use the access scope information received in the 3gpp-Sbi-Access-Scope header to determine the access scope required for access authorization for an incoming service request. The SCP may also use the scopes required by the NF service producer (as registered in its NF profile) for this determination and, if a new access token is required, request an access token to the NRF for a list of scopes that is the intersection of the scopes indicated in the 3gpp-Sbi-Access-Scope header and the scopes expected by the NF Service producer. If the 3gpp-Sbi-Other-Access-Scopes header is received in the incoming service request, the SCP may also include the other access scopes received in this header to the scopes requested to the NRF for the access token. + +If the NF service consumer has included an access token in the service request without including the 3gpp-Sbi-Access-Scope header, or if the SCP has a cached granted access token that matches the service request, the SCP should reuse the available access token. If the NF service consumer has included an access token in the service request and the 3gpp-Sbi-Access-Scope header, the 3gpp-Sbi-Access-Scope header contains multiple scopes, and the access token has a matching scope only for a subset of the scopes present in the 3gpp-Sbi-Access-Scope header, the SCP should consider that the access token has a valid scope for the service request if the NF service producer does not require any scope not granted in the Access Token (as determined from its NF profile); otherwise, the SCP shall request a new access token for the service request. + +NOTE 4: This allows the SCP to consider that an access token has a valid scope if the 3gpp-Sbi-Access-Scope header contains a service-level scope and a resource/operation-level scope, the access token has a scope matching only the service-level scope, and the NF service producer is not configured to require the resource/operation-specific scope. + +When the NRF receives a request to obtain an access token for a list of scopes, but the NF service producer's profile does not allow to grant a token for all the requested scopes, the NRF should grant an access token but restricted to the allowed scope, unless the request cannot be authorized for other reasons. + +NOTE 5: This allows the NRF to grant an access token for a service-level scope, in response to an access token request for a list of scopes including a service-level scope and a resource/operation-level scope, when the NF service producer's profile is not configured to require the resource/operation-level scope. + +A failure to obtain an access scope received in the 3gpp-Sbi-Other-Access-Scopes header in the granted token shall not result in the SCP failing the service request, as long as all the scopes required for access authorization for the incoming service request have been authorized by the NRF. + +When the SCP requests an access token for a service request, the SCP may include the access token it has obtained from the NRF in the service response it forwards to the NF service consumer, by including the 3gpp-Sbi-Access-Token header, for possible re-use in subsequent service requests by the NF service consumer. The NF service consumer should store the access token received in a service response and use it in subsequent service requests as defined above. + +#### 6.10.11.2.2 Error handling when the SCP fails to obtain an access token + +If the SCP cannot issue an Access Token Request towards the NRF due to missing information in the incoming service request, e.g. if the 3gpp-Sbi-Discovery-requester-nf-instance header is missing, the SCP shall reject the service request with a 400 Bad Request response including a ProblemDetails IE with: + +- the cause attribute set to MISSING\_ACCESS\_TOKEN\_INFO; +- the invalidParams attribute indicating the missing parameters (e.g. missing discovery header). + +If the SCP can issue an Access Token Request towards the NRF, but the NRF rejects the request (e.g. because the validation of the Client Credentials Assertion fails at the NRF or because the NF service consumer is not authorized to access the requested service), the SCP shall reject the service request towards the NF service consumer with a 403 Forbidden response including a ProblemDetails IE with the cause attribute set to ACCESS\_TOKEN\_DENIED. The ProblemDetails IE should also contain: + +- the accessTokenError attribute set to the accessTokenErr content received from the NRF; + +and it may contain: + +- the accessTokenRequest attribute set to the Access Token Request content sent to the NRF; +- the nrfId attribute set to the FQDN of the NRF that rejected the access token request. + +In either case, the SCP shall include the Server header in the error response set with its own identity (i.e. SCP FQDN) as specified in clause 6.10.8.2. + +#### 6.10.11.2.2A Error handling when the SCP obtains an access token without all the scopes required for access authorization of the incoming service request + +If the SCP issues an Access Token Request towards the NRF and the NRF returns an access token not granting authorization for all the scopes required for access authorization of the incoming service request, the SCP shall reject the service request towards the NF service consumer with a 403 Forbidden response including a ProblemDetails IE with the cause attribute set to ACCESS\_TOKEN\_DENIED. The ProblemDetails IE may contain: + +- the accessTokenRequest attribute set to the Access Token Request payload sent to the NRF; +- the nrfId attribute set to the FQDN of the NRF that rejected the access token request. + +The SCP shall include the Server header in the error response set with its own identity (i.e. SCP FQDN) as specified in clause 6.10.8.2. + +The SCP may include the access token it has obtained from the NRF (e.g. granting authorization for the other access scopes indicated in the service request) in the service response to the NF service consumer, by including the 3gpp-Sbi-Access-Token header, for possible re-use in subsequent service requests by the NF service consumer. The NF service consumer should store the access token received in a service response and use it in subsequent service requests as defined above. + +NOTE 1: This error scenario can happen e.g. when the incoming service request includes a first service name in the 3gpp-Sbi-Access-Token header, a second service name in 3gpp-Sbi-Other-Access-Scopes header, and the NRF grants an access token with a scope of the second service name only. + +NOTE 2: The SCP does not reject the service request (i.e. it is not an error) if the 3gpp-Sbi-Access-Scope header contains a service-level scope and a resource/operation-level scope, the access token granted by the NRF has a scope matching only the service-level scope and the NF service producer is not configured to require the resource/operation-specific scope. See NOTE 3 of clause 6.10.11.2.1. + +#### 6.10.11.2.3 Error handling when SCP receives a "401 Unauthorized" response or a "403 Forbidden" response with a "WWW-Authenticate" header + +If the NF service producer rejects the service request with a "401 Unauthorized" response or with a "403 Forbidden" response with a "WWW-Authenticate" header containing "Bearer" as the scheme for challenge: + +- if the SCP had included an access token received from the NF service consumer in the service request to the NF service producer, the SCP shall forward the response to the NF service consumer; the NF service consumer shall then delete the corresponding access token and may repeat the request without an access token or with a different access token; +- if the SCP had included an access token it had cached or obtained from the NRF, the SCP shall not repeat the request with the access token that was used; the SCP may repeat the request with a new access token; otherwise, or if the repeated request fails, the SCP shall forward the response to the NF service consumer; +- if the SCP had not included an access token in the service request to the NF service producer, the SCP should request an access token to the NRF and repeat the request; otherwise, the SCP shall forward the response to the NF service consumer. + +#### 6.10.11.3 Authorization for indirect communication without delegated discovery + +Requirements in clause 13.4.1.3.1 of 3GPP TS 33.501 [17] shall apply with the following additions. + +If selection or reselection of a producer's NF instance may apply at the SCP (e.g. initial service request containing the target NF Set ID, or service request containing a routing binding header or a discovery header with the producer's NF set ID), the NF service consumer shall include in the service request an access token that is valid for any producer's NF + +instance that the SCP may select or reselect, i.e. an access token that is not specific to a particular producer's NF instance. This shall be an access token valid for the target NF type and producer's NF set. + +## 6.11 Detection and handling of late arriving requests + +### 6.11.1 General + +The procedures specified in this clause aim at handling more efficiently requests which may arrive late at upstream entities, e.g. in networks experiencing processing or transport delays. + +These procedures are optional to support. When supported, the use of these procedures is dependent on operator policy. + +### 6.11.2 Detection and handling of requests which have timed out at the HTTP client + +#### 6.11.2.1 General + +This procedure enables an HTTP server which receives a request to know when the request times out at the HTTP client, and to stop further processing, at the receiver and further upstream NFs, a request which has timed out at the HTTP client. + +The HTTP client and HTTP server shall be NTP synchronized. This procedure may be used between NFs pertaining to the same PLMN, and if allowed by operator policy, between NFs pertaining to different PLMNs. + +#### 6.11.2.2 Principles + +An HTTP client originating a request may include in the request the 3gpp-Sbi-Sender-Timestamp and the 3gpp-Sbi-Max-Rsp-Time headers indicating respectively the absolute time at which the request is originated and the maximum time period to complete the processing of the request; both headers together indicate the absolute time at which the request times out at the HTTP client. + +When forwarding a request that includes the 3gpp-Sbi-Sender-Timestamp and the 3gpp-Sbi-Max-Rsp-Time headers, the SCP or SEPP may forward these headers unmodified; if the SCP or SEPP modifies and sets the 3gpp-Sbi-Sender-Timestamp to the time when it forwards the request, it shall adjust the 3gpp-Sbi-Max-Rsp-Time accordingly such as to properly reflect the time until which the HTTP client waits for a response. + +Upon receipt of a request which contains the 3gpp-Sbi-Sender-Timestamp and the 3gpp-Sbi-Max-Rsp-Time headers, the HTTP server should check that the request has not already timed out at the originating HTTP client. The HTTP server may perform additional similar checks during the processing of the request, e.g. upon receipt of a response from the next upstream NF service. + +Based on local configuration, the HTTP server may reject a request that is known to have timed out with the HTTP status code "504 Gateway Timeout" and the protocol error "TIMED\_OUT\_REQUEST"; it may alternatively drop the request. If so, the HTTP server should initiate the release of any resource it may have successfully created towards an upstream entity, to avoid hanging resources in the network. + +## 6.12 Binding between an NF Service Consumer and an NF Service Resource + +### 6.12.1 General + +A Binding Indication for an NF Service Resource may be provided to an NF Service Consumer of the resource as part of the Direct or Indirect Communication procedures, to be used in subsequent related service requests. This allows the NF Service Resource owner to indicate that the NF Service Consumer, for a particular resource, should be bound to an NF service instance, NF instance, NF service set or NF set. See clause 6.3.1.0 of 3GPP TS 23.501 [3] and clause 4.17.12 of 3GPP TS 23.502 [4]. + +A binding may be established or updated as part of a: + +- 1) service response creating or modifying a resource, to be used for subsequent requests targeting this resource (see clause 4.17.12.2 of 3GPP TS 23.502 [4]), for any API that defines resources; +- 2) service request, if the NF Service Consumer can also act as an NF Service Producer for later communication from the contacted NF Service Producer, to be used for subsequent service requests initiated by the contacted NF Service Producer (see clause 4.17.12.3 of 3GPP TS 23.502 [4]); +- 3) service request creating or modifying an explicit or an implicit subscription, or as part of a notification response, to be used for subsequent notification requests initiated by the NF Service Producer (see clause 4.17.12.3 of 3GPP TS 23.502 [4]); +- 4) service response creating an implicit or explicit subscription or updating a subscription, or as part of a notification request, to be used for subsequent operations on the subscription (see clause 4.17.12.4 of 3GPP TS 23.502 [4]); +- 5) service request creating a callback (other than notification) resource (e.g. V-SMF or I-SMF callback URI sent to the H-SMF or SMF), or as part of a callback response, to be used for subsequent callback requests initiated by the NF Service Producer (e.g. H-SMF or SMF initiated PDU session modification); +- 6) callback request sent from a NF Service Producer to update the binding for the resource context, to be used by the NF Service Consumer for subsequent service requests addressing the resource context. + +Two types of binding information are defined to manage the binding between an NF Service Consumer and an NF Service Resource: + +- 1) A Binding Indication conveys binding information for a resource which must be stored by the consumer (client) of that resource and used by the client to direct future requests to the resource. When contained in a service request, the binding information is associated with a resource owned by the NF Service Consumer for the current transaction. When contained in a service response, the binding information is associated with a resource owned by the NF Service Producer for the current transaction. +- 2) A Routing Binding Indication conveys binding information to direct a request from a client to a server which has the context. A Routing Binding Indication shall only be contained in an HTTP request. + +A same service request may convey more than one Binding Indication, e.g.: + +- to provide bindings for notification or callback (i.e. bullets 3 or 5) and for other services that the NF service consumer can provide later as a NF Service Producer (i.e. bullet 2); or +- to provide binding information for different event notifications, when creating a subscription on behalf of another NF (see clause 6.12.4). + +The scope parameter in a Binding Indication in a service request (or notification or callback response) identifies the applicability of (i.e. scenario associated with) the binding information. + +A service request may convey one or more Binding Indications as described above using a 3gpp-Sbi-Binding header and/or include a Binding Routing Indication to influence routing of the request e.g. to an appropriate set of NF Service Producers or to an appropriate service set of the NF Service Producer using a 3gpp-Sbi-Routing-Binding header. A service response may convey a Binding Indication for a resource using a 3gpp-Sbi-Binding header. + +NOTE 1: An HTTP request can contain for instance one 3gpp-Sbi-Binding header containing two Binding Indications for other services and for callbacks, and one 3gpp-Sbi-Routing-Binding header conveying a Routing Binding Indication. + +Once a binding indication has been received for a particular resource or scope, the absence of a binding indication for the same resource or scope in a subsequent request/response message shall be interpreted as meaning that the earlier received binding indication for that resource or scope has not changed, unless specified otherwise in the rest of the specification (see scenarios with NF service producer or consumer change further down, and clause 6.12.4 for inter-AMF mobility scenarios). + +In scenarios with NF service producer change (e.g. V-SMF or I-SMF change), the NF service consumer (e.g. AMF) shall delete any earlier binding indication received from the old NF service producer (e.g. old V-SMF/I-SMF) for the + +producer's resource (e.g. SM context resource) and replace it by any new binding indication possibly received from the new NF service producer (e.g. new V-SMF/I-SMF). + +In scenarios with NF service consumer change (e.g. inter-AMF mobility), the NF service producer (e.g. SMF) shall delete any earlier binding indication received from the old NF service consumer (e.g. binding indication for callback request received from the old AMF) and replace it by any new binding indication possibly received from the new NF service consumer (e.g. new AMF). + +If an SCP receives a Routing Binding Indication within a service or notification request and decides to forward that request to a next-hop SCP, it shall include the Routing Binding Indication in the forwarded request. The SCP shall remove the Routing Binding Indication if it forwards the request to the target NF. + +Binding Indications and Routing Binding Indications shall include the Binding level and one or more Binding entity IDs representing all NF service instances that are capable to serve service requests targeting the resource, i.e. that share the same resource contexts. + +The Binding Level indicates a preferred binding to either a NF Instance, a NF set, a NF Service Instance or a NF Service Set. + +When sending a request targeting the resource context in a NF Service Producer or the session context in a NF Service Consumer, the resource URI received in the Location header or the Notification/Callback URI shall be used first if available to set the "3gpp-Sbi-Target-apiRoot" header or target URI; as an exception, if the binding indication earlier received for the target resource context or session context indicates a binding level of "NF service set", "NF Instance" or "NF Set" and alternative NF service instances within the preferred binding entity corresponding to the binding level are available, the request may alternatively be sent to one of these alternative NF service instances. When the URI received in the Location header or the Notification/Callback URI is not reachable or when becoming aware of a NF Service Producer or Consumer change as specified in bullet 3 of clauses 6.5.3.2 and 6.5.3.3, the binding entity corresponding to the binding level shall be selected whenever possible. If this is not possible, e.g. because the preferred binding entity is not reachable, the request should be sent to any other Binding entity signalled in the Binding Indication or Routing Binding Indication, in the following decreasing order of priority: + +- select an NF service instance if available in the backup NF instance, if a backup NF service instance and/or backup NF instance was signalled in the Binding Indication or Routing Binding Indication; +- select an NF service instance in the same NF service set, if a NF service Set ID was signalled in the Binding Indication or Routing Binding Indication; +- select an equivalent NF service instance in the same NF instance, if an NF instance ID was signalled in the Binding Indication or Routing Binding Indication; +- select an NF service instance in an equivalent NF service set of the backup AMF instance, if a NF service Set ID and backup AMF Instance ID was signalled in the Binding Indication or Routing Binding Indication; +- select an equivalent NF service instance in the backup AMF instance, if backup AMF Instance ID was signalled in the Binding Indication or Routing Binding Indication; +- select an NF service instance in an equivalent NF service set of another NF instance of the NF set, if an NF Service Set ID and an NF Set ID were signalled in the Binding Indication or Routing Binding Indication; +- select an equivalent NF service instance in another NF instance of the NF Set, if an NF Set ID was signalled in the Binding Indication or Routing Binding Indication. + +NOTE 2: NF service instances from different NF instances are equivalent NF service instances if they share the same MCC, MNC, NID (for SNPN), ServiceName, API version, and, if applicable, NF Service Set ID (see clause 28.13 of 3GPP TS 23.003 [15]). + +Binding Indications shall not be used if a particular resource can only be served by a specific NF service instance of an NF instance, i.e. if NF service instances of a same NF service are not capable to share resource inside the NF Instance, unless the receiver of the Binding Indication has indicated its support of the no-redundancy indication in the Binding Indication in the SupportFeatures attribute for a specific API (see clause 5.2.3.2.6). A resource for which no Binding Indication or Routing Binding Indication is signalled shall be considered to be bound exclusively to one NF service instance, unless the NF Service resource owner instance is part of an NF set (or AMF set) or an NF service set, or unless its NF profile in the NRF indicates that its supports NF service persistence within the NF instance (see clause 6.5 of 3GPP TS 23.527 [38]). + +An NF service producer supporting different sets of NF service instances, e.g. serving different network slices, shall include the NF Service Set ID in the Binding Indication to enable the reselection (when required) of an alternative NF service instance from the same or an equivalent NF service set. See also clause 6.10.3.2 for requirements on the inclusion of "3gpp-Sbi-Discovery-\*" headers in service requests targeting an existing resource context in the NF service producer. + +A Binding Indication may be shared by multiple resource/session contexts, i.e. these resource contexts (in the NF Service Producer) or session contexts (in the NF Service Consumer) are sharing the same resilience information. The Binding Indication for multiple contexts has the same semantics as the one for a single resource/session context but with the following additions. When it is supported as indicated in the Supported Features for a specific service API: + +- both NF Service Consumer and NF Service Producer can indicate if the Binding Indication for multiple contexts; and if the Binding Indication is for multiple contexts, the "group" parameter in the Binding Indication shall be set to "true"; +- a group id may be included in the Binding Indication to indicate the group to which resource/session contexts pertain are sharing the same Binding Indication, when the resource/session context is created; +- the Binding Indication for a group of contexts may be updated towards each Resource URI with different apiRoot part (representing different peer NF (service) instances) or towards each Notification URI with different authority part, or with the same authority part but different callback-uri-prefix (see clause 5.2.3.3.7) if it is provided in 3gpp-Sbi-Consumer-Info header when the NF service consumer provides the Callback URI, e.g. when the NF is changed, by including an oldgroupid, oldnfinst, oldservset, oldservinst or uribase to address applicable contexts for the update of the Binding Indication. When the oldgroupid is present, the groupid shall also be present to indicate the new group id which is newly allocated. Additionally, the Binding Indication may be updated for a group of UE contexts by including the gumai to address applicable UE contexts for the update of the Binding Indication. + +## 6.12.2 Binding created as part of a service response + +An NF Service Producer may provide a Binding Indication in a service response by including a 3gpp-Sbi-Binding header (see clause 5.2.3.2.5) in the HTTP response with: + +- the binding level (bl) parameter indicating a preferred binding to either a NF Service Instance, a NF Service Set, a NF Instance or a NF set; +- at least one of the NF Service Instance (nfservinst), NF Service Set (nfserviceset), NF instance (nfinst) and NF Set (nfset) parameters, set to a NF Service Instance ID, NF Service Set ID, NF Instance ID and NF Set ID respectively, as described in Table 6.3.1.0-1 of 3GPP TS 23.501 [3]. + +The NF Service Consumer shall store the Binding Indication received from the NF Service Producer and include it in a 3gpp-Sbi-Routing-Binding header in subsequent related service requests targeting the NF Service Resource. The NF Service Consumer or the SCP shall use this information for selecting or reselecting an NF Service Producer which has access to the NF Service Resource context, for direct or indirect communication respectively, as specified in clause 6.3.1.0 of 3GPP TS 23.501 [3]. + +NOTE: The Binding Indication can be part of an HTTP response with or without content, e.g. in a 204 No Content. The Routing Binding Indication can be part of an HTTP request with or without content, e.g. in a DELETE request. + +## 6.12.3 Binding created as part of a service request + +As specified in clause 4.17.12.3 of 3GPP TS 23.502 [4], when an AMF, V-SMF or I-SMF as NF Service Consumer sends a service request to an SMF as NF Service Producer, or when an AMF as NF Service Consumer sends a service request to a PCF or an SMSF as NF Service Producer or when an AMF as NF Service Consumer sends a service request to an I-SMF or V-SMF, or when a SMF as NF Service Consumer sends a service request to a NEF as NF Service Producer, the NF Service Consumer may provide a Binding Indication in a service request by including a 3gpp-Sbi-Binding header (see clause 5.2.3.2.6) in an HTTP request with: + +- the binding level (bl) parameter indicating a preferred binding to either a NF Service Instance, a NF Service Set, a NF Instance or a NF set; + +- at least one of the NF Service Instance (nfservinst), NF Service Set (nfserviceset), NF instance (nfinst) and NF Set (nfset) parameters, set to a NF Service Instance ID, NF Service Set ID, NF Instance ID and NF Set ID respectively, as described in Table 6.3.1.0-1 of 3GPP TS 23.501 [3]; +- the scope parameter indicating "other-service"; +- optionally the service name parameter indicating the service(s) for which the binding information applies. If no service name is indicated in the Binding Indication, the binding information applies to any service that the NF Service Consumer can provide as an NF Service Producer. + +When receiving a service request from an NF Service Consumer with a Binding Indication with the scope set to "other-service", the V-SMF, the I-SMF, the (Home) SMF, the SMSF, the PCF or the NEF acting as the NF Service Producer shall use this binding information when sending later on service requests for the "other-service" for existing or new resource context(s) in the original NF service consumer that are related to: + +- the PDU session for which the service request is received, when the other service corresponds to an SMF service, e.g. SMF event exposure service or SMF NIDD service; or +- the UE for which the service request is received, when the other service corresponds to an AMF service, e.g. AMF event exposure service or AMF Communication Service. + +The NF Service Producer shall store the Binding Indication received from the NF Service Consumer and include it in a 3gpp-Sbi-Routing-Binding header in subsequent service requests it sends, where the NF Service Consumer acts as an NF Service Producer. The NF Service Producer (when acting as a NF service consumer) or the SCP shall use this information for selecting or reselecting an NF Service Producer which has access to the original consumer's NF Service Resource context, for direct or indirect communication respectively, as specified in clause 6.3.1.0 of 3GPP TS 23.501 [3]. + +## 6.12.4 Binding for explicit or implicit subscription requests + +A NF Service Consumer may provide a Binding Indication: + +- in a service request creating an explicit or an implicit subscription, or in a notification response, by including a 3gpp-Sbi-Binding header (see clause 5.2.3.2.6) in an HTTP request or response respectively; or +- for a default notification subscription in its NF profile in NRF (see clause 6.1.6.2.4 of 3GPP TS 29.510 [8]). + +The Binding Indication shall contain: + +- the binding level (bl) parameter indicating a preferred binding to either a NF Service Instance, a NF Service Set, a NF Instance or a NF set; +- at least one of the NF Service Instance (nfservinst), NF Service Set (nfserviceset), NF instance (nfinst) and NF Set (nfset) parameters, set to a NF Service Instance ID, NF Service Set ID, NF Instance ID and NF Set ID respectively, as described in Table 6.3.1.0-1 of 3GPP TS 23.501 [3]; +- the scope parameter indicating "subscription-events" if the binding information is applicable to subscription change event notification (see clause 4.17.12.4 of 3GPP TS 23.502 [4]); +- optionally, the scope parameter indicating "callback" if the binding information is applicable to notification and callback requests; the absence of this parameter shall also be interpreted as binding information is applicable to callback (i.e. notification) requests; +- optionally the service name parameter indicating the service that will handle the notification. +- optionally the prefix of the Callback URI. + +When binding information is applicable to notification/callback requests, corresponding notifications are bound to: + +- the NF instance or NF set (according to the binding level), if no service name was received; +- the specific service (indicated by the service name parameter) of the NF instance or NF set (according to the binding level), if a service name was received; or +- the NF service instance or NF service set (according to the binding level). + +NOTE 1: The NF Service Consumer in a NF Instance or NF Set can be identified by the NF Instance Id or NF Set Id, with or without a service name parameter, or a NF Service Instance Id (together with the NF Instance Id or the NF Service Set Id) or a NF Service Set Id, where the service can be either a standardised service or a custom service. + +NOTE 2: A notification can be sent to a service instance of any binding entity included in the Binding Indication, i.e. the binding entity may be other than the one(s) indicated by the binding level, if the latter(s) are not reachable. For instance, if the Binding Indication contains an NF Set ID, an NF Instance ID and a binding level is set to NF Instance, the notification can be sent to any NF instance of the NF set if the NF instance identified by the NF Instance ID is not reachable. See clause 6.3.1.0 of 3GPP TS 23.501 [3]. + +The NF Service Producer shall store the Binding Indication received from the NF Service Consumer and include it in a 3gpp-Sbi-Routing-Binding header in subsequent notification requests it sends to the NF Service Consumer (that acts as an HTTP server) related to this subscription. See also clause 6.10.3.2 for requirements on the inclusion of "3gpp-Sbi-Discovery-\*" headers in notification requests. For a default notification subscription, the NF Service Producer shall fetch the Binding Indication value (if available) from the NF profile of the NF Service Consumer and include it in a 3gpp-Sbi-Routing-Binding header in related notification requests. For notifications corresponding to default notification subscriptions using Indirect Communication with Delegated Discovery (see clause 6.10.3.3), when the notification is targeting a specific NF instance/NF service instance, the SCP shall fetch the Binding Indication value (if available) for the default notification subscription from the NF profile of the NF Service Consumer. The NF Service Producer or the SCP shall use this information for selecting or reselecting an NF Service Consumer (HTTP server) which has access to the original consumer's NF Service Resource context, for direct or indirect communication respectively, as specified in clause 6.3.1.0 of 3GPP TS 23.501 [3]. If the notification endpoint provided in the subscription is not reachable, the NF Service Producer or SCP shall look up for an alternative notification endpoint address at the service level (i.e. NF Service registered in NRF) if the Binding Indication contains a service name or a binding to an NF Service Instance or NF Service Set, or at the NF instance level (i.e. NF Profile registered in NRF) otherwise. The NF Service Producer or SCP shall derive the alternative notification URI (or callback URI) as described in clauses 6.5.2.2 and 6.5.3.2 and shall use that URI in subsequent notifications. + +The NF Service Consumer may provide an updated Binding Indication to the NF Service Producer in a service request modifying the subscription or in a notification response. + +The NF Service Producer may also provide a Binding Indication in a service response creating or modifying an explicit or an implicit subscription, or in a notification request generated for this subscription, by including a 3gpp-Sbi-Binding header (see clause 5.2.3.2.5) in the HTTP response, or in the HTTP request respectively (without the scope parameter), as specified in clause 6.12.2. If the service request creates a resource and a subscription, the Binding Indication returned in the HTTP response shall apply to both the NF Service Resource and the subscription, i.e. the created resource and subscription shall be bound to the same (service) set of producers or producer instance. The NF Service Consumer shall store the Binding Indication received from the NF Service Producer and include it in a 3gpp-Sbi-Routing-Binding header in subsequent related service requests as specified in clause 6.12.2. + +For a default notification subscription, a NF Service Consumer shall update the Binding Indication value in NF profile when binding information of the default notification subscription has changed. + +A subscription request may also contain a Routing Binding Indication that can be used in case of indirect communication by the SCP to route the message to the NF Service Producer. + +A service request may create an explicit subscription on behalf of another NF (e.g. UDM subscribing to an AMF event on behalf of the NEF); typically, this may happen when a "source" NF (e.g. NEF) issues a service request to an "intermediate" NF (e.g. UDM) who sends a subsequence service request to a "target" NF (e.g. AMF). The "intermediate" NF may include two Binding Indications: a first Binding Indication for subscription change event notification sent from the "target" NF to the "intermediate" NF (e.g. notifications to UDM upon AMF change) and a second Binding Indication for the event notifications sent from the "target" NF to the "source" NF (e.g. AMF notification to the NEF). + +In the former Binding Indication, the scope parameter shall be set to "subscription-events"; in the latter Binding Indication (corresponding to the event notifications to the "target" NF to the "source" NF), the scope parameter shall be set to "callback" or be absent, and the other binding parameters ("bl", "nfs", etc.) shall be taken from the original service request from the "source" to the "intermediate" NF (e.g. binding parameters in the service request from NEF to UDM). + +The "source" NF (e.g. NEF) or "intermediate" NF (e.g. UDM) may also include an "nr" (notification receiver) parameter in its Binding Indication conveying the notification URI used by the "target" NF (e.g. AMF) in subsequent event notifications. This "nr" parameter allows the "target" NF to match binding information with different types of + +notification events in scenarios in which the "intermediate" NF combines multiple subscriptions to the "target" NF, in a single subscription request. + +Upon receipt of a subscription change event notification, the "intermediate" NF may include in the notification response an (updated) Binding Indication for subscription change event notification with the scope parameter set to "subscription-events". + +Upon receipt of an event notification from the "target" NF, the "source" NF may include in the notification response an (updated) Binding Indication for event notifications sent from the "target" NF to the "source" NF with the scope parameter set to "callback" or absent. + +NOTE 3: Binding indications for subscription change event notification and for event notifications sent from the "target" NF to the "source" NF are transferred by the source AMF to the target AMF during inter-AMF mobility procedures, if the source AMF supports the binding procedures. Accordingly, the "intermediate" NF only needs to include a Binding Indication for subscription change event notification in the notification response if the Binding Indication is updated. + +NOTE 4: Upon receipt of a subscription change event notification, the "intermediate" NF needs not include a Binding Indication for event notifications sent from the "target" NF to the "source" NF. Doing so could conflict with binding updates sent by the "source" NF to the "target" NF, if the "intermediate" NF has not been updated (yet) by the "source" NF with the binding updates. + +During an inter-AMF UE mobility, if the target AMF notifies an NF service consumer of an AMF event subscription that the subscription Id has changed (see clause 5.3.2.4.1 of 3GPP TS 29.518 [31]), the NF service consumer shall delete any earlier binding indication received from the source AMF for the AMF event subscription resource and replace it by any new binding indication possibly received from the target NF in the notification request. + +## 6.12.5 Binding for service requests creating a callback resource + +A NF Service Consumer may provide a Binding Indication in a service request creating a callback (other than notification) resource (e.g. V-SMF or I-SMF callback URI sent to the H-SMF or SMF), by including a 3gpp-Sbi-Binding header (see clause 5.2.3.2.6) in an HTTP request as specified in clause 6.12.4, with the scope parameter being absent or indicating "callback". + +The NF Service Producer shall behave as specified in clause 6.12.4, with the "notification endpoint and callback URI prefix " being replaced by the callback endpoint and callback URI prefix. + +The NF Service Consumer may provide an updated Binding Indication as part of a callback response, to be used for subsequent callback requests initiated by the NF Service Producer, by including a 3gpp-Sbi-Binding header (see clause 5.2.3.2.6) in an HTTP response as specified in clause 6.12.4, with the scope parameter being absent or indicating "callback". + +## 6.13 SBI messages correlation for network troubleshooting + +### 6.13.1 General + +The procedures defined in this clause provide means for correlating 5GC internal SBI messages (request or response) with a UE identity, by network management tools or probes that are used for network performance analysis and troubleshooting. + +The procedures are optional to support. When supported, the use of these procedures is dependent on operator's policy, regulatory guidelines and security considerations. + +### 6.13.2 SBI messages correlation using UE identifier + +#### 6.13.2.1 General + +The procedure enables network analytics tools or probes, to easily identify messages that were exchanged for a given UE. When supported and configured to be used by operator's policy, an NF service consumer or NF service producer + +may include the UE identity in 3gpp-Sbi-Correlation-Info header, to identify the UE related to the HTTP request or response, as further defined in clause 6.13.2.2. + +When included in an HTTP request or response, the 3gpp-Sbi-Correlation-Info header should contain at least one UE identifier, and no more than one of each type of UE identifier (ctype). + +The NF should comply with 5GC SBI interface specific and security requirements while selecting a UE identifier to be included in the 3gpp-Sbi-Correlation-Info header. Additionally, based on operator's policy and regulatory requirements some UE identifiers may be not be allowed in the 3gpp-Sbi-Correlation-Info header for certain HTTP request or response messages. + +## 6.13.2.2 Principles + +An HTTP client originating a request may include in the request the 3gpp-Sbi-Correlation-Info header containing the UE identity that is related to the request. The HTTP client should include the SUPI in the 3gpp-Sbi-Correlation-Info header when it is available. If the SUPI is not available, the header should contain a UE identity that is known to the NF and is the most appropriate for the message context. + +Upon receipt of a request that includes the 3gpp-Sbi-Correlation-Info header, the HTTP server, if it supports this header, may include the header in the response sent to the HTTP client, with the same UE identity that was contained in the 3gpp-Sbi-Correlation-Info header of the received HTTP request. If the HTTP request creates a subscription to notifications and the HTTP server supports this header, it should store the UE identifier received in the header and should include the header containing the stored UE identifier in subsequent callback notification requests. + +The HTTP server may include the 3gpp-Sbi-Correlation-Info header in a successful response even when the header is not included in the request received from the HTTP client. + +In an HTTP error response, the HTTP server may include the same UE identifier that was received in the 3gpp-Sbi-Correlation-Info header of the HTTP request or should not include the 3gpp-Sbi-Correlation-Info header if the header was not included in the HTTP request. + +When forwarding a request or response that includes the 3gpp-Sbi-Correlation-Info header, the SCP should forward this header unmodified. For NF Discovery and (re)selection in indirect communication with or without Delegated Discovery, if the service request is received including the 3gpp-Sbi-Correlation-Info header, the SCP should include this header unmodified when it initiates a NF Discovery Request to the NRF. In indirect communication with or without Delegated Discovery, if the SCP reselects an alternative NF, the SCP should also include this header unmodified when it sends the HTTP request to the alternative NF service instance. In an inter-PLMN scenario, the SEPP may remove the header based on operator policies and regulatory requirements. + +## 6.13.3 SBI messages correlation using NF Peer Information + +### 6.13.3.1 General + +The procedure enables network elements (such as NFs, SCPs, SEPPs, network analytics tools or probes, etc.), to obtain source and destination information of messages that were exchanged between a specified pair of NF (Service) instances. An NF as HTTP client or NF as HTTP server should include the NF (Service) instance IDs in 3gpp-Sbi-NF-Peer-Info header, to identify the HTTP requests or responses between the given pair of NF (Service) instances, as further defined in clause 6.13.3.2. + +### 6.13.3.2 Principles + +An HTTP client originating a request should include in the request the 3gpp-Sbi-NF-Peer-Info header containing the Source NF (Service) instance ID and if available the Destination NF (Service) instance ID. + +Upon receipt of a request that includes the 3gpp-Sbi-NF-Peer-Info, the HTTP server should insert the header in the response sent to the HTTP client, with source and destination peer info corresponding to the destination and source peer info in the request respectively (i.e. swap the received source and destination peer info in the response). The HTTP server should include the 3gpp-Sbi-NF-Peer-Info header in a response even when the header is not included in the request received from the HTTP client. + +If the destination peer information provided by HTTP client in the request does not match the information of the HTTP server (e.g. due to the HTTP server having updated its NF (Service) instance ID), the HTTP server should include the updated NF (Service) instance ID values in the response header sent to HTTP client. + +When forwarding a request or response that includes the 3gpp-Sbi-NF-Peer-Info header, the SCP should forward this header and may update the destination peer info if the receiver NF is (re)selected; the SCP shall also update the srcscp/dstscp components, based on the source and destination SCP of the forwarded HTTP request or response, as described in clause 5.2.3.2.21; the SEPP shall also update the dstscp component (if SEPP relays the request towards an SCP). + +In an inter-PLMN scenario, the SEPP may remove the header based on operator policies. If an SCP or SEPP generates an error response to a request including this header, the SCP and SEPP should insert the header in the response with source peer info containing the information of the SCP or SEPP, and with destination peer info containing the source peer info in the request respectively. + +## 6.14 Indicating the purpose of Inter-PLMN signaling + +### 6.14.1 General + +The procedures defined in this clause provide means for two PLMNs to send/receive the purpose of inter-PLMN signaling. This can be used to help operators to avoid receiving any signaling from different operator without any relevant contract. + +SEPP shall be preconfigured to understand the relationship with other PLMNs, e.g. roaming. The means on how to configure the relationship is outside the scope of the Release. + +### 6.14.2 Inclusion of the intended purpose + +An NF Consumer or SCP in case of model D may include in the HTTP request the intended purpose of the request that is targeted to PLMN different from the source PLMN, using 3gpp-Sbi-Interplmn-Purpose as defined in clause 5.2.3.3.11. The purposes shall be selected from the values specified in 3GPP TS 29.573 [27] clause 6.1.5.3.9. In addition, the any additional information may be associated for indicating the exact purpose. + +### 6.14.3 Evaluating the intended purpose + +When the SEPP receives request from NF consumer or SCP of the same network bound to another network (in case of cSEPP), or from the peer SEPP (in case of pSEPP), the SEPP shall evaluate the intended purpose of the signaling from the following information: + +- Source PLMN; +- Target PLMN; and +- intended purpose in the received in the 3gpp-Sbi-Interplmn-Purpose header, if available + +If the SEPP (i.e. cSEPP) receives request from NF consumer or SCP of the same network bound to another network including 3gpp-Sbi-Interplmn-Purpose header, the receiving SEPP shall compare the value received in the header with the preconfigured value of allowed intended purpose between the source and target PLMN. + +If the SEPP (i.e. pSEPP) receives from the peer SEPP including 3gpp-Sbi-Interplmn-Purpose header, the receiving SEPP shall compare the value received in the header with the pre-negotiated value of allowed intended purpose between the source and target PLMN during Security Capability Negotiation procedure specified in 3GPP TS 29.573 [27]. + +The receiving SEPP shall: + +- If the purpose in the 3gpp-Sbi-Interplmn-Purpose header matches with any one of the preconfigured purposes (for cSEPP) or pre-negotiated purposes (for pSEPP) as allowed by the receiving SEPP, then the receiving SEPP shall continue processing the request. +- Else, the receiving SEPP shall reject the message with 403 Forbidden with ProblemDetails REQUESTED\_PURPOSE\_NOT\_ALLOWED as defined in Table 5.2.7.4-1. + +EXAMPLE The following example describes how cSEPP and pSEPP evaluates and process with regards to the intended purposes. + +a) cSEPP and pSEPP are configured with the allowed purpose =X, Y + +- Case 1: +NFc/SCP sends the first message to cSEPP with purpose = X. In this case, cSEPP validate the message against the configured purpose and allow it. Using the N32 connection established between cSEPP and pSEPP for purpose = X , cSEPP deliver the message to pSEPP. Then only pSEPP checks the purpose=X over N32f with the pre-negotiated purpose. +- Case 2: +NFc/SCP sends a second message to cSEPP with the purpose=Z. Here, cSEPP rejects it on its own because it is not allowed purpose for cSEPP (configured). + +b) cSEPP is configured with allowed purpose X, Y and pSEPP is configured with X, K + +- Case 3: +NFc/SCP sends a second message to cSEPP with purpose =Y. In this case, cSEPP validates the message against the configured purpose and allow it. Then cSEPP will negotiate purpose=Y with pSEPP over N32-c and the negotiation will fail. Then cSEPP rejects the message. + +If the SEPP receives request from NF consumer or SCP of the same network bound to another network (in case of cSEPP), or from the peer SEPP (in case of pSEPP) that does not include 3gpp-Sbi-Interplmn-Purpose header, the receiving SEPP shall by default consider this as roaming in order to allow backward compatibility for NF consumers not support the 3gpp-Sbi-Interplmn-Purpose header, and apply the policy accordingly. The purpose of transactions of AMFs or SMFs between two different VPLMNs, i.e. inter AMF or inter V-SMF signalling from VPLMN1 to VPLMN2 shall be considered as inter PLMN mobility. + +--- + +## Annex A (informative): Client-side Adaptive Throttling for Overload Control + +This clause contains an example algorithm to make an NF Service Consumer adjust the traffic rate sent to an NF Service Producer based on the number of received "rejects" of HTTP requests with a status code "503 Service Unavailable", or requests that have timed-out and the response was never received. This algorithm is described in the book "Betsy Beyer, et al; Google: Site Reliability Engineering" (), clause 21, "Handling Overload". + +NOTE: The reference link provided to the book can change and hence the name of the book is expected to be used for referring to the latest edition. + +Each client (NF Service Consumer) keeps track of the following counters during a certain time window: + +- Requests: The number of requests that the client (NF Service Consumer) needs to handle. Under normal operation (no overload), all these requests are sent to the server (NF Service Producer). Under an overload situation, part of these requests are locally rejected by the client (and not sent to the server), and the rest of the requests are sent to the server. +- Accepts: The number of requests accepted by the server (i.e., requests for which a response has been effectively received at the client, with a status code other than "503 Service Unavailable"). + +When there is no server overload, these values are equal. + +When there is an overload status in the server, the rate between "Accepts" and "Requests" decreases progressively. When this rate falls below a certain point (given by an algorithm parameter named "K"), the client shall start dropping some requests locally and not send them to the server. + +The local rejection of requests can be done by calculating a "Client request rejection probability", as: + +$$\max\left(0, \frac{\text{requests} - K \times \text{accepts}}{\text{requests} + 1}\right)$$ + +So, for example, assuming that the K parameter is set at 1.5: + +- if the server accepts >67% of the traffic, and rejects <33% of the traffic, the client does not take any throttling action, and keeps sending to the server all the traffic it has available for processing +- if, during a first time-window, the server accepts, e.g., only 60% of the requests, and rejects 40% due to overload, the application of this algorithm implies that the client must drop locally 10% of the requests (probabilistically), and only send to the server the remainder 90% of its traffic. +- if, during a second time-window, the client keeps the same amount of available traffic to handle, but the server continues rejecting requests with same rate as before (40%) of the received requests, the application of the algorithm again, results in increasing the drop rate to 14.5%, and sending to the server only 85.5% of the available traffic. + +The value of the parameter K, along with the size of the time window during which the total number of "requests" and "accepts" is accounted for, has a fundamental role on how the algorithm behaves. If K is higher, the algorithm is more "permissive", and the client does not start dropping requests locally until the rejection rate is higher (e.g., >50%, for K = 2); if K is lower, the algorithm is more "aggressive", and the client starts dropping requests sooner (e.g., K = 1.1 implies to start dropping requests as soon as the server rejects >10% of the requests). + +## Annex B (normative): 3gpp-Sbi-Callback Types + +This annex specifies allowed 3GPP SBI callback type values for the "3gpp-Sbi-Callback" HTTP custom header specified in clause 5.2.3.2.3. + +Table B-1 contains a non-exhaustive list of callbacks that are invoked in the 5GS. + +**Table B-1: Non-exhaustive list of values for the "3gpp-Sbi-Callback" Custom HTTP Header** + +| Value for "3gpp-Sbi-Callback" Custom HTTP Header | Reference | +|--------------------------------------------------|------------------------------------------------------------------------------------| +| "Nsmf_PDUSession_Update" | 3GPP TS 29.502 [28], Clause 5.2.2.8.3.2, 5.2.2.8.3.3, 5.2.2.8.3.4 and 5.2.2.8.3.5. | +| "Nsmf_PDUSession_StatusNotify" | 3GPP TS 29.502 [28], Clause 5.2.2.10. | +| "Nudm_SDM_Notification" | 3GPP TS 29.503 [29], Clause 6.1.5.2 | +| "Nudm_UECM_DeregistrationNotification" | 3GPP TS 29.503 [29], Clause 6.2.5.2 | +| "Nudm_UECM_PCSCFRestorationNotification" | 3GPP TS 29.503 [29], Clause 6.2.5.3 | +| "Nnrf_NFManagement_NFStatusNotify" | 3GPP TS 29.510 [8], Clause 6.1.5.2. | +| "Namf_EventExposure_Notify" | 3GPP TS 29.518 [31], Clause 6.2.5.2. | +| "Npcf_UEPolicyControl_UpdateNotify" | 3GPP TS 29.525 [35], Clauses 4.2.4, 5.5.2 and 5.5.3. | +| "Nnssf_NSSAIAvailability_Notification" | 3GPP TS 29.531 [32], Clause 6.2.5.2 | +| "Namf_Communication_AMFStatusChangeNotify" | 3GPP TS 29.518 [31], Clause 6.1.5.2. | +| "Ngmlc_Location_EventNotify" | 3GPP TS 29.515 [40], Clause 6.1.4.2. | +| "Nchf_ConvergedCharging_Notify" | 3GPP TS 32.291 [42], Clause 6.1.5.2 | +| "Nnssaa NSSAA ReAuthentication" | 3GPP TS 29.526 [44], Clause 6.1.5.2. | +| "Nnssaa NSSAA Revocation" | 3GPP TS 29.526 [44], Clause 6.1.5.3. | +| "N5g-ddnmf_Discovery_MonitorUpdateResult" | 3GPP TS 29.555 [46], Clause 6.1.5.2. | +| "N5g-ddnmf_Discovery_MatchInformation" | 3GPP TS 29.555 [46], Clause 6.1.5.3. | +| ... | ... | + +For notification and callback service operations (used across PLMNs or within a PLMN) that are not part of Table B.1, the value of the header shall be constructed as follows: + +"\_" + +EXAMPLE: Nsmf\_PDUSession\_smContextStatusNotification (for the Notify SM Context Status service operation) + +where the "smContextStatusNotification" correspond to: + +``` +callbacks: + smContextStatusNotification: + '{ $request.body#/smContextStatusUri }': +``` + +NOTE: Several values in Table B-1 do not comply with the construction rule for the "3gpp-Sbi-Callback" HTTP header described in this clause; in those cases, the values explicitly included in Table B-1 take precedence over the construction rule. + +## Annex C (informative): Internal NF Routing of HTTP Requests + +The internal details of the architecture of a Network Function instance is out of the scope of 3GPP and are entirely implementation-specific. This annex describes how an instance of an NF Service Producer can route internally HTTP requests received on a given Service-Based Interface. + +Figure C-1 illustrates an example component architecture where incoming HTTP requests are received and processed in a component named as "Ingress Proxy" module and route them to the appropriate computing resource in the NF. + +![Diagram of internal message routing inside an NF Service Producer. An NF Service Consumer sends an HTTP request (URI) to an Ingress Proxy. The Ingress Proxy uses a mapping of URI path components to computing resources to route the request to one of several computing resources (Computing Resource 1, Computing Resource 2, or Computing Resource N) within the NF Service Producer.](b2a75beaa7e485cd651c2a83b30a4adc_img.jpg) + +``` + +graph LR + subgraph NF_Service_Producer [NF Service Producer] + direction TB + Ingress_Proxy[Ingress Proxy] + CR1[Computing Resource 1] + CR2[Computing Resource 2] + CRN[Computing Resource N] + Ingress_Proxy -- "Mapping of URI path components to Computing Resources" --> CR1 + Ingress_Proxy --> CR2 + Ingress_Proxy --> CRN + end + NF_Service_Consumer[NF Service Consumer] -- "HTTP request (URI)" --> Ingress_Proxy + +``` + +Diagram of internal message routing inside an NF Service Producer. An NF Service Consumer sends an HTTP request (URI) to an Ingress Proxy. The Ingress Proxy uses a mapping of URI path components to computing resources to route the request to one of several computing resources (Computing Resource 1, Computing Resource 2, or Computing Resource N) within the NF Service Producer. + +**Figure C-1: Internal message routing inside NF Service Producer** + +The Ingress Proxy may parse any of the different components in the HTTP request, but typically it may parse the path of the URI (i.e. the :path pseudo-header in the HTTP/2 request). Parsing of other component in the request message, such as the HTTP body, is also possible but it is not desirable as it requires the parsing of the entire body (i.e. a JSON document) which is a much more computing-intensive task. + +The path component of the URI contains the service name of the requested SBA service, so frequently the routing is done based on this component. + +It is also frequent to inspect other components of the path (i.e. path segments), to do a more fine-grained routing and direct requests done on a specific HTTP resource(s) towards a given computing resource(s). + +It can be noted that the path components used to determine the target computing resource typically do not need to be statically defined but are frequently defined in terms of "variables", or placeholders, similarly to how they are defined in + +the OpenAPI specification language (a mechanism usually known as "path templating"). See: + + +--- + +## Annex D (Normative): ABNF grammar for 3GPP SBI HTTP custom headers + +### D.1 General + +This Annex contains a self-contained set of ABNF rules, comprising the re-used rules from IETF RFCs, and the rules defined by the 3GPP custom headers defined in this specification (see clause 5.2.3). + +This grammar may be used as input to existing tools to help implementations to parse 3GPP custom headers. + +Given that this Annex is included in relation to ABNF tooling, the following aspects should be observed: + +- The "list extension" rule defined in IETF RFC 9110 [11], section 5.6.1, is typically not supported by ABNF tooling, so rules included this syntax have been re-written with their equivalent syntax: + +``` +Rule1 = 1#element +``` + +``` +Rule2 = #element +``` + +is re-written as: + +``` +Rule1 = element *( OWS "," OWS element ) +``` + +``` +Rule2 = [ element *( OWS "," OWS element ) ] +``` + +- The ABNF specification defined in IETF RFC 5234 [43] does not describe how to evaluate the "alternative" operator (i.e., "Rule1 / Rule2"), when both rules match, but one of them have a "longer" match than the other. Based on existing ABNF rules in different RFCs, it seems that the approach is to apply a "longest" match (see, for example, the "dec-octet" rule in IETF RFC 3986 [14]); however, most existing ABNF tools apply a "left-most" match. When this occurs, the rules in this Annex have been re-written by placing the rule with a longest match on the left side, and the shortest match on the right side of the alternative operator. + +NOTE: This ambiguity in the ABNF language has been identified in other IETF specifications, such as IETF RFC 3501; in that case, a requirement was added to the RFC (see section 9): *"In the case of alternative or optional rules in which a later rule overlaps an earlier rule, the rule which is listed earlier MUST take priority"*. + +For example: + +``` +Rule1 = "imei" / "imeisv" +``` + +``` +Rule2 = DIGIT / ( "1" DIGIT ) ; allows an integer in the range 0-19 +``` + +is re-written as: + +``` +Rule1 = "imeisv" / "imei" +``` + +``` +Rule2 = ( "1" DIGIT ) / DIGIT ; allows an integer in the range 0-19 +``` + +- The rules containing prose text ("<...>") are typically not supported by ABNF tooling, so the rule in IETF RFC 3986 [14]: + +``` +path-empty = 0 +``` + +is re-written as: + +``` +path-empty = 0pchar +``` + +- Some rules in IETF RFC 9110 [11] ("day", "month", "year") contain the same rule names as in IETF RFC 5322 [37], so these clashing rule names in IETF RFC 9110 [11] have been renamed as "day-rfc9110", "month-rfc9110" and "year-rfc9110" respectively. + +## D.2 ABNF definitions (Filename: "TS29500\_CustomHeaders.abnf") + +``` +; ----- +; RFC 5234 +; ----- + +HTAB = %x09 ; horizontal tab +LF = %x0A ; linefeed +CR = %x0D ; carriage return +SP = %x20 +DQUOTE = %x22 ; " (Double Quote) +DIGIT = %x30-39 ; 0-9 +ALPHA = %x41-5A / %x61-7A ; A-Z / a-z +VCHAR = %x21-7E ; visible (printing) characters +WSP = SP / HTAB ; white space +CRLF = CR LF ; Internet standard newline +HEXDIG = DIGIT / "A" / "B" / "C" / "D" / "E" / "F" + +; ----- +; RFC 3986 +; ----- + +unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" +pct-encoded = "%" HEXDIG HEXDIG +sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" +pchar = unreserved / pct-encoded / sub-delims / ":" / "@" +segment = *pchar +segment-nz = 1*pchar +path-abempty = *( "/" segment ) +path-absolute = "/" [ segment-nz *( "/" segment ) ] +path-rootless = segment-nz *( "/" segment ) +path-empty = 0pchar +IPvFuture = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" ) +dec-octet = "25" %x30-35 / "2" %x30-34 DIGIT / "1" 2DIGIT / %x31-39 DIGIT / DIGIT +h16 = 1*4HEXDIG +ls32 = ( h16 ":" h16 ) / Ipv4address +Ipv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet +``` + +``` + +Ipv6address = 6( h16 ":" ) ls32 + / ":" 5( h16 ":" ) ls32 + / [ h16 ] "::" 4( h16 ":" ) ls32 + / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32 + / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32 + / [ *3( h16 ":" ) h16 ] "::" h16 ls32 + / [ *4( h16 ":" ) h16 ] "::" ls32 + / [ *5( h16 ":" ) h16 ] "::" h16 + / [ *6( h16 ":" ) h16 ] "::" + +IP-literal = "[" ( Ipv6address / IpvFuture ) "]" + +reg-name = *( unreserved / pct-encoded / sub-delims ) + +host = IP-literal / Ipv4address / reg-name + +port = *DIGIT + +scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) + +userinfo = *( unreserved / pct-encoded / sub-delims / ":" ) + +authority = [ userinfo "@" ] host [ ":" port ] + +hier-part = "//" authority path-abempty / path-absolute / path-rootless / path-empty + +query = *( pchar / "/" / "?" ) + +fragment = *( pchar / "/" / "?" ) + +URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] + +; ----- +; RFC 5322 +; ----- + +obs-FWS = 1*WSP *( CRLF 1*WSP ) + +FWS = ( [ *WSP CRLF ] 1*WSP ) / obs-FWS + +obs-NO-WS-CTL = %d1-8 / %d11 / %d12 / %d14-31 / %d127 + +obs-ctext = obs-NO-WS-CTL + +ctext = %d33-39 / %d42-91 / %d93-126 / obs-ctext + +obs-qp = "\" ( %d0 / obs-NO-WS-CTL / LF / CR ) + +quoted-pair = ( "\" ( VCHAR / WSP ) ) / obs-qp + +ccontent = ctext / quoted-pair / comment + +comment = "(" *( [ FWS ] ccontent ) [ FWS ] ")" + +CFWS = ( 1*( [ FWS ] comment ) [ FWS ] ) / FWS + +day-name = "Mon" / "Tue" / "Wed" / "Thu" / "Fri" / "Sat" / "Sun" + +obs-day-of-week = [ CFWS ] day-name [ CFWS ] + +day-of-week = ( [ FWS ] day-name ) / obs-day-of-week + +obs-day = [ CFWS ] 1*2DIGIT [ CFWS ] + +day = ( [ FWS ] 1*2DIGIT FWS ) / obs-day + +month = "Jan" / "Feb" / "Mar" / "Apr" / "May" / "Jun" + / "Jul" / "Aug" / "Sep" / "Oct" / "Nov" / "Dec" + +obs-year = [ CFWS ] 2*DIGIT [ CFWS ] + +year = ( FWS 4*DIGIT FWS ) / obs-year + +date = day month year + +obs-hour = [ CFWS ] 2DIGIT [ CFWS ] + +``` + +``` + +hour = obs-hour / 2DIGIT +obs-minute = [ CFWS ] 2DIGIT [ CFWS ] +minute = obs-minute / 2DIGIT +obs-second = [ CFWS ] 2DIGIT [ CFWS ] +second = obs-second / 2DIGIT +time-of-day = hour ":" minute [ ":" second ] +obs-zone = "UT" / "GMT" / "EST" / "EDT" / "CST" / "CDT" / "MST" / "MDT" + / "PST" / "PDT" / %d65-73 / %d75-90 / %d97-105 / %d107-122 +zone = ( FWS ( "+" / "-" ) 4DIGIT ) / obs-zone +time = time-of-day zone +date-time = [ day-of-week "," ] date time [ CFWS ] + +; ----- +; RFC 6749 +; ----- + +NQCHAR = %x21 / %x23-5B / %x5D-7E + +; ----- +; RFC 9110 +; ----- + +OWS = *( SP / HTAB ) +RWS = 1*( SP / HTAB ) +tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" + / "." / "^" / "_" / "`" / "|" / "~" / DIGIT / ALPHA +token = 1*tchar +BWS = OWS +quoted-string = DQUOTE *( qdtext / quoted-pair ) DQUOTE +qdtext = HTAB / SP / %x21 / %x23-5B / %x5D-7E / obs-text +obs-text = %x80-FF +date1 = day-rfc9110 SP month-rfc9110 SP year-rfc9110 ; e.g., 02 Jun 1982 +day-rfc9110 = 2DIGIT +month-rfc9110 = %x4A.61.6E ; "Jan", case-sensitive + / %x46.65.62 ; "Feb", case-sensitive + / %x4D.61.72 ; "Mar", case-sensitive + / %x41.70.72 ; "Apr", case-sensitive + / %x4D.61.79 ; "May", case-sensitive + / %x4A.75.6E ; "Jun", case-sensitive + / %x4A.75.6C ; "Jul", case-sensitive + / %x41.75.67 ; "Aug", case-sensitive + / %x53.65.70 ; "Sep", case-sensitive + / %x4F.63.74 ; "Oct", case-sensitive + / %x4E.6F.76 ; "Nov", case-sensitive + / %x44.65.63 ; "Dec", case-sensitive +year-rfc9110 = 4DIGIT +codings = content-coding / "identity" / "*" +content-coding = token +weight = OWS ";" OWS "q=" qvalue + +``` + +``` + +qvalue = ( "0" [ "." *3DIGIT ] ) / ( "1" [ "." *3"0" ] ) + +credentials = auth-scheme [ 1*SP ( token68 + / [ ( "," / auth-param ) *( OWS "," [ OWS auth-param ] ) ] ) ] + +auth-scheme = token + +auth-param = token BWS "=" BWS ( token / quoted-string ) + +token68 = 1*( ALPHA / DIGIT / "-" / "." / "_" / "~" / "+" / "/" ) *"" + +; ----- +; 3GPP TS 29.500 +; +; Version: 18.4.0 (December 2023) +; +; (c) 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +; ----- + +; +; Header: 3gpp-Sbi-Message-Priority +; + +Sbi-Message-Priority-Header = "3gpp-Sbi-Message-Priority:" OWS + ( "3" %x30-31 / %x31-32 DIGIT / DIGIT ) OWS + +; +; Header: 3gpp-Sbi-Callback +; + +Sbi-Callback-Header = "3gpp-Sbi-Callback:" OWS cbtype *( ";" OWS "apiversion=" majorversion ) OWS + +cbchar = "-" / "_" / DIGIT / ALPHA + +cbtype = 1*cbchar + +majorversion = *DIGIT + +; +; Header: 3gpp-Sbi-Target-apiRoot +; + +Sbi-Target-ApiRoot-Header = "3gpp-Sbi-Target-apiRoot:" OWS sbi-scheme "://" sbi-authority + [ prefix ] OWS + +sbi-scheme = "https" / "http" + +sbi-authority = host [ ":" port ] + +prefix = path-absolute + +; +; Header: 3gpp-Sbi-Routing-Binding +; + +Sbi-Routing-Binding-Header = "3gpp-Sbi-Routing-Binding:" OWS "bl=" blvalue + 1*( ";" OWS parameter ) + [ ";" OWS callback-uri-prefix ] OWS + +blvalue = "nf-instance" + / "nf-set" + / "nfservice-instance" + / "nfservice-set" + +parametername = "nfinst" + / "nfset" + / "nfservinst" + / "nfserviceset" + / "servname" + / "backupamfinst" + +``` + +``` + + / "backupnf" + +parameter = parametername "=" token + +; +; Header: 3gpp-Sbi-Binding +; + +Sbi-Binding-Header = "3gpp-Sbi-Binding:" OWS binding-element *( OWS "," OWS binding-element ) OWS + +binding-element = "bl=" blvalue 1*( ";" OWS bh-parameter ) + [ ";" OWS recoverytime ] + [ ";" OWS notif-receiver ] + [ ";" OWS "group=" groupvalue ] + [ 1*( ";" OWS groupparameter ) ] + [ ";" OWS "no-redundancy=" no-red-value ] + [ ";" OWS callback-uri-prefix ] OWS + +bh-parametername = parametername / "scope" + +bh-parameter = bh-parametername "=" token + +recoverytime = "recoverytime=" OWS DQUOTE date-time DQUOTE + +notif-receiver = "nr=" URI + +groupvalue = "true" / "false" + +groupparametername = "oldgroupid" + / "groupid" + / "uribase" + / "oldnfinst" + / "oldservset" + / "oldservinst" + / "guami" + +groupparameter = groupparametername "=" token + +no-red-value = "true" + +; +; Header: 3gpp-Sbi-Producer-Id +; + +Sbi-Producer-Id-Header = "3gpp-Sbi-Producer-Id:" OWS "nfinst=" nfinst + [ OWS ";" OWS "nfservinst=" nfservinst ] + [ OWS ";" OWS "nfset=" nfset ] + [ OWS ";" OWS "nfserviceset=" nfserviceset ] OWS + +nfinst = 8HEXDIG "-" 4HEXDIG "-" 4HEXDIG "-" 4HEXDIG "-" 12HEXDIG + +nfservinst = token + +nfset = token + +nfserviceset = token + +; +; Header: 3gpp-Sbi-Oci +; + +Sbi-Oci-Header = "3gpp-Sbi-Oci:" OWS oci-element *( OWS "," OWS oci-element ) OWS + +oci-element = timestamp ";" RWS validityPeriod ";" RWS olcMetric ";" RWS olcScope + +timestamp = "Timestamp:" RWS DQUOTE date-time DQUOTE + +validityPeriod = "Period-of-Validity:" RWS 1*DIGIT "s" + +olcMetric = "Overload-Reduction-Metric:" RWS ( "100" / %x31-39 DIGIT / DIGIT ) "%" + +olcScope = nfProducerScope / nfConsumerScope / scpScope / seppScope + +``` + +``` + +nfProducerScope = ( ( "NF-Instance:" RWS nfinst ) + / ( "NF-Set:" RWS nfset ) + / ( "NF-Service-Instance:" RWS nfservinst [ ";" RWS "NF-Inst:" RWS nfinst ] ) + / ( "NF-Service-Set:" RWS nfserviceset ) + ) [ ";" RWS sNssaiList ";" RWS dnnList ] + +nfConsumerScope = ( "NFC-Instance:" RWS nfinst [ ";" RWS "Service-Name:" RWS servname ] ) + / ( "NFC-Set:" RWS nfset [ ";" RWS "Service-Name:" RWS servname ] ) + / ( "NFC-Service-Instance:" RWS nfservinst [ ";" RWS "NF-Inst:" RWS nfinst ] ) + / ( "NFC-Service-Set:" RWS nfserviceset ) + / ( "Callback-Uri:" RWS DQUOTE URI DQUOTE *( RWS "&" RWS DQUOTE URI DQUOTE ) ) + +servname = token + +scpScope = "SCP-FQDN:" RWS fqdn + +seppScope = "SEPP-FQDN:" RWS fqdn + +fqdn = token + +dnnList = "DNN:" RWS 1*tchar *( RWS "&" RWS 1*tchar ) + +sNssaiList = "S-NSSAI:" RWS snssai *( RWS "&" RWS snssai ) + +snssai = 1*tchar + +; +; Header: 3gpp-Sbi-Lci +; + +Sbi-Lci-Header = "3gpp-Sbi-Lci:" OWS lc-element *( OWS "," OWS lc-element ) OWS + +lc-element = timestamp ";" RWS lcMetric ";" RWS lcScope + +lcMetric = "Load-Metric:" RWS ( "100" / %x31-39 DIGIT / DIGIT ) "%" + +lcScope = lcNfProducerScope / scpScope / seppScope + +lcNfProducerScope = ( ( "NF-Instance:" RWS nfinst ) + / ( "NF-Set:" RWS nfset ) + / ( "NF-Service-Instance:" RWS nfservinst [ ";" RWS "NF-Inst:" RWS nfinst ] ) + / ( "NF-Service-Set:" RWS nfserviceset ) + ) [ ";" RWS sNssaiList ";" RWS dnnList ";" RWS relativeCapacity ] + +relativeCapacity = "Relative-Capacity:" RWS ( "100" / 1*2DIGIT ) "%" + +; +; Header: 3gpp-Sbi-Client-Credentials +; + +Sbi-Client-Credentials-Header = "3gpp-Sbi-Client-Credentials:" OWS jwt OWS + +jwt = 1*b64urlchar "." 1*b64urlchar "." 1*b64urlchar + +b64urlchar = ALPHA / DIGIT / "-" / "_" + +; +; Header: 3gpp-Sbi-Source-NF-Client-Credentials +; + +Sbi-Source-NF-Client-Credentials-Header = "3gpp-Sbi-Source-NF-Client-Credentials:" OWS jwt OWS + +; +; Header: 3gpp-Sbi-Nrf-Uri +; + +Sbi-Nrf-Uri-Header = "3gpp-Sbi-Nrf-Uri:" OWS nrfUriParam *( OWS ";" OWS nrfUriParam ) OWS + +nrfUriParam = nrfUriParamName ":" RWS ( nrfUriParamValue1 / nrfUriParamValue2 ) + +``` + +``` +nrfUriParamName = "nnrf-disc" / "nnrf-nfm" / "nnrf-oauth2" / "oauth2-requested-services" / token +nrfUriParamValue1 = DQUOTE URI DQUOTE +nrfUriParamValue2 = ( nrfServiceName *( RWS "&" RWS nrfServiceName ) ) +nrfServiceName = "nnrf-disc" / "nnrf-nfm" + +; +; Header: 3gpp-Sbi-Target-Nf-Id +; + +Sbi-Target-Nf-Id-Header = "3gpp-Sbi-Target-Nf-Id:" OWS "nfinst=" nfinst + [ ";" OWS "nfservinst=" nfservinst ] OWS + +; +; Header: 3gpp-Sbi-Max-Forward-Hops +; + +Sbi-Max-Forward-Hops-Header = "3gpp-Sbi-Max-Forward-Hops:" OWS ( %x31-39 DIGIT / DIGIT ) + [ ";" OWS "nodetype=" nodetypevalue OWS +nodetypevalue = "scp" + +; +; Header: 3gpp-Sbi-Originating-Network-Id +; + +Sbi-Originating-Network-Id-Header = "3gpp-Sbi-Originating-Network-Id:" OWS 3DIGIT "-" 2*3DIGIT + [ "-" 11HEXDIG ] [ ";" OWS srcinfo ] OWS +srcinfo = "src" ":" RWS srcctype "-" srcfqdn +srcctype = "SCP" / "SEPP" +srcfqdn = 4*( ALPHA / DIGIT / "-" / "." ) + +; +; Header: 3gpp-Sbi-Access-Scope +; + +Sbi-Access-Scope-Header = "3gpp-Sbi-Access-Scope:" OWS scope-token *( SP scope-token ) OWS +scope-token = 1*NQCHAR + +; +; Header: 3gpp-Sbi-Other-Access-Scopes +; + +Sbi-Other-Access-Scopes-Header = "3gpp-Sbi-Other-Access-Scopes:" OWS scope-token + *( SP scope-token ) OWS + +; +; Header: 3gpp-Sbi-Access-Token +; + +Sbi-Access-Token-Header = "3gpp-Sbi-Access-Token:" OWS credentials OWS + +; +; Header: 3gpp-Sbi-Target-Nf-Group-Id +; + +Sbi-Target-Nf-Group-Id-Header = "3gpp-Sbi-Target-Nf-Group-Id:" OWS "nfgid=" nfGroupIdValue OWS +``` + +``` + +nfGroupIdValue = DQUOTE token DQUOTE + +; +; Header: 3gpp-Sbi-Nrf-Uri-Callback +; + +Sbi-Nrf-Uri-Callback-Header = "3gpp-Sbi-Nrf-Uri-Callback:" OWS + nrfUriCallbackParam *( OWS ";" OWS nrfUriCallbackParam ) OWS + +nrfUriCallbackParam = nrfUriCallbackParamName ":" RWS nrfUriCallbackParamValue + +nrfUriCallbackParamName = "nnrf-disc" / "nnrf-nfm" / token + +nrfUriCallbackParamValue = DQUOTE URI DQUOTE + +; +; Header: 3gpp-Sbi-NF-Peer-Info +; + +Sbi-NF-Peer-Info-Header = "3gpp-Sbi-NF-Peer-Info:" OWS peerinfo *( " ;" OWS peerinfo ) OWS + +peerinfo = peertype "=" token + +peertype = "srcinst" + / "srcservinst" + / "srcscp" + / "srcsepp" + / "dstinst" + / "dstservinst" + / "dstscp" + / "dstsepp" + +; +; Header: 3gpp-Sbi-Sender-Timestamp +; + +Sbi-Sender-Timestamp-Header = "3gpp-Sbi-Sender-Timestamp:" OWS + day-name "," SP date1 SP time-of-day "." milliseconds SP "GMT" OWS + +milliseconds = 3DIGIT + +; +; Header: 3gpp-Sbi-Max-Rsp-Time +; + +Sbi-Max-Rsp-Time-Header = "3gpp-Sbi-Max-Rsp-Time:" OWS 1*5DIGIT OWS + +; +; Header: 3gpp-Sbi-Correlation-Info +; + +Sbi-Correlation-Info-Header = "3gpp-Sbi-Correlation-Info:" OWS + correlationinfo *( " ;" OWS correlationinfo ) OWS + +correlationinfo = ctype "-" cvalue + +ctype = extension-token / "imsi" / "impi" / "suci" / "nai" / "gci" / "gli" + / "impu" / "msisdn" / "extid" / "imeisv" / "imei" / "mac" / "eui" + +extension-token = 1*( "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "." / "^" / "_" + / "`" / "|" / "~" / DIGIT / ALPHA ) + +cvalue = 1*( tchar / "@" ) + +; + +``` + +``` + +; Header: 3gpp-Sbi-Alternate-Chf-Id +; + +Sbi-Alternate-Chf-Id-Header = "3gpp-Sbi-Alternate-Chf-Id:" OWS + "nfinst=" nfinst ";" OWS ( "primary" / "secondary" ) OWS + +; +; Header: 3gpp-Sbi-Notif-Accepted-Encoding +; + +Sbi-Notif-Accepted-Encoding-Header = "3gpp-Sbi-Notif-Accepted-Encoding:" OWS + encoding-element *( OWS "," OWS encoding-element ) OWS + +encoding-element = codings [ weight ] + +; +; Header: 3gpp-Sbi-Consumer-Info +; + +Sbi-Consumer-Info-Header = "3gpp-Sbi-Consumer-Info:" OWS + consumer-info-element *( OWS "," OWS consumer-info-element ) OWS + +consumer-info-element = ( supportedService ";" OWS supportedVersions + [ ";" OWS supportedFeatures ] + [ ";" OWS acceptEncoding ] + [ ";" OWS callback-uri-prefix ] + ) [ ";" OWS intraPlmnCallbackRoot ";" OWS interPlmnCallbackRoot ] + +supportedService = "service=" servicename + +servicename = 1*( "-" / %x30-39 / %x41-5A / "_" / %x61-7A ) + +supportedVersions = "apiversion=" "(" OWS + [ apimajorversion *( RWS apimajorversion ) OWS ] ")" + +apimajorversion = %x31-39 [ *DIGIT ] + +supportedFeatures = "supportedfeatures=" features + +features = *HEXDIG + +acceptEncoding = "acceptencoding=" %x22 encodingList %x22 + +encodingList = [ encoding-element *( OWS "," OWS encoding-element ) ] + +intraPlmnCallbackRoot = "intraPlmnCallbackRoot=" + DQUOTE sbi-scheme "://" sbi-authority [ prefix ] DQUOTE + +interPlmnCallbackRoot = "interPlmnCallbackRoot=" + DQUOTE sbi-scheme "://" sbi-authority [ prefix ] DQUOTE + +callback-uri-prefix = "callback-uri-prefix=" DQUOTE prefix DQUOTE + +; +; Header: 3gpp-Sbi-Response-Info +; + +Sbi-Response-Info-Header = "3gpp-Sbi-Response-Info:" OWS + resp-info-param *( OWS ";" OWS resp-info-param ) OWS + +resp-info-param = resp-info-param-name "=" OWS resp-info-param-value + +resp-info-param-name = "request-retransmitted" + / "nfinst" + / "nfset" + / "nfservinst" + / "nfserviceset" + / "context-transferred" + / "no-retry" + / token + +resp-info-param-value = token + +``` + +``` +; +; Header: 3gpp-Sbi-Selection-Info +; + +Sbi-Selection-Info-Header = "3gpp-Sbi-Selection-Info:" OWS + selection-info-element *( OWS "," OWS selection-info-element ) OWS + +selection-info-element = ( "reselection=" reselectionvalue *( ";" OWS selection-criteria ) ) + / ( selection-criteria *( ";" OWS selection-criteria ) ) + +reselectionvalue = "true" / "false" + +selection-criteria = selection-action "=" token + +selection-action = "not-select-nfservinst" + / "not-select-nfserviceset" + / "not-select-nfinst" + / "not-select-nfset" + +; +; Header: 3gpp-Sbi-Interplmn-Purpose +; + +Sbi-Interplmn-Purpose-Header = "3gpp-Sbi-Interplmn-Purpose:" OWS N32Purpose ":" OWS + additional-info OWS + +N32Purpose = "ROAMING" + / "INTER_PLMN MOBILITY" + / "SMS_INTERCONNECT" + / "ROAMING_TEST" + / "INTER_PLMN MOBILITY_TEST" + / "SMS_INTERCONNECT_TEST" + / "SNPN_INTERCONNECT" + / "SNPN_INTERCONNECT_TEST" + / "DISASTER_ROAMING" + / "DISASTER_ROAMING_TEST" + / token + +additional-info = token + +; +; Header: 3gpp-Sbi-Request-Info +; + +Sbi-Request-Info-Header = "3gpp-Sbi-Request-Info:" OWS req-param *( ";" OWS req-param ) OWS + +req-param = req-param-name "=" OWS req-param-value + +req-param-name = "retrans" + / "redirect" + / "reason" + / "idempotency-key" + / "receivedrejectioncause" + / "callback-uri-prefix" + / token + +req-param-value = token + +; +; Header: 3gpp-Sbi-Retry-Info +; + +Sbi-Retry-Info-Header = "3gpp-Sbi-Retry-Info:" OWS retriesindication OWS + +retriesindication = "no-retries" +``` + +## Annex E (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|---------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | R
ev | Cat | Subject/Comment | New version | +| 2017-10 | CT4#80 | C4-175246 | | | | TR skeleton | 0.1.0 | +| 2017-10 | CT4#80 | C4-175390 | | | | Implementation of pCRs agreed at CT4#80. | 0.2.0 | +| 2017-12 | CT4#81 | C4-176433 | | | | Implementation of pCRs agreed at CT4#81. | 0.3.0 | +| 2018-01 | CT4#82 | C4-181387 | | | | Implementation of pCRs agreed at CT4#82. | 0.4.0 | +| 2018-03 | CT4#83 | C4-182430 | | | | Implementation of pCRs agreed at CT4#83. | 0.5.0 | +| 2018-03 | CT#79 | CP-180028 | | | | Presented for information | 1.0.0 | +| 2018-04 | CT4#84 | C4-183512 | | | | Implementation of pCRs agreed at CT4#84. | 1.1.0 | +| 2018-05 | CT4#85 | C4-184617 | | | | Implementation of pCRs agreed at CT4#85. The following pCRs are implemented. C4-184589, C4-184580, C4-184347, C4-184590, C4-184338, C4-184591, C4-184349, C4-184490, C4-184350, C4-184579, C4-184577 and C4-184498. | 1.2.0 | +| 2018-06 | CT#80 | CP-181098 | | | | Presented for approval | 2.0.0 | +| 2018-06 | CT#80 | | | | | Apprvoed in CT#80 | 15.0.0 | +| 2018-09 | CT#81 | CP-182053 | 0001 | 4 | F | OAuth2.0 Clarifications | 15.1.0 | +| 2018-09 | CT#81 | CP-182053 | 0002 | 2 | B | Specifying N32 Aspects | 15.1.0 | +| 2018-09 | CT#81 | CP-182053 | 0003 | 1 | F | Determination of SBI message priorities | 15.1.0 | +| 2018-09 | CT#81 | CP-182053 | 0004 | 5 | F | Stateless AMF support | 15.1.0 | +| 2018-09 | CT#81 | CP-182053 | 0005 | | F | Support of status code "501 Not implemented" | 15.1.0 | +| 2018-09 | CT#81 | CP-182053 | 0006 | 2 | B | Default port number | 15.1.0 | +| 2018-12 | CT#82 | CP-183011 | 0009 | 3 | F | Keep-alive on idle HTTP connections | 15.2.0 | +| 2018-12 | CT#82 | CP-183011 | 0010 | 1 | F | Stream Concurrency for overload control | 15.2.0 | +| 2018-12 | CT#82 | CP-183011 | 0011 | 1 | F | Update of missing status code 429 | 15.2.0 | +| 2018-12 | CT#82 | CP-183011 | 0012 | 1 | F | Correction of the entity upon which content encoding is performed | 15.2.0 | +| 2018-12 | CT#82 | CP-183011 | 0013 | 2 | F | Custom header for notifications | 15.2.0 | +| 2018-12 | CT#82 | CP-183011 | 0014 | 3 | F | Routing across PLMN | 15.2.0 | +| 2018-12 | CT#82 | CP-183011 | 0015 | | F | HTTP status code "406 Not Acceptable" | 15.2.0 | +| 2018-12 | CT#82 | CP-183011 | 0016 | 1 | F | Support of HTTP status code "414 URI Too Long" | 15.2.0 | +| 2018-12 | CT#82 | CP-183011 | 0018 | | F | HTTP status code "414 URI Too Long" on PUT method | 15.2.0 | +| 2018-12 | CT#82 | CP-183011 | 0020 | 1 | F | Correction of Stream Priority in HTTP/2 Server Behaviour | 15.2.0 | +| 2018-12 | CT#82 | CP-183194 | 0022 | 2 | F | Change 403 to mandatory and clarify conditional headers | 15.2.0 | +| 2018-12 | | | | | | Change history annex number corected | 15.2.1 | +| 2019-03 | CT#83 | CP-190016 | 0023 | 1 | F | Extensibility mechanism for Query parameters | 15.3.0 | +| 2019-03 | CT#83 | CP-190016 | 0024 | 1 | F | Bearer Tokens | 15.3.0 | +| 2019-03 | CT#83 | CP-190016 | 0025 | 1 | F | Handling of Incorrect IEs | 15.3.0 | +| 2019-03 | CT#83 | CP-190016 | 0026 | 2 | F | Clarification on Handling of Incorrect Optional IEs | 15.3.0 | +| 2019-03 | CT#83 | CP-190016 | 0027 | | F | Status Codes | 15.3.0 | +| 2019-06 | CT#84 | CP-191027 | 0030 | 1 | F | Content-encodings supported in HTTP requests | 15.4.0 | +| 2019-06 | CT#84 | CP-191027 | 0031 | 3 | F | Missing Application Error Codes | 15.4.0 | +| 2019-06 | CT#84 | CP-191027 | 0032 | 2 | F | Correction on Feature Negotiation | 15.4.0 | +| 2019-06 | CT#84 | CP-191027 | 0037 | 1 | F | Allowed values of 3gpp-Sbi-Callback header field | 15.4.0 | +| 2019-06 | CT#84 | CP-191027 | 0038 | 1 | F | Adding the Control Plane interfaces that support service based interface | 15.4.0 | +| 2019-06 | CT#84 | CP-191055 | 0033 | 1 | B | Support of Indirect Communication (General) | 16.0.0 | +| 2019-06 | CT#84 | CP-191055 | 0034 | 2 | B | Support of Indirect Communication (Routing to SCP) | 16.0.0 | +| 2019-06 | CT#84 | CP-191055 | 0035 | 1 | B | Support of Indirect Communication (NF discovery and selection) | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0036 | 2 | B | Partially implemented PATCH | 16.0.0 | +| 2019-09 | CT#85 | CP-192194 | 0040 | 2 | B | Support of stateless NFs | 16.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------------|--------| +| 2019-09 | CT#85 | CP-192194 | 0041 | 1 | B | Routing mechanisms for Indirect Communication | 16.1.0 | +| 2019-09 | CT#85 | CP-192194 | 0042 | 1 | B | Routing extensions for Indirect Communication | 16.1.0 | +| 2019-09 | CT#85 | CP-192194 | 0043 | - | B | Authority and/or deployment-specific string in apiRoot of resource URI for Indirect Communication | 16.1.0 | +| 2019-09 | CT#85 | CP-192194 | 0044 | 1 | B | NF / NF service instance selection for Indirect Communication without Delegated Discovery | 16.1.0 | +| 2019-09 | CT#85 | CP-192194 | 0045 | - | B | Feature negotiation for Indirect Communication with Delegated Discovery | 16.1.0 | +| 2019-09 | CT#85 | CP-192194 | 0053 | 2 | B | Routing for indirect Communication with HTTP between NFs and SCP | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0046 | - | B | Timestamp in HTTP messages | 16.1.0 | +| 2019-09 | CT#85 | CP-19212 | 0047 | 1 | B | Handling of timed out requests | 16.1.0 | +| 2019-09 | CT#85 | CP-19212 | 0049 | 1 | B | Indicating partially implemented PATCH | 16.1.0 | +| 2019-09 | CT#85 | CP-19212 | 0052 | 2 | F | Adding the Control Plane interfaces that support service based interface | 16.1.0 | +| 2019-12 | CT#86 | CP-193036 | 0059 | 1 | F | Load Info used for Load Control | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0062 | - | F | Informative description of internal NF routing of HTTP messages | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0039 | 5 | B | Binding between NF Service Consumer and NF Service Producer | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0056 | 2 | B | Routing of Indirect Communication with TLS between NFs and SCP | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0057 | 2 | B | Routing of Indirect Communication without TLS between NFs and SCP | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0060 | 3 | B | Conveyance of Delegated Discovery Parameters in HTTP/2 Headers | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0064 | 1 | B | Binding indication for subscribe/notify | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0065 | - | B | General Introduction for Delegated Discovery | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0067 | 1 | B | Handling of relative URIs with indirect communication | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0068 | 2 | B | Use of 3gpp-Sbi-Target-apiRoot header in HTTP requests from NFs to SEPP | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0069 | 2 | B | Returning NF Producer ID to NF Consumer when using Delegated Discovery | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0066 | 1 | B | Handling of default notification subscriptions with Delegated Discovery | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0063 | 1 | F | Clarification of Cause MANDATORY_IE_INCORRECT | 16.2.0 | +| 2020-01 | | | | | | 6.10.7 was removed (same as 6.10.2A0) | 16.2.1 | +| 2020-03 | CT#87e | CP-200025 | 0074 | 6 | B | Description of the 3GPP Rel-16 OLC | 16.3.0 | +| 2020-03 | CT#87e | CP-200025 | 0081 | 6 | B | Dynamic Load Control | 16.3.0 | +| 2020-03 | CT#87e | CP-200016 | 0085 | 2 | F | Security requirements for Indirect Communication | 16.3.0 | +| 2020-03 | CT#87e | CP-200016 | 0086 | 3 | F | Corrections to routing mechanism with TLS between NF and SCP | 16.3.0 | +| 2020-03 | CT#87e | CP-200016 | 0087 | 4 | F | Binding procedures | 16.3.0 | +| 2020-03 | CT#87e | CP-200016 | 0088 | 3 | F | Notifications sent with indirect communication | 16.3.0 | +| 2020-03 | CT#87e | CP-200016 | 0089 | 4 | F | Handling of Discovery headers not supported by the SCP | 16.3.0 | +| 2020-03 | CT#87e | CP-200016 | 0091 | 2 | F | Clarification to the SBI priority range | 16.3.0 | +| 2020-03 | CT#87e | CP-200016 | 0095 | 2 | F | Indirect Communication Configuration Fixes With or Without TLS | 16.3.0 | +| 2020-03 | CT#87e | CP-200016 | 0096 | 1 | B | Stateless Network Functions | 16.3.0 | +| 2020-03 | CT#87e | CP-200016 | 0097 | 2 | F | NF set / NF service set usage in Indirect Communication models | 16.3.0 | +| 2020-03 | CT#87e | CP-200016 | 0100 | - | F | Complement to 3gpp-Sbi-Callback Types in Annex B | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0090 | 2 | B | Failover cause | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0098 | 1 | B | Usage of compression for HTTP responses | 16.3.0 | +| 2020-03 | CT#87e | CP-200039 | 0092 | 2 | D | Editorial fixes | 16.3.0 | +| 2020-06 | CT#88e | CP-201030 | 0104 | 2 | F | Essential definitions for the binding concept | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0106 | 1 | F | Correction of references | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0107 | - | F | ABNF definition of 3gpp-Sbi-Target-apiRoot header | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0108 | 1 | F | Error handling for indirect communications | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0113 | 1 | B | Populating Recovery Information in the Binding Indication | 16.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------|--------| +| 2020-06 | CT#88e | CP-201030 | 0114 | 1 | B | Binding Indication sent from a Service Consumer | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0118 | - | F | Binding indications / headers | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0119 | 1 | F | HTTP redirection for indirect communication | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0121 | 3 | F | Clarifications for scenarios with more than one SCP | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0124 | 2 | F | Service instance binding level | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0127 | 2 | F | Binding header clarification | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0128 | - | F | Correcting parameter names in the binding headers | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0134 | - | F | Clarifications of Binding concepts | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0135 | 1 | B | Client credentials assertion and authentication | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0136 | - | F | URI used in communications after an NF Service Producer change | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0137 | - | F | Discovery parameters | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0138 | - | F | Support of Nchf_ConvergedCharging_Notify in 3gpp-Sbi-Callback | 16.4.0 | +| 2020-06 | CT#88e | CP-201030 | 0139 | 1 | F | Complete the description of custom headers | 16.4.0 | +| 2020-06 | CT#88e | CP-201039 | 0109 | 1 | B | Scope of OCI signalled by an NF service consumer | 16.4.0 | +| 2020-06 | CT#88e | CP-201039 | 0110 | 1 | B | Load and Overload Control for Indirect Communications | 16.4.0 | +| 2020-06 | CT#88e | CP-201039 | 0111 | 1 | B | S-NSSAI/DNN based Load/Overload Control | 16.4.0 | +| 2020-06 | CT#88e | CP-201039 | 0112 | 1 | | Handling of multiple LCI/OCIs with different scopes | 16.4.0 | +| 2020-06 | CT#88e | CP-201039 | 0116 | 1 | F | The Overload Control clarification when OCI sent from a Service Consumer | 16.4.0 | +| 2020-06 | CT#88e | CP-201071 | 0122 | 2 | F | Failure detection on idle HTTP connections by NFs acting as HTTP/2 server | 16.4.0 | +| 2020-06 | CT#88e | CP-201071 | 0142 | 1 | F | Missing abbreviations | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0120 | 1 | B | Resource-Level Authorization | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0123 | 2 | F | Delimiters - ABNF specific | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0140 | 1 | F | HTTP Connection management and HTTP Retry | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0141 | 1 | B | Definition of error
"RESOURCE CONTEXT NOT FOUND" | 16.4.0 | +| 2020-06 | CT#88e | CP-201047 | 0132 | - | B | NSSAA Callback | 16.4.0 | +| 2020-09 | CT#89e | CP-202119 | 0148 | 1 | F | Custom headers related to indirect communication | 16.5.0 | +| 2020-09 | CT#89e | CP-202119 | 0150 | 1 | F | TLS security with the 3gpp-Sbi-Target-apiRoot header on N32f | 16.5.0 | +| 2020-09 | CT#89e | CP-202119 | 0151 | 1 | F | Determining the NF Service Producer Identity without support of binding procedures | 16.5.0 | +| 2020-09 | CT#89e | CP-202119 | 0152 | 1 | F | Clarifications for Indirect Communications | 16.5.0 | +| 2020-09 | CT#89e | CP-202119 | 0153 | - | F | Incorrect references and editorial errors | 16.5.0 | +| 2020-09 | CT#89e | CP-202119 | 0154 | - | F | Sending the NRF API URIs to the SCP for indirect communication | 16.5.0 | +| 2020-09 | CT#89e | CP-202119 | 0157 | - | F | Discovery Headers | 16.5.0 | +| 2020-09 | CT#89e | CP-202119 | 0158 | 1 | F | Reselection with indirect communication | 16.5.0 | +| 2020-09 | CT#89e | CP-202119 | 0159 | 2 | F | API Root Change Handling | 16.5.0 | +| 2020-09 | CT#89e | CP-202119 | 0160 | 2 | F | Notification Binding for Default Subscription | 16.5.0 | +| 2020-09 | CT#89e | CP-202119 | 0161 | 1 | F | Notification for Default Subscriptions | 16.5.0 | +| 2020-09 | CT#89e | CP-202117 | 0156 | - | F | 3gpp-Sbi-Oci and 3gpp-Sbi-Lci headers | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0163 | 2 | F | Corrections on expressions based on ABNF | 16.5.0 | +| 2020-09 | CT#89e | CP-202121 | 0144 | 1 | D | Editorial fixes | 17.0.0 | +| 2020-09 | CT#89e | CP-202121 | 0145 | - | D | Fixing proofing language | 17.0.0 | +| 2020-12 | CT#90e | CP-203054 | 0171 | - | A | Service access authorization for indirect communication with delegated discovery | 17.1.0 | +| 2020-12 | CT#90e | CP-203054 | 0173 | 1 | A | NF instance selection in SCP for Indirect Communication mode C | 17.1.0 | +| 2020-12 | CT#90e | CP-203054 | 0175 | 2 | A | Essential Clarification on the Default Notification with indirect communication | 17.1.0 | +| 2020-12 | CT#90e | CP-203054 | 0177 | 1 | A | Reporting NF is not reachable | 17.1.0 | +| 2020-12 | CT#90e | CP-203054 | 0181 | 1 | A | Update a binding indication | 17.1.0 | +| 2020-12 | CT#90e | CP-203060 | 0168 | 2 | F | Clarifications to stateless NF definition | 17.1.0 | +| 2020-12 | CT#90e | CP-203054 | 0183 | 1 | A | Binding indication with the scope set to other service | 17.1.0 | +| 2020-12 | CT#90e | CP-203054 | 0185 | 1 | A | NF instance reselection and use of location | 17.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------|--------| +| 2020-12 | CT#90e | CP-203054 | 0191 | 1 | A | Handling of binding on behalf of another NF | 17.1.0 | +| 2020-12 | CT#90e | CP-203054 | 0193 | 1 | A | Binding Indication for Backup AMF | 17.1.0 | +| 2020-12 | CT#90e | CP-203054 | 0197 | - | A | Target NF (service) instance ID in HTTP 307/308 response | 17.1.0 | +| 2020-12 | CT#90e | CP-203054 | 0198 | 1 | A | Clarifications to Stateless NF scenarios | 17.1.0 | +| 2020-12 | CT#90e | CP-203048 | 0195 | 2 | B | Max SCP Hops | 17.1.0 | +| 2020-12 | CT#90e | CP-203061 | 0167 | 1 | F | Incorrect reference | 17.1.0 | +| 2020-12 | CT#90e | CP-203061 | 0179 | 1 | F | Direct retrying with another SCP | 17.1.0 | +| 2020-12 | CT#90e | CP-203064 | 0169 | - | B | SBI correlation info header | 17.1.0 | +| 2020-12 | CT#90e | CP-203064 | 0186 | 1 | C | Too Many Requests | 17.1.0 | +| 2020-12 | CT#90e | CP-203064 | 0187 | - | F | Resolution of FQDN in Callback URIs | 17.1.0 | +| 2020-12 | CT#90e | CP-203064 | 0189 | 4 | B | Asserted PLMN-ID Header | 17.1.0 | +| 2021-03 | CT#91e | CP-210037 | 0202 | - | A | Authorization of NF service access for Indirect Communication with Delegated Discovery | 17.2.0 | +| 2021-03 | CT#91e | CP-210037 | 0204 | - | A | Authorization of NF service access for Indirect Communication without Delegated Discovery | 17.2.0 | +| 2021-03 | CT#91e | CP-210037 | 0206 | - | A | Error handling when SCP receives "401 Unauthorized" or "403 Forbidden" from NFp | 17.2.0 | +| 2021-03 | CT#91e | CP-210037 | 0208 | 1 | A | Error handling when the SCP fails to obtain an access token | 17.2.0 | +| 2021-03 | CT#91e | CP-210037 | 0210 | 1 | A | Rejection response upon Client credentials assertion verification failure | 17.2.0 | +| 2021-03 | CT#91e | CP-210037 | 0212 | 1 | A | Scope parameter in notification and callback responses | 17.2.0 | +| 2021-03 | CT#91e | CP-210037 | 0214 | 1 | A | User-Agent header | 17.2.0 | +| 2021-03 | CT#91e | CP-210037 | 0218 | 1 | A | Essential Correction for interpretation of NF change | 17.2.0 | +| 2021-03 | CT#91e | CP-210037 | 0228 | 1 | A | Signaling Primary or Secondary CHF instance ID in service response with Model D | 17.2.0 | +| 2021-03 | CT#91e | CP-210037 | 0233 | 1 | A | HTTP status code used by SCP/SEPP | 17.2.0 | +| 2021-03 | CT#91e | CP-210043 | 0222 | - | A | Essential Correction to Causes NF_FAILOVER and NF_SERVICE_FAILOVER | 17.2.0 | +| 2021-03 | CT#91e | CP-210043 | 0223 | 1 | A | ABNF Definition of 3GPP Custom Headers | 17.2.0 | +| 2021-03 | CT#91e | CP-210058 | 0225 | - | A | Correction to API Prefix | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0215 | 2 | B | Update Binding Indication for multiple resource contexts | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0226 | - | F | Corrections to the description of the 3gpp-Sbi-discovery custom headers | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0235 | 1 | F | Usage of Via header | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0236 | 1 | F | Overload Control based on HTTP status codes | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0237 | - | D | Editorial Corrections | 17.2.0 | +| 2021-03 | CT#91e | CP-210034 | 0229 | - | F | Text style correction | 17.2.0 | +| 2021-06 | CT#92e | CP-211059 | 0242 | - | A | Correction to binding procedures | 17.3.0 | +| 2021-06 | CT#92e | CP-211059 | 0257 | - | A | SCP Redirect | 17.3.0 | +| 2021-06 | CT#92e | CP-211059 | 0263 | 1 | A | Requirements supported for Indirect Communication without Delegated Discovery | 17.3.0 | +| 2021-06 | CT#92e | CP-211059 | 0264 | 1 | A | Sending requests taking the binding level into account | 17.3.0 | +| 2021-06 | CT#92e | CP-211065 | 0255 | - | A | Match check between Token and CCA | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0238 | 1 | F | New header for requests sent to an (alternate) NF and overload control | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0239 | 2 | B | Enhancement of the supported communication options discovery | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0245 | 1 | F | 3GPP SBI Callback in Notification | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0247 | 1 | F | Clarification on NF Service Advertisement URI | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0248 | 1 | F | Detection and handling of message looping | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0249 | 1 | B | Load control and overload control for SEPP | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0253 | 1 | | Passing the NF Group ID to the NF service consumer for Indirect communication | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0258 | - | F | Incorrect CR implementation | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0260 | - | F | Implementation errors | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0261 | - | F | Service specific support of 409 status code for HTTP GET method | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0266 | 2 | F | Consumer Information for Direct Notification Report | 17.3.0 | +| 2021-06 | CT#92e | CP-211039 | 0267 | - | B | N5g-ddnmf Discovery Notifications | 17.3.0 | +| 2021-06 | CT#92e | CP-211046 | 0252 | 1 | F | Error handling for encBlockIndex | 17.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------------|--------| +| 2021-06 | CT#92e | CP-211059 | 0250 | - | F | OpenAPI Reference | 17.3.0 | +| 2021-09 | CT#93e | CP-212060 | 0272 | 1 | A | Discovery headers in service request with binding information | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0268 | - | F | Correct the examples of 3gpp-Sbi-Routing-Binding and 3gpp-Sbi-Binding | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0269 | 1 | F | SCP response in NRF error scenarios | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0270 | - | F | Via header encoding | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0274 | - | B | Feature Negotiation for Default Subscription | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0275 | 1 | F | NRF Uri for Callbacks | 17.4.0 | +| 2021-09 | CT#93e | CP-212055 | 0273 | - | F | Correction on 3gpp-Sbi-Callback | 17.4.0 | +| 2021-12 | CT#94e | CP-213088 | 0293 | - | A | Handling of 3gpp-Sbi-Sender-Timestamp and 3gpp-Sbi-Max-Rsp-Time in SEPP | 17.5.0 | +| 2021-12 | CT#94e | CP-213088 | 0295 | 1 | A | Correction to HTTP status code 307 and 308 | 17.5.0 | +| 2021-12 | CT#94e | CP-213086 | 0240 | 4 | B | Indicating in error responses whether a request was retransmitted by SCP | 17.5.0 | +| 2021-12 | CT#94e | CP-213086 | 0283 | 1 | B | 3GPP SBI Response Information | 17.5.0 | +| 2021-12 | CT#94e | CP-213086 | 0284 | 1 | B | NF Peer Information | 17.5.0 | +| 2021-12 | CT#94e | CP-213086 | 0285 | 1 | F | Multiple UE identities in 3gpp-Sbi-Correlation-Info HTTP header | 17.5.0 | +| 2021-12 | CT#94e | CP-213086 | 0286 | 1 | F | Invalid characters in headers using tchar common component in ABNF syntax | 17.5.0 | +| 2021-12 | CT#94e | CP-213086 | 0288 | - | F | NF Producer information sent to NF Consumer when using Delegated Discovery | 17.5.0 | +| 2021-12 | CT#94e | CP-213085 | 0276 | 1 | F | Mandating SCPs to support NF reselection for Model C/D delegated discovery | 17.5.0 | +| 2021-12 | CT#94e | CP-213085 | 0277 | 1 | B | Indicating possible use of OAuth2 authorization in 3gpp-Sbi-Nrf-Uri header | 17.5.0 | +| 2021-12 | CT#94e | CP-213085 | 0280 | 1 | F | 3gpp-Sbi-Correlation-Info in Indirect Communication with or without Delegated Discovery | 17.5.0 | +| 2021-12 | CT#94e | CP-213085 | 0281 | 1 | F | Correction on 3gpp-Sbi-Callback | 17.5.0 | +| 2021-12 | CT#94e | CP-213105 | 0278 | 1 | B | SBI message priority for MPS | 17.5.0 | +| 2021-12 | CT#94e | CP-213093 | 0287 | 1 | F | Notifying different NF Service consumer instance sharing same authority | 17.5.0 | +| 2021-12 | CT#94e | CP-213087 | 0289 | 1 | B | New application errors to indicate Congestion per service | 17.5.0 | +| 2021-12 | CT#94e | CP-213087 | 0290 | 1 | F | NF_FAILOVER and NF_SERVICE_FAILOVER from NF service consumer | 17.5.0 | +| 2021-12 | CT#94e | CP-213087 | 0297 | 2 | F | Event subscriptions with Inter PLMN and Intra PLMN callback URIs | 17.5.0 | +| 2022-03 | CT#95e | CP-220069 | 0300 | 2 | A | 3gpp-Sbi-Discovery-service-names header | 17.6.0 | +| 2022-03 | CT#95e | CP-220069 | 0309 | - | A | ABNF correction for binding header | 17.6.0 | +| 2022-03 | CT#95e | CP-220069 | 0315 | - | A | ABNF definition of the 3gpp-Sbi-Target-Nf-Id header | 17.6.0 | +| 2022-03 | CT#95e | CP-220069 | 0322 | - | A | Correction on Pseudo-header Setting | 17.6.0 | +| 2022-03 | CT#95e | CP-220023 | 0298 | 1 | F | Static Authorization | 17.6.0 | +| 2022-03 | CT#95e | CP-220023 | 0302 | 1 | B | 3gpp-Sbi-NF-Peer-Info header field | 17.6.0 | +| 2022-03 | CT#95e | CP-220023 | 0304 | - | F | HTTP Client Behaviour | 17.6.0 | +| 2022-03 | CT#95e | CP-220023 | 0305 | 1 | B | Group Binding for NF (Service) Levels | 17.6.0 | +| 2022-03 | CT#95e | CP-220023 | 0306 | 1 | B | Other-service Scope support to PDU Session resource for NIDD | 17.6.0 | +| 2022-03 | CT#95e | CP-220023 | 0307 | - | F | Producer ID for Indirect Communication without Delegated Discovery | 17.6.0 | +| 2022-03 | CT#95e | CP-220024 | 0303 | 1 | B | Avoidance of (re)selection of the target NF for Indirect Communication | 17.6.0 | +| 2022-03 | CT#95e | CP-220024 | 0316 | - | F | NF Type in User-Agent | 17.6.0 | +| 2022-03 | CT#95e | CP-220024 | 0323 | - | F | Corrections to the examples on API URI | 17.6.0 | +| 2022-03 | CT#95e | CP-220024 | 0325 | 1 | B | Retry with an Idempotency key for non-idempotent methods | 17.6.0 | +| 2022-03 | CT#95e | CP-220025 | 0312 | 1 | F | S-NSSAI encoding in the 3gpp-Sbi-Lci and 3gpp-Sbi-Oci headers' examples | 17.6.0 | +| 2022-03 | CT#95e | CP-220025 | 0317 | 1 | B | URL Encoding | 17.6.0 | +| 2022-03 | CT#95e | CP-220025 | 0326 | 3 | B | Usage indication over N32-f | 17.6.0 | +| 2022-03 | CT#95e | CP-220090 | 0301 | - | F | Editorial corrections | 17.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------|--------| +| 2022-03 | CT#95e | CP-220092 | 0299 | 1 | F | OpenAPI definition of 3gpp-Sbi-Discovery headers | 17.6.0 | +| 2022-03 | CT#95e | CP-220092 | 0310 | - | F | ABNF correction for max forwarding header | 17.6.0 | +| 2022-03 | CT#95e | CP-220092 | 0311 | - | F | SEPP Error Correction | 17.6.0 | +| 2022-06 | CT#96 | CP-221027 | 0327 | - | F | Corrections to Parameter Name in 3gpp-Sbi-Routing-Binding | 17.7.0 | +| 2022-06 | CT#96 | CP-221027 | 0329 | - | F | 3gpp-Sbi-Request-Info | 17.7.0 | +| 2022-06 | CT#96 | CP-221028 | 0335 | - | F | Access Token reuse in indirect communication with delegated discovery | 17.7.0 | +| 2022-06 | CT#96 | CP-221028 | 0330 | 2 | F | New values for the 3gpp-Sbi-Callback HTTP custom header | 17.7.0 | +| 2022-06 | CT#96 | CP-221045 | 0328 | - | F | Style correction | 17.7.0 | +| 2022-06 | CT#96 | CP-221045 | 0333 | 2 | F | Removing misplaced string | 17.7.0 | +| 2022-06 | CT#96 | CP-221045 | 0334 | - | F | Target NF type in notification request for NF service consumer reselection by SCP | 17.7.0 | +| 2022-09 | CT#97e | CP-222026 | 0337 | 2 | F | URL Encoding of data | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0344 | 1 | F | Binding Indication for the resource bound to a specific NF service instance | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0345 | 1 | F | Originating network ID | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0352 | 1 | F | Removal of Editor's NOTE | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0353 | 1 | F | Usage of 3gpp-Sbi-NF-Peer-Info HTTP header | 17.8.0 | +| 2022-09 | CT#97e | CP-222045 | 0340 | 1 | F | Load and Overload Control Information of an NF service instance | 17.8.0 | +| 2022-09 | CT#97e | CP-222045 | 0346 | - | F | Correct the order of parameters in 3gpp-Sbi-Producer-Id | 17.8.0 | +| 2022-09 | CT#97e | CP-222046 | 0341 | 1 | A | Redirection to an SCP or SEPP | 17.8.0 | +| 2022-09 | CT#97e | CP-222053 | 0349 | 1 | F | NF Producer Id for Resource Creation | 17.8.0 | +| 2022-09 | CT#97e | CP-222059 | 0351 | 1 | A | API version in URI setting in indirect communication | 17.8.0 | +| 2022-09 | CT#97e | CP-222061 | 0348 | 1 | A | Essential Correction on Headers in Indirect Communication | 17.8.0 | +| 2022-12 | CT#98e | CP-223041 | 0358 | - | F | Incomplete implementation of CR 29.500 #0353 | 17.9.0 | +| 2022-12 | CT#98e | CP-223041 | 0363 | 3 | F | Identifying the entity inserting 3gpp-Sbi-Originating-Network-Id | 17.9.0 | +| 2022-12 | CT#98e | CP-223027 | 0355 | 1 | F | Notification error handling | 18.0.0 | +| 2022-12 | CT#98e | CP-223027 | 0359 | 1 | F | Extending the problem details with supported API versions | 18.0.0 | +| 2022-12 | CT#98e | CP-223027 | 0362 | - | F | Standalone Notifications | 18.0.0 | +| 2022-12 | CT#98e | CP-223028 | 0357 | 1 | F | Feature negotiation for subscriptions to notifications occurring via an indirect path | 18.0.0 | +| 2022-12 | CT#98e | CP-223029 | 0356 | 2 | F | Restricting SCP to perform retries | 18.0.0 | +| 2022-12 | CT#98e | CP-223029 | 0360 | 2 | F | Extending the 3gpp-Sbi-Nrf-Callback URI with the NRF NFManagement API URI | 18.0.0 | +| 2022-12 | CT#98e | CP-223029 | 0365 | 3 | F | Clarification on error handling at SEPP | 18.0.0 | +| 2023-03 | CT#99 | CP-230091 | 0372 | - | A | NF Set ID encoding for an AMF set | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0375 | - | F | Binding created as part of a service request | 18.1.0 | +| 2023-03 | CT#99 | CP-230051 | 0367 | 1 | D | Correcting reference to RFC 1738 | 18.1.0 | +| 2023-03 | CT#99 | CP-230051 | 0368 | 1 | D | Clarification to URL Encoding of URI components | 18.1.0 | +| 2023-06 | CT#100 | CP-231086 | 0378 | - | A | Redirection to an SCP or SEPP | 18.2.0 | +| 2023-06 | CT#100 | CP-231029 | 0382 | 4 | F | Correction of ABNF rules | 18.2.0 | +| 2023-09 | CT#101 | CP-232072 | 0389 | 2 | A | ABNF rule of 3gpp-Sbi-Oci header | 18.3.0 | +| 2023-09 | CT#101 | CP-232061 | 0395 | - | A | Correlation-Info Header | 18.3.0 | +| 2023-09 | CT#101 | CP-232068 | 0393 | 1 | A | Client Credentials Assertion of the source NF service consumer | 18.3.0 | +| 2023-09 | CT#101 | CP-232073 | 0391 | - | A | S-NSSAI encoding in 3gpp-Sbi-Oci and 3gpp-Sbi-Lci headers | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0384 | - | B | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0385 | - | B | Binding indication with other-service scope from AMF to SMSF and PCF | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0386 | 1 | B | Access token with additional scopes for indirect com. with delegated discovery | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0387 | 1 | B | Prefix in Callback URIs | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0398 | - | F | Correction on NRF API URI | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0400 | 2 | F | 504 Gateway Timeout response including the problemDetails | 18.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------------------------------|--------| +| 2023-12 | CT#102 | CP-233027 | 0403 | - | B | ABNF definition and example of callback-uri-prefix in 3gpp-Sbi-Request-Info header | 18.4.0 | +| 2023-12 | CT#102 | CP-233027 | 0404 | - | F | HTTP requests redirected by SEPP | 18.4.0 | +| 2023-12 | CT#102 | CP-233028 | 0402 | 1 | F | Incorrect references to HTTP RFC 7230 obsoleted by IETF RFC 9110 | 18.4.0 | +| 2023-12 | CT#102 | CP-233028 | 0407 | 1 | F | ABNF Corrections | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0409 | - | F | Correction on the general description for overload | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0408 | 1 | F | Reserved characters in JSON attributes defined as URI and in HTTP header parameters defined as URI or path-absolute | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0412 | - | F | Encoding for String Type JSON Attributes | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 0410 | 2 | F | Essential Correction on Notification URIs of Reselected NF Consumers | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 0411 | 1 | B | New protocol error for the rejection due to target PLMN not reachable | 18.4.0 | +| 2023-12 | CT#102 | CP-233062 | 0406 | 1 | A | 3gpp-Sbi-Consumer-Info Header | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29501/raw.md b/raw/rel-18/29_series/29501/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e95a240a408f514d60ac6e20678316a94b90456a --- /dev/null +++ b/raw/rel-18/29_series/29501/raw.md @@ -0,0 +1,3804 @@ + + +# 3GPP TS 29.501 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Principles and Guidelines for Services Definition; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 9 | +| 3.3 Special characters, operators and delimiters ..... | 9 | +| 3.3.1 General ..... | 9 | +| 3.3.2 ABNF operators..... | 9 | +| 3.3.3 URI reserved and special characters..... | 9 | +| 3.3.4 SBI specific usage of delimiters..... | 10 | +| 4 Design Principles for 5GC SBI APIs..... | 10 | +| 4.1 General Principles ..... | 10 | +| 4.2 API Design Style and REST Implementation Levels ..... | 11 | +| 4.2.1 General ..... | 11 | +| 4.2.2 API Design Principles for Query Operation..... | 11 | +| 4.2.3 API Design Principles for Delete Operation ..... | 11 | +| 4.3 Version Control..... | 12 | +| 4.3.0 General ..... | 12 | +| 4.3.1 Structure of API version numbers ..... | 12 | +| 4.3.1.1 API version number format ..... | 12 | +| 4.3.1.2 Rules for incrementing field values ..... | 12 | +| 4.3.1.3 Visibility of the API version number fields..... | 16 | +| 4.3.1.4 Relation to the Technical Specification version number..... | 16 | +| 4.3.1.5 Discovery of the supported versions..... | 16 | +| 4.3.1.6 Withdrawing API versions..... | 17 | +| 4.4 URI Structure ..... | 17 | +| 4.4.1 Resource URI structure ..... | 17 | +| 4.4.2 Custom operations URI structure ..... | 18 | +| 4.4.3 Callback URI structure ..... | 18 | +| 4.5.1 Resource Representation ..... | 18 | +| 4.5.2 Content Format Negotiation ..... | 19 | +| 4.6 Use of HTTP Methods ..... | 19 | +| 4.6.1 Use of Request/Response Communication ..... | 19 | +| 4.6.1.1 CRUD ..... | 19 | +| 4.6.1.1.1 Creating a Resource ..... | 19 | +| 4.6.1.1.2 Reading a Resource..... | 21 | +| 4.6.1.1.3 Updating a Resource ..... | 22 | +| 4.6.1.1.4 Deleting a Resource ..... | 24 | +| 4.6.1.1.5 Query Parameters ..... | 24 | +| 4.6.1.2 Custom Operations ..... | 25 | +| 4.6.1.3 Use of Asynchronous Operations ..... | 26 | +| 4.6.1.4 Special provisions to support the seamless change of AMF as NF service producer ..... | 27 | +| 4.6.2 Use of Subscribe/Notify Communication ..... | 27 | +| 4.6.2.1 General..... | 27 | +| 4.6.2.2 Management of Subscriptions ..... | 28 | +| 4.6.2.2.1 General ..... | 28 | +| 4.6.2.2.2 Creation of a Subscription..... | 28 | +| 4.6.2.2.3 Modify a subscription..... | 29 | +| 4.6.2.2.4 Delete a subscription ..... | 30 | +| 4.6.2.3 Notifications..... | 31 | +| 4.6.2.4 Special provisions to support the seamless change of AMF as NF service consumer ..... | 32 | +| 4.7 HATEOAS ..... | 32 | +| 4.7.1 General ..... | 32 | +| 4.7.2 3GPP hypermedia format ..... | 32 | + +| | | | +|---------|----------------------------------------------------------------------------------|----| +| 4.7.2.1 | Basic 3GPP hypermedia format..... | 32 | +| 4.7.2.2 | Extended 3GPP hypermedia format ..... | 33 | +| 4.7.3 | Advertising legitimate application state transitions..... | 34 | +| 4.7.4 | Inferring link relation semantic ..... | 34 | +| 4.7.5 | Common Relation Types..... | 34 | +| 4.7.5.1 | Introduction..... | 34 | +| 4.7.5.2 | Registered relation types..... | 34 | +| 4.7.5.3 | Extension relation types..... | 35 | +| 4.7.6 | Negotiating the support of optional HATEOAS features..... | 35 | +| 4.8 | Error Responses..... | 35 | +| 4.8.1 | Error Response Status Code ..... | 35 | +| 4.8.2 | Error Response Body..... | 35 | +| 4.8.3 | Extending ProblemDetails for API Backward Compatibility ..... | 36 | +| 4.9 | Transferring multiple resources to a NF Service Consumer ..... | 37 | +| 4.9.1 | General ..... | 37 | +| 4.9.2 | Direct Delivery ..... | 37 | +| 4.9.3 | Direct Delivery with Iterations ..... | 37 | +| 4.9.4 | Indirect Delivery..... | 39 | +| 4.9.5 | Indirect Delivery with HTTP/2 Server Push ..... | 39 | +| 4.9.6 | Criteria for choosing the transfer method..... | 41 | +| 4.10 | Scopes definition for OAuth2.0 access token ..... | 41 | +| 5 | Documenting 5GC SBI APIs ..... | 42 | +| 5.1 | Naming Conventions..... | 42 | +| 5.1.1 | Case Conventions ..... | 42 | +| 5.1.2 | API Naming Conventions..... | 43 | +| 5.1.3 | Conventions for URI Parts ..... | 43 | +| 5.1.3.1 | Introduction..... | 43 | +| 5.1.3.2 | URI Path Segment Naming Conventions ..... | 44 | +| 5.1.3.3 | URI Query Naming Conventions ..... | 44 | +| 5.1.4 | Conventions for Names in Data Structures ..... | 45 | +| 5.2 | API Definition ..... | 45 | +| 5.2.1 | Resource Structure..... | 45 | +| 5.2.2 | Resources and HTTP Methods ..... | 47 | +| 5.2.3 | Representing RPC as Custom Operations on Resources..... | 49 | +| 5.2.3A | Notifications ..... | 50 | +| 5.2.4 | Data Models..... | 52 | +| 5.2.4.1 | General..... | 52 | +| 5.2.4.2 | Structured data types..... | 53 | +| 5.2.4.3 | Simple data types and enumerations..... | 54 | +| 5.2.4.4 | Binary Data ..... | 55 | +| 5.2.4.5 | Data types describing alternative data types or combinations of data types ..... | 55 | +| 5.2.5 | Void..... | 56 | +| 5.2.6 | 3GPP Custom HTTP Headers ..... | 56 | +| 5.3 | OpenAPI specification files ..... | 56 | +| 5.3.1 | General ..... | 56 | +| 5.3.2 | Formatting of OpenAPI specification files..... | 57 | +| 5.3.3 | Info ..... | 57 | +| 5.3.4 | externalDocs ..... | 57 | +| 5.3.5 | Servers ..... | 58 | +| 5.3.6 | References to other 3GPP-defined OpenAPI specification files ..... | 58 | +| 5.3.7 | Server-initiated communication ..... | 59 | +| 5.3.8 | Describing the body of HTTP PATCH requests ..... | 60 | +| 5.3.8.1 | General..... | 60 | +| 5.3.8.2 | JSON Merge Patch..... | 60 | +| 5.3.8.3 | JSON PATCH..... | 61 | +| 5.3.9 | Structured data types ..... | 61 | +| 5.3.10 | Data types describing alternative data types or combinations of data types ..... | 63 | +| 5.3.11 | Error Responses..... | 65 | +| 5.3.12 | Enumerations..... | 66 | +| 5.3.13 | Formatting of structured data types in query parameters ..... | 67 | +| 5.3.14 | Attribute Presence Conditions..... | 67 | + +| | | | +|-------------------------------|-----------------------------------------------------------------|-----------| +| 5.3.15 | Usage of the "tags" field..... | 69 | +| 5.3.16 | Security ..... | 70 | +| 5.3.17 | Reuse of Structured Data Types ..... | 72 | +| 5.3.18 | Operation identifiers ..... | 72 | +| 5.3.19 | Formatting of description fields ..... | 73 | +| 6 | Requirements for secure API design..... | 73 | +| 6.1 | Introduction ..... | 73 | +| 6.2 | General ..... | 73 | +| 6.3 | SBA-specific requirements ..... | 74 | +| Annex A (informative): | TS Skeleton Template ..... | 75 | +| Annex B (informative): | Backward Incompatible Changes ..... | 75 | +| Annex C (Informative): | Resource modelling ..... | 76 | +| C.0 | General..... | 76 | +| C.1 | Document..... | 76 | +| C.2 | Collection..... | 76 | +| C.3 | Store ..... | 77 | +| C.4 | Custom operation ..... | 77 | +| Annex D (informative): | Example of an OpenAPI specification file for Patch ..... | 78 | +| Annex E (Informative): | Considerations for handling of JSON arrays ..... | 80 | +| Annex F (informative): | Change history..... | 83 | + +# Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document defines design principles and documentation guidelines for 5GC SBI APIs. These principles and guidelines should be followed when drafting the 5G System SBI Stage 3 specifications. + +# --- 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 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [3] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [4] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [5] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [6] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [7] IETF RFC 7396: "JSON Merge Patch". +- [8] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [9] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [10] IETF RFC 5789: "PATCH Method for HTTP". +- [11] IETF RFC 8288: "Web Linking". +- [12] IANA: "HTTP Status Code Registry at IANA", . +- [13] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [14] Fielding, Roy Thomas. Architectural Styles and the Design of Network-based Software Architectures. Doctoral dissertation, University of California, Irvine, 2000. +- [15] Erik Wilde, Cesare Pautasso, REST: From Research to Practice, Springer. +- [16] YAML 1.2: "YAML Ain't Markup Language", . + +- [17] Semantic Versioning Specification: . +- [18] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [19] IETF RFC 9457: "Problem Details for HTTP APIs". +- [20] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". +- [21] 3GPP TS 29.509: "5G System; Authentication Server Services; Stage 3". +- [22] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [23] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [24] 3GPP TS 29.573: "5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3". +- [25] 3GPP TR 21.900: "Technical Specification Group working methods". +- [26] IETF RFC 5234: "Augmented BNF for Syntax Specifications: ABNF". +- [27] 3GPP TS 23.003: "Numbering, addressing and identification". +- [28] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". + +# --- 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]. + +**Absolute URI:** Absolute URI follows generic URI syntax and consists of a hierarchical sequence of the following components: the "scheme", "authority", "path" and "query", i.e. excluding the "fragment" component. See clause 4.3 in IETF RFC 3986 [9]. + +**apiRoot:** apiRoot follows an absolute URI syntax, but excludes the following absolute URI identifiers: the "query" and "fragment" components. The API root contains the "scheme" and the "authority" components and may also contain an API prefix subcomponent. See clause 4.4.1. In 3GPP APIs, the default apiRoot value is "https://example.com" (see e.g. Annex A.2 in 3GPP TS 29.502 [20]), where "example.com" is replaced by the operator specific FQDN (for FQDN examples see clause 28.3.2 in 3GPP TS 23.003 [27]). + +**API Prefix:** API prefix is an optional, deployment-specific string, which is a subcomponent of the "apiRoot". API prefix format follows "path-absolute" syntax and that starts with a "/" reserved character (see clause 4.4.1 and also clause 3.3 in IETF RFC 3986 [9]). In 3GPP APIs, the default apiRoot does not contain API Prefix (see e.g. Annex A.2 in 3GPP TS 29.502 [20]). + +**API URI:** API URI has the following format: "{apiRoot}//". For more details see clause 4.4.1. As an example, for the Nudm\_SDM API defined in 3GPP TS 29.503 [28], the API URI is: "{apiRoot}/nudm-sdm/v2". + +**Base URI:** Base URI is used as a reference against which the relative URI reference is applied. See clause 4.6.1.1.1.2 and also clause 5.1 in IETF RFC 3986 [9]. As an example, for the resource URI of the SM contexts collection that is defined in Nsmf\_PDUSession API (see 3GPP TS 29.502 [20]), the base URI is "{apiRoot}/nsmf-pdusession/". + +**Callback URI:** Callback URI follows an absolute URI syntax, but excludes the following absolute URI identifiers: "userinfo" subcomponent of the "authority" component and also the "query" component ("fragment" component is already excluded from the absolute URI). Therefore, callback URI contains the "scheme", "authority" (excluding "userinfo" subcomponent) and the "path" components. See clause 4.4.3. As an example, for the Nsmf\_PDUSession API defined in 3GPP TS 29.502 [20], "smContextStatusUri" is one of the callback references that can be provided by the NF Service Consumer. A complete callback URI for the "smContextStatusUri" has the following structure + +//smContextStatus>, where "consumer-host" is either an FQDN or an IP address (see clause 4.4.3). + +**Relative path after API URI:** Refers to the sequence of path segments of a resource URI that are below the API URI (see the definition of the "Paths Object" in OpenAPI specification [4]). When appended to the API URI of the concerned API, it constitutes the resource URI. As an example, for the Nudm\_SDM API defined in 3GPP TS 29.503 [28] for which the API URI is "{apiRoot}/nudm-sdm/v2", the "relative path after API URI" for the "AccessAndMobilitySubscriptionData" resource is:("/{supi}/am-data". + +**Relative URI:** Relative URI is deprecated and shall not be used in SBI specifications. See clause 1.2.3 in IETF RFC 3986 [9]. + +**Resource URI:** Resource URI identifies an abstract or a physical resource. See the Abstract of the IETF RFC 3986 [9]. In this specification this generally means "an URI of a resource". Resource URI structure is defined in clause 4.4.1. As an example, for the resource URI of the SM contexts collection that is defined in Nsmf\_PDUSession API (see 3GPP TS 29.502 [20]), the resource URI is "{apiRoot}/nsmf-pdusession//sm-contexts". + +## 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]. + +| | | +|---------|-----------------------------------------------| +| 5GC | 5G Core Network | +| CNF | Conjunctive Normal Form | +| CRUD | Create, Read, Update, Delete | +| DNF | Disjunctive Normal Form | +| HAL | Hypertext Application Language | +| HATEOAS | Hypermedia as the Engine of Application State | +| REST | REpresentational State Transfer | +| RPC | Remote-Procedure-Call | +| SBI | Service Based Interface | +| YAML | YAML Ain't Markup Language | + +## 3.3 Special characters, operators and delimiters + +### 3.3.1 General + +A number of characters have special meaning and are used as delimiters in this document and also in other stage 3 SBI specifications. Below clauses specify the usage of a selected set of the special characters. Full set of these special characters are specified in the respective IETF specifications. + +### 3.3.2 ABNF operators + +Special characters that are used as delimiters in ABNF syntax have somewhat different purpose from the same characters when used by URI syntax. See clause 3.3.2 in 3GPP TS 29.500 [2]. + +### 3.3.3 URI reserved and special characters + +| | | +|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| / | Reserved character. The forward slash character is a delimiter, which precedes an URI path component and also separates a sequence of path segments. See clauses 2.2 and 3.3 in IETF RFC 3986 [9]. | +| # | Reserved character. The number sign (hash) character is a delimiter, which terminates either an URI path component, or an authority component, or a query component and starts a fragment component. See clauses 2.2, 3.2, 3.3 and 3.5 in IETF RFC 3986 [9]. | +| ? | Reserved character. The question mark character is a delimiter, which terminates either an URI path component, or an authority component and starts a query component/parameter. See clauses 2.2, 3.2, 3.3 and 3.4 in IETF RFC 3986 [9]. | +| = | Reserved character. The equal sign character is a delimiter, which separates a parameter name and its value, e.g. in an URI query. See clauses 1.2.3 and 3.3 in IETF RFC 3986 [9]. | + +| | | +|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [ ] | Reserved character. The square bracket characters enclose an IPv6 literal address. This is the only place where square bracket characters are allowed in the URI syntax. See clause 3.2.2 in IETF RFC 3986 [9]. | +| < > | Special characters. The angle bracket characters are delimiters and enclose a complete URI or an URI component or a subcomponent. See Appendix C in IETF RFC 3986 [9]. | +| ; | Reserved character. The semicolon character is a delimiter, which is often used to separates a parameter name and its value in a path segment. See clause 3.3 in IETF RFC 3986 [9]. | +| : | Reserved character. The colon character is a delimiter, which either terminates an URI scheme component, or userinfo subcomponent, or separates host subcomponent from the port subcomponent, an authority component, or a query component and starts a fragment component. See clauses 2.2, and 3.2 in IETF RFC 3986 [9]. | + +NOTE: The same characters, like "/", "#", etc. lead to different processing in ABNF and URI grammars. For instance, in URI syntax, ";" character separates parameter and its value, while in ABNF ";" starts a comment. + +### 3.3.4 SBI specific usage of delimiters + +The braces (curly brackets) are used as delimiters across the SBI specifications, but have somewhat different purpose as specified below. + +| | | +|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| { } | Delimiters. The braces (curly brackets) characters enclose a name of a variable in an URI path segment (see clause 5.1.3.2). Example: .../subscriber-data/{supi}. | +| { } | Delimiters. The braces (curly brackets) characters enclose a parameter value in a query (see clause 5.1.3.3). Example: ?nf-id={chooseAValue} | + +NOTE: In SBI specifications, "<>" is a generic placeholder, while "{ }" enclose specifically a variable. + +# 4 Design Principles for 5GC SBI APIs + +## 4.1 General Principles + +Each 5GC SBI API specification should include the following information for each specified service: + +- Purpose of the API; +- URIs of resources; +- Supported HTTP methods for a given resource; +- Supported representations (e.g. JSON, see IETF RFC 8259 [3]); +- Request body schema(s) (where applicable); +- Response body schema(s) (where applicable); +- Supported response status codes; +- Relation types supported if HATEOAS is implemented by the API; +- A reference in the resource description clause to one of the archetypes defined in Annex C if the resource design matches one of them; and +- A list defining identifiers of optional features (see clause 6.6 of 3GPP TS 29.500 [2] for related procedures). + +For each specified service a clause to a normative Annex should be provided containing the OpenAPI definitions according to OpenAPI Specification [4] for the service. The specifications should state that content of this normative annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +The TS Skeleton Template as provided in Annex A should be used as a starting point when drafting 5GC SBI API specifications. + +Common procedures, HTTP extensions and error handling applicable to several 5GC SBI API specifications should be defined in 3GPP TS 29.500 [2] and should be referenced from individual 5GC SBI API specifications. + +Common data types applicable to several 5GC SBI API specifications should be defined in 3GPP TS 29.571 [5] and should be referenced from individual 5GC SBI API specifications. + +## 4.2 API Design Style and REST Implementation Levels + +### 4.2.1 General + +5GC SBI API specifications should apply a protocol design framework as follows: + +- a) REST-style service operations should implement the Level 2 of the Richardson maturity model, with standard HTTP methods, whenever it is a good match for the style of interaction to model, e.g. service operations that can naturally map to one of the standard methods (CRUD operations), this should be the preferred modelling attempt; +- b) service operations may use custom API operations (RPC-style interaction), when it is seen a better fit for the style of interaction to model, e.g. non-CRUD service operations; +- c) it is possible to mix REST-style operations and RPC-style operations in the same API. + +NOTE: Level 3 (HATEOAS) of the Richardson maturity model in the 5G Service-Based Architecture can be implemented by an API but is optional. Hypermedia usage guidelines are provided in clause 4.7 of the present specification. + +### 4.2.2 API Design Principles for Query Operation + +When designing a query operation API, i.e. the NF service consumer invokes the API aiming to retrieve certain information from the NF service producer, the following principles should be applied: + +- a) if the query operation does not require any input parameter for the NF service producer, then the REST-style service operation with standard HTTP GET method should be used (see clause 4.6.1.1.2); +- b) if + - the query operation requires input parameter(s) for the NF service producer; and + - all the required input parameter(s) are used to identify a particular resource and/or control the content of the result of the query operation; + +then the REST-style service operation with standard HTTP GET method should be used (see clause 4.6.1.1.2); + +- c) standard HTTP GET method shall not be used for non-safe operations and non-idempotent operations. + +### 4.2.3 API Design Principles for Delete Operation + +When designing a delete operation API, i.e. the NF service consumer invokes the API aiming to delete certain resource on the NF service producer, the following principles should be applied: + +- a) if the delete operation does not require any input parameter for the NF service producer, then the REST-style service operation with standard HTTP DELETE method should be used (see clause 4.6.1.1.4); +- b) if + +- the delete operation requires input parameter(s) for the NF service producer; and +- all the required input parameter(s) are used to identify a particular resource and/or control the content of the result of the delete operation; + +then the REST-style service operation with standard HTTP DELETE method should be used (see clause 4.6.1.1.4); + +- c) standard HTTP DELETE method shall not be used for non-idempotent operations. + +## 4.3 Version Control + +### 4.3.0 General + +The version control mechanism in the present clause allows the management of changes to an API and provides a version number that is incremented whenever changes to the API are applied. + +NOTE: The version number does not reflect the usage of optional features. A mechanism to negotiate the usage of optional features is defined in clause 6.6 of 3GPP TS 29.500 [2]. + +### 4.3.1 Structure of API version numbers + +#### 4.3.1.1 API version number format + +API version numbers shall consist of at least 3 fields, following a MAJOR.MINOR.PATCH pattern according to the Semantic Versioning Specification [17]. + +The 1st Field (MAJOR), the 2nd Field (MINOR), and the 3rd Field (PATCH) shall contain unsigned integer numbers, and they shall not contain leading zeroes. + +An additional field (called "pre-release version" in Semantic Versioning Specification [17]) is added to denote an OpenAPI version under development, i.e. prior to the freeze of the corresponding OpenAPI description for a given 3GPP Release. This additional field is appended after the 3 first version fields using the hyphen "-" character and shall have the format "alpha.n", where "n" is an unsigned integer number without leading zeroes. + +NOTE: An OpenAPI is referred to as "non-frozen", if for a given 3GPP Release the OpenAPI freeze milestone was not reached. Otherwise, an OpenAPI is referred to as "frozen". + +After the freeze of a 3GPP Release, additional fields (called "build metadata" in Semantic Versioning Specification [17]), containing operator-specific version information, may be appended after the 3 first version fields using the plus sign "+" character and they shall consist of a list of dot-separated identifiers, where each identifier may contain only alphanumeric characters and hyphens ([0-9A-Za-z-]). + +NOTE: Operator-specific version information are ignored when determining version precedence. Thus, two versions that differ only in the operator-specific version information, have the same precedence. + +##### EXAMPLES: + +"1.0.0-alpha.1" + +"3.0.1+orange.2020-09" + +#### 4.3.1.2 Rules for incrementing field values + +The first version of a new API under development shall obtain the version number "1.0.0-alpha.1". At the first publication of the 3GPP Technical Specification defining the API after the OpenAPI freeze of the first 3GPP Release that contains the API, the version number of the API shall be set to "1.0.0". + +When a new version of the 3GPP TS containing OpenAPI file(s) is published, the fields of the corresponding API version number(s) shall be incremented according to the following rules: + +- The 1st Field (MAJOR) shall be incremented only if the applied change is backward incompatible relative to the earlier, i.e. frozen version of the given OpenAPI (see the details below). For a non-frozen OpenAPI, the first backwards incompatible change relative to the latest frozen version triggers incrementing the 1st Field (MAJOR), while subsequent backwards incompatible changes do not increment the value, until the OpenAPI stays non-frozen. When the 1st Field (MAJOR) is incremented, this impacts the lower level fields as follows: + - The 2nd Field (MINOR) shall be reset to "0"; + - The 3rd Field (PATCH) shall be reset to "0"; + - The 4th Field (NON-FROZEN), if present shall be reset to "alpha.1" (this field is removed when the OpenAPI freezes). + +The 2nd Field (MINOR) shall be incremented only if the applied change is a backward compatible new feature relative to the earlier, i.e. frozen version of the given OpenAPI (see the details below). For a non-frozen OpenAPI, the first backwards compatible change relative to the latest frozen version triggers incrementing the 2nd Field (MINOR), while subsequent backwards incompatible changes do not increment the value, until the OpenAPI stays non-frozen. When the 2nd Field (MINOR) is incremented, this impacts the lower level fields as follows: + +- The 3rd Field (PATCH) shall be reset to "0"; +- The 4th Field (NON-FROZEN), if present shall be reset to "alpha.1" (this field is removed when the OpenAPI freezes). + +The 3rd Field (PATCH) shall be incremented only if the applied change is a backward compatible correction relative to the earlier, i.e. frozen version of the given OpenAPI (see the details below). For a non-frozen OpenAPI, the first backwards compatible change relative to the latest frozen version triggers incrementing the 3rd Field (PATCH), while subsequent backwards incompatible changes do not increment the value, until the OpenAPI stays non-frozen. When the 3rd Field (PATCH) is incremented, this impacts the lower level field as follows: + +- The 4th Field (NON-FROZEN), if present shall be reset to "alpha.1" (this field is removed when the OpenAPI freezes). +- The 4th Field (NON-FROZEN), if present shall be incremented in a non-frozen OpenAPI every time any kind of changes are applied the given non-frozen OpenAPI (see the details below). This field is removed when the OpenAPI freezes. + +##### 1st Field (MAJOR): + +- This numerical field shall be incremented when: + - a) there are one or more backward incompatible changes to the API after the OpenAPI freeze for a given 3GPP Release; and + - b) there are the first backward incompatible change(s) to the existing API with respect to the latest version in the previous 3GPP Release while a 3GPP Release is under development (i.e. prior to the OpenAPI freeze for a given 3GPP Release). + +EXAMPLE 1: Assuming that 3GPP Rel-16 under development contains API version "1.1.0-alpha.2", and a backward incompatible change with respect to the latest version in the previous 3GPP Release is applied to that API before the OpenAPI freeze, the new Rel-16 API version is "2.0.0-alpha.1". + +NOTE 1: Subsequent changes in a given 3GPP Release under development do not lead to increment of the 1st field (MAJOR) and 2nd field (MINOR). + +NOTE 2: Rules for determining backward incompatible changes are provided in Annex B. + +NOTE 3: It is recommended to avoid backward incompatible change to the API after the OpenAPI freeze whenever possible, especially after OpenAPI freeze of a succeeding Release. It is preferable to introduce such changes only in the 3GPP Release under development. + +- If a backward incompatible change needs to be applied to several 3GPP Releases the following applies: + +- a) If the 3GPP Releases contain different MAJOR versions of the same API, a new MAJOR API version shall be assigned to each 3GPP Release in the order of those 3GPP Releases in such a manner that the lowest of those 3GPP Releases shall obtain the first unassigned MAJOR version value. + +EXAMPLE 2: Assuming that 3GPP Rel-15 contains API version "1.0.0", and Rel-16 contains API version "2.0.0", and that the same backward incompatible change is applied to that API in both Releases, the new Rel-15 API version is "3.0.0" and the new Rel-16 API version is "4.0.0". + +- b) If the 3GPP Releases contain the same MAJOR version but different MINOR versions of the same API, a single new MAJOR API version value shall be assigned for all those 3GPP Releases, unless other backward incompatible changes only applied to some of those Releases require the creation of separate MAJOR versions. + +NOTE 4: For each such Release a new MINOR version is assigned. + +EXAMPLE 3: Assuming that 3GPP Rel-15 and Rel-16 contain API version "1.0.0", and Rel-17 contains API version "1.2.0", and that the same backward incompatible change is applied to that API in all 3GPP Releases, the new 3GPP Rel-15 and Rel-16 API version is "2.0.0" and the new 3GPP Rel-17 API version is "2.2.0". + +- c) If the 3GPP Releases contain the same API versions, a single new API version shall be assigned for all those 3GPP Releases, unless other changes only applied to some of those Releases require the creation of separate versions. + +EXAMPLE 4: Assuming that 3GPP Rel-15 and 3GPP Rel-16 contain API version "1.0.0", and that only the same backward incompatible change is applied to that API in both 3GPP Releases, the new 3GPP Rel-15 and Rel-16 API version is "2.0.0". + +EXAMPLE 5: Assuming that 3GPP Rel-15 and Rel-16 contain API version "1.0.0", and that the same backward incompatible change is applied to that API in both Releases and an additional backward compatible change is applied in 3GPP Rel-16, the new 3GPP Rel-15 API version is "2.0.0", and the 3GPP Rel-16 API version is "2.1.0". + +EXAMPLE 6: Assuming that 3GPP Rel-15 and Rel-16 contain API version "1.0.0", and that the same backward incompatible change is applied to that API in both Releases and an additional backward incompatible change is applied in 3GPP Rel-16, the new 3GPP Rel-15 API version is "2.0.0", and the 3GPP Rel-16 API version is "3.0.0". + +##### 2nd Field (MINOR): + +- This numerical field shall be incremented when: + +- a) there are the first one or more backward compatible changes not corresponding to changes to earlier 3GPP Releases (i.e. changes introduced by 3GPP CR with other categories than "mirror") to the same API in a given 3GPP Release without any prior backward incompatible changes in that Release. If the same 1st field (MAJOR) and the 2nd field (MINOR) are assigned to $n$ previous 3GPP Releases, a MINOR version number shall be reserved for each intermediate 3GPP Release for possible subsequent changes in that Release and the MINOR version number shall be incremented by $n$ ; and + +EXAMPLE 7: Assuming that 3GPP Rel-15 and Rel-16 contain API version "1.0.0" (because there were no changes to the API in Rel-16), and in Rel-17 the first backward compatible new feature is added before the OpenAPI freeze, the API version "1.2.0-alpha.1" is assigned to Rel-17. + +- b) there are one or more subsequent backward compatible additions of features not corresponding to changes to previous 3GPP Releases to the API in a frozen 3GPP Release before a higher MINOR number has been allocated for the same MAJOR version (for a subsequent Release). + +- This field shall be reset to "0" if the 1st field (MAJOR) is changed, unless a backward incompatible change needs to be applied to several 3GPP Releases that already contain the same MAJOR but different MINOR API versions. In that case a single new major API version is assigned, and for each such 3GPP Release with an own MINOR version, a new MINOR version shall be assigned, starting with MINOR version "0" for the lowest such Release, and reserving a MINOR version number for each intermediate Release without an own MINOR version. (see Example 3) + +NOTE 5: In most cases the MINOR version is incremented when new backward compatible features are added in a 3GPP Release. In rare cases, where only backward compatible changes not corresponding to changes to previous 3GPP Releases are applied to a 3GPP Release, the MINOR version is also incremented. It is recommended to avoid such changes in 3GPP Releases without added functionality whenever possible. + +NOTE 6: Subsequent backward compatible changes in a given 3GPP Release before OpenAPI freeze do not lead to an increment of the 2nd field (MINOR). + +NOTE 7: Changes corresponding to changes in previous 3GPP Releases do not lead to an increment of the 2nd field (MINOR). + +NOTE 8: If two 3GPP Releases are under parallel development (because the work on Rel-*X+1* has commenced before the OpenAPI freeze of Rel-*X*), the corresponding APIs will obtain distinct values of the 1st field (MAJOR) or 2nd field (MINOR). + +EXAMPLE 8: Assuming that an API was introduced with version "1.0.0" in Rel-15, and that the Rel-16 version is "1.1.0-alpha.5" because the OpenAPI is not yet frozen in Rel-16, and that a new backward compatible Rel-17 feature is added, the Rel-17 API version is "1.2.0-alpha.1". + +##### 3rd Field (PATCH): + +- This numerical field shall be incremented: + - a) if the changes are only one or more backward-compatible corrections (but no changes requiring an update of the 1st field (MAJOR) or of the 2nd field (MINOR) are made to the API after the OpenAPI freeze of a 3GPP Release; and + - b) if one or more backward compatible additions of features, but no changes requiring an update of the 1st field (MAJOR) or of the 2nd field (MINOR), are made to the API after the OpenAPI freeze of a 3GPP Release and after the assignment of a MINOR version to a higher 3GPP Release. +- This field shall be reset to "0" if the 1st field (MAJOR) or 2nd field (MINOR) is changed. + +NOTE 9: Before the OpenAPI freeze for a given 3GPP Release, the 3rd field (PATCH) will not be incremented. + +NOTE 10: If the 1st field (MAJOR) and 2nd field (MINOR) were not incremented between 3GPP Releases (because there were no added features and no backward incompatible changes), and the same backward compatible changes are then applied to those 3GPP Releases, the API files in those 3GPP Releases are identical and will obtain the same API version number. + +NOTE 11: In rare cases for which a new backward compatible functionality needs to be added in an older 3GPP Release after the OpenAPI freeze and work on that API already started in a later Release, the new functionality is exceptionally introduced as a PATCH correction and a new supported feature could be defined accordingly. + +##### The 4th Field (NON-FROZEN and/or OPERATOR-SPECIFIC): + +- The 4th Field may or may not be present, based on the following conditions. +- NON-FROZEN type. The presence of this field type depends on the OpenAPI status, as follows: + - The 4th Field (NON-FROZEN) shall be present before the OpenAPI freeze of a 3GPP Release. An additional field (separated from the 3 first version fields by a hyphen "-" character) shall be supplied as follows: + - a) When the 1st field (MAJOR) or 2nd field (MINOR) is incremented before the OpenAPI freeze of a 3GPP Release, this field shall obtain the value "alpha.1". + - b) The numerical value "*n*" within the field value "alpha.*n*" shall be incremented if one or more subsequent changes (either backward incompatible, or backward compatible) are made to the given non-frozen OpenAPI. + - The 4th Field (NON-FROZEN) shall not be present after the OpenAPI freeze of a 3GPP Release., this additional field (including the hyphen "-" character) containing pre-release version info is removed from the API version. + +- OPERATOR-SPECIFIC type that represents operator-specific version field(s). The presence of these fields depends on the OpenAPI status, and the operator preferences: + - The 4th Field (OPERATOR-SPECIFIC) shall be present after the OpenAPI freeze of a 3GPP Release. Additional fields may be supplied based on operator policy after the 3 first version fields and separated by a plus sign "+" character. The rules for setting, or incrementing, such fields are out of the scope of 3GPP, but they shall comply with the rules described in the Semantic Versioning Specification [17], and contain a list of dot-separated labels within the allowed character set ([0-9A-Za-z-]). + +If no change is applied to an API in a new published TS version, the API version number shall not be incremented unless the additional field ("-alpha.n") needs to be removed at OpenAPI freeze. This also applies if the TS is published in a new 3GPP Release. + +NOTE 12: OpenAPI files can contain references to other OpenAPI files. Changes to referenced parts of such other OpenAPI files need to be considered when determining if and how to update an API version. + +NOTE 13: The API version number of those version fields managed by 3GPP is incremented using 3GPP change requests. + +#### 4.3.1.3 Visibility of the API version number fields + +The API version shall be indicated in the resource URI of every API, as described in clause 4.4.1. + +The API version shall be indicated as the concatenation of the letter "v" and the 1st field (MAJOR) of the API version number. + +The other fields shall not be included in the resource URI. + +NOTE: Including these digits in the URI would force the NF service consumer to select a specific sub-version, at the risk of seeing the request rejected if the NF service provider does not support it, while the request could have been served by ignoring unknown elements. + +The full API version number (i.e., containing all the fields) shall be visible in the OpenAPI specifications, in the "version" subfield of the "info" field, as described in clause 5.3.3. + +#### 4.3.1.4 Relation to the Technical Specification version number + +There is no one-to-one mapping between an API version number and the version number of the 3GPP Technical Specification defining this API. + +A 3GPP Technical Specification specifies one or more APIs, which may have different versions. + +A change in the 3rd field (PATCH) of a 3GPP TS version number (i.e. an editorial change) should not lead to a change in the version number of the APIs specified in the 3GPP TS. + +A change in the 1st field (MAJOR) and 2nd fields (MINOR) of the 3GPP TS version number is likely to lead to at least a change in the minor version number of the APIs specified in the 3GPP TS. + +EXAMPLE: If version 15.4.1 of a 3GPP TS contains version "1.1.1" of API A, B and C, and a version 16.0.0 of this 3GPP TS is derived from version 15.4.1, TS version 16.0.0 can contain version "1.2.0.alpha-1" of API A (if all changes made are backward compatible), version "2.0.0.alpha-1" of API B (if some changes are no backward compatible) and version "1.1.1" of API C (if no changes were made). + +The 3GPP TS defining the API is indicated in the OpenAPI specification of the API, as described in clause 5.3.4. + +#### 4.3.1.5 Discovery of the supported versions + +The NF service consumer may discover the API version(s) supported by an NF service producer using the following mechanisms: + +- NRF query: The NF service consumer may retrieve from the NRF the NF profile of a given NF Instance. This NF profile contains the full version number(s) of the API(s) supported by an NF Service Instance, as described in the clause 6.2.6.2.4 of 3GPP TS 29.510 [18] and the planned retirement date. + +- NF profile change notifications: The NF service consumer may subscribe for NF status change notifications with the NRF as specified in clause 5.2.2.5 of 3GPP TS 29.510 [18]. The NRF shall notify as specified in clause 5.2.2.6 of 3GPP TS 29.510 [18], any change to the NF profile which may include updated NF service profile containing the current list of NF services and their versions supported by the NF. + +When a new major version is created, the NF service producer shall continue supporting at least the previous major version until a retirement date unless all API versions (except for draft API versions published prior to the OpenAPI freeze) with that previous major version are withdrawn (see clause 4.3.1.6); this enables NF service consumers to migrate to the new version. After expiration of the retirement date, the old major version should be deprecated. The retirement date of an old major version supported by a NF service instance may be updated in the NF profile in the NRF. + +#### 4.3.1.6 Withdrawing API versions + +If it is discovered that one or several previous API versions are not providing the basic mandatory functionality of an API due to severe functional or encoding deficits (for instance, there is no or very limited interoperability between the NF service consumer and NF service producer when such an API version is used, or the API is hardly implementable because of severe deficits in the OpenAPI file that cannot easily be fixed by implementers in an interoperable manner), those API versions shall be listed as withdrawn in subsequent versions of the TS defining the corresponding API; any withdrawn API versions from the same or previous 3GPP releases shall be listed. API versions published before the OpenAPI freeze of the corresponding 3GPP Release, i.e. with a 4th Field (NON-FROZEN and/or OPERATOR-SPECIFIC) as part of the version number, shall not be withdrawn. + +NOTE 1: It is recommended to avoid withdrawing API versions whenever possible. It is expected that a need to withdraw API versions is most likely detected when discussing corrections soon after the OpenAPI freeze of a new API. + +NOTE 2: Corrections to optional or minor parts of the API functionality do not lead to the withdrawal of API versions. However, if severe functional or encoding deficits of the functionality related to an optional functionality with a corresponding supported feature (see 3GPP TS 29.500 [2] clause 6.6.2) are discovered, a new supported feature can be introduced to enable a negotiation of the support of the correction, and the old corresponding supported feature can be marked as "withdrawn" in the table defining the supported features of an API. + +Withdrawn API versions should not be deployed. + +## 4.4 URI Structure + +### 4.4.1 Resource URI structure + +Resources are either individual resources, or structured resources that can contain child resources. It is recommended to design each resource following one of the archetypes provided in the Annex C. + +A URI uniquely identifies a resource. In the 5GC SBI APIs, when a resource URI is an absolute URI, its structure shall be specified as follows: + +**{apiRoot}** + +"apiRoot" shall be a concatenation of the following parts: + +- scheme ("http" or "https") + +NOTE: In this release of the specification both http and https scheme URIs are allowed. See clause 13.1 of 3GPP TS 33.501[22] for further details on security of Service Based Interfaces. + +- the fixed string "://" +- authority (host and optional port) as defined in IETF RFC 3986 [9]. The host should be represented by the operator specific FQDN (for FQDN examples see clause 28.3.2 in 3GPP TS 23.003 [27]). +- an optional deployment-specific string (API prefix) that starts with a "/" character. + +"apiName" shall define the name of the API. For example, 'nsmf-pdusession'. + +"apiVersion" shall indicate the MAJOR version of the API. The format is specified in clause 4.3.1.3. For example, 'v1'. + +While "apiRoot", "apiName" and "apiVersion" together define the API URI of the corresponding API, each "apiSpecificResourceUriPart" defines a resource URI of the API relative to the API URI. + +An API URI should not contain a trailing slash as defined in clause 3.1, and if it contains one, then it should be ignored/removed. + +Example of an API URI from 3GPP TS 29.502 [20]: + +- url: '{apiRoot}/nsmf-pdusession/v1' + +### 4.4.2 Custom operations URI structure + +The custom operation definition is in Annex C. + +The URI of a custom operation which is associated with a resource shall have the following structure: + +**{apiRoot}** + +Custom operations can also be associated with the service instead of a resource. The URI of a custom operation which is not associated with a resource shall have the following structure: + +**{apiRoot}** + +In the above URI structures, "apiRoot", "apiName", "apiVersion" and "apiSpecificResourceUriPart" are as defined in clause 4.4.1 and "custOpName" represents the name of the custom operation as defined in clause 5.1.3.2. + +### 4.4.3 Callback URI structure + +The purpose of the callback URI is to enable NF service consumer to provide the URI to be used by an NF Service Producer to send notification or callback requests. + +The callback URI shall be in the form of an absolute URI as defined in clause 4.3 of IETF RFC 3986 [9], including an authority, and excluding any query component, any fragment component and any userinfo subcomponent. + +Therefore, callback URI consists of the following components, specified with ABNF syntax (see IETF RFC 5234 [26]): + +URI = scheme ":" "/" host [ ":" port ] [ prefix ] "/" + +Where: + +- scheme is either "http" or "https"; + +NOTE: In this release of the specification both http and https scheme URIs are allowed. See clause 13.1 of 3GPP TS 33.501[22] for further details on security of Service Based Interfaces. + +- 'host' is either an FQDN or an IP address; + - the URI may contain an optional port; + - the URI may contain an optional deployment-specific string (prefix) that starts with a "/" character; + - the "callbackUriPart" is the part of the callback URI, after the prefix (if any), of the path to an HTTP resource on the consumer, which is implementation specific; and + - the path of the callback URI comprises the prefix (if any) and the "callbackUriPart". +- 4.5 Resource Representation and Content Format Negotiation + +### 4.5.1 Resource Representation + +A resource representation is a serialization of the resource state in a particular content format. It's included in the data frame of an HTTP/2 request or response. Representation header fields provide metadata about the representation. When a message includes a data frame, the representation data enclosed in the data frame. HTTP/2 reuses the definition of Representation header as HTTP 1.1 in IETF RFC 7231 [6]. Content-type field in HTTP/2 header performs as + +representation header fields and describes the representation data that would have been enclosed in the data frame, e.g. if content-type is application/json, resource representation in data frame is serialized in JSON format. + +Server supports the content format of the representation received in the data frame of the request and returns the "200 OK" response code. + +### 4.5.2 Content Format Negotiation + +IETF RFC 7231 [6] provides a mechanism to negotiate the content format of a representation. + +In HTTP/2 requests and responses, the "Content-Type" HTTP/2 header field is used to signal the format of the actual representation included in the data frame. If the format of the representation in an HTTP/2 request is not supported by the server, it responds with the "415 Unsupported Media Type" response code. + +For GET method, the "Accept" HTTP header of the HTTP/2 request signals the content formats that a client supports. If the server cannot provide any of the accepted formats, it returns the "406 Not Acceptable" response code. + +## 4.6 Use of HTTP Methods + +### 4.6.1 Use of Request/Response Communication + +#### 4.6.1.1 CRUD + +##### 4.6.1.1.1 Creating a Resource + +###### 4.6.1.1.1.1 General + +Procedures that allow an NF service consumer to create a new resource at the NF service producer shall be specified to either use the HTTP POST method with procedures according to clause 4.6.1.1.1.2 or the HTTP PUT method with procedures according to clause 4.6.1.1.1.3. + +###### 4.6.1.1.1.2 Creating a Resource using POST + +The HTTP POST method (see IETF RFC 7231 [6]) allows an NF service consumer to create a new child resource at the NF service producer in such a manner that the NF service producer selects the child resource identifier and the URI for the child resource. + +Figure 4.6.1.1.1.2-1 illustrates creating a resource using POST. + +![Sequence diagram illustrating the interaction between an NF service consumer and an NF service producer for creating a resource using POST.](bed6d614aeb513fab7c7299bff6c0523_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. POST ../parent-resource (ResourceRepresentation) + Note right of Producer: + Producer-->>Consumer: 2. 201 Created (ResourceRepresentation) + Note left of Consumer: +``` + +The diagram shows a sequence of two messages between an NF service consumer and an NF service producer. The consumer sends a POST request to the producer, and the producer responds with a 201 Created status. The messages are labeled with their respective HTTP methods and status codes, along with the resource representation. + +Sequence diagram illustrating the interaction between an NF service consumer and an NF service producer for creating a resource using POST. + +**Figure 4.6.1.1.1.2-1: Creating a resource using POST** + +1. The parent resource of which the new resource is to be created as a child is identified by the request URI. The payload body of the POST request shall contain a representation of the resource to be created without a child resource identifier. For forward compatibility, the NF service producer ignores unknown attributes in the received resource representation unless specified otherwise by the particular application. + +2. The NF service producer generates a child resource identifier and constructs the URI for the created resource by appending that child resource identifier to the parent resource URI received as request URI of the POST request (e.g. ".../parent-resource/childresource1"). + +On success, "201 Created" shall be returned, the payload body of the POST response should contain a representation of the created resource, and the "Location" header shall be present and shall contain the URI of the created resource. The created resource shall be served by the same NF (service) instance that received the service request, unless the 5GC SBI API specifications explicitly specified that in specific use cases the created resource may be served by another NF (service) instance. If in such specific use cases the resource is created in a different NF (service) instance, the identifier of the serving NF (service) instance shall be included in the response message. + +If the HTTP scheme used in the returned URI is "https", then the authority of the URI included in the Location header shall be an FQDN, and not an IP address. + +The URI included in the "Location" header may be an absolute URI or a relative URI reference (see IETF RFC 3986 [9]); when the URI is in relative form, the base URI used to resolve the URI reference is the target URI included in the received POST request. + +NOTE: The representations of the resource in the request and response can differ, e.g. the representation of the resource in the response can be empty or can contain a subset of the representation as received in the request possibly with modified attributes, and in addition can contain additional attributes. Exact details will be specified by the application. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.8). + +A collection may be used to model a resource that serves as a directory of resources that may be distributed on different processing instances or hosts. If so: + +- the authority and/or deployment-specific string of the apiRoot of the created resource URI returned by the NF Service Producer in the "Location" header may differ from the authority and/or deployment-specific string of the apiRoot of the request URI received in the POST request. +- the NF Service Consumer shall be capable to receive and process an authority and/or deployment-specific string in the apiRoot of the created resource URI that differs from the authority and/or deployment-specific string of the apiRoot of the Request URI. + +It needs to be clearly stated in the 5GC SBI API specifications when a NF Service Producer may return a different authority and/or deployment-specific string in the apiRoot of the created resource URI for a collection resource. + +###### 4.6.1.1.1.3 Creating a Resource using PUT + +The HTTP PUT method (see IETF RFC 7231 [6]) allows an NF service consumer to create a new resource at the NF service producer in such a manner that the NF service consumer selects the resource identifier and the URI for the resource. + +Figure 4.6.1.1.1.3-1 illustrates creating a resource using HTTP PUT. + +![Sequence diagram illustrating the interaction between an NF service consumer and an NF service producer for creating a resource using HTTP PUT. The consumer sends a PUT request to the producer, and the producer responds with a 201 Created status and a resource representation.](37819f1170c36655c57129b6bd8a5ceb_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. PUT .../resource (ResourceRepresentation) + Note right of Producer: + Producer-->>Consumer: 2. 201 Created (ResourceRepresentation) + Note left of Consumer: +``` + +Sequence diagram illustrating the interaction between an NF service consumer and an NF service producer for creating a resource using HTTP PUT. The consumer sends a PUT request to the producer, and the producer responds with a 201 Created status and a resource representation. + +Figure 4.6.1.1.1.3-1: Creating a Resource using HTTP PUT + +1. The NF service consumer selects a resource identifier and constructs the URI for the resource to be created by appending that resource identifier to the parent resource URI. The resource that is to be created is identified by that URI as request URI. The payload body of the PUT request shall contain a representation of the resource to be created. For forward compatibility, the NF service producer ignores unknown attributes in the received resource representation unless specified otherwise by the particular application. +2. On success, "201 Created" shall be returned, the payload body of the PUT response should contain the representation of the created resource, and the "Location" header shall be present and shall contain the URI of the created resource. The created resource shall be served by the same NF (service) instance that received the service request, unless the 5GC SBI API specifications explicitly specified that in specific use cases the created resource may be served by another NF (service) instance. If in such specific use cases the resource is created in a different NF (service) instance, the identifier of the serving NF (service) instance shall be included in the response message. + +If the HTTP scheme used in the returned URI is "https", then the authority of the URI included in the Location header shall be an FQDN, and not an IP address. + +NOTE: The representations of the resource in the request and response can differ, e.g. the representation of the resource in the response can be empty or can contain a subset of the representation as received in the request possibly with modified attributes, and in addition can contain additional attributes. Exact details will be specified by the application. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +If the resource that is to be created already exists at the NF service producer, the following applies: + +- 1) If the update of that resource by PUT is supported, the existing representation of the resource is replaced with the representation received in the PUT request body; see clause 4.6.1.1.3.1. +- 2) If the update of that resource by PUT is not supported, the "403 Forbidden" HTTP status code shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +##### 4.6.1.1.2 Reading a Resource + +###### 4.6.1.1.2.1 Reading a Single Resource + +Procedures that allow a service consumer NF (client) to read information from the server shall be specified to use the HTTP GET method (see IETF RFC 7231 [6]) to obtain the current representation of a resource. + +Figure 4.6.1.1.2.1-1 illustrates reading a resource. + +![Sequence diagram illustrating the interaction for reading a resource. An NF service consumer sends a GET request to an NF service producer, and the producer responds with a 200 OK status and the resource representation.](c0e369274e53b2e5364666be6f786c7a_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. GET .../resource?query-parameter=value () + Note right of Producer: + Producer-->>Consumer: 2. 200 OK (ResourceRepresentation) + Note left of Consumer: +``` + +Sequence diagram illustrating the interaction for reading a resource. An NF service consumer sends a GET request to an NF service producer, and the producer responds with a 200 OK status and the resource representation. + +Figure 4.6.1.1.2.1-1: Reading a resource + +1. The resource of which a representation is to be obtained is identified by the request URI. Query parameters may be used to control the content of the result. + +The payload body of the GET request shall be empty. + +2. On success, "200 OK" shall be returned and the payload body of the GET response shall contain the obtained resource representation. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body (see clause 4.8). + +###### 4.6.1.1.2.2 Querying a Set of Resources + +Procedures that allow a service consumer NF (client) to querying a set of resources from the server shall be specified to use HTTP GET method towards a resource modelled as Collection or Store archetype. + +Query parameters (see clause 4.6.1.1.5) may be provided when querying a set of resources. The query component contains non-hierarchical data that, along with data in the path component, to filter the resources identified within the scope of the URI's scheme to a subset of the resources matching the query parameters. The query component is indicated by the first question mark ("?") character and terminated by a number sign ("#") character or by the end of the URI. + +![Sequence diagram showing a client sending a GET request to a server and receiving a 200 OK or 404 Not Found response.](90ddf538ef276510e2b631f7b96654e6_img.jpg) + +``` +sequenceDiagram + participant client + participant server + Note left of client: client + Note right of server: server + client->>server: 1. GET .../resource?query-parameters + server-->>client: 2. 200 OK (ResourceRepresentation) + Note right of server: or + Note right of server: 404 Not Found +``` + +The diagram illustrates a sequence of interactions between a client and a server. The client sends a GET request to a resource with query parameters. The server responds with either a 200 OK status containing a resource representation, or a 404 Not Found status. + +Sequence diagram showing a client sending a GET request to a server and receiving a 200 OK or 404 Not Found response. + +**Figure 4.6.1.1.2.2-1: Query of a collection of resources by using query parameters.** + +Step 1. The client shall send a HTTP GET request using the URI of a resource modelled as Collection or Store archetype, optionally with query parameters, to the server. + +Step 2. On success, the server shall return a set of sub-resources that includes only those entries filtered by the query parameters. If no sub-resource is matched for the querying service operation, the server shall return "200 OK" with an empty array (e.g. "[ ]" in JSON) in response body. If the resource in the URI doesn't exist on the server, the server shall return "404 Not Found" with optionally the cause information in response body. + +NOTE: The result array/empty array can be defined as an attribute of an object, if the service operation returns an object in the response payload for extensibility consideration. + +Clause 4.9 specifies some possible options for an NF Service Producer to return the representations of multiple resources to a NF Service Consumer. + +##### 4.6.1.1.3 Updating a Resource + +###### 4.6.1.1.3.1 Usage of HTTP PUT + +Procedures that allow a service consumer NF (client) to update information stored at the server by means of a complete replacement shall be specified to use the HTTP PUT method to replace the current representation of a resource with a new representation. + +Figure 4.6.1.1.3.1-1 illustrates updating a resource using HTTP PUT. + +![Sequence diagram showing the interaction between an NF service consumer and an NF service producer for updating a resource using HTTP PUT. The consumer sends a PUT request to a resource, and the producer responds with either a 204 No Content or a 200 OK status code.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. PUT .../resource (ResourceRepresentation) + Note right of Producer: + Producer-->>Consumer: 2. 204 No Content () +or 200 OK +``` + +Sequence diagram showing the interaction between an NF service consumer and an NF service producer for updating a resource using HTTP PUT. The consumer sends a PUT request to a resource, and the producer responds with either a 204 No Content or a 200 OK status code. + +**Figure 4.6.1.1.3.1-1: Updating a Resource using HTTP PUT** + +1. The resource that is to be updated is identified by the request URI. The payload body of the PUT request shall contain the new representation of the resource. For forward compatibility, the NF service producer ignores unknown attributes in the received resource representation unless specified otherwise by the particular application. +2. On success, "204 No Content" or "200 OK" shall be returned. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +If the resource that is to be updated does not exist at the NF service producer, the following applies: + +1. If the creation of that resource by PUT is supported, the resource is created according to the procedure in clause 4.6.1.1.1.3. +2. If the creation of that resource by PUT is not supported, the "403 Forbidden" HTTP status code shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +###### 4.6.1.1.3.2 Usage of HTTP PATCH + +Procedures that allow a service consumer NF (client) to update information stored at the server by means of a partial replacement shall be specified to use the HTTP PATCH method (see IETF RFC 5789 [10]) to modify the current representation of a resource according to given modification instructions. The format of the PATCH message body shall be specified for each resource where the PATCH method is supported using one or several of the following encodings: + +- If no modification of individual elements within an array needs to be supported, the "JSON Merge Patch" encoding of changes defined in IETF RFC 7396 [7] should be used. +- If a modification of individual elements within an array needs to be supported, the "JSON Patch" encoding of changes defined in IETF RFC 6902 [8] shall be used. + +A single of the above encodings shall be specified for each resource where the PATCH method is supported unless backward compatibility considerations necessitate the support of both encodings. + +NOTE 1: In Rel-15 a single encoding will be selected for each resource as backward compatibility considerations do not yet apply. + +NOTE 2: "JSON Merge Patch" does not support the modification of individual elements within an array. However, it supports the modification of individual elements within maps (see clause 5.2.4.2). Collections of elements can be modelled as maps, instead of arrays, if a partial modification using PATCH is desired. + +NOTE 3: The Open API description of the body of HTTP PATCH requests is specified in clause 5.3.8. + +Figure 4.6.1.1.3.2-1 illustrates updating a resource using HTTP PATCH. + +![Sequence diagram showing the interaction between an NF service consumer and an NF service producer for updating a resource using HTTP PATCH. The consumer sends a PATCH request to a resource with modification instructions. The producer responds with either a 204 No Content or a 200 OK status.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: 1. PATCH .../resource (ModificationInstructions) + Consumer->>Producer: Request + Note right of Producer: 2. 204 No Content () or 200 OK + Producer-->>Consumer: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and an NF service producer for updating a resource using HTTP PATCH. The consumer sends a PATCH request to a resource with modification instructions. The producer responds with either a 204 No Content or a 200 OK status. + +**Figure 4.6.1.1.3.2-1: Updating a Resource using HTTP PATCH** + +1. The resource that is to be updated is identified by the request URI. The payload body of the PATCH request shall contain a description of the requested modifications of the resource. For the "JSON Merge Patch" encoding defined in IETF RFC 7396 [7] and the "Content-Type" header shall be set to "application/merge-patch+json". For the "JSON Patch" encoding of changes defined in IETF RFC 6902 [8] the "Content-Type" header shall be set to "application/json-patch+json". For forward compatibility, the NF service producer shall ignore received modification instructions of unknown attributes in the resource unless specified otherwise by the particular application. +2. On success, "204 No Content" or "200 OK" shall be returned. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body (see clause 4.8). + +##### 4.6.1.1.4 Deleting a Resource + +Procedures that allow a service consumer NF (client) to delete a resource from the server shall be specified to use the HTTP DELETE method (see IETF RFC 7231 [6]). + +Figure 4.6.1.1.4-1 illustrates deleting a resource. + +![Sequence diagram showing the interaction between an NF service consumer and an NF service producer for deleting a resource using HTTP DELETE. The consumer sends a DELETE request to a resource. The producer responds with a 204 No Content status.](d3b5eac55166fc428a223bba5c46961b_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: 1. DELETE .../resource () + Consumer->>Producer: Request + Note right of Producer: 2. 204 No Content () + Producer-->>Consumer: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and an NF service producer for deleting a resource using HTTP DELETE. The consumer sends a DELETE request to a resource. The producer responds with a 204 No Content status. + +**Figure 4.6.1.1.4-1: Deleting a resource** + +The resource that is to be deleted is identified by the request URI. + +The payload body of the DELETE request shall be empty. + +On success, "204 No Content" should be returned and then the payload body of the DELETE response shall be empty. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body (see clause 4.8). + +##### 4.6.1.1.5 Query Parameters + +###### 4.6.1.1.5.1 General + +The query component in the URI contains non-hierarchical data that, along with data in the path component, to filter the resources identified within the scope of the URI's scheme to a subset of the resources matching the query parameters. + +The query component is indicated by the first question mark ("?") character and terminated by a number sign ("#") character or by the end of the URI. The syntax of the query component is specified in IETF RFC 3986 [9]. + +When a server receives a request with a query component, it shall parse the query string in order to identify filters. The first question mark is used to be a separator and is not part of the query string. A query string is composed of a series of "key=value" pairs, separated by "&". If one query parameter contains more than one value, i.e. an array of data elements, different values shall be separated by comma (","). + +The behaviour of the server, when receiving an HTTP/2 method with a query parameter which is of type array and only some of the members in the array can be matched, depends on each API and the behaviour shall be clearly described. + +If multiple query parameters are defined for a method on the resource, the logical 'AND' represents the default logical relationship between the query parameters for this resource. If a logical relationship between multiple query parameters is specified in an API, then this overrides the default relationship. If multiple query parameters are defined for a method on the resource in an API, but there is no need to specify any logical relationship between these query parameters, the API shall explicitly state this. + +###### 4.6.1.1.5.2 Complex query expression + +The complex query expression is used when there are multiple query parameters in the URI and the query condition needs to be expressed by a logical combination of multiple query parameters which overrides the default logical relationship of the query parameters. The complex query expression is either a Conjunctive Normal Form (CNF) or a Disjunctive Normal Form (DNF) which is equivalent to the logical combination of query parameters reflecting the query condition. + +The "complex-query" query parameter may be used when a complex query expression is needed to express a query condition. The value of the "complex-query" query parameter is of type "ComplexQuery" which is a JSON object, the corresponding CNF or DNF is encoded into that JSON object (see 3GPP TS 29.571 [5] for the details of the data type "ComplexQuery"). The use of "complex-query" shall be negotiated using the feature negotiation procedure as defined in 3GPP TS 29.500 [2]. + +If a query parameter is included in the "complexQuery" then the same query parameter shall not be included outside the "complexQuery" in the same request message. + +NOTE 1: It is not assumed that all APIs support "complex-query", the API supports this feature only when it is described in the corresponding specification. + +NOTE 2: The logical relationship between "complex-query" and the other query parameters defined for a particular API is described in the corresponding specification of that API. + +NOTE 3: The "complex-query" is not an additional explanation of the other query parameters, the condition expressed in the "complex-query" is evaluated along with the other queries. + +#### 4.6.1.2 Custom Operations + +Custom Operations provide procedures that allow a service consumer NF (client) to interact with an NF service producer in other ways than what is supported by the CRUD methods described in clause 4.6.1.1. + +Custom Operation can be related to a resource or can be related to an entire service and be independent of a resource. + +Figure 4.6.1.2-1 illustrates the use of a custom operation related to a resource. + +![Sequence diagram for Figure 4.6.1.2-1: Custom Operation on a Resource using HTTP POST. It shows an NF service consumer sending a POST request to an NF service producer and receiving a 200 OK or 204 No Content response.](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: 1. POST .../resource/custom-operation-name (Custom Operation Parameters) + NF service consumer->>NF service producer: Request + Note right of NF service producer: 2. 200 OK (Data related to Custom Operation) or 204 No Content() + NF service producer-->>NF service consumer: Response +``` + +Sequence diagram for Figure 4.6.1.2-1: Custom Operation on a Resource using HTTP POST. It shows an NF service consumer sending a POST request to an NF service producer and receiving a 200 OK or 204 No Content response. + +**Figure 4.6.1.2-1: Custom Operation on a Resource using HTTP POST** + +1. The request URI identifies the custom operation to be executed and the resource the custom operation relates to and is constructed by adding a verb as name for the custom operation at the end of the resource URI (see clauses 4.4.2 and 5.1.3.2). Parameters for the custom operation are included in the request body. +2. On success, "204 No Content" or "200 OK" shall be returned. "200 OK" shall contain a body with data related to the custom operation. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.8). + +Figure 4.6.1.2-2 illustrates the use of a custom operation related to a service. + +![Sequence diagram for Figure 4.6.1.2-2: Custom Operation related to Service using HTTP POST. It shows an NF service consumer sending a POST request to an NF service producer and receiving a 200 OK or 204 No Content response.](9b686adccf125267a013fa25721231a3_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: 1. POST .../custom-operation-name (Custom Operation Parameters) + NF service consumer->>NF service producer: Request + Note right of NF service producer: 2. 200 OK (Data related to Custom Operation) or 204 No Content() + NF service producer-->>NF service consumer: Response +``` + +Sequence diagram for Figure 4.6.1.2-2: Custom Operation related to Service using HTTP POST. It shows an NF service consumer sending a POST request to an NF service producer and receiving a 200 OK or 204 No Content response. + +**Figure 4.6.1.2-2: Custom Operation related to Service using HTTP POST** + +1. The request URI identifies the custom operation to be executed and is constructed by adding a verb as name for the custom operation at the end of the service URI (see clauses 4.4.2 and 5.1.3.2). Parameters for the custom operation are included in the request body. +2. On success, "204 No Content" or "200 OK" shall be returned. "200 OK" shall contain a body with data related to the custom operation. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.8). + +#### 4.6.1.3 Use of Asynchronous Operations + +Certain service operations may be designed to allow the invocation of a request so that the response can be received asynchronously: if the NF service consumer when sending a request cannot expect to receive an immediate final response, the service consumer may provide a callback reference for final result notification. The service provider, + +when receiving a request that contains a callback reference for final result notification, may then return an immediate "202 Accepted", and notify the service consumer about the final result using the received callback reference at a later point in time. + +#### 4.6.1.4 Special provisions to support the seamless change of AMF as NF service producer + +Services provided by the AMF can be transferred seamlessly to a new AMF when the corresponding UE context is transferred to that AMF. + +To support a seamless change of the AMF as NF service producer, the procedures in clause 4.6.1 are applied with the following special provisions: + +1. When becoming aware that a new AMF is serving the resource, the NF service consumer shall exchange the authority part of resource URIs with the address of a new NF service producer and shall use that URI in subsequent communication. + +NOTE: An NF service consumer can become aware of an AMF change via Namf\_Communication service AMFStatusChange Notifications, via Error response from old AMF, via link level failures (e.g. no response from the AMF), or via a notification from the NRF that the AMF has deregistered and can then determine the new AMF either via information received within those services or by selecting an AMF from an earlier received AMF set or the backup AMF. + +2. Each AMF within a set of AMFs supporting seamless changes shall be prepared to receive updates for resource URIs constructed according to bullet 1 with the own IP address as authority part from the NF service consumer, by either handling the updates, or by replying with an HTTP "307 temporary redirect" error response pointing to new NF service producer, or by replying with another HTTP error such as an "404 Not found". +3. For a service that includes notifications from the AMF, the NF service consumer shall be prepared to receive notifications for the that service from any NF service producer within a set of NF service producers supporting seamless changes. + +### 4.6.2 Use of Subscribe/Notify Communication + +#### 4.6.2.1 General + +Subscribe/Notify communication between 5GC NFs can be used to keep involved NFs (consumers of a service) informed of data changes or events that occur at another NF (producer of the service). A notification is a message that contains information about the event. + +Service consumer NFs (clients) need to subscribe to notifications at the service provider NF (server). This either happens explicitly by means of creating a new subscription resource (see clause 4.6.2.2), or implicitly by updating a relevant resource. + +Service consumer NFs can in principle explicitly or implicitly subscribe to be notified about data change to any type of resource of any resource archetype (Document, Store or Collection). It is up to the API to define the resources that support subscriptions. + +When the change/event occurs at the service producer NF, notifications (see clause 4.6.2.3) are sent from the service producer NF to the service consumer NFs. This communication initiated by the service producer to the service consumers requires that the service consumer NF (client) takes the role of an HTTP server and the service producer NF (server) takes the role of an HTTP client. + +During the explicit subscription the service consumer NF (client) provides a callback URI and possibly additional filter criteria to the service producer NF (server). When the data-change/event occurs that matches the filter criteria in the subscription, the service producer NF (taking the role of an HTTP client) uses the provided callback URI to notify the service consumer NF (taking the role of an HTTP server) about the change. + +#### 4.6.2.2 Management of Subscriptions + +##### 4.6.2.2.1 General + +The HTTP method to create a subscription shall be POST. The HTTP method to modify a subscription shall be PUT or PATCH. The HTTP method to delete a subscription (i.e. to unsubscribe) shall be DELETE (see IETF RFC 7231 [6]). + +Subscriptions may be implicit, i.e. exist without being explicitly created by a dedicated subscribe operation. + +Two types of implicit subscriptions exist: + +1. The subscription is implied by an explicit operation different from the subscribe operation, which does not use the GET method. The subscription implied by the explicit operation and the corresponding notification shall be part of the same service. +2. The subscription exists without any explicit operation. + +As an example for the first type, at the UDM the registered AMF (as long as it is registered) is implicitly subscribed to notification about de-registration and (possibly) P-CSCF restoration as side effect of the registration. + +As another example for the first type, at the SMF, the AMF that created a SM Context for a PDU session is implicitly subscribed for SM Context Status notification. At AMF change the new AMF updates the SMF with its callback URI for receiving subsequent SM Context Status notification. + +As an example for the second type, at the UDR any available UDM is implicitly subscribed to notification about changes of provisioned subscriber data. When provisioned subscriber data are modified at the UDR by means of provisioning, the UDR selects one of the available UDMs (i.e. one of the implicitly subscribed UDMs) and notifies it about the subscriber data change. + +In the OpenAPI specification file, notifications for the second type of implicit subscriptions shall be specified as part of an explicit subscription. + +##### 4.6.2.2.2 Creation of a Subscription + +Figure 4.6.2.2.2-1 illustrates explicit creation of a subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to an NF service producer, and the producer responds with a 201 Created status.](d5918cee231b536f20789a18d861fae3_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. POST .../xyz-subscriptions (XyzSubscription) + Note right of Producer: + Producer-->>Consumer: 2. 201 Created (XyzSubscription) + Note left of Consumer: +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to an NF service producer, and the producer responds with a 201 Created status. + +**Figure 4.6.2.2.2-1: Creation of a subscription** + +The parent resource (collection of subscriptions) is identified by the request URI. + +The data structure in the payload body of the POST request shall contain a callback URI, and may contain additional criteria to filter the set of events that trigger a notification. The request may contain an expiry time, suggested by the NF Service Consumer as a hint, representing the time up to which the subscription is desired to be kept active and the time after which the subscribed event shall stop generating notifications. + +On success, "201 Created" shall be returned, the payload body of the POST response shall contain a representation of the created subscription, and the "Location" header shall contain the URI of the created resource. The created resource shall be served by the same NF (service) instance that received the service request, unless the 5GC SBI API specifications explicitly specified that in specific use cases the created resource may be served by another NF (service) instance. If in such specific use cases the resource is created in a different NF (service) instance, the identifier of the serving NF (service) instance shall be included in the response message. + +If the HTTP scheme used in the returned URI is "https", then the authority of the URI included in the Location header shall be an FQDN, and not an IP address. + +The response based on operator policies and taking into account the expiry time included in the request, may contain an expiry time (i.e. a future timestamp), as determined by the NF Service Producer, after which the subscription becomes invalid. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the NF Service Producer. The NF Service Producer shall not provide the same expiry time (i.e. a future timestamp) for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.9). + +##### 4.6.2.2.3 Modify a subscription + +###### 4.6.2.2.3.1 Modification of a Subscription Using HTTP PUT + +Procedures that allow a NF service consumer to update the subscription at the server by means of a complete replacement shall use the HTTP PUT method to replace the current subscription with a new representation. + +Figure 4.6.2.2.3.1-1 illustrates modification a subscription using HTTP PUT. + +![Sequence diagram showing the modification of a subscription using HTTP PUT. The NF service consumer sends a PUT request to the NF service producer, and the producer responds with either a 204 No Content or a 200 OK status.](84e5b251aa38db522f76f5cc3afcb853_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: + NF service consumer->>NF service producer: 1. PUT ...{subscriptionId} (XyzSubscription) + Note right of NF service producer: + NF service producer-->>NF service consumer: 2. 204 No Content () +or 200 OK(XyzSubscription) +``` + +Sequence diagram showing the modification of a subscription using HTTP PUT. The NF service consumer sends a PUT request to the NF service producer, and the producer responds with either a 204 No Content or a 200 OK status. + +**Figure 4.6.2.2.3.1-1: Modification a subscription using HTTP PUT** + +1. The NF Service Consumer shall send a PUT request to the resource URI representing the individual subscription. The payload body of the PUT request shall contain the subscription information to be replaced including the criteria to filter the set of events that trigger a notification. The request may contain an updated expiry time, suggested by the NF Service Consumer as a hint, to extend the subscription lifetime, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event shall stop generating notifications. If the request does not contain an expiry time, the NF Service Producer shall consider that the NF Service Consumer requests for an extension of the existing subscription lifetime without indicating any specific expiration time; still, the NF Service Producer shall be authoritative to set the expiry time in the subscription response according to its own policies. +2. On success, "204 No Content" without any response body or "200 OK" with a response body providing current resource representation shall be returned. + +When "200 OK" is returned, the response based on operator policies and taking into account the expiry time included in the request, may contain an expiry time (i.e. a future timestamp), as determined by the NF Service Producer, after which the subscription becomes invalid. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the NF Service Producer, as specified in clause 4.6.2.2.2. The NF Service Producer shall not provide the same expiry time (i.e. a future timestamp) for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +When "204 No Content" is returned, it shall be interpreted that the NF Service Producer accepted entirely the resource representation provided by the NF Service Consumer in the request; e.g., if the request contained a + +proposed expiry time, a 204 response shall be interpreted as if such timestamp is accepted by the NF Service Producer as the expiration time for the subscription and, similarly, if the request did not contain a proposed expiry time, a 204 response shall be interpreted as if no expiration time is set by the NF Service Producer for the subscription. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +If the NF Service Consumer is not allowed to update the subscription information, the "403 Forbidden" HTTP status code shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +If the resource that is to be updated does not exist at the NF service producer, the "404 Not Found" HTTP status code shall be returned. + +###### 4.6.2.2.3.2 Modification of a Subscription Using HTTP PATCH + +Procedures that allow a NF service consumer to update subscription at the server by means of a partial replacement shall use the HTTP PATCH method (see IETF RFC 5789 [10]) to modify the current subscription according to given modification instructions. + +Figure 4.6.2.2.3.2-1 illustrates updating a resource using HTTP PATCH. + +![Sequence diagram illustrating the modification of a subscription using HTTP PATCH. The diagram shows two participants: NF service consumer and NF service producer. The consumer sends a PATCH request to the producer. The producer responds with either a 204 No Content or a 200 OK with a response body.](17a1ba23b641c01871b08f0a4f08ef48_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: + Note right of NF service producer: + NF service consumer->>NF service producer: 1. PATCH .../{subscriptionId}(ModificationXyzSubscription) + NF service producer-->>NF service consumer: 2. 204 No Content () +or 200 OK(ModifiedXyzSubscription) +``` + +Sequence diagram illustrating the modification of a subscription using HTTP PATCH. The diagram shows two participants: NF service consumer and NF service producer. The consumer sends a PATCH request to the producer. The producer responds with either a 204 No Content or a 200 OK with a response body. + +**Figure 4.6.2.2.3.2-1: Modification a subscription using HTTP PATCH** + +1. The NF Service Consumer shall send a PATCH request to the resource URI representing the individual subscription. The payload body of the PATCH request shall contain the modification instructions. The request may contain an expiry time (i.e. a future timestamp), requested by the NF Service Consumer, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event shall stop generating notifications. +2. On success, "204 No Content" without any response body or "200 OK" with a response body containing the modified subscription information shall be returned. When "204 No Content" is returned and if the request included an expiry time, then the requested expiry time shall be accepted by the NF Service Producer. When "200 OK" is returned and if the request included an expiry time then the response based on operator policies and taking into account the expiry time included in the request, shall contain an expiry time (i.e. a future timestamp), as determined by the NF Service Producer, after which the subscription becomes invalid. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the NF Service Producer, as specified in clause 4.6.2.2.2. The NF Service Producer shall not provide the same expiry time (i.e. a future timestamp) for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body (see clause 4.8). + +##### 4.6.2.2.4 Delete a subscription + +Figure 4.6.2.2.4-1 illustrates explicit deletion of a subscription. + +![Sequence diagram for Figure 4.6.2.2.4-1: Deletion of a subscription. It shows an NF service consumer sending a DELETE request to an NF service producer, which responds with a 204 No Content.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: 1. DELETE ...{subscriptionId} () + NF service consumer->>NF service producer: 1. DELETE ...{subscriptionId} () + Note right of NF service producer: 2. 204 No Content () + NF service producer-->>NF service consumer: 2. 204 No Content () + +``` + +Sequence diagram for Figure 4.6.2.2.4-1: Deletion of a subscription. It shows an NF service consumer sending a DELETE request to an NF service producer, which responds with a 204 No Content. + +**Figure 4.6.2.2.4-1: Deletion of a subscription** + +1. The NF Service Consumer shall send a DELETE request to the resource URI representing the individual subscription. The request body shall be empty. +2. On success, "204 No Content" shall be returned. The response body shall be empty. + +On failure, the appropriate HTTP status code indicating the error shall be returned in the DELETE response body (see clause 4.8). + +#### 4.6.2.3 Notifications + +The HTTP method for the notification that corresponds to an explicit subscription shall be POST (see IETF RFC 7231 [6]). + +NOTE: Clause 5.3.7 describes how to encode Notifications in OpenAPI specification files. + +Figure 4.6.2.3-1 illustrates a notification. + +![Sequence diagram for Figure 4.6.2.3-1: Notification. It shows an NF service consumer (acting as an HTTP server) receiving a POST request from an NF service producer (acting as an HTTP client) and responding with 200 OK or 204 No Content.](ca5dc5fde2061d0ca2051ef7840fc842_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer (taking the role of a HTTP server) + participant NF service producer (taking the role of a HTTP client) + Note left of NF service producer: 1. POST {callback_ref} (Notification) + NF service producer->>NF service consumer: 1. POST {callback_ref} (Notification) + Note right of NF service consumer: 2. 200 OK or 204 No Content + NF service consumer-->>NF service producer: 2. 200 OK or 204 No Content + +``` + +Sequence diagram for Figure 4.6.2.3-1: Notification. It shows an NF service consumer (acting as an HTTP server) receiving a POST request from an NF service producer (acting as an HTTP client) and responding with 200 OK or 204 No Content. + +**Figure 4.6.2.3-1: Notification** + +1. The callback reference provided during creation of the subscription resource, or otherwise known from implicit subscription, is used as the request URI. The callback reference for implicit subscriptions are obtained from the NRF. When an NF / NF service registers with the NRF, the default notification subscriptions along with the callback URI for receiving those notifications may be provided (see clause 6.1.6.2.3 of 3GPP TS 29.510 [18]). + +The payload body of the POST request shall contain the notification payload. + +The payload body of the notification should follow the resource definition of the subscribed resource and can for example be based on the resource definition of the GET operation, but it is up to the API to define the notification resource definition. + +Each API that supports subscription to collection/store archetype resources, should specify in their semantics whether notifications should be sent by changes on the collection/store resource ONLY (i.e. creation/deletion of the main top-level resource itself, and creation/deletion of its children), or if in addition the consumer can expect to get notifications from changes on the resource representation. + +2. On success, "200 OK" shall be returned if any information needs to be included in the payload body of the POST response; otherwise, "204 No Content" shall be returned and the payload body of the POST response shall be empty. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.8). + +#### 4.6.2.4 Special provisions to support the seamless change of AMF as NF service consumer + +Services consumed by an AMF can be transferred seamlessly to a new AMF when the corresponding UE context is transferred to that AMF. + +To support a seamless change of AMF as NF service consumer, the procedures in clause 4.6.2 are applied with the following special provisions: + +1. When becoming aware that a new AMF is requiring notifications related to a subscription resource, the NF service producer shall exchange the authority part of the corresponding Notification URI with the address of that new NF service consumer and shall use that URI in subsequent communication. + +NOTE: An NF service producer can become aware of an AMF change via Namf Communication service AMFStatusChange Notifications, via Error response from old AMF, via link level failures (e.g. no response from the AMF), or via a notification from the NRF that the AMF has deregistered and can then determine the new AMF either via information received within those services or selecting an AMF from an earlier received AMF set or the backup AMF. + +2. Each AMF within a set of AMFs supporting seamless changes shall be prepared to receive notifications at the Notification URI constructed according to bullet 1 with the own IP address as authority part from the NF service producer, by either handling the notifications, or by replying with an HTTP "307 temporary redirect" error response pointing to new NF service consumer, or by replying with another HTTP error such as an "404 Not found". + +## 4.7 HATEOAS + +### 4.7.1 General + +As defined in [14], HATEOAS stands for Hypermedia As The Engine Of Application State. It means that the hypermedia models application state transitions and describe application protocols. + +As defined in [15] clause 3 RESTful Domain Application Protocols, an application is a software implementation defined to achieve a particular goal. It consists of a set of constrained interactions between NF Service Consumer and Producer performed at run-time that are guided by an application specific set of rules. The application transits across some intermediate states until the application's goal is achieved. The application has then reached its final state. + +An application state is a snapshot of an application instance. + +On each interaction, the NF Service Consumer and Producer exchange representations of resource state. According to [14], "REST concentrates all of the control state into the representations received in response to interactions." and "The model application is therefore an engine that moves from one state to the next by examining and choosing from among the alternative state transitions in the current set of representations." After each interaction the NF Service Consumer is then presented with control state options to interact with additional resources. These control states are in the form of hypermedia markups embedded in the returned resource representation. The application state changes when an NF Service Consumer examines and chooses which control to operate and subsequently interacts with the resources identified in the selected control state. + +HATEOAS support is optional. If HATEOAS is supported, the procedure in the present clause 4.7 shall apply. + +### 4.7.2 3GPP hypermedia format + +#### 4.7.2.1 Basic 3GPP hypermedia format + +NOTE 1: Basic 3GPP hypermedia format is derived from Hypertext Application Language (HAL). HAL is specified in an expired internet draft available at "". + +Basic 3GPP hypermedia format specifies the following optional reserved properties (see 3GPP TS 29.571 [5] for the complete list and definition of objects and object members): + +- "\_links": contains links to other resources and expresses valid state transitions. + +A NF service producer shall construct a basic 3GPP hypermedia document by taking a 3GPP defined JSON object attribute list and then adding a "\_links" attribute. + +**Table 4.7.2.1-1: \_links attribute** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|-------------------------------------------------------------------------| +| _links | map(LinksValueSchema) | C | 0..N | _links attribute to be added into the JSON hypermedia object definition | + +The LinksValueSchema data type shall be added to the list of re-used data types of the hypermedia enabled API (see 3GPP TS 29.509 [21] for an example of implementation of a hypermedia API). + +NOTE 2: Depending of the applicable situation, the presence condition and the cardinality can be changed in accordance. LinksValueSchema data type is defined in 3GPP TS 29.571 [5]. + +The "\_links" member names are link relation types (as defined by IETF RFC 8288 [11]) and values are either a "link" object or an array of "link" objects. + +Basic 3GPP hypermedia format specifies the following "link" attribute: + +- "href": contains the URI of the linked resource. + +A NF service producer shall set the Content-Type HTTP header to "application/3gppHal+json" when returning an HTTP payload with a basic 3GPP hypermedia enabled document. + +A NF service consumer supporting HATEOAS shall advertise it by adding an "Accept" HTTP header with "application/3gppHal+json" as media type. + +NOTE 3: The HATEOAS principle relies on NF Service Producer providing control state options (\_links objects) embedded in the returned resource representation to the NF Service Consumer. An NF Service Consumer may decide to use the format of the \_links attribute in HTTP requests to transfer URIs. This is beyond the scope of HATEOAS and another content type than "3gppHal+json" such as "application/json" can be used. + +#### 4.7.2.2 Extended 3GPP hypermedia format + +NOTE 1: Extended 3GPP hypermedia format is derived from HAL-FORMS media type, see "https://rwcbook.github.io/hal-forms/". + +Extended 3GPP hypermedia format specifies the following optional reserved properties (see 3GPP TS 29.571 [5] for the complete list and definition of objects and object members): + +- "\_links": contains links to other resources and expresses valid state transitions; +- "\_templates": contains the HAL templates corresponding to the \_links attribute. + +A NF service producer shall construct a extended 3GPP hypermedia document by taking a 3GPP defined JSON object attribute list and then adding "\_links" attribute and "\_templates" attribute. + +**Table 4.7.2.2-1: \_halForms attribute** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| links | map(Link) | C | 1..N | The key is the name of the link relation type. | +| _templates | map(HalTemplate) | C | 1..N | The key is the name of the corresponding link relation type to which the template is to be applied. | + +The Link data type and HalTemplate data type shall be added to the list of re-used data types of the hypermedia enabled API. + +NOTE 2: Depending of the applicable situation, the presence condition can be changed in accordance. Link and HalTemplate data types are defined in 3GPP TS 29.571 [5]. A NF service producer shall set the Content-Type HTTP header to "application/3gppHalForms+json" when returning an HTTP payload with Extended 3GPP hypermedia enabled document. + +A NF service consumer supporting HATEOAS and extended 3GPP hypermedia shall advertise it by adding an "Accept" HTTP header with "application/3gppHalForms+json" as media type. + +### 4.7.3 Advertising legitimate application state transitions + +When a NF service producer responds to a NF service consumer and there is one or more application state transition possible, the NF service producer shall advertise them by adding a "\_links" property in the returned resource representation. When there are multiple state transitions with different relation types, then one member per relation type shall be added to the "\_links" object which name is equal to the relation type. If there is only one state transition for a given relation type then the value of the member is a "link" object otherwise it is an array of "link" objects. + +A NF service producer shall include a link into the returned resource representation with a registered relation type "self" when it is expected further actions upon it (for instance reading it again or replacing the resource state). + +NOTE 1: For a hypermedia application, a returned representation without any link denotes for the NF service consumers the end of the interaction with the NF service producer. 3GPP APIs does not fulfil this rule. + +### 4.7.4 Inferring link relation semantic + +When a NF service consumer receives a response with linked resources then it shall infer the link relation semantic from the relation type. It shall not infer it from the linked resource URI format. + +In 3GPP hypermedia, relation types are the name of "\_links" object members. + +### 4.7.5 Common Relation Types + +#### 4.7.5.1 Introduction + +This clause contains the list of relation types supported in 3GPP Service Based Interface APIs. + +As defined in IETF RFC 8288 [11] clause 2.1, a link relation type identifies the semantics of a link. It describes how resources are related to each other. It may also be used to indicate that the target resource of a link has particular attributes, or exhibits particular behaviours. Relation types shall not be confused with media types. It does not identify the format of the representation that results when the link is dereferenced. + +There are two kinds of relation types: + +- Registered relation types; +- Extension relation types. + +Registered relation types are identified by a token (for instance "self") and can be reused by other applications such as 3GPP SBI APIs. They are registered by IANA. Registered relation types shall be preferred against extension relation types when expressing the link relation between two resources. + +If there is a need to define a relation type that does not correspond to a registered one but it is not wanted to register it then an extension relation type shall be used instead. + +#### 4.7.5.2 Registered relation types + +The "Link Relations" registry is located at: . + +Table 4.7.5.2-1 specifies the list of registered relation types supported by all hypermedia enabled 3GPP APIs. + +Table 4.7.5.2-2 specifies the list of registered relation types that can be used by some hypermedia enabled 3GPP APIs, depending on the API design. + +**Table 4.7.5.2-1: mandatory registered relation types** + +| Relation name | +|---------------| +| self | + +**Table 4.7.5.2-2: optional registered relation types** + +| Relation name | +|---------------| +| next | +| first | +| previous | +| last | +| item | + +#### 4.7.5.3 Extension relation types + +When no registered relation exists to express the relation between two resources, an extension relation type shall be used instead. It may be defined as a string token or as a URI as defined in IETF RFC 8288 [11]. + +An API specification using extension relation types shall contain a clause "Relation types" in the clause "Simple data types and enumerations" (see 3GPP TS 29.509 [21] for an example of implementation of a hypermedia API). The clause shall contain a table listing the token or the URI of the created relation types. It shall also contain a detailed specification of the semantic of the relation types defining the conditions that the NF Service Consumer shall match to follow a link. + +### 4.7.6 Negotiating the support of optional HATEOAS features + +The supported feature mechanism in clause 6.6.2 of 3GPP TS 29.500 [2] should be used to negotiate the usage of optional HATEOAS features in addition to negotiating the content type "3gppHal+json" and "3gppHalForms+json". Separate supported features can be defined for link relation types related to different use cases. + +## 4.8 Error Responses + +### 4.8.1 Error Response Status Code + +When an error occurs that prevents the NF/NF service acting as an HTTP server from successfully fulfilling the HTTP request, the NF/NF service shall map an application error to the most similar 4xx/5xx HTTP status code as defined in clause 5.2.7 of 3GPP TS 29.500 [2]. + +### 4.8.2 Error Response Body + +When the HTTP status code is not enough for the NF/NF service acting as an HTTP client to determine the cause of the error, the NF/NF service acting as an HTTP server should provide additional application related error information, by including in the response body a representation of a "ProblemDetails" data structure according to IETF RFC 9457 [19] that provides additional details of the error. + +NOTE 1: The response body with the "ProblemDetails" data structure does not need to be sent on a 3GPP 5GC API for a particular HTTP status code if that HTTP status code itself provides enough information of the error, or if there are security concerns disclosing detailed error information. + +The definition of the general "ProblemDetails" data structure from IETF RFC 9457 [19] is specified in clause 5.2.4.1 of 3GPP TS 29.571 [5]. The "ProblemDetails" data structure is a JSON object, as defined in IETF RFC 9457 [19], and contains the following attributes: + +- a) "type" - a URI reference according to IETF RFC 3986 [9] that identifies the problem type; + +- b) "title" - a short, human-readable summary of the problem type that should not change from occurrence to occurrence of the problem; +- c) "status" - the HTTP status code for this occurrence of the problem; +- d) "detail" - a human-readable explanation specific to this occurrence of the problem; and +- e) "instance" - a URI reference that identifies the specific occurrence of the problem. + +A particular API may define additional attributes that provide more information about the error. + +NOTE 2: IETF RFC 9457 [19] allows adding of new properties in the "ProblemDetails" object. + +The following additional attributes are generic extensions defined for the 3GPP 5GC APIs: + +- a) "cause"- a machine-readable application error cause specific to this occurrence of the problem; and +- b) "invalidParams" - invalid parameters causing a request to be rejected. + +The "cause" attribute should be included and provide application-related error information, if available. Application error causes should be defined in 5GC SBI APIs specifications, using the UPPER\_WITH\_UNDERSCORE case convention specified in clause 5.1.1. + +EXAMPLE 1: "OUT\_OF\_LADN\_SA". + +The "invalidParams" attribute should be used to report invalid parameters when a request is rejected due to invalid parameters. + +All the application error causes supported by an API should be defined in a specific clause "Application Errors" under the "Error Handling" clause specified for the API. The application error causes that a specific service operation may respond should be further listed in the table defining the data structure supported by the response body, with the associated HTTP error status code. + +To enable a SEPP or an SCP for Indirect Communications to provide error details in error responses they originate, all service operations should support returning error responses including a representation of a "ProblemDetails" data structure. If additional application specific information is required in the error responses, the API should support returning the additional application information as specified in clause 4.8.3. The NF/NF service that generates the HTTP response shall include in the HTTP response a "Content-Type" header field set to: + +- "application/problem+json", if the response includes a payload body containing the "ProblemDetails" (or extended ProblemDetails, see clause 4.8.3) data structure; or +- "application/json", if the response includes a payload body containing an application-specific data structure. + +NOTE 3: Designing an error response payload body containing an application-specific data structure is discouraged for new APIs or service operations as this prevents a SEPP or an SCP when using indirect communications to include error details for errors they originate. If an API is defined with an application-specific error response body, the API also needs to support an error response body encoding a ProblemDetails object. + +### 4.8.3 Extending ProblemDetails for API Backward Compatibility + +For a service operation that returns "ProblemDetails" in error responses in a given release, if in a later release it is required to provide additional application specific information in the error responses, the API should be modified to return an Extended-ProblemDetails data type by reusing the "ProblemDetails" common data type, as specified in clause 5.3.17, to keep the API backward compatibility. + +The "Content-Type" header shall be set to "application/problem+json" for the error response with the payload body containing the Extended-ProblemDetails data type defined above. + +EXAMPLE: + +- an "AdditionInfo" structured data type containing the additional information to be returned, as specified in clause 5.2.4.2; + +**Table 4.8.3-1 Definition of type AdditionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------|------------------------------------------------------------|-----------------|-----------------------|----------------------|---------------| +| | "" or "array()" or "map()" or "Any Type" | "M", "C" or "O" | "0..1", "1" or "M..N" | | | + +- a "ProblemDetails" data type as combination of "ProblemDetails" common data type and "AdditionInfo" data type define above, as specified in clause 5.2.4.5: + +**Table 4.8.3-2 Definition of type ProblemDetails as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|--------------------------------|-------------|----------------------|---------------| +| ProblemDetails | 1 | | | +| AdditionInfo | 1 | | | + +Example OpenAPI specification of ProblemDetails data type, as specified in clause 5.3.10: + +``` +components: + schemas: + ProblemDetails: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionInfo' +``` + +Example OpenAPI specification of an error response returning ProblemDetails data type: + +``` +responses: + '504': + description: Gateway Timeout + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +``` + +## 4.9 Transferring multiple resources to a NF Service Consumer + +### 4.9.1 General + +This clause describes some possible options that an API may implement when a NF Service Producer needs to return the representations of multiple resources to a NF Service Consumer, e.g. during the query of a large collection of resources (see clause 4.6.1.1.2.2). + +Which options an API may support is defined in the respective stage 3 specification of the API. + +### 4.9.2 Direct Delivery + +A NF Service Producer may return the representations of the resources directly in the response body, i.e. the response body contains an array of the resource representations. + +### 4.9.3 Direct Delivery with Iterations + +If a large number of resource representations need to be returned, the NF Service Producer may return a representation containing a partial list of the requested resources in the response body, with link(s) containing URI(s) allowing the client to retrieve the remaining part(s) of the resources. + +The returned representation containing a partial list of the requested resource is a "3gppHal+json" document. The document is a JSON object with two members whose names are below. + +- \_links. +- child: contains the resources of the partial list. + +The member whose name is "\_links" shall contain a member whose name is "self" and whose value is a "link" object that contains the URI of the returned representation. It shall also contain a member whose name is "next" and whose value is a "link" object that contains the URI of the next partial list of the collection if the returned partial list is not the last one. + +The member whose name is "\_links" should also contain members whose names are "first", "previous" and "last" and whose values contain a "link" object that contains the URIs of the first, previous and last partial lists of the collection if such lists exist. + +The returned representation shall have a member whose name is "child" and whose value is an array of objects. Each of the individual resource representations returned in the partial list shall be embedded in an object of that array. Each object shall also have a member whose name is "\_links". The later shall contain a member whose name is "self" and whose value is a "link" object that contains the URI of the embedded representation. + +The table below provides a template to be added in the clause describing the GET operation of a 3GPP API using the direct delivery with iteration mechanism. + +**Table 4.9.3-1: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------| +| PartialList | M | 1 | 200 OK | This case represents a successful return of a partial list for the corresponding request with direct delivery with iteration. | + +The following data types shall be added to the list of specific data types and described as below in the structured data type clause. + +**Table 4.7.2-1: PartialList** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| _links | map(LinksValueSchema) | M | 1..N | contains the pagination links | +| child | array(ApiSpecificHypermediaEnabledIndividualResource) | M | 1..N | contains the individual resources with a self link.
The data type in the array is specific to the API and is a hypermedia enabled version of the individual resource data type. | + +**Table 4.7.2-1: ApiSpecificHypermediaEnabledIndividualResource** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------| +| attribute1 | | | | | +| attribute2 | | | | | +| ... | | | | | +| attribute N | | | | | +| _links | selfLink | M | 1 | contains the link to itself | + +NOTE 1: attributes 1 to N are the attributes of the original individual resource. + +The LinksValueSchema and SelfLink data types shall be added to the list of re-used data types of the 3GPP API. + +A NF Service Consumer that receives link(s) in the response body may retrieve the remaining part(s) of the resources by sending GET requests towards the URI(s) contained in the link(s). + +### 4.9.4 Indirect Delivery + +A NF Service Producer may not return any requested resource representation and instead may return a representation containing only a list of links to the requested resources in the response body. + +The returned representation containing the list is a "3gppHal+json" document. The document is a JSON object with one member whose name is: + +- \_links. + +This member shall contain a member whose name is "item" and whose value is an array of "link" objects. Each of the link objects contains one requested resource URI. There shall be one link object per requested resource. + +It shall also contain a member whose name is "self" and whose value is a "link" object that contains the URI of the returned representation. + +A NF Service Consumer that receives such a response may then send a GET request per resource URI to retrieve the requested resources from the NF Service Producer. + +### 4.9.5 Indirect Delivery with HTTP/2 Server Push + +A NF Service Producer may use HTTP/2 Server Push, if HTTP/2 Server Push is supported in the PLMN. + +To use HTTP/2 Server Push, the NF Service Producer shall send PUSH\_PROMISE frames in the HTTP response, with each PUSH\_PROMISE frame containing a GET request targeting the URI of one resource to be transferred and the reserved stream identifier to be used for transferring the resource. Then the NF Service Producer shall send Push Responses via the corresponding reserved streams, with each Push Response containing the representation of the associated resource. The NF Service Producer shall also send links with the URIs of the resources in DATA frame(s) of the response message. + +A NF Service Consumer may disable HTTP/2 Server Push by sending SETTINGS\_ENABLE\_PUSH parameter with value "0" on HTTP level, as specified in IETF RFC 7540 [13]. + +![Sequence diagram illustrating Indirect Delivery with HTTP/2 Server Push between an NF Service Consumer and an NF Service Producer.](329c96049bb432e9c2cbda4e224a0c9c_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer + participant Producer as NF Service Producer + + Note right of Producer: 2. Detects of sending multiple resources and choose to use Server Push + + Consumer->>Producer: 1. Ask for resources (HTTP GET /resource-path?query-parameters) + Producer-->>Consumer: 3. HTTP 200 OK + Note left of Consumer: PUSH_PROMISE frame 1 +(:path=,stream id=) +PUSH_PROMISE frame 2 +(:path=,stream id=) +... +PUSH_PROMISE frame N +(:path=,stream id=) +Response HEADERS frame & DATA frames +(List of URIs of the resources) + Note left of Consumer: 4.1 Push response +(body: data representation of ) ————— Stream: + Note left of Consumer: 4.2 Push response +(body: data representation of ) ————— Stream: + Note left of Consumer: ... +4.n Push response +(body: data representation of ) ————— Stream: + Note left of Consumer: 5. Get Single Resource Request +(:path=) + Note left of Consumer: 5.a. Get Single Resource Response +(body: data representation of ) + +``` + +The diagram illustrates the interaction between an NF Service Consumer and an NF Service Producer for indirect delivery using HTTP/2 Server Push. The sequence of events is as follows: + +- The NF Service Consumer sends a request (HTTP GET /resource-path?query-parameters) to the NF Service Producer. +- The NF Service Producer detects that multiple resources need to be returned and decides to use the Server Push mechanism. A box on the right indicates: "2. Detects of sending multiple resources and choose to use Server Push". +- The NF Service Producer responds with an HTTP 200 OK status. Before the response headers and data frames, it sends multiple PUSH\_PROMISE frames (labeled 3. PUSH 200 OK). Each PUSH\_PROMISE frame contains a path (e.g., , , ..., ) and a stream ID (e.g., , , ..., ). This is followed by the Response HEADERS frame and DATA frames containing a list of URIs of the resources. +- The NF Service Producer then sends push responses for each resource (labeled 4.1, 4.2, ..., 4.n). Each push response consists of the body: data representation of the resource (e.g., , , ..., ) and is associated with a specific stream (e.g., Stream: , Stream: , ..., Stream: ). +- The NF Service Consumer sends a request for a single resource (labeled 5. Get Single Resource Request) with the path . +- The NF Service Producer responds with the single resource (labeled 5.a. Get Single Resource Response) with the body: data representation of . + +Sequence diagram illustrating Indirect Delivery with HTTP/2 Server Push between an NF Service Consumer and an NF Service Producer. + +**Figure 4.9.5-1 Indirect Delivery with HTTP/2 Server Push** + +1. A NF Service Consumer sends a HTTP request to get resources(s) to the NF Service Producer, e.g. a query of a collection of resources. +2. The NF Service Producer detects that multiple resources are to be returned and choose to indirectly deliver the resources with the Server Push mechanism. +3. The NF Service Producer returns multiple PUSH\_PROMISE Requests before HEADERS frame and DATA frames(s) to the NF Service Consumer. Each PUSH\_PROMISE Request contains the URI of one resource to be + +transferred and the identifier of the reserved stream used for transferring the resource. The NF Service Producer shall also send links with the URIs of the resources in DATA frame(s) of the response message. + +- 4.1-4.n. The NF Service Producer sends Push Responses via corresponding reserved streams. Each Push Response contains the representation of the associated resource. +5. If the NF Service Consumer does not successfully receive a resource in time, it may send a request to get that resource, using the resource URI previously received from the Push Request. +- 5.a. The NF Service Producer returns the data of the requested resource in the response. + +### 4.9.6 Criteria for choosing the transfer method + +The following considerations may be used to determine which method to use transfer multiple resources to a NF Service Consumer. + +If the size of the representation of each resource is small, direct delivery is preferred. If the number of resources to be returned is large, the NF Service Producer may choose iterative delivery. + +NOTE 1: For this release of this specification, a JSON payload size less than 64000 octets is considered as not large and a JSON payload size larger than 64000 octets is considered as large. + +If the size of the representation of each resource is large, indirect delivery is preferred. If the NF Service Producer supports HTTP/2 Server Push, then: + +- when SETTINGS\_ENABLE\_PUSH parameter with value "1" has been received from the NF Service Consumer, as specified in IETF RFC 7540 [13], it should choose HTTP/2 Server Push to deliver the resource. +- when SETTINGS\_ENABLE\_PUSH parameter with value "0" has been received from the NF Service Consumer, as specified in IETF RFC 7540 [13], it must not choose HTTP/2 Server Push to deliver the resources. +- when SETTINGS\_ENABLE\_PUSH parameter has not been received from the NF Service Consumer, as specified in IETF RFC 7540 [13], it may decide whether to use HTTP/2 Server push or not, depending on other factors, e.g. operator policy, whether the client and server pertain to the same PLMN, etc. + +An NF Service Producer shall use Indirect Delivery with HTTP/2 Server Push only if the NF Service Consumer (client) indicated support for accepting server pushed resource representations, via the Supported Features negotiation as specified in clause 6.6.2 of 3GPP TS 29.500 [2]. + +NOTE 2: In this release the Indirect Delivery with HTTP/2 Server Push is not used by 3GPP service based interface APIs. + +## 4.10 Scopes definition for OAuth2.0 access token + +As indicated in 3GPP TS 33.501 [22] and in clause 6.7.3 of 3GPP TS 29.500 [2], the access to an 5GC API may be authorized by means of the OAuth 2.0 protocol (see IETF RFC 6749 [23]), based on local configuration. OAuth 2.0 supports the concept of scope values to signal which actual access rights an access token represents. + +Each 5GC API shall define a service-level scope set to the service name of the NF Service. This scope grants generic access to the given API, for those operations on resources that do not require a specific authorization. In addition, a 5GC API may define additional resource/operation-level scopes, that uniquely represents the type of operation (e.g. create/modify/read), the resource and the service; a resource/operation-level scope and the service-level scope, together, grant access to the operations on resources that require a specific authorization. + +The need for defining additional resource/operation-level scopes in a 5GC API depends on the API functionalities and service operations and on the expected NF service consumers, and thus is up to the API responsible Working Group to decide. The following points may be considered when assessing the need for additional scopes: + +- It should be carefully assessed during the design of the 5GC API whether different access rights to the functionalities provided by the API may be needed for different NF service consumers, e.g. considering example NF service consumers of the different service operations supported by the API. + +- A 5GC API defined with a service-level scope only, i.e. without additional resource/operation-level scopes, grants access permissions to all its service operations to all NF service consumers allowed to access the service. It should be ensured that designing the API in this way does not cause any vulnerability to the 5GS, e.g. by granting inappropriate read access to sensitive data to undue NF service consumers or by granting inappropriate write (or delete) access to undue NF service consumers. +- Additional scopes should be defined when it is needed to enable restricting the access to certain resource/operations of the 5GC API to specific NF service consumers. This may be the case e.g. when an API supports multiple service operations that may be invoked by different NF service consumers (possibly with different NF types or belonging to different S-NSSAIs, PLMNs or SNPNS), or when it is needed to differentiate access rights for read vs. create/modify/write operations. +- The definition of additional scopes comes with some implementation and network operation complexity. Care should be taken not to increase unreasonably the number of scopes defined in a 5GC API. +- Each additional resource/operation-level scope shall be defined with a clear description (in the main body and in the OpenAPI file of the Technical Specification defining the API) of the access right the additional scope corresponds to. The naming of the resource/operation-level scopes should follow the conventions defined in clause 5.3.16 for ease of understanding and consistency across all 5GC APIs. + +# --- 5 Documenting 5GC SBI APIs + +## 5.1 Naming Conventions + +### 5.1.1 Case Conventions + +The following case conventions for names and strings are used in the 5GC SBI service APIs. + +#### 1) UPPER\_WITH\_UNDERSCORE + +All letters of a string are capital letters. Digits are allowed. Word boundaries are represented by the underscore "\_" character. No other characters are allowed. + +Example 1: + +- a) DATA\_MANAGEMENT +- b) CELL\_CHANGE + +#### 2) lower\_with\_underscore + +All letters of a string are lowercase letters. Digits are allowed. Word boundaries are represented by the underscore "\_" character. No other characters are allowed. + +Example 2: + +- a) data\_management; +- b) cell\_change. + +#### 3) UPPER-WITH-HYPHEN + +All letters of a string are capital letters. Digits are allowed. Word boundaries are represented by the hyphen "-" character. No other characters are allowed. + +Example 3: + +- a) DATA-MANAGEMENT +- b) CELL-CHANGE + +#### 4) lower-with-hyphen + +All letters of a string are lowercase letters. Digits are allowed. Word boundaries are represented by the hyphen "-" character. No other characters are allowed. + +Example 4: + +- a) data-management; +- b) cell-change. + +#### 5) UpperCamel + +A string is formed by concatenating words. Each word starts with a letter or a digit. The first letter of each word shall be an uppercase letter; all other characters in the word shall be lowercase letters or digits. + +Abbreviations follow the same scheme (i.e. first letter uppercase, all other letters lowercase). + +Example 5: + +- a) DataManagement. +- b) CellChange +- c) 5QiPriorityLevel +- d) Amf3GppAccessRegistration + +#### 6) lowerCamel + +A string is formed by concatenating words. Each word starts with a letter or a digit. The first letter of the first word shall be a lowercase letter; the first letter of the rest of the words shall be an uppercase letter. All other characters in the words shall be lowercase letters or digits. + +Abbreviations follow the same scheme. + +Example 6: + +- a) dataManagement +- b) cellChange +- c) 5qiPriorityLevel + +NOTE: These naming conventions are used as guidelines, to provide some uniformity in the specification of the different 5GC APIs. However, for different reasons, sometimes exceptions can be made. In any case, the OpenAPI specifications are mandatory, and the different network elements cannot determine that a certain message, that otherwise complies to the OpenAPI specification, is incorrect based only on the fact that it does not follow a given naming convention in a certain data element. + +### 5.1.2 API Naming Conventions + +An API shall take the name of the corresponding service (e.g. Nudm\_SubscriberDataManagement). When used in URIs the name shall be converted to lower-with-hyphen and may use an abbreviated form (e.g. nudm-sdm). + +### 5.1.3 Conventions for URI Parts + +#### 5.1.3.1 Introduction + +The parts of the URI syntax that are relevant in the context of the 5GC SBI service APIs are as follows: + +- Path, consisting of segments, separated by "/" (e.g. segment1/segment2/segment3). +- Query, consisting of pairs of parameter name and value (e.g., ?mcc=262&mnc=01, where two pairs are presented). + +#### 5.1.3.2 URI Path Segment Naming Conventions + +- a) All path segments of a resource URI which represent a string constant shall use lower-with-hyphen (this implies that a path cannot end with "/"). + +Example 1: + +subscriber-data + +- b) If a resource represents a collection of entities and the last path segment of the resource URI is a string constant, that last path segment shall be plural. + +Example 2: + +.../prefix/api/v1/users + +- c) For resources where the last path segment of the resource URI is a string constant, that last path segment shall be a noun or a composite noun. + +Example 3: + +.../prefix/api/v1/users + +Example 4: + +.../prefix/api/v1/user-session + +- d) For custom operations, the last path segment of the URI via which the operation is invoked shall be a verb, or shall start with a verb. + +Example 5: + +.../app\_instances/{appInstanceId}/instantiate + +Example 6: + +.../sessions/terminate-all + +- e) All path segments of a URI which are variable names shall use lowerCamel, and shall be surrounded by curly brackets. + +Example 7: + +.../subscriber-data/{supi} + +- f) Once a variable is replaced at runtime by an actual string, the string shall follow the rules for a path segment defined in IETF RFC 3986 [9]. IETF RFC 3986 [9] disallows certain characters from use in a path segment. Each actual 5GC SBI service API specification shall define this restriction to be followed when generating values for path segment variables, or propose a suitable encoding (such as percent-encoding according to IETF RFC 3986 [9]), to escape such characters if they can appear in input strings intended to be substituted for a path segment variable. + +#### 5.1.3.3 URI Query Naming Conventions + +- a) URI query parameter names in queries shall use lower-with-hyphen. + +Example 1: + +?nf-type=AMF + +- b) Variables that represent actual parameter values in queries shall use lowerCamel and shall be surrounded by curly brackets. + +Example 2: + +?nf-id={chooseAValue} + +- c) When a variable is replaced at runtime by an actual string, the convention defined in clause 5.1.3.2 item f) applies to that string. + +### 5.1.4 Conventions for Names in Data Structures + +The following syntax conventions apply when defining the names for attributes in the 5GC SBI service API data structures, carried in the payload body of http requests and responses. + +- a) Names of attributes shall be represented using lowerCamel. + +Example 1: + +attributeName + +- b) Names of arrays (i.e. those with cardinality 1..N or 0..N) shall be plural rather than singular. + +Example 2: + +users + +- c) Each value of an enumeration type shall be represented using UPPER\_WITH\_UNDERSCORE. + +Example 3: + +PROHIBITTED\_LISTED + +- d) The names of data types shall be represented using UpperCamel. + +Example 4: + +ResourceHandle + +## 5.2 API Definition + +### 5.2.1 Resource Structure + +Resource structure shall define the structure of the resource URIs, the resources, the associated HTTP methods and custom operations used for the service. + +Figure 5.2.1-1 provides an example of the resource URI structure (i.e. resource tree) of an API. Table 5.2.1-1 provides an example of an overview of the resources defined for the service, and their applicable HTTP methods and custom operations. + +![Diagram showing the resource URI structure of the API. The root is {apiRoot}. It branches into two main paths. The first path is / This is a Collection, e.g. /sessions, which further branches into / This is a collection, e.g. /contexts, then / This is a Document, and finally / (dashed box). The second path is /, which branches into / e.g update, release, etc. (dashed box) and / e.g./subscriptions, which further branches into / This is a Document, e.g. /.](4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg) + +{apiRoot} + +``` + +graph TD + Root["{apiRoot}"] --> RA["/ This is a Collection, e.g. /sessions"] + Root --> B["/"] + RA --> A1["/ This is a collection, e.g. /contexts"] + A1 --> A2["/ This is a Document"] + A2 --> A3["/"] + B --> C1["/ e.g update, release, etc."] + B --> C2["/ e.g./subscriptions"] + C2 --> C2_ref["/ This is a Document, e.g. /"] + style A3 stroke-dasharray: 5 5 + style C1 stroke-dasharray: 5 5 + +``` + +Diagram showing the resource URI structure of the API. The root is {apiRoot}. It branches into two main paths. The first path is / This is a Collection, e.g. /sessions, which further branches into / This is a collection, e.g. /contexts, then / This is a Document, and finally / (dashed box). The second path is /, which branches into / e.g update, release, etc. (dashed box) and / e.g./subscriptions, which further branches into / This is a Document, e.g. /. + +**Figure 5.2.1-1: Resource URI structure of the API** + +In figure 5.2.1-1 the following graphical conventions are used: + +- a child node with a solid-line frame represents: + - a resource-URI that has at least one supported HTTP method associated, see e.g. "/resource A" in Figure 5.2.1-1. Such node may be any of the archetypes defined in Annex C1, C2 and C3; + - a resource-URI, which does not have any standard HTTP operation defined, but has a custom operation, see e.g. "/individual child resource A2" in Figure 5.2.1-1; +- a child node with a dashed-line frame represents a specific custom operation, see e.g. "/custom operation A3" and "/custom operation C1" in Figure 5.2.1-1. Such node is a Custom operation archetype, see Annex C4; +- a child node without a line around its frame (e.g. "/special node type B" in Figure 5.2.1-1) typically represents a path segment for which no standard HTTP operation is specified. This graphical representation is also used when a custom operation without an associated resource is defined for a path segment. . + +Table 5.2.1-1: Resources and methods overview + +| Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) | +|-----------------------|--------------------------------------------|---------------------------------|------------------------------------------| +| | | GET | | +| | | PUT | | +| | | PATCH | | +| | | POST | | +| | | DELETE | | +| | /release | release (POST) | | + +NOTE 1: The "API URI" is defined in clauses 3.1 and 4.4.1. + +For a resource, the "relative path after API URI" is appended to the API URI to form the resource URI as defined in clause 3.1. + +### 5.2.2 Resources and HTTP Methods + +Resources and HTTP methods shall specify the resource URI, resource URI variables for the resource and the standard HTTP methods supported by the resource. + +Example: + +Resource URI: {apiRoot}/// + +The resource URI variables supported by the resource shall be defined as table 5.2.2-1 illustrates. + +Table 5.2.2-1: Resource URI variables for the resource + +| Name | Definition | +|------------------------------------------------|-------------------------------------------------------| +| apiRoot | See clause 4.4.1 | +| < Name of resource URI variables for resource> | < Definition of resource URI variables for resource > | + +The {apiRoot} URI variable should be defined in clauses and this definition should be referenced to ease a possible update of the apiVersion value. + +Each method supported by the resource shall be described including the URI query parameters supported by the method, data structures supported by the request body, and the data structures supported by the response body. + +URI query parameters supported by the method shall be defined as table 5.2.2-2 illustrates. + +Table 5.2.2-2: URI query parameters supported by a method on the resource + +| Name | Data type | P | Cardinality | Description | Applicability | +|---------------|-------------------------|-------------|--------------------------------------------|----------------------|---------------| +| or n/a | or | | 0..1 or 1 or 0..N or 1..N or | | | + +**Name:** Name of query parameter in URI. If no query parameters are defined for the URI, the name should be marked as "n/a". + +**Data type:** Data type of URI query parameters, i.e. a data type defined in the specification. If no query parameter is defined for the URI, the column is left empty. + +**P:** Presence condition of URI query parameters. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). If no query parameter is defined for the URI, the column is left empty. + +**Cardinality:** Defines the allowed number of occurrence. It shall be "0..1", "1", "0..N", "1..N". If no query parameter is defined for the URI, the column is left empty. + +**Description:** Additional information for URI query parameter, i.e. describes the use of the parameter or the presence condition of the parameter and so on. + +**Applicability:** If the URI query parameter is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6.2 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the attribute can be used with any feature. + +NOTE 1: If no optional features are defined for an API, the applicability column can be omitted for that API. + +Data structures supported by the request body of the method shall be specified as table 5.2.2-3 illustrates. + +**Table 5.2.2-3: Data structures supported by the request body on the resource** + +| Data type | P | Cardinality | Description | +|-----------------------------------------------------|-----------------|------------------------------------------|----------------------| +| "" or "array()" or "map()" or n/a | "M", "C" or "O" | "0..1", "1", or "M..N", or | | + +**Data type:** Data type of the data structure in the request body. If the data type is indicated as "", the request body shall be of data type . If the data type is indicated as "array()", the request body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the request body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no request body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in request body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers with M being greater than or equal 0, and N being greater than 0 and M. For data type "", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no request body is allowed. + +**Description:** Additional information for a data structure, i.e. describes the use of the data structure or the presence condition of the data structure and so on. + +NOTE 2: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +Data structures supported by the response body of the method shall be specified as table 5.2.2-4 illustrates. + +**Table 5.2.2-4: Data structures supported by the response body on the resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------|-----------------|------------------------------------------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| "" or "array()" or "map()" or n/a | "M", "C" or "O" | "0..1", "1", or "M..N", or | | or | + +**Data type:** Data type of the data structure in the response body. If the data type is indicated as "", the response body shall be of data type . If the data type is indicated as "array()", the response body shall be an array + +(see IETF RFC 8259 [3]) that contains elements of data type **. If the data type is indicated as "map(**)", the response body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type **. ** can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no response body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in response body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type **. A cardinality of "*M..N*", is only allowed for data types "array(**)" and "map(**)" and indicates the number of elements within the array or map; the values *M* and *N* can either be the characters "M" and "N", respectively, or integer numbers with *M* being greater than or equal 0, and *N* being greater than 0 and *M*. For data type "**", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no response body is allowed. + +**Response codes:** Lists applicable response codes with name from HTTP Status Code Registry at IANA [12]. Mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall only be included if specific clarifications in the description part or special data types of the response body are required. Applicable HTTP status codes in addition to the mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall be included. + +**Description:** Additional information for a response, i.e. describes the meaning of the success case or meaning of the error case with additional statement regarding error handling. + +NOTE 3: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +### 5.2.3 Representing RPC as Custom Operations on Resources + +Custom operations (RPC-style interaction) may be used on a resource. The description of each custom operation contains the custom operation URI, the HTTP method on which the operation is mapped (typically POST), data structures supported by the request body and the data structures supported by the response body. + +An overview of the custom operations on a resource is illustrated in table 5.2.3-1. + +**Table 5.2.3-1: Custom operation** + +| Custom operation URI | Mapped HTTP method | Description | +|------------------------|--------------------|------------------------------------------| +| | e.g. POST | | + +Data structures supported by the request body of the method shall be specified as table 5.2.3-2 illustrates. + +**Table 5.2.3-2: Data structures supported by the mapped HTTP method request body on the resource** + +| Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------|-----------------|---------------------------------------------------|----------------------| +| " <type> " or "array( <type> )" or "map( <type> )" | "M", "C" or "O" | "0..1", "1", or " M..N ", or | | + +**Data type:** Data type of the data structure in the request body. If the data type is indicated as "**", the request body shall be of data type **. If the data type is indicated as "array(**)", the request body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type **. If the data type is indicated as "map(**)", the request body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type **. ** can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no request body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in request body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type **. A cardinality of "*M..N*", is only allowed for data types "array(**)" and "map(**)" and indicates the number of elements within the array or map; the values *M* and *N* can either be the characters "M" and "N", respectively, or integer numbers with *M* being greater than or equal 0, and *N* being greater than 0 and *M*. For data type "<*type*>", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no request body is allowed. + +**Description:** Additional information for a data structure, i.e. describes the use of the data structure or the presence condition of the data structure and so on. + +NOTE 1: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +Data structures supported by the response body of the method shall be specified as table 5.2.3-3 illustrates. + +**Table 5.2.3-3: Data structures supported by the mapped HTTP method response body on the resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------|-----------------|----------------------------------------------------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| "< type >" or "array(< type >)" or "map(< type >)" | "M", "C" or "O" | "0..1", "1" or "< M..N >", or | | or | + +**Data type:** Data type of the data structure in the response body. If the data type is indicated as "<*type*>", the response body shall be of data type **. If the data type is indicated as "array(<*type*>)", the response body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type **. If the data type is indicated as "map(<*type*>)", the response body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type **. ** can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no response body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in response body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type **. A cardinality of "*M..N*", is only allowed for data types "array(<*type*>)" and "map(<*type*>)" and indicates the number of elements within the array or map; the values *M* and *N* can either be the characters "M" and "N", respectively, or integer numbers with *M* being greater than or equal 0, and *N* being greater than 0 and *M*. For data type "<*type*>", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no response body is allowed. + +**Response codes:** Lists applicable response codes with name from HTTP Status Code Registry at IANA [12]. Mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall only be included if specific clarifications in the description part or special data types of the response body are required. Applicable HTTP status codes in addition to the mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall be included. + +**Description:** Additional information for a response, i.e. describes the meaning of the success case or meaning of the error case with additional statement regarding error handling. + +NOTE 2: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +### 5.2.3A Notifications + +Notifications based on the Callback URI as specified in clause 4.6.2.3 and clause 6.2 of 3GPP TS 29.500 [2] may be supported. The description of each notification contains the Callback URI, the HTTP method (typically POST), data structures supported by the request body and the data structures supported by the response body. + +An overview of the notifications is illustrated in table 5.2.3A-1. + +**Table 5.2.3A-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------------------------|----------------------------------------------|---------------------------------|---------------------------------| +|
e.g. Status Change Notification | < Callback URI >
e.g. {StatusCallbackUri} | e.g POST | e.g. Notify Event | + +Example: + +Callback URI: {notifUri} + +The callback URI variables shall be defined as table 5.2.3A-2 illustrates. + +**Table 5.2.3A-2: Callback URI variables** + +| Name | Definition | +|----------|-----------------------------------------------| +| notifUri | String formatted as URI with the Callback Uri | + +Data structures supported by the request body of the method shall be specified as table 5.2.3A-3 illustrates. + +**Table 5.2.3A-3: Data structures supported by the HTTP method request body** + +| Data type | P | Cardinality | Description | +|----------------------------------------------------|-----------------|---------------------------------------------|----------------------| +| "" or
"array()" or
"map()" | "M", "C" or "O" | "0..1", "1", or
"M..N", or | | + +**Data type:** Data type of the data structure in the request body. If the data type is indicated as "", the request body shall be of data type . If the data type is indicated as "array()", the request body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the request body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no request body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in request body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers with M being greater than or equal 0, and N being greater than 0 and M. For data type "", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no request body is allowed. + +**Description:** Additional information for a data structure, i.e. describes the use of the data structure or the presence condition of the data structure and so on. + +NOTE 1: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +Data structures supported by the response body of the method shall be specified as table 5.2.3A-4 illustrates. + +**Table 5.2.3A-4: Data structures supported by the mapped HTTP method response body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------|-----------------|-----------------------------------------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| "" or "array()" or "map()" | "M", "C" or "O" | "0..1", "1" or "M..N", or | | or | + +**Data type:** Data type of the data structure in the response body. If the data type is indicated as "", the response body shall be of data type . If the data type is indicated as "array()", the response body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the response body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no response body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in response body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers with M being greater than or equal 0, and N being greater than 0 and M. For data type "", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no response body is allowed. + +**Response codes:** Lists applicable response codes with name from HTTP Status Code Registry at IANA [12]. Mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall only be included if specific clarifications in the description part or special data types of the response body are required. Applicable HTTP status codes in addition to the mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall be included. + +**Description:** Additional information for a response, i.e. describes the meaning of the success case or meaning of the error case with additional statement regarding error handling. + +NOTE 2: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +### 5.2.4 Data Models + +#### 5.2.4.1 General + +The application data model supported by the API shall be specified with the following data types: + +1. Structured data types +2. Simple data types +3. Enumerations +4. Binary data +5. Data types describing alternative data types +6. Data types describing combinations of data types + +Each data type can be specific for the API or common to multiple APIs (offered by the same or different NFs). The common data types shall be specified in 3GPP TS 29.571 [5]. + +Characters in an enumeration or string data type in both simple and structured/combination data types specific for the API or common to multiple APIs shall be handled as case sensitive by default, unless stated otherwise. + +Strings representing a numerical value or a binary octet string, encoded as hexadecimal characters, shall be handled as case insensitive. + +#### 5.2.4.2 Structured data types + +The structured data types shall represent an object (see IETF RFC 8259 [3]). The structured data types shall contain attributes that are simple data types, structured data types, arrays (see below), maps (as defined below), enumerations, data types describing alternative data types, data types describing combinations of data types or "Any Type" (as described below). + +An array (see IETF RFC 8259 [3]) shall represent a list of values without keys and with significance in the order of sequence. All values shall be of the same type. + +A map shall represent an object (see IETF RFC 8259 [3]) with a list of key-value pairs (with no significance in the order of sequence), where all keys are of type string and shall be unique identifiers assigned by the application rather than by the schema, and where all values shall be of the same type. + +NOTE 1: Maps are supported by the OpenAPI specification [4] as described at . Maps can enable a faster lookup of elements identified by some key in huge data structures compared to arrays that contain the key within the elements. Maps can also be used instead of arrays to modify individual elements when modification instructions of the PATCH method are compliant to IETF RFC 7396 [7]. + +Each structured data type shall be specified in a separate clause as illustrated in table 5.2.4.2-1. + +**Table 5.2.4.2-1: Definition of type ** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------------------------------------------------|-----------------|-----------------------|----------------------|---------------| +| | "" or "array()" or "map()" or "Any Type" | "M", "C" or "O" | "0..1", "1" or "M..N" | | | + +**Table 5.2.4.2-2: Definition of type with nested structures** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------------------------------------------------------------------------------|-----------------|------------------|----------------------|---------------| +| | "array(map()" or "map(array()" or "array(array()" or "map(map()" | "M", "C" or "O" | "M1..N1(M2..N2)" | | | + +**Attribute name:** Name of attributes that belong to the specified data type. The attribute names within a structured data type shall be unique, and their relative order inside the structured data type shall not imply any specific ordering of the corresponding JSON elements in a JSON object. + +NOTE 2: The JSON specification (IETF RFC 8259 [3]) allows duplicate keys in a JSON object, but its usage is discouraged, since it makes interoperability more difficult, and makes the behavior of the JSON parsing software unpredictable. Similarly, that RFC encourages to make implementations not dependent on attribute ordering. + +**Data type:** Data type of the attribute. If the data type is indicated as "", the attribute shall be of data type . If the data type is indicated as "array()", the attribute shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the attribute shall be an object (see IETF RFC 8259 [3]) encoding a map that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a + +3GPP specification. If the data type is indicated as "Any Type", the attribute can either be "integer", "number", "string", "boolean", "array" or "object" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. + +**P:** Presence condition of a data structure in request body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers; with M being greater than or equal 0, and N being greater than 0 and M. For data type with nested structures, the cardinality is expressed in a nested manner, each level of the M and N values describe the cardinality of the corresponding level of the data structure. For data type "" and "Any Type", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". + +**Description:** Describes the meaning and use of the attribute and may contain normative statements. + +**Applicability:** If the attribute is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the attribute can be used with any feature. + +NOTE 3: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +NOTE 4: If no optional features are defined for an API, the applicability column can be omitted for that API. + +#### 5.2.4.3 Simple data types and enumerations + +The simple data types and enumerations can be referenced from data structures. All simple data types and enumerations should map to base types supported by OpenAPI specification [4]. Simple data types shall be specified as illustrated in table 5.2.4.3-1. + +**Table 5.2.4.3-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|------------------------------------------------------------------|-------------|---------------| +| | | | | + +**Type Name:** The name of the simple data type. + +**Type Definition:** Base types supported by OpenAPI specification [4], i.e. Boolean, integer, string and so on. + +**Description:** Additional descriptions for simple data types like range, string length, string pattern (regular expression) and so on. + +**Applicability:** If the type is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the type can be used with any feature. + +NOTE 1: If no optional features are defined for an API, the applicability column can be omitted for that API. + +Each enumeration type shall be respectively specified for their elements sets as illustrated in table 5.2.4.3-2. + +**Table 5.2.4.3-2: Enumeration ** + +| Enumeration value | Description | Applicability | +|---------------------|------------------------------------------|---------------| +| Enumeration value 1 | The description of this enum value | | +| Enumeration value 2 | The description of this other enum value | | + +**Enumeration value:** Defines the valid values, which can be integer, string or boolean, it is suggested to keep the same value style in one API specification. + +**Description:** Additional descriptions for enumeration attributes, like the meaning and usage of enumeration elements. + +**Applicability:** If the enumeration value is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the enumeration value can be used with any feature. + +NOTE 2: If no optional features are defined for an API, the applicability column can be omitted for that API. + +#### 5.2.4.4 Binary Data + +#### 5.2.4.5 Data types describing alternative data types or combinations of data types + +The data types describing alternative data types or combinations of data types shall represent an OpenAPI schema object using the "oneOf" , "anyOf" or "allOf" keyword to list alternative or to be combined data types (see the OpenAPI specification [4] and ). + +An instance (i.e. a corresponding part of a JSON file to be evaluated against the schema) matches a list of mutually exclusive alternative data types , as described using the OpenAPI "oneOf" keyword, if the instance matches against one and only one of the alternative data types. + +NOTE 1: Data types with the same simple data type but different format and/or pattern attributes are mutually exclusive if the corresponding formats and/or patterns are mutually exclusive. + +An instance (i.e. a corresponding part of a JSON file to be evaluated against the schema) matches a list of non-exclusive alternative data types, as described using the OpenAPI "anyOf" keyword, if the instance matches against one or more of the alternative data types. + +An instance (i.e. a corresponding part of a JSON file to be evaluated against the schema) matches a list of to be combined data types, as described using the OpenAPI "allOf" keyword, if the instance matches against all of the to be combined data types. + +The alternative or to be combined data types shall be simple data types, structured data types, arrays (see clause 5.2.4.2), maps (see clause 5.2.4.2), enumerations, data types describing alternative data types, or data types describing combinations of data types. + +Each structured data type shall be specified in a separate clause as illustrated in table 5.2.4.2-1. + +**Table 5.2.4.2-1: Definition of type as a list of <"mutually exclusive alternatives" / "non-exclusive alternatives" / "to be combined data types">** + +| Data type | Cardinality | Description | Applicability | +|----------------------------------------------------|---------------|----------------------|---------------| +| "" or
"array()" or
"map()" | "1" or "M..N" | | | + +**Data type:** Data type of the alternative or to be combined data type. If the data type is indicated as "", the alternative or to be combined data type shall be of data type . If the data type is indicated as "array()", the alternative or to be combined data type shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the alternative or to be combined data type shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers; with M being greater than or equal 0, and N being greater than 0. For data type "", the cardinality shall be set to "1". + +**Description:** Describes the meaning and use of the attribute and may contain normative statements. + +**Applicability:** If the type is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the type can be used with any feature. + +NOTE 2: If no optional features are defined for an API, the applicability column can be omitted for that API. + +NOTE 3: Data types describing alternative data types or combinations of data types can only be extended with additional data types in a backward compatible manner if the new data types are associated with an optional feature and the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2] is used to negotiate the support of that optional feature before that new data type is used. + +### 5.2.5 Void + +### 5.2.6 3GPP Custom HTTP Headers + +The definition of 3GPP APIs for the Service-Based Architecture includes the definition of 3GPP-specific HTTP headers, both generic (i.e. applicable to any API), and also API-specific headers. + +The definition of the generic HTTP headers is done in 3GPP TS 29.500 [2]. It consists of the ABNF definition of each header, along with a detailed description of the syntax and expected behaviour and handling by the receiver of such header; each header is specified in its own separate clause. + +3GPP TS 29.500 [2], Annex D, contains a self-contained full grammar of the entire set of custom HTTP headers, comprising both the definition of ABNF components/rules re-used from IETF RFCs, and the 3GPP-specific ABNF rule definitions. + +In addition, the zip file of the published 3GPP TS 29.500 [2] shall contain a file, named "TS29500\_CustomHeaders.abnf", that reflects the content of such Annex D, and the same file shall be made available on the 3GPP Forge GitLab repository mentioned in clause 5.3.1, along with the OpenAPI files, where tooling can be used for validation of the ABNF grammar. + +For API-specific HTTP header definition, a similar procedure shall be followed: if an API defines custom HTTP headers, their ABNF shall be included in the TS where such API is defined, along with the description of each header; each header shall be described in its own separate clause. + +Similarly, each TS that defines custom HTTP headers shall contain an Annex with a self-contained and minimal set of ABNF rules, including re-used rules from other sources (e.g. IETF RFCs, 3GPP TS 29.500, etc.). The zip file of the published TS shall contain a file with ".abnf" extension, with the same content as the Annex, and such file shall be made available, and validated, on 3GPP Forge/GitLab. + +## 5.3 OpenAPI specification files + +### 5.3.1 General + +5GC SBI APIs' OpenAPI specification files shall comply with the OpenAPI specification [4] and with the present clause 5.3. + +Each API shall be described in one OpenAPI specification file contained in an Annex of the 3GPP specification that describes the corresponding API. In addition, 3GPP specifications may contain OpenAPI specification file with common data types. + +Informative copies of all OpenAPI specification files contained in 3GPP Technical Specifications are available on a Git-based repository hosted in 3GPP Forge, that uses the GitLab software version control system. + +The repository is named "5G APIs" and is publicly accessible via the following URI: + +[https://forge.3gpp.org/rep/all/5G\\_APIs](https://forge.3gpp.org/rep/all/5G_APIs) + +NOTE: As indicated in 3GPP TR 21.900 [25], clause 5C, there is an alternative option for the availability and distribution of OpenAPI specification files (decided by the responsible Working Group of each TS), where these files can be stored in a 3GPP Forge GitLab repository and can be declared as normative. + +In that case, the TS does not contain OpenAPI descriptions in normative Annexes and instead it includes information about the repository used for the storage of OpenAPI files, e.g., GitLab group, repository name, branch, directory path (if any), and a Git tag representing the repository snapshot that corresponds to the specific TS version. + +### 5.3.2 Formatting of OpenAPI specification files + +The following guidelines shall be used when documenting OpenAPI specification files: + +- OpenAPI specification files shall be documented using YAML format (see YAML 1.2 [16]). For specific restrictions on the usage of YAML in OpenAPI, see OpenAPI Specification [4]. +- The style used for the specification shall be "PL" (Programming Language). +- The different scopes in the YAML data structures representing collections (objects, arrays...) shall use an indentation of two white spaces. +- Comments may be added by following the standard YAML syntax ("#"). +- Tabs shall not be used in OpenAPI specification files (e.g. within description fields). +- "Unbreakable" spaces (UTF-8 'NO-BREAK SPACE' (U+00A0)) shall not be used in OpenAPI specification files (e.g. within description fields). Only "normal" spaces (UTF-8 'SPACE' (U+0020)) shall be allowed. +- Trailing spaces (i.e. white spaces at the end of a line) should not be used in OpenAPI specification files. + +### 5.3.3 Info + +The OpenAPI specification file of an API shall contain an "info" object with the title that should be set to the same value as chosen for the API name in the heading of Annex A.x of the corresponding 3GPP TS, and with the version set as described in clause 4.3. + +The "info" object shall also include a "description" field, containing the name of the service that the API implements, and the same copyright notice as included in the front page of the corresponding 3GPP TS that specifies the API. The content of the "description" field shall be formatted using the YAML block notation for scalars (i.e. using the "|" character). + +EXAMPLE: "info" object with the title, version and description of the API. + +``` +info: + title: 'Nsmf_PDUSession' + version: '1.0.0' + description: | + SMF PDUSession Service. + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +``` + +### 5.3.4 externalDocs + +Each OpenAPI specification file shall provide an "externalDocs" object as illustrated in the example below that shall contain: + +- within the "description" field the 3GPP TS number, the version number and the name of the 3GPP TS describing the API, and +- within the "url" field a reference to the folder of that TS within the specification archive of the public 3GPP fileserver (i.e. "https://www.3gpp.org/ftp/Specs/archive///"). + +The version number in the "externalDocs" object shall be updated each time when the TS version contains new changes to the OpenAPI specification file. + +NOTE 1: If a new TS version is provided without any changes to the OpenAPI specification file, the TS version number included in the "description" field of the "externalDocs" field in the OpenAPI specification file is not updated. + +NOTE 2: If a new TS version is provided with changes to the OpenAPI specification file, the TS version number included in the "description" field of the "externalDocs" object is updated. However, if the API version in a given release is still the same as in a previous release, the first TS version in the first release that contains that API version is provided as TS version within the "externalDocs" object also in the TS versions of the subsequent releases. + +EXAMPLE: "externalDocs" object. + +``` +externalDocs: + description: 3GPP TS 29.503 V15.1.0; 5G System; Unified Data Management Services + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' +``` + +### 5.3.5 Servers + +As defined in clause 4.4.1, the API URI consists of {apiRoot}//. It shall be encoded in the corresponding OpenAPI specification file as "servers" field with {apiRoot} as variable. + +Example: + +``` +servers: +- url: '{apiRoot}/nxxx-yyyy/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4.1 of 3GPP TS 29.501 +``` + +### 5.3.6 References to other 3GPP-defined OpenAPI specification files + +Open API specification files may contain references to fragments of other 3GPP-defined Open API specification files. + +Such references shall be formatted to refer to local files stored on the same folder. + +NOTE 1: For the purpose of referencing, it is assumed that each OpenAPI specification file contained in a 3GPP specification is stored as separate physical file and that all OpenAPI specification files are stored in the same directory on the local server. + +The referenced file names for other 3GPP-defined Open API specification files shall comply with the following convention, unless a specific file name is indicated in the Annex of a 3GPP specification defining an OpenAPI specification file. The file name shall consist of (in the order below): + +- the 3GPP specification number in the format "TSxxyyy"; +- an "\_" character; +- if the OpenAPI specification file contains an API definition: the API name which shall be taken from the heading of the relevant annex A.x as defined in the corresponding 3GPP TS of that API. +- if the OpenAPI specification file contains a definition of CommonData: the string "CommonData"; and +- the string ".yaml". + +NOTE 2: The informative copies of OpenAPI specification files contained in 3GPP Technical Specifications at the public 3GPP file server (see clause 5.3.1) follow the above conventions and can be copied into a local folder in order to resolve references. + +Such a reference to another OpenAPI specification file shall be interpreted as referring to the related OpenAPI specification file contained in the version of the corresponding 3GPP TS indicated in the reference clause of the specification, i.e. for a non-specific reference the latest version of that 3GPP TS in the same Release as the specification. + +EXAMPLE: Reference to Data Type "Xxx" defined in the same file + +``` +$ref: '#/components/schemas/Xxx' +``` + +EXAMPLE: Reference to Data Type "Xxx" defined as Common Data in 3GPP TS 29.571: + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Xxx' +``` + +EXAMPLE: Reference to Data Type "Xxx" defined within API "Nudm\_UEAU" in 3GPP "TS 29.503": + +``` +$ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Xxx' +``` + +### 5.3.7 Server-initiated communication + +If an API contains server-initiated communication (see clause 6.2 of 3GPP TS 29.500 [2]), e.g. for notifications as described in clause 4.6.2.3, it should be described as "callbacks" in OpenAPI specification files. + +Example: + +``` +paths: + /subscriptions: + post: + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + callbackUrl: # Callback URL + type: string + format: uri + responses: + '201': + description: Success + callbacks: + myNotification: # arbitrary name + '{ $request.body#/callbackUrl }': # refers The callback URL in the POST + post: + requestBody: # Contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationBody' + responses: # Expected responses to the callback message + '204': + description: xxx +``` + +An API description may consist of standalone notifications, i.e., notifications where there is no previous interaction between consumer and producer to create a subscription. In such case, the API shall be documented by including a "dummy" subscription request pseudo-operation that shall not be used by the consumer. In such case, the notification URI may be obtained by the producer by different means (e.g. out of band configuration, or via a separate signaling interaction with the producer, or by querying NRF for the NF Profile of the consumer and looking for a "default notification endpoint"). + +Example: + +``` +paths: + /subscriptions: + post: + # This is a pseudo operation, consumers shall NOT invoke this method! +``` + +``` + +requestBody: + required: true + content: + application/json: + # Unspecified schema for the JSON body, since this is not used by consumer or producer + schema: {} +responses: + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + standaloneNotification: + '{notificationUri}': + # The URI in {notificationUri} is obtained out of band by the producer + post: + requestBody: # Contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationBody' + responses: # Expected responses to the callback message + '204': + description: xxx + +``` + +### 5.3.8 Describing the body of HTTP PATCH requests + +#### 5.3.8.1 General + +As described in clause 4.6.1.1.3.2, the bodies of HTTP PATCH requests either use a "JSON Merge Patch" encoding as defined in IETF RFC 7396 [7], or a "JSON Patch" encoding as defined IETF RFC 6902 [8]. + +It is possible to allow both encodings in a OpenAPI Specification [4] offering both schemas as alternative contents. + +NOTE: In Rel-15 a single encoding will be selected for each resource as backward compatibility considerations do not yet apply. + +An example OpenAPI specification file offering both PATCH encodings is included in Annex D. + +#### 5.3.8.2 JSON Merge Patch + +In the OpenAPI Specification [4] file, the content field key of the Request Body Object shall contain "application/merge-patch+json". The content field value is a Media Type Object identifying the applicable patch body Schema Object. The patch body Schema Object may contain structured data types derived from the data types used in the schema to describe a complete representation of the resource in such a manner that attributes that are allowed to be modified are listed in the "properties" validation keyword. + +NOTE 1: A derived structured data type is beneficial if the data types used to describe a complete representation of the resource contains mandatory attributes, if attributes are allowed to be removed by the PATCH operation, or if a checking by the OpenAPI tooling that only allowed modifications are done via the "additionalProperties: false" keyword is desired. It also provides a clear description in the OpenAPI specification file to developers which modifications need to be supported. + +As an alternative, the data types used in the schema to describe a complete representation of the resource may be used if any attributes that are allowed to be removed are marked as "nullable: true" in that schema. + +Any attributes that are allowed to be removed shall be marked as "nullable: true" in the patch body Schema Object. + +The "additionalProperties: false" keyword may be set. + +NOTE 2: The "additionalProperties: false" keyword enables the OpenAPI tooling to check that only allowed modifications are done. Extensions of the object in future releases are still possible under the assumption that the supported features mechanism is used to negotiate the usage of any new attribute prior to the PATCH invocation. If new optional attributes are expected to be introduced without corresponding supported feature or if PATCH can be used as first operation in an API, the usage of the "additionalProperties: false" keyword is not appropriate. + +#### 5.3.8.3 JSON PATCH + +In the OpenAPI Specification [4] file, the content field of the key Request Body Object shall contain "application/json-patch+json". The content field value is a Media Type Object identifying the applicable patch body. It may contain a mutually exclusive list (using the "oneOf" keyword) of all allowed modifications as tuples, where "path" is a string containing a JSON Pointer value referring to a JSON object that is allowed to be modified, "op" is an enumeration of allowed JSON PATCH operations on the JSON object identified by "path" and "value" representing the schema/type of the value that will be updated or added at the JSON object identified by "path". In addition, an open alternative containing an object with no properties may be added using the "anyOf" keyword. + +NOTE 1: A mutually exclusive list provides a clear description in the OpenAPI specification file to developers which modifications need to be supported. This is of particular interest if only a limited number of modifications need to be supported. If no open alternative is included, the OpenAPI tooling will also check that only allowed modifications are done. + +NOTE 2: The open alternative allows for extensions of the PATCH in scenarios where new optional attributes are expected to be introduced without corresponding supported feature or if PATCH can be used as first operation in an API. + +### 5.3.9 Structured data types + +For a structured data type, as defined in clause 5.2.4.2, the OpenAPI Specification [4] file shall contain a definition in the components/schemas clause defining a schema with the name of the structured data type as key. + +The schema shall contain: + +- "type: object"; +- "description: ", where is the description of the data type in the table defining the structured data type. The "description" attribute should be provided for all data types, specially if they are frequently reused from the same or other OpenAPI specification files; the "description" attribute shall always be provided for data types defined as maps, with a clear indication of the values (strings) used as key of the map. +- if any attributes in the structured data type are marked as mandatory, a "required" keyword listing those attributes; and +- a "properties" keyword containing for each attribute in the structured data type an entry with the attribute name as key and: + 1. if the data type is "": + - a. if the data type of the attribute is "string", "number", "integer", or "boolean"; + - i) a type definition using that data type as value ("type: "); and + - ii) optionally "description: ", where is the description of the attribute in the table defining the structured data type; or + - b. otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + 2. if the data type is "array()": + - a. a type definition "type: array"; + - b. an "items:" definition containing: + - i). if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii). otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same + +OpenAPI specification file and "\$ref: '/#/components/schemas/'"" if that data type schema is contained in file in the same directory on the same server; + +- c. if the cardinality contained an integer value as lower boundary, "minItems: "; and + - d. if the cardinality contained an integer value as upper boundary, "maxItems: "; and + - e. optionally "description: ", where is the description of the attribute in the table defining the structured data type; +3. if the data type is "map()": +- a. a type definition "type: object"; and + - b. an "additionalProperties:" definition containing: + - i. if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii. otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'"" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '/#/components/schemas/'"" if that data type schema is contained in file in the same directory on the same server; + - c. if the cardinality contained an integer value as lower boundary, "minProperties: "; and + - d. if the cardinality contained an integer value as upper boundary, "maxProperties: "; and + - e. "description: ", where is the description of the attribute in the table defining the structured data type; the "description" attribute shall always be provided for attributes defined as maps, with a clear indication of the values (strings) used as key of the map. + +NOTE: An omission of the "minProperties", and "maxProperties" keywords indicates that no lower or upper boundaries respectively, for the number of properties in an object are defined. An omission of the "minItems", and "maxItems" keywords indicates that no lower or upper boundaries, respectively, for the number of items in an array are defined. + +4. if the data type is "Any Type": +- a. if no properties to be defined, a pair of curly braces after the attribute name key ": {}", which is shorthand syntax for an arbitrary-type schema; or + - b. at least one of the following properties: + - i) if null value is allowed, "nullable: true"; or + - ii). "description: ", where is the description of the attribute in the table defining the structured data type. + +In the OpenAPI 3.0.0 Specification [4], the '\$ref' keyword must be the only attribute of the JSON object. Therefore it is not allowed to use e.g. a "description" attribute along with the '\$ref' keyword. However, if it is deemed necessary, a "description" attribute can be added before or after the '\$ref' keyword as a comment, i.e. by adding a comment sign '#' in front of the "description" field. + +NOTE: CT4 decides on case-by-case basis when it is deemed necessary to add such a "description" attribute along with the '\$ref' keyword. + +Example: + +**Table 5.3.9-1: Definition of type ExampleStructuredType** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|--------------------|---|-------------|------------------------------------------------|---------------| +| exSimple | ExSimple | M | 1 | exSimple attribute description | | +| exArrayElements | array(string) | O | 0..10 | exArrayElements attribute description | | +| exMapElements | map(ExStructure) | M | 1..N | exMapElements attribute description | | +| exNestedArray | array(map(string)) | M | 0..N(1..M) | exNestedArray attribute description | | +| exNestedMap | map(array(string)) | O | 1..N(2..M) | exNestedMap attribute description | | +| exAnyTypeNullableElement | Any Type | O | 0..1 | exAnyTypeNullableElement attribute description | | +| exAnyTypeNoDescription | Any Type | O | 0..1 | n/a | | + +The data structure in table 5.3.9-1 is described in an OpenAPI specification file as follows: + +``` + +components: + schemas: + ExampleStructuredType: + type: object + description: ExampleStructuredType data type description + required: + - exSimple + - exMapElements + properties: + exSimple: + $ref: '#/components/schemas/ExSimple' + exArrayElements: + type: array + items: + type: string + minItems: 0 + maxItems: 10 + description: exArrayElements attribute description + exMapElements: + type: object + additionalProperties: + # description: commented out description of the additionalProperties + $ref: '#/components/schemas/ExStructure' + minProperties: 1 + description: exMapElements attribute description, indicating values of the map keys + exNestedArray: + type: array + items: + type: object + additionalProperties: + type: string + minProperties: 1 + description: exNestedArray attribute description + exNestedMap: + type: object + additionalProperties: + type: array + items: + type: string + minItems: 2 + minProperties: 1 + description: exNestedMap attribute description + exAnyTypeNullableElement: + nullable: true + description: exAnyTypeNullableElement attribute description + exAnyTypeNoDescription: {} + +``` + +### 5.3.10 Data types describing alternative data types or combinations of data types + +For a data type describing alternatives, as defined in clause 5.2.4.5, the OpenAPI Specification [4] file shall contain a definition in the components/schemas clause defining a schema with the name of the data type describing alternatives as key. + +The schema shall contain: + +- the "oneOf", "anyOf" or "allOf" keyword selected as follows: + 1. for table caption "Definition of type as a list of mutually exclusive alternatives", the "oneOf" keyword; + 2. for table caption "Definition of type as a list of non-exclusive alternatives", the "anyOf" keyword; + 3. for table caption "Definition of type as a list of to be combined data types", the "allOf" keyword; +- a list of alternatives, containing for each line in the table describing the data type a separate line starting with "-": + 1. if the data type is "": + - a. if the data type of the attribute is "string", "number", "integer", or "boolean"; + - i) a type definition using that data type as value ("type: "); and + - ii) optionally "description: ", where is the description of the attribute in the table defining the structured data type; or + - b. otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + 2. if the data type is "array()": + - a. a type definition "type: array"; + - b. an "items:" definition containing: + - i). if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii). otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + - c. if the cardinality contained an integer value as lower boundary, "minItems: "; and + - d. if the cardinality contained an integer value as upper boundary, "maxItems: "; and + - e. optionally "description: ", where is the description of the attribute in the table defining the structured data type; + 3. if the data type is "map()": + - a. a type definition "type: object"; and + - b. an "additionalProperties:" definition containing: + - i). if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii). otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + - c. if the cardinality contained an integer value as lower boundary, "minProperties: "; and + - d. if the cardinality contained an integer value as upper boundary, "maxProperties: "; and + - e. optionally "description: ", where is the description of the attribute in the table defining the structured data type. + +NOTE: An omission of the "minProperties", and "maxProperties" keywords indicates that no lower or upper boundaries respectively, for the number of properties in an object are defined. An omission of the "minItems", and "maxItems" keywords indicates that no lower or upper boundaries, respectively, for the number of items in an array are defined. + +Example: + +**Table 5.3.10-1: Definition of type ExampleAlternativesType as a list of mutually exclusive alternatives** + +| Data type | Cardinality | Description | Applicability | +|------------------|-------------|---------------------------------------|---------------| +| ExSimple | 1 | exSimple attribute description | | +| array(string) | 0..10 | exArrayElements attribute description | | +| map(ExStructure) | 1..N | exMapElements attribute description | | + +The data structure in table 5.3.10-1 is described in an OpenAPI specification file as follows: + +``` +components: + schemas: + ExampleAlternativesType: + oneOf: + - $ref: '#/components/schemas/ExSimple' + - type: array + items: + type: string + minItems: 0 + maxItems: 10 + description: exArrayElements attribute description + - type: object + additionalProperties: + $ref: '#/components/schemas/ExStructure' + minProperties: 1 + description: exMapElements attribute description +``` + +### 5.3.11 Error Responses + +As described in clause 4.8 of the present specification and clause 5.2.7 of 3GPP TS 29.500 [2], 5GC SBI APIs use valid HTTP response codes as error codes in HTTP responses and may include a "ProblemDetails" data structure specified in clause 5.2.4.1 of 3GPP TS 29.571 [5] or an application-specific data structure. + +Table 5.2.7.1-1 of 3GPP TS 29.500 [2] specifies HTTP status code per HTTP method. For each HTTP method of an API, HTTP status codes shall be specified using response code tables as described in clauses 5.2.2 and 5.2.3. OpenAPI specification files shall include in the description of an HTTP method in the "paths" segment the mandatory HTTP status codes in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] and the HTTP status codes listed in response codes table of that HTTP method. + +For the purpose of referencing, HTTP error responses with "ProblemDetails" data structure are specified as part of the CommonData OpenAPI specification file in Annex A of 3GPP TS 29.571 [5]. + +Example: + +In the example below, the 400, 500 and default error response descriptions defined in 3GPP TS 29.571 [5] are referenced. + +``` +paths: + /users: + get: + responses: + '200': + content: + application/json + schema: + $ref: '#/components/schemas/ExampleGetBody' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +The following definitions provided in Annex A of 3GPP TS 29.571 [5] are used in that example: + +``` +components: + responses: + '400': + description: Bad request + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + default: + description: Generic Error +``` + +### 5.3.12 Enumerations + +For enumerations, as defined in clause 5.2.4.3, the OpenAPI Specification [4] file shall contain a definition in the components/schemas clause defining a schema with the name of the enumeration as key. + +The schema + +- shall contain the "anyOf" keyword listing as alternatives: + 1. the "type: string" keyword and the "enum" keyword with a list of all defined values for the enumeration; and + 2. the "type: string" keyword and the "description" keyword with a description stating that the string is only provided for forward compatibility with future extensions but is not used to encode contents defined in the present version of the specification. Future extensions may need to be defined in conjunction with the supported feature mechanism as specified in clause 6.6.2 of 3GPP TS 29.500 [2], and +- should contain a description field, containing the overall meaning and purpose of the enumeration; additionally, this field may contain a list of the defined values of the enumeration together with explanations of those values. + +NOTE: The "enum" keyword restricts the permissible values of the string to the enumerated ones. This can lead to extensibility problems when new values need to be introduced. + +Example: + +ExampleEnumeration represents xxx, and it is used to indicate yyy or zzz; it complies with the provisions defined in Table 5.3.12-1 + +**Table 5.3.12-1: Enumeration ExampleEnumeration** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------|---------------| +| "ONE" | Value One description | | +| "TWO" | Value Two description | | + +The data structure in table 5.3.12-1 is described in an OpenAPI specification file as follows: + +``` +components: + schemas: + ExampleEnumeration: + anyOf: + - type: string + enum: + - ONE + - TWO + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + ExampleEnumeration represents xxx, and it is used to indicate yyy or zzz; + it complies with the provisions defined in Table 5.3.12-1 of 3GPP TS ab.cde. +``` + +``` +Possible values are: +- ONE: Value One description +- TWO: Value Two description +``` + +### 5.3.13 Formatting of structured data types in query parameters + +Structured data types shall represent JSON objects or arrays. + +When used in query parameters of a URI, the following formatting shall be used: + +- JSON objects and arrays of JSON objects: they shall be formatted using the JSON syntax, which is specified in OpenAPI Specification [4] by including a "content:" block, and specifying the "application/json" media type, followed by the OpenAPI definition of the object. + +##### EXAMPLE: + +``` +- name: plmn-id + in: query + content: + application/json: + schema: + type: object + properties: + mcc: + type: string + mnc: + type: string +``` + +This results in the following formatting: + +``` +.../resource?plmn-id={"mcc":"123","mnc":"456"} +``` + +- Arrays of simple types: they shall be formatted using the OpenAPI "style" keyword set to "form" and the "explode" keyword set to "false". + +#### EXAMPLE: + +``` +- name: service-names + in: query + style: form + explode: false + schema: + type: array + items: + type: string +``` + +This results in the following formatting: + +``` +.../resource?service-names=service1,service2,service3 +``` + +As described in 3GPP TS 29.500 [2], clause 5.2.10, when the URI is composed, it shall escape (percent-encode) certain "reserved" characters. When an array of strings is formatted with "explode: false" keyword, the COMMA (U+002C) character is used as separator of the different string values; this implies that this character (the value separator) shall not be escaped, while any other comma used inside the different string values shall be escaped (percent-encoded). + +### 5.3.14 Attribute Presence Conditions + +In an OpenAPI Specification [4], presence conditions for attributes in a JSON schema definition shall be expressed by using the "required" keyword, indicating a list (array) of attributes that shall always be present in an object conforming to such schema. + +The "required" keyword may be used as part of any of the expressions defined by OpenAPI to combine schemas ("oneOf", "anyOf", "allOf", "not"). + +#### EXAMPLES: + +- JSON object defining attributes "a" and "b", of type integer, where attribute "a" shall always be present: + +``` +components: + schemas: + ExampleType1: + type: object + required: [ a ] + properties: + a: + type: integer + b: + type: integer +``` + +- JSON object defining attributes "a" and "b", of type integer, where at least one of them, or both, shall be present: + +``` +components: + schemas: + ExampleType2: + type: object + anyOf: + - required: [ a ] + - required: [ b ] + properties: + a: + type: integer + b: + type: integer +``` + +- JSON object defining attributes "a" and "b", of type integer, where at least one of them shall be present, but not both: + +``` +components: + schemas: + ExampleType3: + type: object + oneOf: + - required: [ a ] + - required: [ b ] + properties: + a: + type: integer + b: + type: integer +``` + +- JSON object defining attributes "a" and "b", of type integer, where "a" and "b" can be both absent but, if one of them is present, the other shall be absent: + +``` +components: + schemas: + ExampleType4: + type: object + not: + required: [ a, b ] + properties: + a: + type: integer + b: + type: integer +``` + +- JSON object defining attributes "a" and "b", of type integer, where "b" shall be present if "a" takes a given value (e.g., value 1), but may be absent otherwise: + +``` +components: + schemas: + ExampleType5: + type: object + properties: + a: + type: integer + b: + type: integer + anyOf: + - not: + required: [ a ] + properties: + a: + type: integer + enum: [ 1 ] +``` + +- required: [ b ] +- JSON object defining attributes "a" and "b", of type integer, where "b" shall be present if and only if "a" takes a given value (e.g., value 1): + +``` +components: + schemas: + ExampleType6: + type: object + properties: + a: + type: integer + b: + type: integer + oneOf: + - required: [ a ] + properties: + a: + type: integer + enum: [ 1 ] + - not: + required: [ b ] +``` + +- JSON object defining attributes "a", "b", "c" and "d", of type integer, where none of the pairs ("a" and "b") and ("c" and "d") shall be present: + +``` +components: + schemas: + ExampleType7: + type: object + properties: + a: + type: integer + b: + type: integer + c: + type: integer + d: + type: integer + allOf: + - not: + required: [ a, b ] + - not: + required: [ c, d ] +``` + +NOTE: Object schema definitions should not have property names in the "required" attribute for which a corresponding property definition does not exist. + +### 5.3.15 Usage of the "tags" field + +In an OpenAPI specification, all HTTP operations belonging to the same resource should include a "tags" field containing a same value, briefly describing that resource (e.g. using the name of the resource and its archetype). This results in all operations being grouped by the User Interface of OpenAPI tools, which helps with readability of the API documentation. + +#### EXAMPLE: + +``` +openapi: 3.0.0 +(...) +paths: + /nf-instances/{nfInstanceID}: + get: + summary: Read the profile of a given NF Instance + operationId: GetNFInstance + tags: + - NF Instance ID (Document) + (...) + put: + summary: Register a new NF Instance + operationId: RegisterNFInstance + tags: + - NF Instance ID (Document) + (...) + patch: +``` + +``` + +summary: Update NF Instance profile +operationId: UpdateNFInstance +tags: + - NF Instance ID (Document) +(...) + +``` + +### 5.3.16 Security + +As indicated in 3GPP TS 33.501 [22] and 3GPP TS 29.500 [2], the access to an 5GC API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [23]), based on local configuration. 5GC APIs thus need to support the OAuth2 protocol. + +To reflect this, the OpenAPI specification file of an API shall contain: + +- a top-level "security" field, that applies to the overall API unless overridden by a resource/operation-level "security" field, listing as alternatives: + - i) "{}" to indicate that usage of security is optional; and + - ii) the name of the security scheme for OAuth2, including in the array of scopes the name of the API as the only scope; and optionally +- a resource/operation-level "security" field, that applies to a specific operation on a specific resource, and overrides the top-level "security" field, listing as alternatives: + - i) "{}" to indicate that usage of security is optional; and + - ii) the name of the security scheme for OAuth2, including in the array of scopes the name of the API as the only scope, and + - iii) the name of the security scheme for OAuth2, including in the array of scopes the name of the API and the name of one scope to be used to invoke the specific resource/operation, and optionally + - iv) the name of the security scheme for OAuth2, including in the array of scopes the name of the API and the names of two scopes to be used to invoke the specific resource/operation, and + +NOTE: the option iv) can be used e.g. to define one scope for a set of specific resources, and a second scope for a specific operation within the set. + +- a "securitySchemes" field in the "components" clause defining a security schema for OAuth2 as follows: + - i) to be of type "oauth2"; and + - ii) with a "flows" field containing a "clientCredentials" field that contains: + - 1) a "tokenUrl" field pointing to the Access Token Request service provided by the NRF (see 3GPP TS 29.510 [18]); and + - 2) a "scopes" field defining all the different scopes applicable to this API, which includes the name of the corresponding API (using the format used within URIs of that API) to be used as the scope required to get access to the overall API, and also including those resource/operation-level scopes to be used as scopes required to invoke a specific operation on a specific resource. + +The naming of the resource/operation-level scopes should consist of the concatenation of the service name, a string or sequence of strings representing a resource name or set of resource names or custom operation, and optionally a string indicating the type of access (e.g. read/modify/create), separated by the ":" (colon) character. + +Such last string component of the resource/operation-level scope, that represents the type of access for a resource, should comply with the following principles: + +- "read": for GET operations for any resource archetype, +- "create": for POST or PUT operations that result in a creation of new resources from a collection or store resource, + +- "modify": for PUT, PATCH or DELETE operations that result on an update or deletion of a document resource, +- "invoke": for POST operations that result in the invocation of a custom operation +- "write": for any operation that results in creation, modification or deletion of resource representations. + +#### Example 1: + +``` +security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + +paths: + /nf-instances: + get: + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instances:read + parameters: + (...) + responses: + (...) + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnrf-nfm: Access to the Nnrf_NFManagement API + nnrf-nfm:nf-instances:read: Read access to the NF Instances (Collection) resource +``` + +#### Example 2: + +``` +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + +paths: + /exposure-data/{ueId}/access-and-mobility-data: + get: + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:read + parameters: + (...) + responses: + (...) + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudr-dr: Access to the Nudr_DataRepository API + nudr-dr:exposure-data: Access to the ExposureData data set +``` + +nudr-dr:exposure-data:read: Access to read ExposureData + +### 5.3.17 Reuse of Structured Data Types + +As indicated in clause 5.2.4.1, common data types can be defined in 3GPP TS 29.571 [5], in order to avoid the duplication of data type definitions across multiple APIs. + +When such data types are of type object, a given API may require that the common data type is extended with additional attributes, on top of those from the original definition in 3GPP TS 29.571 [5]. + +In such case, the new data type in that API should not re-define entirely the common data type, and instead, it should use appropriate constructs in OpenAPI (i.e. the "allOf" keyword) to indicate that the new data type contains all the attributes from the common data type, by referencing to it, and indicate the additional attributes needed in the new data type. + +#### EXAMPLE: + +The ProblemDetails data type is defined in 3GPP TS 29.571 [5] as: + +``` +ProblemDetails: + type: object + properties: + type: + $ref: '#/components/schemas/Uri' + title: + type: string + status: + type: integer + detail: + type: string + instance: + $ref: '#/components/schemas/Uri' + cause: + type: string + invalidParams: + type: array + items: + $ref: '#/components/schemas/InvalidParam' + minItems: 1 +``` + +Then, if a given API needs to extend ProblemDetails with an additional attribute, e.g. "action" of type string, it should define, e.g. an ExtendedProblemDetails data type as follows: + +``` +ExtendedProblemDetails: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ProblemDetailsExtension' + +ProblemDetailsExtension: + type: object + properties: + action: + type: string +``` + +### 5.3.18 Operation identifiers + +Service operations defined in an OpenAPI specification file should be assigned an Operation ID. + +#### EXAMPLE: + +``` +get: + operationId: ReadInfo + summary: Read Information. + tags: + - Information (Document) + parameters: + - name: infoType + in: path + description: Requested information Type + required: true + schema: + type: string +``` + +(...) + +### 5.3.19 Formatting of description fields + +As indicated in OpenAPI Specification [4], "description" fields support the CommonMark Markdown formatting (see ). + +In the 3GPP APIs, a description field may consist of multiple lines of YAML text; in order to have a proper output formatting (i.e., to be correctly rendered by tooling producing, e.g., HTML-based content), they should be documented as follows: + +- If line breaks need to be kept in the output formatting, this shall be indicated by two trailing white spaces (see ). Those are represented in the example below as gray-shaded non-break spaces for illustration purposes, but the YAML file shall contain two normal white spaces: + +``` +description: | + Text in the first line.    + More text in the second line.    + Additional text in the third line. +``` + +- If the text in the different lines should be formatted as a bulleted HTML list, each line may be prepended by the hyphen "-" character, as follows: + +``` +description: | + Text in the first line: + - List item 1 + - List item 2 +``` + +- If the text should be displayed in the output formatting as a single line, the YAML file may be formatted using one of the following options: + +- All text in a single YAML line, following the "description" keyword, such as: + +``` +description: This is a long description text that is formatted as a single YAML line, which is correct, but may not be optimal when the YAML file is displayed on a text editor configured to not automatically wrap long lines. +``` + +- The "description" keyword is followed by the ">" character and the text is placed in different lines (this option should be the preferred approach, rather than having extremely long lines in the YAML file), such as: + +``` +description: > + This text is the first part of a single line, + followed by this second line, + where all these 3 lines will be displayed in the same line in the output formatting. +``` + +# --- 6 Requirements for secure API design + +## 6.1 Introduction + +This clause contains a list of security requirements for API design provided by SA3. + +## 6.2 General + +The following requirements are intended as general guidance for 3GPP Stage 3 work in order to specify secure protocols and APIs. As such, these guidelines are independent of the specific technology and shall be followed at all times. + +- The valid format and range of values (when applicable) for each IE shall be defined unambiguously. + +NOTE 1: Explicitly defining format and range of values not only helps to improve the security of a certain implementation, but also allows for reliable interoperability between different protocol implementations. Example: Defining a "lowercase string variable of length 10 and range [a..z]" is much more explicit than just defining a "string of length 10". There are known vulnerabilities such as a denial of service (resulting in the parser converting from a string representing an integer – an attacker can pass in an arbitrarily large integer and trigger an unhandled exception) and such leading to a heap corruption and crash (proof-of-concept available), or potentially remote code execution (no proof-of-concept known). Unicode literals also require special treatment when doing string comparisons to ensure that equivalent strings return true when compared. + +- For each message the number of leaf IEs shall not exceed 2048K. If a leaf IE is an array of a simple data type, then the whole array shall count as one leaf. If a leaf IE is a data structure or an array of data structures, then it shall be considered a branch, i.e. it shall not be counted as a leaf. The data structure's (branch) attributes determine the number of leaves. For instance, a data structure with e.g. three attributes will count as three leaves. +- The maximum size of the JSON body of any HTTP request/response shall not exceed 16 million octets before compression is applied, if any. + +NOTE 2: APIs need to be designed taking care to avoid a too large HTTP payload size for performance reasons. + +- The maximum nesting depth of leaves shall not exceed 32. If a leaf IE is an array of a simple data type, then the whole array shall be considered as the first level of nesting. If a leaf IE is a data structure or an array of data structures, then it shall be considered a branch and the first level of nesting. The data structure's attributes (leaves) shall be considered as the second level of nesting. For instance, a data structure with e.g. one attribute-A, which is also a data structure with e.g. one attribute-B, then attribute-B will make the third level of nesting. + +NOTE 3: There are resource exhaustion attacks on JSON parsers. Defined maximum numbers of IEs, sizes and nesting depths allow implementations to know an upper bound of required resources. It also allows validation of incoming messages. Recursively processing nested objects leads to stack exhaustion and a denial of service bug. + +- For data structures where values are accessible using names (sometimes referred to as keys), e.g. a JSON object, the name shall be unique. The occurrence of the same name (or key) twice within such a structure shall be an error and the message shall be rejected. + +NOTE 4: Serialization schemes (e.g. JSON) can leave the handling of repeated names (keys) up to the implementer's discretion. For example, for a repeated name an error can be raised, the pair can be ignored, or the first or last value read can be used, though there is no canonical order in which a parser should treat the data it receives. Failure to adhere to consistent handling rules can lead to vulnerabilities. From a security perspective rejecting objects with repeated names, rather than accepting according to some rule, is the more robust solution, and aids in identification of potentially malicious activity. There are known attacks with specially crafted malicious messages that are designed to confuse implementations of NFs to get fraudulent messages into a PLMN. + +## 6.3 SBA-specific requirements + +The following requirements shall be considered for every network function that implements a service-based interface. + +- OpenAPI specifications are machine-readable JSON objects and can be used as the basis for re-configuring an NFs action when an API or message structure changes. Therefore, each OpenAPI specifications shall contain all necessary information to correctly and unambiguously parse the contents of the message body. + +NOTE: Attacks often exploit corner cases and unspecified behavior in order to exploit a system. Traffic normalization counters this by either dropping traffic that is malformed or by forcing certain information elements to a "normal" value. Typically, this relates to inconsistent fields. + +- 3GPP TS 33.501 [22] documents which type of information shall be confidentiality protected on the N32 interface. The fields where these types of information (e.g. SUPI) is contained may have different names. Even if the field names are different, the mechanism specified in clause 5.2.3.3 of 3GPP TS 29.573 [24] shall clearly identify the type of information carried in each IE and which information types shall be confidentiality protected. + +# --- Annex A (informative): TS Skeleton Template + +A TS Skeleton Template to be used as a starting point of drafting a 5G System SBI Stage 3 specification is available at the following location: + +[https://www.3gpp.org/ftp/information/All\\_Templates/29.xxx-SBI-Stage3-Template.zip](https://www.3gpp.org/ftp/information/All_Templates/29.xxx-SBI-Stage3-Template.zip) + +# --- Annex B (informative): Backward Incompatible Changes + +This Annex provides information about the changes in the API that are considered as backwards compatible and those that are considered as backwards incompatible. This list is to be considered informative and it may be expanded in future releases, when necessary. + +Backward compatible changes are additions or changes in the API that do not break the existing Service Consumer behaviour. Examples of backward compatible changes include: + +- Adding a new, optional child resource/URI; +- Supporting a new HTTP method; +- Adding new elements to a resource representation; +- Changing the order of fields in a resource representation; +- Addition of a new status code: + +NOTE 1: When a NF / NF Service receives a HTTP status code that it cannot recognize it will treat it as the corresponding x00 status code as specified in clause 5.2.7.3 of 3GPP TS 29.500 [2]. + +- Corrections of obvious errors in an OpenAPI file required to enable a correct parsing of the file such as misspelled references; +- Corrections that only relate to smaller and optional parts of the functionality (e.g. a supported feature, see 3GPP TS 29.500 [2] clause 6.6.2), even if the changes are backward incompatible with respect to that part of the functionality; and + +NOTE 2: It is recommended to only apply corrections which are also backward compatible with respect to such smaller and optional parts of the functionality. If this is not possible a new supported feature can be introduced to enable a negotiation of the support of the correction, and the old corresponding supported feature can be marked as "withdrawn" in the table defining the supported features of an API. + +- Backward-compatible changes related to the semantics (i.e. functional behaviour) specified for an API. + +Changes in the API that do not result in any loss of existing functionality (i.e. functionality that works fine if both consumer and provider do not support the change) if only consumer or only provider implements the change can be considered as backwards compatible corrections or additions. + +Backward incompatible changes are additions or changes in the API that break the existing Service Consumer behaviour. Here is a list of backward incompatible changes that shall require incrementing the 1st field (MAJOR) of the API version number unless they only relate to smaller and optional parts of the functionality (see above): + +- Removing a resource/URI; +- Removing support for an HTTP method; +- Renaming a field in a resource representation; +- Adding mandatory parameters to a resource URI or resource representation; + +- Attribute data type changes; +- Cardinality changes (NOTE 3); and + +NOTE 3: Whether attribute cardinality changes are backward compatible depend on the type of change. Examples of non-backward compatibility changes include decreasing the upper bound of a cardinality range for attributes sent by the NF service consumer, changing the meaning of the default behavior associated to the absence of an attribute of cardinality 0..N, etc. + +- Backward incompatible changes related to the semantics (i.e. functional behaviour) specified for an API. + +Changes in the API that result in loss of existing functionality (i.e. functionality that works fine if both consumer and provider do not support the change) if only consumer or only provider implements the change can be considered as backwards incompatible modifications. + +When a change although being categorised as backwards compatible correction or addition results in interoperability issues, it is expected that the issue will be resolved by implementing the change at both consumer and provider. + +# --- Annex C (Informative): Resource modelling + +## C.0 General + +When designing an API, one shall first think of defining the set of resources consumed. Resources represent objects that are modified by standard HTTP methods and that can be modelled with one of 4 archetypes detailed below. Resource archetypes help API designers to structure the resources. In this process the designer should refer to the appropriate archetype when the resource definition perfectly matches the archetype one. Referring to an archetype immediately defines what operations and HTTP methods are supported by the resource. + +The archetypes provided hereafter don't preclude the existence of resources of different types. + +## --- C.1 Document + +The document archetype is the conceptual base archetype of the other ones. Any resource that is not identified with one of the other resource archetypes is a document. + +A document may have child resources that represent its specific subordinate concepts. + +The archetype does not place any restriction on HTTP methods when acting on a document. + +Only CRUD operations are performed directly on a document resource, i.e. by sending an HTTP request to the URI of that resource. Custom methods are not performed directly on the resource, but by sending an HTTP request to a URI that is associated by a convention with the URI of the resource. + +## --- C.2 Collection + +The collection archetype can be used to model a resource that serves as a directory of resources. A collection is NF Service Provider-managed so the NF Service Provider decides the URIs of each resource that is created in the collection. + +NOTE: Even though a collection resource typically contains child resources, it is allowed that a particular collection resource does not contain any child resource at a particular point in time ("empty collection"). + +The Create and Read operations are performed on a collection directly. + +More specifically: + +- A collection child resource is created by sending a POST with the collection URI if accepted by the collection; +- A collection is read by sending a GET with the collection URI; +- The PUT and PATCH methods with the collection URI are not allowed; +- The DELETE method with the collection URI is only allowed if the collection resource has been created dynamically based on a request from the NF Service Consumer. +- The authorized operations on a collection child resource depend on that resource's archetype. + +## --- C.3 Store + +The store archetype can also be used to model a resource that serves as a directory of resources but a store is NF Service Consumer-managed. The NF Service Consumer solely decides what resource shall be added to / deleted from a store. The NF Service Consumer decides what the URI of the added resource is. + +NOTE: Even though a store resource typically contains child resources, it is allowed that a particular store resource does not contain any child resource at a particular point in time ("empty store"). + +The Read operation is performed on a store directly, and the Create operation is performed on store child resources. + +More specifically: + +- A store child resource is created by sending a PUT with the URI of the child resource to be created. +- A store is read by sending a GET with the store URI; +- The POST, PUT and PATCH methods with the store URI are not allowed; +- The DELETE method with the store URI is only allowed if the store resource has been created dynamically based on a request from the NF Service Consumer. +- Apart from Create (PUT), the authorized operations on a store child resource depend on that resource's archetype. + +## --- C.4 Custom operation + +The custom operation archetype can be used to model an unsafe and non-idempotent operation that is not a Create on a collection. + +A custom operation does not operate directly on the resource that would be identified by the custom operation URI. Instead, when the custom operation is associated with a resource, the operation is performed on this associated resource. For instance, a custom operation may modify the associated resource in a special way. This associated resource is identified by stripping the suffix string "" from the custom operation URI template in clause 4.4.2. + +When the custom operation is not associated with any resource but with the service, it acts as an executable function with input parameters and returns the result of the executed function in the response body, not modifying any resource. + +POST is the only method allowed with a custom operation URI. + +The semantic of the custom operation is encoded in the last segment of the URI template in clause 4.4.2: +/{custOpName}. + +# Annex D (informative): Example of an OpenAPI specification file for Patch + +As described in clause 4.6.1.1.3.2, the bodies of HTTP PATCH requests will either use a "JSON Merge Patch" encoding as defined in IETF RFC 7396 [7], or a "JSON Patch" encoding as defined IETF RFC 6902 [8]. This annex provides an example OpenAPI Specification [4] allowing both encodings. + +NOTE: Both encoding possibilities are shown in this example for illustrative purposes. However, only a single of the above encodings will be specified for each resource where the PATCH method is supported unless backward compatibility considerations necessitate the support of both encodings. + +``` +openapi: 3.0.0 + +info: + version: "1.0.0" + title: PATCH Example + +paths: + /inventory: + post: + summary: adds an inventory item + operationId: addInventory + description: Adds an item to the system + responses: + '201': + description: item created + '400': + description: 'invalid input, object invalid' + '409': + description: an existing item already exists + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItem' + description: Inventory item to add + + /inventory/{id}: + get: + summary: read inventory item + parameters: + - name: id + in: path + required: true + schema: + type: integer + responses: + '200': + description: search results matching criteria + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItem' + '400': + description: bad input parameter + patch: + summary: patch inventory item + parameters: + - name: id + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/PatchInventoryItem' + application/merge-patch+json: + schema: + $ref: '#/components/schemas/MergePatchInventoryItem' + responses: + '200': +``` + +``` + description: Patch was successfull and updated Inventory Item is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItem' + '204': + description: Patch was successfull + '400': + description: bad input parameter + +components: + + schemas: + InventoryItem: + type: object + required: + - name + - manufacturer + properties: + id: + type: integer + name: + type: string + manufacturer: + $ref: '#/components/schemas/Manufacturer' + customers: + type: array + items: + type: string + + Manufacturer: + type: object + description: Represents the manufacturer. + required: + - name + properties: + name: + type: string + homePage: + type: string + format: url + phone: + type: string + + ManufacturerRm: + type: object + description: > + This data type is defined in the same way as the "Manufacturer" data type, + but with the OpenAPI "nullable: true" property. + required: + - name + properties: + name: + type: string + homePage: + type: string + format: url + phone: + type: string + nullable: true + + PatchInventoryItem: + type: array + description: A JSON PATCH body schema to Patch selected parts of an Inventory Item + items: + anyOf: + - oneOf: + - type: object + description: Modifies the URL of a Manufacturer + properties: + op: + type: string + enum: + - "add" + - "remove" + - "replace" + path: +``` + +``` + + type: string + pattern: '^/manufacturer/homePage$' + value: + type: string + format: url + required: + - "op" + - "path" + - type: object + description: Modifies a Manufacturer + properties: + op: + type: string + enum: + - "replace" + path: + type: string + pattern: '^/manufacturer$' + value: + $ref: '#/components/schemas/Manufacturer' + required: + - "op" + - "path" + - "value" + - type: object + description: Modifies a Customer + properties: + op: + type: string + enum: + - "add" + - "remove" + - "replace" + path: + type: string + pattern: '^/customers/(-|\d+)$' + value: + type: string + required: + - "op" + - "path" + - type: object + description: Open Alternative + minItems: 1 + +MergePatchInventoryItem: + description: A JSON Merge PATCH body schema to Patch selected parts of an Inventory Item + type: object + properties: + manufacturer: + $ref: '#/components/schemas/ManufacturerRm' + customers: + type: array + description: Allows to replace the entire array, but not to modify individual elements. + items: + type: string + +``` + +# --- Annex E (Informative): Considerations for handling of JSON arrays + +This Annex provides guidelines on the use of JSON arrays on the SBI APIs of the 5GC. + +As described in clause 5.2.4, the data model of an API definition in a 5GC API consists of any of the different data types supported by OpenAPI, corresponding to the different data structures found in the JSON data format. One of these structures is the "array", representing a set of ordered values. + +It should be noted that, while JSON allows that the value of the elements of an array may be of different types, in OpenAPI Specification [4] this is further restricted, and all elements of an array shall be of the same type. + +Also, it is important to note that the JSON format itself, as specified in IETF RFC 8259 [3], does not define any syntax to refer to specific array elements. + +However, there are certain conventions to specify mechanism to refer to array elements, e.g. based on the position a given element has in the array. + +In particular, the JSON Pointer syntax defines a string syntax for identifying a specific value within a JSON document. This syntax consists of a number of tokens separated by the "/" character; in order to refer to a specific element in an array, then token shall contain an unsigned decimal value, indicating the zero-based index of the element in the array. + +### EXAMPLE: + +JSON document: + +``` +{ + "attr1": 0, + "attr2": true, + "attr3": [ 1, 2, 3 ] +} +``` + +JSON Pointer expression "/attr3/0" evaluated on such JSON document: 1 + +There are several scenarios, frequently employed in the 5GC APIs, that make use of the JSON Pointer mechanism to refer to specific elements in an array: + +- Update of resources using the PATCH method, as described in clause 4.6.1.1.3.2. If the syntax used in the PATCH request payload is based on the "JSON Patch" format, then the JSON Pointer mechanism is used to specify patch operations applied to specific array elements. +- Notifications of events (such as data changes), as described in clause 4.6.2.3, using as notification payload the notation defined in "NotifyItem" / "ChangeItem" data types defined in 3GPP TS 29.571 [5]. This notation is similar to "JSON Patch", so it also makes use of the JSON Pointer syntax to refer to specific array elements. +- Explicit usage of attributes containing JSON Pointer expressions in request or response payloads. + +In these scenarios, it is critical that any JSON Pointer expression is applied by both client and server on the exact same array representation, since otherwise the indexes may vary, and the JSON Pointer will give unexpected results. + +A typical scenario that may create issues could be as follows: + +1. NF Service Consumer sends a first GET request towards a NF Service Producer, including certain query parameters in the HTTP request, that result into retrieving a resource representation that contains a subset of the data that the NF Service Producer holds under such resource. When such subset refers to returning just some of the elements of an array, rather than the entire array, then the content of the array will differ between consumer and producer. +- 2a. The NF Service Consumer sends a subsequent PATCH request towards the NF Service Producer, with the intention to modify a given element of the array (specified by the array index, per the JSON Pointer syntax). This results into the server modifying a wrong element in the array, given that the NF Service Producer contains a different array. +- 2b. The NF Service Consumer may subscribe to be notified by the NF Service Producer when a given resource representation has changed. When the NF Service Producer detects such a change, it sends a notification that may include a reference to an array index, which may be different than the array index kept by the NF Service Producer. +- 2c. The NF Service Consumer is a stateless NF Service Consumer that has no local representation of the array that subscribes to be notified by the NF Service Producer when a given resource representation has changed. + +Another scenario that may lead to incorrect array updates is: + +1. Two different NF Service Consumer sends a GET request towards a NF Service Producer to retrieve the representation of a certain resource. +2. A first NF Service Consumer NF1 sends a PATCH request towards the NF Service Producer, with the intention to delete a given element of the array (specified by the array index, per the JSON Pointer syntax). This results in some of the array indexes being changed (of those elements placed after the deleted element) + +3. A second NF Service Consumer NF2, sends another PATCH request towards the NF Service Producer, to modify any of the elements of the array whose index was affected by the previous operation done by NF1. This results in modifying unintentionally the wrong array element. + +The design of 5GC SBI APIs should take into account these scenarios and provide mechanisms to avoid unintended modifications of array elements, when they are referred by their position index in the array. + +To achieve these, both NF Service Consumer and Producer (taking the role of HTTP client and server) should ensure that any resource update takes place on a known and current resource representation, based on the content of ETag values sent along with resource representations by the resource owner. + +If an NF Service Consumer needs to cache a resource representation received from an NF Service Producer (i.e. the JSON information received in an HTTP response message), it shall use the exact same representation of arrays as received from the service producer. + +When sending notifications or modifications whose semantics is based on the JSON Pointer syntax, the sending NF shall use the exact same representation of arrays as previously signalled in a previous interaction with the receiver of such notifications/modifications. Further, when sending notifications whose semantics is based on the JSON Pointer syntax, if the NF Service Consumer is a stateless NF Service Consumer and thus has no local representation of the array, the NF Producer shall use the complete replacement array representation as the NF Service Consumer is otherwise required to request the complete data from the NF Service Producer with a GET request. + +# Annex F (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|---------|-----|-----------------------------------------------|----------------| +| Date | Meeting | TDoc | CR | R
ev | Cat | Subject/Comment | New
version | +| 2017-10 | CT4#80 | C4-175250 | | | | TS skeleton | 0.1.0 | +| 2017-10 | CT4#80 | C4-175358
C4-175252
C4-175253
C4-175254
C4-175255
C4-175331
C4-175332
C4-175333
C4-175334
C4-175359
C4-175327
C4-175328
C4-175360
C4-175330
C4-175336
C4-175337 | | | | Inclusion of pCRs agreed at CT4#80 | 0.2.0 | +| 2017-12 | CT4#81 | C4-176414
C4-176372
C4-176447
C4-176415
C4-176416
C4-176417
C4-176418
C4-176250
C4-176419
C4-176422 | | | | Inclusion of pCRs agreed at CT4#81 | 0.3.0 | +| 2018-01 | CT4#82 | C4-181179
C4-181384 | | | | Inclusion of pCRs agreed at CT4#82 | 0.4.0 | +| 2018-03 | CT4#83 | C4-182396
C4-182397
C4-182394
C4-182395
C4-182399
C4-182261
C4-182184
C4-182330
C4-182398
C4-182332 | | | | Inclusion of pCRs agreed at CT4#83 | 0.5.0 | +| 2018-03 | CT#79 | CP-180029 | | | | Presented for information | 1.0.0 | +| 2018-04 | CT4#84 | C4-183238
C4-183288
C4-183289
C4-183291
C4-183292
C4-183385
C4-183387
C4-183388
C4-183477
C4-183478 | | | | Inclusion of pCRs agreed at CT4#84 | 1.1.0 | +| 2018-05 | | | | | | 29.xxx-SBI-Stage3 Template added in zip-file. | 1.1.1 | +| 2018-05 | CT4#85 | C4-184492
C4-184493
C4-184494
C4-184495
C4-184496
C4-184544
C4-184614
C4-184503
C4-184497
C4-184592 | | | | Inclusion of pCRs agreed at CT4#85 | 1.2.0 | +| 2018-06 | CT#80 | CP-181099 | | | | Presented for approval | 2.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | +| 2018-07 | | | | | | TS template added in zip-file | 15.0.1 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------------------------|--------| +| 2018-09 | CT#81 | CP-182054 | 0001 | 4 | B | Security requirements for API design | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0002 | | F | Example URIs in figures | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0003 | 2 | F | Clarification on the use of API version number | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0004 | 2 | F | External Docs Clause in OpenAPI file | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0006 | 1 | B | JSON Structures in Query Parameters | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0008 | 1 | F | Servers Selection in OpenAPI | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0009 | | F | Query Parameter | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0010 | | F | yaml file names | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0011 | | F | OpenAPI servers field | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0012 | 1 | F | Query parameter | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0013 | 1 | F | presence condition and cardinality | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0014 | 1 | F | Clarification on Naming Conventions and Digits | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0015 | 1 | F | URIs of created resources | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0016 | 1 | F | Custom operation in resource structure presentation | 15.1.0 | +| 2018-12 | CT#82 | CP-183012 | 0018 | 2 | F | Attribute Presence Conditions | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0019 | 1 | F | Version addressed by references within OpenAPI files | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0020 | 2 | F | Resolve Editor's Note | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0021 | | F | Attribute with Any Type | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0022 | | F | Incorrect resource URI structure presentation | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0023 | 1 | F | Storage of OpenAPI files within a central directory | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0025 | 3 | F | Complex query expression | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0031 | 1 | F | Correction and Clarification on Security Requirements | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0032 | 2 | R | Subscription Lifetime for Subscribe / Notify operations | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0033 | | F | Usage of the "tags" field in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0035 | 2 | F | Corrections to API versioning | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0036 | 1 | F | Security in Open API specification files | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0037 | 1 | F | Custom Operations | 15.2.0 | +| 2019-03 | CT#83 | CP-190017 | 0039 | 2 | F | Address Editor's Note on implicit subscriptions | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0040 | | F | Address Editor's Note on partial representation in POST response | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0041 | 1 | F | Maximum HTTP payload size | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0042 | 1 | F | HTTP Scheme | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0043 | 2 | F | Resolve Editor's Notes | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0044 | | F | Correction to Minor Field Increment Rules in API Versioning | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0045 | 1 | F | Handling of unknown attributes during resource creation and modification | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0046 | 1 | F | Correct use of "OpenAPI" name | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0047 | 1 | F | Resolution of Editor's Notes in Annex C | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0048 | 2 | F | IANA registration of "3gppHal+json" media type | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0049 | 1 | F | Addition of applicability column to query parameters table | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0050 | 1 | F | Removing multiple redundant appearances of major version number in TS template to ease update of that number | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0051 | 2 | F | Storage of OpenAPI specification files | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0052 | - | F | Use of Relative URI in Location Header | 15.3.0 | +| 2019-06 | CT#84 | CP-191028 | 0053 | 2 | F | Criteria for non-backward compatible changes | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0056 | 1 | F | Reuse of Structured Data Types | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0057 | 1 | F | Delete editor's note on complex query | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0059 | - | F | Correction on Notifications | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0060 | 1 | F | Copyright Note in YAML files | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0055 | 2 | F | Precedence of OpenAPI file | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0054 | 4 | F | Withdrawing API versions | 15.4.0 | +| 2019-06 | CT#84 | CP-191057 | 0061 | 2 | F | Updates to TS Template for SBI | 16.0.0 | +| 2019-09 | CT#85 | CP-192101 | 0065 | 1 | F | Externaldoc version number change | 16.1.0 | +| 2019-12 | CT#86 | CP-193025 | 0069 | 2 | A | Fourth field of API versions | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0070 | 1 | F | Add Corresponding API descriptions in clause 5.1 | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0066 | 2 | B | HAL-forms media type | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0067 | 1 | F | Extending ProblemDetails for Backward Compatibility | 16.2.0 | +| 2020-03 | CT#87e | CP-200054 | 0072 | 1 | F | Storage of YAML files in ETSI Forge | 16.3.0 | +| 2020-03 | CT#87e | CP-200039 | 0073 | 1 | F | New tables in 29.501 template | 16.3.0 | +| 2020-06 | CT#88e | CP-201034 | 0074 | 2 | F | Clarifications to callback URI | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0075 | 1 | B | Resource-Level Authorization | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0077 | 2 | F | Delimiters - URI and SBI specific | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0078 | 2 | F | URI types | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0080 | - | F | Correct the Resource Tree Example | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0081 | 1 | F | Requirements for secure API design | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0079 | 1 | F | API URI correction and template update | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0082 | 1 | F | Maximum JSON payload size | 16.4.0 | +| 2020-06 | CT#88e | CP-201071 | 0076 | - | F | Correction of the method used for Notification | 16.4.0 | +| 2020-06 | CT#88e | CP-201071 | 0083 | 1 | F | Missing abbreviations | 16.4.0 | +| 2020-09 | CT#89e | CP-202043 | 0093 | - | A | Storage of YAML files in 3GPP Forge | 16.5.0 | +| 2020-09 | CT#89e | CP-202109 | 0085 | 2 | D | Editorial fixes | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0086 | 2 | F | Handling of JSON Arrays | 16.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------|--------| +| 2020-09 | CT#89e | CP-202110 | 0087 | - | F | Naming requirements for resource/operation-level scopes | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0088 | 1 | F | Data types with string type | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0089 | - | F | Content of Location header when TLS is used | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0090 | - | F | Miscellaneous corrections | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0091 | 1 | F | API URI correction and template update | 16.5.0 | +| 2020-12 | CT#90e | CP-203064 | 0094 | - | F | API Versioning System based on Semantic Versioning | 17.0.0 | +| 2020-12 | CT#90e | CP-203064 | 0095 | - | F | OpenAPI Reference | 17.0.0 | +| 2020-12 | CT#90e | CP-203064 | 0096 | - | F | OpenAPI "description" fields in data type definitions | 17.0.0 | +| 2021-03 | CT#91e | CP-210027 | 0097 | - | D | Use of inclusive terminology | 17.1.0 | +| 2021-03 | CT#91e | CP-210021 | 0098 | - | F | Guidance on Error Response design for Indirect Communication | 17.1.0 | +| 2021-03 | CT#91e | CP-210021 | 0099 | 1 | B | SBI TS Template Update | 17.1.0 | +| 2021-03 | CT#91e | CP-210021 | 0101 | - | D | Editorial Corrections | 17.1.0 | +| 2021-03 | CT#91e | CP-210021 | 0102 | - | F | Withdrawing API versions | 17.1.0 | +| 2021-06 | CT#92e | CP-211065 | 0105 | - | A | Nested cardinality | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0103 | 1 | F | Change Notification of Array to Stateless NF Consumer | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0103 | 1 | B | Additional guidelines for OpenAPI specification files | 17.2.0 | +| 2021-09 | CT#93e | CP-212026 | 0107 | 1 | F | Compatibility Clarification | 17.3.0 | +| 2021-09 | CT#93e | CP-212026 | 0108 | 2 | F | Clarification to API name guidance in the SBI template | 17.3.0 | +| 2021-09 | CT#93e | CP-212026 | 0109 | 2 | F | Corrections to the API URI and relative URI below root concepts | 17.3.1 | +| 2021-12 | CT#94e | CP-213085 | 0110 | 1 | F | Miscellaneous clarifications | 17.4.0 | +| 2021-12 | CT#94e | CP-213087 | 0111 | 5 | F | Resource URI structure in the Guidelines for Services Definition | 17.4.0 | +| 2021-12 | CT#94e | CP-213086 | 0112 | 2 | F | Resource URI structure in the SBI skeleton | 17.4.0 | +| 2021-12 | CT#94e | CP-213086 | 0114 | - | F | Subscription update with PUT request | 17.4.0 | +| 2022-03 | CT#95e | CP-220023 | 0115 | 1 | F | Adding examples to the Resource URI structure clause | 17.5.0 | +| 2022-03 | CT#95e | CP-220023 | 0116 | 1 | F | Handling Description field along with the '\$ref' keyword | 17.5.0 | +| 2022-03 | CT#95e | CP-220023 | 0117 | 1 | F | Aligning SBI-Stage3-Template with TS 29.501 | 17.5.0 | +| 2022-03 | CT#95e | CP-220023 | 0118 | - | F | JSON schema example with a combination of restrictions | 17.5.0 | +| 2022-03 | CT#95e | CP-220024 | 0122 | - | F | URL Encoding | 17.5.0 | +| 2022-03 | CT#95e | CP-220024 | 0120 | 1 | D | Miscellaneous corrections to the 5GC SBI TS Skeleton | 17.5.0 | +| 2022-03 | CT#95e | CP-220025 | 0119 | 1 | F | Formatting of Description Fields | 17.5.0 | +| 2022-03 | CT#95e | CP-220025 | 0121 | 1 | F | Notification Clarification | 17.5.0 | +| 2022-06 | CT#96 | CP-221027 | 0123 | 1 | F | SBI stage 3 template update - OpenAPI | 17.6.0 | +| 2022-06 | CT#96 | CP-221027 | 0124 | 1 | F | SBI stage 3 template update - Data models | 17.6.0 | +| 2022-06 | CT#96 | CP-221027 | 0125 | - | F | Remove the apiVersion placeholder from the resource URI variables table | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0127 | - | F | OAuth2 clarification | 17.6.0 | +| 2022-06 | CT#96 | CP-221029 | 0126 | 1 | F | Default logical relationship between query parameters | 17.6.0 | +| 2022-09 | CT#97e | CP-222070 | 0129 | 1 | A | Essential Correction for Location Header in 201 Response | 17.7.0 | +| 2022-09 | CT#97e | CP-222026 | 0130 | 1 | F | Limits for number and length of query parameters | 17.7.0 | +| 2022-12 | CT#98e | CP-223027 | 0132 | - | F | Standalone Notifications | 18.0.0 | +| 2022-12 | CT#98e | CP-223029 | 0131 | 1 | F | Description fields in enumerations | 18.0.0 | +| 2023-03 | CT#99 | CP-230090 | 0137 | 2 | F | Maximum number of leaves | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0134 | 1 | D | Editorial modifications to the rules for incrementing API version | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0138 | 1 | F | Guidelines for OAuth2 scopes definition | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0139 | - | F | Correction of the NO-\$REF SIBLINGS error for nullable attributes within PATCH method | 18.1.0 | +| 2023-06 | CT#100 | CP-231026 | 0140 | 1 | B | Adding Redirection clause to SBI template | 18.2.0 | +| 2023-06 | CT#100 | CP-231027 | 0133 | 2 | F | Rules for incrementing API version field values | 18.2.0 | +| 2023-09 | CT#101 | CP-232033 | 0142 | 2 | B | Prefix in Callback URIs | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0143 | - | B | Documentation of 3GPP Custom HTTP Headers | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0144 | 1 | F | Correct SBI stage 3 template for custom operations without resources | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0145 | - | B | Uptade of the template to add ABNF | 18.3.0 | +| 2023-12 | CT#102 | CP-233028 | 0148 | 1 | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233028 | 0149 | 1 | F | Update of SBI TS skeleton template | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0151 | - | F | Case-insensitive hexadecimal encoding | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 0150 | 1 | B | Optional usage of 3GPP Forge as normative storage of OpenAPI files | 18.4.0 | +| 2023-12 | CT#102 | CP-233062 | 0147 | - | A | wrong CR implementation | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29507/00504fc688ebcf131ccbeff94dfc9939_img.jpg b/raw/rel-18/29_series/29507/00504fc688ebcf131ccbeff94dfc9939_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..90c3642845fe9acea67ff26ad8c7614cba794fb9 --- /dev/null +++ b/raw/rel-18/29_series/29507/00504fc688ebcf131ccbeff94dfc9939_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:047998ee9a6ef3b9797ed1bd283c640167c399dd489e67b6825b62bbce904dc7 +size 32871 diff --git a/raw/rel-18/29_series/29507/3e2a8dc8c5537dbe703cdcb0e21e4e1b_img.jpg b/raw/rel-18/29_series/29507/3e2a8dc8c5537dbe703cdcb0e21e4e1b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a4673cfe13cd06353d50507135aadb50655c400f --- /dev/null +++ b/raw/rel-18/29_series/29507/3e2a8dc8c5537dbe703cdcb0e21e4e1b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fd6c936412af192ba9b28388c626c20f29427ade9b852522cfb21105a7eae1eb +size 22959 diff --git a/raw/rel-18/29_series/29507/5a4e62bead259c258d069fd3663ea670_img.jpg b/raw/rel-18/29_series/29507/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0ebce314676d9c13a1e0d57de5031f91a93e6ca2 --- /dev/null +++ b/raw/rel-18/29_series/29507/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1bf00702f9e9072c273c8b48d837289ba87ac80ab661346c33db73531f8292e9 +size 7770 diff --git a/raw/rel-18/29_series/29507/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29507/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..00455c162a49ff77984df2d168873b42dfaece14 --- /dev/null +++ b/raw/rel-18/29_series/29507/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:35fd6cba5eacd756cf2036e26c79751711d60e1e4813a5159ea26c010930714b +size 9760 diff --git a/raw/rel-18/29_series/29507/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29507/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..18664503ce5e7ded4700162856569aea9d6f13ec --- /dev/null +++ b/raw/rel-18/29_series/29507/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b6fbbc6456c07fc620c7bef8177ca326b06fd700a10692b10d3e3676d29a4f92 +size 5135 diff --git a/raw/rel-18/29_series/29507/7e670a2b556b53ea9002dfff3a420e08_img.jpg b/raw/rel-18/29_series/29507/7e670a2b556b53ea9002dfff3a420e08_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..00bf93747b558b10d7aabe9e2967e14209bb369b --- /dev/null +++ b/raw/rel-18/29_series/29507/7e670a2b556b53ea9002dfff3a420e08_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3c953ccf24c86cbc8b3260f9326d21fc7ea9fe700df1a191aaf684b36c767ae1 +size 8822 diff --git a/raw/rel-18/29_series/29507/a51105b2031bad93b818b82f071c6add_img.jpg b/raw/rel-18/29_series/29507/a51105b2031bad93b818b82f071c6add_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..da7eb5c2525e82d09090ed192bc966b023c2f269 --- /dev/null +++ b/raw/rel-18/29_series/29507/a51105b2031bad93b818b82f071c6add_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7ec2e95bf55ae69c3f0e96779faaacc87e1c82381bb4f33eb9f4ca89eadb2899 +size 31167 diff --git a/raw/rel-18/29_series/29507/db7ae70402c81d140ae7df14b002e057_img.jpg b/raw/rel-18/29_series/29507/db7ae70402c81d140ae7df14b002e057_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dbacae56a221253dd9fff96b7f2a31074d029913 --- /dev/null +++ b/raw/rel-18/29_series/29507/db7ae70402c81d140ae7df14b002e057_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2553b85e6a1fc740e2df4f4b6943e9a035fea40cfcf5916b6e4afa984b9304e8 +size 32540 diff --git a/raw/rel-18/29_series/29507/dd5771673aececa53d42ece89218299d_img.jpg b/raw/rel-18/29_series/29507/dd5771673aececa53d42ece89218299d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..015ec18f2be51d56f11d9515bccb75d392049f3e --- /dev/null +++ b/raw/rel-18/29_series/29507/dd5771673aececa53d42ece89218299d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:696f7b16e6459b445f756dbfe38d70ede325563c9de041667ccdb93312ab8609 +size 33205 diff --git a/raw/rel-18/29_series/29507/ee8536b235eb6aad21e2048fd5308900_img.jpg b/raw/rel-18/29_series/29507/ee8536b235eb6aad21e2048fd5308900_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6e5d672806dfcfdfeb9cb818ccd27df5eede9a71 --- /dev/null +++ b/raw/rel-18/29_series/29507/ee8536b235eb6aad21e2048fd5308900_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5aa28acb3dc4c20bd6e03a4906e7459c02ae4a0ee5827704199005e20b252ead +size 14097 diff --git a/raw/rel-18/29_series/29507/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/raw/rel-18/29_series/29507/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e6ac1570abd3a5d1c37415084c61208f1f6bc24e --- /dev/null +++ b/raw/rel-18/29_series/29507/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0aacb14d147dfff8793f9727bb804e57a6e793bf96f7fc6e84816cc2d3eeca56 +size 29455 diff --git a/raw/rel-18/29_series/29507/raw.md b/raw/rel-18/29_series/29507/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..42bb32fe08802fbc785a1cc908b765c6ebc5abbb --- /dev/null +++ b/raw/rel-18/29_series/29507/raw.md @@ -0,0 +1,3436 @@ + + +# 3GPP TS 29.507 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Access and Mobility Policy Control Service; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- Keywords --- + +## **3GPP** + +### --- Postal address --- + +### 3GPP support office address --- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## Internet --- + + + +--- + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 9 | +| 4 Access and Mobility Policy Control Service ..... | 10 | +| 4.1 Service Description ..... | 10 | +| 4.1.1 Overview ..... | 10 | +| 4.1.2 Service Architecture ..... | 10 | +| 4.1.3 Network Functions ..... | 11 | +| 4.1.3.1 Policy Control Function (PCF)..... | 11 | +| 4.1.3.2 NF Service Consumers ..... | 12 | +| 4.2 Service Operations ..... | 12 | +| 4.2.1 Introduction ..... | 12 | +| 4.2.2 Npcf_AMPolicyControl_Create Service Operation..... | 12 | +| 4.2.2.1 General..... | 12 | +| 4.2.2.2 Void ..... | 16 | +| 4.2.2.2.0 Void..... | 16 | +| 4.2.2.2.1 Void..... | 16 | +| 4.2.2.2.2 Void..... | 16 | +| 4.2.2.3 AMF Access and Mobility Policy ..... | 16 | +| 4.2.2.3.1 Service Area Restriction..... | 16 | +| 4.2.2.3.2 RFSP Index ..... | 18 | +| 4.2.2.3.3 UE-AMBR ..... | 18 | +| 4.2.2.3.4 SMF Selection Management ..... | 18 | +| 4.2.2.3.5 UE-Slice-MBR..... | 19 | +| 4.2.2.3.6 5G access stratum time distribution ..... | 19 | +| 4.2.2.3.7 Network slice usage control ..... | 19 | +| 4.2.3 Npcf_AMPolicyControl_Update Service Operation..... | 20 | +| 4.2.3.1 General..... | 20 | +| 4.2.3.2 Policy Control Request Triggers..... | 24 | +| 4.2.3.3 Encoding of updated policy ..... | 25 | +| 4.2.3.4 Feature renegotiation during AMF relocation ..... | 26 | +| 4.2.4 Npcf_AMPolicyControl_UpdateNotify Service Operation ..... | 27 | +| 4.2.4.1 General..... | 27 | +| 4.2.4.2 Policy update notification ..... | 27 | +| 4.2.4.3 Request for termination of the policy association ..... | 29 | +| 4.2.5 Npcf_AMPolicyControl_Delete Service Operation..... | 30 | +| 5 Npcf_AMPolicyControl API ..... | 31 | +| 5.1 Introduction ..... | 31 | +| 5.2 Usage of HTTP..... | 32 | +| 5.2.1 General ..... | 32 | +| 5.2.2 HTTP standard headers ..... | 32 | +| 5.2.2.1 General..... | 32 | +| 5.2.2.2 Content type..... | 32 | +| 5.2.3 HTTP custom headers ..... | 32 | +| 5.3 Resources ..... | 32 | +| 5.3.1 Resource Structure..... | 33 | +| 5.3.2 Resource: AM Policy Associations ..... | 33 | +| 5.3.2.1 Description..... | 33 | +| 5.3.2.2 Resource definition ..... | 33 | +| 5.3.2.3 Resource Standard Methods ..... | 33 | +| 5.3.2.3.1 POST ..... | 33 | + +| | | | +|-----------------------------------------------------------------------------------|---------------------------------------------------------|-----------| +| 5.3.3 | Resource: Individual AM Policy Association ..... | 34 | +| 5.3.3.1 | Description..... | 34 | +| 5.3.3.2 | Resource definition..... | 34 | +| 5.3.3.3 | Resource Standard Methods ..... | 34 | +| 5.3.3.3.1 | GET ..... | 34 | +| 5.3.3.3.2 | DELETE..... | 36 | +| 5.3.3.4 | Resource Custom Operations..... | 37 | +| 5.3.3.4.1 | Overview ..... | 37 | +| 5.3.3.4.2 | Operation: Update ..... | 37 | +| 5.3.3.4.2.1 | Description ..... | 37 | +| 5.3.3.4.2.2 | Operation Definition..... | 37 | +| 5.4 | Custom Operations without associated resources ..... | 38 | +| 5.5 | Notifications ..... | 38 | +| 5.5.1 | General ..... | 38 | +| 5.5.2 | Policy Update Notification ..... | 38 | +| 5.5.2.1 | Description..... | 38 | +| 5.5.2.2 | Operation Definition ..... | 38 | +| 5.5.3 | Request for termination of the policy association ..... | 40 | +| 5.5.3.1 | Description..... | 40 | +| 5.5.3.2 | Operation Definition ..... | 40 | +| 5.6 | Data Model..... | 41 | +| 5.6.1 | General ..... | 41 | +| 5.6.2 | Structured data types ..... | 43 | +| 5.6.2.1 | Introduction..... | 43 | +| 5.6.2.2 | Type PolicyAssociation ..... | 44 | +| 5.6.2.3 | Type PolicyAssociationRequest ..... | 46 | +| 5.6.2.4 | Type PolicyAssociationUpdateRequest..... | 49 | +| 5.6.2.5 | Type PolicyUpdate ..... | 52 | +| 5.6.2.6 | Type TerminationNotification ..... | 54 | +| 5.6.2.7 | Type SmfSelectionData ..... | 54 | +| 5.6.2.8 | Type CandidateForReplacement..... | 55 | +| 5.6.2.9 | Type AmRequestedValueRep..... | 55 | +| 5.6.2.10 | Type: AsTimeDistributionParam..... | 56 | +| 5.6.2.11 | Type UeSliceMbr..... | 56 | +| 5.6.2.12 | Type SliceUsgCtrlInfo ..... | 56 | +| 5.6.2.13 | Type SnssaiPartRejected..... | 57 | +| 5.6.3 | Simple data types and enumerations ..... | 57 | +| 5.6.3.1 | Introduction..... | 57 | +| 5.6.3.2 | Simple data types..... | 57 | +| 5.6.3.3 | Enumeration: RequestTrigger..... | 57 | +| 5.6.3.4 | Enumeration: PolicyAssociationReleaseCause ..... | 59 | +| 5.7 | Error handling ..... | 59 | +| 5.7.1 | General ..... | 59 | +| 5.7.2 | Protocol Errors..... | 59 | +| 5.7.3 | Application Errors ..... | 59 | +| 5.8 | Feature negotiation..... | 60 | +| 5.9 | Security..... | 62 | +| Annex A (normative): OpenAPI specification ..... | | 63 | +| A.1 | General..... | 63 | +| A.2 | Npcf_AMPolicyControl API ..... | 63 | +| Annex B (normative): Wireless and wireline convergence access support..... | | 76 | +| B.1 | Scope..... | 76 | +| B.2 | Npcf_AMPolicyControl Service..... | 76 | +| B.2.1 | Service Description ..... | 76 | +| B.2.1.1 | Overview ..... | 76 | +| B.2.1.2 | Service Architecture ..... | 77 | +| B.2.1.3 | Network Functions ..... | 77 | + +| | | | +|---------------------------------------------------|-----------------------------------------------------------|-----------| +| B.2.1.3.1 | Policy Control Function (PCF) ..... | 77 | +| B.2.1.3.2 | NF Service Consumers ..... | 77 | +| B.3 | Service Operation..... | 77 | +| B.3.1 | Introduction ..... | 77 | +| B.3.2 | Npcf_AMPolicyControl_Create Service Operation..... | 77 | +| B.3.2.1 | General ..... | 77 | +| B.3.2.2 | AMF Access and Mobility Policy ..... | 78 | +| B.3.2.2.1 | General ..... | 78 | +| B.3.2.2.2 | Wireline Service Area Restriction ..... | 79 | +| B.3.2.2.3 | Void ..... | 79 | +| B.3.3 | Npcf_AMPolicyControl_UpdateNotify Service Operation ..... | 79 | +| B.3.3.1 | General ..... | 79 | +| B.3.4 | Npcf_AMPolicyControl_Update Service Operation ..... | 79 | +| B.3.4.1 | General ..... | 79 | +| B.3.4.2 | Policy Control Request Triggers ..... | 80 | +| B.3.4.3 | Encoding of updated policy ..... | 80 | +| B.3.5 | Npcf_AMPolicyControl_Delete Service Operation..... | 80 | +| B.3.5.1 | General ..... | 80 | +| Annex C (informative): Change history..... | | 81 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd 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. + +# --- 1 Scope + +The present specification provides the stage 3 definition of the Access and Mobility Policy Control Service (Npcf\_AMPolicyControl) of the 5G System. + +The stage 2 definition and procedures of the Access and Mobility Policy Control Service are contained in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +Stage 3 call flows are provided in 3GPP TS 29.513 [7]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition of the 5G System are specified in 3GPP TS 29.500 [5] and 3GPP TS 29.501 [6]. + +The Access and Mobility Policy Control Service is provided by the Policy Control Function (PCF). This service provides Access and Mobility Policies. + +# --- 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [5] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [6] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [7] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [8] IETF RFC 9113: "HTTP/2". +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [11] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [12] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [13] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [14] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [15] void. +- [16] void. + +- [17] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for Exposure; Stage 3". +- [18] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [19] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [20] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [21] IETF RFC 9457: "Problem Details for HTTP APIs". +- [22] 3GPP TR 21.900: "Technical Specification Group working methods". +- [23] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [24] 3GPP TS 29.531: "5G System; Network Slice Selection Services; Stage 3". +- [25] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [26] 3GPP TS 29.534: "5G System; Access and Mobility Policy Authorization Service; Stage 3". +- [27] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [28] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [29] 3GPP TS 29.525: "UE Policy Control Service; Stage 3". +- [30] 3GPP TS 29.521: "5G System; Binding Support Management Service; Stage 3". +- [31] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". +- [32] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [33] 3GPP TS 29.594: "5G System; Spending Limit Control Service; Stage 3". + +# --- 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]. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.501 [2], clause 3.1 apply: + +**Allowed NSSAI** + +**Alternative S-NSSAI** + +**Partially Allowed NSSAI** + +**Target NSSAI** + +**Pending NSSAI** + +## 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]. + +| | | +|---------|-------------------------------------------------------| +| 5G-BRG | 5G Broadband Residential Gateway | +| 5G-RG | 5G Residential Gateway | +| 5GC | 5G Core Network | +| 5G-CRG | 5G Cable Residential Gateway | +| 5GS | 5G System | +| AMBR | Aggregated Maximum Bit Rate | +| AMF | Access and Mobility Management Function | +| BBF | Broadband Forum | +| CHF | Charging Function | +| DNN | Data Network Name | +| EPC | Evolved Packet Core | +| EPS | Evolved Packet System | +| E-UTRAN | Evolved Universal Terrestrial Radio-Access Network | +| FN-BRG | Fixed Network Broadband Residential Gateway | +| FN-CRG | Fixed Network Cable Residential Gateway | +| FN-RG | Fixed Network Residential Gateway | +| FQDN | Fully Qualified Domain Name | +| GBR | Guaranteed Bit Rate | +| GPSI | Generic Public Subscription Identifier | +| GUAMI | Globally Unique AMF Identifier | +| HFC | Hybrid Fiber-Coaxial | +| JSON | JavaScript Object Notation | +| LBO | Local Break Out (roaming) | +| MBR | Maximum Bit Rate | +| MME | Mobility Management Entity | +| NID | Network Identifier | +| NRF | Network Repository Function | +| NSSAI | Network Slice Selection Assistance Information | +| NWDAF | Network Data Analytics Function | +| PCF | Policy Control Function | +| PEI | Permanent Equipment Identifier | +| PRA | Presence Reporting Area | +| QoS | Quality of Service | +| RA | Registration Area | +| RFSP | RAT Frequency Selection Priority | +| SMF | Session Management Function | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SNPN | Stand-alone Non-Public Network | +| SUPI | Subscription Permanent Identifier | +| UDM | Unified Data Management | +| URSP | UE Route Selection Policy | +| V-PCF | Visited Policy Control Function | +| W-5GAN | Wireline 5G Access Network | +| W-5GBAN | Wireline BBF Access Network | +| W-5GCAN | Wireline 5G Cable Access Network | +| W-AGF | Wireline Access Gateway Function | + +# 4 Access and Mobility Policy Control Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The Access and Mobility Policy Control Service, as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4], is provided by the Policy Control Function (PCF). + +This service provides access control and mobility management related policies to the NF service consumer and offers the following functionalities: + +- policy creation based on a request from the NF service consumer during UE registration; +- notification of the NF service consumer of the updated policies which are subscribed; and +- deletion of the policy context for a UE. + +### 4.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Policy and Charging related 5G architecture is also described in 3GPP TS 29.513 [7]. + +The Access and Mobility Policy Control Service (Npcf\_AMPolicyControl) is part of the Npcf service-based interface exhibited by the Policy Control Function (PCF). + +The known NF service consumer of the Npcf\_AMPolicyControl service is the Access and Mobility Management Function (AMF). + +The AMF accesses the Access and Mobility Policy Control Service at the PCF via the N15 Reference point. In the roaming scenario, the N15 reference point is located between the V-PCF in the visited network and the AMF. + +![Reference Architecture for the Npcf_AMPolicyControl Service; SBI representation](ee8536b235eb6aad21e2048fd5308900_img.jpg) + +The diagram illustrates the service-based interface (SBI) representation for the Npcf\_AMPolicyControl service. At the top, a rectangular box labeled '(V-)PCF' contains an oval labeled 'Npcf'. At the bottom, a rectangular box is labeled 'AMF'. A vertical line connects the 'Npcf' oval to the 'AMF' box, with the label 'Npcf\_AMPolicyControl' positioned to the right of the line. + +Reference Architecture for the Npcf\_AMPolicyControl Service; SBI representation + +Figure 4.1.2-1: Reference Architecture for the Npcf\_AMPolicyControl Service; SBI representation + +![Non-roaming Reference Architecture for the Npcf_AMPolicyControl Service](5a4e62bead259c258d069fd3663ea670_img.jpg) + +A diagram showing the non-roaming reference architecture for the Npcf\_AMPolicyControl Service. It consists of two rectangular boxes, 'PCF' at the top and 'AMF' at the bottom, connected by a vertical line. A horizontal tick mark on the vertical line is labeled 'N15' to its right. + +Non-roaming Reference Architecture for the Npcf\_AMPolicyControl Service + +**Figure 4.1.2-2: Non-roaming Reference Architecture for the Npcf\_AMPolicyControl Service; reference point representation** + +![Roaming reference Architecture for the Npcf_AMPolicyControl Service](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +A diagram showing the roaming reference architecture for the Npcf\_AMPolicyControl Service. It consists of two rectangular boxes, 'V-PCF' at the top and 'AMF' at the bottom, connected by a vertical line. A horizontal tick mark on the vertical line is labeled 'N15' to its right. + +Roaming reference Architecture for the Npcf\_AMPolicyControl Service + +**Figure 4.1.3-2: Roaming reference Architecture for the Npcf\_AMPolicyControl Service; reference point representation** + +### 4.1.3 Network Functions + +#### 4.1.3.1 Policy Control Function (PCF) + +The Policy Control Function (PCF): + +- Supports unified policy framework to govern network behaviour; and +- Provides Access and Mobility Management related policies to the NF service consumer that enforces them. + +In the roaming scenario, the Visited Policy Control Function (V-PCF) provides the functions described in this clause towards the visited network. + +The policy decisions made by the PCF may be based on one or more of the following: + +- Information obtained from the AF/NEF, e.g. high throughput indication; +- Information obtained from the UDR; +- Information obtained from the AMF, e.g. UE related and access related information; +- Information obtained from the NWDAF; +- Information from the CHF about spending limit control; +- Information from the TSCTSF; and + +- PCF pre-configured policy context. + +#### 4.1.3.2 NF Service Consumers + +The Access and Mobility Management function (AMF) provides: + +- Registration management; +- Connection management; +- Reachability management; and +- Mobility Management. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +**Table 4.2.1-1: Operations of the Npcf\_AMPolicyControl Service** + +| Service operation name | Description | Initiated by | +|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| Npcf_AMPolicyControl_Create | Creates an AM Policy Association and provides corresponding policies to the NF service consumer. | NF service consumer (e.g. AMF) | +| Npcf_AMPolicyControl_Update | Updates an AM Policy Association and provides corresponding policies to the NF service consumer when a policy control request trigger is met or the AMF is relocated due to UE mobility and the old PCF is selected. | NF service consumer (e.g. AMF) | +| Npcf_AMPolicyControl_UpdateNotify | Provides updated policies to the NF service consumer. | PCF (V-PCF in roaming case) | +| Npcf_AMPolicyControl_Delete | Provides means for the NF service consumer to delete the AM Policy Association. | NF service consumer (e.g. AMF) | + +### 4.2.2 Npcf\_AMPolicyControl\_Create Service Operation + +#### 4.2.2.1 General + +The procedure in the present clause is applicable when the NF service consumer (e.g. AMF) creates an AM policy association when the UE registers to the network, and when the AMF is relocated (between the different AMF sets) and the new AMF selects a new PCF. The procedure for the case where the AMF is relocated and the new AMF selects the old PCF is defined in clause 4.2.3.1. + +The creation of an AM policy association only applies for normally registered UEs, i.e., it does not apply for Emergency Registered UEs. + +Figure 4.2.2.1-1 illustrates the creation of a policy association. + +![Sequence diagram showing the creation of a policy association between an NF service consumer and a PCF. The NF service consumer sends a POST request to the PCF, and the PCF responds with a 201 Created status.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST .../policies + NF service consumer->>PCF: Request + Note left of PCF: 2. "201 Created" + PCF-->>NF service consumer: Response + +``` + +Sequence diagram showing the creation of a policy association between an NF service consumer and a PCF. The NF service consumer sends a POST request to the PCF, and the PCF responds with a 201 Created status. + +**Figure 4.2.2.1-1: Creation of a policy association** + +When a UE registers and a UE context is being established, the AMF can obtain Service Area Restrictions, RFSP index, subscribed UE-AMBR, subscribed UE-Slice-MBR(s) and GPSI(s) from the UDM during the Access and Mobility Subscription Data retrieval procedure, and the list of NWDAF instance IDs used for the UE and their associated Analytic ID(s) consumed by the AMF, the Allowed NSSAI and the Target NSSAI from local configuration or from the NSSF during the slice selection procedure and shall decide based on local policies whether to request policies from the PCF. + +To request policies from the PCF, the NF service consumer (e.g. AMF) shall send an HTTP POST request with: "{apiRoot}/npcf-am-policy-control/v1/policies" as Resource URI and the PolicyAssociationRequest data structure as request body that shall include: + +- Notification URI encoded as "notificationUri" attribute; +- SUPI encoded as "supi" attribute; +- if the "SliceSupport" feature, the "DNNReplacementControl" feature and/or the "NetSliceRepl" feature is supported in the NF service consumer and the UE is registered via a 3GPP access, the Allowed NSSAI in the 3GPP access encoded in the "allowedSnssais" attribute; and +- if the "PartNetSliceSupport" feature and/or the "NetSliceRepl" feature is/are supported in the NF service consumer and the UE is registered via a 3GPP access, the Partially Allowed NSSAI in the 3GPP access within the "partAllowedNssai" attribute; + +and that shall include when available: + +- GPSI encoded as "gpsi" attribute; +- if the feature "MultipleAccessTypes" is not supported, the access type encoded as "accessType" attribute; +- Permanent Equipment Identifier (PEI) encoded as "pei" attribute; +- User Location Information encoded as "userLoc" attribute; +- UE Time Zone encoded as "timeZone" attribute; +- the identifier of the serving network (the PLMN Identifier or the SNPN Identifier) encoded as "servingPlmn" attribute; + +NOTE 1: The SNPN Identifier consists of the PLMN Identifier and the NID. + +- if the feature "MultipleAccessTypes" is not supported, the RAT type encoded as "ratType" attribute; +- Service Area Restrictions (see clause 4.2.2.3.1) derived from the Service Area Restrictions obtained from the UDM by mapping any service areas denoted by geographical information into Tracking Area Identities (TAIs) and encoded as "servAreaRes" attribute; +- RFSP index (see clause 4.2.2.3.2) as obtained from the UDM encoded as "rfsp" attribute; +- a list of Internal Group Identifiers encoded as "groupIds" attribute; + +- if the NF service consumer is an AMF, the GUAMI encoded as "guami" attribute; +- if the NF service consumer is an AMF, the name of a service produced by the AMF that expects to receive information within Npcf\_AMPolicyControl\_UpdateNotify service operation encoded as "serviceName" attribute; +- Alternate or backup IPv4 Address(es) where to send Notifications encoded as "altNotifIpv4Addrs" attribute; +- Alternate or backup IPv6 Address(es) where to send Notifications encoded as "altNotifIpv6Addrs" attribute; +- Alternate or backup FQDN(s) where to send Notifications encoded as "altNotifFqdns" attribute; +- trace control and configuration parameters information encoded as "traceReq" attribute; +- if the feature "UE-AMBR\_Authorization" is supported in the NF service consumer, the subscribed UE-AMBR (see clause 4.2.2.3.3) in the "ueAmbr" attribute; +- if the "DNNReplacementControl" feature and/or the "NetSliceRepl" feature is/are supported, the mapping of each S-NSSAI of the Allowed NSSAI and, if the "PartNetSliceSupport" feature and/or the "NetSliceRepl" feature is/are supported, the mapping of each S-NSSAI of the Partially Allowed NSSAI to the corresponding S-NSSAI of the HPLMN encoded in the "mappingSnssais" attribute; +- if the "PartNetSliceSupport" feature is supported in the NF service consumer and the UE is registered via a 3GPP access: + - the list of the S-NSSAI(s) partially rejected in the RA, if available, encoded via the "snssaisPartRejected" attribute; + - the list of the Rejected S-NSSAI(s) in the RA, if available, encoded via the "rejectedSnssais" attribute; and/or + - the Pending NSSAI encoded, if available, via the "pendingNssai" attribute; +- if the feature "UE-Slice-MBR\_Authorization" is supported in the NF service consumer, the subscribed UE-Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping to a S-NSSAI of the serving PLMN if available (see clause 4.2.2.3.5) encoded in the "ueSliceMbrs" attribute; +- when the "EneNA" feature is supported, the list of NWDAF instance IDs used for the UE and their associated Analytic IDs consumed by the NF service consumer, included within the "nwdafDatas" attribute; and +- if the feature "TargetNSSAI" is supported in the NF service consumer, the Target NSSAI generated by the NF service consumer or received from the NSSF encoded in the "targetSnssais" attribute. + +Upon the reception of this HTTP POST request, the PCF shall: + +- assign a policy association ID; +- determine the applicable policy (taking into consideration and optionally modifying the possibly received UE-AMBR, UE-Slice-MBR(s) for the Allowed NSSAI and the Partially Allowed NSSAI, Service Area Restrictions, RFSP index, Allowed NSSAI, Partially Allowed NSSAI, list of the S-NSSAI(s) partially rejected in the RA, list of the Rejected S-NSSAI(s) in the RA and/or Pending NSSAI); +- for the successful case, send a HTTP "201 Created" response with the URI for the created resource in the "Location" header field + +NOTE 2: The assigned policy association ID is part of the URI for the created resource and is thus associated with the SUPI. + +and the PolicyAssociation data type as response body including: + +- conditionally AMF Access and Mobility Policy (see clause 4.2.2.3), i.e.: + - a) if the PCF received the "servAreaRes" attribute in the request, Service Area Restrictions encoded as "servAreaRes" attribute; and/or + - b) if the PCF received the "rfsp" attribute in the request, RAT Frequency Selection Priority (RFSP) Index encoded as "rfsp" attribute. If the feature "RFSPValidityTime" is supported and the PCF determines to provide an RFSP index value that indicates EPC/E-UTRAN access is prioritized over 5GS access, the + +PCF may provide, based on operator policies, a validity time for the RFSP index value within the "rfspValTime" attribute;; and/or + +- c) if the feature "UE-AMBR\_Authorization" is supported and the PCF received the "ueAmbr" attribute in the request, the authorized UE-AMBR encoded as "ueAmbr" attribute; +- d) if the feature "UE-Slice-MBR\_Authorization" is supported and the PCF received the "ueSliceMbrs" attribute in the request, the corresponding authorized UE-Slice-MBR(s) encoded as "ueSliceMbrs" attribute; +- e) if the feature "AMInfluence" is supported, the PCF for the UE determines that the access and mobility policies may be influenced by the traffic of PDU session(s) and local operator policies indicate that the PCF for the UE shall subscribe with the PCF for the PDU session for established/terminated PDU session(s) event notifications via the AMF and the SMF, the PCF for the UE information within the "pcfUeInfo" attribute, and the DNN and S-NSSAI of the concerned PDU session(s) within the "matchPdus" attribute. The "pcfUeInfo" attribute shall include the PCF for the UE callback URI via which the PCF(s) for the PDU session shall send notifications about the related PDU session(s) established/terminated events within the "callbackUri" attribute, and if available, the associated PCF for the UE instance ID, PCF set ID, and the level of SBA binding within the "bindingInfo" attribute; +- f) if the feature "5GAccessStratumTime" is supported and the PCF receives the access stratum time distribution parameters from the TSCTSF as defined in 3GPP TS 29.534 [26], the 5G access stratum time distribution parameters encoded as "asTimeDisParam" attribute as defined in clause 4.2.2.3.6; and/or +- g) if the "NetSliceUsageCtrl" feature is supported and the PCF determines that one or more S-NSSAI(s) of the UE's Allowed NSSAI is/are on-demand S-NSSAI(s) and subject to network slice usage control, the network slice usage control information (e.g. slice deregistration inactivity timer) within the "sliceUsgCtrlInfoSets" attribute as specified in clause 4.2.2.3.7; + +NOTE 3: In this release of the specification, network slice usage control information provisioning by the PCF is not supported in roaming scenarios. + +- optionally one or several of the following Policy Control Request Trigger(s) encoded as "triggers" attribute (see clause 4.2.3.2): + - a) Location change (tracking area); + - b) Change of UE presence in PRA; + - c) if the "SliceSupport" feature, the "DNNReplacementControl" feature and/or the "NetSliceRepl" feature is supported, change of Allowed NSSAI; + - d) if the "DNNReplacementControl" feature is supported, change of SMF selection information; and + - e) if the "EneNA" feature is supported, change of NWDAF data; + - f) if the "TargetNSSAI" feature is supported, Generation of Target NSSAI; + - g) if the "NetSliceRepl" feature is supported, S-NSSAI Replacement; + - h) if the "PartNetSliceSupport" feature and/or the "NetSliceRepl" feature is supported, Change of the Partially Allowed NSSAI; + - i) if the "PartNetSliceSupport" feature is supported, Change of the the S-NSSAI(s) rejected partially in the RA, Change of the rejected S-NSSAI(s) in the RA and/or Change of the Pending NSSAI; +- if the Policy Control Request Trigger "Change of UE presence in PRA" is provided, the presence reporting areas for which reporting is required encoded as "pras" attribute; + +NOTE 4: If the PCF uses a Presence Reporting Area identifier referring to a Set of Core Network predefined Presence Reporting Areas as defined in 3GPP TS 23.501 [2], the PCF includes the identifier of this Presence Reporting Area set within the "praId" attribute. + +- if the Policy Control Request Trigger "Change of SMF selection information" is provided, the SMF selection information representing the conditions upon which the AMF shall request a DNN replacement (see clause 4.2.2.3.4) encoded as "smfSelInfo" attribute; and + +- if the Policy Control Request Trigger "Generation of Target NSSAI" is provided, the RFSP Index associated with the Target NSSAI encoded as "targetRfsp" attribute; + +and + +- if errors occur when processing the HTTP POST request, apply error handling procedures as specified in clause 5.7 and according to the following provisions: + - if the user information received within the "supi" attribute is unknown, the PCF shall reject the request and include in an HTTP "400 Bad Request" response message the "cause" attribute of the ProblemDetails data structure set to "USER\_UNKNOWN"; + - if the PCF is, due to incomplete, erroneous or missing information in the request, not able to provision an AM policy decision, the PCF may reject the request and include in an HTTP "400 Bad Request" response message the "cause" attribute of the ProblemDetails data structure set to "ERROR\_REQUEST\_PARAMETERS"; and + - if the PCF rejects the AM policy association establishment, the NF service consumer shall apply the policy retrieved from the UDM if available; otherwise, the NF service consumer shall apply the operator configured policy. + +If the PCF received a GUAMI, the PCF may subscribe to GUAMI changes using the AMFStatusChange service operation of the Namf\_Communication service specified in 3GPP TS 29.518 [14], and it may use the Nnrf\_NFDiscovery Service specified in 3GPP TS 29.510 [13] (using the obtained GUAMI and possibly service name) to query the other AMFs within the AMF set. + +If the PCF received a "traceReq" attribute, it shall perform trace procedures as defined in 3GPP TS 32.422 [18]. + +If the PCF received the list of NWDAF instance IDs used for the UE and their associated Analytic IDs within the "nwdafDatas" attribute, the PCF may select those NWDAF instances as described in 3GPP TS 29.513 [7]. + +The PCF may retrieve AF requirements on Access and Mobility policies from the UDR as specified in 3GPP TS 29.519 [17] and consider them for determining the Access and Mobility policies to be provisioned. + +#### 4.2.2.2 Void + +##### 4.2.2.2.0 Void + +##### 4.2.2.2.1 Void + +##### 4.2.2.2.2 Void + +#### 4.2.2.3 AMF Access and Mobility Policy + +##### 4.2.2.3.1 Service Area Restriction + +If service area restrictions are enabled, the Service Area Restriction information is encoded using the "ServiceAreaRestriction" data type defined in 3GPP TS 29.571 [11] and consists of: + +- a limited allowed area represented as: + - a) the maximum number of allowed TAs that can be traversed encoded as "maxNumOfTAs" attribute; or + - b) both of: + - (i) a list of allowed Tracking Area Identities (TAIs) encoded as "tacs" attributes within the "areas" attribute; and + - (ii) the "restrictionType" attribute set to "ALLOWED\_AREAS"; or + - c) both a) and b) above; +- or a limited allowed area represented as: + +- a) the maximum number of allowed TAs that can be traversed encoded as "maxNumOfTAsForNotAllowedAreas" attribute; or +- b) all of: + - (i) a list of not allowed Tracking Area Identities (TAIs) encoded as "tacs" attributes within the "areas" attribute; and + - (ii) the "restrictionType" attribute set to "NOT\_ALLOWED\_AREAS"; and + - (iii) the maximum number of allowed TAs that can be traversed encoded as "maxNumOfTAsForNotAllowedAreas" attribute; +- or a not allowed area represented as: + - a) a list of not allowed Tracking Area Identities (TAIs) encoded as "tacs" attributes within the "areas" attribute; and + - b) the "restrictionType" attribute set to "NOT\_ALLOWED\_AREAS". + +When the "restrictionType" attribute is set to "NOT\_ALLOWED\_AREAS", the "maxNumOfTAs" attribute shall not be present. + +When the "restrictionType" attribute is set to "ALLOWED\_AREAS", the "maxNumOfTAsForNotAllowedAreas" attribute shall not be present. + +When for a limited allowed area both, "maxNumOfTAs" and "areas" attributes are present, the "maxNumOfTAs" attribute represents the upper limit of the limited allowed area. The AMF may add any not yet visited tracking areas to the allowed area represented by the "areas" attribute until the total number of TAs reaches the "maxNumOfTAs" attribute value. + +NOTE 1: The "maxNumOfTAs" attribute value represents the maximum number of TAs of the limited allowed area. When "maxNumOfTAs" attribute value is lower than the number of TAs in the "areas" attribute it represents the maximum number of TAs allowed inside the limited allowed area defined by the TAs contained in the "areas" attribute. When the "maxNumOfTAs" attribute value is higher than the number of TAs in the "areas" attribute it represents that additional TAs up to the "maxNumOfTAs" attribute value can be dynamically added to the area defined by the TAs contained in the "areas" attribute. + +When for a limited allowed area the following three attributes are present: + +- "maxNumOfTAsForNotAllowedAreas" attribute; and +- the "restrictionType" attribute set to "NOT\_ALLOWED\_AREAS"; and +- the "areas" attribute, + +the "maxNumOfTAsForNotAllowedAreas" attribute represents the maximum number of TAs allowed in a limited allowed area outside the not allowed area represented in the "areas" attribute. The limited allowed area is dynamically calculated by the AMF, and the TAs outside of the dynamically calculated limited allowed area become not allowed TAs. + +NOTE 2: Both, the "maxNumOfTAsForNotAllowedAreas" attribute and the "maxNumOfTAs" attribute, when present in a "ServiceAreaRestriction" data type instance that does not include the "areas" attribute and the "restrictionType" attribute, represent a maximum number of allowed TAs in a limited allowed area dynamically calculated by the AMF. + +When the authorized service area restrictions result in an unlimited set of allowed tracking areas, the PCF shall include: + +- an empty "servAreaRes" attribute; or +- the "restrictionType" attribute set to "NOT\_ALLOWED\_AREAS" and an empty "areas" attribute. + +When the authorized service area restrictions result in an unlimited set of not-allowed tracking areas, the PCF shall include the "restrictionType" attribute set to "ALLOWED\_AREAS" and an empty "areas" attribute. + +NOTE 3: The "maxNumOfTAs" attribute and the "maxNumOfTAs" attribute are not used when the authorized service area restrictions result in an unlimited set of allowed or an unlimited set of not-allowed tracking areas. + +##### 4.2.2.3.2 RFSP Index + +The RFSP Index is an index referring to a UE information used locally by the Access Network in order to apply specific radio resource management strategies. It shall be encoded using the RfspIndex data type defined in 3GPP TS 29.571 [11]. + +If the feature "TargetNSSAI" is supported and when the PCF receives the Target NSSAI from the NF service consumer, the PCF shall, if the Policy Control Request Trigger "Generation of Target NSSAI" is provisioned in the response, additionally provide the RFSP Index associated with the Target NSSAI. + +In order for the PCF to determine the RFSP Index value that will be authorized, the PCF shall be configured with a mapping between the RAT Type and/or frequency value and the RFSP Index. + +NOTE 1: The RFSP index value that will be authorized is determined based on operator policies that take into consideration e.g. accumulated usage, analytics information related to load level information per network slice instance, UE communication, user data congestion or service experience, etc. + +The PCF may determine an RFSP Index value that indicates that the EPC/E-UTRAN access is prioritized over 5GS access. In this case, if the feature "RFSPValidityTime" is supported, the PCF may, based on operator policy, send to the AMF a validity time associated to the provided RFSP Index within the "rfspValTime" attribute. When the AMF determines to use the RFSP Index received from the PCF, the AMF provides to the MME the validity time of the RFSP Index, if received. The validity time indicates the time for which the RFSP Index will be used in the MME after 5GS to EPS mobility, as specified in clause 4.11.1.5.8 of 3GPP TS 23.502 [3]. + +NOTE 2: The RFSP validity time is used by the MME to allow the UE to stay in EPS during the period of time indicated by the "rfspValTime" attribute and avoid the potential ping-pong issue from 5GS and EPS (i.e., 5GS keeps sending the UE to EPS based on authorized RFSP Index from PCF, and the EPS keeps sending the UE back to 5GS immediately based on the subscribed RFSP Index). + +Upon reception of the authorized RFSP index, the NF service consumer (e.g. AMF) shall choose the RFSP Index in use as described in 3GPP TS 23.501 [2] clause 5.3.4.3.1. + +##### 4.2.2.3.3 UE-AMBR + +The UE-AMBR limits the aggregate bit rate that can be expected to be provided across all Non-GBR QoS Flows of a UE. It shall be encoded using the Ambr data type defined in 3GPP TS 29.571 [11]. + +##### 4.2.2.3.4 SMF Selection Management + +If the "DNNReplacementControl" feature is supported, when SMF Selection Management is enabled, the SMF selection information is encoded using the "SmfSelectionData" data type, which consists of: + +- the conditions upon which the AMF shall request to the PCF the replacement of SMF selection data, which may include: + - a) an indication of whether the AMF shall request DNN replacement when the UE requested an unsupported DNN during PDU session establishment encoded in the "unsuppDnn" attribute; and/or + - b) a list of candidate DNNs for replacement encoded in the "candidates" map, where: + - i) the key of the map is the S-NSSAI; and + - ii) each entry of the map is of "CandidateForReplacement" data type, which: + - shall include the S-NSSAI encoded in the "snssai" attribute; and + - may include the list of candidate DNNs for the S-NSSAI encoded in the "dnns" attribute; + +NOTE 1: The S-NSSAIs included in the map are S-NSSAIs of the allowed NSSAI and/or the Partially Allowed NSSAI, if the "PartNetSliceSupport" feature and/or "NetSliceRepl" feature is/are supported, valid in the serving network. The PCF keeps updated information of the Allowed NSSAI valid in the serving network by subscribing to the policy control request trigger Change of Allowed NSSAI of the served UE. + +NOTE 2: When the PCF provides URSP rules (see 3GPP TS 29.525 [29]) to the UE with new DNN information and in order to provide uniform service experience for UEs from earlier Releases, the candidate DNNs for replacement will consider those included within the traffic descriptors in addition to those included as part of the Route Selection Descriptor(s) of the URSP rule(s) provided to the UE. + +- and, + +a) when included within the Npcf\_AMPolicyControl\_Update request, the UE requested DNN and S-NSSAI at PDU session establishment that matched an entry of the "candidates" map, encoded in the "dnn" attribute and in the "snssai" attribute respectively, and the mapping to the home S-NSSAI encoded in the "mappingSnssai" attribute if available; and + +b) when included within the Npcf\_AMPolicyControl\_Update response, the PCF selected DNN encoded in the "dnn" attribute; + +NOTE 2: The PCF can select the same DNN and S-NSSAI as the UE requested DNN and S-NSSAI. When the PCF returns an unsupported DNN, the AMF applies internal policies to reject the PDU session establishment. + +When the "dnns" attribute is omitted in an entry of the "candidates" map it represents that the AMF shall invoke the procedure for any UE request matching the S-NSSAI value included in the "snssai" attribute. + +##### 4.2.2.3.5 UE-Slice-MBR + +The UE-Slice-MBR limits the aggregate bit rate that can be expected to be provided across all GBR and Non-GBR QoS Flows of a UE for an S-NSSAI. It shall be encoded using the SliceMbr data type defined in 3GPP TS 29.571 [11]. + +##### 4.2.2.3.6 5G access stratum time distribution + +If the feature "5GAccessStratumTime" is supported and the PCF receives the access stratum time distribution parameters from the TSCTSF as defined in 3GPP TS 29.534 [26], the 5G access stratum time distribution parameters are encoded using the "asTimeDisParam" attribute of the "AsTimeDistributionParam" data type, which consists of: + +- an indication of whether the 5G access stratum time distribution is enabled encoded in the "asTimeDistInd" attribute if applicable; +- the Uu Time synchronization error budget encoded in the "uuErrorBudget" attribute if applicable, and +- the clock quality detail level in the "clkQltDetLvl" attribute and optionally the clock quality acceptance criteria in the "clkQltAcptCri" attribute if applicable, and if the feature "NetTimeSyncStatus" is supported. + +If the PCF receives multiple time synchronization error budgets for a given UE, the PCF shall encode the most stringent error budget within the "uuErrorBudget" attribute. + +If the PCF receives the removal of the access stratum time distribution parameters from the TSCTSF as defined in 3GPP TS 29.534 [26] and there are no other access stratum time distribution parameters from other requests for the same UE, the PCF shall provide the "asTimeDisParam" attribute set to NULL. + +##### 4.2.2.3.7 Network slice usage control + +When the PCF receives a Npcf\_AMPolicyControl\_Create request and the "NetSliceUsageCtrl" feature is supported, the PCF may check whether any of the UE's S-NSSAI(s) are subject to network slice usage control. If it is the case, the PCF may provision in the Npcf\_AMPolicyControl\_Create response the network slice usage control information (e.g., slice deregistration inactivity timer) within the "sliceUsgCtrlInfoSets" attribute of the PolicyAssociation data structure for each on-demand S-NSSAI of the UE's Allowed NSSAI, as specified in clause 5.15.15.3 of 3GPP TS 23.501 [2]. + +NOTE: In this release of the specification, network slice usage control information provisioning by the PCF is not supported in roaming scenarios. + +##### 4.2.2.3.8 Alternative S-NSSAI + +When the "NetSliceRepl" feature is supported, the Alternative S-NSSAI indicates a compatible S-NSSAI for an S-NSSAI of the Allowed NSSAI and/or the Partially Allowed NSSAI that the AMF uses as a replacement when the S-NSSAI is not available or congested. It shall be encoded using the SnssaiReplaceInfo data type as defined in 3GPP TS 29.571 [11]. + +### 4.2.3 Npcf\_AMPolicyControl\_Update Service Operation + +#### 4.2.3.1 General + +The procedure in the present clause is applicable when the NF service consumer modifies an existing AM policy association (including the case where the AMF is relocated and the new AMF selects the old PCF to maintain the policy association and to update the Notification URI). + +Figure 4.2.3.1-1 illustrates the update of a policy association. + +![Sequence diagram showing the update of a policy association between an NF service consumer and a PCF.](a51105b2031bad93b818b82f071c6add_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST .../policies/{polAssId}/update + NF service consumer->>PCF: Request + Note left of PCF: 2. "200 OK" + PCF-->>NF service consumer: Response +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and a PCF. The first message, labeled "1. POST .../policies/{polAssId}/update", is sent from the NF service consumer to the PCF. The second message, labeled "2. "200 OK"", is sent from the PCF back to the NF service consumer. + +Sequence diagram showing the update of a policy association between an NF service consumer and a PCF. + +Figure 4.2.3.1-1: Update of a policy association + +The AMF as NF service consumer invokes this procedure when a policy control request trigger (see clause 4.2.3.2) occurs. When a policy control request trigger that does not require the subscription as defined in table 5.6.3.3-1 (e.g. Service Area Restriction change trigger) occurs, the NF service consumer (e.g. AMF) shall always invoke the procedure. When a policy control request trigger requires the subscription as defined in table 5.6.3.3-1 (e.g. location change trigger) occurs, the NF service consumer shall only invoke the procedure if the PCF has subscribed to that event trigger. + +If an AMF knows by implementation specific means that the UE context has been transferred to an AMF with another GUAMI within the AMF set, it may also invoke this procedure to update the Notification URI and the GUAMI. + +NOTE 1: Either the old or the new AMF can invoke this procedure. + +During the AMF relocation, if the new AMF received the resource URI of the individual AM Policy from the old AMF and selects the old PCF, the new AMF shall also invoke this procedure to update the Notification URI and the GUAMI. The new AMF may also update the alternate or backup IP addresses. If the feature "FeatureRenegotiation" is supported, the new AMF may perform feature renegotiation, as described in clause 4.2.3.4. + +To request policies from the PCF, to update the Notification URI, to renegotiate features, to update the trace control configuration and/or to request the termination of trace, the NF service consumer (e.g. AMF) shall request the update of the AM Policy Association by providing the relevant parameters about the UE context by sending an HTTP POST request with "{apiRoot}/npcf-am-policy-control/v1/policies/{polAssId}/update" as Resource URI and the PolicyAssociationUpdateRequest data structure as request body that shall include: + +- at least one of the following: + 1. a new Notification URI encoded in the "notificationUri" attribute; + 2. observed Policy Control Request Trigger(s) (see clause 4.2.3.2) encoded as "triggers" attribute; + +3. if a Service Area restriction change occurred, the Service Area Restrictions (see clause 4.2.2.3.1) as obtained from the UDM encoded as "servAreaRes" attribute; +4. if a RFSP index change occurred, the RFSP index (see clause 4.2.2.3.2) as obtained from the UDM encoded as "rfsp" attribute; +5. if a UE location change occurred and the Policy Control Request Trigger "Location change" was provided, the UE location encoded as "userLoc" attribute; +6. if the Policy Control Request Trigger "Change of UE presence in PRA" was provided, the current presence status of the UE for the presence reporting areas for which reporting was requested, if not previously provided, or the presence reporting areas for which reporting was requested and the status has changed encoded as "praStatuses" attribute; + +NOTE 2: If the PCF included the identifier of a Core Network predefined Presence Reporting Area Set within the "pralD" attribute during the subscription to changes of UE presence in PRA, the AMF only provides the presence reporting area information corresponding to the concerned individual Presence Reporting Area Identifier(s) within the Set. The "pralD" attribute within each returned "PresenceInfo" data type hence includes the identifier of the concerned individual Presence Reporting Area. + +7. if the trace control configuration needs to be updated, trace control and configuration parameters information encoded as "traceReq" attribute; +8. if trace needs to be terminated, the "traceReq" attribute set to the Null value; +9. if the "SliceSupport" feature, the "DNNReplacementControl" feature and/or the "NetSliceRepl" feature is supported, the UE is registered via 3GPP access, the Allowed NSSAI changed, and the Policy Control Request Trigger "Change of Allowed NSSAI" was provided, then the Allowed NSSAI encoded in the "allowedSnssais" attribute; +10. for AMF relocation scenarios, if available, alternate or backup IPv4 Address(es) where to send Notifications encoded as "altNotifIpv4Addrs" attribute; +11. for AMF relocation scenarios, if available, alternate or backup IPv6 Address(es) where to send Notifications encoded as "altNotifIpv6Addrs" attribute; +12. for AMF relocation scenarios, if available, alternate or backup FQDN(s) where to send Notifications encoded as "altNotifFqdns" attribute; +13. for AMF relocation scenarios, the GUAMI encoded as "guami" attribute; + +NOTE 3: An alternate NF service consumer than the one that requested the generation of the subscription resource can send the request. For instance, an AMF as service consumer can change. + +14. if the feature "UE-AMBR\_Authorization" is supported, and a subscribed UE-AMBR change occurred, the UE-AMBR (see clause 4.2.2.3.3) as obtained from the UDM encoded as "ueAmbr" attribute; +15. if the feature "DNNReplacementControl" is supported, DNN replacement applies and the Policy Control Request Trigger "Change of SMF selection information" was provided, the "smfSelInfo" attribute including: + - the UE requested DNN in the "dnn" attribute; and + - the UE requested S-NSSAI in the "snssai" attribute and, if available, the corresponding mapped home S-NSSAI in the "mappingSnssai" attribute; + +when: + +- the UE requested an unsupported DNN and the "unsuppDnn" attribute is set to "true"; or + - the UE requested DNN and S-NSSAI matched one of the S-NSSAI and DNN provided in the "candidates" attribute; +16. if feature "DNNReplacementControl" is supported, the UE is registered via 3GPP access, the Allowed NSSAI changed and/or the mapping of a S-NSSAI of the Allowed NSSAI to the corresponding S-NSSAI of the HPLMN changed, and the Policy Control Request Trigger "Change of allowed NSSAI" was provided, + +then the mapping of each S-NSSAI of the Allowed NSSAI to the corresponding S-NSSAI of the HPLMN encoded in the "mappingSnssais" attribute; + +NOTE 4: When the feature "DNNReplacementControl" is supported, the AMF applies DNN replacement for non-roaming scenarios and LBO. For a PDU session with home routed roaming, whether to perform DNN replacement is based on operator agreement. + +17. if feature "UE-Slice-MBR\_Authorization" is supported, and a subscribed UE-Slice-MBR change occurred, the subscribed UE-Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping to a S-NSSAI of the serving PLMN (see clause 4.2.2.3.5) encoded in the "ueSliceMbrs" attribute; + +18. if the feature "EneNA" is supported and an NWDAF information change occurred, the list of NWDAF instance IDs used for the UE and their associated Analytic ID(s) with the updated values within the "nwdafDatas" attribute; + +NOTE 5: The NF service consumer provides the complete updated list of NWDAF instance IDs and associated Analytic ID(s) used for the UE. If all NWDAF data is deleted an empty list is included. + +19. if the feature "TargetNSSAI" is supported, a new Target NSSAI is generated and the Policy Control Request Trigger "Generation of Target NSSAI" is provided, the new generated Target NSSAI encoded in the "targetSnssais" attribute; + +20. if the "NetSliceRepl" feature is supported, the AMF is aware that one or more S-NSSAI(s) become unavailable but cannot determine the corresponding Alternative S-NSSAI(s) and the Policy Control Request Trigger "SLICE\_REPLACE\_MGMT" was provided, these unavailable S-NSSAI(s) encoded within the "unavailSnssais" attribute; and + +21. if "PartNetSliceSupport" feature and/or "NetSliceRepl" feature is/are supported, the UE is registered via 3GPP access and: + +- if the Partially Allowed NSSAI changed and the Policy Control Request Trigger "Change of the Partially Allowed NSSAI" was subscribed by the PCF, then the updated Partially Allowed NSSAI encoded via the "partAllowedNssai" attribute; and + +- if the Partially Allowed NSSAI changed and/or the mapping of one or more of the S-NSSAI(s) of the Partially Allowed NSSAI to the corresponding HPLMN S-NSSAI changed, and the Policy Control Request Trigger "Change of the Partially Allowed NSSAI" was subscribed by the PCF, then the mapping of each S-NSSAI of the Partially Allowed NSSAI to the corresponding HPLMN S-NSSAI encoded within the "mappingSnssais" attribute; + +22. if the "PartNetSliceSupport" feature is supported, the UE is registered via 3GPP access and: + +- if the list of the S-NSSAI(s) partially rejected in the RA changed and the Policy Control Request Trigger "Change of the S-NSSAI(s) rejected partially in the RA" was subscribed by the PCF, then the updated list of the S-NSSAI(s) partially rejected in the RA encoded via the "snssaisPartRejected" attribute; + +- if the list of the Rejected S-NSSAI(s) in the RA changed and the Policy Control Request Trigger "Change of the Rejected S-NSSAI(s)" was subscribed by the PCF, then the updated list of the Rejected S-NSSAI(s) in the RA encoded via the "rejectedSnssais" attribute; and + +- if the Pending NSSAI changed and the Policy Control Request Trigger "Change of the Pending NSSAI" was subscribed by the PCF, then the updated Pending NSSAI encoded via the "pendingNssai" attribute. + +Upon the reception of the HTTP POST request, the PCF shall: + +- update the corresponding individual AM Policy resource based on the information provided by the NF service consumer; +- determine the applicable policy based on local policy; +- for the successful case, send a HTTP "200 OK" response with the PolicyUpdate data type as body with possible updates for that applicable policy and Policy Control Request Trigger(s) encoded as described in clause 4.2.3.3 and according to the following provisions: + +a) if the PCF received the "servAreaRes" attribute in the request, Service Area Restrictions encoded as "servAreaRes" attribute; + +- b) if the PCF received the "rfsp" attribute in the request, RAT Frequency Selection Priority (RFSP) Index encoded as "rfsp" attribute. If the feature "RFSPValidityTime" is supported and the PCF determines to provide an RFSP index value that indicates EPC/E-UTRAN access is prioritized over 5GS access, the PCF may provide, based on operator policies, a validity time for the RFSP index value within the "rfspValTime" attribute; +- c) if the feature "UE-AMBR\_Authorization" is supported and the PCF received the "ueAmbr" attribute in the request, UE-AMBR encoded as "ueAmbr" attribute; +- d) if the PCF received the "smfSelInfo" attribute in the request, the "smfSelInfo" attribute encoding the PCF selected DNN in the "dnn" attribute corresponding to the S-NSSAI received in the "snssai" attribute; + +NOTE 6: A PolicyUpdate data structure with only mandatory attribute(s) is included in the "200 OK" response when the PCF decides not to update the policies. + +- e) if the feature "UE-Slice-MBR\_Authorization" is supported and the PCF received the "ueSliceMbrs" attribute in the request, the corresponding authorized UE-Slice-MBR(s) encoded as "ueSliceMbrs" attribute; +- f) if the feature "TargetNSSAI" is supported and the PCF received the "targetSnssais" attribute in the request, the RFSP Index associated with the Target NSSAI encoded as "targetRfsp" attribute; +- g) if the "NetSliceUsageCtrl" feature is supported, the updated network slice usage control information (e.g., updated slice deregistration inactivity timer) within the "sliceUsgCtrlInfoSets" attribute for each on-demand S-NSSAI of the UE's Allowed NSSAI; and/or + +NOTE 7: In this release of the specification, network slice usage control information provisioning/update/removal by the PCF is not supported in roaming scenarios. + +- h) if the "NetSliceRepl" feature is supported and the PCF received the "unavailSnssais" attribute in the request, the Alternative S-NSSAI(s) associated with the received S-NSSAI(s) within the "snssaiReplInfos" attribute containing these unavailable S-NSSAI(s), and for each unavailable S-NSSAI, the corresponding status information set to "UNAVAILABLE" and the corresponding Alternative S-NSSAI; +- if errors occur when processing the HTTP POST request, apply error handling procedures as specified in clause 5.7 and according to the following provisions: + - a) if the PCF is, due to incomplete, erroneous or missing information in the request, not able to provision an AM policy decision, the PCF may reject the request and include in an HTTP "400 Bad Request" response message the "cause" attribute of the ProblemDetails data structure set to "ERROR\_REQUEST\_PARAMETERS". + - b) if the "ES3XX" feature is supported and the PCF (service) instance has changed, the PCF may respond with an HTTP 3xx redirect response pointing to a new PCF (service) instance as defined in clause 6.5.3.3 of 3GPP TS 29.500 [5]. + +If the PCF received a "traceReq" attribute, it shall perform trace procedures as defined in 3GPP TS 32.422 [18]. + +If the AMF received the request of removal of Service Area Restrictions and/or RFSP Index and/or UE-AMBR and/or UE-Slice-MBR(s) from the UDM, the AMF shall remove the authorized Service Area Restrictions and/or RFSP Index and/or UE-AMBR and/or UE-Slice-MBR(s) provisioned by the PCF and apply the configured Service Area Restrictions and/or RFSP Index and/or UE-AMBR and/or UE-Slice-MBR(s) at the AMF without interacting with the PCF. + +If feature "DNNReplacementControl" is supported and the AMF received the update of the SMF selection information within the "smfSelInfo" attribute in the response, the AMF shall apply the updated SMF selection information to the new PDU Sessions only, i.e. already established PDU Sessions are not affected. + +If the feature "AMInfluence" is supported, the PCF determines that the access and mobility policies may be influenced by the traffic of a PDU session(s), e.g. based on the received policy control request trigger(s), and local operator policies indicate the PCF for the UE shall subscribe with the PCF for the PDU session for established/terminated PDU session(s) event notifications, the PCF shall provision/update the AMF with the PCF for the UE information within the "pcfUeInfo" attribute and the complete list of S-NSSAI and DNN combinations within the "matchPdus" attribute. The AMF shall then update the affected established PDU session(s), by forwarding the received PCF for the UE information for the PDU session(s) matching the new S-NSSAI and DNN combination(s) and removing the previously provided PCF for the UE information for the PDU session(s) matching the removed S-NSSAI and DNN combination(s) as defined in 3GPP TS 29.502 [31]. + +When the feature "AMInfluence" is supported, and the SBA binding indication information for the PCF instance changes, the PCF may update the previously provided information in the AMF. The AMF shall apply the updated PCF callback information to the new PDU Sessions only, i.e., already established PDU sessions are not affected. + +If the PCF received a new GUAMI, the PCF may subscribe to GUAMI changes using the AMFStatusChange service operation of the Namf\_Communication service specified in 3GPP TS 29.518 [14], and it may use the Nnrf\_NFDiscovery Service specified in 3GPP TS 29.510 [13] (using the obtained GUAMI and possibly service name) to query the other AMFs within the AMF set. + +If the PCF received a "servAreaRes" attribute which resulted to a change of the Service Area Restrictions, it shall send notifications to any NF Service Consumer(s) (e.g. AF) that have subscribed to the related event by using the Npcf\_AMPolicyAuthorization service (see TS 29.534 [26]) and/or the Npcf\_EventExposure service ((see TS 29.523 [28]). + +If the PCF received a new list of NWDAF instance IDs used for the UE and their associated Analytic IDs within the "nwdafDatas" attribute, the PCF may select those NWDAF instances based on this new list as described in 3GPP TS 29.513 [7]. + +#### 4.2.3.2 Policy Control Request Triggers + +The following Policy Control Request Triggers are defined (see clause 6.1.2.5 of 3GPP TS 23.503 [4]): + +- "LOC\_CH", i.e. location change (tracking area): the tracking area of the UE has changed; +- "PRA\_CH", i.e. change of UE presence in PRA: the UE is entering/leaving a Presence Reporting Area, this includes reporting the initial status at the time the request for reports is initiated; +- "SERV\_AREA\_CH", i.e. Service Area Restriction change: the UDM notifies the AMF that the subscribed service area restriction information has changed; +- "RFSP\_CH", i.e. RFSP index change: the UDM notifies the AMF that the subscribed RFSP index has changed; +- "ALLOWED\_NSSAI\_CH", i.e. change of allowed NSSAI of the served UE; + +NOTE 1: The "ALLOWED\_NSSAI\_CH" trigger only applies if the "SliceSupport" feature, the "DNNReplacementControl" feature and/or "NetSliceRepl" feature is/are supported. + +- "UE\_AMBR\_CH", i.e. UE-AMBR change: the UDM notifies the AMF that the subscribed UE-AMBR has changed; + +NOTE 2: The "UE\_AMBR\_CH" trigger only applies if the "UE-AMBR\_Authorization" feature is supported. + +- "SMF\_SELECT\_CH", i.e. SMF selection information change: UE request for an unsupported DNN or UE request for a DNN within the list of DNN candidates for replacement per S-NSSAI; + +NOTE 3: The "SMF\_SELECT\_CH" trigger only applies if the "DNNReplacementControl" feature is supported and "ALLOWED\_NSSAI\_CH" trigger is also subscribed. + +- "ACCESS\_TYPE\_CH", i.e. the access type change: the AMF notifies that the access type and the RAT type combinations available in the AMF for a UE with simultaneous 3GPP and non-3GPP connectivity has changed; + +NOTE 4: The "ACCESS\_TYPE\_CH" trigger only applies if the "MultipleAccessTypes" feature is supported as specified in Annex B. + +- "UE\_SLICE\_MBR\_CH", i.e. UE-Slice-MBR change: the AMF notifies for any changes in the subscribed UE-Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping to a S-NSSAI of the serving PLMN; + +NOTE 5: The "UE\_SLICE\_MBR\_CH" trigger only applies if the "UE-Slice-MBR\_Authorization" feature is supported. + +- "NWDAF\_DATA\_CH", i.e. NWDAF Data change: the list of NWDAF Instance IDs and/or their associated Analytics IDs consumed by the AMF have changed; + +NOTE 6: The "NWDAF\_DATA\_CH" trigger only applies if the "EneNA" feature is supported. + +- "TARGET\_NSSAI", i.e. Generation of Target NSSAI: the NF service consumer notifies that the Target NSSAI was generated; + +NOTE 7: The "TARGET\_NSSAI" trigger only applies if the "TargetNSSAI" feature is supported. + +- "SLICE\_REPLACE\_MGMT", i.e. Network slice replacement is needed for one or more S-NSSAI(s) and the NF service consumer (i.e., AMF) cannot determine the Alternative S-NSSAI(s) for these S-NSSAI(s); and + +NOTE 8: The "SLICE\_REPLACE\_MGMT" trigger only applies if the "NetSliceRepl" feature is supported. + +- "PARTIALLY\_ALLOWED\_NSSAI\_CH", i.e. change of the Partially Allowed NSSAI of the served UE; + +NOTE 9: The "PARTIALLY\_ALLOWED\_NSSAI\_CH" trigger only applies if the "PartNetSliceSupport" feature and/or "NetSliceRepl" feature is/are supported. + +- "SNSSAIS\_PARTIALLY\_REJECTED\_CH", i.e. change of the S-NSSAI(s) partially rejected in the RA for the served UE; +- "REJECTED\_SNSSAIS\_CH", i.e. change of the Rejected S-NSSAI(s) in the RA for the served UE; +- "PENDING\_NSSAI\_CH", i.e. change of the Pending NSSAI of the served UE; + +NOTE 10: The "SNSSAIS\_PARTIALLY\_REJECTED\_CH", "REJECTED\_SNSSAIS\_CH" and "PENDING\_NSSAI\_CH" triggers only apply if the "PartNetSliceSupport" feature is supported. + +#### 4.2.3.3 Encoding of updated policy + +Updated policies shall be encoded within the PolicyUpdate data type that may include: + +- AMF Access and Mobility Policy (see clause 4.2.2.3) Service Area Restriction encoded as "servAreaRes" attribute; +- AMF Access and Mobility Policy (see clause 4.2.2.3) RFSP Index encoded as "rfsp" attribute and RFSP Index associated with the Target NSSAI encoded as "targetRfsp" attribute; +- if the "UE-AMBR\_Authorization" feature is supported, AMF Access and Mobility Policy (see clause 4.2.2.3) UE-AMBR encoded as "ueAmbr" attribute; +- if the "UE-Slice-MBR\_Authorization" feature is supported, AMF Access and Mobility Policy (see clause 4.2.2.3) UE-Slice-MBR(s) encoded as "ueSliceMbrs" attribute; + +NOTE: PCF can stop applying policies to already provided attributes under PolicyUpdate data type. In that case, PCF will modify those attributes by e.g. providing configured values. How the PCF gets those values is out of specification. + +- if the "DNNReplacementControl" feature is supported, AMF Access and Mobility Policy (see clause 4.2.2.3) SMF selection information encoded as "smfSelInfo" attribute; +- if the "NetSliceRepl" feature is supported, network slice replacement information within the "snssaiReplInfos" attribute; +- updated Policy Control Request Trigger(s) (see clause 4.2.3.2) encoded as "triggers" attribute i.e.: + - 1) either a new complete list of applicable Policy Control Request Trigger(s) including one or several of the following: + - a) Location change (tracking area); + - b) Change of UE presence in PRA; + - c) if the "SliceSupport" feature, the "DNNReplacementControl" feature and/or the "NetSliceRepl" feature is supported, change of Allowed NSSAI; + - d) if the "DNNReplacementControl" feature is supported, SMF selection information change; + - e) if the "NetSliceRepl" feature is supported, network slice replacement information change; + +- f) if the "PartNetSliceSupport" feature and/or "NetSliceRepl" feature is/are supported, Change of the Partially Allowed NSSAI; and/or + - g) if the "PartNetSliceSupport" feature is supported, Change of the S-NSSAI(s) rejected partially in the RA, Change of the Rejected S-NSSAI(s) and/or Change of the Pending NSSAI; +- 2) a "NULL" value to request the removal of all previously installed Policy Control Request Trigger(s); and +- if the Policy Control Request Trigger "Change of UE presence in PRA" is provided or if that trigger was already set but the requested presence reporting areas need to be changed, the presence reporting areas for which reporting is required encoded as "pras" attribute encoded as follows: + - a) A new entry shall be added by supplying a new identifier as key and the corresponding PresenceInfo data type instance with complete contents as value as an entry within the map. + - b) An existing entry shall be modified by supplying the existing identifier as key and the PresenceInfo data type instance with complete contents as value as an entry within the map. + - c) An existing entry shall be deleted by supplying the existing identifier as key and "NULL" as value as an entry within the map. + - d) For an unmodified entry, no entry needs to be provided within the map. +- if the Policy Control Request Trigger "Change of UE presence in PRA" is removed, the presence reporting areas for which reporting was required shall be removed by providing the "pras" attribute with "NULL" as value.; +- if the Policy Control Request Trigger "SMF selection information change" is provided or if that trigger was already set and the indication of DNN replacement when the requested DNN is unknown needs to be set or changed, the "unsuppDnn" attribute within "smfSelInfo" attribute shall be provided including the appropriate value. +- if the Policy Control Request Trigger "SMF selection information change" is provided or if that trigger was already set and the list of candidate DNNs for replacement needs to be set or changed, the "candidates" attribute within the "smfSelInfo" attribute is encoded as follows: + - a) A new entry shall be added by supplying a new S-NSSAI as key and the corresponding CandidateForReplacement data type instance with complete contents as value as an entry within the map. + - b) An existing entry shall be modified by supplying the existing S-NSSAI as key and the CandidateForReplacement data type instance with complete contents as value as an entry within the map. + - c) An existing entry shall be deleted by supplying the existing S-NSSAI as key and "NULL" as value as an entry within the map. + - d) For an unmodified entry, no entry needs to be provided within the map. + - e) The complete list of candidate DNNs for which reporting is required shall be removed by providing the "candidates" attribute with "NULL" as value. +- if the Policy Control Request Trigger "SMF selection information change" is removed, the candidate DNNs for which reporting was required shall be removed by providing the "smfSelInfo" attribute with "NULL" as value; and +- if the "NetSliceUsageCtrl" feature is supported, the PCF may check whether any of the S-NSSAI(s) of the UE's Allowed NSSAI are on-demand S-NSSAI(s) and subject to network slice usage control. If it is the case, the PCF may provision/update/remove in the Npcf\_SMPolicyControl\_Update response the network slice usage control information (e.g., slice deregistration inactivity timer) within the "sliceUsgCtrlInfoSets" attribute of the PolicyUpdate data structure for one or more of these S-NSSAI(s). + +#### 4.2.3.4 Feature renegotiation during AMF relocation + +During the AMF relocation, if the new AMF received the resource URI of the individual AM Policy from the old AMF and selects the old PCF, and the feature "FeatureRenegotiation" is supported, the new AMF shall invoke the update of the AM policy association as described in clause 4.2.3.1 with the following differences: + +- The new AMF shall include in the PolicyAssociationUpdateRequest data structure sent in the HTTP POST request: + - a. the "FEAT\_RENEG" policy control request trigger within the "triggers" attribute; + - b. the "suppFeat" attribute with the AMF supported features; and + - c. for each supported feature, the required feature information elements as specified in clause 4.2.2.1, if applicable. + +NOTE 1: When the new AMF received from the old AMF the subscription to policy control request trigger(s) that depend on feature control, and a policy control request trigger is met, the required feature information included in the update request contains the report of the met policy control request trigger within the "triggers" attribute and the associated information in the corresponding attribute, when applicable. + +- Upon reception of the HTTP POST request, the PCF shall update the "Individual AM Policy Association" resource, determine the applicable policy and include in the PolicyUpdate data structure sent in the HTTP POST response: + +NOTE 2: The determination of the applicable policy can consider the features supported by the new AMF. + +- a. the "suppFeat" attribute with the negotiated features; and +- b. the complete "Individual AM Policy Association" resource representation, as specified in clause 4.2.2.1. + +### 4.2.4 Npcf\_AMPolicyControl\_UpdateNotify Service Operation + +#### 4.2.4.1 General + +The PCF may decide to update policies or to request the termination of the policy association and shall then use an Npcf\_AMPolicyControl\_UpdateNotify service operation. + +The following procedures using the Npcf\_AMPolicyControl\_UpdateNotify service operation are supported: + +- policy update notification; and +- request for termination of the policy association. + +#### 4.2.4.2 Policy update notification + +Figure 4.2.4.2-1 illustrates the policy update notification. + +![Sequence diagram showing the policy update notification process between a PCF and an NF service consumer.](db7ae70402c81d140ae7df14b002e057_img.jpg) + +``` +sequenceDiagram + participant PCF + participant NF as NF service consumer + Note right of PCF: 1. POST {notificationUri}/update + PCF->>NF: 1. POST {notificationUri}/update + Note left of NF: 2a. "200 OK" +2b. "204 No Content" + NF-->>PCF: 2a. "200 OK" +2b. "204 No Content" +``` + +The diagram illustrates a sequence of interactions between a PCF (Policy Control Function) and an NF service consumer. The PCF sends a POST request to the NF service consumer at the notification URI. The NF service consumer responds with either a 200 OK or a 204 No Content status. + +Sequence diagram showing the policy update notification process between a PCF and an NF service consumer. + +Figure 4.2.4.2-1: policy update notification + +The PCF may decide to update policy control request trigger(s) and/or Access and Mobility policies related to an Individual AM Policy Association, e.g., in response to information provided to the PCF via external interfaces, (e.g., the Npcf\_AMPolicyAuthorization service (see 3GPP TS 29.534 [26]), notifications provided by the + +Npcf\_PolicyAuthorization service (see 3GPP TS 29.514 [25]), notifications received from UDR about new or updated AF requirements on Access and Mobility policies (see 3GPP TS 29.519 [17]), or in response to an internal trigger within the PCF, e.g., the activation of a pending policy counter provided via the Nchf\_SpendingLimitControl Service (see 3GPP TS 29.594 [33]). The PCF shall send for this purpose an HTTP POST request with "{notificationUri}/update" as URI (where the Notification URI was previously supplied by the NF service consumer) and the PolicyUpdate data structure as request body encoded as described in clause 4.2.3.3. + +Upon the reception of the HTTP POST request, the NF service consumer shall enforce the received updated policy. + +In case of a successful update notification: + +- if the feature "ImmediateReport" is supported and the PCF provisioned the policy control request triggers related to access type change, PRA change, Allowed NSSAI change, Partially Allowed NSSAI change, change of the S-NSSAI(s) rejected partially in the RA, change of the Rejected S-NSSAI(s) in the RA, Pending NSSAI change and/or location change, a "200 OK" response code and a response body with the corresponding available information in the "AmRequestedValueRep" data structure shall be returned in the response; +- otherwise, a "204 No Content" response code shall be returned in the response. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +If the AMF as NF service consumer is not able to handle the notification but knows by implementation specific means that another AMF is able to handle the notification, it shall reply with an HTTP "307 Temporary redirect" response pointing to the URI of the new AMF. If the AMF is not able to handle the notification but another unknown AMF could possibly handle the notification, it shall reply with an HTTP "404 Not found" error response. + +If the PCF receives a "307 Temporary redirect" response, the PCF shall resend the failed policy update notification request using the received URI in the Location header field as Notification URI. Subsequent policy update notifications, triggered after the failed one, shall be sent to the Notification URI provided by the NF service consumer during the corresponding policy association creation/update. + +If the PCF becomes aware that a new AMF is requiring notifications (e.g. via the "404 Not found" response, via Namf\_Communication service AMFStatusChange Notifications, see 3GPP TS 29.518 [14], or via link level failures), and the PCF knows alternate or backup IPv4, IPv6 Address(es) or FQDN(s) where to send Notifications (e.g. via "altNotifIpv4Addrs", "altNotifIpv6Addrs" or "altNotifFqdns" attributes received when the policy association was created, via AMFStatusChange Notifications or via the Nnrf\_NFDiscovery Service specified in 3GPP TS 29.510 [13] (using the service name and GUAMI obtained during the creation of the subscription) to discover the other AMFs within the AMF set), the PCF shall exchange the authority part of the corresponding Notification URI with one of those addresses and shall use that URI in any subsequent communication. + +If the PCF received a "404 Not found" response, the PCF should resend the failed policy update notification request to that URI. + +If the feature "DNNReplacementControl" is supported and the AMF received the update of the SMF selection information within the "smfSelInfo" attribute in the request, the AMF shall apply the updated SMF selection information to the new PDU Sessions only, i.e. already established PDU Sessions are not affected. + +If the feature "AMInfluence" is supported, the PCF determines that the access and mobility policies may be influenced by the traffic of a PDU session(s) based on an AF request, UDR notification or other internal policies, and local operator policies indicate the PCF for the UE shall subscribe with the PCF for the PDU session for established/terminated PDU session(s) event notifications, the PCF for the UE shall provision/update the AMF with the PCF for the UE information within the "pcfUeInfo" attribute and the complete list of S-NSSAI and DNN combinations within the "matchPdus" attribute. The AMF shall update the affected established PDU sessions, forwarding the received PCF for the UE information for the PDU session(s) matching the new S-NSSAI and DNN combination(s), and removing the previously provided PCF for the UE information for the PDU session(s) matching the removed S-NSSAI and DNN combination(s) as defined in 3GPP TS 29.502 [31]. + +When the feature "AMInfluence" is supported, and the SBA binding indication information for the PCF instance changes, the PCF may update the previously provided information in the AMF. The AMF shall apply the updated PCF callback information to the new PDU Sessions only, i.e., already established PDU sessions are not affected. + +NOTE 1: Alternatively, the PCF for the UE can subscribe with the BSF to notifications about the PCF binding information creation and/or termination for the affected PDU session(s) as described in 3GPP TS 29.521 [30]. + +If the PCF changed the Service Area Restrictions as part of the policy update, it shall send notifications to any NF Service Consumer(s) (e.g. AF) that have subscribed to the related event by using the Npcf\_AMPolicyAuthorization service (see TS 29.534 [26]) and/or the Npcf\_EventExposure service (see TS 29.523 [28]). + +If the feature "5GAccessStratumTime" is supported and the PCF receives the access stratum time distribution parameters or removal of the access stratum time distribution parameters from the TSCTSF as defined in 3GPP TS 29.534 [26], the PCF may provision, update or remove the 5G access stratum time distribution parameters by provisioning the "asTimeDisParam" attribute as defined in clause 4.2.2.3.6. The AMF shall provision the 5G access stratum time distribution parameters to the NG-RAN when receiving it from the PCF. + +If the feature "RFSPValidityTime" is supported and the PCF determines to modify the RFSP index value in use to indicate EPC/E-UTRAN access is prioritized over 5GS access, the PCF shall send to the AMF the RFSP Index value within the "rfsp" attribute and may provide, based on operator policies, the validity time for the indicated RFSP Index value within the "rfspValTime" attribute, as defined in clause 4.2.2.3.2. + +If the feature "NetTimeSyncStatus" is supported and the PCF receives the clock quality detail level and optionally the clock quality acceptance criteria parameters from the TSCTSF as defined in 3GPP TS 29.534 [26], the PCF may update the clock quality detail level and if applicable the clock quality acceptance criteria parameters by provisioning the "asTimeDisParam" attribute as defined in clause 4.2.2.3.6. The AMF shall provision the clock quality detail level and the clock quality acceptance criteria parameters to the NG-RAN when receiving it from the PCF. + +If the "NetSliceUsageCtrl" feature is supported, the PCF may check whether any of the S-NSSAI(s) of the UE's Allowed NSSAI are subject to network slice usage control. If it is the case, the PCF may provision/update/remove in the Npcf\_AMPolicyControl\_UpdateNotify request the network slice usage control information (e.g. slice deregistration inactivity timer) within the "sliceUsgCtrlInfoSets" attribute of the PolicyUpdate data structure for one or more of these S-NSSAI(s). + +NOTE 2: In this release of the specification, network slice usage control information provisioning/update/removal by the PCF is not supported in roaming scenarios. + +If the "NetSliceRepl" feature is supported, then: + +- when the PCF detects that one or more S-NSSAI(s) of the UE's Allowed NSSAI and/or Partially Allowed NSSAI become(s) unavailable for a UE based on an OAM trigger, a received NWDAF notification or PCF internal triggers, the PCF may indicate this to the AMF by providing the "snssaiReplInfos" attribute containing these impacted S-NSSAI(s), and for each impacted S-NSSAI, the corresponding status information set to "UNAVAILABLE" and optionally an Alternative S-NSSAI; and +- when the PCF becomes aware that one or more S-NSSAI(s) of the UE's Allowed NSSAI and/or Partially Allowed NSSAI become(s) available again, the PCF may indicate this to the AMF also by providing the "snssaiReplInfos" attribute containing these impacted S-NSSAI(s), and for each impacted S-NSSAI, the corresponding status information set to "AVAILABLE". + +NOTE 3: The PCF can provide within the "snssaiReplInfos" attribute both information about S-NSSAI(s) that are currently unavailable and information about S-NSSAI(s) that are available again. + +#### 4.2.4.3 Request for termination of the policy association + +Figure 4.2.4.3-1 illustrates the request for a termination of the policy association. + +![Sequence diagram showing the request for a termination of the policy association between a PCF and an NF service consumer.](dd5771673aececa53d42ece89218299d_img.jpg) + +``` + +sequenceDiagram + participant PCF + participant NF as NF service consumer + Note right of PCF: 1. POST {notificationUri}/terminate + PCF->>NF: Request + Note left of NF: 2. "204 No Content" + NF-->>PCF: Response + +``` + +The diagram illustrates a sequence of two messages between a PCF (Policy Control Function) and an NF service consumer. The first message, labeled '1. POST {notificationUri}/terminate', is sent from the PCF to the NF service consumer. The second message, labeled '2. "204 No Content"', is sent from the NF service consumer back to the PCF. + +Sequence diagram showing the request for a termination of the policy association between a PCF and an NF service consumer. + +**Figure 4.2.4.3-1: request for a termination of the policy association** + +The PCF may request the termination of the policy association and shall then send an HTTP POST request with "{notificationUri}/terminate" as URI (where the Notification URI was previously supplied by the NF service consumer) and the TerminationNotification data structure as request body that shall include: + +- the policy association ID encoded as "polAssoId" attribute; and +- the cause why the PCF requests the termination of the policy association encoded as "cause" attribute. + +Upon the reception of the HTTP POST request, the NF service consumer shall: + +- either send a HTTP "204 No Content" response for the successful processing of the HTTP POST request or an appropriate failure response; and +- if errors occur when processing the HTTP POST request, send an HTTP error response as specified in clause 5.7; or +- if the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +After the successful processing of the HTTP POST request, the NF service consumer shall remove the context related to the policy association but still apply the provisioned AM policies to the UE and invoke the Npcf\_AMPolicyControl\_Delete Service Operation defined in clause 4.2.5 to terminate the policy association. + +If the AMF as NF service consumer is not able to handle the notification but knows by implementation specific means that another AMF is able to handle the notification, it shall reply with an HTTP "307 Temporary redirect" response pointing to the URI of the new AMF. If the AMF is not able to handle the notification but another unknown AMF could possibly handle the notification, it shall reply with an HTTP "404 Not found" error response. + +If the PCF receives a "307 Temporary redirect" response, the PCF shall resend the failed request for termination of the policy association using the received URI in the Location header field as Notification URI. + +If the PCF becomes aware that a new AMF is requiring notifications (e.g. via the "404 Not found" response, via Namf\_Communication service AMFStatusChange Notifications, see 3GPP TS 29.518 [14], or via link level failures), and the PCF knows alternate or backup IPv4, IPv6 Address(es) or FQDN(s) where to send Notifications (e.g. via "altNotifIpv4Addrs", "altNotifIpv6Addrs" or "altNotifFqdns" attributes received when the policy association was created, via AMFStatusChange Notifications or via the Nnrf\_NFDiscovery Service specified in 3GPP TS 29.510 [13] (using the service name and GUAMI obtained during the creation of the subscription) to discover the other AMFs within the AMF set), the PCF shall exchange the authority part of the corresponding Notification URI with one of those addresses and shall resend the failed request for termination of the policy association to that URI. + +If the PCF received a "404 Not found" response, the PCF should resend the failed request for termination of the policy association to that URI. + +### 4.2.5 Npcf\_AMPolicyControl\_Delete Service Operation + +Figure 4.2.5-1 illustrates the deletion of a policy association. + +![Sequence diagram showing the deletion of a policy association. An NF service consumer sends a DELETE request to a PCF, and the PCF responds with a 204 No Content.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. DELETE .../policies/{polAssoId} + NF service consumer->>PCF: Request + Note left of PCF: 2. "204 No Content" + PCF-->>NF service consumer: Response + +``` + +Sequence diagram showing the deletion of a policy association. An NF service consumer sends a DELETE request to a PCF, and the PCF responds with a 204 No Content. + +**Figure 4.2.5-1: Deletion of a policy association** + +The AMF as NF service consumer requests that the policy association is deleted when the corresponding UE context is terminated, e.g. during UE de-registration from the network, or when the UE moves from 5GS to EPS and the UE is not connected to the 5GC over a non-3GPP access. + +During the AMF relocation, the old AMF shall invoke this procedure when: + +- the resource URI of the "Individual AM Policy Association" resource is not transferred to the new AMF; or +- the new AMF informs the old AMF that the "Individual AM Policy Association" resource is not being reused (i.e. the old PCF is not being reused). + +To request that the policy association is deleted, the NF service consumer (e.g. AMF) shall send an HTTP DELETE request with "{apiRoot}/npcf-am-policy-control/v1/policies/{polAssoId}" as Resource URI. + +Upon the reception of the HTTP DELETE request, the PCF shall: + +- delete the policy association; +- send either an HTTP "204 No Content" response indicating the success of the deletion or an appropriate failure response; and +- if errors occur when processing the HTTP DELETE request, send an HTTP error response as specified in clause 5.7; or +- if the feature "ES3XX" is supported, and the PCF determines the received HTTP DELETE request needs to be redirected, send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +# 5 Npcf\_AMPolicyControl API + +## 5.1 Introduction + +The Access and Mobility Policy Control Service shall use the Npcf\_AMPolicyControl API. + +The API URI of the Npcf\_AMPolicyControl API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the PCF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [6], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. + +- The shall be "npcf-am-policy-control". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +The OpenAPI [10] specification of HTTP messages and content bodies for the Npcf\_AMPolicyControl is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers. + +#### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [9], 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 [5]. 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 9457 [21]. + +### 5.2.3 HTTP custom headers + +The Npcf\_AMPolicyControl API shall support HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [5] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [5]. + +In this Release of the specification, no specific custom headers are defined for the Npcf\_AMPolicyControl API. + +## 5.3 Resources + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.3.1-1 depicts the resource URIs structure for the Npcf\_AMPolicyControl API. + +### 5.3.1 Resource Structure + +![A hierarchical diagram showing the resource URI structure. The root is {apiRoot}/npcf-am-policy-control/v1. It branches to /policies. /policies branches to/{polAssId}. /{polAssId} branches to /update, which is shown in a dashed box.](3e2a8dc8c5537dbe703cdcb0e21e4e1b_img.jpg) + +{apiRoot}/npcf-am-policy-control/v1 + +``` + +graph TD + Root["{apiRoot}/npcf-am-policy-control/v1"] --> Policies["/policies"] + Policies --> PolAssId["/{polAssId}"] + PolAssId --> Update["/update"] + style Update stroke-dasharray: 5 5 + +``` + +A hierarchical diagram showing the resource URI structure. The root is {apiRoot}/npcf-am-policy-control/v1. It branches to /policies. /policies branches to/{polAssId}. /{polAssId} branches to /update, which is shown in a dashed box. + +**Figure 5.3.1-1: Resource URI structure of the Npcf\_AMPolicyControl API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------|-----------------------------|---------------------------------|------------------------------------------------------------| +| AM Policy Associations | /policies | POST | Create a new Individual AM Policy Association resource. | +| Individual AM Policy Association | /policies/{polAssId} | GET | Read the Individual AM Policy Association resource. | +| | | DELETE | Delete the Individual AM Policy Association resource. | +| | /policies/{polAssId}/update | update (POST) | Report observed event trigger and obtain updated policies. | + +### 5.3.2 Resource: AM Policy Associations + +#### 5.3.2.1 Description + +This resource represents a collection of Individual AM policy Associations. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/npcf-am-policy-control/v1/policies + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|------------------------------------------------------------| +| PolicyAssociationRequest | M | 1 | Input parameters for the creation of a policy association. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|-----------------|-----------------------------------------------------------------| +| PolicyAssociation | M | 1 | 201 Created | Policy association was created and policies are being provided. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: Failure cases are described in clause 5.7. + +**Table 5.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}/npcf-am-policy-control/v1/policies/{polAssId} | + +### 5.3.3 Resource: Individual AM Policy Association + +#### 5.3.3.1 Description + +This document resource represents an individual AM policy association. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/npcf-am-policy-control/v1/policies/{polAssId} + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|-------------------------------------| +| apiRoot | string | See clause 5.1. | +| polAssId | string | Identifier of a policy association. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.3.3.1-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.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.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.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| PolicyAssociation | M | 1 | 200 OK | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual AM policy retrieval.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual AM policy retrieval.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-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.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +**Table 5.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The policy association was successfully deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual AM policy deletion.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual AM policy deletion.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +#### 5.3.3.4 Resource Custom Operations + +##### 5.3.3.4.1 Overview + +**Table 5.3.3.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|------------------------------|--------------------|------------------------------------------------------------| +| Update | /policies/{polAssold}/update | POST | Report observed event trigger and obtain updated policies. | + +##### 5.3.3.4.2 Operation: Update + +###### 5.3.3.4.2.1 Description + +The update custom operation allows an NF service consumer to report the occurrence of one or more policy control request trigger(s) and to obtain related updated policies. + +###### 5.3.3.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 5.3.3.4.2.2-1 and the response data structure and response codes specified in table 5.3.3.4.2.2-2. + +**Table 5.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|-----------------------------------------------------------| +| PolicyAssociationUpdateRequest | M | 1 | Describes the observed policy control request trigger(s). | + +**Table 5.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| PolicyUpdate | M | 1 | 200 OK | Describes updated policies. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual AM policy modification.

Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual AM policy modification.

Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | +| NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. | | | | | +| NOTE 2: Failure cases are described in clause 5.7. | | | | | +| NOTE 3: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]). | | | | | + +**Table 5.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 5.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +## 5.4 Custom Operations without associated resources + +None. + +## 5.5 Notifications + +### 5.5.1 General + +**Table 5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------------------------|-----------------------------|---------------------------------|----------------------------------------------------| +| Policy Update Notification | {notificationUri}/update | update (POST) | Policy Update Notification. | +| Request for termination of the policy association | {notificationUri}/terminate | terminate (POST) | Request for termination of the policy association. | + +### 5.5.2 Policy Update Notification + +#### 5.5.2.1 Description + +This notification is used by the PCF to provide updates of access and mobility policies to the NF service consumer. + +#### 5.5.2.2 Operation Definition + +This operation shall support the request data structures specified in table 5.5.2.2-1 and the response data structure and response codes specified in table 5.5.2.2-2. + +Table 5.5.2.2-1: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|-------------------| +| PolicyUpdate | M | 1 | Updated policies. | + +Table 5.5.2.2-2: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The policies were successfully updated. | +| AmRequestedValueRep | O | 0..1 | 200 OK | The current applicable values corresponding to the policy control request trigger are reported. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during AM policy notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during AM policy notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The NF service consumer can use this response when the notification can be sent to another unknown host. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +Table 5.5.2.2-3: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | String | O | 0..1 | Identifier of the target NF consumer (service) instance towards which the notification request is redirected. May be included if the feature "ES3XX" is supported. | + +Table 5.5.2.2-4: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | String | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | String | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +### 5.5.3 Request for termination of the policy association + +#### 5.5.3.1 Description + +This notification is used by the PCF to request the termination of a policy association. + +#### 5.5.3.2 Operation Definition + +This operation shall support the request data structures specified in table 5.5.3.2-1 and the response data structure and response codes specified in table 5.5.3.2-2. + +**Table 5.5.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|----------------------------------------------| +| TerminationNotification | M | 1 | Request to terminate the policy association. | + +**Table 5.5.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The request for policy association termination was received. | +| RedirectResponse | O | 0..1 | 307 temporary redirect | Temporary redirection, during AM policy notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during AM policy notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The NF service consumer can use this response when the notification can be sent to another unknown host. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.5.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF consumer (service) instance towards which the notification request is redirected. May be included if the feature "ES3XX" is supported. | + +**Table 5.5.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF consumer (service) instance towards which the notification request is redirected. | + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.1-1 specifies the data types defined for the Npcf\_AMPolicyControl service based interface protocol. + +**Table 5.6.1-1: Npcf\_AMPolicyControl specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------|----------------------------| +| AsTimeDistributionParam | 5.6.2.10 | Contains the 5G access stratum time distribution parameters. | 5GAccessStratumTime | +| CandidateForReplacement | 5.6.2.8 | Contains the list of candidate DNNs for replacement per S-NSSAI. | DNNReplacementControl | +| PolicyAssociation | 5.6.2.2 | Description of a policy association that is returned by the PCF when a policy Association is created, or read. | | +| PolicyAssociationReleaseCause | 5.6.3.4 | The cause why the PCF requests the termination of the policy association. | | +| PolicyAssociationRequest | 5.6.2.3 | Information that NF service consumer provides when requesting the creation of a policy association. | | +| PolicyAssociationUpdateRequest | 5.6.2.4 | Information that NF service consumer provides when requesting the update of a policy association. | | +| PolicyUpdate | 5.6.2.5 | Updated policies that the PCF provides in a notification or in the reply to an Update Request. | | +| RequestTrigger | 5.6.3.3 | Enumeration of possible Request Triggers. | | +| SliceUsgCtrlInfo | 5.6.2.12 | Represents network slice usage control related information. | NetSliceUsageCtrl | +| SmfSelectionData | 5.6.2.7 | Includes the SMF Selection information that may be replaced by the PCF. | DNNReplacementControl | +| SnsaiPartRejected | 5.6.2.13 | Represents a S-NSSAI partially rejected in the RA. | PartNetSliceSupport | +| TerminationNotification | 5.6.2.6 | Request to terminate a policy Association that the PCF provides in a notification. | | +| AmRequestedValueRep | 5.6.2.9 | Contains the current applicable values corresponding to the policy control request triggers. | ImmediateReport | +| UeSliceMbr | 5.6.2.11 | Contains a UE-Slice-MBR and the related information. | UE-Slice-MBR_Authorization | + +Table 5.6.1-2 specifies data types re-used by the Npcf\_AMPolicyControl 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 Npcf\_AMPolicyControl service based interface. + +Table 5.6.1-2: Npcf\_AMPolicyControl re-used Data Types + +| Data type | Reference | Comments | Applicability | +|---------------------------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| +| AccessType | 3GPP TS 29.571 [11] | Represents an access type. | | +| Ambr | 3GPP TS 29.571 [11] | Aggregated Maximum Bit Rate. | UE-AMBR_Authorization | +| ClockQualityAcceptanceCriterion | 3GPP TS 29.571 [11] | Indicates the Clock quality acceptance criteria information. | NetTimeSyncStatus | +| ClockQualityDetailLevel | 3GPP TS 29.571 [11] | Contains the clock quality detail level information, that indicates whether it consists of clock quality metrics or acceptance indication. | NetTimeSyncStatus | +| Dnn | 3GPP TS 29.571 [11] | DNN | DNNReplacementControl | +| DurationSec | 3GPP TS 29.571 [11] | Duration in number of seconds. | RFSPValidityTime | +| DurationSecRm | 3GPP TS 29.571 [11] | This data type is defined in the same way as the "DurationSec" data type, but with the OpenAPI "nullable: true" property. | | +| Fqdn | 3GPP TS 29.571 [11] | FQDN | | +| Gpsi | 3GPP TS 29.571 [11] | Generic Public Subscription Identifier | | +| GroupId | 3GPP TS 29.571 [11] | Represents the identifier of a group of UEs. | | +| Guami | 3GPP TS 29.571 [11] | Globally Unique AMF Identifier | | +| Ipv4Addr | 3GPP TS 29.571 [11] | Represents an IPv4 address. | | +| Ipv6Addr | 3GPP TS 29.571 [11] | Represents an IPv6 address. | | +| MappingOfSnssai | 3GPP TS 29.531 [24] | Identifies the mapping of an S-NSSAI of the Allowed NSSAI or the Partially Allowed NSSAI to the corresponding S-NSSAI of the HPLMN. | DNNReplacementControl
PartNetSliceSupport | +| NwdafData | 3GPP TS 29.512 [27] | Indicates an NWDAF instance ID used for the UE and its associated Analytics ID(s) consumed by the NF service consumer. | EneNA | +| PartiallyAllowedSnssai | 3GPP TS 29.571 [11] | Represents the S-NSSAI that is partially allowed in the Registration Area, | NetSliceRepl
PartNetSliceSupport | +| PcfUeCallbackInfo | 3GPP TS 29.571 [11] | Contains the PCF for the UE information necessary for the PCF for the PDU session to send Establishment and Termination event. | AMInfluence | +| PduSessionInfo | 3GPP TS 29.571 [11] | Contains information related to a PDU session. | AMInfluence | +| Pei | 3GPP TS 29.571 [11] | Permanent Equipment Identifier | | +| PlmnIdNid | 3GPP TS 29.571 [11] | Identifies the network: PLMN Identifier or the SNPn Identifier (the PLMN Identifier and the NID). | | +| PresenceInfo | 3GPP TS 29.571 [11] | Presence reporting area information | | +| PresenceInfoRm | 3GPP TS 29.571 [11] | This data type is defined in the same way as the "PresenceInfo" data type, but with the OpenAPI "nullable: true" property. | | +| ProblemDetails | 3GPP TS 29.571 [11] | Represents error related information. | | +| RedirectResponse | 3GPP TS 29.571 [11] | Contains redirection related information. | ES3XX | +| Uri | 3GPP TS 29.571 [11] | Represents a URI. | | +| UserLocation | 3GPP TS 29.571 [11] | Represents user location information. | | +| RatType | 3GPP TS 29.571 [11] | Represent a RAT type. | | +| RfspIndex | 3GPP TS 29.571 [11] | Represent an RFSP Index. | | +| ServiceAreaRestriction | 3GPP TS 29.571 [11] | Within the areas attribute, only tracking area codes shall be included. | | +| ServiceName | 3GPP TS 29.510 [13] | Name of the service instance. | | +| SliceMbr | 3GPP TS 29.571 [11] | Contains the slice Maximum Bit Rate including UL and DL. | UE-Slice-MBR_Authorization | +| Snssai | 3GPP TS 29.571 [11] | Identifies an S-NSSAI. | SliceSupport,
TargetNSSAI,
DNNReplacementControl
NetSliceRepl
PartNetSliceSupport | + +| | | | | +|--------------------------------|---------------------|--------------------------------------------------------------------------------------|-----------------------------| +| SnsaiReplaceInfo | 3GPP TS 29.571 [11] | Represents the network slice replacement information. | NetSliceRepl | +| Supi | 3GPP TS 29.571 [11] | Subscription Permanent Identifier | | +| SupportedFeatures | 3GPP TS 29.571 [11] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | +| TimeZone | 3GPP TS 29.571 [11] | Represents a time zone. | | +| TraceData | 3GPP TS 29.571 [11] | Represents trace data. | | +| UIntegerRm | 3GPP TS 29.571 [11] | Indicates Unsigned Integer, but with the OpenAPI "nullable: true" property. | 5GAccessStratumTime | +| WirelineServiceAreaRestriction | 3GPP TS 29.571 [11] | Represent wireline service area restriction information. | WirelineWirelessConvergence | + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 5.6.2.2 Type PolicyAssociation + +Table 5.6.2.2-1: Definition of type PolicyAssociation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| request | PolicyAssociationRequest | O | 0..1 | The information provided by the NF service consumer when requesting the creation of a policy association | | +| triggers | array(RequestTrigger) | O | 1..N | Request Triggers that the PCF subscribes. Only values "LOC_CH", "ALLOWED_NSSAI_CH", "TARGET_NSSAI", "SMF_SELECT_CH", "PRA_CH", "ACCESS_TYPE_CH", "SLICE_REPLACE_MGMT", "PARTIALLY_ALLOWED_NSSAI_CH", "SNSSAIS_PARTIALLY_REJECTED_CH", "REJECTED_SNSSAIS_CH" and "PENDING_NSSAI_CH" are permitted. | (NOTE 1) | +| servAreaRes | ServiceAreaRestriction | O | 0..1 | Service Area Restriction as part of the AMF Access and Mobility Policy as determined by the PCF | | +| wlServAreaRes | WirelineServiceAreaRestriction | O | 0..1 | Wireline Service Area Restriction as part of the AMF Access and Mobility Policy as determined by the PCF | WirelineWirelessConvergence | +| rfsp | RfspIndex | O | 0..1 | RFSP Index as part of the AMF Access and Mobility Policy as determined by the PCF. | | +| rfspValTime | DurationSec | O | 0..1 | Validity time of the RFSP Index value provided within the "rfsp" attribute.
It may be provided when the RFSP Index value within the "rfsp" attribute indicates the EPC/E-UTRAN access is prioritized over 5GS access. It shall be omitted for other RFSP Index values. | RFSPValidityTime | +| targetRfsp | RfspIndex | C | 0..1 | RFSP Index associated with the Target NSSAI. It shall be present if the Target NSSAI was received in the request and the trigger "TARGET_NSSAI" is provided. | TargetNSSAI | +| pras | map(PresenceInfo) | C | 1..N | If the Trigger "PRA_CH" is provided, the presence reporting area(s) for which reporting is requested shall be provided. The "prald" attribute within the PresenceInfo data type shall also be the key of the map. The "presenceState" and the "additionalPrald" attributes within the PresenceInfo data type shall not be supplied. The "prald" attribute within the PresenceInfo data type shall include the identifier of either a presence reporting area or a presence reporting area set. | | +| smfSelInfo | SmfSelectionData | O | 0..1 | If the trigger "SMF_SELECT_CH" is provided, the conditions for SMF selection information replacement, as determined by the PCF shall be provided. | DNNReplacementControl | +| ueAmbr | Ambr | O | 0..1 | UE-AMBR as part of the AMF Access and Mobility Policy as determined by the PCF. | UE-AMBR_Authorization | + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| ueSliceMbrs | array(UeSliceMbr) | O | 1..N | One or more UE-Slice-MBR(s) for S-NSSAI(s) of serving PLMN as part of the AMF Access and Mobility Policy as determined by the PCF. | UE-Slice-MBR_Authorization | +| pcfUeInfo | PcfUeCallbackInfo | O | 0..1 | Contains the PCF for the UE information necessary for the PCF for the PDU session to send established/terminated events notifications to the PCF for the UE. | AMInfluence | +| matchPduS | array(PduSessionInfo) | C | 1..N | Indicates the matched PDU session(s) for which the PCF for the UE information in the "pcfUeInfo" attribute shall be forwarded to the SMF. It shall be present when the "pcfUeInfo" attribute is present. (NOTE 2) | AMInfluence | +| asTimeDisParam | AsTimeDistributionParam | O | 0..1 | Contains the 5G access stratum time distribution parameters. | 5GAccessStratumTime | +| sliceUsgCtrlInfoSets | map(SliceUsgCtrlInfo) | O | 1..N | Represents the network slice usage control information.

The key of the map is the on-demand S-NSSAI (within the "snssai" attribute of the corresponding map value) to which the network slice usage control information is related. | NetSliceUsageCtrl | +| suppFeat | SupportedFeatures | M | 1 | Indicates the negotiated supported features. | | +| NOTE 1: The "ALLOWED_NSSAI_CH", "TARGET_NSSAI", "SMF_SELECT_CH", "ACCESS_TYPE_CH", "SLICE_REPLACE_MGMT", "PARTIALLY_ALLOWED_NSSAI_CH", "SNSSAIS_PARTIALLY_REJECTED_CH", "REJECTED_SNSSAIS_CH" and "PENDING_NSSAI_CH" values in the "triggers" attribute apply under feature control as described in clause 4.2.3.2. | | | | | | +| NOTE 2: The DNN encoded within the PduSessionInfo element(s) of the "matchPduS" array contains a full DNN or only the DNN Network Identifier based on the DNN provided by the AF to the PCF in the AmInfluence API, as specified in 3GPP TS 29.522 [32]. When the DNN contains the Network Identifier only, the AMF shall match a PDU session for the received Network Identifier and for any value of the Operator Identifier. | | | | | | + +#### 5.6.2.3 Type PolicyAssociationRequest + +Table 5.6.2.3-1: Definition of type PolicyAssociationRequest + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|---------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| notificationUri | Uri | M | 1 | Identifies the recipient of Notifications sent by the PCF. | | +| altNotifIpv4Addrs | array(Ipv4Addr) | O | 1..N | Alternate or backup IPv4 Address(es) where to send Notifications. | | +| altNotifIpv6Addrs | array(Ipv6Addr) | O | 1..N | Alternate or backup IPv6 Address(es) where to send Notifications. | | +| altNotifFqdns | array(Fqdn) | O | 1..N | Alternate or backup FQDN(s) where to send Notifications. | | +| supi | Supi | M | 1 | Subscription Permanent Identifier. | | +| gpsi | Gpsi | C | 0..1 | Generic Public Subscription Identifier. Shall be provided when available. | | +| accessType | AccessType | C | 0..1 | The Access Type where the served UE is camping. Shall be provided when available. | | +| accessTypes | array(AccessType) | C | 1..N | The Access Types where the served UE is camping. Shall be provided when available. | MultipleAccess Types | +| pei | Pei | C | 0..1 | The Permanent Equipment Identifier of the served UE. Shall be provided when available. | | +| userLoc | UserLocation | C | 0..1 | The location of the served UE. Shall be provided when available. | | +| timeZone | TimeZone | C | 0..1 | The time zone where the served UE is camping. Shall be provided when available. | | +| servingPlmn | PlmnIdNid | C | 0..1 | The serving network (a PLMN or an SNPN) where the served UE is camping. For the SNPN the NID together with the PLMN ID identifies the SNPN. Shall be provided when available. | | +| ratType | RatType | C | 0..1 | The 3GPP RAT Type where the served UE is camping. Shall be provided when available. | | +| ratTypes | array(RatType) | C | 1..N | The 3GPP and non-3GPP RAT Types where the served UE is camping. Shall be provided when available. | MultipleAccess Types | +| groupIds | array(GroupId) | C | 1..N | List of Internal Group Identifiers of the served UE. Shall be provided when available. | | +| servAreaRes | ServiceAreaRestriction | C | 0..1 | Service Area Restriction as part of the AMF Access and Mobility Policy. Shall be provided when available. | | +| wlServAreaRes | WirelineServiceArea Restriction | O | 0..1 | Wireline Service Area Restriction as part of the AMF Access and Mobility Policy. | WirelineWireless Convergence | +| rfsp | RfspIndex | C | 0..1 | RFSP Index as part of the AMF Access and Mobility Policy. Shall be provided when available. | | +| ueAmbr | Ambr | C | 0..1 | UE-AMBR as part of the AMF Access and Mobility Policy. Shall be provided when available. | UE-AMBR_Authori zation | +| ueSliceMbrs | array(UeSliceMbr) | C | 1..N | The subscribed UE-Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping to a S-NSSAI of the serving PLMN. Shall be provided when available. (NOTE) | UE-Slice-MBR_Authoriz ation | + +| | | | | | | +|---------------------|------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| +| allowedSnssais | array(Snssai) | C | 1..N | Represents the Allowed NSSAI in the 3GPP access and includes the S-NSSAIs values the UE can use in the serving PLMN. It shall be included if the feature "SliceSupport" or the feature "DNNReplacementControl" is supported in the AMF. | SliceSupport, DNNReplacementControl, NetSliceRepl | +| partAllowedNssai | map(PartiallyAllowed Snssai) | O | 1..N | Represents the Partially Allowed NSSAI.

The "snssai" attribute within the PartiallyAllowedSnssai data type shall be the key of the map. | PartNetSliceSupport, NetSliceRepl | +| snssaisPartRejected | map(SnssaiPartRejected) | O | 1..N | Represents the set of S-NSSAI(s) partially rejected in the RA.

The "snssai" attribute within the SnssaiPartRejected data type shall be the key of the map. | PartNetSliceSupport | +| rejectedSnssais | array(Snssai) | O | 1..N | Represents the set of Rejected S-NSSAI(s) in the RA. | PartNetSliceSupport | +| pendingNssai | array(Snssai) | O | 1..N | Represents the Pending NSSAI. | PartNetSliceSupport | +| targetSnssais | array(Snssai) | C | 1..N | Represents the Target NSSAI. It shall be included if available and the feature "TargetNSSAI" is supported. | TargetNSSAI | +| mappingSnssais | array(MappingOfSnssai) | C | 1..N | If the "DNNReplacementControl" feature and/or "NetSliceRepl" feature is/are supported, this attribute shall contain the mapping of each S-NSSAI of the Allowed NSSAI and, if the "PartNetSliceSupport" feature and/or "NetSliceRepl" feature is/are also supported, the mapping of each S-NSSAI of the Partially Allowed NSSAI to the corresponding S-NSSAI of the HPLMN. This attribute shall be included if available.

If the feature "MultipleAccessTypes" is supported, this attribute contains also the mapping of the Allowed NSSAI in the non-3GPP access to the corresponding S-NSSAI of the HPLMN. | DNNReplacementControl, PartNetSliceSupport, NetSliceRepl | +| n3gAllowedSnssais | array(Snssai) | C | 1..N | Represents the Allowed NSSAI in the non-3GPP access and includes the S-NSSAIs values the UE can use in the serving PLMN. It shall be included if the feature "MultipleAccessTypes" and, the feature "SliceSupport" or "DNNReplacementControl" are supported in the AMF and the UE is registered in the non-3GPP access. | SliceSupport, MultipleAccessTypes, DNNReplacementControl | +| guami | Guami | C | 0..1 | The Globally Unique AMF Identifier (GUAMI) shall be provided by an AMF as service consumer. | | +| serviceName | ServiceName | O | 0..1 | If the NF service consumer is an AMF, it should provide the name of a service produced by the AMF that makes use of information received within the Npcf_AMPolicyControl_UpdateNotify service operation. | | +| suppFeat | SupportedFeatures | M | 1 | Indicates the features supported by | | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------|-------| +| | | | | the service consumer. | | +| traceReq | TraceData | C | 0..1 | Trace control and configuration parameters information defined in 3GPP TS 32.422 [18] shall be included if trace is required to be activated. | | +| nwdafDatas | array(NwdafData) | O | 1..N | List of NWDAF Instance IDs and their associated Analytics IDs consumed by the NF service consumer. | EneNA | +| NOTE: If the serving PLMN is not the HPLMN, then within the "ueSliceMbrs" attribute, there shall not be more than one array item with the same "servingSnssai" attribute's value in this release of the specification. | | | | | | + +#### 5.6.2.4 Type PolicyAssociationUpdateRequest + +Table 5.6.2.4-1: Definition of type PolicyAssociationUpdateRequest + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------| +| notificationUri | Uri | O | 0..1 | Identifies the recipient of Notifications sent by the PCF. | | +| altNotifIpv4Addrs | array(Ipv4Addr) | O | 1..N | Alternate or backup IPv4 Address(es) where to send Notifications. | | +| altNotifIpv6Addrs | array(Ipv6Addr) | O | 1..N | Alternate or backup IPv6 Address(es) where to send Notifications. | | +| altNotifFqdns | array(Fqdn) | O | 1..N | Alternate or backup FQDN(s) where to send Notifications. | | +| triggers | array(RequestTrigger) | C | 1..N | Request Triggers that the NF service consumer observes. Shall be provided when a policy control request trigger occurs. | | +| servAreaRes | ServiceAreaRestriction | C | 0..1 | Service Area Restriction as part of the AMF Access and Mobility Policy. Shall be provided for trigger "SERV_AREA_CH". | | +| wlServAreaRes | WirelineServiceAreaRestriction | C | 0..1 | Wireline Service Area Restriction as part of the AMF Access and Mobility Policy. Shall be provided for trigger "SERV_AREA_CH". | WirelineWirelessConvergence | +| rfsp | RfspIndex | C | 0..1 | RFSP Index as part of the AMF Access and Mobility Policy. Shall be provided for trigger "RFSP_CH". | | +| smfSelInfo | SmfSelectionData | C | 0..1 | The UE requested S-NSSAI and UE requested DNN. Shall be provided for trigger "SMF_SELECT_CH". | DNNReplacementControl | +| ueAmbr | Ambr | C | 0..1 | UE-AMBR as part of the AMF Access and Mobility Policy. Shall be provided for trigger "UE_AMBR_CH". | UE-AMBR_Authorization | +| ueSliceMbrs | array(UeSliceMbr) | C | 1..N | The subscribed UE-Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping to a S-NSSAI of the serving PLMN. Shall be provided for the "UE_SLICE_MBR_CH" policy control request trigger. (NOTE) | UE-Slice-MBR_Authorization | +| praStatuses | map(PresenceInfo) | C | 1..N | If the Trigger "PRA_CH" is reported, the UE presence status for tracking area for which changes of the UE presence occurred shall be provided. The "prald" attribute within the PresenceInfo data type shall also be the key of the map. The "presenceState" attribute within the PresenceInfo data type shall be supplied. The "additionalPrald" attribute within the PresenceInfo data type shall not be supplied. The "prald" attribute within the PresenceInfo data type shall include the identifier of an individual presence reporting area. | | +| userLoc | UserLocation | C | 0..1 | The location of the served UE shall be provided for trigger "LOC_CH". | | +| allowedSnssais | array(Snssai) | C | 1..N | Represents the Allowed NSSAI in the 3GPP access and includes the S-NSSAIs values the UE can use in the serving PLMN. It shall be provided for trigger "ALLOWED_NSSAI_CH". | SliceSupport, DNNReplacementControl, NetSliceRepl | +| partAllowedNssai | map(PartiallyAllowedSnssai) | C | 1..N | Represents the updated Partially Allowed NSSAI. | PartNetSliceSupport, NetSliceRepl | + +| | | | | | | +|---------------------|---------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| +| | | | | It shall be provided for the trigger "PARTIALLY_ALLOWED_NSSAI_CH".
The "snssai" attribute within the PartiallyAllowedSnssai data type shall be the key of the map. | | +| snssaisPartRejected | map(SNSSAI part Rejected) | C | 1..N | Represents the updated set of S-NSSAI(s) partially rejected in the RA.
It shall be provided for the trigger "NSSAIS_PARTIALLY_REJECTED_CH".
The "snssai" attribute within the SnssaiPartRejected data type shall be the key of the map. | PartNetSliceSupport | +| rejectedSnssais | array(SNSSAI) | C | 1..N | Represents the updated set of Rejected S-NSSAI(s) in the RA.
It shall be provided for the trigger "REJECTED_NSSAIS_CH". | PartNetSliceSupport | +| pendingNSSAI | array(SNSSAI) | C | 1..N | Represents the updated Pending NSSAI.
It shall be provided for the trigger "PENDING_NSSAI_CH". | PartNetSliceSupport | +| targetSnssais | array(SNSSAI) | C | 1..N | Represents the Target NSSAI. It shall be provided for the trigger "TARGET_NSSAI". | TargetNSSAI | +| mappingSnssais | array(MappingOfSnssai) | O | 1..N | The mapping of each S-NSSAI of the Allowed NSSAI and/or the Partially Allowed NSSAI to the corresponding S-NSSAI of the HPLMN. It shall be provided for trigger "ALLOWED_NSSAI_CH" and/or "PARTIALLY_ALLOWED_NSSAI_CH" if available.
If the feature "MultipleAccessTypes" is supported, this attribute contains also the mapping of the Allowed NSSAI in the non-3GPP access to the corresponding S-NSSAI of the HPLMN. | DNNReplacementControl, PartNetSliceSupport, NetSliceRepl | +| n3gAllowedSnssais | array(SNSSAI) | C | 1..N | Represents the Allowed NSSAI in the non-3GPP access and includes the S-NSSAIs values the UE can use in the serving PLMN. It shall be provided for trigger "ALLOWED_NSSAI_CH" when the feature "MultipleAccessTypes" is supported. | SliceSupport, MultipleAccessTypes, DNNReplacementControl | +| unavailSnssais | array(SNSSAI) | C | 1..N | Represents the unavailable S-NSSAI(s) that require network slice replacement.
It shall be provided for trigger "SLICE_REPLACE_MGMT" when the "NetSliceRep" feature is supported. | NetSliceRepl | +| accessTypes | array(AccessType) | C | 1..N | The Access Types where the served UE is camping. Shall be provided for trigger "ACCESS_TYPE_CH". | MultipleAccessTypes | +| ratTypes | array(RatType) | C | 1..N | The 3GPP RAT Type and non-3GPP RAT Type where the served UE is camping. Shall be provided for trigger "ACCESS_TYPE_CH". | MultipleAccessTypes | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| traceReq | TraceData | C | 0..1 | Trace control and configuration parameters information defined in 3GPP TS 32.422 [18] shall be included if trace is required to be activated, modified or deactivated. For trace modification, it shall contain a complete replacement of trace data. For trace deactivation, it shall contain the Null value. | | +| guami | Guami | C | 0..1 | The Globally Unique AMF Identifier (GUAMI) shall be provided by an AMF as service consumer during the AMF relocation. | | +| nwdafDatas | array(NwdafData) | O | 1..N | List of NWDAF Instance IDs and their associated Analytics IDs consumed by the NF service consumer. | EneNA | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the features supported by the NF service consumer. It shall be included by the target AMF in inter-AMF mobility scenarios for trigger "FEAT_RENEG". | FeatureRenegotiation | +| NOTE: If the serving PLMN is not the HPLMN, then within the "ueSliceMbrs" attribute, there shall not be more than one array item with the same "servingSnssai" attribute's value in this release of the specification. | | | | | | + +#### 5.6.2.5 Type PolicyUpdate + +Table 5.6.2.5-1: Definition of type PolicyUpdate + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| resourceUri | Uri | M | 1 | The resource URI of the individual AM policy related to the notification. (NOTE 3) | | +| triggers | array(RequestTrigger) | O | 1..N | Request Triggers that the PCF subscribes. Only values "LOC_CH", "ALLOWED_NSSAI_CH", "TARGET_NSSAI", "SMF_SELECT_CH", "PRA_CH", "ACCESS_TYPE_CH", "SLICE_REPLACE_MGMT", "PARTIALLY_ALLOWED_NSSAI_CH", "SNSSAIS_PARTIALLY_REJECTED_CH", "REJECTED_SNSSAIS_CH" and "PENDING_NSSAI_CH" are permitted. | (NOTE 1)
(NOTE 2) | +| servAreaRes | ServiceAreaRestriction | O | 0..1 | Service Area Restriction as part of the AMF Access and Mobility Policy as determined by the PCF. | | +| wlServAreaRes | WirelineServiceAreaRestriction | O | 0..1 | Wireline Service Area Restriction as part of the AMF Access and Mobility Policy as determined by the PCF | WirelineWirelessConvergence | +| rfsp | RfspIndex | O | 0..1 | RFSP Index as part of the AMF Access and Mobility Policy as determined by the PCF. | | +| rfspValTime | DurationSec | O | 0..1 | Validity time of the RFSP Index value provided within the "rfsp" attribute. It may be provided when the RFSP Index value within the "rfsp" attribute indicates the EPC/E-UTRAN access is prioritized over 5GS access. It shall be omitted for other RFSP Index values. | RFSPValidityTime | +| targetRfsp | RfspIndex | C | 0..1 | RFSP Index associated with the Target NSSAI. It shall be present when the Target NSSAI was received in the request. | TargetNSSAI | +| smfSelInfo | SmfSelectionData | C | 0..1 | It may include updated conditions for SMF Selection information replacement. It shall include the PCF decision of the selected DNN when the "smfSelInfo" attribute containing the UE requested S-NSSAI and DNN was sent in the request. | DNNReplacementControl | +| ueAmbr | Ambr | C | 0..1 | UE-AMBR as part of the AMF Access and Mobility Policy. | UE-AMBR_Authorization | +| ueSliceMbrs | array(UeSliceMbr) | O | 0..1 | One or more UE-Slice-MBR(s) for S-NSSAI(s) of serving PLMN as part of the AMF Access and Mobility Policy as determined by the PCF. | UE-Slice-MBR_Authorization | +| pras | map(PresenceInfoRm) | C | 1..N | If the Trigger "PRA_CH" is provided or if that trigger was already set but the requested presence reporting areas need to be changed, the presence reporting area(s) for which reporting is requested shall be provided. The "prald" attribute within the PresenceInfo data type shall also be the key of the map. The "presenceState" attribute within the PresenceInfo data type shall not be | | + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| | | | | supplied. The "prald" attribute within the PresenceInfo data type shall include the identifier of either a presence reporting area or a presence reporting area set. | | +| pcfUeInfo | PcfUeCallbackInfo | O | 0..1 | Contains the PCF for the UE information necessary for the PCF for the PDU session to send established/terminated event notifications to the PCF for the UE. | AMInfluence | +| matchPdus | array(PduSessionInfo) | C | 1..N | Indicates the matched PDU session(s) for which the PCF for the UE information in the "pcfUeInfo" attribute shall be forwarded to the SMF.
It shall be present when the "pcfUeInfo" attribute is present and was not previously provisioned by the PCF for the UE.
(NOTE 4) | AMInfluence | +| asTimeDisParam | AsTimeDistributionParam | O | 0..1 | Contains the 5G access stratum time distribution parameters. | 5GAccessStratumTime | +| snssaiReplInfos | map(SnssaiReplaceInfo) | O | 1..N | Contains the network slice replacement related Information for one or more S-NSSAI(s) of the UE's Allowed NSSAI and/or Partially Allowed NSSAI.

The key used in this map for each entry is the concerned unavailable S-NSSAI provided within the "snssai" attribute of the corresponding SnssaiReplaceInfo map entry. | NetSliceRepl | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the negotiated supported features.
It shall be included in the HTTP POST response when the NF service consumer provided the supported features in the HTTP POST request. | FeatureRenegotiation | +| sliceUsgCtrlInfoSets | map(SliceUsgCtrlInfo) | O | 1..N | Represents the updated network slice usage control information.

The key of the map is the on-demand S-NSSAI (within the "snssai" attribute of the corresponding map value) to which the network slice usage control information is related. | NetSliceUsageCtrl | +| NOTE 1: The "ALLOWED_NSSAI_CH", "TARGET_NSSAI", "SMF_SELECT_CH", "ACCESS_TYPE_CH", "SLICE_REPLACE_MGMT", "PARTIALLY_ALLOWED_NSSAI_CH", "SNSSAIS_PARTIALLY_REJECTED_CH", "REJECTED_SNSSAIS_CH" and "PENDING_NSSAI_CH" values in the "triggers" attribute apply under feature control as described in clause 4.2.3.2. | | | | | | +| NOTE 2: The "SMF_SELECT_CH" trigger may be met only for new PDU sessions, i.e. it shall not apply to ongoing PDU sessions. | | | | | | +| NOTE 3: When the PolicyUpdate data type is used in a policy update notify service operation, either the complete resource URI included in the "resourceUri" attribute or the "apiSpecificResourceUriPart" component (see clause 5.1) of the resource URI included in the "resourceUri" attribute may be used by the NF service consumer (e.g. AMF) for the identification of the Individual AM Policy Association resource related to the notification. | | | | | | +| NOTE 4: The DNN encoded within the PduSessionInfo element(s) of the "matchPdus" array contains a full DNN or only the DNN Network Identifier based on the DNN provided by the AF to the PCF in the AmInfluence API, as specified in 3GPP TS 29.522 [32]. When the DNN contains the Network Identifier only, the AMF shall match a PDU session for the received Network Identifier and for any value of the Operator Identifier. | | | | | | + +#### 5.6.2.6 Type TerminationNotification + +**Table 5.6.2.6-1: Definition of type TerminationNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------|---|-------------|-------------------------------------------------------------------------------------|---------------| +| resourceUri | Uri | M | 1 | The resource URI of the individual AM policy related to the notification.
(NOTE) | | +| cause | PolicyAssociationReleaseCause | M | 1 | The cause why the PCF requests the termination of the policy association. | | + +NOTE: Either the complete resource URI included in the "resourceUri" attribute or the "apiSpecificResourceUriPart" component (see clause 5.1) of the resource URI included in the "resourceUri" attribute may be used by the NF service consumer (e.g. AMF) for the identification of the Individual AM Policy Association resource related to the notification. + +#### 5.6.2.7 Type SmfSelectionData + +**Table 5.6.2.7-1: Definition of type SmfSelectionData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| unsuppDnn | boolean | O | 0..1 | When it is set to "true", the NF service consumer shall request DNN replacement when the UE requested an unsupported DNN at PDU session establishment request. The default value is "false". | | +| candidates | map(CandidateForReplacement) | O | 1..N | Contains the list of DNNs per S-NSSAI that are candidate for replacement.
The "snssai" attribute within the CandidateForReplacement data type shall also be the key of the map.
(NOTE 2) | | +| snssai | Snssai | C | 0..1 | It shall be included in AM policy association update requests and represents the allowed S-NSSAI the UE includes in the PDU session establishment request. | | +| mappingSnssai | Snssai | O | 0..1 | It may be included in AM policy association update requests and represents the home mapping of the allowed S-NSSAI the UE includes in the PDU session establishment request. | | +| dnn | Dnn | C | 0..1 | It shall be included in AM policy association update requests and represents the UE requested DNN.
It shall be included in AM policy association update response and represents the PCF selected DNN.
The DNN shall contain the Network Identifier only.
(NOTE 3) | | + +NOTE 1: Either one of the "unsuppDnn" attribute and "candidates" attribute, or both attributes shall be present when the "smfSelInfo" attribute is included in the PolicyAssociation type or PolicyUpdate type when included in the Npcf\_AMPolicyControl\_UpdateNotify request. + +NOTE 2: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[11], clause 5.4.4.2. + +NOTE 3: The AMF shall match a PDU session for the received Network Identifier and replace it by the received selected Network Identifier for any Operator Identifier value. + +#### 5.6.2.8 Type CandidateForReplacement + +Table 5.6.2.8-1: Definition of type CandidateForReplacement + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | The S-NSSAI in the serving PLMN. It shall contain a S-NSSAI within the Allowed NSSAI. | | +| dnns | array(Dnn) | O | 1..N | List of candidate DNNs for replacement for the S-NSSAI included in the "snssai" attribute. If omitted, any DNN for the provided S-NSSAI is candidate for replacement. The DNN shall contain the Network Identifier only.
(NOTE) | | + +NOTE: The AMF shall match the PDU session that contain a candidate DNN Network Identifier for any Operator Identifier value. + +#### 5.6.2.9 Type AmRequestedValueRep + +Table 5.6.2.9-1: Definition of type AmRequestedValueRep + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| +| userLoc | UserLocation | O | 0..1 | The location of the served UE is camping. | | +| praStatuses | map(PresenceInfo) | O | 1..N | The UE presence statuses for tracking areas.
The "prald" attribute within the PresenceInfo data type shall also be the key of the map. | | +| accessTypes | array(AccessType) | O | 1..N | The Access Types where the served UE is camping. | MultipleAccessTypes | +| ratTypes | array(RatType) | O | 1..N | The 3GPP RAT Type and non-3GPP RAT Type where the served UE is camping. | MultipleAccessTypes | +| allowedSnssais | array(SNSSAI) | O | 1..N | The Allowed NSSAI in the 3GPP access and includes the S-NSSAIs values the UE can use in the serving PLMN. | SliceSupport, DNNReplacementControl, NetSliceRepl | +| n3gAllowedSnssais | array(SNSSAI) | O | 1..N | The Allowed NSSAI in the non-3GPP access and includes the S-NSSAIs values the UE can use in the serving PLMN when the UE is registered in the non-3GPP access. | SliceSupport, MultipleAccessTypes, DNNReplacementControl | +| partAllowedNssai | map(PartiallyAllowedSnssai) | O | 1..N | Represents the updated Partially Allowed NSSAI.

The "snssai" attribute within the PartiallyAllowedSnssai data type shall be the key of the map. | PartNetSliceSupport, NetSliceRepl | +| snssaisPartRejected | map(SNSSAIPartRejected) | O | 1..N | Represents the updated set of S-NSSAI(s) partially rejected in the RA.

The "snssai" attribute within the SnssaiPartRejected data type shall be the key of the map. | PartNetSliceSupport | +| rejectedSnssais | array(SNSSAI) | O | 1..N | Represents the updated set of Rejected S-NSSAI(s) in the RA. | PartNetSliceSupport | +| pendingNssai | array(SNSSAI) | O | 1..N | Represents the updated Pending NSSAI. | PartNetSliceSupport | + +#### 5.6.2.10 Type: AsTimeDistributionParam + +Table 5.6.2.10-1: Definition of type AsTimeDistributionParam + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| asTimeDistInd | boolean | O | 0..1 | When this attribute is included and set to true, it indicates that the access stratum time distribution via Uu reference point is activated.
When present it shall be set as follows:
- true: activated.
- false (default): deactivated. | | +| uuErrorBudget | UIntegerRm | O | 0..1 | Indicates the time synchronization error budget in terms of time units of nanoseconds. | | +| clkQltDetLvl | ClockQualityDetailLevel | O | 0..1 | Indicates the clock quality detail level, its value, if provided, shall be set to "ACCEPTABLE" or "NON ACCEPTABLE" indication. | NetTimeSyncStatus | +| clkQltAcptCri | ClockQualityAcceptanceCriterion | O | 0..1 | Indicates the clock quality acceptable criteria for the UE. | NetTimeSyncStatus | + +#### 5.6.2.11 Type UeSliceMbr + +Table 5.6.2.11-1: Definition of type UeSliceMbr + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------|---------------| +| sliceMbr | SliceMbr | M | 1 | Contains the MBR for uplink and the MBR for downlink. | | +| servingSnssai | Snssai | M | 1 | Indicates the S-NSSAI of serving PLMN. | | +| mappedHomeSnssai | Snssai | C | 0..1 | Indicates the mapped S-NSSAI of home PLMN. Shall only be provided in the request towards the PCF when serving PLMN is not the HPLMN. | | + +#### 5.6.2.12 Type SliceUsgCtrlInfo + +Table 5.6.2.12-1: Definition of type SliceUsgCtrlInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Contains the on-demand S-NSSAI to which the provided network slice usage control information is related. | | +| deregInactivTimer | DurationSecRm | O | 0..1 | Contains the slice deregistration inactivity timer value to be used to support and enforce network slice usage control for the on-demand S-NSSAI.
(NOTE) | | + +NOTE: When the "deregInactivTimer" is not present and it was previously provisioned by the PCF, this means that the network slice deregistration timer previously provisioned for the S-NSSAI identified by the "snssai" attribute shall no longer apply. + +#### 5.6.2.13 Type SnssaiPartRejected + +**Table 5.6.2.13-1: Definition of type SnssaiPartRejected** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------|---|-------------|---------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Contains the S-NSSAI that is rejected partially in the RA. | | +| allowedTaiList | array(Tai) | C | 1..N | Contains the list of TAI(s) of the RA within which the S-NSSAI is allowed.
(NOTE) | | +| rejectedTaiList | array(Tai) | C | 1..N | Contains the list of TAI(s) of the RA within which the S-NSSAI is rejected.
(NOTE) | | + +NOTE: These attributes are mutually exclusive. Either one of them shall be provided. + +### 5.6.3 Simple data types and enumerations + +#### 5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous sclauses. + +#### 5.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| n/a | | | | + +#### 5.6.3.3 Enumeration: RequestTrigger + +The enumeration RequestTrigger represents the possible Policy Control Request Triggers. It shall comply with the provisions defined in table 5.6.3.3-1. + +Table 5.6.3.3-1: Enumeration RequestTrigger + +| Enumeration value | Description | Applicability | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------| +| LOC_CH | Location change (tracking area): the tracking area of the UE has changed. (NOTE 1) | | +| PRA_CH | Change of UE presence in PRA: the NF service consumer reports the current presence status of the UE in a Presence Reporting Area, and notifies that the UE enters/leaves the Presence Reporting Area. | | +| SERV_AREA_CH (NOTE 2) | Service Area Restriction change: the UDM notifies the NF service consumer that the subscribed service area restriction information has changed. | | +| RFSP_CH (NOTE 2) | RFSP index change: the UDM notifies the NF service consumer that the subscribed RFSP index has changed. | | +| ALLOWED_NSSAI_CH | Allowed NSSAI change: the NF service consumer notifies that the set of UE allowed S-NSSAIs has changed. (NOTE 1) | SliceSupport, DNNReplacement Control, NetSliceRepl | +| UE_AMBR_CH (NOTE 2) | UE-AMBR change: the UDM notifies the NF service consumer that the subscribed UE-AMBR has changed. | UE-AMBR_Authorization | +| SMF_SELECT_CH | SMF selection information change: UE request for an unsupported DNN or UE request for a DNN within the list of DNN candidates for replacement per S-NSSAI. | DNNReplacement Control | +| ACCESS_TYPE_CH | Access Type change: the NF service consumer notifies that the access type and the RAT type combinations available in the NF service consumer for a UE with simultaneous 3GPP and non-3GPP connectivity have changed. (NOTE 1) | MultipleAccessTypes | +| UE_SLICE_MBR_CH | UE-Slice-MBR change: the NF service consumer notifies any changes in the subscribed UE-Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping to a S-NSSAI of the serving PLMN. | UE-Slice-MBR_Authorization | +| NWDAF_DATA_CH (NOTE 2) | Indicates that the NWDAF instance IDs used for the UE and/or associated Analytics IDs have changed. | EneNA | +| TARGET_NSSAI | Generation of Target NSSAI: the NF service consumer notifies that the Target NSSAI was generated. | TargetNSSAI | +| SLICE_REPLACE_MGMT | Indicates that network slice replacement is needed for one or more S-NSSAI(s) of the UE's Allowed NSSAI and/or Partially Allowed NSSAI and the NF service consumer (i.e., AMF) cannot determine the Alternative S-NSSAI(s) for these S-NSSAI(s). | NetSliceRepl | +| FEAT_RENEG (NOTE 2) | The NF service consumer notifies that the target AMF is requesting feature re-negotiation. | FeatureRenegotiation | +| PARTIALLY_ALLOWED_NSSAI_CH | Partially Allowed NSSAI change: the NF service consumer notifies that the set of Partially Allowed S-NSSAI(s) of the UE has changed.

(NOTE 1) | PartNetSliceSupport, NetSliceRepl | +| SNSSAIS_PARTIALLY_REJECTED_CH | Change of the S-NSSAI(s) partially rejected in the RA: the NF service consumer notifies that the set of S-NSSAI(s) partially rejected in the RA for the UE has changed.

(NOTE 1) | PartNetSliceSupport | +| REJECTED_SNSSAIS_CH | Change of the Rejected S-NSSAI(s) in the RA: the NF service consumer notifies that the set of the Rejected S-NSSAI(s) in the RA for the UE has changed.

(NOTE 1) | PartNetSliceSupport | +| PENDING_NSSAI_CH | Pending NSSAI change: the NF service consumer notifies that the set of Pending S-NSSAI(s) of the UE has changed.

(NOTE 1) | PartNetSliceSupport | + +NOTE 1: This includes reporting the current value at the time the trigger is provisioned during the update or update notification of the policy association. + +NOTE 2: The NF service consumer always reports to the PCF. + +#### 5.6.3.4 Enumeration: PolicyAssociationReleaseCause + +The enumeration PolicyAssociationReleaseCause represents the cause why the PCF requests the termination of the policy association. It shall comply with the provisions defined in table 5.6.3.4-1. + +**Table 5.6.3.4-1: Enumeration PolicyAssociationReleaseCause** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------| +| UNSPECIFIED | This value is used for unspecified reasons. | | +| UE_SUBSCRIPTION | This value is used to indicate that the session needs to be terminated because the subscription of UE has changed (e.g. was removed). | | +| INSUFFICIENT_RES | This value is used to indicate that the server is overloaded and needs to abort the session. | | + +## 5.7 Error handling + +### 5.7.1 General + +For the Npcf\_AMPolicyControl API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] 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 [5]. + +In addition, the requirements in the following clauses are applicable for the Npcf\_AMPolicyControl API. + +### 5.7.2 Protocol Errors + +No specific protocol errors for the Npcf\_AMPolicyControl API service are specified. + +### 5.7.3 Application Errors + +The application errors defined for the Npcf\_AMPolicyControl service are listed in Table 5.7.3-1 and Table 5.7.3-2. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USER_UNKNOWN | 400 Bad Request | The HTTP request is rejected because the end user specified in the request is unknown to the PCF. | +| ERROR_REQUEST_PARAMETERS | 400 Bad Request | The HTTP request is rejected because the set of information needed by the PCF for AM Policy selection is incomplete or erroneous or not available for the decision to be made. | +| PENDING_TRANSACTION | 400 Bad Request | This error shall be used when the PendingTransaction feature is supported and the PCF receives an incoming request on a policy association while it has an ongoing transaction on the same policy association and cannot handle the request as described in clause 9.2 of 3GPP TS 29.513 [7]. | +| POLICY_ASSOCIATION_NOT_FOUND | 404 Not Found | The HTTP request is rejected because no policy association corresponding to the request exists in the PCF. | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +**Table 5.7.3-2: Application errors when NF service consumer acts as a server to receive a notification** + +| Application Error | HTTP status code | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PENDING_TRANSACTION | 400 Bad Request | This error shall be used when the PendingTransaction feature is supported and the NF service consumer receives an incoming request on a policy association while it has an ongoing transaction on the same policy association and cannot handle the request as described in clause 9.2 of 3GPP TS 29.513 [7]. (NOTE 1) | +| NOTE 1: This application error is included in the response to the Policy Update Notification HTTP POST request. | | | +| NOTE 2: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Npcf\_AMPolicyControl API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [5]. + +Table 5.8-1: Supported Features + +| Feature number | Feature Name | Description | +|----------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | SliceSupport | Indicates the support of AM policies differentiation based on the awareness of the allowed NSSAI. | +| 2 | PendingTransaction | This feature indicates support for the race condition handling as defined in 3GPP TS 29.513 [7]. | +| 3 | UE-AMBR_Authorization | Indicates the support of UE-AMBR control by the PCF in the serving network. | +| 4 | DNNReplacementControl | Indicates the support of DNN replacement control. | +| 5 | MultipleAccessTypes | Indicates the support of AM policies for the multiple access types where the served UE is camping. | +| 6 | WirelineWirelessConvergence | Indicates the support of Wireline and Wireless access convergence. | +| 7 | ImmediateReport | Indicates the support of the current applicable values report corresponding to the policy control request triggers for policy update notification. | +| 8 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [5] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. | +| 9 | UE-Slice-MBR_Authorization | Indicates the support of UE-Slice-MBR control by the PCF in the serving network. | +| 10 | AMInfluence | Indicates the support of the alternative mechanism to support informing the PCF for the UE of PDU session(s) established/terminated events via the delivery of the PCF for the UE information necessary for the PCF for the PDU session to send notifications on PDU session(s) established/terminated events through the AMF and the SMF. | +| 11 | EneNA | This feature indicates the support of NWDAF data reporting. | +| 12 | TargetNSSAI | Indicates the support for RFSP Index associated with the Target NSSAI. | +| 13 | 5GAccessStratumTime | This feature indicates the support of 5G access stratum time distribution parameters provisioning. | +| 14 | FeatureRenegotiation | This feature indicates the support of feature renegotiation during the update of a policy association triggered by UE mobility with AMF change. | +| 15 | NetSliceRepl | This feature indicates the support of the network slice replacement functionality as part of the enhancements of the network slicing functionality.

The following functionalities are supported:
- Support the network slice replacement information management. | +| 16 | RFSPValidityTime | This feature indicates the support of the provisioning of a validity time for the RFSP Index value that indicates the EPC/E-UTRAN access is prioritized over 5GS access. | +| 17 | NetTimeSyncStatus | This feature indicates the support of network timing synchronization status and reporting. This feature requires the support of the 5GAccessStratumTime feature as well. | +| 18 | NetSliceUsageCtrl | This feature indicates the support of the network slice usage control functionality as part of the enhancements of the network slicing functionality.

The following functionalities are supported:
- Support the provisioning by the PCF of the network slice usage control information (e.g., slice deregistration inactivity timer value).

This feature requires the support of the "SliceSupport" and/or "DNNReplacementControl" features. | +| 19 | PartNetSliceSupport | This feature indicates the partial network slice support in a Registration Area functionality as part of the enhancements of the network slicing functionality.

The following functionalities are supported: | + +| | | | +|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | - Support the reporting of the changes in the Partially Allowed NSSAI, S-NSSAI(s) partially rejected in the RA, Rejected S-NSSAI(s) in the RA and/or the Pending NSSAI to the PCF. | +|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [19] and 3GPP TS 29.500 [5], the access to the Npcf\_AMPolicyControl API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [20]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Npcf\_AMPolicyControl API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [13], 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 Npcf\_AMPolicyControl service. + +The Npcf\_AMPolicyControl API defines a single scope "npcf-am-policy-control" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +The present Annex contains an OpenAPI [10] specification of HTTP messages and content bodies used by the Npcf\_AMPolicyControl API. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [22] and clause 5.3.1 of the 3GPP TS 29.501 [6] for further information). + +## A.2 Npcf\_AMPolicyControl API + +``` +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.4 + title: Npcf_AMPolicyControl + description: | + Access and Mobility Policy Control Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.507 V18.3.0; 5G System; Access and Mobility Policy Control Service. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.507/' + +servers: + - url: '{apiRoot}/npcf-am-policy-control/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npcf-am-policy-control + +paths: + /policies: + post: + operationId: CreateIndividualAMPolicyAssociation + summary: Create individual AM policy association. + tags: + - AM Policy Associations (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyAssociationRequest' + responses: + '201': + description: Created + content: + application/json: + schema: +``` + +``` + $ref: '#/components/schemas/PolicyAssociation' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/npcf-am-policy-control/v1/policies/{polAssoId} + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + policyUpdateNotification: + '{ $request.body#/notificationUri }/update': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyUpdate' + responses: + '200': + description: > + OK. The current applicable values corresponding to the policy control request + trigger is reported + content: + application/json: + schema: + $ref: '#/components/schemas/AmRequestedValueRep' + '204': + description: No Content, Notification was successful. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +``` + +``` + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +policyAssociationTerminationRequestNotification: + '{ $request.body#/notificationUri }/terminate': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TerminationNotification' + responses: + '204': + description: No Content, Notification was successful. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/policies/{polAssocId}: + get: + operationId: ReadIndividualAMPolicyAssociation + summary: Read individual AM policy association. + tags: + - Individual AM Policy Association (Document) + parameters: + - name: polAssocId + in: path + description: Identifier of a policy association + required: true + schema: + type: string + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyAssociation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +``` + +``` + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + operationId: DeleteIndividualAMPolicyAssociation + summary: Delete individual AM policy association. + tags: + - Individual AM Policy Association (Document) + parameters: + - name: polAssoId + in: path + description: Identifier of a policy association + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/policies/{polAssoId}/update: + post: + operationId: ReportObservedEventTriggersForIndividualAMPolicyAssociation + summary: > + Report observed event triggers and obtain updated policies for an individual AM + policy association. + tags: + - Individual AM Policy Association (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyAssociationUpdateRequest' + parameters: + - name: polAssoId + in: path + description: Identifier of a policy association + required: true + schema: + type: string + responses: + '200': + description: OK. Updated policies are returned + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyUpdate' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': +$ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': +$ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': +$ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': +$ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': +$ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': +$ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': +$ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': +$ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': +$ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': +$ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': +$ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: +$ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcf-am-policy-control: Access to the Npcf_AMPolicyControl API + schemas: + PolicyAssociation: + description: Represents an individual AM Policy Association resource. + type: object + properties: + request: + $ref: '#/components/schemas/PolicyAssociationRequest' + triggers: + type: array + items: + $ref: '#/components/schemas/RequestTrigger' + minItems: 1 + description: Request Triggers that the PCF subscribes. + servAreaRes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' + wlServAreaRes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/WirelineServiceAreaRestriction' + rfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + rfspValTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + targetRfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + smfSelInfo: + $ref: '#/components/schemas/SmfSelectionData' + ueAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + ueSliceMbrs: + type: array + items: + $ref: '#/components/schemas/UeSliceMbr' + minItems: 1 + description: > + One or more UE-Slice-MBR(s) for S-NSSAI(s) of serving PLMN as part of the + AMF Access and Mobility Policy as determined by the PCF. + pras: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Contains the presence reporting area(s) for which reporting was requested. + The praId attribute within the PresenceInfo data type is the key of the map. +``` + +``` +pcfUeInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' +matchPdus: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionInfo' + nullable: true +asTimeDisParam: + $ref: '#/components/schemas/AsTimeDistributionParam' +sliceUsgCtrlInfoSets: + type: object + additionalProperties: + $ref: '#/components/schemas/SliceUsgCtrlInfo' + minProperties: 1 + description: > + Represents the network slice usage control information. + The key of the map is the on-demand S-NSSAI (within the "snssai" attribute of the + corresponding map value) to which the network slice usage control information is + related. +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +required: +- suppFeat + +PolicyAssociationRequest: + description: > + Information which the NF service consumer provides when requesting the creation of a policy + association. The serviveName property corresponds to the serviceName in the main body + of the specification. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + altNotifIpv4Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + description: Alternate or backup IPv4 Address(es) where to send Notifications. + altNotifIpv6Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + description: Alternate or backup IPv6 Address(es) where to send Notifications. + altNotifFqdns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + description: Alternate or backup FQDN(s) where to send Notifications. + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + accessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + userLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + servingPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + ratTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 + groupIds: +``` + +``` +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' +minItems: 1 +servAreaRes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' +wlServAreaRes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/WirelineServiceAreaRestriction' +rfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' +ueAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' +ueSliceMbrs: + type: array + items: + $ref: '#/components/schemas/UeSliceMbr' + minItems: 1 + description: > + The subscribed UE Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping to + a S-NSSAI of the serving PLMN Shall be provided when available. +allowedSnssais: + description: array of allowed S-NSSAIs for the 3GPP access. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 +partAllowedNSSAI: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartiallyAllowedSnssai' + minProperties: 1 + description: > + Represents the Partially Allowed NSSAI. The "snssai" attribute within the + PartiallyAllowedSnssai data type shall be the key of the map. +snssaisPartRejected: + type: object + additionalProperties: + $ref: '#/components/schemas/SNSSAI' + minProperties: 1 + description: > + Represents the set of S-NSSAI(s) partially rejected in the RA. + The "snssai" attribute within the SnssaiPartRejected data type shall be the key of the + map. +rejectedSnssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 +pendingNSSAI: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 +targetSnssais: + description: array of target S-NSSAIs. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 +mappingSnssais: + description: > + mapping of each S-NSSAI of the Allowed NSSAI to the corresponding S-NSSAI of the HPLMN. + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/MappingOfSnssai' + minItems: 1 +n3gAllowedSnssais: + description: array of allowed S-NSSAIs for the Non-3GPP access. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 +guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' +serviveName: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' +traceReq: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' +``` + +``` + nwdafData: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/NwdafData' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - notificationUri + - suppFeat + - supi + +PolicyAssociationUpdateRequest: + description: > + Represents information that the NF service consumer provides when requesting the update of + a policy association. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + altNotifIpv4Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + description: Alternate or backup IPv4 Address(es) where to send Notifications. + altNotifIpv6Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + description: Alternate or backup IPv6 Address(es) where to send Notifications. + altNotifFqdns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + description: Alternate or backup FQDN(s) where to send Notifications. + triggers: + type: array + items: + $ref: '#/components/schemas/RequestTrigger' + minItems: 1 + description: Request Triggers that the NF service consumer observes. + servAreaRes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' + wlServAreaRes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/WirelineServiceAreaRestriction' + rfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + smfSelInfo: + $ref: '#/components/schemas/SmfSelectionData' + ueAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + ueSliceMbrs: + type: array + items: + $ref: '#/components/schemas/UeSliceMbr' + minItems: 1 + description: > + The subscribed UE-Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping + to a S-NSSAI of the serving PLMN Shall be provided for the "UE_SLICE_MBR_CH" + policy control request trigger. + praStatuses: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Contains the UE presence status for tracking area for which changes of the UE presence + occurred. The praId attribute within the PresenceInfo data type is the key of the map. + userLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + allowedSnssais: + description: array of allowed S-NSSAIs for the 3GPP access. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +``` + +``` +minItems: 1 +partAllowedNssai: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartiallyAllowedSnssai' + minProperties: 1 + description: > + Represents the Partially Allowed NSSAI. The "snssai" attribute within the + PartiallyAllowedSnssai data type shall be the key of the map. +snssaisPartRejected: + type: object + additionalProperties: + $ref: '#/components/schemas/SNSSAI' + minProperties: 1 + description: > + Represents the set of S-NSSAI(s) partially rejected in the RA. + The "snssai" attribute within the SnssaiPartRejected data type shall be the key of the + map. +rejectedSnssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 +pendingNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 +targetSnssais: + description: array of target S-NSSAIs. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 +mappingSnssais: + description: > + mapping of each S-NSSAI of the Allowed NSSAI to the corresponding S-NSSAI of the HPLMN. + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/MappingOfSnssai' + minItems: 1 +accessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 +ratTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 +n3gAllowedSnssais: + description: array of allowed S-NSSAIs for the Non-3GPP access. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 +unavailSnssais: + description: > + Represents the unavailable S-NSSAI(s) from the UE's Allowed NSSAI and/or + Partially Allowed NSSAI that require network slice replacement. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 +traceReq: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' +guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' +nwdafDatas: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/NwdafData' + minItems: 1 + nullable: true +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` +PolicyUpdate: + description: > + Represents updated policies that the PCF provides in a notification or in a reply to an + Update Request. + type: object + properties: + resourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + triggers: + type: array + items: + $ref: '#/components/schemas/RequestTrigger' + minItems: 1 + nullable: true + description: Request Triggers that the PCF subscribes. + servAreaRes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' + wlServAreaRes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/WirelineServiceAreaRestriction' + rfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + rfspValTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + targetRfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + smfSelInfo: + $ref: '#/components/schemas/SmfSelectionData' + ueAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + ueSliceMbrs: + type: array + items: + $ref: '#/components/schemas/UeSliceMbr' + minItems: 1 + description: > + One or more UE-Slice-MBR(s) for S-NSSAI(s) of serving PLMN the allowed NSSAI as + part of the AMF Access and Mobility Policy as determined by the PCF. + pras: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfoRm' + description: > + Contains the presence reporting area(s) for which reporting was requested. The praId + attribute within the PresenceInfo data type is the key of the map. + minProperties: 1 + nullable: true + pcfUeInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' + matchPdns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionInfo' + nullable: true + asTimeDisParam: + $ref: '#/components/schemas/AsTimeDistributionParam' + snssaiReplInfos: + nullable: true + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAIReplaceInfo' + minProperties: 1 + description: > + Contains the network slice replacement information. + The key of the map is the concerned unavailable S-NSSAI (within the "snssai" attribute + of the corresponding map value) to which the network slice replacement information is + related. + sliceUsgCtrlInfoSets: + type: object + additionalProperties: + $ref: '#/components/schemas/SliceUsgCtrlInfo' + minProperties: 1 + description: > + Represents the updated network slice usage control information. + The key of the map is the on-demand S-NSSAI (within the "snssai" attribute of the + corresponding map value) to which the network slice usage control information is + related. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` +required: + - resourceUri + +TerminationNotification: + description: > + Represents a request to terminate a policy Association that the PCF provides in a + notification. + type: object + properties: + resourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + cause: + $ref: '#/components/schemas/PolicyAssociationReleaseCause' + required: + - resourceUri + - cause + +SmfSelectionData: + description: Represents the SMF Selection information that may be replaced by the PCF. + type: object + properties: + unsuppDnn: + type: boolean + candidates: + type: object + additionalProperties: + $ref: '#/components/schemas/CandidateForReplacement' + minProperties: 1 + description: > + Contains the list of DNNs per S-NSSAI that are candidates for replacement. The snssai + attribute within the CandidateForReplacement data type is the key of the map. + nullable: true + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + mappingSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + nullable: true + +CandidateForReplacement: + description: Represents a list of candidate DNNs for replacement for an S-NSSAI. + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + dnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + nullable: true + required: + - snssai + nullable: true + +AmRequestedValueRep: + description: > + Represents the current applicable values corresponding to the policy control request + triggers. + type: object + properties: + userLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + praStatuses: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Contains the UE presence statuses for tracking areas. The praId attribute within the + PresenceInfo data type is the key of the map. + accessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + ratTypes: + type: array +``` + +``` + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +allowedSnssais: + description: array of allowed S-NSSAIs for the 3GPP access. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +n3gAllowedSnssais: + description: array of allowed S-NSSAIs for the Non-3GPP access. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +partAllowedNssai: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartiallyAllowedSnssai' + minProperties: 1 + description: > + Represents the Partially Allowed NSSAI. The "snssai" attribute within the + PartiallyAllowedSnssai data type shall be the key of the map. +snssaisPartRejected: + type: object + additionalProperties: + $ref: '#/components/schemas/SnssaiPartRejected' + minProperties: 1 + description: > + Represents the set of S-NSSAI(s) partially rejected in the RA. + The "snssai" attribute within the SnssaiPartRejected data type shall be the key of the + map. +rejectedSnssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 +pendingNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + +AsTimeDistributionParam: + description: Contains the 5G access stratum time distribution parameters. + type: object + properties: + asTimeDistInd: + type: boolean + uuErrorBudget: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UIntegerRm' + clkQltDetLvl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityDetailLevel' + clkQltAcptCri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityAcceptanceCriterion' + nullable: true + +UeSliceMbr: + description: Contains a UE-Slice-MBR and the related information. + type: object + properties: + sliceMbr: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceMbr' + minProperties: 1 + description: Contains the MBR for uplink and the MBR for downlink. + servingSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + mappedHomeSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - sliceMbr + - servingSnssai + nullable: true + +SliceUsgCtrlInfo: + description: Represents network slice usage control information. + type: object + properties: + snssai: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + deregInactivTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + required: + - snssai + +SnssaiPartRejected: + description: Represents the list of the S-NSSAI(s) partially rejected in the RA. + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + allowedTaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + rejectedTaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + required: + - snssai + oneOf: + - required: [ allowedTaiList ] + - required: [ rejectedTaiList ] + +RequestTrigger: + anyOf: + - type: string + enum: + - LOC_CH + - PRA_CH + - SERV_AREA_CH + - RFSP_CH + - ALLOWED_NSSAI_CH + - UE_AMBR_CH + - UE_SLICE_MBR_CH + - SMF_SELECT_CH + - ACCESS_TYPE_CH + - NWDAF_DATA_CH + - TARGET_NSSAI + - SLICE_REPLACE_MGMT + - FEAT_RENEG + - PARTIALLY_ALLOWED_NSSAI_CH + - SNSSAIS_PARTIALLY_REJECTED_CH + - REJECTED_SNSSAIS_CH + - PENDING_NSSAI_CH + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Represents the possible request triggers. + Possible values are: + - LOC_CH: Location change (tracking area). The tracking area of the UE has changed. + - PRA_CH: Change of UE presence in PRA. The AMF reports the current presence status + of the UE in a Presence Reporting Area, and notifies that the UE enters/leaves the + Presence Reporting Area. + - SERV_AREA_CH: Service Area Restriction change. The UDM notifies the AMF that the + subscribed service area restriction information has changed. + - RFSP_CH: RFSP index change. The UDM notifies the AMF that the subscribed RFSP index has + changed. + - ALLOWED_NSSAI_CH: Allowed NSSAI change. The AMF notifies that the set of UE allowed + S-NSSAIs has changed. + - UE_AMBR_CH: UE-AMBR change. The UDM notifies the AMF that the subscribed UE-AMBR has + changed. + - SMF_SELECT_CH: SMF selection information change. The UE requested for an unsupported + DNN or UE requested for a DNN within the list of DNN candidates for replacement per + S-NSSAI. + - ACCESS_TYPE_CH: Access Type change. The AMF notifies that the access type and the RAT + type combinations available in the AMF for a UE with simultaneous 3GPP and non-3GPP + connectivity has changed. + - UE_SLICE_MBR_CH: UE-Slice-MBR change. The NF service consumer notifies any changes + in the subscribed UE-Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping + to a S-NSSAI of the serving PLMN. + +``` + +- NWDAF\_DATA\_CH: NDWAF DATA CHANGE. The AMF notifies that the NWDAF instance IDs used for the UE and/or associated Analytics IDs used for the UE and available in the AMF have changed. +- TARGET\_NSSAI: Generation of Target NSSAI. The NF service consumer notifies that the Target NSSAI was generated. +- SLICE\_REPLACE\_MGMT: Indicates that slice replacement is needed for one or more S-NSSAI(s) of the UE's Allowed NSSAI and/or Partially Allowed NSSAI and the AMF cannot determine the Alternative S-NSSAI(s) for these S-NSSAI(s). +- FEAT\_RENEG: The NF service consumer notifies that the target AMF is requesting feature re-negotiation. +- PARTIALLY\_ALLOWED\_NSSAI\_CH: Partially Allowed NSSAI change. The NF service consumer notifies that the set of Partially Allowed S-NSSAI(s) of the UE has changed. +- SNSSAIS\_PARTIALLY\_REJECTED\_CH: Change of the S-NSSAI(s) partially rejected in the RA. The NF service consumer notifies that the set of S-NSSAI(s) partially rejected in the RA for the UE has changed. +- REJECTED\_SNSSAIS\_CH: Change of the Rejected S-NSSAI(s) in the RA. The NF service consumer notifies that the set of the Rejected S-NSSAI(s) in the RA for the UE has changed. +- PENDING\_NSSAI\_CH: Pending NSSAI change. The NF service consumer notifies that the set of Pending S-NSSAI(s) of the UE has changed. + +###### PolicyAssociationReleaseCause: + +###### anyOf: + +- type: string + +###### enum: + +- UNSPECIFIED +- UE\_SUBSCRIPTION +- INSUFFICIENT\_RES + +- type: string + +###### description: > + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +###### description: | + +Represents the cause why the PCF requests the termination of the policy association. + +Possible values are: + +- UNSPECIFIED: This value is used for unspecified reasons. +- UE\_SUBSCRIPTION: This value is used to indicate that the session needs to be terminated because the subscription of UE has changed (e.g. was removed). +- INSUFFICIENT\_RES: This value is used to indicate that the server is overloaded and needs to abort the session. + +# --- Annex B (normative): Wireless and wireline convergence access support + +## B.1 Scope + +This annex defines procedures for wireless and wireline convergence access support for 5GS. The stage 2 definition and procedures are contained in 3GPP TS 23.316 [23]. The System Architecture for wireless and wireline convergence access is defined in 3GPP TS 23.501 [2]. + +## --- B.2 Npcf\_AMPolicyControl Service + +### B.2.1 Service Description + +#### B.2.1.1 Overview + +Clause 4.1.1 applies with the modification that the UE is replaced by the 5G-RG and the W-AGF, which is acting as a UE towards the 5GC on behalf of the FN-RG. + +#### B.2.1.2 Service Architecture + +Clause 4.1.2 applies with the exception that roaming functionality shall not apply in this Release of the specification for access and mobility policy control for 5G-RG connecting via W-5GAN and FN-RG. Roaming architecture is only applicable to a 5G-RG connecting to the 5GC via NG RAN. + +#### B.2.1.3 Network Functions + +##### B.2.1.3.1 Policy Control Function (PCF) + +The PCF functionality defined in clause 4.1.3.1 shall apply with the following modifications for wireline access: + +- The UE-AMBR control by the serving network does not apply. +- The Service Area Restrictions for a FN-BRG do not apply. +- The PCF provides access and mobility related policy control as described in this Annex. + +##### B.2.1.3.2 NF Service Consumers + +The NF service consumer functionality defined in clause 4.1.3.2 shall apply with the following exceptions: + +- The UE-AMBR control by the visited network is only applicable for a 5G-RG registered over 3GPP access. +- The NF service consumer enforces access and mobility related policy control as described in this Annex. + +## --- B.3 Service Operation + +### B.3.1 Introduction + +The descriptions in clause 4.2.1 are applied with the following differences: + +- UE is replaced by the 5G-RG. + +### B.3.2 Npcf\_AMPolicyControl\_Create Service Operation + +#### B.3.2.1 General + +The procedure defined in clause 4.2.2.1 is applied with following differences: + +- UE is replaced by the 5G-RG or FN-RG if applicable. +- Handling of RFSP information is not applicable if the 5G-RG or FN-RG connects the 5GC via wireline access. +- When the 5G-BRG or FN-BRG connects the 5GC via W-5BBAN, the "n3gaLocation" attribute shall be included in the "ueLoc" attribute and: + - Global Line ID including the line Id and either PLMN Id or operator Id shall be encoded within the "gli" attribute; and + - the "w5gbnLineType" attribute to indicate whether the W-5GBAN access is DSL or PON may be included. +- The HFC Node Identifier in the "hfcNodeId" attribute of the "n3gaLocation" attribute included in the "userLoc" attribute within the PolicyAssociationRequest data structure when the 5G-CRG or FN-CRG connects to the 5GC via W-5GCAN. + +- Only the policy control request triggers defined in clause B.3.4.2 are provided by the PCF when the 5G-RG or FN-RG connects the 5GC via wireline access. +- The PolicyAssociationRequest data structure shall include, if available, and if the feature "WirelineWirelessConvergence" is supported, wireline access Service Area Restrictions (see clause B.3.2.2.2) derived from the wireline access Service Area Restrictions obtained from the UDM by mapping any service areas denoted by geographical information into Line IDs (for a 5G-BRG) or HFC Node IDs (for a 5G-CRG and FN-CRG) encoded as "wlServAreaRes" attribute. +- The PolicyAssociation data type returned as body of the HTTP "201 Created" response shall include if the feature "WirelineWirelessConvergence" is supported, and if the PCF received the "wlServAreaRes" in the request, wireline Service Area Restrictions encoded as "wlServAreaRes" attribute. +- If the feature "MultipleAccessTypes" is supported, the NF service consumer (e.g. AMF) shall include: + - a) the RAT type entry corresponding to non-3GPP wireline access and/or the RAT type entry corresponding to the 3GPP access encoded in the "ratTypes" attribute, if available; and + - b) the "accessTypes" attribute indicating registration in the 3GPP access, or registration in the non-3GPP access, or registration in both 3GPP and non-3GPP access, if available. + +NOTE: When both, 3GPP access and non-3GPP accesses are available, the "accessType" attribute and the "ratType" attribute within the PolicyAssociationRequest type contain the access type and RAT type corresponding to the 3GPP access. + +- If the feature "SliceSupport" or the feature "DNNReplacementControl" is supported in the AMF, the UE is registered in the non-3GPP access, and the feature "MultipleAccessTypes" is supported, the NF service consumer (e.g. AMF) shall include the Allowed NSSAI in the non-3GPP access encoded in the "n3gAllowedSnssais" attribute. +- If the feature "DNNReplacementControl" is supported, the UE is registered in the non-3GPP access, and the feature "MultipleAccessTypes" is supported, the NF service consumer (e.g. AMF) may include the mapping of each S-NSSAI of the Allowed NSSAI in the non-3GPP access to the corresponding S-NSSAI of the HPLMN encoded in the "mappingSnssais" attribute. +- The PEI that may be included within the "pei" attribute shall have one of the following representations: + - a) If the 5G-BRG supports only wireline access, the PEI shall be the 5G-BRG MAC address. + - b) If the 5G-CRG supports only wireline access, the PEI shall be the cable modem MAC address. + - c) If the 5G-RG supports at least one 3GPP access technology, the PEI shall be the allocated IMEI or IMEISV. + - d) For the FN-BRG and FN-CRG, the PEI shall be the FN-RG MAC address. + +NOTE: When the PEI includes an indication that the MAC address cannot be used as Equipment identifier of the FN-RG, the PEI cannot be trusted for regulatory purposes and cannot be used for equipment based policy evaluation. + +#### B.3.2.2 AMF Access and Mobility Policy + +##### B.3.2.2.1 General + +The functionality defined in clause 4.2.2.3 shall apply with the following modifications: + +- UE-AMBR defined in clause 4.2.2.3.3 shall not apply for wireline access. +- RFSP Index defined in clause 4.2.2.3.2 shall not apply for wireline access. +- Service Area Restriction defined in clause 4.2.2.3.1 is only applicable for a 5G-RG connected via NG-RAN. The wireline access Service Area Restriction defined in clause B.3.2.2.2 shall apply for a FN-CRG and/or a 5G-RG (5G-BRG and 5G-CRG) connected via wireline access. + +##### B.3.2.2.2 Wireline Service Area Restriction + +If service area restrictions are enabled, and if the feature "WirelineWirelessConvergence" is supported, the Service Area Restriction information is encoded using the "WirelineServiceAreaRestriction" data type defined in 3GPP TS 29.571 [11] and consists of: + +- either a limited allowed area represented as both of: + - (i) a list of either Line IDs encoded as "globLineIds" (for a 5G-BRG) or HFC-Node IDs (for 5G-CRG and FN-CRG) encoded as "hfcNIDs" attribute within the "areas" attribute; and + - (ii) the "restrictionType" attribute set to "ALLOWED\_AREAS"; +- or a limited not allowed area represented as both of: + - (i) a list of either Line IDs encoded as "globLineIds" (for a 5G-BRG) or HFC-Node IDs (for 5G-CRG and FN-CRG) encoded as "hfcNIDs" attribute within the "areas" attribute; and + - (ii) the "restrictionType" attribute set to "NOT\_ALLOWED\_AREAS"; + +When the authorized wireline service area restrictions result in an unlimited set of allowed HFC-Node IDs or Line IDs, the PCF shall include: + +- an empty "wlServAreaRes" attribute; or +- the "restrictionType" attribute set to "NOT\_ALLOWED\_AREAS" and an empty "areas" attribute. + +When the authorized wireline service area restrictions result in an unlimited set of not-allowed HFC-Node IDs or Line IDs, the PCF shall include the "restrictionType" attribute set to "ALLOWED\_AREAS" and an empty "areas" attribute. + +##### B.3.2.2.3 Void + +### B.3.3 Npcf\_AMPolicyControl\_UpdateNotify Service Operation + +#### B.3.3.1 General + +The functionality defined in clause 4.2.4.2 and 4.2.4.3 shall apply. + +### B.3.4 Npcf\_AMPolicyControl\_Update Service Operation + +#### B.3.4.1 General + +The general procedure specified in clause 4.2.3.2 to modify an existing AM policy association shall apply with the exception that for a FN-RG or a 5G-RG registering via wireline access only, the existing AM policy association shall not be updated due to location change (tracking area), change of UE presence in PRA, or RFSP index change. + +If the feature "MultipleAccessTypes" is supported, the NF service consumer may include in the PolicyAssociationUpdateRequest data structure: + +- if the Access Type and/or the RAT type changed and the access type change Policy Control Request Trigger was previously provisioned (see clause B.3.4.2), the list of Access Type and RAT Type combinations available encoded in the "accessTypes" attribute, "ratTypes" attribute. + +When the feature "MultipleAccessTypes" is supported the PCF may include in the PolicyUpdate data type the access type change Policy Control Request Trigger (see clause B.3.4.2) encoded within the "triggers" attribute. + +If the feature "SliceSupport" or the feature "DNNReplacementControl" is supported in the AMF, the UE is registered in the non-3GPP access, and the feature "MultipleAccessTypes" is supported, the NF service consumer (e.g. AMF) shall include the Allowed NSSAI in the non-3GPP access encoded in the "n3gAllowedSnssais" attribute together with the "ALLOWED\_NSSAI\_CH" policy control request trigger when a change of the Allowed NSSAI for the non-3GPP access occurred. + +If the feature "DNNReplacementControl" is supported, the UE is registered in the non-3GPP access, and the feature "MultipleAccessTypes" is supported, the Allowed NSSAI changed and/or the mapping of a S-NSSAI of the Allowed NSSAI to the corresponding S-NSSAI of the HPLMN changed, and the Policy Control Request Trigger "Change of allowed NSSAI" was provided then NF service consumer (e.g. AMF) may include the mapping of each S-NSSAI of the Allowed NSSAI in the non-3GPP access to the corresponding S-NSSAI of the HPLMN encoded in the "mappingSnssais" attribute. + +In addition, if the feature "WirelineWirelessConvergence" is supported: + +- the PolicyAssociationUpdateRequest data structure shall include if a wireline access Service Area restriction change occurred, the wireline access Service Area Restrictions (see clause B.3.2.2.2) derived from the ones obtained from the UDM encoded as "wlServAreaRes" attribute; +- the PolicyUpdate data returned in the response, if the PCF received the "wlServAreaRes" attribute in the request, wireline access Service Area Restrictions encoded as "wlServAreaRes" attribute. + +#### B.3.4.2 Policy Control Request Triggers + +For a 5G-RG registering via NG-RAN, the Policy Control Request Triggers defined in clause 4.2.3.2 shall apply. + +For a FN-RG or a 5G-RG registering via wireline access, only the following Policy Control Request Triggers defined in clause 4.2.3.2 shall apply: + +- "SERV\_AREA\_CH", i.e. Service Area Restriction change: the UDM notifies the NF service consumer that the subscribed service area restriction information has changed; +- "ALLOWED\_NSSAI\_CH", i.e. change of allowed NSSAI of the served UE; + +NOTE 1: The "ALLOWED\_NSSAI\_CH" trigger only applies if the feature "SliceSupport" or the feature "DNNReplacementControl" is supported. + +NOTE 2: The "SERV\_AREA\_CH" trigger is also used to notify that the subscribed wireline access service area restriction information has changed. + +- "ACCESS\_TYPE\_CH", i.e. the access type change: the NF service consumer notifies that the access type and the RAT type combinations available in the NF service consumer for a UE with simultaneous 3GPP and non-3GPP connectivity has changed; and + +NOTE 3: The "ACCESS\_TYPE\_CH" trigger only applies if the "MultipleAccessTypes" feature is supported. + +- "SMF\_SELECT\_CH", i.e. SMF selection information change. + +NOTE 4: The "SMF\_SELECT\_CH" trigger only applies if the "DNNReplacementControl" feature is supported. + +#### B.3.4.3 Encoding of updated policy + +Updated policies shall be encoded within the PolicyUpdate as specified in clause 4.2.3.3 with the modifications listed in clauses B.3.4.1, B.3.4.2, and this clause. + +- AMF Access and Mobility Policy (see clause B.3.2.2.2) Service Area Restriction for wireline access is encoded as "wlServAreaRes" attribute. + +### B.3.5 Npcf\_AMPolicyControl\_Delete Service Operation + +#### B.3.5.1 General + +The functionality defined in clause 4.2.5 shall apply. + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | | | | | | TS skeleton of Access and Mobility Policy Control Service specification | 0.0.0 | +| 2017-10 | CT3#92 | | | | | C3-175324, C3-175338 and C3-17525 | 0.1.0 | +| 2017-12 | CT3#93 | | | | | C3-176355, C3-176354, C3-176237, C3-176238 and C3-176239 | 0.2.0 | +| 2018-01 | CT3#94 | | | | | C3-180033, C3-180195 C3-182307, C3-182308, C3-182309, C3-182442, C3-182311, C3-182312, C3-182313 and C3-182314. | 0.3.0 | +| 2018-05 | CT3#97 | | | | | C3-183447, C3-183803, C3-183449, C3-183804, C3-183805, C3-183806, C3-183807, C3-183844, C3-183650 and C3-183650 | 0.5.0 | +| 2018-06 | CT#80 | CP-181025 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181025 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182023 | 0002 | 1 | B | Trace activation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0003 | 3 | F | AM Policy Association management during the AMF relocation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | 4 | F | Completion of Error Codes in OpenAPI file | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0005 | 1 | F | Stateless AMF support updates | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0006 | 7 | F | Removal of editor's note about additional parameters to further qualify event triggers | 15.1.0 | +| 2018-09 | CT#81 | CP-182029 | 0007 | 3 | F | Service Area Restrictions | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0008 | 3 | F | UE Policies | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0009 | 1 | F | V-PCF procedures | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0010 | | F | Alignment of resource URIs to resource URI structure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0011 | 1 | F | Including location information when a location change event is met | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0012 | 1 | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0014 | 1 | F | Update of notification | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0015 | | F | Update the consumer of Npcf_AMPolicyControl service | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0016 | 1 | F | Type of Rfsp attribute in PolicyAssociation data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0017 | 3 | F | Encoding to provide only updated parts of policies | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0018 | 1 | F | Termination Causes | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0019 | 1 | F | Update of resource figure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0020 | | F | Correction of cardinality of arrays | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0021 | 1 | F | Cleanup of UE policy | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0022 | 2 | F | AM Policy association handling during the AMF relocation | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0023 | 1 | F | Removal of unused abbreviations | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0024 | 1 | F | Correction of HTTP header field with URL of created resource | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0025 | | F | Type of servAreaRes attribute within Type PolicyAssociation | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0026 | | F | HTTP Error responses for Notifications | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0028 | 2 | F | Individual AM policy deletion at AMF relocation | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0029 | 1 | F | Correction of the update of Policy Control Request triggers | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0030 | | F | Default value for apiRoot | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0031 | | F | API version | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0032 | | F | ExternalDocs OpenAPI field | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0033 | | F | Location header field in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0034 | 1 | F | Security | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0035 | | F | supported content types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0036 | 2 | F | HTTP Error responses | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0037 | 1 | F | Correction to the PolicyAssociation data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0039 | | F | Re-use PresenceInfoRm data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0040 | | F | Correction to the PresenceInfo data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0041 | 1 | F | Alternate IP address in Npcf_AMPolicyControl_Update | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0042 | 2 | F | Corrections on authorized service area restrictions and RFSP index | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0043 | 2 | F | Corrections on encoding of Service Area Restrictions | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0044 | 1 | F | AM Policy Control support for Emergency Registration | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0045 | 1 | F | Multiple Internal Group identifiers | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0046 | 2 | F | Corrections on Protocol and Application errors | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0047 | 1 | F | Correction of Resource name | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0048 | 1 | F | Removal of pras attribute | 15.2.0 | +| 2018-12 | CT#82 | CP-183176 | 0049 | | F | Corrections of Cardinality in OpenAPI | 15.2.0 | +| 2019-03 | CT#83 | CP-190114 | 0050 | 2 | F | Correction on PCF-initiated AM Policy association termination | 15.3.0 | +| 2019-06 | CT#84 | CP-191187 | 0053 | 1 | F | Precedence of OpenAPI file | 15.4.0 | +| 2019-06 | CT#84 | CP-191187 | 0057 | 1 | F | Correction to Service Area Restriction and RFSP | 15.4.0 | +| 2019-06 | CT#84 | CP-191187 | 0059 | 1 | F | Copyright Note in YAML file | 15.4.0 | +| 2019-06 | CT#84 | CP-191089 | 0051 | 3 | F | Support of Allowed NSSAI | 16.0.0 | +| 2019-06 | CT#84 | CP-191089 | 0054 | 1 | F | Correction on Policy Association termination | 16.0.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------------------------|--------| +| 2019-06 | CT#84 | CP-191101 | 0055 | 2 | F | API version Update | 16.0.0 | +| 2019-06 | CT#84 | CP-191096 | 0056 | 1 | F | Adding tags to OpenAPI File | 16.0.0 | +| 2019-06 | CT#84 | CP-191089 | 0058 | 1 | F | Race Condition handling | 16.0.0 | +| 2019-09 | CT#85 | CP-192178 | 0061 | | B | Adding NID as input for policy decisions | 16.1.0 | +| 2019-09 | CT#85 | CP-192156 | 0062 | | B | Serving PLMN UE AMBR control | 16.1.0 | +| 2019-09 | CT#85 | CP-192140 | 0065 | 1 | A | Correcting the resource URI of AM Policy Associations | 16.1.0 | +| 2019-09 | CT#85 | CP-192176 | 0066 | 1 | B | Support of wireline and wireless access convergence, NFs | 16.1.0 | +| 2019-09 | CT#85 | CP-192152 | 0067 | 2 | B | Support of 5WWC, Policy Control Request Triggers | 16.1.0 | +| 2019-09 | CT#85 | CP-192152 | 0068 | | B | Annex of wireless and wireline convergence access support | 16.1.0 | +| 2019-09 | CT#85 | CP-192152 | 0070 | | B | Npcf_AMPolicyControl Create Service Operation of annex | 16.1.0 | +| 2019-09 | CT#85 | CP-192140 | 0074 | 2 | A | GUAMI included in the Update operation | 16.1.0 | +| 2019-09 | CT#85 | CP-192173 | 0076 | | F | OpenAPI version update for TS 29.507 Rel-16 | 16.1.0 | +| 2019-12 | CT#86 | CP-193197 | 0078 | 1 | F | Data type of the "serviceName" attribute | 16.2.0 | +| 2019-12 | CT#86 | CP-193182 | 0080 | | A | Correction to PolicyUpdate | 16.2.0 | +| 2019-12 | CT#86 | CP-193197 | 0081 | 2 | B | DNN replacement | 16.2.0 | +| 2019-12 | CT#86 | CP-193237 | 0084 | 2 | B | Line Identifier | 16.2.0 | +| 2019-12 | CT#86 | CP-193197 | 0086 | 1 | B | AM Policy association establishment rejection | 16.2.0 | +| 2019-12 | CT#86 | CP-193182 | 0088 | 1 | A | Correction to Service Area Restrictions description | 16.2.0 | +| 2019-12 | CT#86 | CP-193182 | 0090 | 1 | A | Correction on 307 error, 29.507 | 16.2.0 | +| 2019-12 | CT#86 | CP-193232 | 0091 | 1 | B | Support of simultaneous registration in multiple accesses | 16.2.0 | +| 2019-12 | CT#86 | CP-193232 | 0092 | 2 | B | Support of S-NSSAI for non-3GPP access | 16.2.0 | +| 2019-12 | CT#86 | CP-193191 | 0093 | 1 | B | Support of 5WWC, Service Area Restrictions | 16.2.0 | +| 2019-12 | CT#86 | CP-193191 | 0094 | 1 | B | Clarification of PEI format, 29.507 | 16.2.0 | +| 2019-12 | CT#86 | CP-193226 | 0095 | 2 | B | HFC node Id in Location information | 16.2.0 | +| 2019-12 | CT#86 | CP-193212 | 0096 | | F | Update of API version and TS version in OpenAPI file | 16.2.0 | +| 2020-03 | CT#87e | CP-200203 | 0097 | 1 | B | Policy Control Request Triggers for wireline access | 16.3.0 | +| 2020-03 | CT#87e | CP-200203 | 0098 | 1 | B | The data type of GlobalIneld | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0099 | | F | Corrections related to DNN replacement | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0100 | | F | Remove the possibility of SNSSAI change for DNN replacement | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0101 | | B | Mapping Of Allowed NSSAI | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0102 | | B | Completion of DNN replacement functionality | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0103 | 1 | B | Completing the description of triggers values applicability in PolicyAssociation and PolicyUpdate types. | 16.3.0 | +| 2020-03 | CT#87e | CP-200216 | 0105 | 1 | B | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-06 | CT#88e | CP-201215 | 0107 | 1 | A | Corrections on Service Area Restriction | 16.4.0 | +| 2020-06 | CT#88e | CP-201215 | 0109 | 1 | A | Location Header of 307 status code | 16.4.0 | +| 2020-06 | CT#88e | CP-201215 | 0111 | 1 | A | Notification URI | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0112 | 3 | B | Correction to the DNN replacement | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0113 | 1 | B | Enable removing the policy decision | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0114 | 1 | B | FQDN of alternative AMF | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0115 | | F | Removal of MAC address | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0116 | 3 | D | OpenAPI: Removal of values from description of "triggers" property | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0117 | 1 | F | Corrections on Annex B | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0118 | 1 | B | Untrusted FN-RG PEI | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0119 | 1 | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0121 | 1 | F | URI of the Npcf_AMPolicyControl service | 16.4.0 | +| 2020-06 | CT#88e | CP-201261 | 0122 | 1 | F | Removal of RG_TMBR trigger | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0123 | | F | Correction to wireline service area restriction | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0125 | | F | Optionality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0126 | 1 | F | Supported headers, Resource Data type, Operation Name | 16.4.0 | +| 2020-06 | CT#88e | CP-201255 | 0128 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2020-09 | CT#89e | CP-202059 | 0129 | 1 | F | correction to ACCESS_TYPE_CH trigger | 16.5.0 | +| 2020-09 | CT#89e | CP-202079 | 0130 | 1 | F | report initial presence status for PRA | 17.0.0 | +| 2020-09 | CT#89e | CP-202073 | 0131 | 1 | B | Successful Response | 17.0.0 | +| 2020-09 | CT#89e | CP-202073 | 0132 | | B | Error status code | 17.0.0 | +| 2020-09 | CT#89e | CP-202085 | 0134 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.0.0 | +| 2020-12 | CT#90e | CP-203074 | 0137 | 2 | A | Essential corrections and alignments | 17.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0139 | 1 | A | Storage of YAML files in 3GPP Forge | 17.1.0 | +| 2020-12 | CT#90e | CP-203143 | 0141 | 1 | A | Correction to PRA | 17.1.0 | +| 2020-12 | CT#90e | CP-203148 | 0142 | 1 | F | Report current value in Update for location and accessType related triggers | 17.1.0 | +| 2020-12 | CT#90e | CP-203148 | 0143 | 1 | B | Adding 200OK response for UpdateNotify | 17.1.0 | +| 2020-12 | CT#90e | CP-203147 | 0144 | | F | PolicyAssociationReleaseCause enumeration name | 17.1.0 | +| 2020-12 | CT#90e | CP-203148 | 0145 | | F | "400 Bad Request" response on notification | 17.1.0 | +| 2020-12 | CT#90e | CP-203153 | 0148 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-03 | CT#91e | CP-210191 | 0152 | 1 | A | Support of stateless NFs | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0153 | | F | Adding "description" field for map data types | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0154 | | F | OpenAPI reference | 17.2.0 | +| 2021-03 | CT#91e | CP-210226 | 0155 | | F | Encoding of Snssai as key of a map | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0156 | | F | Clarification on optional HTTP custom headers | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0158 | 1 | F | Clarification of update operation | 17.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------|--------| +| 2021-03 | CT#91e | CP-210221 | 0159 | 1 | F | Ambiguous concept of NF service consumer terminology | 17.2.0 | +| 2021-03 | CT#91e | CP-210221 | 0160 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.2.0 | +| 2021-03 | CT#91e | CP-210191 | 0162 | | A | Correction to resource identifiers descriptions used in notifications | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0163 | 1 | F | Correction to Service Area Restrictions | 17.2.0 | +| 2021-03 | CT#91e | CP-210240 | 0165 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-06 | CT#92e | CP-211257 | 0166 | 2 | B | Enabling Dynamic Changes of AM Policies in AMPolicyControl | 17.3.0 | +| 2021-06 | CT#92e | CP-211245 | 0168 | 1 | B | GLI report | 17.3.0 | +| 2021-06 | CT#92e | CP-211200 | 0170 | 1 | A | Temporary and Permanent Redirection | 17.3.0 | +| 2021-06 | CT#92e | CP-211104 | 0171 | 2 | B | Serving PLMN UE Slice-MBR control | 17.3.0 | +| 2021-06 | CT#92e | CP-211265 | 0173 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2021-09 | CT#93e | CP-212220 | 0174 | | F | Correction of URI structure | 17.4.0 | +| 2021-09 | CT#93e | CP-212225 | 0175 | 1 | B | Add retrieval of and subscription to AM Influence requests for DCAMP | 17.4.0 | +| 2021-09 | CT#93e | CP-212223 | 0177 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.4.0 | +| 2021-12 | CT#94e | CP-213194 | 0179 | 1 | B | Request of notification of PDU session established/terminated | 17.5.0 | +| 2021-12 | CT#94e | CP-213229 | 0180 | | F | Direct access to SNPN | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0181 | 3 | B | NWDAF instance provisioning to the PCF | 17.5.0 | +| 2021-12 | CT#94e | CP-213194 | 0182 | | F | Miscellaneous corrections | 17.5.0 | +| 2021-12 | CT#94e | CP-213243 | 0183 | | F | Correction to Update procedure | 17.5.0 | +| 2021-12 | CT#94e | CP-213230 | 0184 | 1 | F | Some updates to UE-Slice-MBR | 17.5.0 | +| 2021-12 | CT#94e | CP-213230 | 0185 | | F | Corrections to UE-Slice-MBR | 17.5.0 | +| 2021-12 | CT#94e | CP-213230 | 0186 | 1 | B | RFSP Index associated with the Target NSSAI | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0187 | | F | Correction of the applicability feature for data type Snssai | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0188 | | F | Correction on the condition for location change reporting | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0190 | 1 | A | Correction to PCF-provisioned triggers | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0191 | | B | DNN Replacement implications when URSP rules are provided | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0192 | 1 | F | Error handling when no AM Policy Association exists | 17.5.0 | +| 2021-12 | CT#94e | CP-213246 | 0193 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.5.0 | +| 2022-03 | CT#95e | CP-220197 | 0194 | 1 | B | Clarification of the dynamic AM policy decision | 17.6.0 | +| 2022-03 | CT#95e | CP-220183 | 0195 | 3 | B | 5G access stratum time distribution support | 17.6.0 | +| 2022-03 | CT#95e | CP-220176 | 0197 | 1 | A | Alignment of "Application Errors" clause with SBI TS template | 17.6.0 | +| 2022-03 | CT#95e | CP-220196 | 0198 | | F | Clarification to Policy Update Notification | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0199 | | F | Reporting available allowed NSSAI when ImmediateReport applies | 17.6.0 | +| 2022-03 | CT#95e | CP-220167 | 0204 | 1 | A | Handling of error responses | 17.6.0 | +| 2022-03 | CT#95e | CP-220197 | 0206 | 1 | F | Removal of Editor's Notes | 17.6.0 | +| 2022-03 | CT#95e | CP-220194 | 0207 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221155 | 0210 | 3 | F | Formatting of description fields | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0211 | | F | Using the common data type for FQDN | 17.7.0 | +| 2022-06 | CT#96 | CP-221144 | 0212 | | F | Determination of error budgets for a given UE | 17.7.0 | +| 2022-06 | CT#96 | CP-221145 | 0213 | 4 | F | Correction to access stratum time distribution | 17.7.0 | +| 2022-06 | CT#96 | CP-221139 | 0214 | 1 | F | remove EN related to Target NSSAI | 17.7.0 | +| 2022-06 | CT#96 | CP-221139 | 0215 | 2 | F | decouple UE-Slice-MBR from Allowed NSSAI | 17.7.0 | +| 2022-06 | CT#96 | CP-221139 | 0216 | | F | missing TARGET_NSSAI trigger from the triggers provisioned by PCF | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0217 | | F | Correction to NWDAF_DATA_CH trigger | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0219 | 1 | F | Mapping between RAT type and frequency and the RFSP Index | 17.7.0 | +| 2022-06 | CT#96 | CP-221144 | 0220 | 1 | F | Correction to AS Time Distribution | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0221 | | F | Removal of sibling element | 17.7.0 | +| 2022-06 | CT#96 | CP-221159 | 0223 | 1 | F | Correction to the notification of PCF for a PDU session | 17.7.0 | +| 2022-06 | CT#96 | CP-221151 | 0224 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-09 | CT#97e | CP-222123 | 0225 | 1 | F | Alignment with the SBI template | 17.8.0 | +| 2022-09 | CT#97e | CP-222107 | 0227 | 1 | F | Correction to UE-Slice-MBR handling for VPLMN S-NSSAI to HPLMN S-NSSAI mapping | 17.8.0 | +| 2022-12 | CT#98e | CP-223201 | 0229 | 2 | B | Feature awareness during UE mobility with AMF change | 18.0.0 | +| 2022-12 | CT#98e | CP-223191 | 0230 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0232 | 1 | F | Correction on the handling of RFSP Index authorized by PCF | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0233 | | F | Correction to DNN encoding | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0234 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230151 | 0236 | 1 | A | Correction of an openAPI error | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0237 | | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0239 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231252 | 0240 | 2 | B | Support of network slice replacement | 18.2.0 | +| 2023-06 | CT#100 | CP-231174 | 0241 | 1 | B | Support of Non-3GPP access for SNPN scenarios | 18.2.0 | +| 2023-06 | CT#100 | CP-231177 | 0242 | | B | PCF triggered UE mobility from 5GS to EPS | 18.2.0 | +| 2023-06 | CT#100 | CP-231325 | 0243 | 4 | B | Support for network timing synchronization status and reporting | 18.2.0 | +| 2023-06 | CT#100 | CP-231152 | 0246 | 1 | B | Updates to support the provisioning of the slice deregistration inactivity timer value | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 0247 | | F | Correcting description for wIServAreaRes attribute | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 0248 | | F | Missing presence condition for triggers attribute | 18.2.0 | +| 2023-06 | CT#100 | CP-231251 | 0251 | 2 | B | Support of provisioning of alternative S-NSSAI handling upon AMF request | 18.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------------------------------------------|--------| +| 2023-06 | CT#100 | CP-231152 | 0252 | 1 | B | Support of partially allowed S-NSSAI | 18.2.0 | +| 2023-06 | CT#100 | CP-231132 | 0253 | 1 | F | HTTP redirection clause correction | 18.2.0 | +| 2023-06 | CT#100 | CP-231173 | 0256 | 1 | B | Solving ENs on feature re-negotiation | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0257 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232093 | 0258 | 1 | B | Completing the support of slice deregistration inactivity timer provisioning by the PCF | 18.3.0 | +| 2023-09 | CT#101 | CP-232093 | 0259 | 1 | B | Defining the new PCRTs to support partial Network Slice support in a Registration Area | 18.3.0 | +| 2023-09 | CT#101 | CP-232269 | 0260 | 3 | B | Updates to the definition of the Network Slice Replacement functionality | 18.3.0 | +| 2023-09 | CT#101 | CP-232105 | 0261 | 1 | B | Data model for timing synchronization status and reporting | 18.3.0 | +| 2023-09 | CT#101 | CP-232098 | 0263 | 1 | F | Addition of the missing description fields for reused data types | 18.3.0 | +| 2023-09 | CT#101 | CP-232107 | 0265 | | A | Incorrect description of NWDAF data | 18.3.0 | +| 2023-09 | CT#101 | CP-232093 | 0266 | | F | Removal of EN related to SnssaiReplaceInfo | 18.3.0 | +| 2023-09 | CT#101 | CP-232099 | 0267 | 1 | B | Spending limits report for AM Policy | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0268 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233274 | 0269 | 1 | F | Correction on description of rfspValTime | 18.4.0 | +| 2023-12 | CT#102 | CP-233250 | 0270 | 1 | F | Resolving the remaining Editor's Note on the support of partial network slice support in a Registration Area functionality | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0271 | - | F | HTTP RFC uplifting | 18.4.0 | +| 2023-12 | CT#102 | CP-233250 | 0273 | 1 | F | Impact of PartNetSliceSupport on mappingSnssais | 18.4.0 | +| 2023-12 | CT#102 | CP-233250 | 0274 | 1 | F | Removal of feature dependency | 18.4.0 | +| 2023-12 | CT#102 | CP-233256 | 0275 | 2 | D | Incorrect feature name | 18.4.0 | +| 2023-12 | CT#102 | CP-233248 | 0278 | - | F | Correction to the typo | 18.4.0 | +| 2023-12 | CT#102 | CP-233229 | 0281 | 1 | F | Update RFC 7807 obsoleted by RFC 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233250 | 0282 | 1 | B | Slice info obtained in the AMF at AM Policy Association establishment | 18.4.0 | +| 2023-12 | CT#102 | CP-233250 | 0283 | - | B | Missing applicable features in the re-used data type table | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29508/raw.md b/raw/rel-18/29_series/29508/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..249a0b2d3f9975e465dd48f1ea69e2545397fcc6 --- /dev/null +++ b/raw/rel-18/29_series/29508/raw.md @@ -0,0 +1,3133 @@ + + +# 3GPP TS 29.508 V18.4.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Session Management Event Exposure Service; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- Keywords --- + +## **3GPP** + +## --- Postal address --- + +## 3GPP support office address --- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## Internet --- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Session Management Event Exposure Service ..... | 8 | +| 4.1 Service Description ..... | 8 | +| 4.1.1 Overview ..... | 8 | +| 4.1.2 Service Architecture ..... | 9 | +| 4.1.3 Network Functions ..... | 10 | +| 4.1.3.1 Session Management Function (SMF) ..... | 10 | +| 4.1.3.2 NF Service Consumers ..... | 10 | +| 4.2 Service Operations ..... | 11 | +| 4.2.1 Introduction ..... | 11 | +| 4.2.2 Nsmf_EventExposure_Notify Service Operation ..... | 11 | +| 4.2.2.1 General..... | 11 | +| 4.2.2.2 Notification about subscribed events..... | 11 | +| 4.2.3 Nsmf_EventExposure_Subscribe Service Operation ..... | 17 | +| 4.2.3.1 General..... | 17 | +| 4.2.3.2 Creating a new subscription..... | 17 | +| 4.2.3.3 Modifying an existing subscription ..... | 20 | +| 4.2.4 Nsmf_EventExposure_UnSubscribe Service Operation ..... | 21 | +| 4.2.4.1 General..... | 21 | +| 4.2.4.2 Unsubscription from event notifications..... | 22 | +| 4.2.5 Nsmf_EventExposure_AppRelocationInfo Service Operation ..... | 22 | +| 4.2.5.1 General..... | 22 | +| 4.2.5.2 Acknowledgement of Notification about subscribed events ..... | 22 | +| 5 Nsmf_EventExposure API..... | 23 | +| 5.1 Introduction ..... | 23 | +| 5.2 Usage of HTTP..... | 24 | +| 5.2.1 General ..... | 24 | +| 5.2.2 HTTP standard headers ..... | 24 | +| 5.2.2.1 General..... | 24 | +| 5.2.2.2 Content type..... | 24 | +| 5.2.3 HTTP custom headers ..... | 24 | +| 5.3 Resources ..... | 24 | +| 5.3.1 Resource Structure..... | 24 | +| 5.3.2 Resource: SMF Notification Subscriptions ..... | 25 | +| 5.3.2.1 Description..... | 25 | +| 5.3.2.2 Resource definition ..... | 25 | +| 5.3.2.3 Resource Standard Methods ..... | 25 | +| 5.3.2.3.1 POST ..... | 25 | +| 5.3.2.4 Resource Custom Operations..... | 26 | +| 5.3.3 Resource: Individual SMF Notification Subscription ..... | 26 | +| 5.3.3.1 Description..... | 26 | +| 5.3.3.2 Resource definition..... | 26 | +| 5.3.3.3 Resource Standard Methods ..... | 27 | +| 5.3.3.3.1 GET ..... | 27 | +| 5.3.3.3.2 PUT ..... | 28 | +| 5.3.3.3.3 DELETE..... | 29 | +| 5.3.3.4 Resource Custom Operations..... | 30 | +| 5.4 Custom Operations without associated resources ..... | 30 | +| 5.5 Notifications..... | 31 | + +| | | | +|--------------------------------------------------------|--------------------------------------------|-----------| +| 5.5.1 | General ..... | 31 | +| 5.5.2 | Event Notification ..... | 31 | +| 5.5.2.1 | Description..... | 31 | +| 5.5.2.2 | Target URI ..... | 31 | +| 5.5.2.3 | Standard Methods ..... | 31 | +| 5.5.2.3.1 | POST ..... | 31 | +| 5.5.3 | Acknowledgement of event notification..... | 32 | +| 5.5.3.1 | Description..... | 32 | +| 5.5.3.2 | Target URI ..... | 33 | +| 5.5.3.3 | Standard Methods ..... | 33 | +| 5.5.3.3.1 | POST ..... | 33 | +| 5.6 | Data Model..... | 34 | +| 5.6.1 | General ..... | 34 | +| 5.6.2 | Structured data types ..... | 37 | +| 5.6.2.1 | Introduction..... | 37 | +| 5.6.2.2 | Type NsmfEventExposure ..... | 38 | +| 5.6.2.3 | Type NsmfEventExposureNotification..... | 41 | +| 5.6.2.4 | Type EventSubscription..... | 42 | +| 5.6.2.5 | Type EventNotification..... | 43 | +| 5.6.2.6 | void. .... | 48 | +| 5.6.2.7 | Type AckOfNotify ..... | 48 | +| 5.6.2.8 | Type SmNasFromUe ..... | 48 | +| 5.6.2.9 | Type SmNasFromSmf ..... | 48 | +| 5.6.2.10 | Type TransactionInfo..... | 49 | +| 5.6.2.11 | Type PduSessionInformation..... | 49 | +| 5.6.2.12 | Type PduSessionInfo ..... | 49 | +| 5.6.2.13 | Type UpfInformation..... | 49 | +| 5.6.2.14 | Type: TrafficCorrelationNotification ..... | 50 | +| 5.6.3 | Simple data types and enumerations ..... | 50 | +| 5.6.3.1 | Introduction..... | 50 | +| 5.6.3.2 | Simple data types ..... | 50 | +| 5.6.3.3 | Enumeration: SmfEvent..... | 51 | +| 5.6.3.4 | Enumeration: NotificationMethod ..... | 51 | +| 5.6.3.5 | void. .... | 52 | +| 5.6.3.6 | Enumeration: AppliedSmccType..... | 52 | +| 5.6.3.7 | Enumeration: TransactionMetric ..... | 52 | +| 5.6.3.8 | Enumeration: PduSessionStatus ..... | 52 | +| 5.7 | Error handling ..... | 52 | +| 5.7.1 | General ..... | 52 | +| 5.7.2 | Protocol Errors..... | 52 | +| 5.7.3 | Application Errors ..... | 52 | +| 5.8 | Feature negotiation..... | 53 | +| 5.9 | Security..... | 55 | +| Annex A (normative): OpenAPI specification..... | | 56 | +| A.1 | General..... | 56 | +| A.2 | Nsmf_EventExposure API..... | 56 | +| Annex B (informative): Change history ..... | | 70 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd 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. + +# 1 Scope + +The present specification provides the stage 3 definition of the Session Management Event Exposure Service (Nsmf\_EventExposure) of the 5G System. + +The stage 2 definition and procedures of the Session Management Event Exposure Service are contained in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [6]. The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +Stage 3 call flows for policy and charging control use cases are provided in 3GPP TS 29.513 [7]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition of the 5G System are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +The Session Management Event Exposure Service is provided by the Session Management Function (SMF). This service exposes events related to PDU Sessions observed at the SMF. + +# 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [7] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [8] IETF RFC 9113: "HTTP/2". +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [11] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [12] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [13] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [14] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [15] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [16] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". + +- [18] IETF RFC 9457: "Problem Details for HTTP APIs". +- [19] 3GPP TR 21.900: "Technical Specification Group working methods". +- [20] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [21] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [22] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [23] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane of EPC Nodes". +- [24] 3GPP TS 29.122: "T8 reference point for Northbound APIs". +- [25] 3GPP TS 29.591: "5G System; Network Exposure Function Southbound Services; Stage 3". +- [26] 3GPP TS 29.564: "5G System; User Plane Function Services; Stage 3". +- [27] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". + +# --- 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 | +| AMBR | Aggregate Maximum Bit Rate | +| AMF | Access and Mobility Management Function | +| API | Application Programming Interface | +| DCCF | Data Collection Coordination Function | +| DDD | Downlink Data Delivery | +| DNAI | DN Access Identifier | +| DNN | Data Network Name | +| EAS | Edge Application Server | +| FQDN | Fully Qualified Domain Name | +| GPSI | Generic Public Subscription Identifier | +| GUAMI | Globally Unique AMF Identifier | +| HTTP | Hypertext Transfer Protocol | +| H-SMF | Home SMF | +| I-SMF | Intermediate SMF | +| JSON | JavaScript Object Notation | +| NEF | Network Exposure Function | +| NF | Network Function | +| NID | Network Identifier | +| NRF | Network Repository Function | +| NSSAI | Network Slice Selection Assistance Information | +| NWDAF | Network Data Analytics Function | +| PCF | Policy Control Function | +| PRA | Presence Reporting Area | +| QFI | QoS Flow Identifier | + +| | | +|---------|-------------------------------------------------------| +| SMCC | Session Management Congestion Control | +| SMCCE | Session Management Congestion Control Experience | +| SMF | Session Management Function | +| SNPN | Stand-alone Non-Public Network | +| SUPI | Subscription Permanent Identifier | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SSC | Session and Service Continuity | +| UDM | Unified Data Management | +| UPF | User Plane Function | +| V-SMF | Visited SMF | + +# --- 4 Session Management Event Exposure Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The Session Management Event Exposure Service, as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [6], is provided by the Session Management Function (SMF). + +This service: + +- allows NF service consumers to subscribe and unsubscribe for events on a PDU session; and +- notifies recipient of notification(s) subscribed by NF service consumers with a corresponding subscription about observed events on the PDU session. + +The types of observed events applicable for (H-)SMF include: + +- UP path change (e.g. addition and/or removal of PDU session anchor); +- access type change; +- RAT type change; +- PLMN change; +- PDU session release; +- PDU session establishment; +- Downlink data delivery status (for non-roaming); +- UE IP address/prefix change; +- QFI allocation; +- QoS monitoring; +- SM congestion control experience for PDU Session; +- Dispersion; +- Satellite backhaul category change; +- WLAN information for PDU Session; +- Redundant transmission experience for PDU Session; +- UPF events; and/or +- Traffic Correlation. + +The types of observed events applicable for V-SMF include: + +- Downlink data delivery status. + +The types of observed events applicable for I-SMF include: + +- Downlink data delivery status. + +### 4.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Policy and Charging related 5G architecture is also described in 3GPP TS 29.513 [7]. + +The Session Management Event Exposure Service (Nsmf\_EventExposure) is part of the Nsmf service-based interface exhibited by the Session Management Function (SMF). + +The known NF service consumers of the Nsmf\_EventExposure service are: + +- Network Exposure Function (NEF), +- Access and Mobility Management Function (AMF), +- Application Function (AF), +- Unified Data Management (UDM), +- Network Data Analytics Function (NWDAF), and +- Data Collection Coordination Function (DCCF). + +The PCF accesses the Session Management Event Exposure Service at the SMF via the N7 Reference point. + +NOTE: The PCF can implicitly subscribe on behalf of the AF or NEF to the UP\_PATH\_CH, TRAFFIC\_CORRELATION event and/or the QOS\_MON event by including the information on AF or NEF subscription within the PCC rule. + +The AMF accesses the Session Management Event Exposure Service at the SMF via the N11 Reference point. + +![Reference Architecture for the Nsmf_EventExposure Service; SBI representation diagram](5a24ac755b962fd5f0183f13de0726de_img.jpg) + +The diagram illustrates the service architecture for the Nsmf\_EventExposure service. At the top, a box labeled 'SMF' contains an oval labeled 'Nsmf'. A vertical line descends from the 'Nsmf' oval to a horizontal line labeled 'Nsmf\_EventExposure'. From this horizontal line, six vertical lines descend to a row of six boxes at the bottom, labeled from left to right: 'UDM', 'AMF', 'NEF', 'Application Function', 'NWDAF', and 'DCCF'. + +Reference Architecture for the Nsmf\_EventExposure Service; SBI representation diagram + +**Figure 4.1.2-1: Reference Architecture for the Nsmf\_EventExposure Service; SBI representation** + +![Figure 4.1.2-2: Reference Architecture for the Nsmf_EventExposure Service: reference point representation. The diagram shows a central SMF box at the top connected to six boxes below: AMF, NEF, AF, UDM, NWDAF, and DCCF. Lines connect SMF to each of these boxes. The line to AMF is labeled N11. The line to NEF is labeled N29. The lines to AF, UDM, NWDAF, and DCCF are collectively labeled N10.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +graph TD + SMF[SMF] -- N11 --> AMF[AMF] + SMF -- N29 --> NEF[NEF] + SMF -- N10 --> AF[AF] + SMF -- N10 --> UDM[UDM] + SMF -- N10 --> NWDAF[NWDAF] + SMF -- N10 --> DCCF[DCCF] + +``` + +Figure 4.1.2-2: Reference Architecture for the Nsmf\_EventExposure Service: reference point representation. The diagram shows a central SMF box at the top connected to six boxes below: AMF, NEF, AF, UDM, NWDAF, and DCCF. Lines connect SMF to each of these boxes. The line to AMF is labeled N11. The line to NEF is labeled N29. The lines to AF, UDM, NWDAF, and DCCF are collectively labeled N10. + +**Figure 4.1.2-2: Reference Architecture for the Nsmf\_EventExposure Service: reference point representation** + +### 4.1.3 Network Functions + +#### 4.1.3.1 Session Management Function (SMF) + +The Session Management function (SMF) provides: + +- Session Management e.g. Session establishment, modification and release; +- UE IP address allocation & management; +- Selection and control of UP function; +- Termination of interfaces towards Policy control functions; and +- Control part of policy enforcement and QoS. + +#### 4.1.3.2 NF Service Consumers + +The Network Exposure Function (NEF); + +- provides means to securely expose the services and capabilities provided by 3GPP network functions to e.g. 3rd parties or internal exposure consumer NF. + +The Access and Mobility Management function (AMF) provides: + +- Registration management; +- Connection management; +- Reachability management; and +- Mobility Management. + +The Application Function (AF) + +- interacts with the 3GPP Core Network to provide services. + +The Unified Data Management (UDM). + +- has access to subscriber information, can determine the SMF serving a user based on that data, and can then subscribe to event notifications for a user (e.g. when triggered by the NEF). + +The Network Data Analytics Function (NWDAF) + +- collects data based on event subscription provided by AMF, SMF, UPF, PCF, UDM, AF (directly or via NEF) and OAM; +- retrieves information about NFs; + +- performs on demand provision of analytics to NF service consumers, as indicated in clause 6, 3GPP TS 23.288 [21]. + +The Data Collection Coordination Function (DCCF) + +- coordinates the collection and distribution of data and analytics. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +**Table 4.2.1-1: Operations of the Nsmf\_EventExposure Service** + +| Service operation name | Description | Initiated by | +|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------| +| Notify | Report UE PDU session related event(s) to recipient of notification(s) which the NF service consumer has subscribed to the event report service. | (H-)SMF, V-SMF, I-SMF | +| Subscribe | This service operation is used by an NF service consumer to subscribe for event notifications on a specified PDU session, or for all PDU Sessions of one UE, a group of UE(s) or any UE, or to modify a subscription. | NF service consumers (e.g. AMF, NEF, AF, UDM, NWDAF, DCCF) | +| UnSubscribe | This service operation is used by an NF service consumer to unsubscribe from event notifications. | NF service consumers (e.g. AMF, NEF, AF, UDM, NWDAF, DCCF) | +| AppRelocationInfo | This service operation is used by an NF service consumer to acknowledge the notification from the SMF regarding UE PDU Session related event(s) | NF service consumers (e.g. NEF, AF) | + +NOTE: The Nsmf\_TrafficCorrelation\_Notify Service Operation defined in clause 5.2.8.5.2 of 3GPP TS 23.502 [3] is implemented as the "TRAFFIC\_CORRELATION" event in the Nsmf\_EventExposure\_Notify Service Operation with "CommonEASDNAI" feature support. + +### 4.2.2 Nsmf\_EventExposure\_Notify Service Operation + +#### 4.2.2.1 General + +The Nsmf\_EventExposure\_Notify service operation enables the SMF (i.e. (H-)SMF, V-SMF and/or I-SMF) to send notifications to recipient of notification(s) subscribed by NF service consumers upon the occurrence of a previously subscribed event on the related PDU session. + +The following procedure using the Nsmf\_EventExposure\_Notify service operation is supported: + +- notification about subscribed events. + +#### 4.2.2.2 Notification about subscribed events + +The present "notification about subscribed events" procedure is performed by the SMF when any of the subscribed events occur. + +The following applies with respect to the detection of subscribed events: + +- If: + - the SMF supports the "DownlinkDataDeliveryStatus" feature, + - the event "DDDS" is subscribed, + - the traffic descriptors of the downlink data source have been provided for that subscription, and + +- the SMF is informed that the UE corresponding to that subscription is unreachable, +- if the data is buffered at the UPF, then the SMF shall interact with the UPF to notify that the UPF buffers the downlink packets. The SMF shall include the traffic descriptor of the subscriptions in the PDR with a higher priority if the PCC is not applied to the PDU session or derive the PDR from the PCC rule received from the PCF as defined in clause 4.2.4.27 of 3GPP TS 29.512 [14] if the PCC is applied to the PDU session and request the UPF to report when there are corresponding buffered downlink packets or discarded packets in the UPF as defined in clause 5.28.1 of 3GPP TS 29.244 [23]. When receiving the report from the UPF, the SMF shall determine whether that subscribed event with delivery status "DISCARDED" or "BUFFERED" occurred. The SMF shall determine that subscribed event with delivery status "TRANSMITTED" occurred by the fact that the related PDU session becomes ACTIVE. +- if the data is buffered at the SMF, the SMF shall determine whether that subscribed event occurred by comparing the downlink packets with the traffic descriptors received in the corresponding event subscription. If the SMF decides to buffer the packets, the subscribed event with delivery status "BUFFERED" occurred. If the SMF decides to discard the packets, the subscribed event with delivery status "DISCARDED" occurred. The SMF shall determine that subscribed event with delivery status "TRANSMITTED" occurred by the fact that the related PDU session becomes ACTIVE. + +Figure 4.2.2.2-1 illustrates the notification about subscribed events. + +![Sequence diagram showing the notification about subscribed events between SMF and NF service consumer.](7f17c430b9598e4d748a8041457810b3_img.jpg) + +``` +sequenceDiagram + participant SMF + participant NF as NF service consumer + Note right of SMF: 1. POST {notifUri} + SMF->>NF: 1. POST {notifUri} + Note left of NF: 2. "204 No Content" + NF-->>SMF: 2. "204 No Content" +``` + +The diagram illustrates a sequence of two messages between the SMF and an NF service consumer. The SMF sends a POST request with the body {notifUri} to the NF service consumer. The NF service consumer responds with a "204 No Content" status. + +Sequence diagram showing the notification about subscribed events between SMF and NF service consumer. + +**Figure 4.2.2.2-1: Notification about subscribed events** + +If the SMF observes PDU Session related event(s) for which an NF service consumer has subscribed, the SMF shall send an HTTP POST request with "{notifUri}", as previously provided by the NF service consumer within the corresponding subscription, as URI and NsmfEventExposureNotification data structure as request body that shall include: + +- Notification correlation ID provided by the NF service consumer during the subscription, or as provided by the PCF for implicit subscription of UP path change and/or traffic correlation as defined in clause 4.2.6.2.6.2 of 3GPP TS 29.512 [14], or as provided by the PCF for implicit subscription of QoS Monitoring as defined in clause 4.2.3.25 of 3GPP TS 29.512 [14], as "notifId" attribute; and +- information about the observed event(s) within the "eventNotifs" attribute that shall contain for each observed event an "EventNotification" data structure that shall include: + 1. the Event Trigger as "event" attribute; + 2. for a UP path change notification: + - a) type of notification ("EARLY" or "LATE") as "dnaiChgType" attribute; + - b) source DNAI and/or target DNAI as "sourceDnai" attribute and "targetDnai" attribute if DNAI is changed, respectively (NOTE 3); and + - c) if the PDU Session type is IP, for the source DNAI IP address/prefix of the UE as "sourceUeIpv4Addr" attribute or "sourceUeIpv6Prefix" attribute; and + +- d) if the PDU Session type is IP, for the target DNAI IP address/prefix of the UE as "targetUeIpv4Addr" attribute or "targetUeIpv6Prefix" attribute; +- e) if available (NOTE 3), for the source DNAI, N6 traffic routing information related to the UE as "sourceTraRouting" attribute; +- f) if available (NOTE 3), for the target DNAI, N6 traffic routing information related to the UE as "targetTraRouting" attribute; +- g) if the PDU Session type is Ethernet, the MAC address of the UE in the "ueMac" attribute; +- h) if the "CommonEASDNAI" feature is supported, + - the candidate DNAI(s) for the PDU Session in "candidateDnais" attribute, optionally together with the indication of their prioritization within the "candDnaisPrioInd" attribute, if the "candDnailInd" attribute was set to "true" in the PCC rule(s); or + - the indication of EAS re-discovery in "easRediscoverInd" attribute if EAS re-discovery took place. +- i) if both the SMF and the NF service consumer support "ULBuffering" and/or "EASIPreplacement" features, these supported features within the "supportedFeatures" attribute. + +NOTE 1: The SMF gets the knowledge of the feature supported by the NF service consumer as described in clause 5.8. + +- j) if the "EasRelocationEnh" feature is supported and the SMF determines that the target DNAI is supported by an AF different to the one that shall receive this notification, the identifier of the target AF that supports this DNAI in the "targetAfId" attribute. + +NOTE 2: The SMF can determine this by comparing the AF ID of the EAS Deployment Information entry that contains the old DNAI with the AF ID of the EAS Deployment Information entry that contains the target DNAI. These EAS Deployment Information entries are received via the Nnef\_EASDeployment API defined in 3GPP TS 29.591 [25]. + +NOTE 3: UP path change notification, i.e. DNAI change notification and/or N6 traffic routing information change notification, can be the result of an implicit subscription of the PCF on behalf of the NEF/AF as part of setting PCC rule(s) via the Npcf\_SMPolicyControl service (see clause 4.2.6.2.6.2 of 3GPP TS 29.512 [14]). + +NOTE 4: If the DNAI is not changed while the N6 traffic routing information change, the source DNAI and target DNAI are not provided. + +NOTE 5: The change from the UP path status where no DNAI applies to a status where a DNAI applies indicates the activation of the related AF request and therefore only the target DNAI and N6 traffic routing information is provided in the event notification; the change from the UP path status where a DNAI applies to a status where no DNAI applies indicates the de-activation of the related AF request and therefore only the source DNAI and N6 traffic routing information is provided in the event notification. + +##### 3. for a UE IP address change: + +- a) added new UE IP address or prefix as "adIpv4Addr" attribute or "adIpv6Prefix" attribute, respectively; and/or +- b) released UE IP address or prefix as "reIpv4Addr" attribute or "reIpv6Prefix" attribute, respectively; + +##### 4. for an access type change: + +- a) new access type as "accType" attribute; + +##### 5. for a PLMN Change: + +- a) new PLMN as "plmnId" attribute; + +##### 6. for a PDU Session Release: + +- a) ID of the released PDU session as "pduSeId" attribute; + +- b) DNN of the released PDU session as "dnn" attribute, if the "PduSessionStatus" feature is supported; + - c) The type of the released PDU session as "pduSessType" attribute, if the "PduSessionStatus" feature is supported; + - d) UE IPv4 address as "ipv4Addr" attribute and/or IPv6 information (IPv6 prefix(es) or IPv6 address(es)) as "ipv6Prefixes" or "ipv6Addrs" attributes, if the released PDU session type is IP and the "PduSessionStatus" feature is supported; and + - e) S-NSSAI of the released PDU session as "snssai" attribute, if the "EneNA" feature is supported and "snssai" attribute is present in the subscribed "NsmfEventExposure" data type; +- 7. the time at which the event was observed encoded as "timeStamp" attribute; + - 8. the SUPI as the "supi" attribute if the subscription applies to a group of UE(s) or any UE. If the "WlanPerformanceExt\_AIML" feature is supported, the "supi" attribute may also be included for a single UE when the subscription applies to the "WLAN\_INFO" event; + - 9. if available, the GPSI as the "gpsi" attribute if the subscription applies to a group of UE(s) or any UE; + - 10. for a Downlink Data Delivery Status, if the "DownlinkDataDeliveryStatus" feature is supported: + - a) the downlink data delivery status as "dddStatus" attribute; + - b) the downlink data descriptors impacted by the downlink data delivery status change within the "dddTraDescriptor" attribute; and + - c) for downlink data delivery status "BUFFERED". the estimated maximum waiting time as "maxWaitTime" attribute; + - 11. for a Communication Failure, if the "CommunicationFailure" feature is supported: + - a) the detailed communication failure information (e.g. 5G SM cause) as "commFailure" attribute; and + - 12. for QoS Monitoring, if the "QoSMonitoring" or "E2eDataVolTransTime" feature is supported: + - a) one or two uplink packet delays within the "ulDelays" attribute; and/or + - b) one or two downlink packet delays within the "dlDelays" attribute; and/or + - c) one or two round trip packet delays within the "rtDelays" attribute; or + - d) if the feature "PacketDelayFailureReport" is supported, the packet delay measurement failure indicator within the "pdmf" attribute; and/or + - e) if the feature "EnQoSMon" is supported, UL and/or DL congestion information within the "ulConInfo" attribute and "dlConInfo" attribute; or + - f) if the feature "EnQoSMon" is supported, the congestion information measurement failure indicator within "cimf" attribute and/or + - g) if the feature "EnQoSMon" is supported, UL and/or DL data rate measurement within the "ulDataRate" attribute and/or "dlDataRate" attribute. +- NOTE 6: The SMF gets the knowledge of the NF service consumer support of "QoSMonitoring" feature as described in 3GPP TS 29.512 [14]. +- NOTE 7: QoS Monitoring notification can be the result of an implicit subscription of the PCF on behalf of the NEF/AF as part of setting PCC rule(s) via the Npcf\_SMPolicyControl service (see clause 4.2.3.25 of 3GPP TS 29.512 [14]). +- 13. for a PDU Session Establishment, if the "PduSessionStatus" feature is supported: + - a) ID of the established PDU session as "pduSeId" attribute; + - b) DNN of the established PDU session as "dnn" attribute; + +- c) The type of the established PDU session as "pduSessType" attribute; + - d) UE IPv4 address as "ipv4Addr" attribute and/or IPv6 information (IPv6 prefix(es) or IPv6 address(es)) as "ipv6Prefixes" or "ipv6Addrs" attributes if available at PDU session establishment; and + - e) S-NSSAI of the established PDU session as "snssai" attribute, if the "EneNA" feature is supported and "snssai" attribute is present in the subscribed "NsmfEventExposure" data type; +14. for a QFI allocation, if the "QfiAllocation" or "E2eDataVolTransTime" feature is supported: +- a) QFI of the allocated QoS Flow ID for the application as "qfi" attribute; + - b) DNN of the allocated PDU session as "dnn" attribute; + - c) Slice of the allocated PDU session as "snssai" attribute; + - d) The description of the application traffic as "appId", "fDescs" or "ethfDescs" attribute; and + - e) ID of the allocated PDU session as "pduSeId" attribute if the subscription was for a UE, a group of UEs, or any UE, and not for a specific PDU Session; + - f) To obtain the PDU Session information, if the "PduSessionInfo" feature is supported: + - i) the information about the UE access type provided as "accessType" attribute; + - ii) the information about the PDU Session Type in the "pduSessType" attribute and/or the SSC mode in the "sscMode" attribute associated with the application provided as "appId" attribute; and/or + - iii) the information about the PDU Session associated access type as "pduAccTypes" attribute, if the "MultipleAccessTypes" feature is also supported. +15. for an RAT type change, if the "EneNA" feature is supported: +- a) new RAT type as "ratType" attribute; +16. for a SM congestion control experience for PDU Session, if the "SMCCE" feature is supported: +- a) DNN of the PDU session as "dnn" attribute if DNN based SMCC is applied +or Slice of the allocated PDU session as "snssai" attribute if S-NSSAI based SMCC is applied; + - b) Time window representing a start time and a stop time of the data collection period as "timeWindow" attribute; + - c) The information of the SM NAS requests from UE as "smNasFromUe" attribute; and + - d) The information of the SM NAS messages from SMF with backoff timer as "smNasFromSmf" attribute; +17. for transactions dispersion collection, if the Dispersion feature is supported: +- a) The transactions dispersion information collected as "transacInfos" attribute; and + - b) The UE IP address as "ueIpAddr" attribute if it is available and requested in the subscription; +18. for redundant transmission experience of PDU Session, if the "RedundantTransmissionExp" feature is supported: +- a) DNN associated with URLLC service for the PDU session as "dnn" attribute; and + - b) UP with redundant transmission setup as "upRedTrans" attribute; +19. for WLAN information on PDU Session, if the "WlanPerformance" feature is supported: +- a) SSID or BSSID that the PDU session is related to as "ssid" or "bssid" attribute; and + - b) Start time or End time of the PDU Session for WLAN as "startWLAN" or "endWLAN" attribute; +20. for obtaining the UPF information, if the "ServiceExperience" and/or "DnPerformance" feature is supported: + +- a) the information of the UPF serving the UE provided as "upfInfo" attribute. +- 21. for obtaining the User Plane status information, if the "UeCommunication" feature is supported: + - a) the information about the User Plane status provided as "pduSessionInfos" attribute. + - 22. for a satellite backhaul category change, if the "EnSatBackhaulCategoryChg" feature is supported: + - a) satellite backhaul category as "satBackhaulCat" attribute. + - 23. for traffic correlation, if the "CommonEASDNAI" feature is supported: + - a) the traffic correlation information in the "trafCorreInfo" attribute, if the "notifUri" attribute, "notifCorrId" attribute and "tfcCorrId" attribute are provided in the PCC rule, and the common EAS is not provided in the PCC rule or the SMF decides to reselect an EAS for the set of UE(s). + +NOTE 8: Traffic correlation notification can be the result of an implicit subscription of the PCF on behalf of the NEF as part of setting PCC rule(s) via the Npcf\_SMPolicyControl service (see clause 4.2.6.2.6.2 of 3GPP TS 29.512 [14]). + +- an URI for further AF acknowledgement in the "ackUri" attribute if the SMF determines to wait for the AF acknowledgement before activating the new UP path associated with the new DNAI. + +NOTE 9: Based on the indication of AF acknowledgment to be expected in the PCC rules received from the PCF and local configuration, the SMF may determine to wait for the AF acknowledgement before activating the new UP path associated with the new DNAI. + +Upon the reception of an HTTP POST request with "{notifUri}" as URI and an NsmfEventExposureNotification data structure as request body, the notified NF shall send an HTTP "204 No Content" response for a successful processing. + +If errors occur when processing the HTTP POST request, the notified NF shall send the HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is not supported and, + +- if the notified NF is not able to handle the Notification but another unknown NF could possibly handle the notification, it shall reply with an HTTP "404 Not found" error response. + +NOTE 10: An AMF as NF service consumer and/or notified NF can change. + +- if the SMF becomes aware that a new NF service consumer is requiring notifications (e.g. via the "404 Not found" response, or via Namf\_Communication service AMFStatusChange Notifications, see 3GPP TS 29.518 [13], or via link level failures or via the Nnrf\_NFDiscovery Service (using the service name and GUAMI obtained during the creation of the subscription) to discover the other AMFs within the AMF set) specified in 3GPP TS 29.510 [12]), and the SMF knows alternate or backup IPv4 Address(es), IPv6 Address(es) or FQDN(s) where to send Notifications (e.g. via "altNotifIpv4Addrs", "altNotifIpv6Addrs" or "altNotifFqdns" attributes received when the subscription was created), the SMF shall exchange the authority part of the Notification URI with one of those addresses and shall use that URI in any subsequent communication. If the SMF received a "404 Not found" response, the SMF should resend the failed notification to that URI. + +If the feature "ES3XX" is supported, and the notified NF determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4] and, + +- if the SMF receives a "307 Temporary Redirect" response, the SMF shall resend the failed event notification request using the received URI in the Location header field as Notification URI. Subsequent event notifications, triggered after the failed one, shall be sent to the Notification URI provided by the NF service consumer during the corresponding subscription creation/update; or +- if the SMF receives a "308 Permanent Redirect" response, the SMF shall resend the failed event notification request and send the subsequent event notification using the received URI in the Location header field as Notification URI. + +If the SMF in the VPLMN needs to send an event notification to the NEF in the HPLMN, it may normalize the event based on roaming agreements when required before provisioning the event report to the NEF of the HPLMN. + +### 4.2.3 Nsmf\_EventExposure\_Subscribe Service Operation + +#### 4.2.3.1 General + +This service operation is used by an NF service consumer to subscribe to event notifications on a specific PDU Session, or for all PDU Sessions of one UE, group of UE(s) or any UE, or to modify an existing subscription. + +The following procedures using the Nsmf\_EventExposure\_Subscribe service operation are supported: + +- creating a new subscription; +- modifying an existing subscription. + +#### 4.2.3.2 Creating a new subscription + +Figure 4.2.3.2-1 illustrates the creation of a subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the SMF, and the SMF responds with a 201 Created status.](90ee16ccc0ad16aeca48087797d7b07f_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant SMF + Note right of NF service consumer: 1. POST .../subscriptions + NF service consumer->>SMF: Request + Note left of SMF: 2. "201 Created" + SMF-->>NF service consumer: Response + +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the SMF, and the SMF responds with a 201 Created status. + +**Figure 4.2.3.2-1: Creation of a subscription** + +To subscribe to event notifications, the NF service consumer shall send an HTTP POST request with: "{apiRoot}/nsmf-event-exposure/v1/subscriptions" as Resource URI and the NsmfEventExposure data structure as request body that shall include: + +- if the subscription applies to events related to a single PDU session for a UE, the PDU Session ID of that PDU session as "pduSessionId" attribute and the UE identification as "supi" or "gpsi" attribute; +- if the subscription applies to events not related to a single PDU session, the Network Function instance identity if "UPEAS" feature is supported and the "eventSubs" attribute contains an entry with the "event" set to the value "UPF\_EVENT", and identification of UEs to which the subscription applies via: + - a) identification of a single UE by SUPI as "supi" attribute or GPSI as "gpsi" attribute; + - b) identification of a group of UE(s) via a "groupId" attribute; or + - c) identification of any UE via the "anyUeInd" attribute set to true; + +NOTE 1: The identification of any UE does not apply for local breakout roaming scenarios where the SMF is located in the VPLMN and the NF service consumer is located in the HPLMN. + +- an URI where to receive the requested notifications as "notifUri" attribute; +- a Notification Correlation Identifier provided by the NF service consumer for the requested notifications as "notifId" attribute; and +- if the NF service consumer is an AMF, the GUAMI encoded as "guami" attribute; +- a description of the subscribed events as "eventSubs" attribute that for each event shall include: + - a) an event identifier as "event" attribute; and + +- b) for event "UP\_PATH\_CH", whether the subscription is for early, late, or early and late notifications of UP path reconfiguration in the "dnaiChgType" attribute; + - c) for event "DDDS", the traffic descriptor(s) of the downlink data source in the "dddTraDescriptors" attribute; +- and that may include: +- a) for event "DDDS", the subscribed delivery statuses in the "dddStati" attribute; + - b) for event "QFI\_ALLOC" or "DISPERSION", the application identifiers in the "appIds" attribute; + - c) for event "SMCC\_EXP", the data collection target period in the "targetPeriod" attribute; + - d) for event "DISPERSION", the UE IP Address in the "ueIpAddr" attribute, the indication of transaction dispersion collection in the "transacDispInd" attribute and the requested transaction metrics in the "transacMetrics" attribute; + - e) for event "WLAN\_INFO", the data collection target period in the "targetPeriod" attribute; + - f) for event "RED\_TRANS\_EXP", the data collection target period in the "targetPeriod" attribute; + - g) for event "UPF\_EVENT", the UPF event exposure information in the "upfEvents" attribute; and/or +- h) for event "QOS\_MON", the Application Identifier in the "appIds" of the application for which the QoS flows are to be monitored and an indication within the "defQosSupp" attribute to inform whether the NF service consumer supports to receive QoS Flow performance information for the QoS Flow associated with the default QoS rule if there are no measurements available for the provided Application Identifier included within the "appIds" attribute.NOTE 2: Explicit subscription to "UPF\_EVENT" and "QOS\_MON" events as described in this clause implies the direct notification from the UPF. + +The NsmfEventExposure data structure as request body may also include: + +- if the NF service consumer is an AMF: + - a) the name of a service produced by the AMF that expects to receive the notifications about subscribed events encoded as "serviceName" attribute; + - b) Alternate or backup IPv4 Address(es) where to send Notifications encoded as "altNotifIpv4Addrs" attribute; + - c) Alternate or backup IPv6 Address(es) where to send Notifications encoded as "altNotifIpv6Addrs" attribute; + - d) Alternate or backup FQDN(s) where to send Notifications encoded as "altNotifFqdns" attribute; +- a Data Network Name as "dnn" attribute; +- a single Network Slice Selection Assistance Information as "snssai" attribute; +- an identification of network area by "networkArea" attribute, if the feature AreaFilter is supported and the "anyUeInd" attribute is provided and set to true; + +NOTE 3: Care needs to be taken with regards to load and major signalling caused when requesting Any UE. This could be achieved via utilization of some event filters (e.g. Area of Interest), a specific DNN, S-NSSAI or sampling ratio as part of Event Reporting Information. + +- a Data Network Identifier as "dnai" attribute, if the feature UPEAS is supported; +- the SSID that the PDU session is related to as "ssid" attribute, if the feature UPEAS is supported; +- the BSSID that the PDU session is related to as "bssid" attribute, if the feature UPEAS is supported; +- the UPF identifier as "upfId" attribute, if the feature UPEAS is supported; +- immediate reporting flag as "ImmeRep" attribute; +- event notification method (periodic, one time, on event detection) as "notifMethod" attribute; +- maximum Number of Reports as "maxReportNbr" attribute; + +- monitoring Duration as "expiry" attribute; +- repetition Period for periodic reporting as "repPeriod" attribute; +- sampling ratio as "sampRatio" attribute; +- partitioning criteria for partitioning the UEs before performing sampling as "partitionCriteria" attribute if the EneNA feature is supported; and/or +- group reporting guard time as "grpRepTime" attribute; +- a notification flag as "notifFlag" attribute if the EneNA feature is supported; and/or +- notification muting exception instructions within the "notifFlagInstruct" attribute, if the EnhDataMgmt feature is supported and the "notifFlag" attribute is provided and set to "DEACTIVATE". + +NOTE 4: For the "PDU\_SES\_EST" event subscription, the "ImmeRep" attribute needs to be included to enable the SMF to report the current available "PDU\_SES\_EST" event information for the subscribed PDU Session which is already established. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nsmf-event-exposure/v1/subscriptions" as Resource URI and NsmfEventExposure data structure as request body, the SMF shall: + +- create a new subscription; +- assign a subscription correlation ID; +- select an expiry time that is equal to or less than the expiry time potentially received in the request; +- store the subscription; +- if the feature "UPEAS" is supported, and if the NF service consumer subscribed to "QOS\_MON" event, the SMF shall check if there is an active PCC rule that includes a Data Collection Application Identifier as described in 3GPP TS 29.512 [14] that matches the Application Identifier received within "applIds" attribute. If there is an active PCC rule, the SMF shall allow the NF service consumer to receive QoS monitoring reports enabled by that PCC rule. If no PCC rule is identified and the "defQosSupp" attribute was received and set to true, the SMF may instruct the UPF to perform QoS monitoring for the QoS Flow associated to the default QoS rule as described in 3GPP TS 29.244 [23]. If no PCC rule is identified and the "defQosSupp" attribute was received and set to false or not received, the SMF may, based on local configuration, reject the request by sending the NO\_ACTIVE\_PCC\_RULE error described in clause 5.7 or include the "qosMonPending" indication set to true in the response to inform the NF service consumer that the reporting will be activated when the measurements are enabled by a PCC rule; + +NOTE 5: The reporting can be activated when a new PCC rule is installed or an existing one is modified with QoS monitoring information that includes the Data Collection Application Identifier related to the subscription. In this case the SMF will act as if the new subscription is received from the NF service consumer. + +- send an HTTP "201 Created" response with NsmfEventExposure data structure as response body and a Location header field containing the URI of the created individual subscription resource, i.e. "{apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId}"; +- if the feature "ERIR" is not supported, and if the "ImmeRep" attribute is included and set to true in the request, the SMF shall immediately notify the recipient of notification(s) subscribed in the "notifUri" attribute of the current available value(s) using the Nsmf\_EventExposure\_Notify service operation, as defined in clause 4.2.2.1; +- if the feature "ERIR" is supported, and if the "ImmeRep" attribute is included and set to true, the SMF may immediately notify the NF service consumer with the current available value(s) for the subscribed event(s) within the HTTP "201 Created" response as shown in figure 4.2.3.2-1, step 2. The "NsmfEventExposure" data type in the response may include the corresponding event(s) notification within the "eventNotifs" attribute. +- if the sampling ratio attribute, as "sampRatio", is included in the subscription without a "partitionCriteria" attribute, the SMF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. If the "partitionCriteria" attribute is additionally included, then the SMF shall first partition the UEs according to the value of the "partitionCriteria" attribute and + +then select a random subset of UEs from each partition according to the sampling ratio and only report the event(s) related to the selected subsets of UEs; + +- when the group reporting guard time attribute, as "grpRepTime", is included in the subscription, the SMF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then the SMF shall notify the NF service consumer using the Nsmf\_EventExposure\_Notify service operation, as described in clause 4.2.2.2; and +- if the "notifFlag" attribute is included and set to "DEACTIVATE" in the request, the SMF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). When a muting exception occurs, the SMF may consider the contents of the "notifFlagInstruct" attribute (if provided) and/or local configuration to determine its actions. If the EnhDataMgmt feature is supported and the SMF accepts the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it may indicate the applied muting notification settings within the "mutingSetting" attribute in the response. If the SMF does not accept the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". + +If the SMF received an GUAMI, the SMF may subscribe to GUAMI changes using the AMFStatusChange service operation of the Namf\_Communication service specified in 3GPP TS 29.518 [13], and it may use the Nnrf\_NFDiscovery Service specified in 3GPP TS 29.510 [12] (using the obtained GUAMI and possibly service name) to query the other AMFs within the AMF set. + +If errors occur when processing the HTTP POST request, the SMF shall send an HTTP error response as specified in clause 5.7. + +#### 4.2.3.3 Modifying an existing subscription + +Figure 4.2.3.3-1 illustrates the modification of an existing subscription. + +![Sequence diagram showing the modification of an existing subscription. An NF service consumer sends a PUT request to the SMF. The SMF responds with either a 200 OK or a 204 No Content.](a51105b2031bad93b818b82f071c6add_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant SMF + Note left of NF service consumer: + NF service consumer->>SMF: 1. PUT.../subscriptions/{subId} + Note right of SMF: + SMF-->>NF service consumer: 2a. 200 OK + SMF-->>NF service consumer: 2b. 204 No Content + +``` + +Sequence diagram showing the modification of an existing subscription. An NF service consumer sends a PUT request to the SMF. The SMF responds with either a 200 OK or a 204 No Content. + +**Figure 4.2.3.3-1: Modification of an existing subscription** + +To modify an existing subscription to event notifications, the NF service consumer shall send an HTTP PUT request with: "{apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId}" as Resource URI, where "{subId}" is the subscription correlation ID of the existing subscription, and NsmfEventExposure data structure as request body as described in clause 4.2.3.2. + +NOTE 1: An alternate NF service consumer than the one that requested the generation of the subscription resource can send the PUT. For instance, an AMF as NF service consumer can change. + +NOTE 2: The "notifUri" attribute within the NsmfEventExposure data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +When the "notifFlag" attribute is included and set to "DEACTIVATE" in the request, the SMF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). When a muting exception occurs, the SMF may consider the contents of the "notifFlagInstruct" attribute (if provided) and/or local configuration to + +determine its actions; if the "notifFlag" attribute is set to "RETRIEVAL" in the request, the SMF shall send the stored events to the NF service consumer, mute the event notification again and store available events; if the "notifFlag" attribute is set to "ACTIVATE" and the event notifications are muted (due to a previously received "DEACTIVATE" value), the SMF shall unmute the event notification, i.e. start sending again notifications for available events. If the EnhDataMgmt feature is supported and the SMF accepts the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it may indicate the applied muting notification settings within the "mutingSetting" attribute in the response. If the SMF does not accept the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". + +When the "ImmRep" attribute set to true is included in the subscription and the subscribed event(s) are available: + +- if the feature "ERIR" is not supported, the SMF shall immediately notify the in the "notifUri" attribute in the "notifUri" attribute with the current available value(s) for the subscribed event(s) using the Nsmf\_EventExposure\_Notify service operation, as described in clause 4.2.2.1. +- if the feature "ERIR" is supported, the SMF may immediately notify the NF service consumer with the current available value(s) for the subscribed event(s) within the HTTP "200 OK" response as shown in figure 4.2.3.3-1, step 2a. The "NsmfEventExposure" data type may include the corresponding event(s) notification within the "eventNotifs" attribute. + +NOTE 3: Only the newly added event(s) needs to be reported during the subscription update. + +NOTE 4: For the "PDU\_SES\_EST" event subscription, the "ImmeRep" attribute needs to be included to enable the SMF to report the current available "PDU\_SES\_EST" event information for the subscribed PDU Session which is already established. + +If the "sampRatio" attribute is included in the request without a "partitionCriteria" attribute, the SMF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. If the "partitionCriteria" attribute is additionally included, then the SMF shall first partition the UEs according to the value of the "partitionCriteria" attribute and then select a random subset of UEs from each partition according to the sampling ratio and only report the event(s) related to the selected subsets of UEs. + +When the "grpRepTime" attribute is included in the request, the SMF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then the SMF shall notify the NF service consumer using the Nsmf\_EventExposure\_Notify service operation, as described in clause 4.2.2.2. + +When the "expiry" attribute is included in the request, the SMF shall select an expiry time that is equal to or less than the expiry time received in the request. + +Upon the reception of an HTTP PUT request with: "{apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId}" as Resource URI and NsmfEventExposure data structure as request body, if the received HTTP request is successfully processed and accepted, the SMF shall: + +- update the concerned subscription; and +- send an HTTP "200 OK" response with a response body containing a representation of the updated subscription in the NsmfEventExposure data structure or send a HTTP "204 No Content". + +If errors occur when processing the HTTP PUT request, the SMF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the SMF determines the received HTTP PUT request needs to be redirected, the SMF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +### 4.2.4 Nsmf\_EventExposure\_UnSubscribe Service Operation + +#### 4.2.4.1 General + +This service operation is used by an NF service consumer to unsubscribe from event notifications. + +The following procedure using the Nsmf\_EventExposure\_UnSubscribe service operation is supported: + +- unsubscription from event notifications. + +#### 4.2.4.2 Unsubscription from event notifications + +Figure 4.2.4.2-1 illustrates the unsubscription from event notifications. + +![Sequence diagram showing the unsubscription from event notifications between an NF service consumer and an SMF.](7d3d5fb5d09c0cd35a9d637be241651e_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant SMF + Note right of NF service consumer: 1. DELETE .../subscriptions/{subId} + NF service consumer->>SMF: 1. DELETE .../subscriptions/{subId} + Note left of SMF: 2. "204 No Content" + SMF-->>NF service consumer: 2. "204 No Content" +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and an SMF. The first message, labeled '1. DELETE .../subscriptions/{subId}', is sent from the NF service consumer to the SMF. The second message, labeled '2. "204 No Content"', is sent from the SMF back to the NF service consumer. + +Sequence diagram showing the unsubscription from event notifications between an NF service consumer and an SMF. + +**Figure 4.2.4.2-1: Unsubscription from event notifications** + +To unsubscribe from event notifications, the NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId}" as Resource URI, where "{subId}" is the subscription correlation ID of the existing subscription that is to be deleted. + +Upon the reception of the HTTP DELETE request with: "{apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId}" as Resource URI, if the received HTTP request is successfully processed and accepted, the SMF shall: + +- remove the corresponding subscription; and +- send an HTTP "204 No Content" response. + +If errors occur when processing the HTTP DELETE request, the SMF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the SMF determines the received HTTP DELETE request needs to be redirected, the SMF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +### 4.2.5 Nsmf\_EventExposure\_AppRelocationInfo Service Operation + +#### 4.2.5.1 General + +The Nsmf\_EventExposure\_AppRelocationInfo service operation enables the NF service consumer to acknowledge the notification of subscribed events on the related PDU session from the SMF. + +The following procedure using the Nsmf\_EventExposure\_AppRelocationInfo service operation is supported: + +- acknowledgement of notification about subscribed events. + +#### 4.2.5.2 Acknowledgement of Notification about subscribed events + +Figure 4.2.5.2-1 illustrates the acknowledgement of notification about subscribed events. + +![Sequence diagram showing the acknowledgement of a notification. An NF service consumer sends a POST {ackUri} request to the SMF, and the SMF responds with a 204 No Content.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant SMF + Note right of NF service consumer: 1. POST {ackUri} + NF service consumer->>SMF: 1. POST {ackUri} + Note left of SMF: 2. "204 No Content" + SMF-->>NF service consumer: 2. "204 No Content" + +``` + +Sequence diagram showing the acknowledgement of a notification. An NF service consumer sends a POST {ackUri} request to the SMF, and the SMF responds with a 204 No Content. + +**Figure 4.2.5.2-1: Acknowledgement of Notification about subscribed events** + +In order to acknowledge the SMF of the application relocation information after the handling of a notification about UP path change event, an NF service consumer shall send an HTTP POST request to the callback URI "{ackUri}" as previously provided by the SMF in an attribute within the NsmfEventExposureNotification data during UP path change notification procedure as defined in clause 4.2.2.2. + +The request body contains the AckOfNotify data structure that shall include: + +- Notification correlation ID provided by the SMF during UP path change notification, as "notifId" attribute; +- an identifier of UE (i.e. SUPI or GPSI), if available and the subscription does not apply to a group of UE(s) or any UE; and +- information about the AF acknowledgement within the "ackResult" attribute that shall contain result status of the application relocation as "afStatus" attribute. If the "afStatus" attribute sets to "SUCCESS", the N6 traffic routing information associated to the target DNAI may be included as "trafficRoute" attribute and, if the "ULBuffering" feature is supported, an indication that buffering of uplink traffic to the target DNAI is needed may be included as "upBuffInd" attribute and, if the feature "EASIPreplacement" is supported, EAS IP replacement information may be included as "easIpReplaceInfos" attribute. If the application relocation is not completed on time, the "afStatus" attribute shall set to the corresponding failure cause. + +**NOTE** The NF service consumer gets the knowledge of the support of "ULBuffering" and/or "EASIPreplacement" negotiated features as part of the notification of the subscribed events as described in clause 4.2.2.2. + +Upon the reception of an HTTP POST request with AckOfNotify data structure as request body, the SMF shall send an HTTP "204 No Content" response for a successful processing. + +If errors occur when processing the HTTP POST request, the SMF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the SMF determines the received HTTP POST request needs to be redirected, the SMF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +# 5 Nsmf\_EventExposure API + +## 5.1 Introduction + +The Session Management Event Exposure Service shall use the Nsmf\_EventExposure API. + +The API URI of the Nsmf\_EventExposure API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the SMF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nsmf-event-exposure". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +HTTP/2, IETF RFC 9113 [8], 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 [10] specification of HTTP messages and content bodies for the Nsmf\_EventExposure is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.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 Content type + +JSON, IETF RFC 8259 [9], 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 9457 [18]. + +### 5.2.3 HTTP custom headers + +The Nsmf\_EventExposure API shall support 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 Nsmf\_EventExposure API. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.3.1-1 depicts the resource URIs structure for the Nsmf\_EventExposure API. + +![Diagram showing the resource URI structure of the Nsmf_EventExposure API. The root path is {apiRoot}/nsmf-event-exposure/v1. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subId}.](26d664119ad25250780f554633444e54_img.jpg) + +{apiRoot}/nsmf-event-exposure/v1 + +``` + +graph TD + Root["{apiRoot}/nsmf-event-exposure/v1"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubId["/{subId}"] + +``` + +Diagram showing the resource URI structure of the Nsmf\_EventExposure API. The root path is {apiRoot}/nsmf-event-exposure/v1. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subId}. + +**Figure 5.3.1-1: Resource URI structure of the Nsmf\_EventExposure API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------------|------------------------|---------------------------------|--------------------------------------------------------------------------------------------------| +| SMF Notification Subscriptions | /subscriptions | POST | Create a new Individual SMF Notification Subscription resource. | +| Individual SMF Notification Subscription | /subscriptions/{subId} | GET | Read an Individual SMF Notification Subscription resource. | +| | | PUT | Modify an existing Individual SMF Notification Subscription resource. | +| | | DELETE | Delete an Individual SMF Notification Subscription resource and cancel the related subscription. | + +### 5.3.2 Resource: SMF Notification Subscriptions + +#### 5.3.2.1 Description + +The SMF Notification Subscriptions resource represents the collection of subscriptions to the SMF event exposure service at a given SMF. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/nsmf-event-exposure/v1/subscriptions + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-----------------------------------------------------------------| +| NsmfEventExposure | M | 1 | Create a new Individual SMF Notification Subscription resource. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------| +| NsmfEventExposure | M | 1 | 201 Created | The creation of an Individual SMF Notification Subscription resource is confirmed and a representation of that resource is returned. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: 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. +NOTE 2: Failure cases are described in clause 5.7. + +**Table 5.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}/nsmf-event-exposure/v1/subscriptions/{subId} | + +#### 5.3.2.4 Resource Custom Operations + +None. + +### 5.3.3 Resource: Individual SMF Notification Subscription + +#### 5.3.3.1 Description + +The SMF Notification Subscriptions resource represents a single subscription to the SMF event exposure service. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId} + +This resource shall support the resource URI variables defined in table 5.3.3.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| subId | string | Identifies a subscription to the SMF event exposure service formatted as defined for the SubId type in table 5.6.3.2-1. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-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.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.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.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| NsmfEventExposure | M | 1 | 200 OK | A representation of the SMF Notification Subscription matching the subId is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual SMF Notification Subscription retrieval.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual SMF Notification Subscription retrieval.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative SMF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the request is redirected | + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative SMF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the request is redirected | + +##### 5.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.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.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +**Table 5.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| NsmfEventExposure | M | 1 | Modify the existing Individual SMF Notification Subscription resource matching the subId according to the representation in the NsmfEventExposure | + +**Table 5.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NsmfEventExposure | M | 1 | 200 OK | Successful case: The Individual SMF Notification Subscription resource matching the subId was modified and a representation is returned. | +| n/a | | | 204 No Content | Successful case: The Individual SMF Notification Subscription resource matching the subId was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual SMF Notification Subscription modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual SMF Notification Subscription modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: Failure cases are described in clause 5.7. + +NOTE 3: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative SMF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the request is redirected | + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative SMF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the request is redirected | + +##### 5.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.3-1. + +**Table 5.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.3.3.3.3-2 and the response data structures and response codes specified in table 5.3.3.3.3-3. + +**Table 5.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.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 SMF Notification Subscription resource matching the subId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual SMF Notification Subscription deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual SMF Notification Subscription deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative SMF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the request is redirected | + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative SMF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the request is redirected | + +#### 5.3.3.4 Resource Custom Operations + +None. + +## 5.4 Custom Operations without associated resources + +None. + +## 5.5 Notifications + +### 5.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.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------------|--------------|---------------------------------|------------------------------------------------| +| Event Notification | {notifUri} | POST | Provides information about observed events. | +| Acknowledgement of event notification | {ackUri} | POST | Provides acknowledgement of event notification | + +### 5.5.2 Event Notification + +#### 5.5.2.1 Description + +The Event Notification is used by the SMF to report one or several observed Events to a recipient of notification(s) that a NF service consumer has subscribed to such Notifications. + +NOTE 1: The definition of "callbacks" in the OpenAPI specification found in clause A.2 associated to the POST method of the "SMF Notification Subscriptions" resource is used as the notification request for both explicit and implicit subscriptions. + +NOTE 2: For implicit subscriptions, the PCF can have previously stored in the SMF the notification URI to be used in the notifications initiated by the SMF. See 3GPP TS 29.512 [14] for the details. + +#### 5.5.2.2 Target URI + +The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 5.5.2.2-1. + +**Table 5.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned either within the Individual SMF Notification Subscription Resource during the explicit subscription service operation and described within the NsmfEventExposure type (see table 5.6.2.2-1) or assigned during the implicit subscription via the provisioning of the subscription information within the PCC Rule from the PCF (see 3GPP TS 29.512 [14]). | + +#### 5.5.2.3 Standard Methods + +##### 5.5.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.2.3.1-1. + +**Table 5.5.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.2.3.1-2 and the response data structures and response codes specified in table 5.5.2.3.1-3. + +**Table 5.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------------|---|-------------|--------------------------------------------| +| NsmfEventExposureNotification | M | 1 | Provides Information about observed events | + +**Table 5.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 the event notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The NF service consumer can use this response when the notification can be sent to another host. | + +NOTE 1: 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. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.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 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. May be included if the feature "ES3XX" is supported. | + +**Table 5.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 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +### 5.5.3 Acknowledgement of event notification + +#### 5.5.3.1 Description + +The Acknowledgement of Event Notification is used by the NF service consumer to acknowledge the SMF about handling result of the event notification (e.g. UP path change). + +#### 5.5.3.2 Target URI + +The Callback URI "{ackUri}" shall be used with the callback URI variables defined in table 5.5.3.2-1. + +**Table 5.5.3.2-1: Callback URI variables** + +| Name | Data type | Definition | +|--------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ackUri | Uri | Acknowledgement Uri as assigned during the procedure of notification about subscribed events and described within the NsmfEventExposureNotification data type (see table 5.6.2.3-1). | + +#### 5.5.3.3 Standard Methods + +##### 5.5.3.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.3.3.1-1. + +**Table 5.5.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.3.3.1-2 and the response data structures and response codes specified in table 5.5.3.3.1-3. + +**Table 5.5.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|---------------------------------------------------| +| AckOfNotify | M | 1 | Acknowledgement information of event notification | + +**Table 5.5.3.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 acknowledgement is successful. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during acknowledgement of notification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during acknowledgement of notification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: 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. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.5.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative SMF (service) instance towards which the acknowledgement should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the acknowledgement request is redirected | + +**Table 5.5.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative SMF (service) instance towards which the acknowledgement should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance towards which the acknowledgement request is redirected | + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.1-1 specifies the data types defined for the Nsmf\_EventExposure service based interface protocol. + +Table 5.6.1-1: Nsmf\_EventExposure specific Data Types + +| Data type | Section defined | Description | Applicability | +|--------------------------------|-----------------|------------------------------------------------------------------------------|------------------------------------| +| AckOfNotify | 5.6.2.7 | Acknowledgement information of event notification | | +| AppliedSmccType | 5.6.3.6 | The type of applied SM congestion control. | SMCCE | +| EventNotification | 5.6.2.5 | Describes notifications about a single event that occurred. | | +| EventSubscription | 5.6.2.4 | Represents the subscription to a single event | | +| NotificationMethod | 5.6.3.4 | Represents the notification methods that can be subscribed | | +| NsmfEventExposure | 5.6.2.2 | Represents an Individual SMF Notification Subscription resource | | +| NsmfEventExposureNotification | 5.6.2.3 | Describes Notifications about events that occurred. | | +| PduSessionInfo | 5.6.2.12 | Represents session information. | UeCommunication | +| PduSessionInformation | 5.6.2.11 | Represents the PDU session related information. | UeCommunication | +| PduSessionStatus | 5.6.3.8 | Status of the PDU Session. | UeCommunication | +| SmfEvent | 5.6.3.3 | Represents the types of events that can be subscribed | | +| SubId | 5.6.3.2 | Identifies an Individual SMF Notification Subscription. | | +| SmNasFromSmf | 5.6.2.9 | Describes the information of the SM NAS messages from SMF with backoff timer | SMCCE | +| SmNasFromUe | 5.6.2.8 | Describes the information of the SM NAS requests from UE | SMCCE | +| TrafficCorrelationNotification | 5.6.2.14 | Represents the traffic correlation Information for Notification. | CommonEASD
NAI | +| TransactionInfo | 5.6.2.10 | UE Session Management transaction information. | Dispersion | +| TransactionMetric | 5.6.3.7 | Metric on UE Session Management transactions. | Dispersion | +| UpfInformation | 5.6.2.13 | The information of the UPF serving the UE. | ServiceExperience
DnPerformance | + +Table 5.6.1-2 specifies data types re-used by the Nsmf\_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 Nsmf\_EventExposure service based interface. + +Table 5.6.1-2: Nsmf\_EventExposure re-used Data Types + +| Data type | Reference | Comments | Applicability | +|-----------------------------|---------------------|------------------------------------------------------------------------------------------------------------|------------------------------------| +| 5Qi | 3GPP TS 29.571 [11] | The 5G QoS Identifier. | EnQfiAllocation | +| AccessType | 3GPP TS 29.571 [11] | | | +| AfResultInfo | 3GPP TS 29.522 [20] | Represents application handling information. | | +| ApplicationId | 3GPP TS 29.571 [11] | The application identifier. | QfiAllocation
PduSessionInfo | +| BitRate | 3GPP TS 29.571 [11] | Represents the bit rate. | EnQoSMon | +| CommunicationFailure | 3GPP TS 29.518 [13] | Represents the communication failure information. | Communication Failure | +| DateTime | 3GPP TS 29.571 [11] | | | +| DiDataDeliveryStatus | 3GPP TS 29.571 [11] | Status of downlink data delivery | DownlinkDataDeliveryStatus | +| DddTrafficDescriptor | 3GPP TS 29.571 [11] | Traffic descriptor of source of downlink data | DownlinkDataDeliveryStatus | +| Dnai | 3GPP TS 29.571 [11] | | | +| DnaiChangeType | 3GPP TS 29.571 [11] | Describes the types of DNAI change. | | +| Dnn | 3GPP TS 29.571 [11] | | QfiAllocation,
PduSessionStatus | +| DurationSec | 3GPP TS 29.571 [11] | | | +| EthFlowDescription | 3GPP TS 29.514 [22] | Ethernet flow description | QfiAllocation | +| FlowDescription | 3GPP TS 29.514 [22] | IP flow description | QfiAllocation | +| Fqdn | 3GPP TS 29.571 [11] | FQDN | | +| Gpsi | 3GPP TS 29.571 [11] | | | +| GroupId | 3GPP TS 29.571 [11] | | | +| Guami | 3GPP TS 29.571 [11] | Globally Unique AMF Identifier | | +| IpAddr | 3GPP TS 29.571 [11] | UE IP address. | Dispersion
CommonEASD
NAI | +| Ipv4Addr | 3GPP TS 29.571 [11] | | | +| Ipv6Addr | 3GPP TS 29.571 [11] | | | +| Ipv6Prefix | 3GPP TS 29.571 [11] | | | +| MacAddr48 | 3GPP TS 29.571 [11] | MAC Address. | | +| MutingExceptionInstructions | 3GPP TS 29.571 [11] | Contains instructions to be executed upon the occurrence of an event muting exception (e.g. full buffer). | EnhDataMgmt | +| MutingNotificationsSettings | 3GPP TS 29.571 [11] | Contains setting related to the muting of notifications. | EnhDataMgmt | +| NetworkAreaInfo | 3GPP TS 29.554 [27] | Identifies the network area. | AreaFilter | +| NfInstanceId | 3GPP TS 29.571 [11] | Instance identity of the Network Function | UPEAS
CommonEASD
NAI | +| NotificationFlag | 3GPP TS 29.571 [11] | Notification flag. | EneNA | +| PartitioningCriteria | 3GPP TS 29.571 [11] | Used to partition UEs before applying sampling. | EneNA | +| PduSessionId | 3GPP TS 29.571 [11] | | | +| PduSessionType | 3GPP TS 29.571 [11] | PDU session type. | PduSessionStatus
PduSessionInfo | +| PlmnIdNid | 3GPP TS 29.571 [11] | Identification of a network: the PLMN Identifier or the SNPN Identifier (the PLMN Identifier and the NID). | | +| ProblemDetails | 3GPP TS 29.571 [11] | | | +| Qfi | 3GPP TS 29.571 [11] | QoS flow identifier. | QfiAllocation | +| RatType | 3GPP TS 29.571 [11] | | | +| RedirectResponse | 3GPP TS 29.571 [11] | Contains redirection related information. | ES3XX | +| RouteToLocation | 3GPP TS 29.571 [11] | A traffic route to/from an DNAI | | +| SamplingRatio | 3GPP TS 29.571 [11] | Sampling Ratio. | | +| SatelliteBackhaulCategory | 3GPP TS 29.571 [11] | Indicates the satellite backhaul category or non-satellite backhaul. | EnSatBackhaul
CategoryChg | +| ServiceName | 3GPP TS 29.510 [12] | Name of the service instance. | | +| Snssai | 3GPP TS 29.571 [11] | S-NSSAI | QfiAllocation | +| SscMode | 3GPP TS 29.571 [11] | SSC Mode selected for the PDU Session. | PduSessionInfo | + +| | | | | +|-------------------|---------------------|--------------------------------------------------------------------------------------|-------| +| Supi | 3GPP TS 29.571 [11] | | | +| SupportedFeatures | 3GPP TS 29.571 [11] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | +| TimeWindow | 3GPP TS 29.122 [24] | A start time and a stop time of a time window. | SMCCE | +| Uinteger | 3GPP TS 29.571 [11] | | | +| UpfEvent | 3GPP TS 29.564 [26] | Contains UPF event information. | UPEAS | +| Uri | 3GPP TS 29.571 [11] | | | + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 5.6.2.2 Type NsmfEventExposure + +Table 5.6.2.2-1: Definition of type NsmfEventExposure + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Subscription Permanent Identifier (NOTE 1) | | +| gpsi | Gpsi | C | 0..1 | Generic Public Subscription Identifier (NOTE 1)
This IE is not applicable to "SMCC_EXP" event. | | +| anyUeInd | boolean | C | 0..1 | This IE shall be present if the event subscription is applicable to any UE. It indicates whether the event subscription is applicable to any UE:
- "true": the event subscription is applicable to any UE;
- "false"(default): the event subscription is not applicable to any UE.
(NOTE 1) (NOTE 4) | | +| groupId | GroupId | C | 0..1 | Identifies a group of UEs. (NOTE 1) | | +| pduSessionId | PduSessionId | C | 0..1 | PDU session ID (NOTE 1) | | +| dnn | Dnn | O | 0..1 | Data Network Name. | | +| snssai | Snssai | O | 0..1 | A single Network Slice Selection Assistance Information. (NOTE 4) | | +| dnai | Dnai | O | 0..1 | Data network access identifier. | UPEAS | +| ssld | string | O | 0..1 | SSID that the PDU session is related to. | UPEAS | +| bssld | string | O | 0..1 | BSSID that the PDU session is related to. | UPEAS | +| upfId | string | O | 0..1 | Identifies the UPF. | UPEAS | +| nfId | NfInstanceId | C | 0..1 | Indicates the instance identity of the NF creating the subscription. It shall be provided if the "eventSubs" attribute contains an entry with the "event" set to the value "UPF_EVENT". | UPEAS | +| subId | SubId | C | 0..1 | Subscription ID.
This parameter shall be supplied by the SMF in HTTP responses that include an object of NsmfEventExposure type. | | +| notifId | string | M | 1 | Notification Correlation ID provided by the NF service consumer. (NOTE 2) | | +| notifUri | Uri | M | 1 | Identifies the recipient of Notifications sent by the SMF. | | +| altNotifIpv4Addrs | array(Ipv4Addr) | O | 1..N | Alternate or backup IPv4 Address(es) where to send Notifications. | | +| altNotifIpv6Addrs | array(Ipv6Addr) | O | 1..N | Alternate or backup IPv6 Address(es) where to send Notifications. | | +| altNotifFqdns | array(Fqdn) | O | 1..N | Alternate or backup FQDN(s) where to send Notifications. | | +| eventSubs | array(EventSubscription) | M | 1..N | Subscribed events. (NOTE 4) | | +| eventNotifs | array(EventNotification) | O | 1..N | Represents the SMF Events to be reported in the Nsmf_EvenExposure_Subscribe response.
May be present when the "ERIR" feature is supported and the "ImmeRep" attribute set to true is included in the subscription request. | ERIR | + +| | | | | | | +|---------------------|-----------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| ImmeRep
(NOTE 6) | boolean | O | 0..1 | It is included and set to true if the immediate reporting of the current status of the subscribed event, if available is required. | | +| notifMethod | NotificationMethod | O | 0..1 | If "notifMethod" is not supplied, the default value "ON_EVENT_DETECTION" applies. (NOTE 4) (NOTE 5) | | +| maxReportNbr | UInteger | O | 0..1 | If omitted, there is no limit. (NOTE 4) (NOTE 5) | | +| expiry | DateTime | C | 0..1 | This attribute indicates the expiry time of the subscription, after which the SMF shall not send any event notifications and the subscription becomes invalid. It may be included in an event subscription request and may be included in an event subscription response based on operator policies. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. If the expiry time is not included in the response, the NF service consumer shall not associate an expiry time for the subscription. (NOTE 4) | | +| repPeriod | DurationSec | C | 0..1 | Is supplied for notification Method "periodic". | | +| guami | Guami | C | 0..1 | The Globally Unique AMF Identifier (GUAMI) shall be provided by an AMF as NF service consumer. | | +| serviceName | ServiceName | O | 0..1 | If the NF service consumer is an AMF, it should provide the name of a service produced by the AMF that makes use of the notification about subscribed events. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.8. This parameter shall be supplied by NF service consumer and SMF in the POST request that request the creation of an SMF Notification Subscriptions resource and the related reply, respectively. | | +| sampRatio | SamplingRatio | O | 0..1 | Indicates the ratio of the random subset to target UEs, event reports only relates to the subset. | | +| partitionCriteria | array(PartitioningCriteria) | O | 1..N | Defines criteria for partitioning the UEs in order to apply the sampling ratio for each partition. It may only be included in event subscription requests when the "sampRatio" attribute is also provided. (NOTE 3) | EneNA | +| grpRepTime | DurationSec | O | 0..1 | Indicates the time for which the SMF aggregates the event reports detected by the UEs in a group and report them together to the NF service consumer. | | +| notifFlag | NotificationFlag | O | 0..1 | Indicates the notification flag, which is used to mute/unmute notifications and to retrieve events stored during a period of muted notifications. Default: "ACTIVATE" | EneNA | +| notifFlagInstruct | MutingExceptionInstructions | O | 0..1 | Contains instructions to be executed upon the occurrence of an event muting exception (e.g. full buffer). It may only be provided if the | EnhDataMgmt | + +| | | | | | | +|---------------|------------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| | | | | "notifFlag" is provided and set to "DEACTIVATE". | | +| mutingSetting | MutingNotifications Settings | O | 0..1 | Contains settings related to the muting of notifications. It may only be provided in the NF service producer response and only if the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes are accepted. | EnhDataMgmt | +| defQosSupp | boolean | O | 0..1 | Indicates whether the NF service consumer requests to receive QoS Flow performance information for the QoS Flow associated with the default QoS rule if there are no measurements available for the provided Application Identifier included within the "appIds" attribute.
True: NF service consumer requests to receive QoS Flow performance information for the QoS Flow associated with the default QoS rule.
False (default): NF service consumer does not request to receive QoS Flow performance information for the QoS Flow associated with the default QoS rule. | UPEAS | +| qosMonPending | boolean | O | 0..1 | Indicates that the reporting will be activated when the measurements are enabled by a PCC rule. It shall be always set to true when present. It may only be provided in the response.
Default value is false. | UPEAS | + +NOTE 1: If the event subscription applies for a specific PDU session, the PDU session of a single UE (pduSeld, and gpsi/supi) shall be included; otherwise one and only one of a single UE (gpsi/supi), a group of UEs (groupId), or anyUeInd set to true shall be included. + +NOTE 2: If the UDM as NF service consumer subscribes to event (e.g. downlink data delivery status, PDU Session Establishment, PDU Session Release) on behalf of AF/NEF, "notifId" shall be set the same as "referenceId" received from the AF/NEF as defined in clause 6.4.6.2.4 of 3GPP TS 29.503 [14]. + +NOTE 3: For a given type of partitioning criteria, the UE shall belong to only one single partition as long as it is served by the NF service producer. + +NOTE 4: If EneNA feature is supported, when the "snssai" attribute is presented together with "anyUeInd" attribute and the "eventSubs" attribute contains "PDU\_SES\_EST" and "PDU\_SES\_REL", then only the "ON\_EVENT\_DETECTION" value is applicable in the "notifMethod" attribute together with "maxReportNbr" attribute and/or "expiry" attribute presence. + +NOTE 5: The attribute "maxReportNbr" is not applicable when the value of "notifMethod" is set to "ONE\_TIME". + +NOTE 6: The attribute does not follow the related naming convention (i.e. "lowerCamel") defined in clause 5.1.4 of 3GPP TS 29.501 [7]. This attribute is however kept as currently defined in this specification for backward compatibility considerations. + +#### 5.6.2.3 Type NsmfEventExposureNotification + +Table 5.6.2.3-1: Definition of type NsmfEventExposureNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifId | string | M | 1 | Notification correlation ID used to identify the subscription which the notification is corresponding to. It shall be set to the same value as the "notifId" attribute of NsmfEventExposure data type or the value of "notifCorrelId" within the UpPathChgEvent data type defined in 3GPP TS 29.512 [14], the value of "notifCorrelId" in the "tfcCorrelInfo" attribute within the TrafficControlData data type defined in 3GPP TS 29.512 [14], or the value of "notifCorrelId" within the QosMonitoringData data type defined in 3GPP TS 29.512 [14]. | | +| eventNotifs | array(EventNotification) | M | 1..N | Notifications about Individual Events | | +| ackUri | Uri | O | 0..1 | The URI provided by the SMF for the AF acknowledgement. If present, it only applies to the "UP_PATH_CH" event indicated in the "eventNotifs" attribute. | | + +#### 5.6.2.4 Type EventSubscription + +Table 5.6.2.4-1: Definition of type EventSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------|-----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| +| event | SmfEvent | M | 1 | Subscribed events | | +| dnaiChgType | DnaiChangeType | C | 0..1 | For event UP path change, this attribute indicates whether the subscription is for early, late, or early and late DNAI change notification shall be supplied. | | +| dddTraDescriptors | array(DddTrafficDescriptor) | C | 1..N | The traffic descriptor(s) of the downlink data source. Shall be included for event "DDDS". | DownlinkDataDeliveryStatus | +| dddStati | array(DIDataDeliveryStatus) | O | 1..N | May be included for event "DDDS". The subscribed statuses (discarded, transmitted, buffered) for the event. If omitted all statuses are subscribed. | DownlinkDataDeliveryStatus | +| appIds | array(ApplicationId) | O | 1..N | May be included for event "QFI_ALLOC", "DISPERSION" or "QOS_MON".
(NOTE) | QfiAllocation
Dispersion
PduSessionInfo
UPEAS | +| networkArea | NetworkAreaInfo | O | 0..1 | Identification of network area to which the subscription applies. | AreaFilter | +| targetPeriod | TimeWindow | O | 0..1 | Indicates the data collection target period.
May be included for event "SMCC_EXP", "RED_TRANS_EXP" or "WLAN_INFO". | SMCC
RedundantTransmissionExp
WlanPerformance | +| transacDispInd | boolean | O | 0..1 | Indicates the subscription for UE transaction dispersion collection, if it is included and set to "true". Default value is "false".
May be included for event "DISPERSION". | Dispersion | +| transacMetrics | array(TransactionMetric) | O | 1..N | Requested transaction metrics.
May be included for event "DISPERSION". | Dispersion | +| uelpAddr | lpAddr | O | 0..1 | Indicates the UE IP address. May be included for event "DISPERSION". | Dispersion | +| upfEvents | array(UpfEvent) | O | 1..N | Indicates the exposure information related to UPF events.
May be included for event "UPF_EVENT". | UPEAS | +| NOTE: Only one instance of "ApplicationId" shall be provided when the event is "QOS_MON". | | | | | | + +#### 5.6.2.5 Type EventNotification + +Table 5.6.2.5-1: Definition of type EventNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| event | SmfEvent | M | 1 | Event that is notified. | | +| timeStamp | DateTime | M | 1 | Time at which the event is observed. | | +| supi | Supi | C | 0..1 | Subscription Permanent Identifier. It is included when the subscription applies to a group of UE(s) or any UE. (NOTE 9) | | +| gpsi | Gpsi | C | 0..1 | Identifies a GPSI. It shall contain an MSISDN. It is included when it is available and the subscription applies to a group of UE(s) or any UE.
This IE is not applicable to "SMCC_EXP" event. | | +| uelpAddr | IpAddr | C | 0..1 | Indicates the UE IP address, It is included for event "DISPERSION" when it is available and requested in the subscription. | Dispersion | +| transacInfos | array(TransactionInfo) | C | 1..N | Transaction Information. Shall be included for event "DISPERSION". | Dispersion | +| sourceDnai | Dnai | C | 0..1 | Source DN Access Identifier. Shall be included for event "UP_PATH_CH" if the DNAI changed (NOTE 1, NOTE 2). | | +| targetDnai | Dnai | C | 0..1 | Target DN Access Identifier. Shall be included for event "UP_PATH_CH" if the DNAI changed (NOTE 1, NOTE 2). | | +| dnaiChgType | DnaiChangeType | C | 0..1 | DNAI Change Type. Shall be included for event "UP_PATH_CH". | | +| candidateDnais | array(Dnai) | O | 1..N | The candidate DNAI(s) for the PDU Session. May be included for event "UP_PATH_CH". | CommonEAS DNAI | +| easRediscoverInd | boolean | O | 0..1 | Indication of EAS re-discovery. If present and set to "true", it indicates the EAS re-discovery is performed, e.g. due to change of common EAS. Default value is "false" if omitted. | CommonEAS DNAI | +| candDnaisPriInd | boolean | O | 0..1 | If provided and set to "true", it indicates that the candidate DNAIs provided in the "candidateDnais" attribute are in descending priority order, i.e. the lower the array index the higher the priority of the respective DNAI. If omitted, the default value is "false". It may only be provided if the "candidateDnais" attribute is provided and the "dnaiChgType" attribute is set to the value "EARLY". | CommonEAS DNAI | +| trafCorrInfo | TrafficCorrelationNotification | O | 0..1 | Contains traffic correlation information for notification. It shall be provided if the event attribute has the value "TRAFFIC_CORRELATION". | CommonEASDNAI | +| sourceUelpv4Addr | Ipv4Addr | O | 0..1 | The IPv4 Address of the served UE for the source DNAI. May be included for event "UP_PATH_CH". | | +| sourceUelpv6Prefix | Ipv6Prefix | O | 0..1 | The Ipv6 Address Prefix of the served UE for the source DNAI. May be included for event "UP_PATH_CH". | | + +| | | | | | | +|--------------------|----------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| targetUelpv4Addr | Ipv4Addr | O | 0..1 | The IPv4 Address of the served UE for the target DNAI. May be included for event "UP_PATH_CH". | | +| targetUelpv6Prefix | Ipv6Prefix | O | 0..1 | The Ipv6 Address Prefix of the served UE for the target DNAI. May be included for event "UP_PATH_CH". | | +| sourceTraRouting | RouteToLocation | C | 0..1 | N6 traffic routing information for the source DNAI. Shall be included for event "UP_PATH_CH" if available (NOTE 2). | | +| targetTraRouting | RouteToLocation | C | 0..1 | N6 traffic routing information for the target DNAI. Shall be included for event "UP_PATH_CH" if available (NOTE 2). | | +| ueMac | MacAddr48 | O | 0..1 | UE MAC address. May be included for event "UP_PATH_CH". | | +| adIpv4Addr | Ipv4Addr | O | 0..1 | Added IPv4 Address(es). May be included for event "UE_IP_CH". | | +| adIpv6Prefix | Ipv6Prefix | O | 0..1 | Added Ipv6 Address Prefix(es). May be included for event "UE_IP_CH". | | +| relIpv4Addr | Ipv4Addr | O | 0..1 | Removed IPv4 Address(es). May be included for event "UE_IP_CH". | | +| relIpv6Prefix | Ipv6Prefix | O | 0..1 | Removed Ipv6 Address Prefix(es). May be included for event "UE_IP_CH". | | +| plmnId | PlmnIdNid | C | 0..1 | New PLMN Identifier or the SNPN Identifier. Shall be included for event "PLMN_CH". (NOTE 7) | | +| accType | AccessType | C | 0..1 | New Access Type. Shall be included for event "AC_TY_CH" and may be included for event "QFI_ALLOC". | | +| pduAccTypes | array(AccessType) | O | 1..N | The list of Access Types used for the PDU session. May be included for event "QFI_ALLOC". (NOTE 11) | MultipleAccessTypes | +| pduSeld | PduSessionId | C | 0..1 | PDU session ID. Shall be included for event "PDU_SES_REL" and "PDU_SES_EST". It shall also be included for event "QFI_ALLOC" if the subscription was for a UE, a group of UEs, or any UE, and not for a specific PDU Session. | | +| ratType | RatType | C | 0..1 | New RAT Type. Shall be included for event 'RAT_TY_CH'. | EneNA | +| dddStatus | DIDataDeliveryStatus | C | 0..1 | Downlink data delivery status (discarded, transmitted, buffered). Shall be included for event "DDDS", | DownlinkDataDeliveryStatus | +| maxWaitTime | DateTime | C | 0..1 | The estimated maximum waiting time for downlink data delivery, Shall be included for event "DDDS" with status "BUFFERED". | DownlinkDataDeliveryStatus | +| dddTraDescriptor | DddTrafficDescriptor | C | 0..1 | The downlink data descriptor impacted by downlink data delivery status change. Shall be included for event "DDDS" | DownlinkDataDeliveryStatus | +| commFailure | CommunicationFailure | C | 0..1 | Describes the communication failure cause for the UE. Shall be included for event "COMM_FAIL". | CommunicationFailure | +| ipv4Addr | Ipv4Addr | O | 0..1 | IPv4 address. May be included for event "PDU_SES_REL" or "PDU_SES_EST". | PduSessionStatus | +| ipv6Prefixes | array(Ipv6Prefix) | O | 1..N | IPv6 prefixes. May be included for event "PDU_SES_REL" or "PDU_SES_EST". (NOTE 3) | PduSessionStatus | +| ipv6Addrs | array(Ipv6Addr) | O | 1..N | IPv6 addresses. May be included for | PduSessionSt | + +| | | | | | | +|--------------|---------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| | | | | event "PDU_SES_REL" or "PDU_SES_EST". (NOTE 3) | atus | +| pduSessType | PduSessionType | C | 0..1 | PDU session type. Shall be included if the PduSessionStatus or PduSessionInfo feature is supported. (NOTE 8) | PduSessionStatus
PduSessionInfo | +| sscMode | SscMode | O | 0..1 | Represents the SSC mode of the PDU Session. It may be included for event "QFI_ALLOC". (NOTE 8) | PduSessionInfo | +| qfi | Qfi | C | 0..1 | QoS flow identifier. Shall be included for event "QFI_ALLOC". | QfiAllocation | +| appId | ApplicationId | O | 0..1 | Contains the application identifier. May be included for event "QFI_ALLOC". (NOTE 4) (NOTE 8) | QfiAllocation
PduSessionInfo | +| ethFlowDescs | array(EthFlowDescription) | O | 1..N | Descriptor(s) for non-IP traffic in which only ethernet flow description is defined. It allows the encoding of multiple UL and/or DL flows. Each entry of the array describes a single Ethernet flow. May be included for event "QFI_ALLOC", when the description of the Ethernet traffic requires multiple UL and/or DL flows. (NOTE 4) | MultipleFlowDescriptions | +| ethfDescs | array(EthFlowDescription) | O | 1..2 | Contains the flow description for the Uplink and/or Downlink Ethernet flows. May be included for event "QFI_ALLOC". (NOTE 4) | QfiAllocation | +| flowDescs | array(FlowDescription) | O | 1..N | Descriptor(s) of IP traffic. It allows the encoding of multiple UL and/or DL flows. Each entry of the array describes a single IP flow. May be included for event "QFI_ALLOC", when the description of the IP traffic requires multiple UL and/or DL flows. (NOTE 4) | MultipleFlowDescriptions | +| fDescs | array(FlowDescription) | O | 1..2 | Contains the flow description for the Uplink and/or Downlink IP flows. May be included for event "QFI_ALLOC". (NOTE 4) | QfiAllocation | +| dnn | Dnn | C | 0..1 | Data network name, Shall be included for event "QFI_ALLOC". May be included for event "PDU_SES_REL" or "PDU_SES_EST". Shall be included to indicate the DNN associated with URLLC service for event "RED_TRANS_EXP". Shall be included if DNN based SMCC is applied. | QfiAllocation,
PduSessionStatus
RedundantTransmissionExp
SMCCE | +| snssai | Snssai | C | 0..1 | Identifies the slice information. Shall be included for event "QFI_ALLOC". Shall be included if S-NSSAI based SMCC is applied. | QfiAllocation
EneNA
SMCCE | +| ulDelays | array(Uinteger) | O | 1..N | Uplink packet delay in units of milliseconds. May be included for event "QOS_MON". (NOTE 5) | QoSMonitoring
E2eDataVolTransTime | +| dlDelays | array(Uinteger) | O | 1..N | Downlink packet delay in units of milliseconds. May be included for event "QOS_MON". (NOTE 5) | QoSMonitoring
E2eDataVolTransTime | +| ulCongInfo | Uinteger | O | 0..1 | Uplink congestion information. Percentage of packets that UPF uses for ECN marking for L4S (without "%" sign). (NOTE 10) | EnQoSMon | +| dlCongInfo | Uinteger | O | 0..1 | Downlink congestion information. | EnQoSMon | + +| | | | | | | +|--------------|------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| +| | | | | Percentage of packets that UPF uses for ECN marking for L4S (without "%" sign). (NOTE 10) | | +| cimf | boolean | O | 0..1 | Congestion information measurement failure indicator. When set to true, it indicates that a congestion information failure has occurred. Default value is false if omitted. (NOTE 10) | EnQoSMon | +| rtDelays | array(UInteger) | O | 1..N | Round trip delay in units of milliseconds. May be included for event "QOS_MON". (NOTE 5) | QoSMonitoring
E2eDataVolTransTime | +| ulDataRate | BitRate | O | 0..1 | Uplink data rate.(NOTE 12) | EnQoSMon | +| dlDataRate | BitRate | O | 0..1 | Downlink data rate.(NOTE 12) | EnQoSMon | +| timeWindow | TimeWindow | C | 0..1 | Time window representing a start time and a stop time of the data collection period. Shall be included for event "SMCC_EXP". | SMCCE | +| smNasFromUe | array(SmNasFromUe) | C | 1..N | Information on the SM NAS messages that SMF receives from UE for PDU Session. Shall be included for event "SMCC_EXP". | SMCCE | +| smNasFromSmf | array(SmNasFromSmf) | C | 1..N | Information on the SM congestion control applied SM NAS messages that SMF sends to UE for PDU Session. Shall be included for event "SMCC_EXP". | SMCCE | +| upRedTrans | boolean | C | 0..1 | Indicates whether the redundant transmission is setup or terminated. Set to "true" if the redundant transmission is setup, otherwise set to "false" if the redundant transmission is terminated. Default value is set to "false". Shall be included for event "RED_TRANS_EXP". | RedundantTransmissionExp | +| ssid | string | C | 0..1 | SSID that the PDU session is related to. (NOTE 6) | WlanPerformance | +| bssid | string | C | 0..1 | BSSID that the PDU session is related to. (NOTE 6) | WlanPerformance | +| startWlan | DateTime | C | 0..1 | The time stamp that indicates when the existing PDU Session's access type changes to WLAN or when the new PDU Session for WLAN is established. (NOTE 6) | WlanPerformance | +| endWlan | DateTime | C | 0..1 | The time stamp that indicates when the existing WLAN based PDU Session's access type is not WLAN any more or when the PDU Session for WLAN is released. (NOTE 6) | WlanPerformance | +| pduSessInfos | array(PduSessionInformation) | C | 1..N | The PDU session related information. It shall be included for event "UP_STATUS_INFO". | UeCommunication | +| upfInfo | UpfInformation | C | 0..1 | The information of the UPF serving the UE. Shall be included for event "UPF_INFO". | ServiceExperience
DnPerformance | +| pdmf | boolean | O | 0..1 | Packet delay measurement failure indicator. When set to true, it indicates that a packet delay failure has occurred, i.e. no measurement result is available during the reporting period. Default value is false if omitted. May be included for event | PacketDelayFailureReport | + +| | | | | | | +|-------------------|---------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| | | | | "QOS_MON". | | +| satBackhaulCat | SatelliteBackhaulCategory | C | 0..1 | The satellite backhaul category or non-satellite backhaul used for the PDU session shall be included for event "SATB_CH". | EnSatBackhaulCategoryChg | +| supportedFeatures | SupportedFeatures | C | 0..1 | List of negotiated features supported by the SMF and NF service consumer as described in clause 5.8.
This parameter shall be supplied by the SMF when the SMF detects that at least one feature related to an implicit subscription is supported by both the SMF and the NF service consumer. | | +| targetAfId | string | O | 0..1 | Identifier of the Application Function responsible for the target DNAI. May be included for event "UP_PATH_CH" if the target DNAI is not known to the source AF. | EasRelocationEnh | +| 5qi | 5Qi | O | 0..1 | The 5G QoS Identifier. May be included for event "QFI_ALLOC". | EnQfiAllocation | + +| | | +|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: | If the DNAI is not changed while the N6 traffic routing information is changed, the "sourceDnai" attribute and "targetDnai" attribute shall not be provided. | +| NOTE 2: | The change from the UP path status where no DNAI applies to a status where a DNAI applies indicates the activation of the related AF request and therefore only the target DNAI and N6 traffic routing information is provided in the event notification; the change from the UP path status where a DNAI applies to a status where no DNAI applies indicates the de-activation of the related AF request and therefore only the source DNAI and N6 traffic routing information is provided in the event notification. | +| NOTE 3: | If provided, either ipv6Prefixes or ipv6Addrs shall be present. | +| NOTE 4: | Only one of the appId, ethFDescs, ethFlowDescs, flowDescs or fDescs attributes shall be provided. | +| NOTE 5: | In this release of the specification the maximum number of elements in the array is 2. If more than one value is received at one given point of time for UL packet delay, DL packet delay or round trip packet delay respectively, the SMF reports the minimum and maximum packet delays to the NEF/AF. | +| NOTE 6: | If notified event is "WLAN_INFO", then one of the "ssid" or "bssid" attribute and one of the "startWLAN" or "endWLAN" attribute shall be present. | +| NOTE 7: | The SNPn Identifier consists of the PLMN Identifier and the NID. | +| NOTE 8: | When the subscribed event is "QFI_ALLOC" and the PduSessionInfo feature is supported, if the "pduSessionType" attribute and/or "sscMode" attribute is included, the associated "appId" attribute shall be provided. | +| NOTE 9: | If the "WlanPerformanceExt_AIML" feature is supported, the "supi" attribute may also be included for a single UE when the subscription applies to the "WLAN_INFO" event. | +| NOTE 10: | If the "cimf" attribute is set to true, "ulConInfo" and "dlConInfo" shall not be present. | +| NOTE 11: | If multiple Access Types are used for the PDU session and the "MultipleAccessTypes" feature is supported, the SMF shall include one Access Type in the "accType" attribute and the remaining Access Types in the "addAccTypes" attribute. | +| NOTE 12: | When the "ulDataRate" and/or "dlDataRate" attributes are present, the congestion related attributes and the packet delay related attributes shall not be present. | + +Editor's note: Whether the "ulCongInfo" and "dlCongInfo" attributes are single or plural is FFS. + +5.6.2.6 void. + +5.6.2.7 Type AckOfNotify + +Table 5.6.2.7-1: Definition of type AckOfNotify + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|-------------------------------------------------------------------------------------|---------------| +| notifId | string | M | 1 | Notification correlation ID provided by the SMF during UP path change notification. | | +| ackResult | AfResultInfo | M | 1 | Identifies the result of application layer handling. | | +| supi | Supi | O | 0..1 | Subscription Permanent Identifier. | | +| gpsi | Gpsi | O | 0..1 | Identifies a GPSI. | | + +5.6.2.8 Type SmNasFromUe + +Table 5.6.2.8-1: Definition of type SmNasFromUe + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------|---------------| +| smNasType | string | M | 1 | The type of SM NAS message transmitted by UE (e.g. PDU Session Establishment Request, PDU Session Modification Request, etc.). | | +| timeStamp | DateTime | M | 1 | Indicates the time stamp when SMF receives SM NAS message from UE. | | + +5.6.2.9 Type SmNasFromSmf + +Table 5.6.2.9-1: Definition of type SmNasFromSmf + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| smNasType | string | M | 1 | The type of SM NAS message with backoff timer provided to UE (e.g. PDU Session Establishment Reject, PDU Session Modification Reject, PDU Session Release Command, etc.). | | +| timeStamp | DateTime | M | 1 | Indicates the time stamp when SMF sends SM NAS message to UE. | | +| backOffTimer | DurationSec | M | 1 | Indicates the value of backoff timer provided to UE in terms of time units of seconds. | | +| appliedSmccType | AppliedSmccType | M | 1 | The type of applied SM congestion control, i.e. DNN based congestion control or S-NSSAI based congestion control. | | + +#### 5.6.2.10 Type TransactionInfo + +Table 5.6.2.10-1: Definition of type TransactionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|---------------------------------------------------|---------------| +| transaction | UInteger | M | 1 | Number of transactions. | | +| snssai | Snssai | C | 0..1 | Identifier of the network slice. | | +| appIds | array(ApplicationId) | O | 1..N | Application Identifiers. | | +| transMetrics | array(TransactionMetric) | O | 1..N | Indicates Session Management Transaction metrics. | | + +#### 5.6.2.11 Type PduSessionInformation + +Table 5.6.2.11-1: Definition of type PduSessionInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|--------------------------------------------------------------------|---------------| +| pduSessionId | PduSessionId | C | 0..1 | Identification of PDU Session. It shall be provided if available. | | +| sessInfo | PduSessionInfo | C | 0..1 | Represents session information. It shall be provided if available. | | + +#### 5.6.2.12 Type PduSessionInfo + +Table 5.6.2.12-1: Definition of type PduSessionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|-------------------------------------------------------------------------------|---------------| +| n4SessionId | string | C | 0..1 | Identification of N4 Session. It shall be provided if available. | | +| sessInactiveTime | DurationSec | C | 0..1 | The value of the session inactivity timer. It shall be provided if available. | | +| pduSessionStatus | PduSessionStatus | C | 0..1 | Status of the PDU Session. It shall be provided if available. | | + +#### 5.6.2.13 Type UpfInformation + +Table 5.6.2.13-1: Definition of type UpfInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------------|---------------| +| upfId | string | C | 0..1 | Identifies the UPF.
(NOTE 1) (NOTE 2) | | +| upfAddr | AddrFqdn | C | 0..1 | Represents the IP address/FQDN of the UPF.
(NOTE 1) (NOTE 2) | | + +NOTE 1: At least one of the "upfId" attribute and "upfAddr" attribute shall be included. + +NOTE 2: The "upfId" attribute and "upfAddr" attribute may indicate an anchor UPF of the PDU session containing the QoS flow. + +#### 5.6.2.14 Type: TrafficCorrelationNotification + +**Table 5.6.2.14-1: Definition of type TrafficCorrelationNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|---------------------------------------------------------------------------------------------|---------------| +| smfId | NfInstanceId | M | 1 | Identifies the SMF Id sending the notification. | | +| tfCorrId | string | M | 1 | Identification of traffic correlation. | | +| dnais | array(Dnai) | C | 1..N | Identification(s) of user plane access to DN(s) which the subscription applies.
(NOTE 2) | | +| easFqdn | Fqdn | C | 0..1 | The Fqdn of the EAS.
(NOTE 1) (NOTE 2) | | +| easIpAddr | IpAddr | C | 0..1 | Indicates the EAS IP address based on EASDF procedure.
(NOTE 1) (NOTE 2) | | +| pduSessionNbr | Uinteger | M | 1 | Indicates the number of PDU sessions that the SMF is serving for the UE(s). | | + +NOTE 1: The "easFqdn" attribute and the "easIpAddr" attribute are mutually exclusive. +NOTE 2: At least one of the "dnais" attribute and the EAS ID ("easFqdn" attribute or "easIpAddr" attribute) shall be provided. + +### 5.6.3 Simple data types and enumerations + +#### 5.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.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| SubId | string | Identifies an Individual SMF Notification Subscription. To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [5]. In an OpenAPI [10] schema, the format shall be designated as "SubId". | | + +#### 5.6.3.3 Enumeration: SmfEvent + +Table 5.6.3.3-1: Enumeration SmfEvent + +| Enumeration value | Description | Applicability | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| AC TY CH | Access Type Change | | +| UP_PATH_CH | UP Path Change | | +| PDU_SES_REL | PDU Session Release | | +| PLMN_CH | PLMN Change | | +| UE_IP_CH | UE IP address change | | +| RAT TY_CH | RAT Type Change | EneNA | +| DDDS | Downlink data delivery status | DownlinkDataDeliveryStatus | +| COMM_FAIL | Communication failure | CommunicationFailure | +| PDU_SES_EST | PDU Session Establishment | PduSessionStatus | +| QFI_ALLOC | QFI allocation | QfiAllocation | +| QOS_MON | QoS Monitoring | QoSMonitoring | +| SMCC_EXP | SM congestion control experience for PDU Session | SMCCE | +| DISPERSION | Session Management transaction dispersion | Dispersion | +| RED_TRANS_EXP | Redundant transmission experience for PDU Session | RedundantTransmissionExp | +| WLAN_INFO | WLAN information on PDU session for which Access Type is NON_3GPP_ACCESS and RAT Type is TRUSTED_WLAN | WlanPerformance | +| UPF_INFO | The UPF information, including the UPF ID/address/FQDN information. | ServiceExperienceDnPerformance | +| UP_STATUS_INFO | User Plane status information | UeCommunication | +| UPF_EVENT | UPF event subscribed via SMF. (NOTE) | UPEAS | +| SATB_CH | Indicates that the SMF has detected a change between different satellite category, or non-satellite backhaul | EnSatBackhaulCategoryChg | +| TRAFFIC_CORRELATION | Indicates that the SMF provides 5GC determined traffic correlation information for a set of UEs identified by Traffic Correlation ID. | CommonEASDNI | + +NOTE: UPF\_EVENT shall only be used for "USER\_DATA\_USAGE\_MEASURES" and "USER\_DATA\_USAGE\_TRENDS" event types in 3GPP TS 29.564 [26]. + +#### 5.6.3.4 Enumeration: NotificationMethod + +The enumeration NotificationMethod represents the notification methods that can be subscribed. It shall comply with the provisions defined in table 5.6.3.4-1. + +Table 5.6.3.4-1: Enumeration NotificationMethod + +| Enumeration value | Description | Applicability | +|--------------------|-----------------------------------------------------------|---------------| +| PERIODIC | The notification is periodically sent. | | +| ONE_TIME | The notification is only sent one time. | | +| ON_EVENT_DETECTION | The notification is sent each time the event is detected. | | + +5.6.3.5 void. + +5.6.3.6 Enumeration: AppliedSmccType + +**Table 5.6.3.6-1: Enumeration AppliedSmccType** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------|---------------| +| DNN_CC | Indicates the DNN based congestion control. | | +| SNSSAI_CC | Indicates the S-NSSAI based congestion control. | | + +5.6.3.7 Enumeration: TransactionMetric + +**Table 5.6.3.7-1: Enumeration TransactionMetric** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------|---------------| +| PDU_SES_EST | PDU Session Establishment | | +| PDU_SES_AUTH | PDU Session Authentication | | +| PDU_SES_MODIF | PDU Session Modification | | +| PDU_SES_REL | PDU Session Release | | + +5.6.3.8 Enumeration: PduSessionStatus + +**Table 5.6.3.8-1: Enumeration PduSessionStatus** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------|---------------| +| ACTIVATED | Indicates the pdu session status is activated. | | +| DEACTIVATED | Indicates the pdu session status is deactivated. | | + +## 5.7 Error handling + +### 5.7.1 General + +For the Nsmf\_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 Nsmf\_EventExposure API. + +### 5.7.2 Protocol Errors + +No specific procedures for the Nsmf\_EventExposure service are specified. + +### 5.7.3 Application Errors + +The application errors defined for the Nsmf\_EventExposure service are listed in Table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------|------------------|------------------------------------------------------------------------------------------------------------| +| MUTING_INSTR_NOT_ACCEPTED | 403 Forbidden | Indicates that the muting instructions received by the NF service consumer cannot be accepted. | +| NO_ACTIVE_PCC_RULE | 403 Forbidden | Indicates that QoS monitoring cannot be performed because there is no PCC rule active for the application. | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Nsmf\_EventExposure API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +Table 5.8-1: Supported Features + +| Feature number | Feature Name | Description | +|----------------|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | DownlinkDataDeliveryStatus | This feature indicates support for the "Downlink data delivery status" event. | +| 2 | CommunicationFailure | This feature indicates support for the "communication failure" event. | +| 3 | PduSessionStatus | This feature indicates support for the PDU session establishment event and enhancement (PDU session type, IP address) for the PDU session release event. | +| 4 | QfiAllocation | This feature indicates support for the "QFI allocation" event. | +| 5 | QosMonitoring | This feature indicates support for the "QoS Monitoring" event. (NOTE 1) | +| 6 | 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]. | +| 7 | EneNA | This feature indicates support for the enhancements of network data analytics requirements. | +| 8 | ULBuffering | This feature indicates support for Uplink buffering indication. (See NOTE 2) | +| 9 | SMCCE | This feature indicates support for Session Management Congestion Control Experience for PDU Session. | +| 10 | Dispersion | This feature indicates support for Session Management transactions dispersion. | +| 11 | ERIR | Indicates the support of immediate report of the available subscribed event(s) within the subscription response to the NF service consumer. | +| 12 | RedundantTransmissionExp | This feature indicates support for Redundant Transmission Experience. | +| 13 | WlanPerformance | This feature indicates support for WLAN information on PDU Session for which Access Type is NON_3GPP_ACCESS and RAT Type is TRUSTED_WLAN, to support WLAN performance analytics. | +| 14 | EASIPreplacement | This feature indicates the support of provisioning of EAS IP replacement info (See NOTE 2). | +| 15 | BIUMR | This feature bit indicates whether the NF Service Consumer (e.g. SMF) and PCF supports Binding Indication Update for multiple resource contexts specified in clauses 6.12.1 and 5.2.3.2.6 of 3GPP TS 29.500 [4]. | +| 16 | UeCommunication | This feature indicates the support of UE communication analytics. | +| 17 | ServiceExperience | This feature indicates support for service experience analytics. | +| 18 | DnPerformance | This feature indicates support for DN performance analytics. | +| 19 | MultipleFlowDescriptions | This feature indicates the support of the report of multiple UL and/or DL flows. | +| 20 | PacketDelayFailureReport | This feature indicates the support of packet delay failure report as part of QoS Monitoring procedures. This feature requires that QosMonitoring feature is supported. | +| 21 | CommonEASDNAI | This feature indicates support of enhancements of UP path change event notification. (NOTE 1) | +| 22 | PduSessionInfo | This feature indicates support for PDU Session parameters information. | +| 23 | EnhDataMgmt | Indicates the support of enhanced data management mechanisms. Supporting this feature also requires the support of feature EneNA. | +| 24 | WlanPerformanceExt_AIML | This feature indicates support for the enhancements of WLAN performance supporting AIML, including support of analytics per UE granularity. Supporting this feature also requires the support of feature WlanPerformance. | +| 25 | EasRelocationEnh | This feature indicates enhanced support of EAS relocation procedures via additional information about the AFs that are responsible for certain EAS. | +| 26 | UPEAS | This feature indicates the support of UPF enhancements for exposure. | + +| | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 27 | EnSatBackhaulCategoryChg | This feature indicates the support of notification of a change between different satellite backhaul categories, or dynamic satellite backhaul categories, or between satellite backhaul and non-satellite backhaul. | +| 28 | E2eDataVolTransTime | This feature indicates support for E2E data volume transfer time analytics. | +| 29 | XRM_5G | This feature indicates the support of multi-modal communication service for extended reality (XR) and interactive media services. | +| 30 | AreaFilter | This feature indicates support for using an area as a subscription filter. | +| 31 | MultipleAccessTypes | This feature indicates the support of providing list of Access Type(s) used for the PDU Session. | +| 32 | EnQfiAllocation | Indicates the enhancement on "QFI allocation" event. Supporting this feature also requires the support of feature QfiAllocation. | +| 33 | EnQoSMon | This feature indicates the support of enhanced QoS monitoring functionality, i.e. the report of the congestion information, and/or, the data rate information monitoring. | +| NOTE 1: SMF determines the support of this feature by the NF service consumer as part of the implicit subscription information provided by the PCF as described in 3GPP TS 29.512 [14] for the "UP_PATH_CH" event and "TRAFFIC_CORRELATION" event. | | | +| NOTE 2: NF service consumers determine the support of this feature as part of the notification of the implicitly subscribed events as described in clause 4.2.2.2. | | | + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [15] and 3GPP TS 29.500 [4], the access to the Nsmf\_EventExposure API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [16]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nsmf\_EventExposure API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], 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 Nsmf\_EventExposure service. + +The Nsmf\_EventExposure API defines a single scope "nsmf-event-exposure" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +The present Annex contains an OpenAPI [10] specification of HTTP messages and content bodies used by the Nsmf\_EventExposure API. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [19] and clause 5.3.1 of the 3GPP TS 29.501 [5] for further information). + +## A.2 Nsmf\_EventExposure API + +``` +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.5 + title: Nsmf_EventExposure + description: | + Session Management Event Exposure Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.508 V18.4.0; 5G System; Session Management Event Exposure Service. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.508/ + +servers: + - url: '{apiRoot}/nsmf-event-exposure/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nsmf-event-exposure + +paths: + /subscriptions: + post: + operationId: CreateIndividualSubscription + summary: Create an individual subscription for event notifications from the SMF + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + responses: + '201': + description: Created. + headers: + Location: + description: > +``` + +``` + + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId} + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposureNotification' + responses: + '204': + description: No Content, Notification was successful. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + afAcknowledgement: + '{request.body#/ackUri}': + post: + +``` + +``` + + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AckOfNotify' + responses: + '204': + description: No Content (successful acknowledgement) + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subId}: + get: + operationId: GetIndividualSubscription + summary: Read an individual subscription for event notifications from the SMF + tags: + - IndividualSubscription (Document) + parameters: + - name: subId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + +``` + +``` +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + operationId: ReplaceIndividualSubscription + summary: Replace an individual subscription for event notifications from the SMF + tags: + - IndividualSubscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + parameters: + - name: subId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource was successfully modified and representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + '204': + description: No Content. Resource was successfully modified + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + operationId: DeleteIndividualSubscription + summary: Delete an individual subscription for event notifications from the SMF + tags: + - IndividualSubscription (Document) + parameters: + - name: subId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +``` + +``` +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nsmf-event-exposure: Access to the Nsmf_EventExposure API + +schemas: + + NsmfEventExposure: + description: > + Represents an Individual SMF Notification Subscription resource. The serviceName property + corresponds to the serviceName in the main body of the specification. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + anyUeInd: + type: boolean + description: > + Any UE indication. This IE shall be present if the event subscription is applicable to + any UE. Default value "false" is used, if not present. + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + pduSeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + ssid: + type: string + description: SSID that the PDU session is related to. + bssId: + type: string + description: BSSID that the PDU session is related to. + upfId: + type: string + description: UPF identity. + nfid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + subId: + $ref: '#/components/schemas/SubId' + notifId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + altNotifIpv4Addrs: + type: array + items: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +description: Alternate or backup IPv4 address(es) where to send Notifications. +minItems: 1 +altNotifIpv6Addrs: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' +description: Alternate or backup IPv6 address(es) where to send Notifications. +minItems: 1 +altNotifFqdns: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +minItems: 1 +description: Alternate or backup FQDN(s) where to send Notifications. +eventSubs: +type: array +items: + $ref: '#/components/schemas/EventSubscription' +minItems: 1 +description: Subscribed events +eventNotifs: +type: array +items: + $ref: '#/components/schemas/EventNotification' +minItems: 1 +ImmeRep: +type: boolean +notifMethod: +$ref: '#/components/schemas/NotificationMethod' +maxReportNbr: +$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' +expiry: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +repPeriod: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +guami: +$ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' +serviveName: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' +supportedFeatures: +$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +sampRatio: +$ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' +partitionCriteria: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartitioningCriteria' +minItems: 1 +description: Criteria for partitioning the UEs before applying the sampling ratio. +grpRepTime: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +notifFlag: +$ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationFlag' +notifFlagInstruct: +$ref: 'TS29571_CommonData.yaml#/components/schemas/MutingExceptionInstructions' +mutingSetting: +$ref: 'TS29571_CommonData.yaml#/components/schemas/MutingNotificationsSettings' +defQosSupp: +type: boolean +description: > + Indicates whether the NF service consumer requests to receive QoS Flow performance + information for the QoS Flow associated with the default QoS rule if there are no + measurements available for the provided Application Identifier included in the appIds + attribute. +qosMonPending: +type: boolean +description: > + Indicates that the reporting will be activated when the measurements are enabled by a + PCC rule. It shall always be set to true when present. It may only be provided in the + response. +required: +- notifId +- notifUri +- eventSubs + +NsmfEventExposureNotification: +description: Represents notifications on events that occurred. +``` + +``` +type: object +properties: + notifId: + type: string + description: Notification correlation ID + eventNotifs: + type: array + items: + $ref: '#/components/schemas/EventNotification' + minItems: 1 + description: Notifications about Individual Events + ackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + required: + - notifId + - eventNotifs + +EventSubscription: + description: Represents a subscription to a single event. + type: object + properties: + event: + $ref: '#/components/schemas/SmfEvent' + dnaIChgType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType' + dddTraDescriptors: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' + minItems: 1 + dddStati: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' + minItems: 1 + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + targetPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + transacDispInd: + type: boolean + description: > + Indicates the subscription for UE transaction dispersion collectionon, if it is included + and set to "true". Default value is "false". + transacMetrics: + type: array + items: + $ref: '#/components/schemas/TransactionMetric' + description: Indicates Session Management Transaction metrics. + minItems: 1 + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + upfEvents: + type: array + items: + $ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/UpfEvent' + description: Indicates UPF event exposure information. + minItems: 1 + required: + - event + +EventNotification: + description: Represents a notification related to a single event that occurred. + type: object + properties: + event: + $ref: '#/components/schemas/SmfEvent' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' +``` + +``` +ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' +transacInfos: + type: array + items: + $ref: '#/components/schemas/TransactionInfo' + description: Transaction Information. + minItems: 1 +sourceDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' +targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' +dnaiChgType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType' +candidateDnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + description: The candidate DNAI(s) for the PDU Session. +candDnaisPrioInd: + type: boolean + description: > + If provided and set to true, it indicates that the candidate DNAIs provided + in the candidateDnais attribute are in descending priority order, i.e., + the lower the array index the higher the priority of the respective DNAI. + If omitted, the default value is false. +easRediscoverInd: + type: boolean + description: > + Indication of EAS re-discovery. If present and set to "true", it indicates the EAS + re-discovery is performed, e.g. due to change of common EAS. Default value is "false" if + omitted. +trafCorreInfo: + $ref: '#/components/schemas/TrafficCorrelationNotification' +sourceUeIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +sourceUeIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +targetUeIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +targetUeIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +sourceTraRouting: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' +targetTraRouting: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' +ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' +adIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +adIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +reIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +reIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +accType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' +pduAccTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 +pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' +ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +dddStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' +dddTraDescriptor: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' +maxWaitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +commFailure: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CommunicationFailure' +``` + +``` +ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +ipv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 +ipv6Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 +pduSessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' +sscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' +qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' +appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' +ethFlowDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + description: > + Descriptor(s) for non-IP traffic. It allows the encoding of multiple UL and/or DL flows. + Each entry of the array describes a single Ethernet flow. +ethfDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + maxItems: 2 + description: > + Contains the UL and/or DL Ethernet flows. Each entry of the array describes a single + Ethernet flow. +flowDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + description: > + Descriptor(s) for IP traffic. It allows the encoding of multiple UL and/or DL flows. + Each entry of the array describes a single IP flow. +fDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + maxItems: 2 + description: > + Contains the UL and/or DL IP flows. Each entry of the array describes a single + IP flow. +dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +ulDelays: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 +dlDelays: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 +rtDelays: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 +ulCongInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +dlCongInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +cimf: +``` + +``` + type: boolean + description: Represents the congestion information measurement failure indicator. + ulDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + timeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + smNasFromUe: + $ref: '#/components/schemas/SmNasFromUe' + smNasFromSmf: + $ref: '#/components/schemas/SmNasFromSmf' + upRedTrans: + type: boolean + description: > + Indicates whether the redundant transmission is setup or terminated. Set to "true" if + the redundant transmission is setup, otherwise set to "false" if the redundant + transmission is terminated. Default value is set to "false". + ssId: + type: string + bssId: + type: string + startWlan: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endWlan: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + pduSessionInfos: + type: array + items: + $ref: '#/components/schemas/PduSessionInformation' + minItems: 1 + upfInfo: + $ref: '#/components/schemas/UpfInformation' + pdmf: + type: boolean + description: Represents the packet delay measurement failure indicator. + satBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + targetAfId: + type: string + description: Identifier of the Application Function responsible for the target DNAI. + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + required: + - event + - timeStamp + not: + required: [ipv6Prefixes, ipv6Addrs] + +SubId: + type: string + format: SubId + description: > + Identifies an Individual SMF Notification Subscription. To enable that the value is used as + part of a URI, the string shall only contain characters allowed according to the + "lower-with-hyphen" naming convention defined in 3GPP TS 29.501. In an OpenAPI schema, the + format shall be designated as "SubId". + +AckOfNotify: + description: Represents an acknowledgement information of an event notification. + type: object + properties: + notifId: + type: string + ackResult: + $ref: 'TS29522_TrafficInfluence.yaml#/components/schemas/AfResultInfo' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + required: + - notifId + - ackResult + +SmNasFromUe: + description: > +``` + +``` + Represents information on the SM NAS messages that SMF receives from UE for PDU Session. + type: object + properties: + smNasType: + type: string + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - smNasType + - timeStamp + +SmNasFromSmf: + description: > + Represents information on the SM congestion control applied SM NAS messages that SMF sends + to UE for PDU Session. + type: object + properties: + smNasType: + type: string + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + backoffTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + appliedSmccType: + $ref: '#/components/schemas/AppliedSmccType' + required: + - smNasType + - timeStamp + - backoffTimer + - appliedSmccType + +TransactionInfo: + description: Represents SMF Transaction Information. + type: object + properties: + transaction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + transacMetrics: + type: array + items: + $ref: '#/components/schemas/TransactionMetric' + minItems: 1 + required: + - transaction + +PduSessionInformation: + description: Represents the PDU session related information. + type: object + properties: + pduSessId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + sessInfo: + $ref: '#/components/schemas/PduSessionInfo' + +PduSessionInfo: + description: Represents session information. + type: object + properties: + n4SessId: + type: string + description: The identifier of the N4 session for the reported PDU Session. + sessInactiveTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + pduSessStatus: + $ref: '#/components/schemas/PduSessionStatus' + +UpfInformation: + description: Represents the ID/address/FQDN of the UPF. + type: object + properties: + upfId: +``` + +``` +type: string +upfAddr: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' + +TrafficCorrelationNotification: + description: Represents notifications for 5GC determined Traffic Correlation Information. + type: object + properties: + smfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + tfcCorrId: + type: string + description: > + Identification of a set of UEs accessing the application identified by the + Application Identifier or traffic filtering information. + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + easFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + easIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + pduSessionNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + required: + - smfId + - pduSessionNbr + - tfcCorrId + anyOf: + - required: [dnais] + - anyOf: + - required: [easFqdn] + - required: [easIpAddr] + +SmfEvent: + anyOf: + - type: string + enum: + - AC TY_CH + - UP_PATH_CH + - PDU_SES_REL + - PLMN_CH + - UE_IP_CH + - RAT TY_CH + - DDDS + - COMM_FAIL + - PDU_SES_EST + - QFI_ALLOC + - QOS_MON + - SMCC_EXP + - DISPERSION + - RED_TRANS_EXP + - WLAN_INFO + - UPF_INFO + - UP_STATUS_INFO + - SATB_CH + - TRAFFIC_CORRELATION + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration and is not used to encode + content defined in the present version of this API. + description: | + Represents the types of events that can be subscribed. + Possible values are: + - AC TY_CH: Access Type Change. + - UP_PATH_CH: UP Path Change. + - PDU_SES_REL: PDU Session Release. + - PLMN_CH: PLMN Change. + - UE_IP_CH: UE IP address change. + - RAT TY_CH: RAT Type Change. + - DDDS: Downlink data delivery status. + - COMM_FAIL: Communication Failure. + - PDU_SES_EST: PDU Session Establishment. + - QFI_ALLOC: QFI allocation. + - QOS_MON: QoS Monitoring. +``` + +- SMCC\_EXP: SM congestion control experience for PDU Session. +- DISPERSION: Session Management transaction dispersion. +- RED\_TRANS\_EXP: Redundant transmission experience for PDU Session. +- WLAN\_INFO: WLAN information on PDU session for which Access Type is NON\_3GPP\_ACCESS and RAT Type is TRUSTED\_WLAN. +- UPF\_INFO: The UPF information, including the UPF ID/address/FQDN information. +- UP\_STATUS\_INFO: The User Plane status information. +- SATB\_CH: Satellite backhaul category change. +- TRAFFIC\_CORRELATION: Indicates that the SMF provides 5GC determined traffic correlation information for a set of UEs identified by Traffic Correlation ID. + +### NotificationMethod: + +anyOf: + +- type: string +enum: + - PERIODIC + - ONE\_TIME + - ON\_EVENT\_DETECTION +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | +Represents the notification methods that can be subscribed. +Possible values are: + +- PERIODIC +- ONE\_TIME +- ON\_EVENT\_DETECTION + +### AppliedSmccType: + +anyOf: + +- type: string +enum: + - DNN\_CC + - SNSSAI\_CC +- type: string +description: > +This string indicates the type of applied SM congestion control. +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | +Represents the type of applied SM congestion control. +Possible values are: + +- DNN\_CC: Indicates the DNN based congestion control. +- SNSSAI\_CC: Indicates the S-NSSAI based congestion control. + +### TransactionMetric: + +anyOf: + +- type: string +enum: + - PDU\_SES\_EST + - PDU\_SES\_AUTH + - PDU\_SES\_MODIF + - PDU\_SES\_REL +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | +Represents the metric on UE Session Management transactions. +Possible values are: + +- PDU\_SES\_EST: PDU Session Establishment +- PDU\_SES\_AUTH: PDU Session Authentication +- PDU\_SES\_MODIF: PDU Session Modification +- PDU\_SES\_REL: PDU Session Release + +### PduSessionStatus: + +anyOf: + +- type: string +enum: + - ACTIVATED + - DEACTIVATED +- type: string +description: > + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | +Represents the status of the PDU Session. +Possible values are: +- ACTIVATED: PDU Session status is activated. +- DEACTIVATED: PDU Session status is deactivated. + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | | | | | | TS skeleton of Session Management Event Exposure Service specification | 0.0.0 | +| 2017-10 | CT3#92 | | | | | C3-175326, C3-175327 and C3-175281 | 0.1.0 | +| 2017-12 | CT3#93 | | | | | C3-176071, C3-176240, C3-176316, C3-176242, C3-176243, C3-176244, C3-176317 and C3-176318 | 0.2.0 | +| 2018-01 | CT3#94 | | | | | C3-180034, C3-180196 and C3-180197 | 0.3.0 | +| 2018-03 | CT3#95 | C3-181366 | | | | Inclusion of P-CRs agreed in CT3#95:
C3-181214, C3-181215, C3-181216, C3-181217, C3-181354, C3-181353. | 0.4.0 | +| 2018-04 | CT3#96 | | | | | C3-182315, C3-182316, C3-182144, C3-182317 | 0.5.0 | +| 2018-05 | CT3#97 | | | | | C3-183452, C3-183451, C3-183829, C3-183453, C3-183454, C3-183283 and C3-183455. | 0.6.0 | +| 2018-06 | CT#80 | CP-181039 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181039 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 2 | F | DNAI change notification type | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0002 | 4 | F | Completion of Error Codes in OpenAPI file | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0003 | | F | Definition of DNAI | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | 2 | F | Stateless AMF support updates | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0007 | 1 | F | Encoding of the "N6 traffic routing information" | 15.1.0 | +| 2018-09 | CT#81 | CP-182033 | 0008 | 2 | F | Addition of Time Stamp | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0009 | 1 | F | Update of resource figure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0010 | | F | Update of resource figure | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0011 | 6 | F | Correction to the event subscription | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0012 | 4 | F | Correction to the AF influence traffic steering control | 15.2.0 | +| 2018-12 | CT#82 | CP-183137 | 0013 | 5 | F | Immediate reporting flag | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0014 | 2 | F | UE ID in the notification | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0015 | 1 | F | Correction to the overview | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0016 | 2 | F | Correction to the NF consumer | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0017 | 1 | F | Location Header | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0018 | | F | Data for notification | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0019 | 1 | F | NotificationMethod | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0020 | 1 | F | Correction of apiName | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0021 | | F | Default value for apiRoot | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0023 | | F | API version | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0024 | 1 | F | ExternalDocs OpenAPI field | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0025 | | F | Location header field in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0026 | 1 | F | Security | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0027 | | F | supported content types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0028 | 2 | F | HTTP Error responses | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0029 | 1 | F | Monitoring identities | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0030 | | F | Correction to the names of data types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0031 | | F | Report of Ethernet UE address | 15.2.0 | +| 2019-03 | CT#83 | CP-190117 | 0032 | 1 | F | Correction of name of security scope | 15.3.0 | +| 2019-03 | CT#83 | CP-190117 | 0033 | 2 | F | API version update for Rel-15 | 15.3.0 | +| 2019-03 | CT#83 | CP-190117 | 0034 | 1 | F | Correction of URIs in resource structure table and figure | 15.3.0 | +| 2019-06 | CT#84 | CP-191074 | 0037 | 3 | F | Correct condition for DNAI in UP path change | 15.4.0 | +| 2019-06 | CT#84 | CP-191074 | 0038 | 1 | F | Precedence of OpenAPI file | 15.4.0 | +| 2019-06 | CT#84 | CP-191074 | 0041 | 1 | F | Correction of Misplaced Location header in OpenAPI file | 15.4.0 | +| 2019-06 | CT#84 | CP-191074 | 0043 | 2 | F | API version Update | 15.4.0 | +| 2019-06 | CT#84 | CP-191074 | 0044 | 1 | F | Copyright Note in YAML file | 15.4.0 | +| 2019-06 | CT#84 | CP-191070 | 0039 | 3 | B | Downlink data delivery status event | 16.0.0 | +| 2019-06 | CT#84 | CP-191071 | 0040 | 3 | B | AF acknowledgement of UP path event notification | 16.0.0 | +| 2019-06 | CT#84 | CP-191101 | 0042 | 2 | F | API version Update | 16.0.0 | +| 2019-09 | CT#85 | CP-192169 | 0045 | | B | Add communication failure event | 16.1.0 | +| 2019-09 | CT#85 | CP-192141 | 0046 | 1 | A | Correct SMF event exposure service name | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0047 | 1 | B | Enhancement of event reporting information | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0048 | 2 | B | Support for Service Experience | 16.1.0 | +| 2019-09 | CT#85 | CP-192159 | 0049 | 1 | B | I-SMF notification to SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192220 | 0050 | 3 | B | Notification of downlink data delivery status | 16.1.0 | +| 2019-09 | CT#85 | CP-192138 | 0051 | 2 | B | AF acknowledgement of UP path event notification | 16.1.0 | +| 2019-09 | CT#85 | CP-192173 | 0054 | | F | OpenAPI version update for TS 29.508 Rel-16 | 16.1.0 | +| 2019-12 | CT#86 | CP-193183 | 0056 | | A | Usage of the "serviveName" attribute | 16.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------|--------| +| 2019-12 | CT#86 | CP-193197 | 0057 | | F | Data type of the "serviceName" attribute | 16.2.0 | +| 2019-12 | CT#86 | CP-193181 | 0058 | 1 | B | OpenAPI file update to support AF acknowledgement | 16.2.0 | +| 2019-12 | CT#86 | CP-193181 | 0059 | 3 | F | Update of AFRelocationAck feature | 16.2.0 | +| 2019-12 | CT#86 | CP-193201 | 0060 | 1 | B | I-SMF applicable event | 16.2.0 | +| 2019-12 | CT#86 | CP-193183 | 0062 | 1 | A | Correction on 307 error, 29.508 | 16.2.0 | +| 2019-12 | CT#86 | CP-193212 | 0064 | | F | Update of API version and TS version in OpenAPI file | 16.2.0 | +| 2020-03 | CT#87e | CP-200220 | 0065 | 1 | B | Update of the Availability after DDN Failure event | 16.3.0 | +| 2020-03 | CT#87e | CP-200230 | 0066 | 1 | B | Update of the DDD status event | 16.3.0 | +| 2020-03 | CT#87e | CP-200202 | 0067 | 1 | B | QoS Monitoring Report | 16.3.0 | +| 2020-03 | CT#87e | CP-200198 | 0068 | | B | Support PDU session establishment event | 16.3.0 | +| 2020-03 | CT#87e | CP-200198 | 0070 | | F | V-SMF applicable event | 16.3.0 | +| 2020-03 | CT#87e | CP-200241 | 0071 | 2 | B | QFI allocation event | 16.3.0 | +| 2020-03 | CT#87e | CP-200211 | 0072 | | F | DDD status for I-SMF | 16.3.0 | +| 2020-03 | CT#87e | CP-200216 | 0073 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-06 | CT#88e | CP-201210 | 0075 | 1 | F | Correction to the DDD status event | 16.4.0 | +| 2020-06 | CT#88e | CP-201246 | 0077 | 1 | F | Correct presence condition in event subscription | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0078 | 1 | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201210 | 0079 | | F | Monitoring event normalization in roaming case | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0080 | 1 | F | URI of the Nsmf_EventExposure service | 16.4.0 | +| 2020-06 | CT#88e | CP-201213 | 0081 | 1 | F | Correction to QoS Monitoring report | 16.4.0 | +| 2020-06 | CT#88e | CP-201216 | 0083 | | A | Notification Uri and subld resource URI | 16.4.0 | +| 2020-06 | CT#88e | CP-201216 | 0085 | 1 | A | OpenAPI: adding Location header field in 307 response | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0086 | 1 | B | FQDN of alternate or backup AMF | 16.4.0 | +| 2020-06 | CT#88e | CP-201210 | 0087 | | B | Add DNN and Slice filter | 16.4.0 | +| 2020-06 | CT#88e | CP-201210 | 0088 | | F | Correct presence condition for snssai | 16.4.0 | +| 2020-06 | CT#88e | CP-201213 | 0089 | 1 | F | Add missing event | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0092 | | F | Optionality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0093 | 1 | F | Supported headers, Resource Data type, Operation Name | 16.4.0 | +| 2020-06 | CT#88e | CP-201255 | 0095 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2020-09 | CT#89e | CP-202050 | 0096 | 1 | F | notifId used for QoS monitoring report | 16.5.0 | +| 2020-09 | CT#89e | CP-202048 | 0097 | | F | Correction to detection of downlink data delivery status change | 16.5.0 | +| 2020-09 | CT#89e | CP-202067 | 0100 | | F | Remove UP path change for I-SMF | 16.5.0 | +| 2020-09 | CT#89e | CP-202209 | 0101 | 1 | F | Subscribed delivery status | 16.5.0 | +| 2020-09 | CT#89e | CP-202073 | 0098 | | F | Successful status code | 17.0.0 | +| 2020-12 | CT#90e | CP-203139 | 0103 | 1 | A | Essential corrections and alignments | 17.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0105 | 1 | A | Storage of YAML files in 3GPP Forge | 17.1.0 | +| 2020-12 | CT#90e | CP-203108 | 0107 | | A | Correction to ddd status when the SMF buffers the data | 17.1.0 | +| 2020-12 | CT#90e | CP-203113 | 0110 | 1 | A | Corrections on resourceURI | 17.1.0 | +| 2020-12 | CT#90e | CP-203108 | 0112 | 1 | A | notifId provided by the UDM for CIoT events | 17.1.0 | +| 2021-03 | CT#91e | CP-210191 | 0115 | 1 | A | Support of stateless NFs | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0118 | | F | OpenAPI reference | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0119 | | F | Clarification on optional HTTP custom headers | 17.2.0 | +| 2021-03 | CT#91e | CP-210189 | 0121 | 1 | A | Correction to DDD status event detection | 17.2.0 | +| 2021-03 | CT#91e | CP-210189 | 0123 | | A | Correction to DDD status event subscription | 17.2.0 | +| 2021-03 | CT#91e | CP-210221 | 0124 | 1 | F | Ambiguous concept of NF service consumer terminology | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0125 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.2.0 | +| 2021-03 | CT#91e | CP-210194 | 0128 | | A | alignment of dnaiChgType attribute | 17.2.0 | +| 2021-03 | CT#91e | CP-210240 | 0130 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-06 | CT#92e | CP-211221 | 0131 | 2 | B | Partitioning criteria for applying sampling in specific UE partitions in SMF exposure | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0132 | 1 | B | Support of Mute Reporting | 17.3.0 | +| 2021-06 | CT#92e | CP-211200 | 0134 | 1 | A | Temporary and Permanent Redirection | 17.3.0 | +| 2021-06 | CT#92e | CP-211243 | 0135 | 1 | F | Removal of resource URI in Notification Acknowledgement procedure | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0136 | 1 | B | Nsmf_EventExposure supports RAT Type Change Event | 17.3.0 | +| 2021-06 | CT#92e | CP-211265 | 0138 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2021-09 | CT#93e | CP-212220 | 0139 | 1 | F | Correction of URI structure | 17.4.0 | +| 2021-09 | CT#93e | CP-212221 | 0141 | 1 | A | Missing PDU Session ID from QFI allocation event notifications | 17.4.0 | +| 2021-09 | CT#93e | CP-212198 | 0142 | 2 | B | Adding uplink buffering indication for Application Relocation | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0143 | 1 | F | Corrections for RAT Type exposure | 17.4.0 | +| 2021-09 | CT#93e | CP-212223 | 0144 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.4.0 | +| 2021-12 | CT#94e | CP-213227 | 0145 | 1 | B | Update input data collection for Slice load level information | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0146 | 2 | B | New event for SM congestion control experience | 17.5.0 | +| 2021-12 | CT#94e | CP-213238 | 0148 | | A | The of the Nsmf_EventExposure API | 17.5.0 | +| 2021-12 | CT#94e | CP-213223 | 0149 | 1 | B | Adding EAS IP replacement information in AppRelocationInfo | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0150 | 1 | B | Adding DCCF as SMF event exposure NF service consumer | 17.5.0 | +| 2021-12 | CT#94e | CP-213239 | 0151 | | F | Adding missing conditions on features for notifications about subscribed events | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0152 | | F | Handling of implicit subscriptions | 17.5.0 | +| 2021-12 | CT#94e | CP-213215 | 0154 | 1 | A | Essential correction to immediate report | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0155 | 1 | B | Transactions dispersion information collected from serving SMF | 17.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------|--------| +| 2021-12 | CT#94e | CP-213246 | 0156 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.5.0 | +| 2022-03 | CT#95e | CP-220195 | 0159 | 4 | B | Event report in the subscription response | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0161 | 1 | B | Support Redundant Transmission Experience | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0162 | 1 | B | Support new event on WLAN information | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0163 | 1 | F | Corrections related to SMCCE | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0164 | 1 | F | Corrections related to Dispersion | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0165 | 1 | D | Correction of SMCC and other abbreviations | 17.6.0 | +| 2022-03 | CT#95e | CP-220186 | 0166 | 1 | F | Handling of supported features for Edge Computing | 17.6.0 | +| 2022-03 | CT#95e | CP-220175 | 0168 | | A | Corrections related to URLLC | 17.6.0 | +| 2022-03 | CT#95e | CP-220201 | 0169 | | B | Updating Binding Indication for multiple resource contexts feature | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0170 | | B | Provide PDU session information for supporting the UE communication analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0171 | 1 | B | Support UPF information for service experience and DN performance analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220194 | 0172 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221154 | 0173 | 1 | F | Formatting of description fields | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0174 | | F | Using the common data type for FQDN | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0175 | | F | Inaccurate condition for immediate reporting | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0176 | | F | Correction to the notifFlag attribute in subscription modification | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0177 | | F | Completion of subscription modification procedure | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0178 | | F | missing applicable RED_TRANS_EXP event for targetPeriod attribute | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0179 | 1 | B | Resolve editor's note on Redundant Transmission Experience event | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0180 | | F | Corrections to SMCCE | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0181 | | F | Muting notifications correction | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0182 | 1 | F | Correction to the reported flows | 17.7.0 | +| 2022-06 | CT#96 | CP-221151 | 0183 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-09 | CT#97e | CP-222123 | 0184 | 1 | F | Alignment with the SBI template | 17.8.0 | +| 2022-12 | CT#98e | CP-223173 | 0186 | 1 | F | User Plane Status Information event handling | 17.9.0 | +| 2022-12 | CT#98e | CP-223177 | 0188 | | F | Adding support of SNPn | 17.9.0 | +| 2022-12 | CT#98e | CP-223188 | 0190 | | F | Update of info and externalDocs fields | 17.9.0 | +| 2022-12 | CT#98e | CP-223191 | 0187 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0189 | 1 | F | Enumeration definitions in the OpenAPI file | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0191 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230166 | 0192 | | F | Adding missing presence condition for IPv6 addresses and prefixes | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0196 | 1 | F | Clarification regarding maxReportNbr | 18.1.0 | +| 2023-03 | CT#99 | CP-230176 | 0197 | 1 | F | Correct the event name for downlink data delivery status | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0198 | | F | Corrections on subscription notification | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0199 | | F | Corrections on PDU Session Establishment | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0200 | | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230145 | 0202 | | A | Missing presence condition for transacInfos attribute | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0204 | | F | Alignment of packet delay report | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0209 | 1 | F | Support of indirect feature negotiation | 18.1.0 | +| 2023-03 | CT#99 | CP-230173 | 0211 | 1 | A | Correction on handling of Packet Delay Failure report Threshold | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0212 | | F | Corrections to attributes not respecting the naming convention | 18.1.0 | +| 2023-03 | CT#99 | CP-230137 | 0213 | 1 | B | Support of common DNAI selection by AF | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0217 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0215 | 2 | B | Support NWDAF assisted URSPs in Service Experience | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 0218 | 1 | B | Prioritization of candidate DNAIs | 18.2.0 | +| 2023-06 | CT#100 | CP-231136 | 0219 | 3 | B | Indicating target AF in UP path change events | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0220 | 1 | B | Event muting enhancements for SMF event exposure | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 0222 | 1 | B | Support NWDAF assisted URSPs in Service Experience | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 0225 | 1 | B | Complete common DNAI and EAS selection | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0226 | 1 | B | Enhancements to WLAN performance event | 18.2.0 | +| 2023-06 | CT#100 | CP-231157 | 0227 | 1 | B | Subscription to UPF notifications via SMF | 18.2.0 | +| 2023-06 | CT#100 | CP-231132 | 0228 | 1 | F | HTTP redirection clause correction | 18.2.0 | +| 2023-06 | CT#100 | CP-231183 | 0229 | 1 | B | Support of SMF event exposure related to dynamic satellite backhaul | 18.2.0 | +| 2023-06 | CT#100 | CP-231128 | 0230 | 1 | B | Input data support of End-to-end data volume transfer time analytics | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0231 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232250 | 0233 | 2 | B | Support of the Congestion Information Monitoring | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0234 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233225 | 0232 | 3 | B | Supporting data collection for PDU Session Traffic Analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0235 | 1 | B | Collect list of Access Types used for the PDU session from SMF | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0236 | 1 | B | Support of 5QI collection from SMF | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 0237 | 1 | F | Support of the new feature name EnQoSMon | 18.4.0 | +| 2023-12 | CT#102 | CP-233239 | 0238 | | B | Supporting SMF Traffic Correlation Notification | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0239 | | F | Update HTTP RFC 7540 obsoleted by IETF RFC 9113 | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------|--------| +| 2023-12 | CT#102 | CP-233249 | 0240 | | F | Corrections to the inputs of subscription to UPF events | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0241 | 1 | F | Update HTTP RFC 7807 obsoleted by IETF RFC 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233254 | 0242 | 1 | A | Correction of anyUeInd attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233249 | 0243 | 1 | B | Support of explicit QoS monitoring subscription | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0244 | | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29509/0f985b39edc1d52ba3600c438bc8f0a5_img.jpg b/raw/rel-18/29_series/29509/0f985b39edc1d52ba3600c438bc8f0a5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f23e66336a8252dc4bc92067bb155fb028213d12 --- /dev/null +++ b/raw/rel-18/29_series/29509/0f985b39edc1d52ba3600c438bc8f0a5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5ec24490d332fb557fa6946f1d992d90d32ef2a149aad01e9d1c69059e935431 +size 32660 diff --git a/raw/rel-18/29_series/29509/2b3a967f6ce4f23649be995a353e39f8_img.jpg b/raw/rel-18/29_series/29509/2b3a967f6ce4f23649be995a353e39f8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..144093e556fbcdfe090c77d21f729f0ad2ac7524 --- /dev/null +++ b/raw/rel-18/29_series/29509/2b3a967f6ce4f23649be995a353e39f8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7358ac5103829085d51171c4b06e40c001df0a5444758989e782b9173ae429df +size 109088 diff --git a/raw/rel-18/29_series/29509/40ebe9179df298f1b6d76822f28d90aa_img.jpg b/raw/rel-18/29_series/29509/40ebe9179df298f1b6d76822f28d90aa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5f2181595053e1f7af31f1a849b20fb3ef2d3494 --- /dev/null +++ b/raw/rel-18/29_series/29509/40ebe9179df298f1b6d76822f28d90aa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f8673f2f7c4dfd471889c1501a64224555e1d0a0e2d5e1d3d685b07b49a757ab +size 15589 diff --git a/raw/rel-18/29_series/29509/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29509/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3dbb4a640c64f7a6723d100ad20863a25f0778c8 --- /dev/null +++ b/raw/rel-18/29_series/29509/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:85768e31589c8c2a3356c2021a279ca4a0ef9302ace7d3bae68ef27a1544ddaf +size 9670 diff --git a/raw/rel-18/29_series/29509/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29509/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fa4bf93bf7ebe766f0322744bc43920af046bb1d --- /dev/null +++ b/raw/rel-18/29_series/29509/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e1826814a6c485939d3560fa3bf27f8008c6eba9ef507e14da09ce03ccfc61c6 +size 5750 diff --git a/raw/rel-18/29_series/29509/6efcea66501271e9ea36cf33982f08d5_img.jpg b/raw/rel-18/29_series/29509/6efcea66501271e9ea36cf33982f08d5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..beee877a928da32b9d2d360148578d4a1535a1b1 --- /dev/null +++ b/raw/rel-18/29_series/29509/6efcea66501271e9ea36cf33982f08d5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:03fb3b586de36fbd5d5876b7280f5bc46a02186c4c52b3d1d018ca3f26da276a +size 32351 diff --git a/raw/rel-18/29_series/29509/7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg b/raw/rel-18/29_series/29509/7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ee2e2370b47ea670f74cede03d0310d74fdae010 --- /dev/null +++ b/raw/rel-18/29_series/29509/7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b247f2614fd284c816be21670e8345aee89fc0460688d628b6533f2c1f2bf021 +size 55726 diff --git a/raw/rel-18/29_series/29509/afd9ce64c136f2090b978ea5f3ef9d8d_img.jpg b/raw/rel-18/29_series/29509/afd9ce64c136f2090b978ea5f3ef9d8d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..717f417c1bf61da3ab233817d34292663d233701 --- /dev/null +++ b/raw/rel-18/29_series/29509/afd9ce64c136f2090b978ea5f3ef9d8d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:44b46da01c150cb640ca32bdd3ddd02f0e82cd0c8b1dac60351a90bcf78bd1aa +size 105538 diff --git a/raw/rel-18/29_series/29509/c0e369274e53b2e5364666be6f786c7a_img.jpg b/raw/rel-18/29_series/29509/c0e369274e53b2e5364666be6f786c7a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e2b32c9cd1fb974dd528a4c1791eadee0f4c228a --- /dev/null +++ b/raw/rel-18/29_series/29509/c0e369274e53b2e5364666be6f786c7a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1944961f5ab805cecdb7ad7eed80c74295bf3104285a47ecc08db203dfdefc4a +size 30661 diff --git a/raw/rel-18/29_series/29509/c2fc2621e8206d24427b56bcb2398fc0_img.jpg b/raw/rel-18/29_series/29509/c2fc2621e8206d24427b56bcb2398fc0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5bca80148a0aba08d53fae0df36dd3de5e458b39 --- /dev/null +++ b/raw/rel-18/29_series/29509/c2fc2621e8206d24427b56bcb2398fc0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:809c33e9433f4451f212f725cbbaafbc9d49a3d434784d3d6ddaa5a9921a0f09 +size 34256 diff --git a/raw/rel-18/29_series/29509/cb4cfa42ce34febde7bdb882f3fc3094_img.jpg b/raw/rel-18/29_series/29509/cb4cfa42ce34febde7bdb882f3fc3094_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..16b126a0bb40226654bd7b3da63a146564b39e76 --- /dev/null +++ b/raw/rel-18/29_series/29509/cb4cfa42ce34febde7bdb882f3fc3094_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c8d07b91032fb821e2867c97d90ebdc6d6956ad92781781c853518b60474c9f +size 32117 diff --git a/raw/rel-18/29_series/29509/df82d77a0d2637cbf2da9ea920a554fa_img.jpg b/raw/rel-18/29_series/29509/df82d77a0d2637cbf2da9ea920a554fa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..96a74e7036325409d4a1d7f5599151756065a0fb --- /dev/null +++ b/raw/rel-18/29_series/29509/df82d77a0d2637cbf2da9ea920a554fa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e68617b8d5cea9c251998e117b46cebc88c8af1da01cc05a38683c60ea488cc7 +size 31849 diff --git a/raw/rel-18/29_series/29509/dfe556fea00682b09a59427aaf72051c_img.jpg b/raw/rel-18/29_series/29509/dfe556fea00682b09a59427aaf72051c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..60eb34556dc5b69588d91c36a698f262e31247b5 --- /dev/null +++ b/raw/rel-18/29_series/29509/dfe556fea00682b09a59427aaf72051c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5b8dd97136f31d26603327a8cd843ef4641f7aed8d11e534f593d6e14ccf6c7f +size 31061 diff --git a/raw/rel-18/29_series/29509/e636d7ccca0ad14c6b95201404324823_img.jpg b/raw/rel-18/29_series/29509/e636d7ccca0ad14c6b95201404324823_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2a2a65273a0f01424ccff26084027ea3fe1e9f61 --- /dev/null +++ b/raw/rel-18/29_series/29509/e636d7ccca0ad14c6b95201404324823_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f29432f62b3e4717a7a2b763a45375f1999705e7c21ce2a15f17cc32e6b46f2 +size 31305 diff --git a/raw/rel-18/29_series/29509/ec67eb0df9ed3c128f9bb311a2017bad_img.jpg b/raw/rel-18/29_series/29509/ec67eb0df9ed3c128f9bb311a2017bad_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d22cdb4514963b78a4838ea2f219d4e884ec371e --- /dev/null +++ b/raw/rel-18/29_series/29509/ec67eb0df9ed3c128f9bb311a2017bad_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8c3be4bb6d23d9cc1420cacc2847fb14d3180037f501bcddfec8008e278126c6 +size 15061 diff --git a/raw/rel-18/29_series/29509/eefe19c5e14dc4d6c316b7f7fbb7d7d7_img.jpg b/raw/rel-18/29_series/29509/eefe19c5e14dc4d6c316b7f7fbb7d7d7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8e3ba24fc70c0a9a652850ebc2722f3a05f064e8 --- /dev/null +++ b/raw/rel-18/29_series/29509/eefe19c5e14dc4d6c316b7f7fbb7d7d7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f39f12a678ddba9b2d594a756d980032d1eb4eecaf6e40d655ea3d8f6429267e +size 67530 diff --git a/raw/rel-18/29_series/29509/f6e8acf9f931452d01688d311b5c0364_img.jpg b/raw/rel-18/29_series/29509/f6e8acf9f931452d01688d311b5c0364_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7ae1aad27c11b4214dbccc515ee4d34f8e9b9de6 --- /dev/null +++ b/raw/rel-18/29_series/29509/f6e8acf9f931452d01688d311b5c0364_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:65b11acead2c0a6ff6a15803933ebd92c90020b689be179844a8cca7cc447478 +size 97683 diff --git a/raw/rel-18/29_series/29511/raw.md b/raw/rel-18/29_series/29511/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d25bacd6b87920e9b79e94ec3f85338bab3691a7 --- /dev/null +++ b/raw/rel-18/29_series/29511/raw.md @@ -0,0 +1,805 @@ + + +# 3GPP TS 29.511 V18.2.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Equipment Identity Register Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Overview..... | 7 | +| 4.1 Introduction ..... | 7 | +| 5 Services offered by the 5G-EIR NF..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 N5g-eir_EquipmentIdentityCheck Service ..... | 8 | +| 5.2.1 Service Description ..... | 8 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 CheckEquipmentIdentity ..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.2.2.2.2 Procedure using CheckEquipmentIdentity Operation..... | 9 | +| 6 API Definitions ..... | 9 | +| 6.1 N5g-eir_EquipmentIdentityCheck Service API..... | 9 | +| 6.1.1 API URI..... | 9 | +| 6.1.2 Usage of HTTP..... | 10 | +| 6.1.2.1 General..... | 10 | +| 6.1.2.2 HTTP standard headers..... | 10 | +| 6.1.2.2.1 General ..... | 10 | +| 6.1.2.2.2 Content type ..... | 10 | +| 6.1.2.3 HTTP custom headers..... | 10 | +| 6.1.2.3.1 General ..... | 10 | +| 6.1.3 Resources..... | 11 | +| 6.1.3.1 Overview..... | 11 | +| 6.1.3.2 Resource: equipmentStatus..... | 11 | +| 6.1.3.2.1 Description ..... | 11 | +| 6.1.3.2.2 Resource Definition..... | 11 | +| 6.1.3.2.3 Resource Standard Methods..... | 11 | +| 6.1.4 Data Model ..... | 13 | +| 6.1.4.1 General..... | 13 | +| 6.1.4.2 Structured data types..... | 13 | +| 6.1.4.2.1 Introduction ..... | 13 | +| 6.1.4.2.2 Type: EirResponseData..... | 13 | +| 6.1.4.3 Simple data types and enumerations..... | 14 | +| 6.1.4.3.1 Introduction ..... | 14 | +| 6.1.4.3.2 Simple data types ..... | 14 | +| 6.1.4.3.3 Enumeration: EquipmentStatus..... | 14 | +| 6.1.5 Error Handling ..... | 14 | +| 6.1.5.1 General..... | 14 | +| 6.1.5.2 Protocol Errors ..... | 14 | +| 6.1.5.3 Application Errors..... | 14 | +| 6.1.6 Feature Negotiation ..... | 14 | +| 6.1.7 Security ..... | 15 | +| 6.1.7.1 General..... | 15 | +| 6.1.7.2 Transport Layer Security Protection of Messages..... | 15 | +| 6.1.7.3 Authorization of 5G-EIR NF Service Access..... | 16 | +| 6.1.8 HTTP redirection..... | 16 | + +A.1 General..... 16 +A.2 N5g-eir\_EquipmentIdentityCheck Service API..... 16 + +# Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document describes the stage 3 protocol and data model for the N5g-eir Service Based Interface between the 5G-EIR and its consumers over which the service to check the equipment identity as described in 3GPP TS 23.501 [2] is performed. It provides the stage 3 protocol definitions and message flows, and specifies the API for each service offered by the 5G-EIR. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [7] IETF RFC 9113: "HTTP/2". +- [8] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", .[9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] IETF RFC 9457: "Problem Details for HTTP APIs". +- [11] 3GPP TS 33.501: "Security Architecture and Procedures for 5G System". +- [12] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [13] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". + +- [14] 3GPP TR 21.900: "Technical Specification Group working methods". +- [15] 3GPP TS 29.524: "5G System; Cause codes mapping between 5GC interfaces; Stage 3". + +# --- 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]. + +**N5g-eir:** Service-based interface exhibited by 5G-EIR + +## 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]. + +| | | +|--------|--------------------------------| +| 5G-EIR | 5G-Equipment Identity Register | +| EIR | Equipment Identity Register | +| PEI | Permanent Equipment Identifier | + +# --- 4 Overview + +## 4.1 Introduction + +N5g-eir is a Service-based interface exhibited by 5G-EIR (5G-Equipment Identity Register) which is an optional network function that supports the following functionality: + +- Check the status of Equipment's identity (e.g. to check that it has not been prohibited listed). + +The reference point N17 (see Fig 4-1 below) shows the interaction between the 5G-Equipment Identity Register 5G-EIR and the AMF (Access and Mobility Management Function) enabling the check of the status of the mobile equipment identity. + +![Diagram showing the interaction between AMF and 5G-EIR via the N17 / N5g-eir interface.](ba9d6e1a75eb6672d04e61a86e1b8a61_img.jpg) + +``` +graph LR; AMF[AMF] --- N17_N5g_eir[N17 / N5g-eir] --- 5G_EIR[5G-EIR]; +``` + +Diagram showing the interaction between AMF and 5G-EIR via the N17 / N5g-eir interface. + +**Figure 4-1: Reference Model – N5g-eir** + +During any procedure establishing a signalling connection with the UE the network may optionally perform an ME identity check with 5G-EIR via the N5g-eir\_Equipment Identity Check Service exhibited by 5G-EIR. + +# 5 Services offered by the 5G-EIR NF + +## 5.1 Introduction + +The following NF service is offered by the N5g-eir to check the ME whether it is prohibited listed or not: + +- N5g-eir\_EquipmentIdentityCheck + +**Table 5.1-1: NF Services provided by 5G-EIR** + +| Service Name | Description | Consumer | +|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| N5g-eir_EquipmentIdentityCheck | This service offered by the 5G-EIR allows the consumer to check the Permanent Equipment Identifier (PEI) and check whether the PEI is in the prohibited list or not. | AMF | + +The N5g-eir\_Equipment Identity Check service is specified in 3GPP TS 23.502 [3], clause 4.2.2.2.2 + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------------------------|--------|-----------------------------------------|---------------------------------------------|-------------|-------| +| N5g-eir_EquipmentIdentityCheck | 6.1 | 5G-EIR Equipment Identity Check Service | TS29511_N5g-eir_EquipmentIdentityCheck.yaml | n5g-eir-eic | A.2 | + +The N5g-eir\_Equipment Identity Check service is specified in 3GPP TS 23.502 [3], clause 4.2.2.2.2 + +## 5.2 N5g-eir\_EquipmentIdentityCheck Service + +### 5.2.1 Service Description + +The N5g-eir\_Equipment Identity Check service is provided by the 5G-EIR to check the Permanent Equipment Identifier (PEI) whether it is in the prohibited list or not. The service can be consumed by AMF which initiates ME identity check by invoking the N5g-eirEquipmentIdentityCheckGet service operation (see clause 5.2.4.2. of 3GPP TS 23.502 [3]). + +During the initial registration the Permanent Equipment Identifier is obtained from the UE. The AMF operator may check the PEI with an EIR. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +#### 5.2.2.2 CheckEquipmentIdentity + +##### 5.2.2.2.1 General + +The CheckEquipmentIdentity operation shall be used to check the PEI and determine whether the subscriber is allowed to use the equipment, in the following procedures: + +- ME Identity check procedure (see clause 4.7 of 3GPP TS 23.502 [3]); + +##### 5.2.2.2.2 Procedure using CheckEquipmentIdentity Operation + +The NF Service Consumer (e.g. AMF) shall check the PEI by using the HTTP GET method as shown in Figure 5.2.2.2.2-1. + +![Sequence diagram showing the PEI status check procedure. An NF service consumer sends a GET request to a 5G-EIR. The 5G-EIR responds with either a 200 OK (EirResponseData) or a 4xx/5xx (ProblemDetails) or 3xx status.](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant 5G-EIR + Note left of NF service consumer: 1. GET .../equipment-status?pei={pei}&supi={supi}&gpsi={gpsi} + NF service consumer->>5G-EIR: Request + Note right of 5G-EIR: 2a. 200 OK (EirResponseData) or 2b. 4xx/5xx (ProblemDetails) or 3xx + 5G-EIR-->>NF service consumer: Response + +``` + +Sequence diagram showing the PEI status check procedure. An NF service consumer sends a GET request to a 5G-EIR. The 5G-EIR responds with either a 200 OK (EirResponseData) or a 4xx/5xx (ProblemDetails) or 3xx status. + +**Figure 5.2.2.2.2-1: PEI status check by the NF Service Consumer** + +1. The NF Service Consumer (e.g. AMF) sends a GET request to the resource representing the PEI equipment Status. It shall include the PEI as a query parameter and, optionally, the SUPI and/or GPSI may also be included. +- 2a. On success, "200 OK" with the message body containing the equipment status of the PEI. +- 2b. If the PEI is not known, "404 Not Found" with the message body containing a ProblemDetails object, with the "details" attribute set to "ERROR\_EQUIPMENT\_UNKNOWN". When receiving the response from the 5G-EIR, the NF Service Consumer (e.g. AMF) shall check the equipment Status and the detailed problem. Dependent upon the result, the NF Service Consumer will decide its subsequent actions (e.g. sending a Registration Reject if the 5G-EIR indicates that the PEI is unknown or prohibited listed). + +The definition of the equipment-status resource is specified in clause 6.1.3. + +# 6 API Definitions + +## 6.1 N5g-eir\_EquipmentIdentityCheck Service API + +### 6.1.1 API URI + +The N5g-eir\_EquipmentIdentityCheck Service shall use the N5g-eir\_EquipmentIdentityCheck API. + +The API URI of the N5g-eir\_EquipmentIdentityCheck API shall be: + +{apiRoot}/ + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in subclause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "n5g-eir-eic". +- The shall be "v1". +- The shall be set as described in subclause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [7], 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]. + +HTTP messages and bodies for the N5g-eir\_EquipmentIdentityCheck Service shall comply with the OpenAPI [8] specification contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [9]. The use of the JSON format shall be signalled by the content type "application/json". See also clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [10]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +In this release of this specification, no custom headers specific to the N5g-eir\_EquipmentIdentityCheck Service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Diagram showing the resource URI structure. The root path is //{apiRoot}/n5g-eir-eic/. A line branches from this root to a box containing the specific resource path /equipment-status.](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +``` + + graph TD + Root[" //{apiRoot}/n5g-eir-eic/"] --> Box[ ] + Box --- Status["/equipment-status"] + style Box fill:none,stroke:none + +``` + +Diagram showing the resource URI structure. The root path is //{apiRoot}/n5g-eir-eic/. A line branches from this root to a box containing the specific resource path /equipment-status. + +**Figure 6.1.3.1-1: Resource URI structure of the n5g-eir-eic API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------|-------------------|---------------------------------|------------------------------------------| +| equipmentStatus | /equipment-status | GET | Retrieve the equipment status of the PEI | + +#### 6.1.3.2 Resource: equipmentStatus + +##### 6.1.3.2.1 Description + +This resource represents the equipmentStatus for a PEI. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/n5g-eir-eic//equipment-status + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| pei | Pei | M | 1 | The PEI of the UE shall be included for equipment identify checking | +| supi | Supi | O | 0..1 | The SUPI of the UE | +| gpsi | Gpsi | O | 0..1 | The GPSI of the UE | +| supported-features | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.6 is supported. | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EirResponseData | M | 1 | 200 OK | Upon success, a response body containing the Equipment Status shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The equipment identify checking has failed. The "cause" attribute may be used to indicate one of the following application errors:
- ERROR_EQUIPMENT_UNKNOWN
See table 6.1.5.3-1 for the description of this error. | + +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] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponses may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.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 of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.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 of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.4 Data Model + +#### 6.1.4.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.4.1-1 specifies the data types defined for the n5g-eir-eic service based interface protocol. + +**Table 6.1.4.1-1: n5g-eir-eic specific Data Types** + +| Data type | Clause defined | Description | +|-----------------|----------------|--------------------------------------------------------| +| EirResponseData | 6.1.4.2.2 | | +| EquipmentStatus | 6.1.4.3.3 | Equipment status of the PEI, this data type is string. | + +Table 6.1.6.1-2 specifies data types re-used by the N 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 N service based interface. + +**Table 6.1.4.1-2: 5g-eir-eic re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|--------------------|---------------------------------------------------------------------------------------------------------------| +| Pei | 3GPP TS 29.571 [6] | Data type representing the PEI of the UE. | +| Supi | 3GPP TS 29.571 [6] | Data type representing the SUPI of the subscriber.
pattern: See pattern of type Supi in 3GPP TS 29.571 [6] | +| ProblemDetails | 3GPP TS 29.571 [6] | Common data type for error responses | +| Gpsi | 3GPP TS 29.571 [6] | Data type representing the GPSI of the subscriber. | +| SupportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| RedirectResponse | 3GPP TS 29.571 [6] | Response body of the redirect response message. | + +#### 6.1.4.2 Structured data types + +##### 6.1.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.4.2.2 Type: EirResponseData + +**Table 6.1.4.2.2-1: Definition of type EirResponseData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|------------------| +| status | EquipmentStatus | M | 1 | Status of the UE | + +#### 6.1.4.3 Simple data types and enumerations + +##### 6.1.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.4.3.2 Simple data types + +The simple data types defined in table 6.1.4.3.2-1 shall be supported. + +**Table 6.1.4.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|---------------------------------------------------------------------|-------------| +| | | | + +##### 6.1.4.3.3 Enumeration: EquipmentStatus + +**Table 6.1.4.3.3-1: Enumeration EquipmentStatus** + +| Enumeration value | Description | +|-------------------|--------------------------------------------| +| "WHITELISTED" | Indicates the PEI is permitted whitelisted | +| "BLACKLISTED" | Indicates the PEI is prohibited listed | +| "GREYLISTED" | Indicates the PEI is tracking listed | + +### 6.1.5 Error Handling + +#### 6.1.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +The Cause codes mapping performed by AMF between the following HTTP responses returned by the EIR services to the AMF and the 5GMM related values is specified in clause 4.5.2 of 3GPP TS 29.524 [15]. + +#### 6.1.5.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.5.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the N5g-eir\_EquipmentIdentityCheck service, and the following application errors listed in Table 6.1.5.3-1 are specific for the N5g-eir\_EquipmentIdentityCheck service. + +**Table 6.1.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------------|------------------|--------------------------------------------------------| +| ERROR_EQUIPMENT_UNKNOWN | 404 Not Found | Indicate the mobile equipment is not known in the EIR. | + +### 6.1.6 Feature Negotiation + +The optional features in table 6.1.6-1 are defined for the N5g-eir\_EquipmentIdentityCheck API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.6-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the EquipmentIdentityCheck service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | + +### 6.1.7 Security + +#### 6.1.7.1 General + +The security mechanisms for service based interfaces are specified in clause 13 of 3GPP TS 33.501 [11] and in clause 6.7.3 of 3GPP TS 29.500 [4]. The access to the N5g-eir\_EquipmentIdentityCheck API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [12]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +The N5g-eir\_EquipmentIdentityCheck API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [11]; it defines a single scope consisting on the name of the service (i.e., "n5g-eir-eic"), and it does not define any additional scopes at resource or operation level. + +Security Protection Edge Proxy (SEPP), as specified in 3GPP TS 33.501 [11], shall be used between service based interfaces across PLMNs. The NFs in a PLMN shall use the SEPP as a HTTP/2 proxy for the HTTP/2 messages that carry ":authority" pseudo header with a uri-host formatted as specified in clause 6.1.4.3 of 3GPP TS 29.500 [4] + +#### 6.1.7.2 Transport Layer Security Protection of Messages + +As specified in clause 13.1 of 3GPP TS 33.501 [11], TLS shall be used for the security protection of messages at the transport layer for the N5g-eir service based interface if network security is not provided by other means. + +The protocol stack for the N5g-eir service based interface is shown on Figure 6.1.7.2-1. + +![Figure 6.1.7.2-1: SBI Protocol Stack diagram showing a vertical stack of layers: Application, HTTP/2, TLS (dashed box), TCP, IP, and L2.](e4c6fa93821e3546ee9fcae897ae2771_img.jpg) + +| | +|-------------| +| Application | +| HTTP/2 | +| TLS | +| TCP | +| IP | +| L2 | + +Figure 6.1.7.2-1: SBI Protocol Stack diagram showing a vertical stack of layers: Application, HTTP/2, TLS (dashed box), TCP, IP, and L2. + +**Figure 6.1.7.2-1: SBI Protocol Stack** + +The N5g-eir service based interface uses HTTP/2 protocol (see clause 5.2) with JSON (see clause 5.4) as the application layer serialization protocol. For the security protection at the transport layer, 5G-EIR NF shall support TLS and TLS shall be used within a PLMN if network security is not provided by other means, as specified in 3GPP TS 33.501 [11]. + +#### 6.1.7.3 Authorization of 5G-EIR NF Service Access + +As specified in clause 13.4.1 of 3GPP TS 33.501 [11] OAuth 2.0 (see IETF RFC 6749 [12]) may be used for authorization of N5g-eir\_EquipmentIdentityCheck service access. The 5G-EIR NF and the NRF (as defined in 3GPP TS 29.510 [13]) shall support the OAuth 2.0 authorization framework with "Client Credentials" grant type as specified in clause 4.4 of IETF RFC 6749 [12]. The NRF shall act as the Authorization Server providing the access tokens to the NF service consumers to access the service provided by the 5G-EIR. If the 5G-EIR NF receives an OAuth 2.0 authorization token in the "Authorization" HTTP request header field, the N5g-eir\_EquipmentIdentityCheck service shall validate the access token, its expiry and its access scope before allowing access to the requested resource, as specified in clause 7 of IETF RFC 6749 [12]. + +### 6.1.8 HTTP redirection + +An HTTP request may be redirected to a different 5G-EIR service instance, within the same 5G-EIR or a different 5G-EIR of an 5G-EIR set, e.g. when an 5G-EIR service instance is part of an 5G-EIR (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.1.6. + +An SCP that reselects a different 5G-EIR producer instance will return the NF Instance ID of the new 5G-EIR producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an 5G-EIR within an 5G-EIR set redirects a service request to a different 5G-EIR of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new 5G-EIR towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the N5g-eir\_EquipmentIdentityCheck Service API. It consists of an OpenAPI 3.0.0 specification, in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE : The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [14] clause 5B). + +## --- A.2 N5g-eir\_EquipmentIdentityCheck Service API + +openapi: 3.0.0 + +info: + +``` +version: '1.3.0-alpha.1' +title: '5G-EIR Equipment Identity Check' +description: | + 5G-EIR Equipment Identity Check Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.511 V18.0.0; 5G System; Equipment Identity Register Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.511/' + +servers: + - url: '{apiRoot}/n5g-eir-eic/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - n5g-eir-eic + +paths: + /equipment-status: + get: + summary: Retrieves the status of the UE + operationId: GetEquipmentStatus + tags: + - Equipment Status (Document) + parameters: + - name: pei + in: query + description: PEI of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + - name: supi + in: query + description: SUPI of the UE + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: gpsi + in: query + description: GPSI of the UE + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + - name: supported-features + in: query + description: supported features of the NF consumer + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/EirResponseData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + description: PEI Not Found + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '406': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + n5g-eir-eic: Access to the N5g-eir_EquipmentIdentityCheck API + +schemas: + EirResponseData: + description: Represents equipment status data provided in an EIR response message. + type: object + required: + - status + properties: + status: + $ref: '#/components/schemas/EquipmentStatus' + EquipmentStatus: + description: Represents equipment status of the PEI. This data type is a string. + type: string + enum: + - WHITELISTED # PERMITTED + - BLACKLISTED # PROHIBITED + - GREYLISTED # TRACKING +``` + +# --- Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|-------|-----|-----|----------------------------------------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2017-10 | CT4#80 | C4-175323 | | | | Initial Draft. | 0.1.0 | | +| 2017-10 | CT4#80 | C4-175396 | | | | At CT4#80 approved pCRs C4-175323, C4-175324, C4-175325, C4-175326 incorporated. | 0.2.0 | | +| 2017-12 | CT4#81 | C4-176439 | | | | At CT4#81 approved pCRs C4-176428, C4-176429 incorporated | 0.3.0 | | +| 2018-03 | CT4#83 | C4-182436 | | | | At CT4#83 approved pCRs C4-182368, C4-182369, C4-182384 incorporated. | 0.4.0 | | +| 2018-03 | CT#79 | CP-180032 | | | | Presented for information | 1.0.0 | | +| 2018-05 | CT4#85 | C4-184627 | | | | At CT4#85 approved pCRs C4-184475, C4-184476, C4-184628 incorporated. | 1.1.0 | | +| 2018-06 | CT#80 | CP-181106 | | | | Presented for approval | 2.0.0 | | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | | +| 2018-09 | CT#81 | CP-182061 | 0001 | - | F | Error Handling | 15.1.0 | | +| 2018-09 | CT#81 | CP-182061 | 0002 | - | F | Description of Structured data types | 15.1.0 | | +| 2018-09 | CT#81 | CP-182061 | 0003 | - | F | Update of Resource Figure | 15.1.0 | | +| 2018-09 | CT#81 | CP-182061 | 0004 | - | F | API Version Number Update | 15.1.0 | | +| 2018-12 | CT#82 | CP-183178 | 0005 | 2 | F | 5G-EIR OpenAPI Updates | 15.2.0 | | +| 2018-12 | CT#82 | CP-183019 | 0007 | - | F | APIRoot Clarification | 15.2.0 | | +| 2018-12 | CT#82 | CP-183019 | 0008 | - | F | Common Status codes | 15.2.0 | | +| 2018-12 | CT#82 | CP-183019 | 0009 | 1 | F | API Version Update | 15.2.0 | | +| 2018-12 | CT#82 | CP-183198 | 00010 | 1 | F | Correction of "externalDocs" for N5g-eir_EquipmentIdentityCheck Service | 15.2.0 | | +| 2019-03 | CT#83 | CP-190024 | 0012 | 1 | F | GPSI | 15.3.0 | | +| 2019-03 | CT#83 | CP-190024 | 0014 | 1 | F | Reuse of data types in EIR OpenAPI | 15.3.0 | | +| 2019-03 | CT#83 | CP-190024 | 0015 | - | F | API Version Update | 15.3.0 | | +| 2019-06 | CT#84 | CP-191035 | 0017 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | | +| 2019-06 | CT#84 | CP-191035 | 0018 | - | F | Copyright Note in YAML file | 15.4.0 | | +| 2019-06 | CT#84 | CP-191035 | 0019 | - | F | Wrong formatting in OpenAPI annex | 15.4.0 | | +| 2019-06 | CT#84 | CP-191035 | 0020 | - | F | 3GPP TS 29.511 API version update | 15.4.0 | | +| 2019-11 | CT#84 | CP-193036 | 0022 | 1 | F | Add reference to TS 29.524 | 16.0.0 | | +| 2019-12 | CT#84 | CP-193121 | 0024 | - | F | ExternalDocs field and API version change in the OpenAPI | 16.0.0 | | +| 2020-03 | CT#87e | CP-200039 | 0025 | 2 | F | Add Corresponding API descriptions in clause 5.1 | 16.1.0 | | +| 2020-03 | CT#87e | CP-200039 | 0028 | 2 | D | Editorial corrections | 16.1.0 | | +| 2020-03 | CT#87e | CP-200020 | 0029 | 1 | B | Optionality of ProblemDetails | 16.1.0 | | +| 2020-03 | CT#87e | CP-200035 | 0030 | - | B | SUPI pattern | 16.1.0 | | +| 2020-04 | CT#88e | CP-201064 | 0032 | 1 | F | Datatype column in Resource URI variables Table | 16.2.0 | | +| 2020-06 | CT#88e | CP-201034 | 0033 | - | B | Storage of YAML files | 16.2.0 | | +| 2020-06 | CT#88e | CP-201332 | 0034 | 1 | F | API Version and ExternalDoc Version Update | 16.2.0 | | +| 2020-12 | CT#90e | CP-203035 | 0036 | - | F | Storage of YAML files in 3GPP Forge | 16.3.0 | | +| 2021-03 | CT#91e | CP-210037 | 0038 | | F | HTTP 3xx redirection | 16.4.0 | | +| 2021-03 | CT#91e | CP-210054 | 0041 | | F | 29.511 Rel-16 API version and External doc update | 16.4.0 | | +| 2021-03 | CT#91e | CP-210026 | 0037 | | D | Use of inclusive terminology | 17.0.0 | | +| 2021-03 | CT#91e | CP-210034 | 0039 | | F | OpenAPI Reference | 17.0.0 | | +| 2021-03 | CT#91e | CP-210029 | 0040 | | F | 29.511 Rel-17 API version and External doc update | 17.0.0 | | +| 2021-06 | CT#91e | CP-211028 | 0042 | | F | backward compatible correction | 17.1.0 | | +| 2021-06 | CT#92e | CP-211059 | 0044 | 2 | F | backward compatible correction | 17.1.0 | | +| 2021-06 | CT#92e | CP-211050 | 0045 | - | F | 29.511 Rel-17 API version and External doc update | 17.1.0 | | +| 2021-09 | CT#93e | CP-212060 | 0048 | | A | 3xx description correction for SCP | 17.2.0 | | +| 2022-06 | CT#96 | CP-221027 | 0051 | | F | Correction of typos in description fields | 17.3.0 | | +| 2022-06 | CT#96 | CP-221304 | 0053 | | F | 29.511 Rel17 API version and External doc update | 17.3.0 | | +| 2022-12 | CT#98e | CP-223027 | 0055 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | | +| 2022-12 | CT#98e | CP-223033 | 0056 | | F | 29.511 Rel18 API version and External doc update | 18.0.0 | | +| 2023-09 | CT#101 | CP-232058 | 0057 | 1 | F | Major API version | 18.1.0 | | +| 2023-12 | CT#102 | CP-233028 | 0058 | | F | Update and replace obsoleted HTTP RFCs | 18.2.0 | | +| 2023-12 | CT#102 | CP-233031 | 0059 | | F | Replacing obsoleted HTTP RFC 7807 with 9457 | 18.2.0 | | + diff --git a/raw/rel-18/29_series/29518/raw.md b/raw/rel-18/29_series/29518/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2e2de41bc068f322f8965eb12c0ab595354b8f0a --- /dev/null +++ b/raw/rel-18/29_series/29518/raw.md @@ -0,0 +1,20051 @@ + + +# 3GPP TS 29.518 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Access and Mobility Management Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller black text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword..... | 16 | +| 1 Scope..... | 17 | +| 2 References..... | 17 | +| 3 Definitions and abbreviations..... | 19 | +| 3.1 Definitions..... | 19 | +| 3.2 Abbreviations..... | 19 | +| 4 Overview..... | 20 | +| 4.1 Introduction..... | 20 | +| 5 Services offered by the AMF..... | 21 | +| 5.1 Introduction..... | 21 | +| 5.2 Namf_Communication Service..... | 23 | +| 5.2.1 Service Description..... | 23 | +| 5.2.2 Service Operations..... | 23 | +| 5.2.2.1 Introduction..... | 23 | +| 5.2.2.2 UE Context Operations..... | 24 | +| 5.2.2.2.1 UEContextTransfer..... | 24 | +| 5.2.2.2.1.1 General..... | 24 | +| 5.2.2.2.1.2 Retrieve UE Context after successful UE authentication..... | 26 | +| 5.2.2.2.2 RegistrationStatusUpdate..... | 27 | +| 5.2.2.2.2.1 General..... | 27 | +| 5.2.2.2.3 CreateUEContext..... | 28 | +| 5.2.2.2.3.1 General..... | 28 | +| 5.2.2.2.3.2 Create UE Context with AMF Relocation..... | 30 | +| 5.2.2.2.4 ReleaseUEContext..... | 31 | +| 5.2.2.2.4.1 General..... | 31 | +| 5.2.2.2.5 RelocateUEContext..... | 32 | +| 5.2.2.2.5.1 General..... | 32 | +| 5.2.2.2.6 CancelRelocateUEContext..... | 33 | +| 5.2.2.2.6.1 General..... | 33 | +| 5.2.2.3 UE Specific N1N2 Message Operations..... | 34 | +| 5.2.2.3.1 N1N2MessageTransfer..... | 34 | +| 5.2.2.3.1.1 General..... | 34 | +| 5.2.2.3.1.2 Detailed behaviour of the AMF..... | 36 | +| 5.2.2.3.2 N1N2Transfer Failure Notification..... | 39 | +| 5.2.2.3.3 N1N2MessageSubscribe..... | 40 | +| 5.2.2.3.3.1 General..... | 40 | +| 5.2.2.3.4 N1N2MessageUnSubscribe..... | 40 | +| 5.2.2.3.4.1 General..... | 40 | +| 5.2.2.3.5 N1MessageNotify..... | 41 | +| 5.2.2.3.5.1 General..... | 41 | +| 5.2.2.3.5.2 Using N1MessageNotify in the Registration with AMF Re-allocation Procedure..... | 42 | +| 5.2.2.3.5.3 Using N1MessageNotify in the UE Assisted and UE Based Positioning Procedure..... | 42 | +| 5.2.2.3.5.4 Using N1MessageNotify in the UE Configuration Update for transparent UE Policy delivery..... | 43 | +| 5.2.2.3.5.5 Using N1MessageNotify in the LCS Event Report, Event Reporting in RRC INACTIVE state procedures, LCS Cancel Location and LCS Periodic-Triggered Invoke Procedures..... | 43 | +| 5.2.2.3.5.6 Using N1MessageNotify in the UE triggered policy provisioning procedure to request UE policies..... | 43 | +| 5.2.2.3.5.7 Using N1MessageNotify in the procedures applicable to a PRU..... | 44 | +| 5.2.2.3.6 N2InfoNotify..... | 44 | +| 5.2.2.3.6.1 General..... | 44 | +| 5.2.2.3.6.2 Using N2InfoNotify during Inter NG-RAN node N2 based handover procedure..... | 45 | +| 5.2.2.3.6.3 Using N2InfoNotify during Location Services procedures..... | 46 | +| 5.2.2.3.6.4 Using N2InfoNotify during AMF planned removal procedure with UDSF deployed procedure..... | 46 | + +| | | | +|-------------|------------------------------------------------------------------------------------------------|----| +| 5.2.2.4 | Non-UE N2 Message Operations..... | 47 | +| 5.2.2.4.1 | NonUeN2MessageTransfer..... | 47 | +| 5.2.2.4.1.1 | General..... | 47 | +| 5.2.2.4.1.2 | Obtaining Non UE Associated Network Assistance Data Procedure..... | 47 | +| 5.2.2.4.1.3 | Warning Request Transfer Procedure..... | 47 | +| 5.2.2.4.1.4 | Configuration Transfer Procedure..... | 48 | +| 5.2.2.4.1.5 | RIM Information Transfer Procedures..... | 48 | +| 5.2.2.4.1.6 | Broadcast of Assistance Data by an LMF..... | 49 | +| 5.2.2.4.1.7 | Management of network timing synchronization status monitoring procedures..... | 49 | +| 5.2.2.4.2 | NonUeN2InfoSubscribe..... | 49 | +| 5.2.2.4.2.1 | General..... | 49 | +| 5.2.2.4.3 | NonUeN2InfoUnSubscribe..... | 50 | +| 5.2.2.4.3.1 | General..... | 50 | +| 5.2.2.4.4 | NonUeN2InfoNotify..... | 50 | +| 5.2.2.4.4.1 | General..... | 50 | +| 5.2.2.4.4.2 | Using NonUeN2InfoNotify during Location Services procedures..... | 51 | +| 5.2.2.4.4.3 | Use of NonUeN2InfoNotify for PWS related events..... | 51 | +| 5.2.2.4.4.4 | Using NonUeN2InfoNotify during network timing synchronization status monitoring procedure..... | 52 | +| 5.2.2.5 | AMF Status Change Operations..... | 52 | +| 5.2.2.5.1 | AMFStatusChangeSubscribe..... | 52 | +| 5.2.2.5.1.1 | General..... | 52 | +| 5.2.2.5.1.2 | Creation of a subscription..... | 52 | +| 5.2.2.5.1.3 | Modification of a subscription..... | 53 | +| 5.2.2.5.2 | AMFStatusChangeUnSubscribe..... | 53 | +| 5.2.2.5.2.1 | General..... | 53 | +| 5.2.2.5.3 | AMFStatusChangeNotify..... | 54 | +| 5.2.2.5.3.1 | General..... | 54 | +| 5.2.2.6 | EBIAssignment..... | 54 | +| 5.2.2.6.1 | General..... | 54 | +| 5.3 | Namf_EventExposure Service..... | 56 | +| 5.3.1 | Service Description..... | 56 | +| 5.3.2 | Service Operations..... | 61 | +| 5.3.2.1 | Introduction..... | 61 | +| 5.3.2.2 | Subscribe..... | 62 | +| 5.3.2.2.1 | General..... | 62 | +| 5.3.2.2.2 | Creation of a subscription..... | 62 | +| 5.3.2.2.3 | Modification of a subscription..... | 64 | +| 5.3.2.2.4 | Remove or add group member UE(s) for a group subscription..... | 65 | +| 5.3.2.3 | Unsubscribe..... | 66 | +| 5.3.2.3.1 | General..... | 66 | +| 5.3.2.4 | Notify..... | 67 | +| 5.3.2.4.1 | General..... | 67 | +| 5.3.2.4.2 | Event Subscription Synchronization for specific UE..... | 67 | +| 5.4 | Namf_MT Service..... | 68 | +| 5.4.1 | Service Description..... | 68 | +| 5.4.2 | Service Operations..... | 68 | +| 5.4.2.1 | Introduction..... | 68 | +| 5.4.2.2 | EnableUEREACHABILITY..... | 69 | +| 5.4.2.2.1 | General..... | 69 | +| 5.4.2.3 | ProvideDomainSelectionInfo..... | 70 | +| 5.4.2.3.1 | General..... | 70 | +| 5.4.2.4 | EnableGroupReachability..... | 71 | +| 5.4.2.4.1 | General..... | 71 | +| 5.4.2.5 | UEREACHABILITYInfoNotify..... | 72 | +| 5.4.2.5.1 | General..... | 72 | +| 5.5 | Namf_Location Service..... | 72 | +| 5.5.1 | Service Description..... | 72 | +| 5.5.2 | Service Operations..... | 73 | +| 5.5.2.1 | Introduction..... | 73 | +| 5.5.2.2 | ProvidePositioningInfo..... | 73 | + +| | | | +|---------------|-------------------------------------------------------------------------|-----| +| 5.5.2.2.1 | General..... | 73 | +| 5.5.2.3 | EventNotify..... | 74 | +| 5.5.2.3.1 | General..... | 74 | +| 5.5.2.4 | ProvideLocationInfo..... | 75 | +| 5.5.2.4.1 | General..... | 75 | +| 5.5.2.5 | CancelLocation..... | 76 | +| 5.5.2.5.1 | General..... | 76 | +| 5.6 | Namf_MBSBroadcast Service..... | 77 | +| 5.6.1 | Service Description..... | 77 | +| 5.6.2 | Service Operations..... | 77 | +| 5.6.2.1 | Introduction..... | 77 | +| 5.6.2.2 | ContextCreate..... | 77 | +| 5.6.2.3 | ContextUpdate..... | 79 | +| 5.6.2.4 | ContextRelease..... | 80 | +| 5.6.2.5 | ContextStatusNotify..... | 81 | +| 5.7 | Namf_MBSCommunication Service..... | 83 | +| 5.7.1 | Service Description..... | 83 | +| 5.7.2 | Service Operations..... | 83 | +| 5.7.2.1 | Introduction..... | 83 | +| 5.7.2.2 | N2MessageTransfer..... | 83 | +| 5.7.2.3 | Notify..... | 84 | +| 6 | API Definitions..... | 85 | +| 6.1 | Namf_Communication Service API..... | 85 | +| 6.1.1 | API URI..... | 85 | +| 6.1.2 | Usage of HTTP..... | 86 | +| 6.1.2.1 | General..... | 86 | +| 6.1.2.2 | HTTP standard headers..... | 86 | +| 6.1.2.2.1 | General..... | 86 | +| 6.1.2.2.2 | Content type..... | 86 | +| 6.1.2.3 | HTTP custom headers..... | 86 | +| 6.1.2.3.1 | General..... | 86 | +| 6.1.2.4 | HTTP multipart messages..... | 86 | +| 6.1.3 | Resources..... | 88 | +| 6.1.3.1 | Overview..... | 88 | +| 6.1.3.2 | Resource: Individual ueContext..... | 89 | +| 6.1.3.2.1 | Description..... | 89 | +| 6.1.3.2.2 | Resource Definition..... | 90 | +| 6.1.3.2.3 | Resource Standard Methods..... | 90 | +| 6.1.3.2.3.1 | PUT..... | 90 | +| 6.1.3.2.4 | Resource Custom Operations..... | 92 | +| 6.1.3.2.4.1 | Overview..... | 92 | +| 6.1.3.2.4.2 | Operation: release (POST)..... | 92 | +| 6.1.3.2.4.2.1 | Description..... | 92 | +| 6.1.3.2.4.2.2 | Operation Definition..... | 92 | +| 6.1.3.2.4.3 | Operation: assign-ebi (POST)..... | 93 | +| 6.1.3.2.4.3.1 | Description..... | 93 | +| 6.1.3.2.4.3.2 | Operation Definition..... | 93 | +| 6.1.3.2.4.4 | Operation: transfer (POST)..... | 96 | +| 6.1.3.2.4.4.1 | Description..... | 96 | +| 6.1.3.2.4.4.2 | Operation Definition..... | 96 | +| 6.1.3.2.4.5 | Operation: transfer-update (POST)..... | 97 | +| 6.1.3.2.4.5.1 | Description..... | 97 | +| 6.1.3.2.4.5.2 | Operation Definition..... | 98 | +| 6.1.3.2.4.6 | Operation: relocate (POST)..... | 99 | +| 6.1.3.2.4.6.1 | Description..... | 99 | +| 6.1.3.2.4.6.2 | Operation Definition..... | 99 | +| 6.1.3.2.4.7 | Operation: cancel-relocate (POST)..... | 100 | +| 6.1.3.2.4.7.1 | Description..... | 100 | +| 6.1.3.2.4.7.2 | Operation Definition..... | 100 | +| 6.1.3.3 | Resource: N1N2 Subscriptions Collection for Individual UE Contexts..... | 101 | +| 6.1.3.3.1 | Description..... | 101 | + +| | | | +|---------------|-----------------------------------------------------------------------|-----| +| 6.1.3.3.2 | Resource Definition..... | 101 | +| 6.1.3.3.3 | Resource Standard Methods..... | 101 | +| 6.1.3.3.3.1 | POST..... | 101 | +| 6.1.3.3.4 | Resource Custom Operations..... | 103 | +| 6.1.3.4 | Resource: N1N2 Individual Subscription..... | 103 | +| 6.1.3.4.1 | Description..... | 103 | +| 6.1.3.4.2 | Resource Definition..... | 103 | +| 6.1.3.4.3 | Resource Standard Methods..... | 103 | +| 6.1.3.4.3.1 | DELETE..... | 103 | +| 6.1.3.4.4 | Resource Custom Operations..... | 104 | +| 6.1.3.5 | Resource: N1N2 Messages Collection..... | 104 | +| 6.1.3.5.1 | Description..... | 104 | +| 6.1.3.5.2 | Resource Definition..... | 104 | +| 6.1.3.5.3 | Resource Standard Methods..... | 105 | +| 6.1.3.5.3.1 | POST..... | 105 | +| 6.1.3.6 | Resource: subscriptions collection..... | 109 | +| 6.1.3.6.1 | Description..... | 109 | +| 6.1.3.6.2 | Resource Definition..... | 109 | +| 6.1.3.6.3 | Resource Standard Methods..... | 109 | +| 6.1.3.6.3.1 | POST..... | 109 | +| 6.1.3.7 | Resource: individual subscription..... | 111 | +| 6.1.3.7.1 | Description..... | 111 | +| 6.1.3.7.2 | Resource Definition..... | 111 | +| 6.1.3.7.3 | Resource Standard Methods..... | 111 | +| 6.1.3.7.3.1 | DELETE..... | 111 | +| 6.1.3.7.3.2 | PUT..... | 112 | +| 6.1.3.8 | Resource: Non UE N2 Messages Collection..... | 113 | +| 6.1.3.8.1 | Description..... | 113 | +| 6.1.3.8.2 | Resource Definition..... | 114 | +| 6.1.3.8.3 | Resource Standard Methods..... | 114 | +| 6.1.3.8.4 | Resource Custom Operations..... | 114 | +| 6.1.3.8.4.1 | Overview..... | 114 | +| 6.1.3.8.4.2 | Operation: transfer..... | 114 | +| 6.1.3.8.4.2.1 | Description..... | 114 | +| 6.1.3.8.4.2.2 | Operation Definition..... | 114 | +| 6.1.3.9 | Resource: Non UE N2 Messages Subscriptions Collection..... | 116 | +| 6.1.3.9.1 | Description..... | 116 | +| 6.1.3.9.2 | Resource Definition..... | 116 | +| 6.1.3.9.3 | Resource Standard Methods..... | 116 | +| 6.1.3.9.3.1 | POST..... | 116 | +| 6.1.3.9.4 | Resource Custom Operations..... | 117 | +| 6.1.3.10 | Resource: Non UE N2 Message Notification Individual Subscription..... | 118 | +| 6.1.3.10.1 | Description..... | 118 | +| 6.1.3.10.2 | Resource Definition..... | 118 | +| 6.1.3.10.3 | Resource Standard Methods..... | 118 | +| 6.1.3.10.3.1 | DELETE..... | 118 | +| 6.1.3.10.4 | Resource Custom Operations..... | 119 | +| 6.1.4 | Custom Operations without associated resources..... | 119 | +| 6.1.5 | Notifications..... | 119 | +| 6.1.5.1 | General..... | 119 | +| 6.1.5.2 | AMF Status Change Notification..... | 120 | +| 6.1.5.2.1 | Description..... | 120 | +| 6.1.5.2.2 | Notification Definition..... | 120 | +| 6.1.5.2.3 | Notification Standard Methods..... | 120 | +| 6.1.5.2.3.1 | POST..... | 120 | +| 6.1.5.3 | Non UE N2 Information Notification..... | 121 | +| 6.1.5.3.1 | Description..... | 121 | +| 6.1.5.3.2 | Notification Definition..... | 121 | +| 6.1.5.3.3 | Notification Standard Methods..... | 122 | +| 6.1.5.3.3.1 | POST..... | 122 | +| 6.1.5.4 | N1 Message Notification..... | 123 | + +| | | | +|-------------|-----------------------------------------------|-----| +| 6.1.5.4.1 | Description..... | 123 | +| 6.1.5.4.2 | Notification Definition..... | 123 | +| 6.1.5.4.3 | Notification Standard Methods..... | 123 | +| 6.1.5.4.3.1 | POST..... | 123 | +| 6.1.5.5 | UE Specific N2 Information Notification..... | 124 | +| 6.1.5.5.1 | Description..... | 124 | +| 6.1.5.5.2 | Notification Definition..... | 124 | +| 6.1.5.5.3 | Notification Standard Methods..... | 124 | +| 6.1.5.5.3.1 | POST..... | 124 | +| 6.1.5.6 | N1N2 Transfer Failure Notification..... | 125 | +| 6.1.5.6.1 | Description..... | 125 | +| 6.1.5.6.2 | Notification Definition..... | 125 | +| 6.1.5.6.3 | Notification Standard Methods..... | 126 | +| 6.1.5.6.3.1 | POST..... | 126 | +| 6.1.5.7 | Void..... | 127 | +| 6.1.6 | Data Model..... | 127 | +| 6.1.6.1 | General..... | 127 | +| 6.1.6.2 | Structured data types..... | 134 | +| 6.1.6.2.1 | Introduction..... | 134 | +| 6.1.6.2.2 | Type: SubscriptionData..... | 135 | +| 6.1.6.2.3 | Type: AmfStatusChangeNotification..... | 135 | +| 6.1.6.2.4 | Type: AmfStatusInfo..... | 135 | +| 6.1.6.2.5 | Type: AssignEbiData..... | 136 | +| 6.1.6.2.6 | Type: AssignedEbiData..... | 136 | +| 6.1.6.2.7 | Type: AssignEbiFailed..... | 137 | +| 6.1.6.2.8 | Type: UEContextRelease..... | 137 | +| 6.1.6.2.9 | Type: N2InformationTransferReqData..... | 137 | +| 6.1.6.2.10 | Type: NonUeN2InfoSubscriptionCreateData..... | 138 | +| 6.1.6.2.11 | Type: NonUeN2InfoSubscriptionCreatedData..... | 139 | +| 6.1.6.2.12 | Type: UeN1N2InfoSubscriptionCreateData..... | 139 | +| 6.1.6.2.13 | Type: UeN1N2InfoSubscriptionCreatedData..... | 139 | +| 6.1.6.2.14 | Type: N2InformationNotification..... | 140 | +| 6.1.6.2.15 | Type: N2InfoContainer..... | 143 | +| 6.1.6.2.16 | Type: N1MessageNotification..... | 144 | +| 6.1.6.2.17 | Type: N1MessageContainer..... | 145 | +| 6.1.6.2.18 | Type: N1N2MessageTransferReqData..... | 146 | +| 6.1.6.2.19 | Type: N1N2MessageTransferRspData..... | 150 | +| 6.1.6.2.20 | Type: RegistrationContextContainer..... | 151 | +| 6.1.6.2.21 | Type: AreaOfValidity..... | 153 | +| 6.1.6.2.22 | Void..... | 153 | +| 6.1.6.2.23 | Type: UeContextTransferReqData..... | 153 | +| 6.1.6.2.24 | Type: UeContextTransferRspData..... | 154 | +| 6.1.6.2.25 | Type: UeContext..... | 155 | +| 6.1.6.2.26 | Type: N2SmInformation..... | 165 | +| 6.1.6.2.27 | Type: N2InfoContent..... | 166 | +| 6.1.6.2.28 | Type: NrppaInformation..... | 166 | +| 6.1.6.2.29 | Type: PwsInformation..... | 167 | +| 6.1.6.2.30 | Type: N1N2MsgTxfrFailureNotification..... | 169 | +| 6.1.6.2.31 | Type: N1N2MessageTransferError..... | 169 | +| 6.1.6.2.32 | Type: N1N2MsgTxfrErrDetail..... | 170 | +| 6.1.6.2.33 | Type: N2InformationTransferRspData..... | 170 | +| 6.1.6.2.34 | Type: MmContext..... | 171 | +| 6.1.6.2.35 | Type: SeafData..... | 174 | +| 6.1.6.2.36 | Type: NasSecurityMode..... | 174 | +| 6.1.6.2.37 | Type: PduSessionContext..... | 175 | +| 6.1.6.2.38 | Type: NssaiMapping..... | 180 | +| 6.1.6.2.39 | Type: UeRegStatusUpdateReqData..... | 181 | +| 6.1.6.2.40 | Type: AssignEbiError..... | 181 | +| 6.1.6.2.41 | Type: UeContextCreateData..... | 182 | +| 6.1.6.2.42 | Type: UeContextCreatedData..... | 183 | +| 6.1.6.2.43 | Type: UeContextCreateError..... | 183 | + +| | | | +|------------|-----------------------------------------------|-----| +| 6.1.6.2.44 | Type: NgRanTargetId..... | 184 | +| 6.1.6.2.45 | Type: N2InformationTransferError..... | 184 | +| 6.1.6.2.46 | Type: PWSSResponseData..... | 184 | +| 6.1.6.2.47 | Type: PWSErrorData..... | 185 | +| 6.1.6.2.48 | Void..... | 185 | +| 6.1.6.2.49 | Type: NgKsi..... | 185 | +| 6.1.6.2.50 | Type: KeyAmf..... | 185 | +| 6.1.6.2.51 | Type: ExpectedUeBehavior..... | 185 | +| 6.1.6.2.52 | Type: UeRegStatusUpdateRspData..... | 186 | +| 6.1.6.2.53 | Type: N2RanInformation..... | 186 | +| 6.1.6.2.54 | Type: N2InfoNotificationRspData..... | 186 | +| 6.1.6.2.55 | Type: SmallDataRateStatusInfo..... | 186 | +| 6.1.6.2.56 | Type: SmfChangeInfo..... | 187 | +| 6.1.6.2.57 | Type: V2xContext..... | 187 | +| 6.1.6.2.58 | Type: ImmediateMdtConf..... | 188 | +| 6.1.6.2.59 | Type: V2xInformation..... | 190 | +| 6.1.6.2.60 | Type: EpsNasSecurityMode..... | 190 | +| 6.1.6.2.61 | Type: UeContextRelocateData..... | 191 | +| 6.1.6.2.62 | Type: UeContextRelocatedData..... | 191 | +| 6.1.6.2.63 | Void..... | 191 | +| 6.1.6.2.64 | Type: EcRestrictionDataWb..... | 192 | +| 6.1.6.2.65 | Type: ExtAmfEventSubscription..... | 192 | +| 6.1.6.2.66 | Type: AmfEventSubscriptionAddInfo..... | 193 | +| 6.1.6.2.67 | Type: UeContextCancelRelocateData..... | 194 | +| 6.1.6.2.68 | Type: UeDifferentiationInfo..... | 194 | +| 6.1.6.2.69 | Type: CeModeBInd..... | 194 | +| 6.1.6.2.70 | Type: LteMInd..... | 195 | +| 6.1.6.2.71 | Type: NpnAccessInfo..... | 195 | +| 6.1.6.2.72 | Type: ProseContext..... | 195 | +| 6.1.6.2.73 | Type: AnalyticsSubscription..... | 196 | +| 6.1.6.2.74 | Type: NwdafSubscription..... | 196 | +| 6.1.6.2.75 | Type: UpdpSubscriptionData..... | 196 | +| 6.1.6.2.76 | Type: ProSeInformation..... | 196 | +| 6.1.6.2.77 | Type: ReleaseSessionInfo..... | 197 | +| 6.1.6.2.78 | Type: AreaOfInterestEventState..... | 197 | +| 6.1.6.2.79 | Type: TssInformation..... | 197 | +| 6.1.6.2.80 | Type: AmPolicyInfoContainer..... | 197 | +| 6.1.6.2.81 | Type: RslpInformation..... | 198 | +| 6.1.6.2.82 | Type: A2xContext..... | 198 | +| 6.1.6.2.83 | Type: A2xInformation..... | 198 | +| 6.1.6.2.84 | Type: LcsUpContext..... | 198 | +| 6.1.6.3 | Simple data types and enumerations..... | 199 | +| 6.1.6.3.1 | Introduction..... | 199 | +| 6.1.6.3.2 | Simple data types..... | 199 | +| 6.1.6.3.3 | Enumeration: StatusChange..... | 200 | +| 6.1.6.3.4 | Enumeration: N2InformationClass..... | 200 | +| 6.1.6.3.5 | Enumeration: N1MessageClass..... | 200 | +| 6.1.6.3.6 | Enumeration: N1N2MessageTransferCause..... | 201 | +| 6.1.6.3.7 | Enumeration: UeContextTransferStatus..... | 202 | +| 6.1.6.3.8 | Enumeration: N2InformationTransferResult..... | 202 | +| 6.1.6.3.9 | Enumeration: CipheringAlgorithm..... | 202 | +| 6.1.6.3.10 | Enumeration: IntegrityAlgorithm..... | 202 | +| 6.1.6.3.11 | Enumeration: SmsSupport..... | 202 | +| 6.1.6.3.12 | Enumeration: ScType..... | 203 | +| 6.1.6.3.13 | Enumeration: KeyAmfType..... | 203 | +| 6.1.6.3.14 | Enumeration: TransferReason..... | 203 | +| 6.1.6.3.15 | Enumeration: PolicyReqTrigger..... | 203 | +| 6.1.6.3.16 | Enumeration: RatSelector..... | 204 | +| 6.1.6.3.17 | Enumeration: NgapIeType..... | 204 | +| 6.1.6.3.18 | Enumeration: N2InfoNotifyReason..... | 204 | +| 6.1.6.3.19 | Enumeration: SmfChangeIndication..... | 204 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 6.1.6.3.20 | Enumeration: SbiBindingLevel..... | 205 | +| 6.1.6.3.21 | Enumeration: EpsNasCipheringAlgorithm..... | 205 | +| 6.1.6.3.22 | Enumeration: EpsNasIntegrityAlgorithm..... | 205 | +| 6.1.6.3.23 | Enumeration: PeriodicCommunicationIndicator..... | 205 | +| 6.1.6.3.24 | Enumeration: UuamMmStatus..... | 205 | +| 6.1.6.3.25 | Enumeration: ReleaseCause..... | 206 | +| 6.1.6.4 | Binary data..... | 206 | +| 6.1.6.4.1 | Introduction..... | 206 | +| 6.1.6.4.2 | N1 Message..... | 206 | +| 6.1.6.4.3 | N2 Information..... | 207 | +| 6.1.6.4.3.1 | Introduction..... | 207 | +| 6.1.6.4.3.2 | NGAP IEs..... | 207 | +| 6.1.6.4.3.3 | NGAP Messages..... | 209 | +| 6.1.6.4.4 | Mobile Terminated Data..... | 211 | +| 6.1.6.4.5 | GTP-C Message..... | 211 | +| 6.1.7 | Error Handling..... | 211 | +| 6.1.7.1 | General..... | 211 | +| 6.1.7.2 | Protocol Errors..... | 211 | +| 6.1.7.3 | Application Errors..... | 212 | +| 6.1.8 | Feature Negotiation..... | 215 | +| 6.1.9 | Security..... | 218 | +| 6.1.10 | HTTP redirection..... | 219 | +| 6.2 | Namf_EventExposure Service API..... | 219 | +| 6.2.1 | API URI..... | 219 | +| 6.2.2 | Usage of HTTP..... | 220 | +| 6.2.2.1 | General..... | 220 | +| 6.2.2.2 | HTTP standard headers..... | 220 | +| 6.2.2.2.1 | General..... | 220 | +| 6.2.2.2.2 | Content type..... | 220 | +| 6.2.2.3 | HTTP custom headers..... | 220 | +| 6.2.2.3.1 | General..... | 220 | +| 6.2.3 | Resources..... | 221 | +| 6.2.3.1 | Overview..... | 221 | +| 6.2.3.2 | Resource: Subscriptions collection..... | 221 | +| 6.2.3.2.1 | Description..... | 221 | +| 6.2.3.2.2 | Resource Definition..... | 221 | +| 6.2.3.2.3 | Resource Standard Methods..... | 222 | +| 6.2.3.2.3.1 | POST..... | 222 | +| 6.2.3.2.4 | Resource Custom Operations..... | 223 | +| 6.2.3.3 | Resource: Individual subscription..... | 223 | +| 6.2.3.3.1 | Description..... | 223 | +| 6.2.3.3.2 | Resource Definition..... | 223 | +| 6.2.3.3.3 | Resource Standard Methods..... | 223 | +| 6.2.3.3.3.1 | PATCH..... | 223 | +| 6.2.3.3.3.2 | DELETE..... | 225 | +| 6.2.3.3.4 | Resource Custom Operations..... | 226 | +| 6.2.4 | Custom Operations without associated resources..... | 226 | +| 6.2.5 | Notifications..... | 226 | +| 6.2.5.1 | Void..... | 226 | +| 6.2.5.2 | AMF Event Notification..... | 226 | +| 6.2.5.2.1 | Notification Definition..... | 226 | +| 6.2.5.2.3 | Notification Standard Methods..... | 226 | +| 6.2.5.2.3.1 | POST..... | 226 | +| 6.2.6 | Data Model..... | 227 | +| 6.2.6.1 | General..... | 227 | +| 6.2.6.2 | Structured data types..... | 229 | +| 6.2.6.2.1 | Introduction..... | 229 | +| 6.2.6.2.2 | Type: AmfEventSubscription..... | 230 | +| 6.2.6.2.3 | Type: AmfEvent..... | 233 | +| 6.2.6.2.4 | Type: AmfEventNotification..... | 239 | +| 6.2.6.2.5 | Type: AmfEventReport..... | 240 | + +| | | | +|------------|---------------------------------------------|-----| +| 6.2.6.2.6 | Type: AmfEventMode..... | 245 | +| 6.2.6.2.7 | Type: AmfEventState..... | 247 | +| 6.2.6.2.8 | Type: RmInfo..... | 248 | +| 6.2.6.2.9 | Type: CmInfo..... | 248 | +| 6.2.6.2.10 | Void..... | 248 | +| 6.2.6.2.11 | Type: CommunicationFailure..... | 248 | +| 6.2.6.2.12 | Type: AmfCreateEventSubscription..... | 248 | +| 6.2.6.2.13 | Type: AmfCreatedEventSubscription..... | 249 | +| 6.2.6.2.14 | Type: AmfUpdateEventSubscriptionItem..... | 250 | +| 6.2.6.2.15 | Type: AmfUpdatedEventSubscription..... | 254 | +| 6.2.6.2.16 | Type: AmfEventArea..... | 254 | +| 6.2.6.2.17 | Type: LadnInfo..... | 255 | +| 6.2.6.2.18 | Type: AmfUpdateEventOptionItem..... | 256 | +| 6.2.6.2.19 | Type: 5GsUserInfo..... | 257 | +| 6.2.6.2.20 | Type: TrafficDescriptor..... | 257 | +| 6.2.6.2.21 | Type: UEIdExt..... | 257 | +| 6.2.6.2.22 | Type: AmfEventSubsSyncInfo..... | 257 | +| 6.2.6.2.23 | Type: AmfEventSubscriptionInfo..... | 258 | +| 6.2.6.2.24 | Type: TargetArea..... | 258 | +| 6.2.6.2.25 | Type: SnssaiTaiMapping..... | 258 | +| 6.2.6.2.26 | Type: SupportedSnssai..... | 259 | +| 6.2.6.2.27 | Type: UeInAreaFilter..... | 259 | +| 6.2.6.2.28 | Type: IdleStatusIndication..... | 260 | +| 6.2.6.2.29 | Type: UeAccessBehaviorReportItem..... | 260 | +| 6.2.6.2.30 | Type: UeLocationTrendsReportItem..... | 261 | +| 6.2.6.2.31 | Type: DispersionArea..... | 261 | +| 6.2.6.2.32 | Type: MmTransactionLocationReportItem..... | 262 | +| 6.2.6.2.33 | Type: MmTransactionSliceReportItem..... | 262 | +| 6.2.6.3 | Simple data types and enumerations..... | 262 | +| 6.2.6.3.1 | Introduction..... | 262 | +| 6.2.6.3.2 | Simple data types..... | 262 | +| 6.2.6.3.3 | Enumeration: AmfEventType..... | 263 | +| 6.2.6.3.4 | Enumeration: AmfEventTrigger..... | 265 | +| 6.2.6.3.5 | Enumeration: LocationFilter..... | 266 | +| 6.2.6.3.6 | Void..... | 266 | +| 6.2.6.3.7 | Enumeration: UeReachability..... | 266 | +| 6.2.6.3.8 | Void..... | 266 | +| 6.2.6.3.9 | Enumeration: RmState..... | 266 | +| 6.2.6.3.10 | Enumeration: CmState..... | 266 | +| 6.2.6.3.11 | Enumeration: 5GsUserInfoState..... | 267 | +| 6.2.6.3.12 | Enumeration: LossOfConnectivityReason..... | 267 | +| 6.2.6.3.13 | Enumeration: ReachabilityFilter..... | 267 | +| 6.2.6.3.14 | Enumeration: UeType..... | 267 | +| 6.2.6.3.15 | Enumeration: AccessStateTransitionType..... | 268 | +| 6.2.6.3.16 | Enumeration: SubTerminationReason..... | 268 | +| 6.2.6.4 | Binary data..... | 268 | +| 6.2.7 | Error Handling..... | 268 | +| 6.2.7.1 | General..... | 268 | +| 6.2.7.2 | Protocol Errors..... | 268 | +| 6.2.7.3 | Application Errors..... | 268 | +| 6.2.8 | Feature Negotiation..... | 269 | +| 6.2.9 | Security..... | 272 | +| 6.2.10 | HTTP redirection..... | 272 | +| 6.3 | Namf_MT Service API..... | 272 | +| 6.3.1 | API URI..... | 272 | +| 6.3.2 | Usage of HTTP..... | 273 | +| 6.3.2.1 | General..... | 273 | +| 6.3.2.2 | HTTP standard headers..... | 273 | +| 6.3.2.2.1 | General..... | 273 | +| 6.3.2.2.2 | Content type..... | 273 | +| 6.3.2.3 | HTTP custom headers..... | 273 | + +| | | | +|---------------|-----------------------------------------------------|-----| +| 6.3.2.3.1 | General..... | 273 | +| 6.3.3 | Resources..... | 274 | +| 6.3.3.1 | Overview..... | 274 | +| 6.3.3.2 | Resource: ueReachInd..... | 274 | +| 6.3.3.2.1 | Description..... | 274 | +| 6.3.3.2.2 | Resource Definition..... | 274 | +| 6.3.3.2.3 | Resource Standard Methods..... | 275 | +| 6.3.3.2.3.1 | PUT..... | 275 | +| 6.3.3.2.4 | Resource Custom Operations..... | 277 | +| 6.3.3.3 | Resource: ueContext..... | 277 | +| 6.3.3.3.1 | Description..... | 277 | +| 6.3.3.3.2 | Resource Definition..... | 277 | +| 6.3.3.3.3 | Resource Standard Methods..... | 277 | +| 6.3.3.3.3.1 | GET..... | 277 | +| 6.3.3.3.4 | Resource Custom Operations..... | 279 | +| 6.3.3.4 | Resource: ueContexts collection..... | 279 | +| 6.3.3.4.1 | Description..... | 279 | +| 6.3.3.4.2 | Resource Definition..... | 279 | +| 6.3.3.4.3 | Resource Standard Methods..... | 279 | +| 6.3.3.4.4 | Resource Custom Operations..... | 279 | +| 6.3.3.4.4.1 | Overview..... | 279 | +| 6.3.3.4.4.2 | Operation: enable-group-reachability..... | 279 | +| 6.3.3.4.4.2.1 | Description..... | 279 | +| 6.3.3.4.4.2.2 | Operation Definition..... | 279 | +| 6.3.4 | Custom Operations without associated resources..... | 281 | +| 6.3.5 | Notifications..... | 281 | +| 6.3.5.1 | General..... | 281 | +| 6.3.5.2 | UE Reachability Info Notify..... | 281 | +| 6.3.5.2.1 | Notification Definition..... | 281 | +| 6.3.5.2.3 | Notification Standard Methods..... | 281 | +| 6.3.5.2.3.1 | POST..... | 281 | +| 6.3.6 | Data Model..... | 282 | +| 6.3.6.1 | General..... | 282 | +| 6.3.6.2 | Structured data types..... | 283 | +| 6.3.6.2.1 | Introduction..... | 283 | +| 6.3.6.2.2 | Type: EnableUeReachabilityReqData..... | 284 | +| 6.3.6.2.3 | Type: EnableUeReachabilityRspData..... | 285 | +| 6.3.6.2.4 | Type: UeContextInfo..... | 285 | +| 6.3.6.2.5 | Type: ProblemDetailsEnableUeReachability..... | 285 | +| 6.3.6.2.6 | Type: AdditionInfoEnableUeReachability..... | 286 | +| 6.3.6.2.7 | Type: EnableGroupReachabilityReqData..... | 286 | +| 6.3.6.2.8 | Type: EnableGroupReachabilityRspData..... | 286 | +| 6.3.6.2.9 | Type: UeInfo..... | 286 | +| 6.3.6.2.10 | Type: ReachabilityNotificationData..... | 287 | +| 6.3.6.2.11 | Type: ReachableUeInfo..... | 287 | +| 6.3.6.3 | Simple data types and enumerations..... | 287 | +| 6.3.6.3.1 | Introduction..... | 287 | +| 6.3.6.3.2 | Simple data types..... | 287 | +| 6.3.6.3.3 | Enumeration: UeContextInfoClass..... | 287 | +| 6.3.6.4 | Binary data..... | 287 | +| 6.3.7 | Error Handling..... | 287 | +| 6.3.7.1 | General..... | 287 | +| 6.3.7.2 | Protocol Errors..... | 287 | +| 6.3.7.3 | Application Errors..... | 288 | +| 6.3.8 | Feature Negotiation..... | 288 | +| 6.3.9 | Security..... | 289 | +| 6.3.10 | HTTP redirection..... | 289 | +| 6.4 | Namf_Location Service API..... | 290 | +| 6.4.1 | API URI..... | 290 | +| 6.4.2 | Usage of HTTP..... | 290 | +| 6.4.2.1 | General..... | 290 | + +| | | | +|---------------|-----------------------------------------------------|-----| +| 6.4.2.2 | HTTP standard headers..... | 290 | +| 6.4.2.2.1 | General..... | 290 | +| 6.4.2.2.2 | Content type..... | 290 | +| 6.4.2.3 | HTTP custom headers..... | 291 | +| 6.4.2.3.1 | General..... | 291 | +| 6.4.3 | Resources..... | 291 | +| 6.4.3.1 | Overview..... | 291 | +| 6.4.3.2 | Resource: Individual UE Context..... | 292 | +| 6.4.3.2.1 | Description..... | 292 | +| 6.4.3.2.2 | Resource Definition..... | 292 | +| 6.4.3.2.3 | Resource Standard Methods..... | 292 | +| 6.4.3.2.4 | Resource Custom Operations..... | 292 | +| 6.4.3.2.4.1 | Overview..... | 292 | +| 6.4.3.2.4.2 | Operation: provide-pos-info (POST)..... | 292 | +| 6.4.3.2.4.2.1 | Description..... | 292 | +| 6.4.3.2.4.2.2 | Operation Definition..... | 292 | +| 6.4.3.2.4.3 | Operation: provide-loc-info (POST)..... | 294 | +| 6.4.3.2.4.3.1 | Description..... | 294 | +| 6.4.3.2.4.3.2 | Operation Definition..... | 294 | +| 6.4.3.2.4.4 | Operation: cancel-pos-info (POST)..... | 295 | +| 6.4.3.2.4.4.1 | Description..... | 295 | +| 6.4.3.2.4.4.2 | Operation Definition..... | 296 | +| 6.4.4 | Custom Operations without associated resources..... | 297 | +| 6.4.5 | Notifications..... | 297 | +| 6.4.5.1 | General..... | 297 | +| 6.4.5.2 | Event Notify..... | 297 | +| 6.4.5.2.1 | Description..... | 297 | +| 6.4.5.2.2 | Notification Definition..... | 297 | +| 6.4.5.2.3 | Notification Standard Methods..... | 297 | +| 6.4.5.2.3.1 | POST..... | 297 | +| 6.4.6 | Data Model..... | 298 | +| 6.4.6.1 | General..... | 298 | +| 6.4.6.2 | Structured data types..... | 302 | +| 6.4.6.2.1 | Introduction..... | 302 | +| 6.4.6.2.2 | Type: RequestPosInfo..... | 303 | +| 6.4.6.2.3 | Type: ProvidePosInfo..... | 308 | +| 6.4.6.2.4 | Type: NotifiedPosInfo..... | 312 | +| 6.4.6.2.5 | Type: RequestLocInfo..... | 315 | +| 6.4.6.2.6 | Type: ProvideLocInfo..... | 316 | +| 6.4.6.2.7 | Type: CancelPosInfo..... | 316 | +| 6.4.6.2.11 | Type: ProvidePosInfoExt..... | 317 | +| 6.4.6.2.12 | Type: NotifiedPosInfoExt..... | 317 | +| 6.4.6.3 | Simple data types and enumerations..... | 317 | +| 6.4.6.3.1 | Introduction..... | 317 | +| 6.4.6.3.2 | Simple data types..... | 317 | +| 6.4.6.3.3 | Enumeration: LocationType..... | 318 | +| 6.4.6.3.4 | Enumeration: LocationEvent..... | 318 | +| 6.4.6.3.5 | Enumeration: LocationPrivacyVerResult..... | 318 | +| 6.4.6.3.6 | Enumeration: LpHapType..... | 318 | +| 6.4.7 | Error Handling..... | 319 | +| 6.4.7.1 | General..... | 319 | +| 6.4.7.2 | Protocol Errors..... | 319 | +| 6.4.7.3 | Application Errors..... | 319 | +| 6.4.8 | Feature Negotiation..... | 319 | +| 6.4.9 | Security..... | 320 | +| 6.4.10 | HTTP redirection..... | 320 | +| 6.5 | Namf_MBSBroadcast Service API..... | 321 | +| 6.5.1 | API URI..... | 321 | +| 6.5.2 | Usage of HTTP..... | 321 | +| 6.5.2.1 | General..... | 321 | +| 6.5.2.2 | HTTP standard headers..... | 321 | + +| | | | +|---------------|----------------------------------------------------------|-----| +| 6.5.2.2.1 | General..... | 321 | +| 6.5.2.2.2 | Content type..... | 321 | +| 6.5.2.3 | HTTP custom headers..... | 322 | +| 6.5.2.3.1 | General..... | 322 | +| 6.5.2.4 | HTTP multipart messages..... | 322 | +| 6.5.3 | Resources..... | 323 | +| 6.5.3.1 | Overview..... | 323 | +| 6.5.3.2 | Resource: Broadcast MBS session contexts collection..... | 323 | +| 6.5.3.2.1 | Description..... | 323 | +| 6.5.3.2.2 | Resource Definition..... | 323 | +| 6.5.3.2.3 | Resource Standard Methods..... | 324 | +| 6.5.3.2.3.1 | POST..... | 324 | +| 6.5.3.2.4 | Resource Custom Operations..... | 325 | +| 6.5.3.3 | Resource: Individual broadcast MBS session context..... | 325 | +| 6.5.3.3.1 | Description..... | 325 | +| 6.5.3.3.2 | Resource Definition..... | 325 | +| 6.5.3.3.3 | Resource Standard Methods..... | 325 | +| 6.5.3.3.3.1 | DELETE..... | 325 | +| 6.5.3.3.4 | Resource Custom Operations..... | 326 | +| 6.5.3.2.4.2 | Operation: update (POST)..... | 326 | +| 6.5.3.2.4.2.1 | Description..... | 326 | +| 6.5.3.2.4.2.2 | Operation Definition..... | 326 | +| 6.5.4 | Custom Operations without associated resources..... | 327 | +| 6.5.5 | Notifications..... | 327 | +| 6.5.5.1 | General..... | 327 | +| 6.5.5.2 | Broadcast MBS Session Context Status Notification..... | 328 | +| 6.5.5.2.1 | Description..... | 328 | +| 6.5.5.2.2 | Target URI..... | 328 | +| 6.5.5.2.3 | Notification Standard Methods..... | 328 | +| 6.5.5.2.3.1 | POST..... | 328 | +| 6.5.6 | Data Model..... | 329 | +| 6.5.6.1 | General..... | 329 | +| 6.5.6.2 | Structured data types..... | 330 | +| 6.5.6.2.1 | Introduction..... | 330 | +| 6.5.6.2.2 | Type: ContextCreateReqData..... | 330 | +| 6.5.6.2.3 | Type: ContextCreateRspData..... | 330 | +| 6.5.6.2.4 | Type: ContextStatusNotification..... | 331 | +| 6.5.6.2.5 | Type: ContextUpdateReqData..... | 332 | +| 6.5.6.2.6 | Type: ContextUpdateRspData..... | 332 | +| 6.5.6.2.7 | Type: N2MbsSmInfo..... | 333 | +| 6.5.6.2.8 | Type: OperationEvent..... | 333 | +| 6.5.6.2.9 | Type: NgranFailureEvent..... | 333 | +| 6.5.6.2.10 | Type: ContextStatusNotificationResponse..... | 334 | +| 6.5.6.3 | Simple data types and enumerations..... | 334 | +| 6.5.6.3.1 | Introduction..... | 334 | +| 6.5.6.3.2 | Simple data types..... | 334 | +| 6.5.6.3.3 | Enumeration: OperationStatus..... | 334 | +| 6.5.6.3.4 | Enumeration: NgapIeType..... | 335 | +| 6.5.6.3.5 | Enumeration: OpEventType..... | 335 | +| 6.5.6.3.6 | Enumeration: NgranFailureIndication..... | 335 | +| 6.5.6.4 | Binary data..... | 335 | +| 6.5.6.4.1 | Introduction..... | 335 | +| 6.5.6.4.2 | N2 Information..... | 336 | +| 6.5.6.4.2.1 | Introduction..... | 336 | +| 6.5.6.4.2.2 | NGAP IEs..... | 336 | +| 6.5.7 | Error Handling..... | 336 | +| 6.5.7.1 | General..... | 336 | +| 6.5.7.2 | Protocol Errors..... | 336 | +| 6.5.7.3 | Application Errors..... | 336 | +| 6.5.8 | Feature Negotiation..... | 337 | +| 6.5.9 | Security..... | 337 | + +| | | | +|---------------|------------------------------------------------------|-----| +| 6.5.10 | HTTP redirection..... | 337 | +| 6.6 | Namf_MBSCCommunication Service API..... | 337 | +| 6.6.1 | API URI..... | 337 | +| 6.6.2 | Usage of HTTP..... | 338 | +| 6.6.2.1 | General..... | 338 | +| 6.6.2.2 | HTTP standard headers..... | 338 | +| 6.6.2.2.1 | General..... | 338 | +| 6.6.2.2.2 | Content type..... | 338 | +| 6.6.2.3 | HTTP custom headers..... | 338 | +| 6.6.2.3.1 | General..... | 338 | +| 6.6.2.4 | HTTP multipart messages..... | 339 | +| 6.6.3 | Resources..... | 339 | +| 6.6.3.1 | Overview..... | 339 | +| 6.6.3.1 | Resource: N2 Message Handler (Custom Operation)..... | 340 | +| 6.6.3.1.1 | Description..... | 340 | +| 6.6.3.1.2 | Resource Definition..... | 340 | +| 6.6.3.1.3 | Resource Standard Methods..... | 340 | +| 6.6.3.1.4 | Resource Custom Operations..... | 340 | +| 6.6.3.1.4.1 | Overview..... | 340 | +| 6.6.3.1.4.2 | Operation: transfer..... | 340 | +| 6.6.3.1.4.2.1 | Description..... | 340 | +| 6.6.3.1.4.2.2 | Operation Definition..... | 340 | +| 6.6.4 | Custom Operations without associated resources..... | 341 | +| 6.6.5 | Notifications..... | 341 | +| 6.6.5.1 | General..... | 341 | +| 6.6.5.2 | Notification..... | 342 | +| 6.6.5.2.1 | Description..... | 342 | +| 6.6.5.2.2 | Notification Definitionn..... | 342 | +| 6.6.5.2.3 | Notification Standard Methods..... | 342 | +| 6.6.5.2.3.1 | POST..... | 342 | +| 6.6.6 | Data Model..... | 343 | +| 6.6.6.1 | General..... | 343 | +| 6.6.6.2 | Structured data types..... | 344 | +| 6.6.6.2.1 | Introduction..... | 344 | +| 6.6.6.2.2 | Type: MbsN2MessageTransferReqData..... | 344 | +| 6.6.6.2.3 | Type: MbsN2MessageTransferRspData..... | 344 | +| 6.6.6.2.4 | Type: N2MbsSmInfo..... | 345 | +| 6.6.6.2.5 | Type: Notification..... | 345 | +| 6.6.6.2.6 | Type: RanFailure..... | 345 | +| 6.6.6.3 | Simple data types and enumerations..... | 345 | +| 6.6.6.3.1 | Introduction..... | 345 | +| 6.6.6.3.2 | Simple data types..... | 345 | +| 6.6.6.3.3 | Enumeration: MbsNgapIeType..... | 346 | +| 6.6.6.3.4 | Enumeration: RanFailureIndication..... | 346 | +| 6.6.6.4 | Binary data..... | 346 | +| 6.6.6.4.1 | Introduction..... | 346 | +| 6.6.6.4.2 | N2 Information..... | 346 | +| 6.6.6.4.2.1 | Introduction..... | 346 | +| 6.6.6.4.2.2 | NGAP IEs..... | 346 | +| 6.6.7 | Error Handling..... | 347 | +| 6.6.7.1 | General..... | 347 | +| 6.6.7.2 | Protocol Errors..... | 347 | +| 6.6.7.3 | Application Errors..... | 347 | +| 6.6.8 | Feature Negotiation..... | 347 | +| 6.6.9 | Security..... | 348 | +| 6.6.10 | HTTP redirection..... | 348 | + +| | | | +|-------|---------------------------------------------------------------------|-----| +| A.1 | General..... | 348 | +| A.2 | Namf_Communication API..... | 349 | +| A.3 | Namf_EventExposure API..... | 404 | +| A.4 | Namf_MT..... | 419 | +| A.5 | Namf_Location..... | 424 | +| A.6 | Namf_MBSSroadcast API..... | 433 | +| A.7 | Namf_MBSCommunication API..... | 445 | +| B.1 | Example of HTTP multipart message..... | 448 | +| B.1.1 | General..... | 448 | +| B.1.2 | Example HTTP multipart message with N2 Information binary data..... | 448 | + +## Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document +- might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +- is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the stage 3 protocol and data model for the Namf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the AMF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.247 [55]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +--- + +## 2 References + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [7] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [8] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [9] IETF RFC 2387: "The MIME Multipart/Related Content-type". +- [10] IETF RFC 2045: "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies". +- [11] 3GPP TS 24.501: "Non-Access-Stratum (NAS) Protocol for 5G System (5GS); Stage 3". +- [12] 3GPP TS 38.413: "NG Radio Access Network (NG-RAN); NG Application Protocol (NGAP)". +- [13] 3GPP TS 36.355: "Evolved Universal Terrestrial Radio Access (E-UTRA); LTE Positioning Protocol (LPP)". +- [14] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [15] 3GPP TS 24.007: "Mobile radio interface signalling layer 3; General Aspects". +- [16] 3GPP TS 29.502: "5G System, Session Management Services; Stage 3". +- [17] 3GPP TS 38.455: "NR Positioning Protocol A (NRPPa)". +- [18] 3GPP TS 29.531: "Network Slice Selection Services; Stage 3". +- [19] IETF RFC 9113: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [20] 3GPP TS 23.041: "Technical realization of Cell Broadcast Service (CBS)". +- [21] Void. + +- [22] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [23] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0". +- [24] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [25] 3GPP TS 29.572: "5G System, Location Management Services; Stage 3". +- [26] Void. +- [27] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [28] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [29] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [30] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [31] Void. +- [32] 3GPP TS 29.507: "5G System; Access and Mobility Policy Control Service; Stage 3". +- [33] 3GPP TS 23.527: "5G System; Restoration Procedures". +- [34] 3GPP TS 29.525: "5G System; UE Policy Control Service; Stage 3". +- [35] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [36] IETF RFC 9457: "Problem Details for HTTP APIs". +- [37] 3GPP TR 21.900: "Technical Specification Group working methods". +- [38] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [39] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC); Stage 2". +- [40] IETF RFC 6901: "JavaScript Object Notation (JSON) Pointer". +- [41] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [42] 3GPP TS 23.273: "5G System (5GS) Location Services (LCS); Stage 2". +- [43] 3GPP TS 24.080: "Mobile radio interface layer 3 supplementary services specification; Formats and coding". +- [44] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)". +- [45] 3GPP TS 24.011: "Point-to-Point (PP) Short Message Service (SMS) support on mobile radio interface". +- [46] 3GPP TS 29.515: "5G System; Gateway Mobile Location Services Stage 3". +- [47] 3GPP TS 23.287: "Architecture enhancements for 5G System (5GS) to support Vehicle-to-Everything (V2X) services". +- [48] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [49] 3GPP TS 33.401: "3GPP System Architecture Evolution (SAE); Security architecture". +- [50] 3GPP TS 29.010: "Information element mapping between Mobile Station - Base Station System (MS - BSS) and Base Station System - Mobile-services Switching Centre (BSS - MSC); Signalling Procedures and the Mobile Application Part (MAP)". +- [51] 3GPP TS 23.304: "Proximity based Services (ProSe) in the 5G System (5GS)". + +- [52] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [53] 3GPP TS 24.587: "Vehicle-to-Everything (V2X) services in 5G System (5GS); Stage 3". +- [54] 3GPP TS 24.554: " Proximity-services (ProSe) in 5G System (5GS) protocol aspects; Stage 3". +- [55] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services". +- [56] 3GPP TS 23.256: "Support of Uncrewed Aerial Systems (UAS) connectivity, identification and tracking; Stage 2". +- [57] 3GPP TS 33.256: "Security aspects of Uncrewed Aerial Systems (UAS)". +- [58] 3GPP TS 23.548: "5G System Enhancements for Edge Computing; Stage 2". +- [59] 3GPP TS 23.586: "Architectural Enhancements to support Ranging based services and Sidelink Positioning". +- [60] 3GPP TS 24.577: "Aircraft-to-Everything (A2X) services in 5G system (5GS); Protocol aspects; Stage 3". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 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 TR 21.905 [1]. + +**example:** text used to clarify abstract rules by applying them literally. + +### 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 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 TR 21.905 [1]. + +| | | +|---------|-----------------------------------------| +| 5GC | 5G Core Network | +| 5GS | 5G System | +| 5G-AN | 5G Access Network | +| 5G-GUTI | 5G Globally Unique Temporary Identifier | +| 5QI | 5G QoS Identifier | +| AMF | Access and Mobility Management Function | +| ASTI | Access Stratum TTime | +| DAPS | Dual Active Protocol Stacks | +| DCCF | Data Collection Coordination Function | +| EBI | EPS Bearer Identity | +| GAD | Universal Geographical Area Description | +| GPSI | Generic Public Subscription Identifier | +| GUAMI | Globally Unique AMF Identifier | +| JSON | JavaScript Object Notation | +| LADN | Local Area Data Network | +| LDR | Location Deferred Request | +| LIR | Location Immediate Request | +| LMF | Location Management Function | + +| | | +|---------|----------------------------------------------------------------| +| LPHAP | Low Power and High Accuracy Positioning | +| MA | Multi-Access | +| MBS | Multicast/Broadcast Service | +| MB-SMF | Multicast/Broadcast Session Management Function | +| MM | Mobility Management | +| N3IWF | Non-3GPP InterWorking Function | +| NEF | Network Exposure Function | +| NR | New Radio | +| NRF | Network Repository Function | +| NRPPa | NR Positioning Protocol A | +| NSI ID | Network Slice Instance Identifier | +| NSSAI | Network Slice Selection Assistance Information | +| NSSAA | Network Slice-Specific Authentication and Authorization | +| NWDAF | Network Data Analytics Function | +| PCF | Policy Control Function | +| PEI | Permanent Equipment Identifier | +| PRU | Positioning Reference Unit | +| RAT | Radio Access Type | +| RFSP | RAT/Frequency Selection Priority | +| SARI | Service Area Restriction Information | +| SBI | Service Based Interface | +| SM | Session Management | +| SMF | Session Management Function | +| SMSF | Short Message Service Function | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SUCI | Subscription Concealed Identifier | +| SUPI | Subscription Permanent Identifier | +| TA | Tracking Area | +| TAI | Tracking Area Identity | +| TNAP | Trusted Non-3GPP Access Point | +| TSCTSF | Time Sensitive Communication and Time Synchronization Function | +| TWAP | Trusted WLAN Access Point | +| UDM | Unified Data Management | +| UDSF | Unstructured Data Storage Function | + +--- + +## 4 Overview + +### 4.1 Introduction + +Within the 5GC, the AMF offers services to the SMF, other AMF, PCF, SMSF, LMF, GMLC, CBCF, PWS-IWF, NWDAF, DCCF, NEF, TSCTSF and MB-SMF via the Namf service based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3], 3GPP TS 23.041 [20], 3GPP TS 23.288 [38] and 3GPP TS 23.247 [55]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the AMF and the scope of the present specification. + +![Reference model diagram showing the AMF connected to various network functions via Nn interfaces.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +The diagram illustrates the reference model for the AMF (Access and Management Function). A central AMF block is connected to various network functions (NFs) through interfaces labeled Nn. The NFs and their connections are as follows: + +- Top row:** AMF, NEF, NWDAF, TSCTSF. Connections: AMF to AMF (N14), NEF to AMF (N51), NWDAF to AMF (N11), TSCTSF to AMF (N89). +- Left column:** SMF, PCF, UDM, SMSF, LMF, GMLC, CBCF. Connections: SMF to AMF (N15), PCF to AMF (N11), UDM to AMF (N8), SMSF to AMF (N20), LMF to AMF (NLg), GMLC to AMF (N50), CBCF to AMF (N14). +- Bottom row:** PWS-IWF, DCCF, MB-SMF. Connections: PWS-IWF to AMF (N50), DCCF to AMF (N11mb), MB-SMF to AMF (N11). + +The central AMF block is labeled with 'Namf' on its left side, indicating the service interface. + +Reference model diagram showing the AMF connected to various network functions via Nn interfaces. + +Figure 4.1-1: Reference model – AMF + +The functionalities supported by the AMF are listed in clause 6.2.1 of 3GPP TS 23.501 [2]. + +## 5 Services offered by the AMF + +### 5.1 Introduction + +The table 5.1-1 shows the AMF Services and AMF Service Operations: + +**Table 5.1-1 List of AMF Services** + +| Service Name | Service Operations | Operation Semantics | Example Consumer(s) | +|-----------------------|---------------------------------|----------------------------|-----------------------------------------------| +| Namf_Communication | UEContextTransfer | Request/Response | Peer AMF | +| | RegistrationStatusUpdate | Request/Response | Peer AMF | +| | CreateUEContext | Request/Response | Peer AMF | +| | ReleaseUEContext | Request/Response | Peer AMF | +| | RelocateUEContext | Request/Response | Peer AMF | +| | CancelRelocateUEContext | Request/Response | Peer AMF | +| | N1MessageNotify | Subscribe/Notify | Peer AMF, LMF, PCF | +| | N2InfoNotify | | LMF, AMF | +| | N1N2MessageSubscribe | | PCF | +| | N1N2MessageUnSubscribe | | PCF | +| | N1N2MessageTransfer | Request/Response | Peer AMF, SMF, SMSF, LMF, PCF | +| | N1N2TransferFailureNotification | Subscribe/Notify | SMF, SMSF, LMF, PCF | +| | NonUeN2MessageTransfer | Request/Response | Peer AMF, LMF, CBCF, PWS-IWF, TSCTSF | +| | NonUeN2InfoSubscribe | Subscribe/Notify | CBCF, PWS-IWF, TSCTSF | +| | NonUeN2InfoUnSubscribe | | CBCF, PWS-IWF, TSCTSF | +| | NonUeN2InfoNotify | | LMF, CBCF, PWS-IWF, TSCTSF | +| | EBIAssignment | Request/Response | SMF | +| | AMFStatusChangeSubscribe | Subscribe / Notify | SMF, PCF, NEF, SMSF, UDM | +| | AMFStatusChangeUnSubscribe | Subscribe / Notify | SMF, PCF, NEF, SMSF, UDM | +| | AMFStatusChangeNotify | Subscribe / Notify | SMF, PCF, NEF, SMSF, UDM | +| Namf_EventExposure | Subscribe (see NOTE) | Subscribe/Notify | NEF, SMF, UDM, NWDAF, LMF, GMLC, DCCF, TSCTSF | +| | Unsubscribe (see NOTE) | Subscribe/Notify | NEF, SMF, UDM, NWDAF, LMF, GMLC, DCCF, TSCTSF | +| | Notify | Subscribe/Notify | NEF, SMF, UDM, NWDAF, LMF, GMLC, DCCF, TSCTSF | +| Namf_MT | EnableUEReachability | Request/Response | SMSF, SMF | +| | ProvideDomainSelectionInfo | Request/Response | UDM | +| | EnableGroupReachability | Request/Response | SMF | +| | UEReachabilityInfoNotify | Subscribe/Notify | SMF | +| Namf_Location | ProvidePositioningInfo | Request/Response | GMLC | +| | EventNotify | Subscribe / Notify | GMLC | +| | ProvideLocationInfo | Request/Response | UDM | +| | CancelLocation | Request/Response | GMLC | +| Namf_MBSBroadcast | ContextCreate | Request/Response | MB-SMF | +| | ContextUpdate | Request/Response | MB-SMF | +| | ContextRelease | Request/Response | MB-SMF | +| | ContextStatusNotify | Subscribe / Notify | MB-SMF | +| Namf_MBSCommunication | N2MessageTransfer | Request/Response | MB-SMF | +| | Notify | Subscribe/Notify | MB-SMF | + +NOTE: A subscription applies for one UE, group of UE(s) or any UE. + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Claus
e | Description | OpenAPI Specification File | apiNam
e | Anne
x | +|-----------------------|--------------------|-------------------------------|------------------------------------|---------------------|-------------------| +| Namf_Communication | 6.1 | AMF Communication Service | TS29518_Namf_Communication.yaml | namf-comm | A.2 | +| Namf_EventExposure | 6.2 | AMF Event Exposure Service | TS29518_Namf_EventExposure.yaml | namf-evts | A.3 | +| Namf_MT | 6.3 | AMF Mobile Terminated Service | TS29518_Namf_MT.yaml | namf-mt | A.4 | +| Namf_Location | 6.4 | AMF Location Service | TS29518_Namf_Location.yaml | namf-loc | A.5 | +| Namf_MBSBroadcast | 6.5 | AMF MBS Broadcast Service | TS29518_Namf_MBSBroadcast.yaml | namf-mbs-bc | A.6 | +| Namf_MBSCommunication | 6.6 | AMF MBS Communication Service | TS29518_Namf_MBSCommunication.yaml | namf-mbs-com | A.7 | + +## 5.2 Namf\_Communication Service + +### 5.2.1 Service Description + +This service enables an NF to communicate with the UE through N1 NAS messages or with the AN (both UE and non UE specific). The service operations defined below allow the NF to communicate with the UE and the AN. The following are the key functionalities of this NF service. + +- Provide service operations for transporting N1 messages to the UE; +- Allow NFs to subscribe and unsubscribe for notifications of specific N1 messages from the UE; +- Allow NFs to subscribe and unsubscribe for notifications about specific information from AN; +- Provide service operations for initiating N2 messages towards the AN; +- Security Context Management; and +- UE information management and transfer (including its security context). + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The Namf\_Communication service supports following service operations: + +- UEContextTransfer +- RegistrationStatusUpdate +- N1N2MessageTransfer (UE Specific) +- N1N2TransferFailureNotification (UE Specific) +- N1N2MessageSubscribe (UE Specific) +- N1N2MessageUnsubscribe (UE Specific) + +- N1MessageNotify (UE Specific) +- N2InfoNotify (UE Specific) +- NonUeN2MessageTransfer +- NonUeN2InfoSubscribe +- NonUeN2InfoUnsubscribe +- NonUeN2InfoNotify +- EBIAssignment +- CreateUEContext +- ReleaseUEContext +- RelocateUEContext +- CancelRelocateUEContext +- AMFStatusChangeSubscribe +- AMFStatusChangeUnsubscribe +- AMFStatusChangeNotify + +## 5.2.2.2 UE Context Operations + +### 5.2.2.2.1 UEContextTransfer + +#### 5.2.2.2.1.1 General + +The UEContextTransfer service operation is used during the following procedure: + +- General Registration procedure (see 3GPP TS 23.502 [3], clause 4.2.2.2.2) +- Registration with Onboarding SNPN (see 3GPP TS 23.502 [3], clause 4.2.2.2.4) + +The UEContextTransfer service operation is invoked by a NF Service Consumer, e.g. a target AMF, towards the AMF (acting as source AMF), when the target AMF receives a Registration Request with the UE's 5G-GUTI included and the serving AMF has changed since last registration, to retrieve the UE Context, e.g. the UE's SUPI and MM Context, in the source AMF. + +The NF Service Consumer (e.g. the target AMF) shall retrieve the UE Context by invoking the "transfer" custom method on the URI of an "Individual ueContext" resource identified by UE's 5G-GUTI, see clause 6.1.3.2.4. See also Figure 5.2.2.2.1.1-1. + +![Sequence diagram for UE Context Transfer between NF Service Consumer and AMF.](a3953dce8dbd7ef15d61a314dbef2cf9_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: POST « ue-contexts/{ueContextId}/transfer (UeContextTransferReqData) » + NF Service Consumer->>AMF: Request + Note left of AMF: -2a. 200 OK (UeContextTransferRspData) + AMF-->>NF Service Consumer: Response 2a + Note left of AMF: -2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Response 2b + +``` + +The diagram illustrates the interaction between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF using the URI « ue-contexts/{ueContextId}/transfer » with data of type UeContextTransferReqData. The AMF responds with either a 200 OK (UeContextTransferRspData) or an error status (4xx/5xx ProblemDetails or 3xx). + +Sequence diagram for UE Context Transfer between NF Service Consumer and AMF. + +**Figure 5.2.2.2.1.1-1 UE Context Transfer** + +1. The NF Service Consumer, e.g. target AMF, shall send a HTTP POST request to invoke "transfer" custom method on an "Individual ueContext" resource URI. The content of the request shall be an object of "UeContextTransferReqData" data type. + +If UE Context Transfer is triggered by UE initial registration, mobility registration, disaster roaming initial registration or disaster roaming mobility registration, the NF Service Consumer, e.g. target AMF, shall set the + +reason attribute to "INIT\_REG" or "MOBI\_REG" and include the integrity protected registration request message which triggers the UE context transfer in the content. + +2a. On success: + +- if the reason attribute is "INIT\_REG" and integrity check is successful, the (source) AMF shall respond with the status code "200 OK". The content of the response shall be an object of "UeContextTransferRspData" data type, containing: + - case a) the representation of the requested UE Context as follows: + - without PDU Session Contexts associated to the access type indicated in the request by the NF Service Consumer (e.g. target AMF); and + - with PDU Session Contexts associated to the other access type, if the UE is registered for the other access type in the (source) AMF, unless the source AMF determines based on the PLMN ID or SNPN ID of the (target) AMF that there is no possibility for relocating the N2 interface for non-3GPP access to the (target) AMF; + - or + - case b) the representation of the requested UE Context only containing the "supi" attribute, if the UE is registered in a different access type in the (source) AMF and the source AMF determines based on the PLMN ID of the (target) AMF that there is no possibility for relocating the N2 interface to the (target) AMF. + - If the reason attribute is "MOBI\_REG" and integrity check is successful, the (source) AMF shall respond with the status code "200 OK". The content of the response shall be an object of "UeContextTransferRspData" data type, containing: + - a) the representation of the complete UE Context including available MM and PDU Session Contexts. The source AMF shall transfer the complete UE context including both access types if the UE is registered for both 3GPP and non-3GPP accesses and if the target PLMN is the same as the source PLMN; or + - b) the representation of the requested UE Context including the available MM and PDU Session Contexts for the 3GPP access type, if the UE is registered for both 3GPP and non-3GPP accesses in the (source) AMF and the source AMF determines based on the PLMN ID or SNPN ID of the (target) AMF that there is no possibility for relocating the N2 interface for non-3GPP access to the (target) AMF. +- NOTE: The source AMF can determine that it is not possible to relocate the N2 interface to the target AMF when both AMFs pertain to different PLMNs or SNPNs. + +The UE context shall contain trace control and configuration parameters, if signalling based trace has been activated (see 3GPP TS 32.422 [30]). + +The NF Service Consumer, e.g. target AMF, starts tracing according to the received trace control and configuration parameters, if trace data is received in the UE context indicating that signalling based trace has been activated. Once the NF Service Consumer receives subscription data, trace requirements received from the UDM supersedes the trace requirements received from the AMF. + +The UE context shall contain analytics subscription parameters, if the (source) AMF has created analytics subscription(s) towards NWDAF related to the UE (see clause 5.2.2.2.2 of 3GPP TS 23.502 [3]). The NF Service Consumer, e.g. target AMF, may take over the analytics subscription(s). + +The UE context shall contain event subscriptions information in the following cases: + +- a) Any NF Service Consumer has subscribed for UE specific event; and/or +- b) Any NF Service Consumer has subscribed for UE group specific events to which the UE belongs. In this case the event subscriptions provided in the UE context shall contain the event details applicable to this specific UE in the group (e.g maxReports in options IE). + +The NF Service Consumer, e.g. target AMF, shall: + +- in case a) create event subscriptions for the UE specific events; +- in case b) create event subscriptions for the group Id if there are no existing event subscriptions for that group Id, subscription change notification URI (subsChangeNotifyUri) and the subscription change notification correlation Id (subsChangeNotifyCorrelationId). If there is already an existing event subscription for the group Id, and for the given subscription change notification URI (subsChangeNotifyUri) and subscription change notification correlation Id (subsChangeNotifyCorrelationId), then an event subscription shall not be created at the NF Service Consumer. The individual UE specific event details (e.g maxReports in options IE) within that group shall be taken into account. +- for both the cases, for each created event subscription, allocate a new subscription Id, if necessary (see clause 6.5.2 of 3GPP TS 29.500 [4]), and if allocated, send the new subscription Id to the notification endpoint for informing the subscription Id creation, along with the notification correlation Id for the + +subscription Id change. If the UEContextTransfer service operation is performed towards the old AMF as part of the EPS to 5GS mobility registration procedure using N26 interface (see clause 4.11.1.3.3 of 3GPP TS 23.502 [3]), the target AMF may also initiate event subscription synchronization procedure with UDM, as specified in clause 5.3.2.4.2, when both the target AMF and the UDM support the "ESSYNC" feature. + +NOTE: Subscription Id can be reused if the mobility is between AMFs of same AMF Set. + +If the UE context being transferred from the source AMF is the last UE context that belongs to a UE group Id related subscription, then the source AMF shall not delete the UE group Id related subscription until the expiry of that event subscription (see clause 5.3.2.2.2). + +The target AMF may authorize the event subscriptions transferred from the source AMF as specified in clause 13.4.1.4 of 3GPP TS 33.501 [27]. Based on local policy, the target AMF may consider that transferred subscriptions containing no or an invalid access token are not authorized. Transferred subscriptions that are not authorized by the target AMF shall not be regarded active; if the target AMF supports the STEN (Subscription Termination Event Notification) feature, and if the notification of event subscription termination was requested by the NF service consumer, the target AMF shall send a notification to the NF service consumer to report the termination of the subscription with the subscription termination cause "SUBSCRIPTION\_NOT\_AUTHORIZED". + +The source AMF shall not transfer those PDU sessions which are not supported by the target AMF, e.g. the MA-PDU sessions shall not be transferred if the target AMF does not support ATSSS. + +The UE context shall contain SNPN Onboarding indication, if the UE is registered for onboarding in an SNPN as described in clause 4.2.2.2.4 of 3GPP TS 23.502 [3]. The NF Service Consumer, i.e. target AMF, may start an implementation specific timer to deregister the onboarding registered UE, i.e. if the received UE context contains SNPN Onboarding indication.2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.4.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.4.4.2-2. + +#### 5.2.2.2.1.2 Retrieve UE Context after successful UE authentication + +When a successful UE authentication has been performed after a previous integrity check failure, the NF service consumer (e.g. the target AMF) shall retrieve the UE context by invoking "transfer" service operation on the URI of the "Individual ueContext" resource identified by UE's SUPI. The same requirements in clause 5.2.2.2.1.1 shall be applied with following modifications: + +1. Same as step 1 of figure 5.2.2.2.1.1-1, with following differences: + - The {ueContextId} in the URI shall be composed using UE's SUPI, and + - The "reason" attribute in request body shall be set to "MOBI\_REG\_UE\_VALIDATED", and + - The request body shall not include registration request message from UE. +2. Same as step 2a of figure 5.2.2.2.1.1-1, with following differences: + - The (source) AMF shall skip integrity check and shall respond with the status code "200 OK "with the UE Context excluding SeafData and including available PDU Session Contexts + +#### 5.2.2.2.2 RegistrationStatusUpdate + +##### 5.2.2.2.2.1 General + +The RegistrationStatusUpdate service operation is used during the following procedure: + +- General Registration procedure (see 3GPP TS 23.502 [3], clause 4.2.2.2.2) +- Registration with AMF re-allocation procedure (see 3GPP TS 23.502 [3], clause 4.2.2.2.3) + +The RegistrationStatusUpdate service operation is invoked by a NF Service Consumer, e.g. the target AMF, towards the NF Service Producer, i.e. the source AMF, to update the status of UE registration at the target AMF, thereby indicating the result of previous UE Context transfer for a given UE (see clause 5.2.2.2.1.1). + +The target AMF shall update the NF Service Producer (i.e. source AMF) with the status of the UE registration at the target AMF due to a previous UE Context transfer. The NF Service Consumer (e.g. target AMF) shall use the HTTP + +method POST to invoke the "transfer-update" custom operation on the URI of an "Individual ueContext" resource, see clause 6.1.3.2.4. See also Figure 5.2.2.2.2.1-1. + +![Sequence diagram showing the Registration Status Update procedure. The NF Service Consumer (e.g. Target AMF) sends a POST request to the Source AMF. The Source AMF responds with either 2a. 200 OK (UeRegStatusUpdateRspData) or 2b. 4xx/5xx (ProblemDetails)Or 3xx.](e90987faabad6a6665cd8ed1151dc474_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer (e.g. Target AMF) + participant Source AMF + Note left of NF Service Consumer: POST « ue-contexts/{ueContextId}/transfer-update (UeRegStatusUpdateReqData) » + NF Service Consumer->>Source AMF: POST request + Note right of Source AMF: 2a. 200 OK (UeRegStatusUpdateRspData) + Source AMF-->>NF Service Consumer: 2a. 200 OK + Note right of Source AMF: 2b. 4xx/5xx (ProblemDetails)Or 3xx + Source AMF-->>NF Service Consumer: 2b. 4xx/5xx + +``` + +Sequence diagram showing the Registration Status Update procedure. The NF Service Consumer (e.g. Target AMF) sends a POST request to the Source AMF. The Source AMF responds with either 2a. 200 OK (UeRegStatusUpdateRspData) or 2b. 4xx/5xx (ProblemDetails)Or 3xx. + +**Figure 5.2.2.2.2.1-1 Registration Status Update** + +1. The NF service consumer (e.g. target AMF), shall send a POST request to invoke the "transfer-update" custom operation on the URI of an "Individual ueContext" resource, to update the source AMF with the status of the UE registration at the target AMF. The UE's 5G-GUTI is included as the UE identity. + +The request content shall include the transferStatus attribute set to "TRANSFERRED" if the UE context transfer was completed successfully (including the case where only the supi was transferred to the target AMF during the UE context transfer procedure) or to "NOT\_TRANSFERRED" otherwise. + +If any network slice(s) become no longer available and there are PDU Session(s) associated with them, the target AMF shall include these PDU session(s) in the toReleaseSessionList attribute in the content. If the continuity of the PDU Session(s) cannot be supported between networks (e.g. SNPN-SNPN mobility, inter-PLMN mobility where no HR agreement exists), the target AMF shall include these PDU session(s) with release cause in the toReleaseSessionInfo attribute in the content. + +If the target AMF selects a new PCF for AM Policy and/or UE policy other than the one which was included in the UeContext by the old AMF, the target AMF shall set pcfReselectedInd to true. + +NOTE: AMF selects the same PCF instance for AM policy and for UE policy, as described in clause 6.3.7.1, 3GPP TS 23.501 [2]. + +The NF service consumer shall include the smfChangeInfoList attribute including the UE's PDU Session ID(s) for which the I-SMF or V-SMF has been changed or removed, if any, with for each such PDU session, the related smfChangeIndication attribute set to "CHANGED" or "REMOVED", if the I-SMF or V-SMF is changed or removed respectively. + +If the target AMF receives analytics subscription parameters from the source AMF, and one or more analytics subscription(s) are not taken over by the target AMF, the target AMF shall include these analytics subscription(s) in the analyticsNotUsedList IE. The source AMF may unsubscribe the analytics subscriptions included in analyticsNotUsedList IE for the UE. + +Once the update is received, the source AMF shall: + +- remove the individual ueContext resource and release any PDU session(s) in the toReleaseSessionList attribute, if the transferStatus attribute included in the POST request body is set to "TRANSFERRED" and if the source AMF transferred the complete UE Context including all MM contexts and PDU Session Contexts. The source AMF may choose to start a timer to supervise the release of the UE context resource and may keep the individual ueContext resource until the timer expires. If the pcfReselectedInd is set to true, the source AMF shall terminate the AM Policy Association and/or the UE Policy Association that the source AMF has to the old PCF. + - keep the UE context only including the MM context and PDU session(s) associated to the non-3GPP access, if the transferStatus attribute included in the POST request body is set to "TRANSFERRED" and if the source AMF did not transfer the MM context and PDU Session Contexts for the non-3GPP access type; the AMF shall release any PDU session(s) in the toReleaseSessionList attribute. The source AMF may choose to start a timer and keep the MM context and PDU session(s) associated to the 3GPP access until the timer expires. + - keep the UE Context as if the context transfer procedure had not happened if the transferStatus attribute included in the POST request body is set to "NOT\_TRANSFERRED". +- 2a. On Success: The source AMF shall respond with the status code "200 OK" if the request is accepted. If the smfChangeInfoList attribute was received in the request, the source AMF shall release the SM context at the I- + +SMF or V-SMF only, for all the PDU sessions listed in the smfChangeInfoList attribute with the smfChangeIndication attribute set to "CHANGED" or "REMOVED". + +If some PDU sessions are not supported by the target AMF and thus not transferred to the target AMF, the source AMF shall release these PDU sessions after this step. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.5.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.4.5.2-2, where applicable. + +### 5.2.2.2.3 CreateUEContext + +#### 5.2.2.2.3.1 General + +The CreateUEContext service operation is used during the following procedure: + +- Inter NG-RAN node N2 based handover (see 3GPP TS 23.502 [3], clause 4.9.1.3, and clause 4.23.7) + +The CreateUEContext service operation is invoked by a NF Service Consumer, e.g. a source AMF, towards the AMF (acting as target AMF), when the source AMF can't serve the UE and selects the target AMF during the handover procedure, to create the UE Context in the target AMF. + +The NF Service Consumer (e.g. the source AMF) shall create the UE Context by using the HTTP PUT method with the URI of the "Individual UeContext" resource (See clause 6.1.3.2.3.1). See also Figure 5.2.2.2.3.1-1. + +![Sequence diagram showing the Create UE Context procedure. An NF Service Consumer sends a PUT request to an AMF. The AMF responds with either a 201 Created status or a 4xx/5xx error status.](49a49278cad196bdfe0db6b4dd1be7fd_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. PUT .../ue-contexts/{ueContextId}(UeContextCreateData) + NF Service Consumer->>AMF: Request + Note right of AMF: -2a. 201 Created (UeContextCreatedData) + AMF-->>NF Service Consumer: Response 2a + Note right of AMF: -2b. 4xx/5xx (UeContextCreateError) or 3xx + AMF-->>NF Service Consumer: Response 2b + +``` + +Sequence diagram showing the Create UE Context procedure. An NF Service Consumer sends a PUT request to an AMF. The AMF responds with either a 201 Created status or a 4xx/5xx error status. + +Figure 5.2.2.2.3.1-1 Create UE Context + +1. The NF Service Consumer, e.g. source AMF, shall send a PUT request, to create the ueContext in the target AMF. The content of the PUT request shall contain a UeContextCreateData structure, including a N2 Information Notification callback URI. + +The UE context shall contain trace control and configuration parameters, if signalling based trace has been activated (see 3GPP TS 32.422 [30]). + +The source AMF shall transfer the complete UE context including both access types if the UE is registered for both 3GPP and non-3GPP accesses and if the target PLMN is the same as the source PLMN. + +The source AMF shall transfer only UE context for 3GPP access if the source AMF determines there is no possibility for relocating the N2 interface for non-3GPP access to the (target) AMF, e.g. when the target AMF is in another PLMN. + +For a UE supporting 5G-SRVCC, the NF Service Consumer (i.e. AMF) shall include the Mobile Station Classmark 2, STN-SR, C-MSISDN and Supported Codec List in the request, if available, as specified in 3GPP TS 23.502 [3]. + +The UE context shall contain analytics subscription parameters, if the (source) AMF has created analytics subscription(s) towards NWDAF related to the UE (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]). The NF service producer, e.g. target AMF, may take over the analytics subscription(s). + +The UE context shall contain SNPN Onboarding indication and the target AMF shall support SNPN Onboarding, if the UE is registered for onboarding in an SNPN as described in clause 4.2.2.2.4 of 3GPP TS 23.502 [3]. + +- 2a. On success, the target AMF shall respond with the status code "201 Created" if the request is accepted, together with a HTTP Location header to provide the location of a newly created resource. The content of the PUT + +response shall contain the representation of the created UE Context. If the target AMF selects a new PCF for AM Policy other than the one which was included in the UeContext by the old AMF, the target AMF shall set pcfReselectedInd to true. If the pcfReselectedInd is set to true, the source AMF shall terminate the AM Policy Association to the old PCF. + +The target AMF starts tracing according to the received trace control and configuration parameters, if trace data is received in the UE context indicating that signalling based trace has been activated. Once the AMF receives subscription data, trace requirements received from the UDM supersedes the trace requirements received from the NF Service Consumer. + +If the target AMF receives analytics subscription parameters from the source AMF, and one or more analytics subscription(s) are not taken over by the target AMF, the target AMF shall include these analytics subscription(s) in the analyticsNotUsedList IE. The source AMF may unsubscribe the analytics subscriptions included in analyticsNotUsedList IE for the UE. + +The UE context shall contain event subscriptions information in the following cases: + +- a) Any NF Service Consumer has subscribed for UE specific event; and/or +- b) Any NF Service Consumer has subscribed for UE group specific events to which the UE belongs. In this case the event subscriptions provided in the UE context shall contain the event details applicable to this specific UE in the group (e.g maxReports in options IE). + +The target AMF shall: + +- in case a) create event subscriptions for the UE specific events; +- in case b) create event subscriptions for the group Id if there are no existing event subscriptions for that group Id, subscription change notification URI (subsChangeNotifyUri) and the subscription change notification correlation Id (subsChangeNotifyCorrelationId). If there is already an existing event subscription for the group Id and for the given subscription change notification URI (subsChangeNotifyUri) and subscription Id change notification correlation Id (subsChangeNotifyCorrelationId), then an event subscription shall not be created at the target AMF. The individual UE specific event details (e.g maxReports in options IE) within that group shall be taken into account. +- for both the cases, for each created event subscription, allocate a new subscription Id, if necessary (see clause 6.5.2 of 3GPP TS 29.500 [4]), and if allocated send the new subscription Id to the notification endpoint for informing the subscription Id creation, along with the notification correlation Id for the subscription Id change. + +NOTE: Subscription Id can be reused if the mobility is between AMFs of same AMF Set. + +If the UE context being transferred from the NF service consumer (e.g. source AMF) is the last UE context that belongs to a UE group Id related subscription, then the NF service consumer (e.g. source AMF) shall not delete the UE group Id related subscription until the expiry of that event subscription (see clause 5.3.2.2.2). + +The target AMF may authorize the event subscriptions transferred from the source AMF as specified in clause 13.4.1.4 of 3GPP TS 33.501 [27]. Based on local policy, the target AMF may consider that transferred subscriptions containing no or an invalid access token are not authorized. Transferred subscriptions that are not authorized by the target AMF shall not be regarded active; if the target AMF supports the STEN (Subscription Termination Event Notification) feature, and if the notification of event subscription termination was requested by the NF service consumer, the target AMF shall send a notification to the NF service consumer to report the termination of the subscription with the subscription termination cause "SUBSCRIPTION\_NOT\_AUTHORIZED". + +If the target AMF receives SNPN Onboarding indication from the source AMF, the target AMF may start an implementation specific timer to deregister the onboarding registered UE, i.e. if the received UE context contains SNPN Onboarding indication. + +The source AMF shall: release those PDU sessions not supported by the target AMF and thus not transferred to the target AMF. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a UeContextCreateError structure, including: + +- a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.3.1-3. The cause in the error attribute shall be set to HANDOVER\_FAILURE, if all of the PDU sessions are failed, e.g. no response from the SMF within a maximum wait timer; +- NgAPCause, if available; +- N2 information carrying the Target to Source Failure Transparent Container, if this information has been received from the target NG-RAN and if the source AMF supports the NPN feature. + +### 5.2.2.2.3.2 Create UE Context with AMF Relocation + +During inter-PLMN N2 Handover, the initial AMF may relocate the UE context to a target AMF (e.g. due to slices cannot be served by initial AMF). This clause describes the procedure for this scenario. + +The NF Service Consumer (e.g. the source AMF) shall create the UE Context by using the HTTP PUT method with the URI of the "Individual UeContext" resource (See clause 6.1.3.2.3.1). See also Figure 5.2.2.2.3.2-1. + +![Sequence diagram for Create UE Context with AMF Relocation. The diagram shows three lifelines: NF Service Consumer, Initial AMF, and Target AMF. Step 1: NF Service Consumer sends a PUT request to Initial AMF. Step 2: Initial AMF performs a 'Create UE Context Procedure' with Target AMF. Step 3a: Initial AMF sends a 201 Created response to NF Service Consumer. Step 3b: Initial AMF sends an error response (4xx/5xx or 3xx) to NF Service Consumer.](6470d350326789d5306eabcb76533951_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant Initial AMF + participant Target AMF + Note right of Initial AMF: 2. Create UE Context Procedure + NF Service Consumer->>Initial AMF: 1. PUT « ue-contexts/{ueContextId}(UeContextCreateData) » + Initial AMF-->>NF Service Consumer: 3a. 201 Created (UeContextCreatedData) + Initial AMF-->>NF Service Consumer: 3b. 4xx/5xx (UeContextCreateError) or 3xx + +``` + +Sequence diagram for Create UE Context with AMF Relocation. The diagram shows three lifelines: NF Service Consumer, Initial AMF, and Target AMF. Step 1: NF Service Consumer sends a PUT request to Initial AMF. Step 2: Initial AMF performs a 'Create UE Context Procedure' with Target AMF. Step 3a: Initial AMF sends a 201 Created response to NF Service Consumer. Step 3b: Initial AMF sends an error response (4xx/5xx or 3xx) to NF Service Consumer. + +**Figure 5.2.2.2.3.2-1 Create UE Context with AMF Relocation** + +Same requirement of clause 5.2.2.2.3.1 applies, with following modifications: + +1. Same as step 1 of clause 5.2.2.2.3.1. +2. The initial AMF selects a target AMF and perform CreateUeContext procedure (see clause 5.2.2.2.3.1). + - the request body shall include the information received from the source AMF in step 1, including the serving network, the supported features, etc. + - if the received serving network (from the source AMF) is different from the PLMN of the target AMF, the resource URI in the Location header in 201 Create response shall contain the inter-PLMN API Root. +- 3a. Same as step 2a of clause 5.2.2.2.3.1, with following modifications: + - the request body shall contain the UE Context and other information received from the target AMF in step 2. + - the Location header shall contain the resource URI received in the "201 Created" response from target AMF in step 2. + - the initial AMF shall insert a 3gpp-Sbi-Producer-Id header indicating the target AMF. +- 3b. Same as step 2b of clause 5.2.2.2.3.1. + +### 5.2.2.2.4 ReleaseUEContext + +#### 5.2.2.2.4.1 General + +The ReleaseUEContext service operation is used during the following procedure: + +- Inter NG-RAN node N2 based handover, Cancel procedure (see 3GPP TS 23.502 [3], clause 4.9.1.4) + +The ReleaseUEContext service operation is invoked by a NF Service Consumer, e.g. a source AMF, towards the AMF (acting as target AMF), when the source AMF receives the Handover Cancel from the 5G-AN during the handover procedure, to release the UE Context in the target AMF. + +The NF Service Consumer (e.g. the source AMF) shall release the UE Context by using the HTTP "release" custom operation with the URI of the "Individual UeContext" resource (See clause 6.1.3.2.4.2). See also Figure 5.2.2.2.4.1-1. + +![Sequence diagram for Figure 5.2.2.4.1-1 Release UE Context. It shows an NF Service Consumer sending a POST request to an AMF. The AMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. POST « /ue-contexts/{ueContextId}/release(UEContextRelease) » + NF Service Consumer->>AMF: Request + Note left of AMF: 2a. 204 No Content + AMF-->>NF Service Consumer: Success Response + Note left of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for Figure 5.2.2.4.1-1 Release UE Context. It shows an NF Service Consumer sending a POST request to an AMF. The AMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +**Figure 5.2.2.4.1-1 Release UE Context** + +1. The NF Service Consumer, e.g. source AMF, shall send a POST request, to release the ueContext in the target AMF. The content of the POST request shall contain the UEContextRelease. +- 2a. On success, the target AMF shall return "204 No Content" with an empty content in the POST response. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.4.2.2-2. + +**5.2.2.2.5 RelocateUEContext** + +**5.2.2.2.5.1 General** + +The RelocateUEContext service operation is used during the following procedure: + +- EPS to 5GS handover using N26 interface with AMF re-allocation (see 3GPP TS 23.502 [3], clause 4.11.1.2.2). + +The RelocateUEContext service operation is invoked by a NF Service Consumer, e.g. an initial AMF, towards the AMF (acting as target AMF), during an EPS to 5GS handover with AMF re-allocation, to relocate the UE Context in the target AMF. + +The NF Service Consumer (e.g. the initial AMF) shall relocate the UE Context in the target AMF by invoking the "relocate" custom method on the URI of an "Individual ueContext" resource (see clause 6.1.3.2.4). See also Figure 5.2.2.2.5.1-1. + +![Sequence diagram for Figure 5.2.2.2.5.1-1 Relocate UE Context. It shows an NF Service Consumer sending a POST request to an AMF. The AMF responds with two dashed return arrows, representing the successful relocation of the UE context.](dfa6249d64e9f63db89f2c5b7bbd01de_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: POST request to relocate UE context + NF Service Consumer->>AMF: Request + Note left of AMF: Success + AMF-->>NF Service Consumer: Response + Note left of AMF: Success + AMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for Figure 5.2.2.2.5.1-1 Relocate UE Context. It shows an NF Service Consumer sending a POST request to an AMF. The AMF responds with two dashed return arrows, representing the successful relocation of the UE context. + +**Figure 5.2.2.2.5.1-1 Relocate UE Context** + +1. The NF Service Consumer, e.g. initial AMF, shall send a POST request to relocate the UE context in the target AMF. The content of the POST request shall contain a UeContextRelocateData structure. + +The UE context shall contain trace control and configuration parameters, if signalling based trace has been activated (see 3GPP TS 32.422 [30]). + +For an EPS to 5GS handover procedure, the NF Service Consumer shall carry per PDU session the S-NSSAI for serving PLMN, the MME Control Plane Address and the TEID in the request. If S-NSSAI for interworking is configured and used in initial AMF for the PDU session, the initial AMF shall also carry the configured S-NSSAI for interworking to the target AMF, as specified in clause 4.11.1.2.2 of 3GPP TS 23.502 [3]. In Home Routed roaming case, the S-NSSAI for serving PLMN is derived by the initial AMF based on the S-NSSAI for home PLMN retrieved from SMF+PGW-C, as specified in 3GPP TS 23.502 [3]. + +- 2a. On success, the target AMF shall respond with the status code "201 Created" if the request is accepted, together with a HTTP Location header to provide the location of the newly created resource. The content of the POST response shall contain the representation of the created UE Context. + +The target AMF starts tracing according to the received trace control and configuration parameters, if trace data is received in the UE context indicating that signalling based trace has been activated. Once the AMF receives subscription data, trace requirements received from the UDM supersedes the trace requirements received from the NF Service Consumer. + +- 2b. On failure to relocate the UE context or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.6.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.4.6.2-2. + +If the target RAN rejects the Handover Request, the target AMF shall send Forward Relocation Response message directly to the source MME over the N26 interface, carrying the appropriate cause value. + +#### 5.2.2.2.6 CancelRelocateUEContext + +##### 5.2.2.2.6.1 General + +The CancelRelocateUEContext service operation is used during the following procedure: + +- EPS to 5GS Handover with AMF re-allocation, Handover Cancel procedure (see 3GPP TS 23.502 [3], clause 4.11.1.2.3) + +The CancelRelocateUEContext service operation is invoked by a NF Service Consumer (i.e. initial AMF), towards the AMF (acting as target AMF), when the initial AMF receives Forward Cancel Request from the source MME during EPS to 5GS Handover with AMF re-allocation procedure, to trigger the target AMF to release the UE Context. + +The NF Service Consumer (i.e. the initial AMF) shall cancel the UE Context Relocation by using the HTTP "cancel-relocate" custom operation with the URI of the "Individual UeContext" resource (See clause 6.1.3.2.4.2). See also Figure 5.2.2.2.6.1-1. + +![Sequence diagram for Cancel Relocate UE Context. It shows two vertical dashed lines representing lifelines. A solid horizontal arrow points from the left lifeline to the right lifeline. Below it, a dashed horizontal arrow points from the right lifeline back to the left lifeline. At the bottom, another dashed horizontal arrow points from the right lifeline back to the left lifeline. There are rectangular boxes at the top of each lifeline and small rectangular boxes on the return arrows.](0977b81510f7649846289ee785d20e74_img.jpg) + +Sequence diagram for Cancel Relocate UE Context. It shows two vertical dashed lines representing lifelines. A solid horizontal arrow points from the left lifeline to the right lifeline. Below it, a dashed horizontal arrow points from the right lifeline back to the left lifeline. At the bottom, another dashed horizontal arrow points from the right lifeline back to the left lifeline. There are rectangular boxes at the top of each lifeline and small rectangular boxes on the return arrows. + +**Figure 5.2.2.2.6.1-1 Cancel Relocate UE Context** + +1. The NF Service Consumer, i.e. initial AMF, shall send a POST request, to release the ueContext in the target AMF. The content of the POST request shall contain the UeContextCancelRelocateData that needs to be passed to the target AMF. +- 2a. On success, the target AMF shall return "204 No Content" with an empty content in the POST response. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.7.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.4.7.2-2. + +### 5.2.2.3 UE Specific N1N2 Message Operations + +#### 5.2.2.3.1 N1N2MessageTransfer + +##### 5.2.2.3.1.1 General + +The N1N2MessageTransfer service operation is used by a NF Service Consumer to transfer N1 and/or N2 information to the UE and/or 5G-AN through the AMF in the following procedures: + +- Network triggered Service Request (see clause 4.2.3.3 of 3GPP TS 23.502 [3]) +- PDU Session establishment (see clause 4.3.2 of 3GPP TS 23.502 [3]) +- PDU Session modification (see clause 4.3.3 of 3GPP TS 23.502 [3]) +- PDU Session release (see clause 4.3.4 of TS 3GPP 23.502 [3]) +- Session continuity, service continuity and UP path management (see clause 4.3.5 of 3GPP TS 23.502 [3]) +- Inter NG-RAN node N2 based handover (see clause 4.9.1.3 of 3GPP TS 23.502 [3]) +- SMS over NAS procedures (see clause 4.13.3 of 3GPP TS 23.502 [3]) +- UE assisted and UE based positioning procedure (see clause 6.11.1 of 3GPP TS 23.273 [42]) +- Network assisted positioning procedure (see clause 6.11.2 of 3GPP TS 23.273 [42]) +- LCS Event Report, Event Reporting in RRC INACTIVE state procedures, LCS Cancel Location and LCS Periodic-Triggered Invoke procedures (see clause 6.3, clause 6.7 and clause 6.20.3 of 3GPP TS 23.273 [42]) +- UE configuration update procedure for transparent UE policy delivery (see clause 4.2.4.3 of 3GPP TS 23.502 [3]) +- UPF anchored Mobile Terminated Data Transport in Control Plane CIoT 5GS Optimisation (see clause 4.24.2 of 3GPP TS 23.502 [3]) +- NEF Anchored Mobile Terminated Data Transport (see clause 4.25.5 of 3GPP TS 23.502 [3]) +- System interworking procedures with EPC (see clause 4.3 in 3GPP TS 23.501 [2] and clause 4.11 in 3GPP TS 23.502 [3]) +- SMF triggered N3 data transfer establishment procedure (see clause 4.2.10.2 of 3GPP TS 23.502 [3]) +- 5G-RG requested PDU Session Establishment via W-5GAN (see clause 7.3.1 of 3GPP TS 23.316 [48]) +- 5G-RG or Network requested PDU Session Modification via W-5GAN (see clause 7.3.2 of 3GPP TS 23.316 [48]) +- 5G-RG or Network requested PDU Session Release via W-5GAN (see clause 7.3.3 of 3GPP TS 23.316 [48]) +- FN-RG related PDU Session Establishment via W-5GAN (see clause 7.3.4 of 3GPP TS 23.316 [48]) +- CN-initiated selective deactivation of UP connection of an existing PDU Session associated with W-5GAN Access (see clause 7.3.5 of 3GPP TS 23.316 [48]) +- FN-RG or Network Requested PDU Session Modification via W-5GAN (see clause 7.3.6 of 3GPP TS 23.316 [48]) +- FN-RG or Network Requested PDU Session Release via W-5GAN (see clause 7.3.7 of 3GPP TS 23.316 [48]) +- Non-5G capable device behind 5G-CRG and FN-CRG requested PDU Session Establishment via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [48]) +- Non-5G capable device behind 5G-CRG and FN-CRG or Network Requested PDU Session Modification via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [48]) +- Non-5G capable device behind 5G-CRG and FN-CRG or Network Requested PDU Session Release via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [48]) +- Handover procedures between 3GPP access / 5GC and W-5GAN access (see clause 7.6.3 of 3GPP TS 23.316 [48]) + +- Handover from 3GPP access / EPS to W-5GAN / 5GC (see clause 7.6.4.1 of 3GPP TS 23.316 [48]) +- Transfer UAV specific data via N1 SM (see clause 5.2.4.3 of 3GPP TS 23.256 [56]) +- MBS join and Session establishment procedure (see clause 7.2.1.3 of 3GPP TS 23.247 [55]) +- MBS activation procedure (see clause 7.2.5.2 of 3GPP TS 23.247 [55]) +- Multicast session leave requested by the network or MBS session release (see clause 7.2.2.3 of 3GPP TS 23.247 [55]) +- Procedures applicable to a PRU (see clause 6.17 of 3GPP TS 23.273 [42]) +- Procedures of SL-MT-LR involving LMF (see 3GPP TS 23.273 [42], clause 6.20.3) +- Procedures of SL-MT-LR for periodic, triggered Location Events (see 3GPP TS 23.273 [42], clause 6.20.4) +- 5GC-MT-LR Procedure using SL positioning (see 3GPP TS 23.273 [42], clause 6.20.5) + +NOTE: Though in 3GPP TS 23.502 [3] the procedure is called "UE configuration update procedure for transparent UE policy delivery", as per 3GPP TS 24.501 [11] clause 5.4.5.3.1, the network initiated NAS transport procedure is used. + +The NF Service Consumer shall invoke the service operation by using HTTP method POST, to request the AMF to transfer N1 and/or N2 information for a UE and/or 5G-AN, with the URI of "N1 N2 Messages Collection" resource (see clause 6.1.3.5.3.1). + +The NF Service Consumer may include the following information in the HTTP Request message body: + +- SUPI +- PDU Session ID or LCS Correlation ID depending on the N1/N2 message class to be transferred +- N2 SM Information (PDU Session ID, QoS profile, CN N3 Tunnel Info, S-NSSAI) +- N1 Message Container, including a N1 SM, LPP message, LCS message, SMS, UPDP message, PRU message +- N2 Information Container, including N2 SM, NRPPa message, PWS or RAN related information +- Mobile Terminated Data (i.e. CIoT user data container) +- Allocation and Retention Priority (ARP) +- Paging Policy Indication +- 5QI +- Notification URL (used for receiving Paging Failure Indication) +- Last Message Indication +- NF Instance Identifier and optionally Service Instance Identifier of the NF Service Consumer (e.g. an LMF or SMF) +- N1 SM Skipping Indication +- Area of Validity for N2 SM Information +- A MA PDU Session Accepted indication, if a MA-PDU session is established; +- Extended Buffering Support Indication, if SMF determines that Extended Buffering applies during Network triggered Service Request Procedure (see clause 4.2.3.3 of 3GPP TS 23.502 [3]), UPF anchored Mobile Terminated Data Transport in Control Plane CIoT 5GS Optimisation procedure (see clause 4.24.2 of 3GPP TS 23.502 [3]) or NEF Anchored Mobile Terminated Data Transport (see clause 4.25.5 of 3GPP TS 23.502 [3]); +- Target Access type towards which the SMF requests to send N2 information and optionally N1 information, for a Multi-Access (MA) PDU session, or through which the LMF requests to transfer an LPP message to the UE. + +During an intra-AMF handover between 3GPP and non-3GPP accesses, the SMF shall include the targetAccess IE set to the old access type in the HTTP Request message body, when releasing the N2 PDU session resources in the old access (see step 3 of Figure 4.9.2.1-1 and step 3 of Figure 4.9.2.2-1 of 3GPP TS 23.502 [3]). + +![Sequence diagram showing N1N2MessageTransfer for UE related signalling between NF Service Consumer and AMF. The NF Service Consumer sends a POST request to /ue-contexts/{ueContextId}/n1-n2-messages. The AMF responds with either a 202 or 200 status code (N1N2MessageTransferRspData) or a 4xx/5xx status code (N1N2MessageTransferError) or 3xx.](6e15fc9ea763541c5913d26f85072ae1_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. POST .../ue-contexts/{ueContextId}/n1-n2-messages(N1N2MessageTransferReqData) + NF Service Consumer->>AMF: Request + Note right of AMF: 2a. 202 or 200 (N1N2MessageTransferRspData) + AMF-->>NF Service Consumer: Success Response + Note right of AMF: 2b. 4xx/5xx (N1N2MessageTransferError) or 3xx + AMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram showing N1N2MessageTransfer for UE related signalling between NF Service Consumer and AMF. The NF Service Consumer sends a POST request to /ue-contexts/{ueContextId}/n1-n2-messages. The AMF responds with either a 202 or 200 status code (N1N2MessageTransferRspData) or a 4xx/5xx status code (N1N2MessageTransferError) or 3xx. + +**Figure 5.2.2.3.1.1-1 N1N2MessageTransfer for UE related signalling** + +1. The NF Service Consumer shall send a POST request to transfer N1 and N2 information. The NF Service Consumer may include a N1N2MessageTransfer Notification URI to AMF in the request message. +- 2a. On success, i.e. if the request is accepted and the AMF is able to transfer the N1/N2 message to the UE and/or the AN, the AMF shall respond with a "200 OK" status code. The AMF shall set the cause IE in the N1N2MessageTransferRspData as "N1\_N2\_TRANSFER\_INITIATED" in this case. + +The AMF shall respond with a "200 OK" status code and set the cause IE in the N1N2MessageTransferRspData to "N2\_MSG\_NOT\_TRANSFERRED", if the N1N2MessageTransfer request included an area of validity for the N2 SM Information, the UE is in CM-CONNECTED state and outside of the area of validity. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.5.3.1-2 shall be returned. For a 4xx/5xx response, the message body shall contain a N1N2MessageTransferError structure, including: + - a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.5.3.1-2; + +#### 5.2.2.3.1.2 Detailed behaviour of the AMF + +When an NF service consumer is requesting to send N1 and/or N2 information and the UE is in CM-IDLE state for the access type for which the N1 and/or N2 information is related (called "associated access type" hereafter in this clause), the requirements specified in clause 5.2.2.3.1.1 shall apply with the following modifications: + +NOTE: N1 and/or N2 Session Management information is related to the access type of the targeted PDU session for a single access PDU session, or to the Target Access received in the request for a MA PDU session; LCS related N2 (NRPPa) information is related to 3GPP access in this release of specification. + +4xx and 5xx response cases shall also apply to UEs in CM-CONNECTED state, when applicable. + +#### 2xx Response Cases: + +##### Case A: When UE is CM-IDLE in 3GPP access and the associated access type is 3GPP access: + +- a) Same as step 2a of Figure 5.2.2.3.1.1-1, the AMF should respond with the status code "200 OK", if "skipInd" attribute is set to "true" in the request body, with a response body that carries the cause "N1\_MSG\_NOT\_TRANSFERRED". +- b) Same as step 2a of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "202 Accepted", if the asynchronous type communication is invoked and hence the UE is not paged, update the UE context and store N1 and/or N2 information and initiate communication with the UE and/or 5G-AN when the UE becomes reachable. In this case the AMF shall provide the URI of the resource in the AMF in the "Location" header of the response. In this release, the URI shall only be used by NF Service consumer to correlate the possible N1/N2 Message Transfer Failure Notification with the related N1/N2 Message Transfer Operation. The NF service consumer shall not send any service requests towards the URI received in the Location header. + +The AMF shall also provide a response body containing the cause, "WAITING\_FOR\_ASYNCHRONOUS\_TRANSFER" that represents the current status of the N1/N2 message transfer; + +- c) Same as step 2a of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "202 Accepted", if paging is issued when the UE is in CM-IDLE and reachable for 3GPP access, with a response body that carries a cause "ATTEMPTING\_TO\_REACH\_UE" as specified in clause 4.2.3.3 and 5.2.2.2.7 of 3GPP TS 23.502 [3]. + +**Case B: When UE is CM-IDLE in Non-3GPP access but CM-CONNECTED in 3GPP access and the associated access type is Non-3GPP access:** + +- a) Same as step 2a of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "200 OK" with cause "N1\_N2\_TRANSFER\_INITIATED" and initiate N1 NAS SM message transfer via 3GPP access, if the NF service consumer (i.e. SMF) requests to send only N1 NAS SM message without any associated N2 SM information, and the current access type related to the PDU session is Non-3GPP access and the UE is CM-CONNECTED in 3GPP access. +- b) Same as step 2a of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "202 Accepted", if NAS Notification procedure is issued when the UE is in CM-CONNECTED in 3GPP access, with a response body that carries a cause "ATTEMPTING\_TO\_REACH\_UE" as specified in step 4c of clause 4.2.3.3 and 5.2.2.2.7 of 3GPP TS 23.502 [3]. + +**Case C: When UE is CM-IDLE in both Non-3GPP access and 3GPP access and the associated access type is Non-3GPP access:** + +All the bullets specified in Case A are applicable. + +The NF Service Consumer shall not send any further signalling for the UE if it receives a POST response body with a cause "ATTEMPTING\_TO\_REACH\_UE" unless it has higher priority signalling. In such a case the response shall include the "Location" header containing the URI of the resource created in the AMF, e.g. + +".../n1-n2-messages/{n1N2MessageId}". In this release, the URI shall only be used by NF Service consumer to correlate the possible N1/N2 Message Transfer Failure Notification with the related N1/N2 Message Transfer Operation. The NF service consumer shall not send any service requests towards the URI received in the Location header. The AMF shall: + +- store the N1 and/or N2 information related to 3GPP access and, when the UE responds with a Service Request, shall initiate communication with the UE and/or 5G-AN using the stored N1 and/or N2 information; +- store the N1 NAS SM information related to Non-3GPP access if no N2 information was received and the AMF initiated paging towards the UE. Later when the UE responds with a Service Request, the AMF shall initiate communication with the UE using the stored N1 information via 3GPP access; +- inform the SMF which invoked the service operation, that the access type of the PDU Session can be changed from Non-3GPP access to 3GPP access as specified in clause 5.2.2.3.2.1 of 3GPP TS 29.502 [16], when the UE responds with a "List Of Allowed PDU Sessions" and the indicated non-3GPP PDU session of the N2 (and N1 if received) information is included in the list; or +- notify the NF which invoked the service operation, as specified in clause 5.2.2.3.2, if the Notification URI is provided, when the AMF determines that the paging or NAS Notification has failed or when the UE responds with a "List Of Allowed PDU Sessions" and the indicated Non-3GPP PDU session of the N2 (and N1 if received) information is not included in the list. + +**4xx Response Cases:** + +- Same as step 2b of Figure 5.2.2.3.1.1-1, the AMF shall respond with status code "409 Conflict" in the following cases: + - if the UE is in 3GPP access and there is already an ongoing paging procedure with higher or same priority, the AMF shall set the application error as "HIGHER\_PRIORITY\_REQUEST\_ONGOING" in the "cause" attribute of the ProblemDetails structure of the POST response body. The AMF may provide a retryAfter IE to the NF Service Consumer in order for the NF Service Consumer to retry the request after the expiry of the timer. When the retryAfter IE is provided, the NF Service Consumer shall not initiate the downlink messaging until the timer expires. The AMF may also provide the ARP value of the QoS flow that has triggered the currently ongoing highest priority paging, so that the NF Service Consumer (e.g. SMF) knows that if any subsequent trigger initiating downlink messaging for a QoS flow with the same or lower priority happens. + - if there is an ongoing registration procedure (see clause 4.2.3.3 of 3GPP TS 23.502 [3]) the AMF shall set the application error as "TEMPORARY\_REJECT\_REGISTRATION\_ONGOING" in the "cause" attribute of the ProblemDetails structure in the POST response body; The AMF may provide a retryAfter IE to the NF Service Consumer in order for the NF Service Consumer to retry the request after a short period. When the retryAfter IE is provided, the NF Service Consumer should not initiate new N1/N2 Message Transfer request until the timer expires. + +- if this is a request to transfer a N2 PDU Session Resource Modify Request or a N2 PDU Session Resource Release Command to a 5G-AN and if the UE is in CM-IDLE state at the AMF for the Access Network Type associated to the PDU session (see clauses 4.3.3 and 4.3.4 of 3GPP TS 23.502 [3] and clause 5.3.2.1 of 3GPP TS 23.527 [33]), the AMF shall set the application error "UE\_IN\_CM\_IDLE\_STATE" in the "cause" attribute of the ProblemDetails structure in the POST response body. +- if there is an ongoing Xn or N2 handover procedure (see clause 4.9.1.2.1 and 4.9.1.3.1 of 3GPP TS 23.502 [3]) the AMF shall set the application error as "TEMPORARY\_REJECT\_HANDOVER\_ONGOING" in the "cause" attribute of the ProblemDetails structure in the POST response body, if the AMF rejects the request due to the on-going handover. +- if the RAT Type is NB-IoT, and the UE already has 2 PDU Sessions with active user plane resources, the AMF shall set the application error as "MAX\_ACTIVE\_SESSIONS\_EXCEEDED" in POST response body. +- if Paging Restrictions information restricts the N1N2MessageTransfer request from causing paging (see clause 4.2.3.3 of 3GPP TS 23.502 [3]) the AMF shall set the application error as "REJECTION\_DUE\_TO\_PAGING\_RESTRICTION" in the "cause" attribute of the ProblemDetails structure in the POST response body. +- Same as step 2b of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "403 Forbidden", if the UE is in a Non-Allowed Area and the service request is not for regulatory prioritized service. The AMF shall set the application error as "UE\_IN\_NON\_ALLOWED\_AREA" in POST response body. + - The NF service consumer (i.e. the SMF) that receives this application error may suppress subsequent message (e.g. N1N2MessageTransfer) to the AMF for non regulatory prioritized service. In this case, the NF service consumer (i.e. the SMF) should subscribe the Reachability-Report event for "UE Reachability Status Change" from the AMF, so as to get notified by the AMF when the UE becomes reachable again. +- Same as step 2b of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "403 Forbidden", if the NF service consumer (e.g. an LMF) is requesting to send N1 LPP message to the UE and the UE has indicated that it does not support LPP in N1 mode during registration procedure (see clause 5.5.1.2.2 and 5.5.1.3.2 of 3GPP TS 24.501 [11]). The AMF shall set the application error to "UE\_WITHOUT\_N1\_LPP\_SUPPORT" in POST response body. +- Same as step 2b of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "403 Forbidden", if the request body includes an nfd IE indicating an SMF instance which is different from the stored SMF instance hosting the SM Context of the PDU session. The AMF shall set the application error to "INVALID\_SM\_CONTEXT" in POST response body. During procedures with SM Context relocation, e.g. UE mobility procedures with I-SMF insertion/change/removal, the AMF shall allow N1N2MessageTransfer from both SMF instances holding the old and new SM Contexts. + +The NF service consumer (i.e. the SMF) that receives this application error shall remove the SM Context for the PDU session and release the PDU session resource in (H-)SMF if available. The SMF shall not send a SMContextStatusNotification to the AMF for the PDU session release. + +- Same as step 2b of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "403 Forbidden", if the NF service consumer (e.g. an LMF) is requesting to initiate a positioning procedure towards a PRU (see clause 6.11.2 of 3GPP TS 23.273 [42]), i.e. the pruInd IE with the value true was included in the request, but the UE is not a valid PRU. The AMF shall set the application error to "INVALID\_PRU" in POST response body. + +### 5xx Response Cases: + +- Same as step 2b of Figure 5.2.2.3.1.1-1, the AMF shall respond with the status code "504 Gateway Timeout", if the UE is currently unreachable (e.g., due to the UE in MICO mode, the UE using extended idle mode DRX or the UE is only registered over Non-3GPP access and its state is CM-IDLE). The AMF shall set the application error as "UE\_NOT\_REACHABLE" in POST response body. If Extended Buffering Support Indication is received in the request, the AMF shall include the Estimated Maximum Waiting time in the response body when the message is rejected due to the UE in MICO mode or the UE using extended idle mode DRX. +- step 2b of Figure 5.2.2.3.1.1-1, the AMF may respond with the status code "504 Gateway Timeout", if the UE is temporarily not responding (e.g., not responding to the paging). The AMF shall set the application error as "UE\_NOT\_RESPONDING" in POST response body. The AMF may provide a retryAfter IE to the NF Service Consumer in order for the NF Service Consumer to throttle sending further N1/N2 Message Transfer request for a short period. When the retryAfter IE is provided, the NF Service Consumer should not initiate new N1/N2 Message Transfer request until the timer expires. + +### 5.2.2.3.2 N1N2Transfer Failure Notification + +The AMF uses this notification to inform the NF service consumer that initiated an earlier + +Namf\_Communication\_N1N2MessageTransfer, that the AMF failed to deliver the N1 and/or N2 message. The HTTP POST method shall be used on the notification callback URI provided by the NF service consumer as specified in clause 5.2.2.3.1.2. + +![Sequence diagram showing N1N2Transfer Failure Notification for UE related signalling. The AMF sends a POST request to the NF Service Consumer, which responds with a 204 No Content or an error status code.](04cfca33e3fc26513abe649d7474f733_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NF Service Consumer + Note right of AMF: 1. POST {n1n2FailureTxfNotifURI} (N1N2MsgTxfrFailureNotification) + AMF->>NF Service Consumer: 1. POST {n1n2FailureTxfNotifURI} (N1N2MsgTxfrFailureNotification) + Note left of NF Service Consumer: 2. 204 No Content +Or 4xx/5xx (ProblemDetails) Or 3xx + NF Service Consumer-->>AMF: 2. 204 No Content +Or 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram showing N1N2Transfer Failure Notification for UE related signalling. The AMF sends a POST request to the NF Service Consumer, which responds with a 204 No Content or an error status code. + +**Figure 5.2.2.3.2-1 N1N2Transfer Failure Notification for UE related signalling** + +1. If the NF service consumer had provided a notification URI (see clause 5.2.2.3.1.2), the AMF shall send a POST request to the NF Service Consumer on that Notification URI when the AMF determines that: + +- the paging or NAS Notification has failed; +- the indicated non-3GPP PDU session is not allowed to move to 3GPP access; +- the UE has rejected the page as defined in 3GPP TS 23.501 [2] clause 5.38.4; +- the delivery of the N1 message fails, e.g. in case the UE is in RRC Inactive and NG-RAN paging was not successful or in case an Xn or N2 handover is being triggered at the NG-RAN + +The AMF shall include the N1N2MessageTransfer request resource URI returned earlier in the N1N2MessageTransfer response if any (see clause 5.2.2.3.1.2), otherwise a dummy URI (see clause 6.1.6.2.30), in the POST request body. The AMF shall also include a N1/N2 message transfer cause information in the POST request body and set the value as specified in clause 6.1.5.6.3.1. + +The NF Service Consumer shall delete any stored representation of the N1N2MessageTransfer request resource URI upon receiving this notification. + +The AMF may also include a "retryAfter" IE in the POST request body in order for the NF consumer to throttle sending further N1/N2 Message Transfer request for a short period, e.g. to reduce unnecessary paging to an unresponding UE for a period of time to save the RAN resources. + +2. The NF Service Consumer shall send a response with "204 No Content" status code. + +On failure or redirection, one of the HTTP status codes together with the response body listed Table 6.1.5.6.3.1-2 shall be returned. + +### 5.2.2.3.3 N1N2MessageSubscribe + +#### 5.2.2.3.3.1 General + +The N1N2MessageSubscribe service operation is used by a NF Service Consumer (e.g. PCF) to subscribe to the AMF for notifying N1 messages of a specific type (e.g. UPDP) or N2 information of a specific type. For the N1 message class UPDP, a PCF shall subscribe for the N1 message notification with the AMF to receive the N1 messages from UE that are related to UE Policy. + +**NOTE:** Step 0 of clause 4.2.4.3 of 3GPP TS 23.502 [3] specifies that the PCF can split the UPDP transfer towards UE into multiple units. One UE specific callback URI is registered with the AMF by the PCF for the AMF to notify all UPDP message responses from the UE to the same callback URI. As a result, an explicit subscription per UE policy association is defined in stage 3 for this purpose. + +An NF Service Consumer (e.g. PCF) may subscribe to notifications of specific N1 message type (e.g. LPP or UPDP) or N2 information type. In this case the NF Service Consumer shall subscribe by using the HTTP POST method with the URI of the "N1N2 Subscriptions Collection for Individual UE Contexts" resource (See clause 6.1.3.3). See also Figure 5.2.2.3.3.1-1. + +![Sequence diagram for N1N2 Message Subscribe. The NF Service Consumer sends a POST request to the AMF to create a subscription resource. The AMF responds with a 201 Created status code and a response body containing subscription details or an error code.](9f6dec4d4e9fde40bce018861ef1278e_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. POST ./namf_comm/v1/ue_contexts/{ueContextId}/n1-n2-messages/subscriptions (UeN1N2InfoSubscriptionCreateData) + NF Service Consumer->>AMF: Request + Note left of AMF: 2. 201 Created (UeN1N2InfoSubscriptionCreatedData) Or 4xx/5xx (ProblemDetails) Or 3xx + AMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for N1N2 Message Subscribe. The NF Service Consumer sends a POST request to the AMF to create a subscription resource. The AMF responds with a 201 Created status code and a response body containing subscription details or an error code. + +**Figure 5.2.2.3.3.1-1 N1N2 Message Subscribe** + +1. The NF Service Consumer shall send a POST request to create a subscription resource in the AMF for a UE specific N1/N2 message notification. The content of the POST request shall contain: + - N1 and/or N2 Message Type, identifying the type of N1 and/or N2 message to be notified + - A callback URI for the notification +2. If the request is accepted, the AMF shall include a HTTP Location header to provide the location of a newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. + +On failure or redirection, one of the HTTP status codes together with the response body listed Table 6.1.3.3.3.1-3 shall be returned. + +#### 5.2.2.3.4 N1N2MessageUnSubscribe + +##### 5.2.2.3.4.1 General + +The N1N2MessageUnSubscribe service operation is used by a NF Service Consumer (e.g. PCF) to unsubscribe to the AMF to stop notifying N1 messages of a specific type (e.g. LPP or UPDP). + +The NF Service Consumer shall use the HTTP method DELETE with the URI of the "N1N2 Individual Subscription" resource (See clause 6.1.3.7.3.1), to request the deletion of the subscription for the N1 / N2 message towards the AMF. See also Figure 5.2.2.3.4.1-1. + +![Sequence diagram for N1N2 Message UnSubscribe. The NF Service Consumer sends a DELETE request to the AMF to delete an existing subscription resource. The AMF responds with a 204 No Content status code and a response body containing subscription details or an error code.](f10dc32e3673e1392029a49e958a9d6c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. DELETE ./namf_comm/v1/ue_contexts/{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId} + NF Service Consumer->>AMF: Request + Note left of AMF: 2. 204 No Content Or 4xx/5xx (ProblemDetails) Or 3xx + AMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for N1N2 Message UnSubscribe. The NF Service Consumer sends a DELETE request to the AMF to delete an existing subscription resource. The AMF responds with a 204 No Content status code and a response body containing subscription details or an error code. + +**Figure 5.2.2.3.4.1-1 N1N2 Message UnSubscribe** + +1. The NF Service Consumer shall send a DELETE request to delete an existing subscription resource in the AMF. +2. If the request is accepted, the AMF shall reply with the status code 204 indicating the resource identified by subscription ID is successfully deleted, in the response message. + +On failure or redirection, one of the HTTP status codes together with the response body listed Table 6.1.3.4.3.1-3 shall be returned. + +#### 5.2.2.3.5 N1MessageNotify + +##### 5.2.2.3.5.1 General + +The N1MessageNotify service operation is used by an AMF notifying the N1 message received from the UE to a destination CN NF, and it is used in the following procedures: + +- Registration with AMF re-allocation (see clause 4.2.2.2.3 of 3GPP TS 23.502 [3]) +- UE assisted and UE based positioning procedure (see clause 6.11.1 of 3GPP TS 23.273 [42]) +- LCS Event Report, Event Reporting in RRC INACTIVE state procedures, LCS Cancel Location and LCS Periodic-Triggered Invoke procedures (see clause 6.3, clause 6.7 and clause 6.20.3 of 3GPP TS 23.273 [42]) +- UE configuration update procedure for transparent UE policy delivery (See clause 4.2.4.3 in 3GPP TS 23.502 [3]) + +NOTE: Though in 3GPP TS 23.502 [3] the procedure is called "UE configuration update procedure for transparent UE policy delivery", as per 3GPP TS 24.501 [11] clause 5.4.5.2.1, the UE initiated NAS transport procedure is used. + +- UE triggered policy provisioning procedure to request UE policies. (See clause 6.2.4 in 3GPP TS 23.287 [47] and clause 6.2.4 in 3GPP TS 23.304 [51]) +- Procedures applicable to a PRU (see clause 6.17 of 3GPP TS 23.273 [42]) +- Procedures of SL-MT-LR involving LMF (see 3GPP TS 23.273 [42], clause 6.20.3) +- Procedures of SL-MT-LR for periodic, triggered Location Events (see 3GPP TS 23.273 [42], clause 6.20.4) +- 5GC-MT-LR Procedure using SL positioning (see 3GPP TS 23.273 [42], clause 6.20.5) + +The AMF shall use HTTP POST method to the N1 Notification URI provided by the NF Service Consumer via N1N2MessageSubscribe service operation (See clause 5.2.2.3.3). See also figure 5.2.2.3.5.1-1. + +![Sequence diagram showing N1 Message Notify interaction between AMF and NF Service Consumer.](26e334e61dd059cff029338a2a604d8d_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NFSC as NF Service Consumer + Note left of NFSC: + AMF->>NFSC: 1. POST {n1NotifyCallbackUri} (N1MessageNotification) + NFSC-->>AMF: 2a. 204 No Content + NFSC-->>AMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +The diagram illustrates the interaction between the AMF and the NF Service Consumer. The AMF sends a POST request (step 1) to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (step 2a) or an error status code (step 2b). + +Sequence diagram showing N1 Message Notify interaction between AMF and NF Service Consumer. + +**Figure 5.2.2.3.5.1-1 N1 Message Notify** + +1. The AMF shall send a HTTP POST request to the N1 Notification URI, and the content of the POST request shall contain an N1MessageNotification data structure with the subscribed N1 message. +- 2a. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.4.3.1-3 shall be returned. The message body shall contain a ProblemDetails object with "cause" set to one of the corresponding application errors listed in Table 6.1.5.4.3.1-3. + +#### 5.2.2.3.5.2 Using N1MessageNotify in the Registration with AMF Re-allocation Procedure + +In the Registration with AMF re-allocation procedure, the N1MessageNotify service operation is invoked by a NF Service Producer, i.e. an Initial AMF, towards a NF Service Consumer, e.g. the target AMF, which is selected to serve the UE, by the initial AMF. + +The requirements specified in clause 5.2.2.3.5.1 shall apply with the following modifications: + +1. The initial AMF discovers the NF Service Consumer (e.g. the target AMF) from the NRF, and fetch N1 Notification URI from the default notification subscription registered with "N1\_MESSAGE" notification type and "5GMM" N1 message class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). + +NOTE: The alternate AMF is expected to have registered a callback URI with the NRF. + +2. Same as step 1 of Figure 5.2.2.3.5.1-1, the request content shall include the following information in the HTTP POST Request message body: + +- RAN NGAP ID and initial AMF name (the information enabling (R)AN to identify the N2 terminating point); +- RAN identity, e.g. RAN Node Id, RAN N2 IPv4/v6 address; +- Information from RAN, e.g. User Location, RRC Establishment Cause and UE Context Request; +- the N1 message, which shall be the complete Registration Request message in clear text if the UE has a valid NAS security context, or as the one contained in the NAS message container IE in the Security Mode Complete message as specified in clause 4.2.2.2.3 of 3GPP TS 23.502 [2]; +- the UE's SUPI and MM Context; +- the Allowed NSSAI and if available the partially Allowed NSSAI, together with the corresponding NSI IDs (if network slicing is used and the initial AMF has obtained). + +#### 5.2.2.3.5.3 Using N1MessageNotify in the UE Assisted and UE Based Positioning Procedure + +In the UE assisted and UE based positioning procedure, the N1MessageNotify service operation is invoked by the AMF, towards the LMF, to notify the N1 UE positioning messages received from the UE. + +The requirements specified in clause 5.2.2.3.5.1 shall apply with the following modifications: + +1. If the corresponding N1 notification URI is not available, the AMF shall retrieve the NF profile of the NF Service Consumer (e.g. the LMF) from the NRF using the NF Instance Identifier received during corresponding N1N2MessageTransfer service operation (see clause 5.2.2.3.1), and further identify the corresponding service instance if Service Instance Identifier was also received, and fetch N1 Notification URI from the default notification subscription registered with "N1\_MESSAGE" notification type and "LPP" N1 message class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). +2. Same as step 1 of Figure 5.2.2.3.5.1-1, the request content shall include the following information: + - the N1 Uplink Positioning Message; + - LCS correlation identifier. + +#### 5.2.2.3.5.4 Using N1MessageNotify in the UE Configuration Update for transparent UE Policy delivery + +In the UE Configuration Update for transparent UE Policy delivery procedure, the N1MessageNotify service operation is invoked by the AMF, towards the PCF which subscribed to be notified with UPDP messages received from the UE. + +The requirements specified in clause 5.2.2.3.5.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.3.5.1-1. The request content shall include the following information: + - the UPDP message. + +#### 5.2.2.3.5.5 Using N1MessageNotify in the LCS Event Report, Event Reporting in RRC INACTIVE state procedures, LCS Cancel Location and LCS Periodic-Triggered Invoke Procedures + +In the LCS Event Report, Event Reporting in RRC INACTIVE state procedures, LCS Cancel Location and LCS Periodic-Triggered Invoke procedure, the N1MessageNotify service operation is invoked by the AMF, towards the LMF, to notify the N1 UE LCS messages received from the UE. + +The requirements specified in clause 5.2.2.3.5.1 shall apply with the following modifications: + +1. If the corresponding N1 notification URI is not available, the AMF shall retrieve the NF profile of the NF Service Consumer (e.g. the LMF) from the NRF using the NF Instance Identifier received during corresponding N1N2MessageTransfer service operation (see clause 5.2.2.3.1), and further identify the corresponding service instance if Service Instance Identifier was also received, and fetch N1 Notification URI from the default notification subscription registered with "N1\_MESSAGE" notification type and "LCS" N1 message class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). +2. Same as step 1 of Figure 5.2.2.3.5.1-1, the request content shall include the following information: + - the N1 Uplink LCS Message; + - LCS correlation identifier; + - indication of Control Plane CIoT 5GS Optimisation if Control Plane CIoT 5GS Optimisation is being used. and may include serving cell ID if it is available; + +NOTE: For the EventReport message and UE initiated CancelDeferredLocation message, the AMF includes the deferred routing identifier received from UE in N1 UL NAS TRANSPORT message as LCS correlation identifier. The LCS correlation identifier can assist a serving LMF in identifying the periodic or triggered location session if the same LMF had assigned the deferred routing identifier or can indicate to the LMF that it is acting as a default LMF. + +#### 5.2.2.3.5.6 Using N1MessageNotify in the UE triggered policy provisioning procedure to request UE policies + +In the UE triggered policy provisioning procedure, the N1MessageNotify service operation is invoked by the AMF, towards the PCF which subscribed to be notified with UPDP messages received from the UE. + +The requirements specified in clause 5.2.2.3.5.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.3.5.1-1. The request content shall include the following information: + - the UPDP message. + +#### 5.2.2.3.5.7 Using N1MessageNotify in the procedures applicable to a PRU + +In the PRU Association Procedure, LMF Initiated PRU Disassociation Procedure or PRU Initiated PRU Disassociation Procedure, the N1MessageNotify service operation is invoked by the AMF, towards the LMF, to notify the N1 PRU messages received from the PRU. + +The requirements specified in clause 5.2.2.3.5.1 shall apply with the following modifications: + +1. If the corresponding N1 notification URI is not available, the AMF shall select the LMF and retrieve the NF profile of the LMF from the NRF (see clause 6.17 of 3GPP TS 23.273 [42]), and fetch N1 Notification URI from the default notification subscription registered with "N1\_MESSAGE" notification type and "LCS" N1 message class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). +2. Same as step 1 of Figure 5.2.2.3.5.1-1, the request content shall include the following information if available: + - the N1 PRU messages; + - PRU subscription Indication; + - the TAI and cell Id of the PRU; + - Correlation identifier; + - SUPI of the PRU. + +#### 5.2.2.3.6 N2InfoNotify + +##### 5.2.2.3.6.1 General + +The N2InfoNotify service operation is used during the following procedure: + +- Inter NG-RAN node N2 based handover procedure (see 3GPP TS 23.502 [3], clauses 4.9.1.3.3, 4.9.1.3.3a and 4.23.7.3); +- Network assisted positioning procedure (see clause 6.11.2 of 3GPP TS 23.273 [42]) +- AMF planned removal procedure with UDSF deployed (see clause 5.21.2.2.1 of 3GPP TS 23.501 [2]), to forward uplink N2 signalling to a different AMF. + +The N2InfoNotify service operation is invoked by AMF, to notify a NF Service Consumer that subscribed N2 information has been received from access network. + +The AMF shall use HTTP POST method to the N2Info Notification URI provided by the NF Service Consumer via N1N2MessageSubscribe service operation (See clause 5.2.2.3.3). See also figure 5.2.2.3.6.1-1. + +![Sequence diagram for N2 Information Notify. It shows an AMF sending a POST request to an NF Service Consumer. The request is labeled '1. POST {n2NotifyCallbackUri} (N2InformationNotification)'. The NF Service Consumer responds with '2a. 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) Or 3xx' on failure or redirection.](8269648391c59363ea61243864a2adf7_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NF Service Consumer + Note left of AMF: 1. POST {n2NotifyCallbackUri} (N2InformationNotification) + AMF->>NF Service Consumer: 1. POST {n2NotifyCallbackUri} (N2InformationNotification) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>AMF: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) Or 3xx + NF Service Consumer-->>AMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram for N2 Information Notify. It shows an AMF sending a POST request to an NF Service Consumer. The request is labeled '1. POST {n2NotifyCallbackUri} (N2InformationNotification)'. The NF Service Consumer responds with '2a. 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) Or 3xx' on failure or redirection. + +**Figure 5.2.2.3.6.1-1 N2 Information Notify** + +1. The AMF shall send a HTTP POST request to the n2NotifyCallbackUri, and the content of the POST request shall contain a N2InformationNotification data structure, containing the N2 information that was subscribed by the NF Service Consumer. +- 2a. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.5.3.1-3 shall be returned. The message body shall contain a ProblemDetails object with "cause" set to one of the corresponding application errors listed in Table 6.1.5.5.3.1-3. + +#### 5.2.2.3.6.2 Using N2InfoNotify during Inter NG-RAN node N2 based handover procedure + +The N2InfoNotify service operation is invoked by a NF Service Producer, e.g. the target AMF, towards the NF Service Consumer, i.e. the source AMF, to notify that the handover procedure has been successful in the target side, for a given UE. + +![Sequence diagram for N2 Information Notify during N2 Handover execution. It shows a Target AMF sending a POST request to a Source AMF. The request is labeled '1. POST {n2InfoNotifyUri} (N2InformationNotification)'. The Source AMF responds with '2a. 200 OK (N2InfoNotificationRspData) or 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) Or 3xx' on failure or redirection.](bc9d0c0b02cbe628b1b6548cc1107734_img.jpg) + +``` + +sequenceDiagram + participant Source AMF + participant Target AMF + Note left of Target AMF: 1. POST {n2InfoNotifyUri} (N2InformationNotification) + Target AMF->>Source AMF: 1. POST {n2InfoNotifyUri} (N2InformationNotification) + Note right of Source AMF: 2a. 200 OK (N2InfoNotificationRspData) or 204 No Content + Source AMF-->>Target AMF: 2a. 200 OK (N2InfoNotificationRspData) or 204 No Content + Note right of Source AMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + Source AMF-->>Target AMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram for N2 Information Notify during N2 Handover execution. It shows a Target AMF sending a POST request to a Source AMF. The request is labeled '1. POST {n2InfoNotifyUri} (N2InformationNotification)'. The Source AMF responds with '2a. 200 OK (N2InfoNotificationRspData) or 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) Or 3xx' on failure or redirection. + +**Figure 5.2.2.3.6.2-1 N2 Information Notify during N2 Handover execution** + +The requirements specified in clause 5.2.2.3.6.1 shall apply with the following modifications: + +0. During an inter AMF handover procedure, the source AMF, acting as a NF Service Consumer, when invoking the CreateUEContext service operation (see clause 5.2.2.2.3), shall include a N2Info Notification URI to the target AMF in the HTTP request message. +1. Same as step 1 of Figure 5.2.2.3.6.1-1, the request content shall contain the following information: + - notification content (see clause 6.1.5.5) without the "n2InfoContainer" attribute; + - the "notifyReason" attribute set to "HANDOVER\_COMPLETED"; + - the "smfChangeInfoList" attribute including the UE's PDU Session ID(s) for which the I-SMF or V-SMF has been changed or removed, if any, with for each such PDU session, the related "smfChangeIndication" attribute set to "CHANGED" or "REMOVED", if the I-SMF or the V-SMF is changed or removed respectively. + - the "notifySourceNgRan" attribute set to "true" during an Inter NG-RAN node N2 based DAPS handover procedure, if the target AMF receives this indication in the Handover Notify from the target NG-RAN node (see clause 4.9.1.3.3a of 3GPP TS 23.502 [3]). + +If any network slice(s) become no longer available and there are PDU Session(s) associated with them, the target AMF shall include these PDU session(s) in the toReleaseSessionList attribute in the content. The n2NotifySubscriptionId included in the notification content shall be the UE context Id. + +2. Same as Step 2a of Figure 5.2.2.3.6.1-1, with the following additions/modifications: + +- the source AMF shall release the PDU Session(s) listed in the toReleaseSessionList attribute in the content; +- if the smfChangeInfoList attribute was received in the request, the source AMF shall release the SM Context at the I-SMF or V-SMF only, for all the PDU sessions listed in the smfChangeInfoList attribute with the smfChangeIndication attribute set to "CHANGED" or "REMOVED"; +- the source AMF shall remove the individual ueContext resource. The source AMF may choose to start a timer to supervise the release of the UE context resource and may keep the individual ueContext resource until the timer expires; +- if Secondary RAT usage data have been received from the source NG-RAN and buffered at the source AMF for one or more PDU sessions as specified in step 2a0 of clause 4.9.1.3.3 of 3GPP TS 23.502 [3], the source AMF shall send a 200 OK response with the Secondary RAT usage data included in the response content for one or more PDU sessions. +- if the "notifySourceNgRan" attribute was set to "true" in the request, the source AMF shall send a HANDOVER SUCCESS to the source NG-RAN (see clause 4.9.1.3.3a of 3GPP TS 23.502 [3]). + +NOTE: This notification is due to an implicit subscription and hence no explicit subscription Id is created. UE context Id is included as the notification subscription Id for the NF Service Consumer (e.g. Source AMF) to co-relate the notification to an earlier initiated UE context creation during a handover procedure. + +#### 5.2.2.3.6.3 Using N2InfoNotify during Location Services procedures + +The N2InfoNotify service operation is invoked by a NF Service Producer, i.e. the AMF, towards the NF Service Consumer, e.g. the LMF, to notify the positioning parameters received from the 5G-AN in the NRPPa message. + +The requirements specified in clause 5.2.2.3.6.1 shall apply with the following modifications: + +1. If the corresponding N2 notification URI is not available, the AMF shall retrieve the NF profile of the NF Service Consumer (e.g. the LMF) from the NRF using the NF Instance Identifier received during corresponding N1N2MessageTransfer service operation (see clause 5.2.2.3.1), and further identify the corresponding service instance if Service Instance Identifier was also received, and fetch N2 Notification URI from the default subscription registered with "N2\_INFORMATION" notification type and "NRPPa" N2 information class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). +2. Same as step 1 of Figure 5.2.2.3.6.1-1, the request content shall contain N2 information of type NRPPa and LCS correlation identifier. + +#### 5.2.2.3.6.4 Using N2InfoNotify during AMF planned removal procedure with UDSF deployed procedure + +In the AMF planned removal procedure with UDSF deployed (see clause 5.21.2.2.1 of 3GPP TS 23.501 [2]), the N2InfoNotify service operation is invoked by a NF Service Producer, i.e. an initial AMF, towards the NF Service Consumer, i.e. the target AMF, to forward uplink N2 signalling to the target AMF. + +The requirements specified in clause 5.2.2.3.6.1 shall apply with the following modifications: + +1. If the N2 notification URI is not available, the initial AMF shall discover the NF Service Consumer (i.e. the target AMF) from the NRF, and fetch the N2 Notification URI from the default notification subscription registered with "N2\_INFORMATION" notification type and "RAN" N2 message class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). + +NOTE: The target AMF is expected to have registered a callback URI with the NRF. + +2. Same as step 1 of Figure 5.2.2.3.6.1-1, the request content shall contain the following information in the HTTP POST Request message body: + - N2 information of type "RAN"; + - N2 message; + - initial AMF name; + - RAN identity, e.g. RAN Node Id, RAN N2 IPv4/v6 address. + +## 5.2.2.4 Non-UE N2 Message Operations + +### 5.2.2.4.1 NonUeN2MessageTransfer + +#### 5.2.2.4.1.1 General + +The NonUeN2MessageTransfer service operation is used by a NF Service Consumer to transfer N2 information to the 5G-AN through the AMF in the following procedures: + +- Obtaining non-UE associated network assistance data (See clause 4.13.5.6 in 3GPP TS 23.502 [3]); +- Warning Request Transfer procedures (See clause 9A in 3GPP TS 23.041 [20]); +- Configuration Transfer procedure (see clause 5.26 of 3GPP TS 23.501 [2]) +- RIM Information Transfer procedures (see clause 8.16 of 3GPP TS 38.413 [12]). +- Broadcast of Assistance Data by an LMF (see clause 6.14.1 of 3GPP TS 23.273 [42]). +- Management of network timing synchronization status monitoring procedures (see clause 4.15.9.X of 3GPP TS 23.502 [3]). + +The NF Service Consumer shall invoke the service operation by sending POST to the URI of the "transfer" customer operation on the "Non UE N2Messages Collection" resource (See clause 6.1.3.8.4.2) on the AMF. See also figure 5.2.2.4.1.1-1. + +![Sequence diagram illustrating the Non-UE N2 Message Transfer procedure between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request (1.POST .../non-ue-n2-messages/transfer (N2InformationTransferReqData)) to the AMF. The AMF responds with either a 200 OK (2a. 200 OK (N2InformationTransferRspData)) or an error status code (2b. 4xx/5xx(N2InformationTransferError) or 3xx).](9edb407536d4d4d4a6ac391527af047c_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF Service Consumer + participant AMF + Note left of NFSC: 1.POST .../non-ue-n2-messages/transfer (N2InformationTransferReqData) + NFSC->>AMF: Request + Note right of AMF: 2a. 200 OK (N2InformationTransferRspData) + AMF-->>NFSC: Success Response + Note right of AMF: 2b. 4xx/5xx(N2InformationTransferError) or 3xx + AMF-->>NFSC: Error Response + +``` + +Sequence diagram illustrating the Non-UE N2 Message Transfer procedure between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request (1.POST .../non-ue-n2-messages/transfer (N2InformationTransferReqData)) to the AMF. The AMF responds with either a 200 OK (2a. 200 OK (N2InformationTransferRspData)) or an error status code (2b. 4xx/5xx(N2InformationTransferError) or 3xx). + +**Figure 5.2.2.4.1.1-1 Non-UE N2 Message Transfer** + +1. The NF Service Consumer shall invoke the custom operation for non UE associated N2 message transfer by sending a HTTP POST request, and the request body shall carry the N2 information to be transferred. +- 2a. On success, AMF shall respond a "200 OK" status code with N2InformationTransferRspData data structure. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.8.4.2.2-2shall be returned with the message body containing a N2InformationTransferError structure, including a ProblemDetails attribute with the "cause" attribute set to one of the application errors listed in Table 6.1.3.8.4.2.2-2. + +#### 5.2.2.4.1.2 Obtaining Non UE Associated Network Assistance Data Procedure + +The NonUeN2MessageTransfer service operation shall be invoked by a NF Service Consumer, e.g. LMF to transfer non UE associated N2 information of N2 information class NRPPa to NG-RAN for obtaining the network assistance data. + +The requirements specified in clause 5.2.2.4.1.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.4.1.1-1, the POST request body shall carry the N2 information to be transferred together with the NG RAN node identifier(s) to which the transfer needs to be initiated. The POST request body shall also include the NF Instance Identifier of the NF Service Consumer (e.g. LMF) in "nflId" attribute. + +#### 5.2.2.4.1.3 Warning Request Transfer Procedure + +The NonUeN2MessageTransfer service operation shall be invoked by the NF Service Consumer, e.g. CBCF/PWS-IWF, to send non-UE specific messages of N2 information class PWS to the NG-RAN. + +The requirements specified in clause 5.2.2.4.1.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.4.1.1-1, the request body shall include the N2 Message Container and: + +- the *globalRanNodeList* IE, or; +- the *taiList* IE and the *ratSelector* IE, or; +- the *ratSelector* IE. + +The AMF shall forward the N2 Message Container to ng-eNBs or to gNBs indicated in the *globalRanNodeList* IE if present. If the *globalRanNodeList* IE if not present, the AMF shall forward the N2 Message Container to ng-eNBs or to gNBs, subject to the value of the *ratSelector* IE, that serve Tracking Areas as listed in the *taiList* IE if present. If the *taiList* IE and the *globalRanNodeList* IE are not present, the AMF shall forward the N2 Message Container to all attached ng-eNBs or all attached gNBs, subject to the value of the *ratSelector* IE. + +NOTE: The *globalRanNodeList* IE can be present when transferring WRITE-REPLACE WARNING REQUEST. When present, the *globalRanNodeList* IE only contains RAN nodes of the same type, i.e. only ng-eNBs or only gNBs. + +The request body may additionally include the *omcId* IE and/or the *sendRanResponse* IE. + +- 2a. Same as step 2a of Figure 5.2.2.4.1.1-1, and the POST response body shall contain the mandatory elements from the Write-Replace-Warning Confirm response (see clause 9.2.17 in TS 23.041 [20]) or the mandatory elements and optionally the *unknown TAI List* IE from the Stop-Warning Confirm response (see clause 9.2.19 in TS 23.041 [20]). + +If the *sendRanResponse* IE with the value "true" was received in the request, but the corresponding N2 information subscription for PWS information from the NF service consumer is not available in the AMF, the AMF should include the *n2PwsSubMissInd* IE with the value "true" in the response. + +- 2b. Same as step 2b of Figure 5.2.2.4.1.1-1, and the POST response body shall contain following additional information: + +- PWS specific information, if any, e.g. PWS Cause information. + +#### 5.2.2.4.1.4 Configuration Transfer Procedure + +The NonUeN2MessageTransfer service operation shall be invoked by the NF Service Consumer (i.e. source AMF) towards the NF Service Producer (i.e. target AMF) to transfer the RAN configuration information received from the source NG-RAN towards the target NG-RAN. + +The requirements specified in clause 5.2.2.4.1.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.4.1.1-1. The POST request body shall contain the SON Configuration Transfer IE received from the source NG-RAN, the NG RAN node identifier of the destination of this configuration information, and the N2 information class "RAN". + +The target AMF shall forward the SON Configuration Transfer IE in a NGAP Downlink RAN Configuration Transfer message to the target NG-RAN. + +#### 5.2.2.4.1.5 RIM Information Transfer Procedures + +The NonUeN2MessageTransfer service operation shall be invoked by the NF Service Consumer (i.e. source AMF) towards the NF Service Producer (i.e. target AMF) to transfer the RIM information received from the source NG-RAN towards the target NG-RAN. + +The requirements specified in clause 5.2.2.4.1.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.4.1.1-1. The POST request body shall contain the RIM Information Transfer IE received from the source NG-RAN, the NG RAN node identifier of the destination of this configuration information, and the N2 information class "RAN". + +The target AMF shall forward the RIM Information Transfer IE in a NGAP Downlink RIM Information Transfer message to the target NG-RAN. + +#### 5.2.2.4.1.6 Broadcast of Assistance Data by an LMF + +The NonUeN2MessageTransfer service operation shall be invoked by a NF Service Consumer, e.g. LMF to transfer non UE associated N2 information of N2 information class NRPPa to NG-RAN for sending assistance information broadcasting. + +The requirements specified in clause 5.2.2.4.1.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.4.1.1-1, the POST request body shall contain NRPPa-PDU IE carrying Network Assistance Data generated by LMF to be transferred together with the target NG RAN node identifier(s) to which the transfer needs to be initiated. The POST request body shall also include the NF Instance Identifier of the NF Service Consumer (e.g. LMF) in "nflId" attribute. + +#### 5.2.2.4.1.7 Management of network timing synchronization status monitoring procedures + +The NonUeN2MessageTransfer service operation shall be invoked by a NF Service Consumer, e.g. TSCTSF, to transfer clock quality reporting control information to NG-RAN. + +The requirements specified in clause 5.2.2.4.1.1 shall apply with the following modifications: + +1. Same as step 1 of Figure 5.2.2.4.1.1-1, the POST request body shall contain Clock Quality Reporting Control Information IE to be transferred together with the information identifying target NG RAN node(s) to which the transfer needs to be initiated, and the N2 information class "TSS". The POST request body shall also include the NF Instance Identifier of the NF Service Consumer (e.g. TSCTSF) in "nflId" attribute. + +**Editor's note:** Further details on NGAP IE "Clock Quality Reporting Control Information" to be aligned with RAN WG3, and it shall be specified in clause 6.1.6.4.3.2. + +**Editor's note:** Whether the target NG-RAN node(s) are identified by TAI or NG-RAN node identifiers is FFS. + +#### 5.2.2.4.2 NonUeN2InfoSubscribe + +##### 5.2.2.4.2.1 General + +The NonUeN2InfoSubscribe service operation is used by a NF Service Consumer (e.g. CBCF, PWS-IWF, TSCTSF) to subscribe to the AMF for notifying non UE specific N2 information of a specific type (e.g. PWS Indications, TSS). + +An NF Service Consumer (e.g. CBCF, PWS-IWF, TSCTSF) may subscribe to notifications of specific N2 information type (e.g. PWS Indications, TSS) that are not associated with any UE. In this case, the NF Service Consumer shall subscribe by using the HTTP POST method with the URI of the "Non UE N2Messages Subscriptions Collection" resource (See clause 6.1.3.9.3.1). See also Figure 5.2.2.4.2.1-1. + +![Sequence diagram showing the N2 Information Subscription for Non UE Information. The NF Service Consumer sends a POST request to the AMF, and the AMF responds with a 201 Created status code.](9e5ebd04b22b9fa09c82a10a81129278_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. POST /namf_comm/v1/non-ue-n2-messages/subscriptions +(NonUeN2InfoSubscriptionCreateData) + NF Service Consumer->>AMF: Request + Note left of AMF: 2. 201 Created (NonUeN2InfoSubscriptionCreatedData) +Or 4xx/5xx (ProblemDetails) Or 3xx + AMF-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the N2 Information Subscription for Non UE Information. The NF Service Consumer sends a POST request to the AMF, and the AMF responds with a 201 Created status code. + +**Figure 5.2.2.4.2.1-1 N2 Information Subscription for Non UE Information** + +1. The NF Service Consumer shall send a POST request to create a subscription resource in the AMF for a non UE specific N2 information notification. The content of the POST request shall contain: + - N2 Information Type, identifying the type of N2 information to be notified + - A callback URI for the notification +2. If the request is accepted, the AMF shall include a HTTP Location header to provide the location of a newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. + +On failure or redirection, one of the HTTP status codes together with the response body listed Table 6.1.3.9.3.1-3 shall be returned. + +### 5.2.2.4.3 NonUeN2InfoUnSubscribe + +#### 5.2.2.4.3.1 General + +The NonUeN2InfoUnSubscribe service operation is used by a NF Service Consumer (e.g. CBCF, PWS-IWF, TSCTSF) to unsubscribe to the AMF to stop notifying N2 information of a specific type (e.g. PWS Indications, TSS). + +The NF Service Consumer shall use the HTTP method DELETE with the URI of the "Non UE N2 Message Notification Individual Subscription" resource (See clause 6.1.3.10.3.1), to request the deletion of the subscription for non UE specific N2 information notification, towards the AMF. See also Figure 5.2.2.4.3.1-1. + +![Sequence diagram for NonUeN2InfoUnSubscribe. The NF Service Consumer sends a DELETE request to the AMF. The AMF responds with a 204 No Content or an error status code.](1316d63eca7b84e13c27f55f0027b7b5_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. DELETE /namf_comm/v1/non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId} + NF Service Consumer->>AMF: Request + Note left of AMF: 2. 204 No Content +Or 4xx/5xx (ProblemDetails) Or 3xx + AMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for NonUeN2InfoUnSubscribe. The NF Service Consumer sends a DELETE request to the AMF. The AMF responds with a 204 No Content or an error status code. + +**Figure 5.2.2.4.3.1-1 NonUeN2InfoUnSubscribe for Non UE Specific Information** + +1. The NF Service Consumer shall send a DELETE request to delete an existing subscription resource in the AMF. +2. If the request is accepted, the AMF shall reply with the status code 204 indicating the resource identified by subscription ID is successfully deleted, in the response message. + +On failure or redirection, one of the HTTP status codes together with the response body listed Table 6.1.3.10.3.1-3 shall be returned. + +### 5.2.2.4.4 NonUeN2InfoNotify + +#### 5.2.2.4.4.1 General + +The NonUeN2InfoNotify service operation is used during the following procedures: + +- Obtaining non-UE associated network assistance data (See clause 4.13.5.6 in 3GPP TS 23.502 [3]) +- Receiving PWS related events from the NG-RAN +- Broadcast of Assistance Data by an LMF (see clause 6.14.1 of 3GPP TS 23.273 [42]). +- Monitoring of Timing synchronization status information (see clause 4.15.9.X of 3GPP TS 23.502 [3]). + +The NonUeN2InfoNotify service operation is invoked by the AMF to notify a NF Service Consumer that subscribed Non-UE N2 information has been received from the 5G-AN. + +The AMF shall use HTTP POST method to the N2Info Notification URI provided by the NF Service Consumer via NonUeN2InfoSubscribe service operation (See clause 5.2.2.4.2). See also Figure 5.2.2.4.4.1-1. + +![Sequence diagram for Non-UE N2 Information Notify. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with a 204 No Content or an error status code.](dbcb760c24ceea4fb409492e549777e5_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of AMF: 1. POST {n2NotifyCallbackUri} (N2InformationNotification) + AMF->>NF Service Consumer: Request + Note left of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>AMF: Response + Note left of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>AMF: Response + +``` + +Sequence diagram for Non-UE N2 Information Notify. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with a 204 No Content or an error status code. + +**Figure 5.2.2.4.4.1-1 Non-UE N2 Information Notify** + +1. The AMF shall send a HTTP POST request to the N2Info Notification URI, and the content of the POST request shall contain a N2InformationNotification data structure, with the N2 information that was subscribed by the NF Service Consumer. +- 2a. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.3.3.1-3 shall be returned. The message body shall contain a ProblemDetails object with "cause" set to one of the corresponding application errors listed in Table 6.1.5.3.3.1-3. + +#### 5.2.2.4.4.2 Using NonUeN2InfoNotify during Location Services procedures + +The NonUeN2InfoNotify service operation is invoked by a NF Service Producer, i.e. the AMF, towards the NF Service Consumer, e.g. the LMF, to notify the assistance data received from the 5G-AN. + +The requirements specified in clause 5.2.2.4.4.1 shall apply with the following modifications: + +1. If the corresponding N2 notification URI is not available, the AMF shall retrieve the NF profile of the NF Service Consumer (e.g. the LMF) from the NRF using the NF Instance Identifier received during "Obtaining Non UE Associated Network Assistance Data Procedure" or "Broadcast of Assistance Data by an LMF Procedure" (see clause 5.2.2.4.1.2), and further identify the corresponding service instance if Service Instance Identifier was also received, and fetch N2 Notification URI from the default subscription registered with "N2\_INFORMATION" notification type and "NRPPa" information class (See Table 6.2.6.2.3-1 and Table 6.2.6.2.4-1 of 3GPP TS 29.510 [29]). +2. Same as step 1 of Figure 5.2.2.4.4.1-1, the content shall contain network assistance data. + +#### 5.2.2.4.4.3 Use of NonUeN2InfoNotify for PWS related events + +The NonUeN2InfoNotify service operation shall be used during the following PWS related events: + +- 1) The AMF has received a Write-Replace-Warning-Response or a PWS-Cancel-Response from the NG-RAN over N2. + +Upon receiving the N2 Message Content the RAN Nodes return a response which may include the *Broadcast Completed Area List IE* or the *Broadcast Cancelled Area List IE*, depending on the *Message Type IE*. The AMF may aggregate the lists it receives from the RAN Nodes for the same request. + +If the *Send-Write-Replace-Warning Indication IE* was present in the Write-Replace-Warning Request message, then the AMF may forward the *Broadcast Completed Area List IE(s)* to the NF Service Consumer. If the NG-RAN node(s) have responded without the *Broadcast Completed Area List IE* then the AMF shall include the NG-RAN node ID(s) in "bcEmptyAreaList" attribute in the request body. + +If the *Send-Stop-Warning Indication IE* was present in the Stop-Warning-Request message, then the AMF may forward the *Broadcast Cancelled Area List IE(s)* to the NF Service Consumer. If the NG-RAN node(s) have responded without the *Broadcast Cancelled Area List IE* then the AMF shall include the NG-RAN node ID(s) in "bcEmptyAreaList" attribute in the request body. + +- 2) The AMF has received a Restart Indication or a Failure Indication from a NG-RAN Node. The AMF shall forward the Restart Indication or Failure Indication to the NF Service Consumer. + +The requirements specified in clause 5.2.2.4.4.1 shall apply with the following modifications: + +- Same as step 1 of Figure 5.2.2.4.4.1-1, the request body shall include the PWS related N2 information. + +#### 5.2.2.4.4.4 Using NonUeN2InfoNotify during network timing synchronization status monitoring procedure + +The NonUeN2InfoNotify service operation is invoked by a NF Service Producer, i.e. the AMF, towards the NF Service Consumer, e.g. the TSCTSF, to notify the RAN timing synchronization status information from the 5G-AN. + +The requirements specified in clause 5.2.2.4.4.1 shall apply with the following modifications: + +- Same as step 1 of Figure 5.2.2.4.4.1-1, the request body shall include the RAN Timing Synchronization Status Report message for TSS related N2 information. + +Editor's note: Further details on NGAP "RAN Timing Synchronization Status Report" to be aligned with RAN WG3, and it shall be specified in clause 6.1.6.4.3.3 + +## 5.2.2.5 AMF Status Change Operations + +### 5.2.2.5.1 AMFStatusChangeSubscribe + +#### 5.2.2.5.1.1 General + +This service operation is used by a NF Service Consumer to subscribe the status change of the AMF. + +The AMFStatusChangeSubscribe service operation is used during the following procedure: + +- AMF planned removal procedure (see 3GPP TS 23.501 [2], clause 5.21.2.2) + +#### 5.2.2.5.1.2 Creation of a subscription + +This service operation creates a subscription so a NF Service Consumer can request to be notified when the status of the AMF is changed. + +It is executed by creating a new individual resource under the collection resource "subscriptions". The operation shall be invoked by issuing a POST request on the URI of the "subscriptions collection" resource (See clause 6.1.3.6.3.1). + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF for subscription creation. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 201 Created status (2a) or a 4xx/5xx status (2b).](f9528ea5b0d2cd0192b7242e5a6af969_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. POST .../subscriptions/(subscriptionData) + NF Service Consumer->>AMF: Request + Note left of AMF: 2a. 201 Created (createdSubscriptionData) + AMF-->>NF Service Consumer: Response 2a + Note left of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Response 2b + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF for subscription creation. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 201 Created status (2a) or a 4xx/5xx status (2b). + +Figure 5.2.2.5.1.1-1 NF Service Consumer Subscription to Notifications + +1. The NF Service Consumer shall send a POST request to the resource URI representing the "subscriptions" collection resource. The request body shall include the data indicating the GUAMI(s) supported by the AMF that the NF Service Consumer is interested in receiving the related status change notification. The request body also contains a callback URI, where the NF Service Consumer shall be prepared to receive the actual notification from the AMF (see AMFStatusChangeNotify operation in clause 5.2.2.5.3). +- 2a. On success, the AMF shall include a HTTP Location header to provide the location of a newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.6.3.1-3 shall be returned. For a 4xx/5xx response, the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.6.3.1-3. + +#### 5.2.2.5.1.3 Modification of a subscription + +This service operation updates the subscription data of an NF Service Consumer previously subscribed in the AMF by providing the updated subscription data to the AMF. The update operation shall apply to the whole subscription data (complete replacement of the existing subscription data by a new subscription data). + +The NF Service Consumer shall issue an HTTP PUT request, towards the URI of the "individual subscription" resource (See clause 6.1.3.7.3.2), as shown in Figure 5.2.2.5.1.3-1: + +![Sequence diagram for Subscription Data Complete Replacement. The NF Service Consumer sends a PUT request to the AMF. The AMF responds with either a 200 OK or 204 No Content (success), or a 4xx/5xx or 3xx status code (failure/redirection).](187d05bf7ead21e1394b61320d8b3632_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. PUT « /subscriptions/{subscriptionId} (subscriptionData) » + NF Service Consumer->>AMF: Request + Note right of AMF: -2a. 200 OK (subscriptionData) or 204 No Content + AMF-->>NF Service Consumer: Success Response + Note right of AMF: -2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for Subscription Data Complete Replacement. The NF Service Consumer sends a PUT request to the AMF. The AMF responds with either a 200 OK or 204 No Content (success), or a 4xx/5xx or 3xx status code (failure/redirection). + +**Figure 5.2.2.5.1.3-1 Subscription Data Complete Replacement** + +1. The NF Service Consumer shall send a PUT request to the resource URI representing the individual subscription. The request body shall include a representation of subscription data to replace the previous subscription data in the AMF. +- 2a. On success, "200 OK" shall be returned, the content of the PUT response shall contain the representation of the replaced resource. "204 No Content" may be returned, if the NF Service Producer accepts entirely the resource representation provided by the NF Service Consumer in the request. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.7.3.2-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.7.3.2-3. + +## 5.2.2.5.2 AMFStatusChangeUnSubscribe + +### 5.2.2.5.2.1 General + +This service operation removes an existing subscription to notifications. + +The AMFStatusChangeUnSubscribe service operation is used during the following procedure: + +- AMF planned removal procedure (see 3GPP TS 23.501 [2], clause 5.21.2.2) + +It is executed by deleting a given resource identified by a "subscriptionId". The operation is invoked by issuing a DELETE request on the URI of the specific "individual subscription" resource (See clause 6.1.3.7.3.1). + +![Sequence diagram for NF Service Consumer Unsubscription to Notifications. The NF Service Consumer sends a DELETE request to the AMF. The AMF responds with a 204 No Content (success), or a 4xx/5xx or 3xx status code (failure/redirection).](ae375ead8aa673286b534e079e9a8533_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. DELETE ../subscriptions/{subscriptionId} () + NF Service Consumer->>AMF: Request + Note right of AMF: -2a. 204 No Content () + AMF-->>NF Service Consumer: Success Response + Note right of AMF: -2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for NF Service Consumer Unsubscription to Notifications. The NF Service Consumer sends a DELETE request to the AMF. The AMF responds with a 204 No Content (success), or a 4xx/5xx or 3xx status code (failure/redirection). + +**Figure 5.2.2.5.2.1-1: NF Service Consumer Unsubscription to Notifications** + +1. The NF Service Consumer shall send a DELETE request to the resource URI representing the individual subscription. The request body shall be empty. +- 2a. On success, "204 No Content" shall be returned. The response body shall be empty. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.7.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.7.3.1-3. + +### 5.2.2.5.3 AMFStatusChangeNotify + +#### 5.2.2.5.3.1 General + +This service operation notifies each NF Service Consumer that was previously subscribed to receiving notifications of the status change of the AMF (e.g. AMF unavailable). The notification is sent to a callback URI that each NF Service Consumer provided during the subscription (see AMFStatusChangeSubscribe operation in 5.2.2.5.1). + +The AMFStatusChangeNotify service operation is used during the following procedure: + +- AMF planned removal procedure (see 3GPP TS 23.501 [2], clause 5.21.2.2) + +The operation is invoked by issuing a POST request to each callback URI of the different NF Service Consumer. + +![Sequence diagram showing AMF Notifications. The diagram illustrates the interaction between an NF Service Consumer and an AMF. The AMF sends a POST request to the NF Service Consumer's callback URI. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](9e9104f9ba7eec1259a7893c6380ca1b_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NFSC as NF Service Consumer + Note left of AMF: 1. POST {amfStatusUri} (AmfStatusChangeNotification) + AMF->>NFSC: + Note right of NFSC: 2a. 204 No Content + NFSC-->>AMF: + Note right of NFSC: 2b. 4xx/5xx (ProblemDetails) Or 3xx + NFSC-->>AMF: + +``` + +Sequence diagram showing AMF Notifications. The diagram illustrates the interaction between an NF Service Consumer and an AMF. The AMF sends a POST request to the NF Service Consumer's callback URI. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +**Figure 5.2.2.5.3.1-1: AMF Notifications** + +1. The AMF shall send a POST request to the callback URI. The request body shall include the GUAMI(s) and the related status change, GUAMI(s) is indicated by the NF Service Consumer during the subscription operation. For network deployment without UDSF case, the target AMF Name which is to serve the user of the indicated GUAMI(s) is also included. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.2.3.1-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.5.2.3.1-2. + +### 5.2.2.6 EBIAssignment + +#### 5.2.2.6.1 General + +The EBIAssignment service operation is used during the following procedures (see 3GPP TS 23.502 [3], clause 4.11.1.4): + +- UE requested PDU Session Establishment including Request Types "Initial Request", "Existing PDU Session", "Initial emergency request" and "Existing emergency PDU session" (Non-roaming and Roaming with Local Breakout (see 3GPP TS 23.502 [3], clause 4.3.2.2.1). +- UE requested PDU Session Establishment including Request Types "Initial Request" and "Existing PDU Session" (Home-routed Roaming (see 3GPP TS 23.502 [3], clause 4.3.2.2.2). +- UE or network requested PDU Session Modification (non-roaming and roaming with local breakout) (see 3GPP TS 23.502 [3], clause 4.3.3.2). +- UE or network requested PDU Session Modification (home-routed roaming) (see 3GPP TS 23.502 [3], clause 4.3.3.3). +- UE Triggered Service Request (see 3GPP TS 23.502 [3], clause 4.2.3.2) to move PDU Session(s) from untrusted non-3GPP access to 3GPP access. +- Network requested PDU Session Modification, when the SMF needs to release the assigned EBI from a QoS flow (see 3GPP TS 23.502 [3], clause 4.11.1.4.3). + +The EBIAssignment service operation is invoked by a NF Service Consumer, e.g. a SMF, towards the NF Service Producer, i.e. the AMF, to request the AMF to allocate EPS bearer ID(s) towards EPS bearer(s) mapped from QoS flow(s) for an existing PDU Session for a given UE. + +EBI allocation shall apply only to: + +- QoS flows of Single Access PDU Session(s) via 3GPP access supporting EPS interworking with N26; +- QoS flows of Multi-Access PDU Session(s) supporting EPS interworking with N26, that are not only allowed over non-3GPP access. + +EBI allocation shall not apply to: + +- PDU Session(s) via 3GPP access supporting EPS interworking without N26, or; +- PDU Session(s) via non-3GPP access supporting EPS interworking; +- GBR QoS flow(s) that are only allowed over non-3GPP access in Multi-Access PDU Session(s) supporting EPS interworking. + +The EBIAssignment service operation is also invoked by an NF Service Consumer, e.g. an SMF, towards the NF Service Producer supporting the EAEA feature, i.e. the AMF, to request the AMF to update the mapping of EBI and ARP, if the ARP for a QoS flow that has already been allocated an EBI is changed during the network requested PDU Session Modification. + +The NF Service Consumer (e.g. the SMF) shall perform EBIAssignment service operation by invoking "assign-ebi" custom operation on the "individual ueContext" resource (See clause 6.1.3.2.4.3). See also Figure 5.2.2.6.1-1. + +![Sequence diagram illustrating the EBI Assignment process. Two rectangular boxes represent the NF Service Consumer (left) and the NF Service Producer (right). A dashed vertical line extends downwards from each box. The consumer sends a solid horizontal arrow to the producer. The producer responds with two dashed horizontal arrows pointing back to the consumer.](c3e8a7fe2e4f51806e05b9b1aae20d57_img.jpg) + +Sequence diagram illustrating the EBI Assignment process. Two rectangular boxes represent the NF Service Consumer (left) and the NF Service Producer (right). A dashed vertical line extends downwards from each box. The consumer sends a solid horizontal arrow to the producer. The producer responds with two dashed horizontal arrows pointing back to the consumer. + +**Figure 5.2.2.6.1-1 EBI Assignment** + +1. The NF Service Consumer, e.g. the SMF, shall invoke "assign-ebi" custom method on individual ueContext resource, which is identified by the UE's SUPI or PEI in the AMF. The NF Service consumer shall provide PDU Session ID and ARP list as input for the service operation. If the NF Service Consumer invokes this service operation to update the mapping of EBI and ARP for a QoS flow to which an EBI is already allocated in the AMF, the NF Service Consumer shall provide the PDU Session ID and modifiedEbiList. +- 2a. On success, the AMF shall assign EBI for each ARP in received ARP list, if enough EBI(s) are available. If there is not enough EBI(s) available, the AMF may revoke already assigned EBI(s) based on the ARP(s) and the S-NSSAI of the PDU session for which the request was received, EBIs information in the UE context and local policies. The AMF may only assign a subset of the requested EPS Bearer ID(s), e.g. when other PDU Sessions with higher ARP have occupied other available EPS Bearer IDs. If AMF has successfully assigned all or part of the requested EBI(s), the AMF shall respond with the status code 200 OK, together with the assigned EBI to ARP mapping(s), the list of ARPs for which the AMF failed to allocate an EBI (if any) and the list of EBI(s) released for this PDU session due to revocation based on ARP(s) and the S-NSSAI (if any). + +If the request contains "releasedEbiList", the AMF shall release the requested EBI(s). The AMF shall respond with the status code 200 OK and shall include the EBI(s) released in the "releasedEbiList" IE of the POST response body. The "releasedEbiList" in the request shall be handled before the EBI assignment in AMF. + +If the same EBI(s) are both in the "releasedEbiList" and "assignedEbiList", the NF service consumer considers that EBI(s) have been released and reassigned. + +If the request contains "modifiedEbiList", the AMF shall store the association of the assigned EBI and ARP pair to the corresponding PDU Session ID. The AMF shall respond with the status code 200 OK and shall include the EBI(s) with ARP updated in the "modifiedEbiList" IE of the POST response body. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.3.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain an AssignEbiError structure, including: +- a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.4.3.2-2; + - a failureDetails which describes the details of the failure including the list of ARPs for which the EBI assignment failed. + +## 5.3 Namf\_EventExposure Service + +### 5.3.1 Service Description + +The AMF may offer this service as a Service Producer to enable an NF to subscribe to event notifications on its own or on behalf of another NF and get notified about an event. The known Service Consumers are NEF, SMF, UDM, NWDAF, DCCF, LMF, TSCTSF and GMLC. See also clause 5.34.7 of 3GPP TS 23.501 [2] and clauses 4.15.1, 4.15.3.2, 4.15.4.2 and 5.2.2.3.1 of 3GPP TS 23.502 [3], clause 6.2.2 in 3GPP TS 23.288 [38]. + +The following events are provided by Namf\_EventExposure Service: + +#### Event: Location-Report + +A NF subscribes to this event to receive the Last Known Location or the Current Location of a UE or a group of UEs or any UE, and Updated Location of any of these UEs when AMF becomes aware of a location change of any of these UEs with the granularity as requested. + +This event implements the "Location Reporting" event in table 4.15.3.1-1 of 3GPP TS 23.502 [3]. + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuous Report (See NOTE 1), Periodic Report (See NOTE 1 and 2) + +Input: UE-ID(s), "ANY\_UE", optional filters: TAI, Cell-ID, N3IWF, UE-IP, UDP-PORT, TNAP ID, TWAP ID, Global Line Id + +Notification: UE-ID, filtered updated location (TAI, Cell-ID for 3GPP access, most recent N3IWF node, UE local IP address and UDP source port number for non-3GPP access, TNAP ID, TWAP ID, Global Line Id). + +NOTE 1: Support of Continuous Report or Periodic Report should be controlled by operator policy. + +NOTE 2: For Periodic Report, UE Last Known Location is reported if the UE is in CM-IDLE state when the report is being generated. + +#### Event: Presence-In-AOI-Report + +A NF subscribe to this event to receive the current present state of a UE or a group of UEs or any UE in a specific Area of Interest (AOI), and notification when a specified UE enters or leaves the specified area. The area could be identified by a TA list, a NG-RAN node ID list, a cell ID list, an area ID or specific interested area name like "LADN". + +For one-time reporting or for the first notification of Continuous reporting, the AMF shall generate the notification as following: + +- when the event subscription is targeting a UE or a group of UEs, the AMF shall report the current presence status of the target UE(s); +- when the event subscription is targeting any UE, the AMF shall only report the UEs that are "IN" the Area of Interest (AOI); if no UE is currently "IN" the Area of Interest (AOI), the AMF shall generate a report only including the AnyUe indication (without any UE ID) and the subscribed AOI with the presence status set to "IN". The NF consumer should consider other UEs served by the AMF are "OUT" of the AOI or with "UNKNOWN" state. + +In subsequent notifications, the AMF shall only report the UE(s) whose presence status has changed compared to the previous notification sent by the AMF. + +If the event subscription indicates that the AoI may be adjusted based on the UE's Registration Area, the AMF shall report that the UE is IN the AoI if the UE is inside a Registration Area which contains at least one Tracking Area that is contained within the Area of Interest (see clause 5.3.4.4 of 3GPP TS 23.501 [2] and clauses 4.15.9.3.2, 4.15.9.4, 5.2.2.3.1 and Annex D.1 of 3GPP TS 23.502 [3]). + +If the subscription to the Presence-In-AOI-Report event includes the "RAN timing synchronization status change event" indication and the UE indicated support for network reconnection due to RAN timing synchronization status change, the AMF shall report the UE presence in AoI based on the most recent N2 connection as described in clause 5.3.4.4 of 3GPP TS 23.501 [2] and Annex D.1 of 3GPP TS 23.502 [3]. + +For an AMF supporting the AOIEF feature (AOI Event Filters for Subscriptions targeting any UE, see clause 6.2.8), a subscription to the Presence-In-AOI-Report event targeting Any UE may include: + +- the notifyForSupiList IE to request the AMF to notify the NF service consumer about AOI events only if the event is for a UE belonging to the provided list of SUPIs; and/or +- the notifyForSnssaiDnnList IE to request the AMF to notify the NF service consumer about AOI events only if the event is for a UE having a PDU session established for the provided DNN(s)/S-NSSAI(s). + +If a subscription to the Presence-In-AOI-Report event targeting Any UE includes both the notifyForSupiList and the notifyForSnssaiDnnList IEs, the AMF shall notify the NF service consumer about AOI events only if the event is for a UE fulfilling all the related conditions specified above. + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuously Report + +Input: UE ID(s), "ANY\_UE", Area identifier (a TA list, a NG-RAN node ID list, a cell ID list, an area Id or "LADN"), S-NSSAI, NSI ID, Adjust AoI based on RA indication, RAN timing synchronization status change indication, optional filters (Notify the NF service consumer only for UEs in the notifyForSupiList, Notify the NF service consumer only for UEs having a PDU session established with a DNN/S-NSSAI in the notifyForSnssaiDnnList IE). + +Notification: UE-ID(s), Area identifier, Presence Status (IN/OUT/UNKNOWN) + +Event: Time-Zone-Report + +A NF subscribes to this event to receive the current time zone of a UE or a group of UEs, and updated time zone of the UE or any UE in the group when AMF becomes aware of a time zone change of the UE. + +UE Type: One UE, Group of UEs + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s) + +Notification: UE-ID, most recent time-zone + +Event: Access-Type-Report + +A NF subscribes to this event to receive the current access type(s) of a UE or a group of UEs or any UE, and updated access type(s) of any of the UEs when AMF becomes aware of the access type change of any of these UEs. The area could be identified by a TA list, an area ID or specific interested area name like "LADN". + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s), "ANY\_UE", optionally filters: Area identifier (a TA list, an area Id or "LADN") + +Notification: UE ID, most recent access-types (3GPP, Non-3GPP) + +Event: Registration-State-Report + +A NF subscribes to this event to receive the current registration state of a UE or a group of UEs or any UE, and report for updated registration state of any of these UEs when AMF becomes aware of a registration state change of any of these UEs. The area could be identified by a TA list, an area ID or specific interested area name like "LADN". + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s), "ANY\_UE", optionally filters: Area identifier (a TA list, an area Id or "LADN") + +Notification: UE ID, most recent registration state (REGISTERED/DEREGISTERED) with access type + +Event: Connectivity-State-Report + +A NF subscribes to this event to receive the current connection management state of a UE or a group of UEs, and report for updated connection management state of a UE or any UE in the group when AMF becomes aware of a connection management state change of the UE. + +UE Type: One UE, Group of UEs + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s) + +Notification: UE ID, most recent connection management state (IDLE/CONNECTED) with access type + +Event: Reachability-Report + +A NF subscribes to this event for "UE Reachability Status Change" to receive the current reachability state of a UE or a group of UEs in the AMF, and report for updated reachability state of a UE or any UE in the group when AMF becomes aware of a reachability state change of the UEs between REACHABLE, UNREACHABLE, REGULATORY\_ONLY. The following conditions apply: + +- the AMF shall send a Reachability Report ("UNREACHABLE") if the Mobile Reachable Timer expires (see clause 5.4.1.1 of 3GPP TS 23.501 [2]) or the UE enters CM-IDLE when it is only registered over the Non-3GPP access (see clause 5.5.3 of 3GPP TS 23.501 [2]); +- the AMF shall send a Reachability Report ("REGULATORY\_ONLY") if the UE becomes reachable only for regulatory prioritized service (see clause 4.15.4.2 of 3GPP TS 23.502 [3]); + +- the AMF shall send a Reachability Report ("REACHABLE") when the UE reachability state changes from any of the two above states to REACHABLE. + +NOTE 3: The AMF does not send a Reachability Report ("UNREACHABLE") in particular when the UE enters extended DRX cycle (see clause 5.31.7.2.2.3 of 3GPP TS 23.501 [2]), the UE enters power saving state (see clause 5.31.8 of 3GPP TS 23.501 [2]), the UE enters CM IDLE in MICO mode (see clause 5.4.1.3 of 3GPP TS 23.501 [2]), or when the UE does not respond to a paging request. + +An NF subscribes to this event for "UE Reachable for DL Traffic" to receive reports of a UE or a group of UEs when the UE becomes reachable for sending downlink data. In this case, the event is detected when the UE transitions to CM-CONNECTED mode or when the UE will become reachable for paging, as specified in table 4.15.3.1-1, clauses 4.2.5 and 4.3.3 of 3GPP TS 23.502 [3]. When reporting the "UE Reachable for DL Traffic", the AMF shall also indicate the access types through which the UE is reachable. + +NOTE 4: The AMF does not send an event report for "UE Reachable for DL Traffic" immediately after an UECM Registration in UDM, if the AMF has previously been indicated that reachability event will be detected at UDM. The UDM will detect the UE reachability from the UECM Registration and send a notification to the NF consumer (unless the UDM is indicated that the UE is currently not reachable, as specified in clause 5.3.2.2.2 of 3GPP TS 29.503 [35]), thus the notification report from AMF is omitted. + +UE Type: One UE, Group of UEs + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s), (optional) Reachability Filter + +Notification: UE ID, AMF Id, most recent reachability state + +(REACHABLE/UNREACHABLE/REGULATORY\_ONLY), access type(s) through which the UE is reachable. + +Event: Communication-Failure-Report + +A NF subscribes to this event to receive the Communication failure report of a UE or group of UEs or any UE, when the AMF becomes aware of a RAN or NAS failure event. + +This event implements the "Communication failure" event in table 4.15.3.1-1 of 3GPP TS 23.502 [3], which is an unexpected termination of the communication. + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s), "ANY\_UE", optionally filters: Area identifier (a TA list, an area Id or "LADN") + +Notification: UE ID, RAN/NAS release code. + +Event: UEs-In-Area-Report + +A NF subscribes to this event to receive the number of UEs in a specific area. A NF may ask AMF for the UEs within the area based on Last Known Location or it may request AMF to actively look for the UEs within the area based on Current Location. + +This event implements the "Number of UEs present in a geographical area" event in table 4.15.3.1-1 of 3GPP TS 23.502 [3]. + +UE Type: any UE + +Input: "ANY\_UE", Area identified in a TA List or cell ID list, optionally Ue in Area filters: UE Aerial Indication, Indication of PDU session established for DNN(s) subject to aerial service, indication to omit UE IDs in the event reports + +Report Type: One-Time Report (See NOTE 3), Continuous Report (See NOTE 4), Periodic Report (See NOTE 4) + +Notification: Number of UEs in the area, and if eNA is supported also the UE IDs + +NOTE 5: For an Immediate Report, UE Last Known Location is used to count the UEs within the area. + +NOTE 6: Support of Continuous Report or Periodic Report should be controlled by operator. + +Event: Loss-of-Connectivity + +An NF subscribes to this event to receive the event report of a UE or group of UEs when AMF detects that a target UE is no longer reachable for either signalling or user plane communication. Such condition is identified when Mobile Reachable timer expires in the AMF (see 3GPP TS 23.501 [2]), when the UE detaches, when AMF deregisters from UDM for an active UE and when UE indicates Unavailability Period by including Unavailability Period Duration during Mobility Registration or Deregistration procedure. If the UE is already not reachable for either signalling or user plane communication when the event is subscribed, the AMF reports the event directly, and shall include, when applicable, the remaining value of Unavailability Period Duration to determine the foreseen Loss of Connectivity time. If the UE included Start of + +Unavailability Period, the event is reported when unavailability period starts, else the event is reported immediately, if subscribed. + +This event implements the "Loss of Connectivity" event in table 4.15.3.1-1 of 3GPP TS 23.502 [3]. + +UE Type: One UE, Group of UEs. + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s) + +Notification: UE ID, optionally Unavailability Period Duration. + +Event: 5GS-User-State-Report + +A NF subscribes to this event to receive the 5GS User State of a UE. + +UE Type: One UE + +Report Type: One-Time Report + +Input: UE ID(s) + +Notification: UE ID, 5GS User State + +Event: Availability-after-DDN-failure + +A NF subscribes to this event to be notified about the Availability of a UE after a DDN failure. + +UE Type: One UE, Group of UEs + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s) + +Notification: UE ID(s) + +Event: Type-Allocation-Code-Report + +A NF subscribes to this event to receive the TAC of a UE or a group of UEs or any UE. + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s), "ANY\_UE", optionally filters: TAI, Area identifier (a TA list, an area Id or "LADN") + +Notification: UE ID(s), TAC(s) + +Event: Frequent-Mobility-Registration-Report + +A NF subscribes to this event to receive the number of mobility registration during a period for a UE or a group of UEs or any UE. + +UE Type: One UE, Group of UEs, any UE + +Report Type: One-Time Report, Continuous Report + +Input: UE ID(s), expiry time, "ANY\_UE", optionally filters: Area identifier (a TA list, an area Id or "LADN") + +Notification: UE ID(s), Frequent Registration + +Event: Snssai-TA-Mapping-Report + +A NF subscribes to this event to receive the related access type and the list of supported S-NSSAIs. + +UE Type: any UE + +Report Type: One-Time Report, Continuous Report + +Input: Target Area: TA list or "ANY\_TAI", optionally filters: S-NSSAI(s) + +Notification: Access type, list of supported S-NSSAIs with an indication of restriction at the AMF + +Event: UE-Access-Behavior-Trends + +A NF subscribes to this event to receive the UE access behavior trends (e.g. access type change, handover, etc.) within a period for a UE or a group of UEs, as specified in clause 4.15.4.2 of 3GPP TS 23.502 [3]. + +UE Type: One UE, Group of UEs + +Report Type: Periodic Report + +Input: UE ID(s), expiry time + +Notification: UE ID(s), UE access behavior trends report. + +Event: UE-Location-Trends + +A NF subscribes to this event to receive the UE Location Trends within a period for a UE or a group of UEs, as specified in clause 4.15.4.2 of 3GPP TS 23.502 [3]. + +UE Type: One UE, Group of UEs + +Report Type: Periodic Report + +Input: UE ID(s), expiry time, Dispersion Area (e.g. a TAI list). + +Notification: UE ID(s), UE Location Trends report. + +Event: UE-MM-Transaction-Report + +A NF subscribes to this event to receive the Total Number of Mobility Management transactions during a period for a UE or a group of UEs, as specified in clause 5.2.2.3.1 of 3GPP TS 23.502 [3]. The Total number of + +transactions is incremented when the NAS signalling transactions from Authentication, Registration, De-Registration, Service Request and UE Configuration Update procedures is completed + +UE Type: One UE, Group of UEs + +Report Type: Periodic Report + +Input: UE ID(s), expiry time, filters: Dispersion Area (e.g. a TA list) or Slice filter (i.e. a list of S-NSSAIs) + +Notification: UE ID(s), List of UE transaction numbers per location or List of UE transaction numbers per slice. + +## 5.3.2 Service Operations + +### 5.3.2.1 Introduction + +For the Namf\_EventExposure service the following service operations are defined: + +- Subscribe; +- Unsubscribe; +- Notify. + +### 5.3.2.2 Subscribe + +#### 5.3.2.2.1 General + +The Service Operation is used by a NF Service Consumer (e.g. NEF) to subscribe to an event(s) for one UE, group of UE(s) or any UE. + +#### 5.3.2.2.2 Creation of a subscription + +The Subscribe service operation is invoked by a NF Service Consumer, e.g. NEF, towards the AMF, when it needs to create a subscription to monitor at least one event relevant to the AMF. The NF Service Consumer may subscribe to multiple events in a subscription. A subscription may be associated with one UE, a group of UEs or any UE. + +The NF Service Consumer shall request to create a new subscription by using HTTP method POST with URI of the subscriptions collection, see clause 6.2.3.2. + +The NF Service Consumer shall include the following information in the HTTP message body: + +- NF ID, indicates the identity of the network function instance initiating the subscription; +- Subscription Target, indicates the target(s) to be monitored, as one of the following types: + - A specific UE, identified with a SUPI, a PEI or a GPSI; + - A group of UEs, identified with a group identity; + - Any UE, identified by the "anyUE" flag. +- Notification URI, indicates the address to deliver the event notifications generated by the subscription; +- Notification Correlation ID, indicates the correlation identity to be carried in the event notifications generated by the subscription; +- List of events to be subscribed; +- Event Types per event, as specified in clause 5.3.1. + +The NF Service Consumer may include the following information in the HTTP message body: + +- Immediate Report Flag per event, indicates an immediate report to be generated with current event status; +- Event Trigger, indicates how the events shall be reported (One-time Reporting or Continuously Reporting). +- Maximum Number of Reports, defines the maximum number of reports after which the event subscription ceases to exist; +- Expiry, defines maximum duration after which the event subscription ceases to exist; + +- Sampling ratio, defines the random subset of UEs among target UEs, and AMF only report the event(s) related to the selected subset of UEs; +- partitioning criteria, that defines Criteria for partitioning UEs before applying sampling ratio; +- Periodic Report Flag per event, indicates the report to be generated periodically; +- Repetition Period, defines the period for periodic reporting; +- Variable reporting periodicity information, defines the list of conditions related to Reporting periodicity and the period per condition. +- Event Filters per applicable event, defines further options on when/how the event shall be reported; +- Reference Id per event, indicates the value of the Reference Id associated with the event to be monitored. If provided, the Reference Id shall be included in the reports triggered by the event; +- a notification flag as "notifFlag" attribute if the EneNA feature is supported; and/or +- Muting Exception Instructions, which specify instructions to apply to the subscription and the stored events when an exception occurs at the AMF while the event is muted (e.g., the buffer of stored event reports is full, or the number of stored event reports exceeds a certain number), if the ENAPH3 feature is supported (see clause 6.2.8). + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF for subscription creation. The NF Service Consumer sends a POST request to the AMF. The AMF responds with a 201 Created status (with optional event report) or a 4xx/5xx (ProblemDetails) or 3xx status.](03d9aaba6c1af8bfd8e42c1d2422ae5c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: NF Service Consumer + Note right of AMF: AMF + NF Service Consumer->>AMF: 1. POST .../subscriptions (AmfCreateEventSubscription) + AMF-->>NF Service Consumer: -2a. 201 Created (AmfCreatedEventSubscription (with optional event report)) + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF for subscription creation. The NF Service Consumer sends a POST request to the AMF. The AMF responds with a 201 Created status (with optional event report) or a 4xx/5xx (ProblemDetails) or 3xx status. + +**Figure 5.3.2.2.2-1 Subscribe for Creation** + +- The NF Service Consumer shall send a POST request to create a subscription resource in the AMF. The content of the POST request shall contain a representation of the individual subscription resource to be created. The request may contain an expiry time, suggested by the NF Service Consumer as a hint, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event(s) shall stop generating report. +- On success, the request is accepted, the AMF shall include a HTTP Location header to provide the location of a newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. If the NF Service Consumer has included more than one events in the event subscription and some of the events are failed to be subscribed, the AMF shall accept the message and provide the successfully subscribed event(s) in AmfEventSubscription. If the NF Service Consumer has included the immediateFlag with value as "true" in the event subscription, the AMF shall include the current status of the events subscribed, if available (e.g. last known location information is included if the subscribed event is LOCATION\_REPORT). If the events with immediateFlag set to "true" are subscribed by an NF service consumer on behalf of a third NF and the NF service consumer has not indicated supporting of IERSR feature (see 6.2.8), the notification will be sent to the third NF directly, i.e. subsChangeNotifyUri is included in the event subscription, the current status of the events subscribed shall not be included in response. The AMF shall subsequently send a notification to the third NF including the current status of the events subscribed. + +If the NF Service Consumer has set the event reporting option as ONE\_TIME and if the AMF has included the current status of the events subscribed in the response, then the AMF shall not do any subsequent event notification for the events given in the AmfCreateEventSubscription parameter. If the NF Service Consumer has set the event reporting option as ONE\_TIME, the subscribed event as LOCATION\_REPORT and the immediateFlag is set to false or absent, the AMF shall send an event notification to notify the current location of the UE after the subscription; if the UE is in RM-REGISTERED and CM-IDLE state over 3GPP access and the UE does not respond to the paging, or if the UE is in RM-REGISTERED over non-3GPP access, the event notification shall include the last known location and the ageOfLocationInformation IE set to a value other than "0", which indicates to the NF service consumer that the AMF returned the last known location. + +If the NF Service Consumer has set the CONTINUOUS or PERIODIC event reporting option, the subscribed event as LOCATION\_REPORT and the immediateFlag is set to false or absent, the AMF shall send a first event notification to notify the current location of the UE after the subscription is created and then subsequent event notifications when the user location changes or according to the requested period respectively; if at the time of the subscription creation the UE is in RM-REGISTERED and CM-IDLE state over 3GPP access and the UE does not respond to the paging, or if the UE is in RM-REGISTERED over non-3GPP access, the AMF shall send the first event notification including the last known location and the ageOfLocationInformation IE set to a value other than "0", which indicates to the NF service consumer that the AMF returned the last known location. + +The response, based on operator policy and taking into account the expiry time included in the request, may contain the expiry time, as determined by the AMF, after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the AMF. The AMF shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +If the sampling ratio ("sampRatio") attribute is included in the subscription without a partitioningCriteria, the AMF shall select a random subset of UEs among target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. If the partitioningCriteria attribute is also included along with sampling ratio, the AMF shall apply the sampling ratio on the group of UEs determined according to the partitioning criteria. + +If the AMF supports the EneNA feature and the "notifFlag" attribute is included and set to "DEACTIVATE" in the request (by e.g. the NWDAF or DCCF), the AMF shall mute the event notification and store the available events. Additionally, if the AMF also supports the ENAPH3 feature (see clause 6.2.8) and the NF service consumer also included event muting instructions in the request, the AMF should evaluate the received event muting instructions against local actions (if configured) and, if the subscription creation request is accepted, the AMF may indicate the following information to the NF service consumer in the response: + +- the maximum number of notifications that the AMF expects to be able to store for the subscription; +- an estimate of the duration for which notifications can be buffered. + +If the NF service consumer is a UDM, the AMF and the UDM both support the "ESSYNC" feature and the subscription is targeting a specific UE with Reference Id(s) included in the subscription, the AMF shall locally store the information that the event subscription is subject to the Event Subscription Synchronization with UDM during EPS to 5GS mobility as specified in clause 5.3.2.4.2. During inter-AMF mobility procedures, the source AMF shall include the "eventSyncInd" IE (in AmfEventSubscriptionAddInfo data type) with the value "true" in the UE Context for the event subscriptions that are subject to Event Subscription Synchronization with UDM. + +If the subscription creation request targets a group of UE or any UE, the AMF shall accept the request and create a subscription even if the AMF does not currently serve any UE of the group or any UE respectively, unless other reasons exist to reject the request. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.2.3.2.3.1-3. + +If the subscription creation request targets a specific UE and this UE is not served by the AMF (i.e. it is not known to the AMF), the AMF shall reject the request with a 403 Forbidden response and the application error "UE\_NOT\_SERVED\_BY\_AMF", unless the request can be redirected to another AMF known to serve the UE (e.g. another AMF of the same AMF set). + +If the AMF supports the EneNA and ENAPH3 features (see clause 6.2.8), the NF service consumer sets the "notifFlag" attribute to "DEACTIVATE" and event muting instructions in the request, but the AMF cannot accept the received instructions, the AMF may reject the request with a 403 Forbidden response and the application error "MUTING\_EXC\_INSTR\_NOT\_ACCEPTED". + +### 5.3.2.2.3 Modification of a subscription + +The Subscribe service operation is invoked by a NF Service Consumer, e.g. NEF, towards the AMF, when it needs to modify an existing subscription previously created by itself at the AMF. + +The NF Service Consumer shall modify the subscription by using HTTP method PATCH with the URI of the individual subscription resource (see clause 6.2.3.3) to be modified. + +See also Figure 5.3.2.2.3-1 below. + +![Sequence diagram showing the modification of a subscription. The NF Service Consumer sends a PATCH request to the AMF. The AMF responds with either a 200 OK (AmfUpdatedSubscriptionData) or a 4xx/5xx (ProblemDetails) or 3xx status code.](65e8c0628536d6d4245e9ab46ba070c3_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note right of NF Service Consumer: 1. PATCH .../subscriptions/{subscriptionId} (AmfUpdateEventSubscriptionItem) or +PATCH .../subscriptions/{subscriptionId} (AmfUpdateEventOptionItem) + NF Service Consumer->>AMF: 1. PATCH request + AMF-->>NF Service Consumer: 2a. 200 OK (AmfUpdatedSubscriptionData) + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the modification of a subscription. The NF Service Consumer sends a PATCH request to the AMF. The AMF responds with either a 200 OK (AmfUpdatedSubscriptionData) or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.3.2.2.3-1 Modification of a Subscription** + +- The NF Service Consumer shall send a PATCH request to modify a subscription resource in the AMF. The modification may be for the events subscribed or for updating the event options. +- On success, the request is accepted, the AMF shall return the representation of the modified subscription resource or its sub-resource together with the status code 200 OK. When the PATCH request is for modifying the expiry attribute of the options IE of the subscription, then the AMF based on operator policies and taking into account the expiry time included in the request, shall include an expiry time, after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the AMF, as specified in clause 5.3.2.2.2. The AMF shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. + +The PATCH request may be used to modify the "notifFlag" attribute of the options IE of the subscription, when both the AMF and NF Service Consumer support the EneNA feature as defined in clause 6.2.8: + +- if the "notifFlag" attribute is set to "DEACTIVATE" in the request and the event notification is currently not muted, the AMF shall mute the event notification and store the available events, or +- if the "notifFlag" is set to "RETRIEVAL" in the request and the event notification is currently muted, the AMF shall send the stored events to the NF service consumer, mute the event notification again and store available events; or +- if the "notifFlag" is set to "ACTIVATE" in the request and the event notification is currently muted, the AMF shall send the stored events to the NF service consumer and stop muting the event notification. + +In addition, if both the AMF and the NF service consumer (e.g. NWDAF or DCCF) also support the ENAPH3 feature (see clause 6.2.8), the PATCH request modifies the "notifFlag" attribute to "DEACTIVATE" and contains muting exception instructions, the AMF should evaluate the received event muting instructions against local actions (if configured) and, if the subscription modification request is accepted, the AMF may indicate the following information to the NF service consumer in the response: + +- the maximum number of notifications that the AMF expects to be able to store; +- an estimate of the duration for which notifications can be buffered. + +If the subscription requested to be modified targets a group of UE or any UE, the AMF shall accept the request and modify the subscription even if the AMF does not currently serve any UE of the group or any UE respectively, unless other reasons exist to reject the request. + +- On failure or redirection, one of the HTTP status codes listed in Table 6.2.3.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.3.3.1-3. + +If the AMF cannot accept the received muting exception instructions, the AMF may reject the request with a 403 Forbidden response and the application error "MUTING\_EXC\_INSTR\_NOT\_ACCEPTED". + +#### 5.3.2.2.4 Remove or add group member UE(s) for a group subscription + +The Subscribe service operation is invoked by a NF Service Consumer, e.g. UDM, towards the AMF, to remove or add group member UE(s) for an existing group subscription. + +The NF Service Consumer shall modify the subscription by using HTTP method PATCH with the URI of the individual subscription resource (see clause 6.2.3.3) to be modified. + +See also Figure 5.3.2.2.4-1 below. + +![Sequence diagram for Figure 5.3.2.2.4-1: Remove or add group member UE(s) for a group subscription. The diagram shows an NF Service Consumer sending a PATCH request to the AMF. The AMF responds with either a 200 OK (AmfUpdatedSubscriptionData) or a 4xx/5xx (ProblemDetails) or 3xx status code.](56a5265d174ce056c1dbe5e7a60839fc_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. PATCH « subscriptions/{subscriptionId} (AmfUpdateEventSubscriptionItem) » + NF Service Consumer->>AMF: Request + Note right of AMF: 2a. 200 OK (AmfUpdatedSubscriptionData) + AMF-->>NF Service Consumer: Success Response + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Error Response + +``` + +Sequence diagram for Figure 5.3.2.2.4-1: Remove or add group member UE(s) for a group subscription. The diagram shows an NF Service Consumer sending a PATCH request to the AMF. The AMF responds with either a 200 OK (AmfUpdatedSubscriptionData) or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.3.2.2.4-1 Remove or add group member UE(s) for a group subscription** + +1. The NF Service Consumer shall send a PATCH request to modify a subscription resource targeting a group of UEs in the AMF. The modification shall indicate the group member UE(s) to be excluded or added for the group subscription. +- 2a. On success, the request is accepted, the AMF shall return the representation of the modified subscription resource with the status code 200 OK. + +The AMF shall stop monitoring events for excluded member UE(s). If Maximum number of Reports is applied, the AMF shall set the number of reports of the indicated UE(s) to Maximum Number of Reports. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.3.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.2.3.3.3.1-3. + +## 5.3.2.3 Unsubscribe + +### 5.3.2.3.1 General + +The Unsubscribe service operation is invoked by a NF Service Consumer, e.g. NEF, towards the AMF, to remove an existing subscription previously created by itself at the AMF. + +The NF Service Consumer shall unsubscribe to the subscription by using HTTP method DELETE with the URI of the individual subscription resource (see clause 6.2.3.3) to be deleted. + +![Sequence diagram for Figure 5.3.2.3.1-1: Unsubscribe a subscription. The diagram shows an NF Service Consumer sending a DELETE request to the AMF. The AMF responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx status code.](9cd7ec4a653f07d02def283cb6f2309e_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. DELETE .../subscriptions/{subscriptionId} + NF Service Consumer->>AMF: Request + Note right of AMF: 2a. 204 No Content + AMF-->>NF Service Consumer: Success Response + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Error Response + +``` + +Sequence diagram for Figure 5.3.2.3.1-1: Unsubscribe a subscription. The diagram shows an NF Service Consumer sending a DELETE request to the AMF. The AMF responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.3.2.3.1-1 Unsubscribe a subscription** + +1. The NF Service Consumer shall send a DELETE request to delete an existing subscription resource in the AMF. +- 2a. On success, the request is accepted, the AMF shall reply with the status code 204 indicating the resource identified by subscription ID is successfully deleted in the response message. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.3.3.2-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.2.3.3.3.2-3. + +### 5.3.2.4 Notify + +#### 5.3.2.4.1 General + +The Notify service operation is invoked by the AMF, to send a notification, towards the notification URI, when certain event included in the subscription has taken place. + +The AMF shall use the HTTP method POST, using the notification URI received in the subscription creation as specified in clause 5.3.2.2.2, including e.g. the subscription ID, Event ID(s) for which event has happened, notification correlation ID provided by the NF service consumer at the time of event subscription, to send a notification. See Figure 5.3.2.4.1-1. + +Additionally, the Notify service operation shall also be invoked by the AMF, when: + +- there is a change of AMF during UE mobility procedures, if the subscription Id changes (i.e. Registration procedures and Handover procedures), or +- the subscription is terminated by the AMF, if event subscription termination notification is requested by the NF consumer. + +![Sequence diagram showing the Notify service operation between an NF Service Consumer and an AMF. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx status code.](ae0dd5533e0b7fd2db452b5e2fdf8e5b_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NFSC as NF Service Consumer + Note left of AMF: 1. POST {eventNotificationUrl}(AmfEventNotification) + AMF->>NFSC: 1. POST {eventNotificationUrl}(AmfEventNotification) + Note right of NFSC: 2a. 204 No Content + NFSC-->>AMF: 2a. 204 No Content + Note right of NFSC: 2b. 4xx/5xx (ProblemDetails) Or 3xx + NFSC-->>AMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram showing the Notify service operation between an NF Service Consumer and an AMF. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx status code. + +Figure 5.3.2.4.1-1 Notify + +1. The AMF shall send a POST request to send a notification. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned and appropriate additional error information should be returned. + +When the AMF received the following response code (and application error), the AMF should consider the subscription is no longer valid and terminate the subscription: + +- "400 Bad Request" with application error "RESOURCE\_CONTEXT\_NOT\_FOUND" +- "404 Not Found" + +When AMF terminates the subscription in above scenarios, if the subscription is created by the NF consumer on behalf of another NF (e.g. the UDM subscribes to the AMF on behalf of the NEF) and notification of event subscription termination is requested by the NF consumer, the AMF supporting the 'STEN' feature shall send a notification to the NF consumer (e.g. the UDM) to report the termination of the subscription. + +#### 5.3.2.4.2 Event Subscription Synchronization for specific UE + +When the AMF and the UDM both support the "ESSYNC" feature, the AMF may initiate synchronization for event subscriptions with the UDM for the specific UE during EPS to 5GS mobility registration procedure (see clause 4.11.5.2 of 3GPP TS 23.502 [3]), if UE specific event subscriptions from the UDM are available in UE Context. + +To initiate event subscription synchronization, when sending notification for subscription change to the UDM, the AMF shall include the event subscription information in the notification request. If subscription change notification is not needed, e.g. when UE registers to the same AMF after moving from EPS, the AMF may send a notification to the subscription change notification URI. The notification request in this case only includes the event subscription information but no event report list. + +The AMF shall only include active event subscriptions that are subject to Event Subscription Synchronization with UDM (determined as defined in clause 5.3.2.2.2) in the event subscription information. + +For each active subscription, the following information shall include: + +- URI of the subscription resource in the AMF; and +- Notification Correlation Id of the subscription; and +- list of Reference Ids, one per event in the subscription; and +- optionally, the URI of old subscription resource on the source AMF, if the subscription Id is changed during the mobility procedure. + +When the UDM receives event subscription information from AMF, the UDM shall compare the active event subscriptions in AMF with the active UDM Event Exposure subscriptions using Reference Id(s) and Notification Correlation Id, and perform the following: + +- if an event is to be detected by AMF but not existing in the AMF, the UDM shall subscribe the event in AMF by creating a new AMF event subscription or updating an existing AMF event subscription; +- if an event exists in AMF but does not exist in UDM, the UDM shall unsubscribe the event from AMF by removing or update an AMF event subscription. + +When the AMF identified that event synchronization with UDM is required, but either the UDM or the AMF or both do not support the "ESSYNC" feature, the AMF may require the UDM to re-subscribe the stored event exposure subscriptions to the AMF, see clause 5.3.2.2.2 and 5.3.2.2.3 of 3GPP TS 29.503 [35]. + +## 5.4 Namf\_MT Service + +### 5.4.1 Service Description + +Namf\_MT service allows a NF to request information related to capabilities to send MT signalling or data to a target UE. The following are the key functionalities of this NF service: + +- enabling UE reachability by: + - paging the UE if the UE is in CM-IDLE state and responding to the requester NF after the UE enters CM-CONNECTED state, or + - responding to the requester NF if UE is in CM-CONNECTED state. +- providing the terminating domain selection information for IMS voice to the consumer NF. +- enabling reachability of a list of UEs by: + - paging UEs for an MBS session if the UEs are in CM-IDLE state, and + - responding to the requester NF, including the list of UEs that are already in CM-CONNECTED state if any, and + - sending notification with the UE reachability information and user location information to NF consumers. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +For the Namf\_MT Service the following service operations are defined: + +- EnableUEReachability +- ProvideDomainSelectionInfo +- EnableGroupReachability +- UEReachabilityInfoNotify + +## 5.4.2.2 EnableUEReachability + +### 5.4.2.2.1 General + +The EnableUEReachability service operation is used in the following procedure: + +- MT SMS over NAS in CM-IDLE state (see 3GPP TS 23.502 [3], clause 4.13.3.6), or in CM-CONNECTED state (see 3GPP TS 23.502 [3], clause 4.13.3.7). +- UPF anchored Mobile Terminated Data Transport in Control Plane CIoT 5GS Optimisation (see clause 4.24.2 of 3GPP TS 23.502 [3]). +- Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling (see clause 4.8.2.2b of 3GPP TS 23.502 [3]). + +The EnableUEReachability service operation shall be invoked by the NF Service Consumer (e.g. SMSF, SMF) to enable the reachability of the UE. + +The NF Service Consumer shall invoke the service by using the HTTP method PUT, towards the URI of a "ueReachInd" resource as specified in clause 6.3.3.2. See also figure 5.4.2.2.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF to enable UE reachability. The NF Service Consumer sends a PUT request to the AMF. The AMF responds with either a 200 OK (success) or a 4xx/5xx error (failure).](921458d4fc1b778c2450592ac9745b48_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. PUT « /{ueContextId}/ue-reachind(EnableUeReachabilityReqData) » + NF Service Consumer->>AMF: Request + Note right of AMF: 2a. 200 OK (EnableUeReachabilityRspData) + AMF-->>NF Service Consumer: Success Response + Note right of AMF: 2b. 4xx/5xx (ProblemDetails / ProblemDetailsEnableUeReachability) or 3xx + AMF-->>NF Service Consumer: Error Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF to enable UE reachability. The NF Service Consumer sends a PUT request to the AMF. The AMF responds with either a 200 OK (success) or a 4xx/5xx error (failure). + +**Figure 5.4.2.2.1-1: NF Service Consumer enables the reachability of the UE** + +1. The NF Service Consumer sends a PUT request to the resource representing the ueReachInd resource of the AMF. The content of the PUT request shall contain an "EnableUeReachabilityReqData" object. + +During the Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling (see clause 4.8.2.2b of 3GPP TS 23.502 [3]), the SMF may include the ppi, the arp, the qfi and the 5qi of the QoS flow of the PDU session for which DL packets are received, together with the PDU session identifier, to enable NG-RAN to take this information into account when paging the UE. + +The SMF shall send a new Namf\_MT\_EnableUEReachability request with a higher priority or a different Paging Policy Indicator to the AMF if the SMF receives any additional Data Notification from the UPF for data packets pertaining to another QoS Flow associated with a higher priority (i.e. ARP priority level) than the priority indicated to the AMF in the previous Namf\_MT\_EnableUEReachability request, or if the SMF derives a different Paging Policy Indicator according to the additional Data Notification, while waiting for the response from the AMF. + +- 2a. On success: + +- if the UE is in CM-CONNECTED state, the AMF shall immediately respond using "200 OK" status code, with content containing an "EnableUeReachabilityRspData" object. +- if the UE is in CM-IDLE state and the NAS message is to be sent over via 3GPP access and paging is not restricted as defined in 3GPP TS 23.501 [2] clause 5.38.5, the AMF shall page the UE. When UE becomes CM-CONNECTED and the UE has not rejected the page as specified in 3GPP TS 23.501 [2] clause 5.38.4, "200 OK" shall be returned with content containing an "EnableUeReachabilityRspData" object. +- if the UE is in Extended DRX for RRC-INACTIVE state and with CN based MT communication handling, and the AMF determines that the UE is reachable, then the AMF shall send a N2 RAN paging request message to NG-RAN with the request for the UE's RRC connection to be resumed as specified in clause 4.8.2.2b of 3GPP TS 23.502 [3]. When an N2 Notification is received by the AMF indicating that the UE is in RRC-CONNECTED state as specified in clause 4.8.2.2 of 3GPP TS 23.502 [3], "200 OK" shall be returned with the content containing an "EnableUeReachabilityRspData" object. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.3.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails or ProblemDetailsEnableUeReachability structure with the "cause" attribute set to one of the application error listed in Table 6.3.3.2.3.1-3. + +The AMF shall respond with the status code "403 Forbidden", if the UE is in a Non-Allowed Area and the service request is not for regulatory prioritized service. The AMF shall set the application error as "UE\_IN\_NON\_ALLOWED\_AREA" in POST response body. + +The AMF shall respond with the status code "409 Conflict", if Paging Restriction Information restrict the EnableUeReachability request from causing paging as defined in 3GPP TS 23.501 [2] clause 5.38.5 or if the UE rejects the paging as defined in 3GPP TS 23.501 [2] clause 5.38.4. The AMF shall set the application error as "REJECTION\_DUE\_TO\_PAGING\_RESTRICTION" in POST response body. + +The AMF shall respond with the status code "504 Gateway Timeout" and set the application error as "UE\_NOT\_REACHABLE" and include an Estimated Maximum Wait time in POST response body when the AMF determines the UE is unreachable (e.g. if the UE is in MICO mode or the UE has entered Extended DRX in CM-IDLE or Extended DRX for RRC-INACTIVE state) as specified in clauses 4.24.2 and 4.8.2.2b of 3GPP TS 23.502 [3]). If the UE is in Extended DRX for RRC-INACTIVE state and with CN based MT communication handling, when the AMF determines that the UE is reachable, the AMF shall send a N2 RAN paging request message to NG-RAN with the request for the UE's RRC connection to be resumed as specified in clause 4.8.2.2b of 3GPP TS 23.502 [3]) using the information received in the EnableUeReachabilityReqData (i.e. the ppi, the arp, the qfi and the 5qi of the QoS flow of the PDU session for which DL packets are received, together with the PDU session identifier). If the UE is in Extended DRX in CM-IDLE state, and the AMF determines that the UE is reachable, the AMF shall page the UE (i.e. using CN paging). + +## 5.4.2.3 ProvideDomainSelectionInfo + +### 5.4.2.3.1 General + +The ProvideDomainSelectionInfo service operation shall be invoked by the NF Service Consumer (e.g. UDM) to get the UE information for terminating domain selection of IMS voice, including following information: + +- Indication of supporting IMS voice over PS Session; +- Time stamp of the last radio contact with the UE; +- Current Access type and RAT type + +The NF Service Consumer shall invoke the service by using the HTTP GET towards the URI of the "UeContext" resource (See clause 6.3.3.3.3.1). See also figure 5.4.2.3.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF for providing UE information for terminating domain selection. The NF Service Consumer sends a GET request to the AMF. The AMF responds with either a 200 OK (UeContextInfo) or a 4xx/5xx (ProblemDetails) or 3xx response.](7355f66b8620d44cf566215621addb74_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: Request + NF Service Consumer->>AMF: 1. GET ...{ueContextId}?Info-class=TADS + Note right of AMF: Success + AMF-->>NF Service Consumer: 2a. 200 OK (UeContextInfo) + Note right of AMF: Failure + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF for providing UE information for terminating domain selection. The NF Service Consumer sends a GET request to the AMF. The AMF responds with either a 200 OK (UeContextInfo) or a 4xx/5xx (ProblemDetails) or 3xx response. + +**Figure 5.4.2.3.1-1: Provide UE Information for Terminating Domain Selection** + +1. The NF Service Consumer shall send a GET request to the URI of the "UeContext" resource on the AMF, with query parameter "info-class" set to value "TADS". +- 2a. On success, the AMF shall return "200 OK" status code with content containing an "UeContextInfo" data structure including UE information for terminating domain selection for IMS voice. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.3.3.3.3.1-3 shall be returned. The message body shall contain a ProblemDetails object with "detail" set to one of the corresponding application errors listed in Table 6.3.3.3.3.1-3. + +If the request cannot be completed due to a Registration procedure going-on for the target UE, the AMF shall reject the request with a 409 Conflict response and with the TEMPORARY\_REJECT\_REGISTRATION\_ONGOING application error. The NF Service Consumer should repeat the request after a suitable delay. + +If the request cannot be completed due to the target UE being in RM\_DEREGISTERED state, the AMF shall reject the request with a 403 Forbidden response and with the UE\_DEREGISTERED application error. + +## 5.4.2.4 EnableGroupReachability + +### 5.4.2.4.1 General + +The EnableGroupReachability service operation is used in the following procedure: + +- MBS session activation procedure (see 3GPP TS 23.247 [55], clause 7.2.5.2). + +The EnableGroupReachability service operation shall be invoked by the NF Service Consumer (e.g. SMF) to enable the reachability of the list of UEs involved in the MBS Session. + +The NF Service Consumer shall invoke the service by using the HTTP method POST (enable-group-reachability custom operation) as shown in figure 5.4.2.4.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK (EnableGroupReachabilityRspData) or a 4xx/5xx (ProblemDetails) or 3xx- response.](d7efe1d3c9fce95c7bacefb7e7d7faff_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: POST /ue-contexts/enable-group-reachability(EnableGroupReachabilityReqData) + NF Service Consumer->>AMF: 1. POST request + Note right of AMF: 2a. 200 OK (EnableGroupReachabilityRspData) + AMF-->>NF Service Consumer: 2a. 200 OK response + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx- + AMF-->>NF Service Consumer: 2b. Error response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK (EnableGroupReachabilityRspData) or a 4xx/5xx (ProblemDetails) or 3xx- response. + +**Figure 5.4.2.4.1-1: NF Service Consumer enabling the reachability of a list of UEs** + +1. The NF Service Consumer shall send a POST request to the resource representing the UeContexts resource of the AMF. The content of the POST request shall contain an "EnableGroupReachabilityReqData" object. + +2a. On success: + +If at least one UE in the list of UEs included in EnableGroupReachabilityReqData is in CM-CONNECTED state, the AMF shall respond using "200 OK" status code, with the content containing the list of UEs in CM-CONNECTED state in "EnableGroupReachabilityRspData" object; or + +If all the UEs in the list of UEs included in EnableGroupReachabilityReqData are in CM-IDLE state, the AMF shall respond with "200 OK" status code. + +The AMF shall page UEs in CM-IDLE state as specified in clause 7.2.5.2 of 3GPP TS 23.247 [55]. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.3.3.4.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.3.3.4.4.2.2-2. + +## 5.4.2.5 UEReachabilityInfoNotify + +### 5.4.2.5.1 General + +The UEReachabilityInfoNotify service operation is used in the following procedure: + +- MBS session activation procedure (see 3GPP TS 23.247 [55], clause 7.2.5.2). + +The UEReachabilityInfoNotify service operation shall be invoked by the AMF to send a notification towards the notification URI for the UE(s) which are reachable or do not respond to paging. + +The AMF shall use the HTTP method POST, using the notification URI received in the EnableGroupReachability request as specified in clause 5.4.2.4.1, to send a notification. See Figure 5.4.2.5.1-1. + +![Sequence diagram showing UE Reachability Info Notify. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content or an error status code (4xx/5xx or 3xx).](343e05a9fd8a8c8743428fa4ae6e2736_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NF Service Consumer + Note left of AMF: 1. POST {reachabilityNotifyUri}(ReachabilityNotificationData) + AMF->>NF Service Consumer: 1. POST {reachabilityNotifyUri}(ReachabilityNotificationData) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>AMF: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing UE Reachability Info Notify. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content or an error status code (4xx/5xx or 3xx). + +**Figure 5.4.2.5.1-1: UE Reachability Info Notify** + +1. The AMF shall send a POST request to send a notification. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned and appropriate additional error information should be returned. + +## 5.5 Namf\_Location Service + +### 5.5.1 Service Description + +The Namf\_Location service is used by NF service consumers to request the AMF for initiating positioning requests and provide the location information. It is also used to subsequently notify the location change events towards the NF service consumers. The following are the key functionalities of this NF service: + +- Allow NFs to request the current geodetic and optionally local and/or civic location of a target UE. +- Allow NFs to be notified of event information related to emergency sessions. +- Allow NFs to request Network Provided Location Information (NPLI) and/or local time zone corresponding to the location of a target UE. +- Allow NFs to request the ranging and sidelink positioning location results for a group of n UEs ( $n \geq 2$ ), the ranging and sidelink positioning location results may include absolute locations, relative locations or ranges and directions related to the UEs. +- Allow NFs to enable the location reporting over user plane. + +### 5.5.2 Service Operations + +#### 5.5.2.1 Introduction + +For the Namf\_Location Service the following service operations are defined: + +- ProvidePositioningInfo; +- EventNotify; and +- ProvideLocationInfo. +- CancelLocation + +## 5.5.2.2 ProvidePositioningInfo + +### 5.5.2.2.1 General + +The ProvidePositioningInfo service operation is used in the following procedure: + +- 5GC-MT-LR Procedure without UDM Query (see 3GPP TS 23.273 [42], clause 6.10.2) +- 5GC-MT-LR Procedure (see 3GPP TS 23.273 [42], clause 6.1) +- Initiation and Reporting of Location Events (see 3GPP TS 23.273 [42], clause 6.3.1) +- Location Continuity for Handover of an Emergency session from NG-RAN (see 3GPP TS 23.273 [42], clause 6.10.3) +- 5GC-MT-LR multiple location procedure without UDM Query (see 3GPP TS 23.273 [42], clause 6.10.4) +- Procedures of SL-MT-LR involving LMF (see 3GPP TS 23.273 [42], clause 6.20.3) +- Procedures of SL-MT-LR for periodic, triggered Location Events (see 3GPP TS 23.273 [42], clause 6.20.4) +- 5GC-MT-LR Procedure using SL positioning (see 3GPP TS 23.273 [42], clause 6.20.5) + +The ProvidePositioningInfo service operation shall be invoked by the NF Service Consumer (e.g. GMLC) to request the current or deferred geodetic and optionally local and/or civic location of the UE. The service operation triggers the AMF to invoke the service towards the LMF. + +The NF Service Consumer shall invoke the service operation by sending POST to the URI of the "provide-pos-info" custom operation on the "Individual UE Context" resource (See clause 6.4.3.2.4.2). See also figure 5.5.2.2.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK (ProvidePosInfoExt), a 204 No Content, or a 4xx/5xx (ProblemDetails) or 3xx response.](314da473d582c4327e1e3d56fcba19dd_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. POST « /{ueContextId}/provide-pos-info(RequestPosInfo) » + NF Service Consumer->>AMF: Request + Note right of AMF: 2a. 200 OK (ProvidePosInfoExt) +2b. 204 No Content + AMF-->>NF Service Consumer: Response + Note right of AMF: 2c. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: Error/Redirect + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK (ProvidePosInfoExt), a 204 No Content, or a 4xx/5xx (ProblemDetails) or 3xx response. + +**Figure 5.5.2.2.1-1: NF Service Consumer requests the positioning information of the UE** + +1. The NF Service Consumer shall send a POST request to the resource URI of "provide-pos-info" custom operation of the "Individual UE context" resource of the AMF. The content of the POST request may contain: + +- an indication of a positioning request from emergency services or commercial services client, +- the required location QoS, and additionally the mapped location QoS applicable to EPS if multiple location QoS is required, +- Supported GAD shapes, +- scheduled location time, +- reliable UE Location Request, +- UE unaware indication, +- the LMF ID that should be used for selecting the LMF, +- the reporting indication, +- the integrity requirements +- the requested ranging\_SL location results, including absolute locations, relative locations or ranges and directions related to the UEs for ranging and sidelink positioning, and/or +- the information of the related UEs, including application layer ID(s) and the related UE type for each related UE for ranging and sidelink positioning. + +If the NF service consumer wants the location change information or deferred location information to be notified (e.g. during a handover procedure or for activation or completion of deferred location), it also provides a callback URI on which the EventNotify service operation is executed (see clause 5.5.2.3). + +During 5GC-MT-LR multiple location procedure for regulatory location service, the request body may also include the indication of acceptance for intermediate response and the maximum response time, the GMLC callback address and the LIR reference number. + +- 2a. On success, "200 OK" shall be returned. The content may contain the LCS correlation identifier, the location estimate, its age and accuracy, the information about the positioning method. If the request is invoked during a handover the response body shall also include the target AMF node identifier as specified in clause 6.10.3 of 3GPP TS 23.273 [42]. + +If the location determination will be sent by LMF to GMLC directly, the content shall include the directReportInd and supportedFeatures attributes. + +- 2b. On accept, "204 No Content" shall be returned to acknowledge that AMF supports a deferred location request and a deferred location is accepted as specified in step 6 of clause 6.3.1 of 3GPP TS 23.273 [42]; +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.4.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.4.3.2.4.2.2-2. + +If the AMF received the LMF ID from the NF service consumer and the AMF does not find an LMF with the LMF ID received from GMLC, the AMF should return a 403 Forbidden response with the cause attribute set to "REQUESTED\_LMF\_NOT\_AVAILABLE" to the NF service consumer, if no other LMF is configured as backup selection. Otherwise, the ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.4.3.2.4.2.2-2 shall be applied. + +### 5.5.2.3 EventNotify + +#### 5.5.2.3.1 General + +The EventNotify service operation is used in the following procedure: + +- 5GC-NI-LR Procedure (see 3GPP TS 23.273 [42], clause 6.10.1) +- Location Continuity for Handover of an Emergency session from NG-RAN (see 3GPP TS 23.273 [42], clause 6.10.3) +- Completion of a deferred location for the UE available event or activation of deferred location for periodic location, area event triggered location or motion event triggered location (see 3GPP TS 23.273 [42], clause 6.3.1) + +The EventNotify service operation notifies the NF Service Consumer (i.e. GMLC) about a UE location related event information related to emergency sessions or deferred location, i.e. the initiation, handover or termination of an emergency session or the completion or activation of deferred location. The notification is delivered to: + +- the callback URI received from the GMLC during an earlier ProvidePositioningInfo service operation, if any; + +Otherwise (if not available), + +- the callback URI registered in the NRF, if the GMLC registered to the NRF with notification endpoints for location notifications (see clauses 6.1.6.2.4 and 6.1.6.3.4 of 3GPP TS 29.510 [29]); + +Otherwise (if not available), + +- GMLC URI locally provisioned in the AMF. + +NOTE: During a handover procedure, both the source AMF and the target AMF can invoke the EventNotify service operation, based on the local configuration. + +The operation is invoked by issuing a POST request to the callback URI of the NF Service Consumer (See clause 6.4.5.2.2). See also figure 5.5.2.3.1-1. + +![Sequence diagram for UE Location Notification. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](5e9af8986a5845504f251d3079da8078_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NF Service Consumer + Note left of AMF: 1. POST {locationNotificationUri}(NotifiedPosInfoExt) + AMF->>NF Service Consumer: 1. POST {locationNotificationUri}(NotifiedPosInfoExt) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>AMF: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) Or 3xx + NF Service Consumer-->>AMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram for UE Location Notification. The AMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +**Figure 5.5.2.3.1-1: UE Location Notification** + +1. The AMF shall send a POST request to the callback URI provided by the NF service consumer determined as described above. The request body shall include the type of location related event and UE Identification (SUPI or PEI), and may include the GPSI, Geodetic Location, Local Location, Civic Location, MSC server identity, the Position methods used or a serving LMF identification for activation of periodic or triggered location. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned and appropriate additional error information should be returned. + +## 5.5.2.4 ProvideLocationInfo + +### 5.5.2.4.1 General + +The ProvideLocationInfo service operation allows an NF Service Consumer (e.g. UDM) to request the Network Provided Location Information (NPLI) of a target UE. + +The NF Service Consumer shall invoke the service operation by sending POST request to the URI of the "provide-loc-info" custom operation on the "Individual UE Context" resource (see clause 6.4.3.2.4.3), as shown in figure 5.5.2.4.1-1. + +![Sequence diagram for NF Service Consumer requests the Location Information of the UE. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK (ProvideLocInfo) (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](f14f0843f9944e61124817d06809d7ad_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. POST .../{ueContextId}/provide-loc-info(RequestLocInfo) + NF Service Consumer->>AMF: 1. POST .../{ueContextId}/provide-loc-info(RequestLocInfo) + Note right of AMF: 2a. 200 OK (ProvideLocInfo) + AMF-->>NF Service Consumer: 2a. 200 OK (ProvideLocInfo) + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for NF Service Consumer requests the Location Information of the UE. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK (ProvideLocInfo) (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +**Figure 5.5.2.4.1-1: NF Service Consumer requests the Location Information of the UE** + +1. The NF Service Consumer shall send a POST request to the resource URI of "provide-loc-info" custom operation of the "Individual UE context" resource on the AMF. The content of the POST request shall contain a "requestLocInfo" data structure indicating the desired type of location information. + +If the NF Service Consumer desires the current location information of the target UE, it shall set "reqCurrentLoc" attribute to "true". + +- 2a. On success, "200 OK" response shall be returned. The content of the response shall contain a "ProvideLocInfo" data structure including the Network Provide Location Information (NPLI) of the target UE. + +If "reqCurrentLoc" attribute is set to "true" and the UE is in RM-REGISTERED and CM-IDLE state over 3GPP access, the AMF shall initiate a paging procedure to the UE. If the paging procedure is successful, the AMF shall return the current location information and set "currentLoc" attribute to "true" in the response; if the UE does not respond to the paging, the AMF shall provide the last known location and set "currentLoc" attribute to "false" in the response. + +If "reqCurrentLoc" attribute is set to "true" and the UE is in RM-REGISTERED and CM-CONNECTED state over 3GPP access, the AMF shall follow NG-RAN Location reporting procedure, as specified in clause 4.10 of 3GPP TS 23.502 [3], to trigger a single standalone report by setting "direct" event type in Location Reporting + +Control message. If NG-RAN reports current location of the UE, the AMF shall set "currentLoc" attribute to "true" in the response; if NG-RAN reports last known location of the UE with timestamp, the AMF shall set "currentLoc" attribute to "false" in the response. + +If the UE is in RM-REGISTERED over non-3GPP access, the AMF shall include the latest non-3GPP access location information. + +- 2b. On failure or redirection, one of the HTTP status code listed in table 6.4.3.2.4.3.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in table 6.4.3.2.4.3.2-2. + +## 5.5.2.5 CancelLocation + +### 5.5.2.5.1 General + +This service operation is used in the following procedure: + +- Cancellation of Reporting of Location Events by an AF or External LCS Client (see 3GPP TS 23.273 [42], clause 6.3.3) + +The CancelLocation service operation shall be invoked by the NF Service Consumer (e.g. GMLC) to cancel reporting periodic or events triggered location. + +The NF Service Consumer shall invoke the service operation by sending a POST request to the URI of the "cancel-pos-info" custom operation on the "Individual UE Context" resource (See clause 6.4.3.2.4.4). See also figure 5.5.2.5.1-1. + +![Sequence diagram showing the cancellation of reporting periodic or events triggered location of the UE. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection).](4f2887d5043c0923cf5b37ca0d80c60b_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: POST .../{ueContextId}/cancel-pos-info(CancelLocInfo) + NF Service Consumer->>AMF: 1. POST .../{ueContextId}/cancel-pos-info(CancelLocInfo) + Note right of AMF: 2a. 204 No Content + AMF-->>NF Service Consumer: 2a. 204 No Content + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the cancellation of reporting periodic or events triggered location of the UE. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection). + +**Figure 5.5.2.5.1-1: Cancellation of reporting periodic or events triggered location of the UE** + +1. The NF Service Consumer shall send a POST request to the resource URI of "cancel-pos-info" custom operation of the "Individual UE context" resource of the AMF. The content of the POST request shall contain a "CancelLocInfo" data structure indicating the desired cancellation of reporting periodic or events triggered location of the UE. +- 2a. On success, AMF responds with "204 No Content". +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.4.3.2.4.4-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors. + +## 5.6 Namf\_MBSBroadcast Service + +### 5.6.1 Service Description + +This service enables the NF Service Consumer (e.g. MB-SMF) to create, update or release a broadcast MBS session context in the AMF and to be notified about status change of the MBS broadcast context. + +### 5.6.2 Service Operations + +#### 5.6.2.1 Introduction + +The Namf\_MBSBroadcast service supports following service operations: + +- ContextCreate +- ContextUpdate +- ContextRelease +- ContextStatusNotify + +### 5.6.2.2 ContextCreate + +The ContextCreate service operation shall be used by the NF Service Consumer (e.g. MB-SMF) to request the AMF to create a broadcast MBS session context. + +NOTE: For a location dependent MBS service, one single ContextCreate service operation is performed per MBS session (for a given AMF). + +It is used in the following procedures: + +- MBS Session Start for Broadcast (see clause 7.3.1 of 3GPP TS 23.247 [55]); +- MBS Session Update for Broadcast (see clause 7.3.3 of 3GPP TS 23.247 [55]); +- Support for Local Broadcast Service (see clause 7.3.4 of 3GPP TS 23.247 [55]). + +There shall be only one broadcast MBS session context per MBS session, or per MBS session and Area Session ID for an MBS session with Location dependent Broadcast service. + +The NF Service Consumer (e.g. MB-SMF) shall create a broadcast MBS session context by using the HTTP POST method as shown in Figure 5.6.2.2-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF for Broadcast MBS session context creation. The NF Service Consumer sends a POST request to /mbs-contexts. The AMF responds with either a 201 Created response or a 4xx/5xx error response.](1ae16a393229b439c7b3f8b2e63d8d6c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: POST /mbs-contexts (ContextCreateReqData) + NF Service Consumer->>AMF: 1. POST « /mbs-contexts (ContextCreateReqData) » + Note right of AMF: 2a. 201 Created (ContextCreateRspData) + AMF-->>NF Service Consumer: 2a. 201 Created (ContextCreateRspData) + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF for Broadcast MBS session context creation. The NF Service Consumer sends a POST request to /mbs-contexts. The AMF responds with either a 201 Created response or a 4xx/5xx error response. + +**Figure 5.6.2.2-1: Broadcast MBS session context creation** + +- The NF Service Consumer shall send a POST request targeting the Broadcast MBS session contexts collection resource of the AMF. The content of the POST request shall contain the following information: + - MBS Session ID (i.e. TMGI, or TMGI and NID for an MBS session in an SNP); + - list of Area Session ID and related MBS service area, for a Location dependent broadcast MBS service; + - MBS service area, for a Local broadcast MBS session; + - N2 MBS Session Management container (see MBS Session Setup or Modification Request Transfer IE in 3GPP TS 38.413 [12]); + - Notification URI where to be notified about the status change of the broadcast MBS session context; and + - SNSSAI. + +The NF Service Consumer may also include the maxResponseTime IE in the request to indicate the maximum response time to receive information about the completion of the Broadcast MBS session establishment. + +The NF Service Consumer may also include the MB-SMF instance ID and MB-SMF service instance ID to enable the AMF subscribing to the MB-SMF status notifications. + +The NF Service Consumer may also include the MBS associated session ID to enable NG-RAN to identify the multiple MBS sessions delivering the same content when AF creates multiple broadcast MBS Sessions via different Core Networks to deliver the same content. + +- 2a. On success, "201 Created" shall be returned. The AMF should respond success when it receives the first successful response from the NG-RAN(s). The 201 Created response shall contain MBS session identifier and may contain one or more N2 MBS Session Management containers, if additional information (e.g. MBS Session Setup or Modification Response Transfer IE or MBS Session Setup or Modification Failure Transfer IE in 3GPP TS 38.413 [12]) needs to be transferred to the MB-SMF. If the AMF received the NG-RAN responses from all involved NG-RAN(s), e.g. if the broadcast MBS session involves only one NG-RAN, the AMF shall include an indication of completion of the operation in all NG-RANs in the 201 Created response. + +Upon receipt of subsequent responses from other NG-RANs after sending the 201 Created response, if additional information (e.g. MBS Session Setup or Modification Response Transfer IE or MBS Session Setup or Modification Failure Transfer IE in 3GPP TS 38.413 [12]) needs to be transferred to the MB-SMF, the AMF shall transfer such information by sending one or more Namf\_MBSBroadcast\_ContextStatusNotify requests to the MB-SMF. A Namf\_MBSBroadcast\_ContextStatusNotify request may include a list of N2 MBS Session Management containers received from different NG-RANs. When the AMF receives the response from all NG-RANs, the AMF shall include an indication of the completion of the operation in the Namf\_MBSBroadcast\_ContextStatusNotify request. + +If the AMF does not receive responses from all NG-RAN nodes before the maximum response time elapses since the reception of the Namf\_MBSBroadcast\_ContextCreate Request, then the AMF should send one Namf\_MBSBroadcast\_ContextStatusNotify request indicating the incompletion of the Broadcast MBS session establishment. + +For each N2 MBS Session Management container sent towards the MB-SMF, the AMF shall insert the identifier of the NG-RAN node that generated it in the corresponding entry of the n2MbsSmInfoList attribute. + +The AMF may send one or more Namf\_MBSBroadcast\_ContextStatusNotify request including an operationEvents attribute to report the MB-SMF about failure to reach one or more NG-RANs. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.5.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.5.3.2.3.1-3. + +### 5.6.2.3 ContextUpdate + +The ContextUpdate service operation shall be used by the NF Service Consumer (e.g. MB-SMF) to request the AMF to update a broadcast MBS session context. + +It is used in the following procedures: + +- MBS Session Update for Broadcast (see clause 7.3.3 of 3GPP TS 23.247 [55]). +- Broadcast MBS session restoration by MB-SMF (see clause 8.3.2.3 of 3GPP TS 23.527 [33]). +- Selecting an alternative AMF for a Broadcast MBS Session at AMF failure (see clause 8.3.2.4 of 3GPP TS 23.527 [33]). + +The NF Service Consumer (e.g. MB-SMF) shall update a broadcast MBS session context by using the HTTP POST method as shown in Figure 5.6.2.3-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an AMF for a Broadcast MBS session context update. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK or 204 No Content, or a 4xx/5xx error with ProblemDetails or 3xx.](b97737027bd1b2effd7ca4dba8914877_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: POST /mbs-contexts/{mbsContextRef}/update + NF Service Consumer->>AMF: 1. POST « /mbs-contexts/{mbsContextRef}/update (ContextUpdateReqData) » + Note right of AMF: 2a. 200 OK (ContextUpdateRspData) / 2b. 204 No Content + AMF-->>NF Service Consumer: 2a. 200 OK (ContextUpdateRspData) / 2b. 204 No Content + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AMF for a Broadcast MBS session context update. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK or 204 No Content, or a 4xx/5xx error with ProblemDetails or 3xx. + +Figure 5.6.2.3-1: Broadcast MBS session context update + +1. The NF Service Consumer shall send a POST request targeting the individual Broadcast MBS session context resource to be updated in the AMF. The content of the POST request may contain the following information: + +- N2 MBS Session Management container (see MBS Session Setup or Modification Request Transfer IE in 3GPP TS 38.413 [12]); +- Notification URI, if the NF Service Consumer wishes to modify the notification URI where to be notified about the status change of the broadcast MBS session context; +- updated MBS service area, for a Local broadcast MBS session; +- updated list of Area Session ID and related MBS service area, for a Location dependent broadcast MBS session. +- the n2MbsInfoChangeInd IE set to "true" or "false" to indicate to the AMF whether the information within the N2 MBS Session Management container has changed or not for the MBS session + +The NF Service Consumer may also include the maxResponseTime IE in the request to indicate the maximum response time to receive information about the completion of the Broadcast MBS session update. + +During a broadcast MBS session restoration procedure for an NG-RAN failure with restart, the MB-SMF may include one or more ranIds attributes to request the AMF to setup the Broadcast MBS session in a list of NG-RANs as identified by the NG-RAN ID(s), as specified in clause 8.3.2.3 of 3GPP TS 23.527 [33]. + +During a restoration procedure upon an AMF failure without restart, for an AMF deployed in an AMF set, the MB-SMF may set the noNgapSignallingInd IE to "true" when the MB-SMF detects the original AMF has failed and then selects an alternative AMF to take over the MBS session but without a need to trigger any NGAP signalling towards NG-RANs, as specified in clause 8.3.2.4 of 3GPP TS 23.527 [33]. + +- 2a. On success, "200 OK" shall be returned if additional information needs to be returned in the response. The 200 OK response may contain one or more N2 MBS Session Management containers, if such information (e.g. MBS Session Setup or Modification Response Transfer IE, MBS Session Setup or Modification Failure Transfer IE or MBS Session Release Response Transfer IE in 3GPP TS 38.413 [12]) needs to be transferred to the MB-SMF. If the AMF received the NG-RAN responses from all involved NG-RAN(s), the AMF shall include an indication of completion of the operation in all NG-RANs. +- 2b. On success, "204 No Content" shall be returned if no additional information needs to be returned in the response. + +In both 2a and 2b cases, upon receipt of subsequent responses from other NG-RANs after sending the 200 OK response or the 204 No Content response, if additional information (e.g. MBS Session Setup or Modification Response Transfer IE, MBS Session Setup or Modification Failure Transfer IE or MBS Session Release Response Transfer IE in 3GPP TS 38.413 [12]) needs to be transferred to the MB-SMF, the AMF shall transfer such information by sending one or more Namf\_MBSBroadcast\_ContextStatusNotify requests to the MB-SMF. A Namf\_MBSBroadcast\_ContextStatusNotify request may include a list of N2 MBS Session Management containers received from different NG-RANs. When the AMF receives the response from all NG-RANs, the AMF shall include an indication of the completion of the operation in the Namf\_MBSBroadcast\_ContextStatusNotify request. + +If the AMF does not receive responses from all NG-RAN nodes before the maximum response time elapses since the reception of the Namf\_MBSBroadcast\_ContextUpdate Request, then the AMF should send one Namf\_MBSBroadcast\_ContextStatusNotify request indicating the incompletion of the Broadcast MBS session update. + +If the n2MbsInfoChangeInd IE is present in the request and set to "false", the AMF does not need to contact NG-RAN nodes unaffected by the MBS service area change. + +For each N2 MBS Session Management container sent towards the MB-SMF, the AMF shall insert the identifier of the NG-RAN node that generated it in the corresponding entry of the n2MbsSmInfoList attribute. + +The AMF may send one or more Namf\_MBSBroadcast\_ContextStatusNotify request including an operationEvents attribute to report the MB-SMF about failure to reach one or more NG-RANs. + +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.5.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.5.3.2.4.2.2-2. + +## 5.6.2.4 ContextRelease + +The ContextRelease service operation shall be used by the NF Service Consumer (e.g. MB-SMF) to request the AMF to release a broadcast MBS session context. + +It is used in the following procedures: + +- MBS Session Release for Broadcast (see clause 7.3.2 of 3GPP TS 23.247 [55]). + +The NF Service Consumer (e.g. MB-SMF) shall release a broadcast MBS session context by using the HTTP DELETE method as shown in Figure 5.6.2.4-1. + +![Sequence diagram showing the Broadcast MBS session context release. The NF Service Consumer sends a DELETE request to the AMF. The AMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response.](350dece6293a0ac3d4c9e4bf41eefa5d_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: 1. DELETE « /mbs-contexts/{mbsContextRef} » + NF Service Consumer->>AMF: 1. DELETE « /mbs-contexts/{mbsContextRef} » + Note right of AMF: 2a. 204 No Content + AMF-->>NF Service Consumer: 2a. 204 No Content + Note right of AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +Sequence diagram showing the Broadcast MBS session context release. The NF Service Consumer sends a DELETE request to the AMF. The AMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response. + +**Figure 5.6.2.4-1: Broadcast MBS session context release** + +1. The NF Service Consumer shall send a DELETE request targeting the individual Broadcast MBS session context resource to be released in the AMF. +- 2a. On success, "204 No Content" shall be returned. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.5.3.3.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.5.3.3.3.1-3. + +The AMF may send one or more Namf\_MBSBroadcast\_ContextStatusNotify request including an operationEvents attribute to report the MB-SMF about failure to reach one or more NG-RANs. + +## 5.6.2.5 ContextStatusNotify + +The ContextStatusNotify service operation shall be used by the AMF to notify status change of a broadcast MBS session context to the NF Service Consumer (e.g. MB-SMF). + +It is used in the following procedures: + +- MBS Session Start for Broadcast (see clause 7.3.1 of 3GPP TS 23.247 [55]); +- MBS Session Update for Broadcast (see clause 7.3.3 of 3GPP TS 23.247 [55]); +- Broadcast MBS Session Release Require (see clause 7.3.6 of 3GPP TS 23.247 [55]). +- Broadcast MBS session restoration by MB-SMF (see clause 8.3.2.3 of 3GPP TS 23.527 [33]). +- Selecting an alternative AMF for a Broadcast MBS Session at AMF failure (see clause 8.3.2.4 of 3GPP TS 23.527 [33]). +- Transport change for resource sharing across broadcast MBS Sessions in network sharing (see clause 7.3.7 of 3GPP TS 23.247 [55]). + +The AMF shall notify status change of a broadcast MBS session context to the NF Service Consumer (e.g. MB-SMF) by using the HTTP POST method as shown in Figure 5.6.2.5-1. + +![Sequence diagram showing the Broadcast MBS session context status change notification. The NF Service Consumer sends a POST {notifyURI} (ContextStatusNotification) to the AMF. The AMF responds with one of the following: 2a. 204 No Content, 2a. 200 OK (ContextStatusNotificationResponse), or 2b. 4xx/5xx (ProblemDetails) or 3xx.](ffb6acd27b8e3a54392840948a75869f_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: POST {notifyURI} (ContextStatusNotification) + NF Service Consumer->>AMF: 1. POST {notifyURI} (ContextStatusNotification) + AMF-->>NF Service Consumer: 2a. 204 No Content + AMF-->>NF Service Consumer: 2a. 200 OK (ContextStatusNotificationResponse) + AMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the Broadcast MBS session context status change notification. The NF Service Consumer sends a POST {notifyURI} (ContextStatusNotification) to the AMF. The AMF responds with one of the following: 2a. 204 No Content, 2a. 200 OK (ContextStatusNotificationResponse), or 2b. 4xx/5xx (ProblemDetails) or 3xx. + +**Figure 5.6.2.5-1: Broadcast MBS session context status change notification** + +- The AMF shall send a POST request targeting the notification URI received from the NF Service Consumer. The content of the POST request shall contain the following information: + - MBS Session ID (i.e. TMGI, or TMGI and NID for an MBS session in an SNPN); + - Area Session ID, if this is a Location dependent broadcast MBS service; + - one or more N2 MBS Session Management containers, if N2 MBS Session Management information (e.g. MBS Session Setup or Modification Response Transfer IE, MBS Session Setup or Modification Failure Transfer IE or MBS Session Release Response Transfer IE or Broadcast Session Transport Request Transfer IE in 3GPP TS 38.413 [12]) has been received from one or more NG-RANs that needs to be transferred to the NF Service Consumer; for each N2 MBS Session Management container sent towards the MB-SMF, the AMF shall insert the identifier of the NG-RAN node that generated it in the corresponding entry of the n2MbsSmInfoList attribute. + - the operationStatus IE indicating the completion of the Broadcast MBS session establishment or update, if the NF Service Consumer has requested to establish or update the Broadcast MBS session context and a response has been received from all NG-RANs; and + - the operationStatus IE indicating the incompletion of the Broadcast MBS session establishment or update, if the NF Service Consumer has requested to establish or update the Broadcast MBS session context including a maximum response time and the AMF has not received responses from all NG-RANs before the maximum response time elapses. + +During a Broadcast MBS Session Release Require procedure (see clause 7.3.6 of 3GPP TS 23.247 [55]), one or more NG-RANs may request the AMF to release the Broadcast MBS session. In this case, based on operator's policy, the AMF may: + +- report the Broadcast MBS Session release to the MB-SMF by including the operationEvent attribute in the MBS Context Status Notification request with the opEventType set to "NG\_RAN\_EVENT" together with a list of "ngranFailureEvent" for each NG-RAN that requested to release the Broadcast MBS Session. Upon receiving such a notification, per local policies, the MB-SMF may attempt to re-establish the MBS session after some operator configurable time in these NG-RANs by performing the Broadcast MBS session restoration by MB-SMF procedure specified in clause 8.3.2.3 of 3GPP TS 23.527 [33]; or +- attempt to re-establish the MBS session after some operator configurable time in these NG-RANs by performing the Broadcast MBS session restoration by AMF procedure specified in clause 8.3.2.2 of 3GPP TS 23.527 [33]. + +If all the NG-RANs serving the Broadcast MBS session requested the AMF to release the Broadcast MBS session, the AMF shall release the Broadcast MBS session context and send a notification with the releaseInd attribute set to true to report to the MB-SMF that the Broadcast MBS session (context) is released at the AMF and NG-RANs. + +The AMF may include an operationEvents attribute in the MBS Context Status Notification request to report the MB-SMF: + +- a NG-RAN failure event, e.g. the NG-RAN failure with or without restart, as specified in clause 8.3.2.3 of 3GPP TS 23.527 [33]; +- that a new AMF has taken over the control of the broadcast MBS session upon an AMF failure as specified in clause 8.3.2.4 of 3GPP TS 23.527 [33]. + +- 2a. On success, if the ContextStatusNotification does not contain a N2 MBS Session Management container with a Broadcast Session Transport Request Transfer IE, the NF Service Consumer shall return a "204 No Content" response. + +If the ContextStatusNotification contains one or more N2 MBS Session Management containers encapsulating a Broadcast Session Transport Request Transfer IE, the MB-SMF shall return a "200 OK" with the ContextStatusNotificationResponse containing one or more N2 MBS Session Management containers encapsulating a Broadcast Session Transport Response Transfer IE or a Broadcast Session Transport Failure Transfer IE. For each N2 MBS Session Management container sent towards the AMF, the MB-SMF shall insert the identifier of the NG-RAN node to which the information in the container relates in the corresponding entry of the n2MbsSmInfoList attribute. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.5.5.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails attribute with the "cause" attribute set to one of the application errors listed in Table 6.5.5.2.3.1-3. + +## 5.7 Namf\_MBSSCommunication Service + +### 5.7.1 Service Description + +This service enables an NF Service Consumer (e.g. MB-SMF) to request the AMF to transfer MBS multicast related N2 message towards NG-RAN(s) serving a multicast MBS session, during a multicast MBS session activation, deactivation or update. + +### 5.7.2 Service Operations + +#### 5.7.2.1 Introduction + +The Namf\_MBSSCommunication service supports the following service operations: + +- N2MessageTransfer +- Notify + +#### 5.7.2.2 N2MessageTransfer + +The N2MessageTransfer service operation shall be used by the NF Service Consumer (e.g. MB-SMF) to request the AMF to transfer an MBS related N2 message to the NG-RAN nodes serving the multicast MBS session. It is used during the following procedures: + +- MBS session activation procedure (see clause 7.2.5.2 of 3GPP TS 23.247 [55]); +- MBS session deactivation procedure (see clause 7.2.5.3 of 3GPP TS 23.247 [55]); and +- Multicast session update procedure (see clause 7.2.6 of 3GPP TS 23.247 [55]). + +The NF Service Consumer shall invoke the service operation by sending a POST request to the URI of the "transfer" custom operation (see clause 6.6.3.1) of the AMF. See Figure 5.7.2.2-1. + +![Sequence diagram showing the N2 Message Transfer for a multicast MBS session between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK or a 4xx/5xx/3xx response.](681dffd423541f7ba0c17aedcbef4959_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AMF + Note left of NF Service Consumer: POST .../n2-messages/transfer (MbsN2MessageTransferReqData) + NF Service Consumer->>AMF: 1.POST .../n2-messages/transfer (MbsN2MessageTransferReqData) + Note right of AMF: 2a. 200 OK (MbsN2MessageTransferRspData) or 2b. 4xx/5xx(ProblemDetails) or 3xx + AMF-->>NF Service Consumer: 2a. 200 OK (MbsN2MessageTransferRspData) + AMF-->>NF Service Consumer: 2b. 4xx/5xx(ProblemDetails) or 3xx + +``` + +Sequence diagram showing the N2 Message Transfer for a multicast MBS session between an NF Service Consumer and an AMF. The NF Service Consumer sends a POST request to the AMF. The AMF responds with either a 200 OK or a 4xx/5xx/3xx response. + +Figure 5.7.2.2-1 N2 Message Transfer for a multicast MBS session + +1. The NF Service Consumer shall invoke the custom operation for N2 message transfer by sending a HTTP POST request and the request body shall carry the MbsN2MessageTransferReqData data structure which contains the N2 MBS Session Management information to be transferred. The MbsN2MessageTransferReqData shall contain: + +- MBS Session ID (i.e. TMGI, or TMGI and NID for an MBS session in an SNPN); + +and may also contain: + +- the Area Session ID, if this is a location dependent multicast MBS session; and/or +- a notification URI where to be notified about any failure of the MBS related N2 procedure for an NG RAN node in this list; and +- an optional notification correlation ID to be sent within notifications. + +If the AMF supports the RAN-ID-LIST feature, the AMF shall distribute the MBS related N2 message to the list of NG-RAN nodes indicated by the MB-SMF, if any, otherwise to the list of NG-RAN nodes having established shared delivery that the AMF stores locally, if any. + +NOTE: An AMF which does not support the the RAN-ID-LIST feature distributes the MBS related N2 message to the list of NG-RAN nodes having established shared delivery that the AMF stores locally. + +- 2a. On success, the AMF shall respond with a "200 OK" status code with MbsN2MessageTransferRspData data structure. The AMF should respond success when it receives the first successful response from the NG-RAN(s). + +If the AMF supports the RAN-ID-LIST feature (see clause 6.6.8), and if the request included a list of NG RAN node IDs and a notification URI where to be notified about failures, the AMF shall report failure(s) of the N2 MBS related N2 procedure with an NG RAN node in this list by including the failureList IE in the "200 OK" response or in a subsequent Notify request towards the notification URI received in the request. See clause 8.4.1.2 of 3GPP TS 23.527 [33]. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.6.3.1.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails attribute with the "cause" attribute set to one of the application errors listed in Table 6.6.4.2.2-2 if any. + +### 5.7.2.3 Notify + +The Notify service operation shall be used by the AMF to notify the NF Service Consumer about a failure of an MBS related N2 procedure with an NG RAN node (see clause 5.7.2.2). + +It is used in the following procedure: + +- N2 MBS session request distribution with list of NG RAN Node IDs provided by MB-SMF to AMF (see clause 8.4.1.2 of 3GPP TS 23.527 [33]). + +The AMF shall notify a failure of an MBS related N2 procedure with an NG RAN node to the NF Service Consumer (e.g. MB-SMF) by using the HTTP POST method as shown in Figure 5.7.2.3-1. + +![Sequence diagram showing the notification process between NF Service Consumer and AMF. The AMF sends a POST {notifyURI} (Notification) to the NF Service Consumer. The NF Service Consumer responds with 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx.](6835f8f6a39e5504463c9a73f0c58674_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant NFSC as NF Service Consumer + Note right of AMF: 1. POST {notifyURI} (Notification) + AMF->>NFSC: 1. POST {notifyURI} (Notification) + Note left of NFSC: 2a. 204 No Content + NFSC-->>AMF: 2a. 204 No Content + Note left of NFSC: 2b. 4xx/5xx (ProblemDetails) or 3xx + NFSC-->>AMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the notification process between NF Service Consumer and AMF. The AMF sends a POST {notifyURI} (Notification) to the NF Service Consumer. The NF Service Consumer responds with 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx. + +Figure 5.7.2.3-1: Notification + +1. The AMF shall send a POST request targeting the notification URI received from the NF Service Consumer. The content of the POST request shall contain the following information: + +- MBS Session ID (i.e. TMGI, or TMGI and NID for an MBS session in an SNPN); +- the Area Session ID, if this is a location dependent multicast MBS session; and +- one or more failures including, for each failure, the related NG-RAN Node ID and failure cause. +- a notification correlation ID if it is received in the N2MessageTransfer request. + +2a. On success, the NF Service Consumer shall return a "204 No Content" response. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.6.5.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails attribute with the "cause" attribute set to one of the application errors listed in Table 6.6.5.2.3.1-3. + +--- + +## 6 API Definitions + +### 6.1 Namf\_Communication Service API + +#### 6.1.1 API URI + +The Namf\_Communication shall use the Namf\_Communication API. + +The API URI of the Namf\_Communication API shall be: + +**{apiRoot}//** + +The request URI 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}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "namf-comm". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +#### 6.1.2 Usage of HTTP + +##### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [19], 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]. + +HTTP messages and bodies for the Namf\_Communication service shall comply with the OpenAPI [23] specification contained in Annex A. + +##### 6.1.2.2 HTTP standard headers + +###### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +###### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. + +- The Problem Details JSON Object (IETF RFC 9457 [36]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one or more binary body parts with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported. + +**Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| vnd.3gpp.ngap | Binary encoded content, encoding NG Application Protocol (NGAP) IEs, as specified in clause 9.4 of 3GPP TS 38.413 [12] (ASN.1 encoded). | +| vnd.3gpp.5gnas | Binary encoded content, encoding a 5GS NAS message, as specified in 3GPP TS 24.501 [11]. | +| NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque content (e.g. NGAP or 5GS NAS information) without having to rely on metadata in the JSON content. | | + +See clause 6.1.2.4 for the binary contents supported in the binary body part of multipart messages. + +## 6.1.2.3 HTTP custom headers + +### 6.1.2.3.1 General + +In this release of this specification, no custom headers specific to the Namf\_Communication service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.1.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported, to transfer opaque N1 Information (e.g. SM, LPP) and/or N2 Information (e.g. SM, NRPPa, PWS), in the following service operations (and HTTP messages): + +- N1N2MessageTransfer Request and Response (POST); +- NonUeN2MessageTransfer Request and Response (POST); +- N1MessageNotify (POST); +- N2InfoNotify (POST); +- NonUeN2InfoNotify (POST); +- UEContextTransfer (POST); +- CreateUEContext (PUT) + +HTTP multipart messages shall include one JSON body part and one or more binary body parts comprising: + +- N1payload, and/or N2 payload (see clause 6.1.6.4). + +The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [9]) specifying the media type of the root body part, i.e. "application/json". + +NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [9]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message. + +For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [10]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part. + +## 6.1.3 Resources + +### 6.1.3.1 Overview + +![Figure 6.1.3.1-1: Resource URI structure of the Namf_Communication API. The diagram shows a hierarchical tree of resource paths starting from the root //apiRoot/namf-comm/apiVersion. It branches into /ue-contexts, /subscriptions, and /non-ue-n2-messages. /ue-contexts leads to {ueContextId}, which further branches into /assign-ebi, /transfer, /release, /transfer-update, /relocate, /cancel-relocate, and /n1-n2-messages. /n1-n2-messages leads to {n1N2MessageId}, /subscriptions, and {ueContextId}. /subscriptions under /ue-contexts leads to {subscriptionsId}, which further branches into /transfer, /subscriptions, and {n2NotifySubscriptionId}. /non-ue-n2-messages leads to /transfer, /subscriptions, and {ueContextId}. /transfer under /non-ue-n2-messages leads to {ueContextId}. /subscriptions under /non-ue-n2-messages leads to {n2NotifySubscriptionId}. /ue-contexts under /non-ue-n2-messages leads to {ueContextId}.](78de09c382ab51b5c3e87979204228c8_img.jpg) + +``` + +graph TD + Root["//apiRoot/namf-comm/apiVersion"] --> UEContexts["/ue-contexts"] + Root --> Subscriptions1["/subscriptions"] + Root --> NonUeN2Messages["/non-ue-n2-messages"] + + UEContexts --> UEContextId["{ueContextId}"] + UEContextId --> AssignEbi["/assign-ebi"] + UEContextId --> Transfer1["/transfer"] + UEContextId --> Release["/release"] + UEContextId --> TransferUpdate["/transfer-update"] + UEContextId --> Relocate["/relocate"] + UEContextId --> CancelRelocate["/cancel-relocate"] + UEContextId --> N1N2Messages["/n1-n2-messages"] + + N1N2Messages --> N1N2MessageId["{n1N2MessageId}"] + N1N2Messages --> Subscriptions2["/subscriptions"] + N1N2Messages --> UEContextId2["{ueContextId}"] + + Subscriptions1 --> SubscriptionsId1["{subscriptionsId}"] + SubscriptionsId1 --> Transfer2["/transfer"] + SubscriptionsId1 --> Subscriptions3["/subscriptions"] + SubscriptionsId1 --> N2NotifySubscriptionId["{n2NotifySubscriptionId}"] + + NonUeN2Messages --> Transfer3["/transfer"] + NonUeN2Messages --> Subscriptions4["/subscriptions"] + NonUeN2Messages --> UEContextId3["{ueContextId}"] + + Transfer3 --> UEContextId4["{ueContextId}"] + Subscriptions4 --> N2NotifySubscriptionId2["{n2NotifySubscriptionId}"] + UEContextId3 --> UEContextId5["{ueContextId}"] + +``` + +Figure 6.1.3.1-1: Resource URI structure of the Namf\_Communication API. The diagram shows a hierarchical tree of resource paths starting from the root //apiRoot/namf-comm/apiVersion. It branches into /ue-contexts, /subscriptions, and /non-ue-n2-messages. /ue-contexts leads to {ueContextId}, which further branches into /assign-ebi, /transfer, /release, /transfer-update, /relocate, /cancel-relocate, and /n1-n2-messages. /n1-n2-messages leads to {n1N2MessageId}, /subscriptions, and {ueContextId}. /subscriptions under /ue-contexts leads to {subscriptionsId}, which further branches into /transfer, /subscriptions, and {n2NotifySubscriptionId}. /non-ue-n2-messages leads to /transfer, /subscriptions, and {ueContextId}. /transfer under /non-ue-n2-messages leads to {ueContextId}. /subscriptions under /non-ue-n2-messages leads to {n2NotifySubscriptionId}. /ue-contexts under /non-ue-n2-messages leads to {ueContextId}. + +**Figure 6.1.3.1-1: Resource URI structure of the Namf\_Communication API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description (Mapped Service Operations) | +|----------------------------------------------------------|--------------------------------------------------------------------------|---------------------------------|-----------------------------------------| +| Individual ueContext | /ue-contexts/{ueContextId} | | | +| | | PUT | CreateUEContext | +| | /ue-contexts/{ueContextId}/release | release (POST) | ReleaseUEContext | +| | /ue-contexts/{ueContextId}/assign-ebi | assign-ebi (POST) | EBIAssignment | +| | /ue-contexts/{ueContextId}/transfer | transfer (POST) | UEContextTransfer | +| | /ue-contexts/{ueContextId}/transfer-update | transfer-update (POST) | RegistrationStatusUpdate | +| | /ue-contexts/{ueContextId}/relocate | relocate (POST) | RelocateUEContext | +| | /ue-contexts/{ueContextId}/cancel-relocate | cancel-relocate (POST) | CancelRelocateUEContext | +| n1N2Message collection | /ue-contexts/{ueContextId}/n1-n2-messages | POST | N1N2MessageTransfer | +| N1N2 Subscriptions Collection for Individual UE Contexts | /ue-contexts/{ueContextId}/n1-n2-messages/subscriptions | POST | N1N2MessageSubscribe | +| N1N2 Individual Subscription | /ue-contexts/{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId} | DELETE | N1N2MessageUnSubscribe | +| subscriptions collection | /subscriptions | POST | AMFStatusChangeSubscribe | +| individual subscription | /subscriptions/{subscriptionId} | PUT | AMFStatusChangeSubscribe | +| | | DELETE | AMFStatusChangeUnSubscribe | +| Non UE N2Messages collection | /non-ue-n2-messages/transfer | transfer (POST) | NonUEN2MessageTransfer | +| Non UE N2Messages Subscriptions collection | /non-ue-n2-messages/subscriptions | POST | NonUEN2InfoSubscribe | +| Non UE N2 Message Notification Individual Subscription | /non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId} | DELETE | NonUEN2InfoUnsubscribe | + +### 6.1.3.2 Resource: Individual ueContext + +#### 6.1.3.2.1 Description + +This resource represents the an individual ueContext identified by the ueContextId. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +#### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//ue-contexts/{ueContextId} + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|-------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | String | See clause 6.1.1 | +| apiVersion | String | See clause 6.1.1. | +| ueContextId | String | Represents the 5G Globally Unique Temporary Identifier (See 3GPP TS 23.501 [2] clause 5.9.4)
Pattern: "5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}"
Or represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: see pattern of type Supi in 3GPP TS 29.571 [6]
Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3)
pattern: "(imei-[0-9]{15} imeisv-[0-9]{16} .+)" | + +When the ueContextId is composed by UE's SUPI or PEI, UE's PEI shall be used for the case: + +- If the UE is emergency registration and the UE is UICClass; +- If the UE is emergency registration but SUPI is not authenticated. + +For other cases, UE's SUPI shall be used. + +#### 6.1.3.2.3 Resource Standard Methods + +##### 6.1.3.2.3.1 PUT + +This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI, See table 6.1.3.2.2-1. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-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 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|---------------------------------------| +| UeContextCreate Data | M | 1 | Defines the UE Context to be created. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeContextCreatedData | M | 1 | 201
Created | This case represents the successful creation of a new UE Context.
Upon success, a response body is returned containing the newly created UE Context. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| UeContextCreateError | O | 0..1 | 403
Forbidden | This case represents the creation of a new UE Context is not successful.

The "cause" attribute may be used to indicate one of the following application errors:
- HANDOVER_FAILURE | +| ProblemDetails | O | 0..1 | 403
Forbidden | This error shall only be returned by an SCP or a SEPP for errors they originate. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.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}/namf-comm//ue-contexts/{ueContextId} | +| 3gpp-Sbi-Producer-Id | string | C | 0..1 | This header shall be included when the UE Context is created in a target AMF other than the initial AMF sending the response.

When included, this header shall indicate the target AMF serving the created UE Context. | + +**Table 6.1.3.2.3.1-5: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-6: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.3.2.4 Resource Custom Operations + +### 6.1.3.2.4.1 Overview + +**Table 6.1.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|-----------------|--------------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| release | /ue-contexts/{ueContextId}/release | POST | Release an existing individual ueContext resource.
It is used for the Release UE Context service operation. | +| assign-ebi | /ue-contexts/{ueContextId}/assign-ebi | POST | Assign EPS bearer ID(s) towards EPS bearer(s) mapped from QoS Flow(s), for a PDU session for the UE.
It is used for EBIAssignment service operation. | +| transfer | /ue-contexts/{ueContextId}/transfer | POST | Transfer an existing individual ueContext resource from old AMF to new AMF.
It is used for the UEContextTransfer service operation. | +| transfer-update | /ue-contexts/{ueContextId}/transfer-update | POST | Update the source AMF about the status of UE registration at the target AMF.
It is used for the RegistrationStatusUpdate service operation. | +| relocate | /ue-contexts/{ueContextId}/relocate | POST | Relocate an existing individual ueContext resource.
It is used for the RelocateUEContext service operation. | +| relocate | /ue-contexts/{ueContextId}/cancel-relocate | POST | Cancel a UE Context Relocation.
It is used for the CancelRelocateUEContext service operation. | + +### 6.1.3.2.4.2 Operation: release (POST) + +#### 6.1.3.2.4.2.1 Description + +This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI, See table 6.1.3.2.2-1. + +#### 6.1.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.2-2. + +**Table 6.1.3.2.4.2.2-1: Data structures supported by the (POST) release Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------| +| UEContextRelease | M | 1 | The information used for releasing of the UE Context | + +**Table 6.1.3.2.4.2.2-2: Data structures supported by the (POST) release Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents the handover is cancelled successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNSPECIFIED
- SUPI_OR_PEI_UNKNOWN

See table 6.1.7.3-1 for the description of this error. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.2.2-3: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.2.2-4: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.2.4.3 Operation: assign-ebi (POST) + +##### 6.1.3.2.4.3.1 Description + +This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI, see Table 6.1.3.2.2-1. + +##### 6.1.3.2.4.3.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.3.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.3.2-2. + +**Table 6.1.3.2.4.3.2-1: Data structures supported by the (POST) assign-ebi Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|----------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AssignEbiData | M | 1 | The information required for AMF to allocate EPS bearer ID(s) or to update the mapping of EBI and ARP for a QoS flow to which an EBI is already allocated. | + +**Table 6.1.3.2.4.3.2-2: Data structures supported by the (POST) assign-ebi Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AssignedEbiData | M | 1 | 200 OK | Represent successful assignment of EPS bearer ID service operation, with the assigned EBIs included, or represent successful update of the mapping of EBI and ARP for a QoS flow to which an EBI is already allocated.
AMF may allocate only a subset of the requested EBIs, when not enough available EBI(s) can be allocated, e.g. when other PDU sessions with higher ARP have occupied too many EBIs. If the POST request body contained "releasedEbiList" the AMF shall release those EBI(s) and shall include the "releaseEbiList" IE in the POST response body.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 3) | +| AssignEbiError | O | 0..1 | 403
Forbidden | This represents the case when none of the requested EBI(s) can be assigned by the AMF. The "cause" attribute of the ProblemDetails shall be set to:
  • - EBI_EXHAUSTED, if the number of EBIs allocated for the UE has already reached the maximum limit.
  • - EBI_REJECTED_LOCAL_POLICY, if the EBI allocation is rejected due to local policies at the AMF as specified in clause 4.11.1.4.1 of 3GPP TS 23.502 [3].
  • - EBI_REJECTED_NO_N26, if the EBI allocation was rejected when the AMF is in a serving PLMN that does not support 5GS-EPS interworking procedures with N26 interface as specified in clause 5.17.2.3.1 of 3GPP TS 23.501 [2].
| +| ProblemDetails | O | 0..1 | 403
Forbidden | This error shall only be returned by an SCP for errors it originates. | +| AssignEbiError | O | 0..1 | 409
Conflict | This represents the case when none of the requested EBI(s) can be assigned by the AMF. The "cause" attribute of the ProblemDetails shall be set to:
  • - TEMPORARY_REJECT_REGISTRATION_ONGOING, if there is an ongoing registration procedure.
  • - TEMPORARY_REJECT_HANDOVER_ONGOING, if there is an ongoing N2 handover procedure or an ongoing Xn handover procedure.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: When receiving EBI assignment request during Xn Handover or N2 Handover, the AMF may either reject the request with the TEMPORARY\_REJECT\_HANDOVER\_ONGOING application error in a 409 Conflict response or proceed with assigning EBIs with a 200 OK response. In the latter case, upon receipt of the 200 OK response, the SMF shall take the assigned EBIs into account in subsequent processing. + +NOTE 3: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.3.2-3: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.3.2-4: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +6.1.3.2.4.4 Operation: transfer (POST) + +6.1.3.2.4.4.1 Description + +This ueContextId identifies the individual ueContext resource is composed by UE's 5G-GUTI or SUPI, see Table 6.1.3.2.2-1. + +6.1.3.2.4.4.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.4.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.4.2-2. + +**Table 6.1.3.2.4.4.2-1: Data structures supported by the (POST) transfer Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-----------------------------------------------------------------------------------------------| +| UeContextTransferReqData | M | 1 | Represents to start transferring of an individual ueContext resource from old AMF to new AMF. | + +**Table 6.1.3.2.4.4.2-2: Data structures supported by the (POST) transfer Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeContextTransferRspData | M | 1 | 200 OK | Indicates the transferring of the individual ueContext resource is started successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | Indicates that AMF can understand the request but cannot fulfil the request due to errors. If the integrity check of the included complete registration message fails at the source AMF the "cause" attribute is set to:
- INTEGRITY_CHECK_FAIL.

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 404 Not Found | If the AMF does not have the requested UE context, the AMF shall return this status code and the "cause" attribute is set to:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.4.2-3: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.4.2-4: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +6.1.3.2.4.5 Operation: transfer-update (POST) + +6.1.3.2.4.5.1 Description + +This ueContextId identifies the individual ueContext resource is composed by UE's 5G-GUTI, see Table 6.1.3.2.2-1. + +## 6.1.3.2.4.5.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.5.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.5.2-2. + +**Table 6.1.3.2.4.5.2-1: Data structures supported by the (POST) transfer-update Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------| +| UeRegStatusUpdateReqData | M | 1 | Represents to the update of status on the transferring of an individual ueContext resource from old AMF to new AMF. | + +**Table 6.1.3.2.4.5.2-2: Data structures supported by the (POST) transfer-update Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeRegStatusUpdateRspData | M | 1 | 200 OK | Indicates the update of UE context transfer status is successful at the source AMF. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | Indicates that AMF can understand the request but cannot fulfil the request due to errors. | +| ProblemDetails | O | 0..1 | 404 Not Found | If the AMF does not have the requested UE context, the AMF shall return this status code and the "cause" attribute is set to:
- CONTEXT_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.5.2-3: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.5.2-4: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.3.2.4.6 Operation: relocate (POST) + +## 6.1.3.2.4.6.1 Description + +The ueContextId identifying the individual ueContext resource is composed by UE's SUPI or PEI, see Table 6.1.3.2.2-1. + +## 6.1.3.2.4.6.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.6.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.5.2-2. + +**Table 6.1.3.2.4.6.2-1: Data structures supported by the (POST) relocate Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------------------------------------| +| UeContextRelocateData | M | 1 | Defines the UE Context to be relocated to a new AMF. | + +**Table 6.1.3.2.4.6.2-2: Data structures supported by the (POST) relocate Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeContextRelocatedData | M | 1 | 201 Created | This case represents the successful relocation of UE Context to a new AMF.
Upon success, a response body is returned containing the newly created UE Context in new AMF. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetail | O | 0..1 | 403 Forbidden | This case represents an unsuccessful relocation of UE Context to a new AMF.

The "cause" attribute may be used to indicate one of the following application errors:
- HANDOVER_FAILURE | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.6.2-3: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.6.2-4: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +6.1.3.2.4.7 Operation: cancel-relocate (POST) + +6.1.3.2.4.7.1 Description + +This ueContextId identifying the individual ueContext resource is composed by UE's SUPI or PEI, See table 6.1.3.2.2-1. + +6.1.3.2.4.7.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.7.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.7.2-2. + +**Table 6.1.3.2.4.7.2-1: Data structures supported by the (POST) release Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|-----------------------------------------------------------------| +| UEContextCancel RelocateData | M | 1 | The information used for cancellation of UE Context Relocation. | + +**Table 6.1.3.2.4.7.2-2: Data structures supported by the (POST) release Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents the handover is cancelled successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNSPECIFIED
- SUPI_OR_PEI_UNKNOWN

See table 6.1.7.3-1 for the description of this error. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.2.7-3: 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 on an alternative service instance within the same AMF or AMF (service) set.
v For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.2.7-4: 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 on an alternative service instance within the same AMF or AMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.3.3 Resource: N1N2 Subscriptions Collection for Individual UE Contexts + +#### 6.1.3.3.1 Description + +This resource represents the collection under an individual UE context for storing the subscriptions for notifications of UE specific N1 and N2 message types. This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +#### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//{ueContextId}/n1-n2-messages/subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | +| ueContextId | string | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: see pattern of type Supi in 3GPP TS 29.571 [6]
Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3)
pattern: "(imei-[0-9]{15} imeisv-[0-9]{16} .+)" | + +#### 6.1.3.3.3 Resource Standard Methods + +##### 6.1.3.3.3.1 POST + +This method creates an individual N1/N2 information subscription resource for UE related N1/N2 information. This method is used by NF Service Consumers (e.g. PCF) to subscribe for notifications about UE related N1/N2 Information. + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeN1N2InfoSubscriptionCreateData | C | 0..1 | Representation of the subscription for N1 and/or N2 information notification. It shall contain the information regarding N1 and/or N2 information to be notified and the callback URI for the respective notifications. | + +**Table 6.1.3.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeN1N2InfoSubscriptionCreatedData | C | 0..1 | 201
Created | This case represents the successful creation of the subscription for N1 and/or N2 information notification.

Upon success, a response body is returned containing the representation describing the status of the request.

The Location header shall contain the location (URI) of the created subscription resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.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}/namf-comm//ue-contexts/{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId} | + +**Table 6.1.3.3.3.1-5: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.1-6: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.3.4 Resource Custom Operations + +There are no custom operations supported on this resource. + +#### 6.1.3.4 Resource: N1N2 Individual Subscription + +##### 6.1.3.4.1 Description + +This resource represents the individual subscription for the subscription for notifications of UE specific N1 and N2 message types. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.4.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | +| ueContextId | string | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: see pattern of type Supi in 3GPP TS 29.571 [6]
Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3)
pattern: "(imei-[0-9]{15} imeisv-[0-9]{16} .+)" | +| subscriptionId | string | Represents the individual subscription to the UE specific N1/N2 message notification. | + +##### 6.1.3.4.3 Resource Standard Methods + +###### 6.1.3.4.3.1 DELETE + +This method deletes an individual N1/N2 message notification subscription resource for an individual UE. This method is used by NF Service Consumers (e.g. PCF) to unsubscribe for notifications about UE related N1/N2 information. + +This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3. + +**Table 6.1.3.4.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.4.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | If the resource corresponding to the SubscriptionId cannot be found, the AMF shall return this status code. The "cause" attribute is set to:
- SUBSCRIPTION_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.4.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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.4.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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.4.4 Resource Custom Operations + +There are no custom operations supported on this resource. + +#### 6.1.3.5 Resource: N1N2 Messages Collection + +##### 6.1.3.5.1 Description + +This resource represents the collection on which UE related N1 messages and N2 information transfer are initiated and the N1 information for the UE is stored temporarily until the UE is reachable. This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//ue-contexts/{ueContextId}/n1-n2-messages + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | +| ueContextId | string | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: see pattern of type Supi in 3GPP TS 29.571 [6]
Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3)
pattern: "(imei-[0-9]{15} imeisv-[0-9]{16})"
Or represents the LCS Correlation ID (see 3GPP TS 29.572 [25] clause 6.1.6.3.2) (NOTE)
pattern: "(cid-{1,255})" | + +NOTE: The LCS Correlation ID shall only be applied when transferring LCS related UE-Specific N1 and/or N2 messages. + +### 6.1.3.5.3 Resource Standard Methods + +#### 6.1.3.5.3.1 POST + +This method initiates a N1 message and/or N2 message transfer at the AMF and may create a resource to store the N1 and/or N2 message as specified in clause 5.2.2.3.1.2, e.g. if asynchronous type communication is invoked or if the UE is paged. + +This method shall support the request data structures specified in table 6.1.3.5.3.1-1 and the response data structures and response codes specified in table 6.1.3.5.3.1-2. + +**Table 6.1.3.5.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| N1N2MessageTransferReqData | M | 1 | This contains:
- N1 message, if the NF Service Consumer requests to transfer an N1 message to the UE or;
- N2 information, if the NF Service Consumer requests to transfer an N2 information to the 5G-AN or;
- both, if the NF Service Consumer requests to transfer both an N1 message to the UE and an N2 information to the 5G-AN. | + +**Table 6.1.3.5.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| N1N2MessageTransferRspData | M | 1 | 202 Accepted |

This case represents the successful storage of the N1/N2 information at the AMF when asynchronous communication is invoked or when the AMF pages the UE. If the AMF pages the UE, it shall store the N1/N2 message information until the UE responds to paging.

The cause included in the response body shall be set to one of the following values:

  • - WAITING_FOR_ASYNCHRONOUS_TRANSFER
  • - ATTEMPTING_TO_REACH_UE

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. In this release, the URI shall only be used by NF Service consumer to correlate the possible N1/N2 Message Transfer Failure Notification with the related N1/N2 Message Transfer Operation. The NF service consumer shall not send any service requests towards the URI received in the Location header.

| +| N1N2MessageTransferRspData | M | 1 | 200 OK |

This represents the cases where:

  • - the AMF is able to successfully transfer the N1/N2 message to the UE and/or the AN;
  • - the AMF skips sending and discards the N1 message when UE is in CM-IDLE and the "skipInd" is set to "true" in the request; or
  • - the AMF skips sending and discards the N2 message as well as the possibly included N1 message, when the UE is in CM-CONNECTED state and the UE is outside of the validity area included in the N1N2MessageTransfer Request.

The cause included in the response body shall be to one of the following values:

  • - N1_N2_TRANSFER_INITIATED
  • - N1_MSG_NOT_TRANSFERRED
  • - N2_MSG_NOT_TRANSFERRED
| +| RedirectResponse | O | 0..1 | 307 Temporary Redirect |

Temporary redirection.

When the related UE context is not fully available at the target NF Service Consumer (e.g. AMF) during a planned maintenance case (e.g. AMF planned maintenance without UDSF case), the "cause" attribute shall be set to:

  • - NF_CONSUMER_REDIRECT_ONE_TXN

See table 6.1.7.3-1 for the description of these errors

(NOTE 2)

| +| RedirectResponse | O | 0..1 | 308 Permanent Redirect |

Permanent redirection.

(NOTE 2)

| +| ProblemDetails | O | 0..1 | 403 Forbidden |

The "cause" attribute may be used to indicate one of the following application errors:

  • - UE_IN_NON_ALLOWED_AREA
  • - UE_WITHOUT_N1_LPP_SUPPORT
  • - UNSPECIFIED
  • - SM_CONTEXT_RELOCATION_REQUIRED
  • - INVALID_PRU

See table 6.1.7.3-1 for the description of these errors.

| +| ProblemDetails | O | 0..1 | 404 Not Found |

When the related UE is not found in the NF Service Consumer (e.g. AMF), the "cause" attribute shall be set

| + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | to:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | +| N1N2MessageTransferError | O | 0..1 | 409
Conflict | This represents the case where the AMF rejects the N1N2MessageTransfer request due to one of the following reasons. The cause attribute of the ProblemDetails structure shall be set to:
- HIGHER_PRIORITY_REQUEST_ONGOING, if there is already an ongoing paging procedure with higher or same priority;
-
TEMPORARY_REJECT_REGISTRATION_ONGOING, if there is an ongoing registration procedure (see clause 4.2.3.3 of 3GPP TS 23.502 [3]);
- TEMPORARY_REJECT_HANDOVER_ONGOING, if there is an ongoing Xn or N2 handover procedure (see clause 4.9.1.2.1 and 4.9.1.3.1 of 3GPP TS 23.502 [3]).
- UE_IN_CM_IDLE_STATE, if this is a request to transfer a N2 PDU Session Resource Modify Request or a N2 PDU Session Resource Release Command to a 5G-AN, and if the UE is in CM-IDLE state at the AMF for the Access Network Type associated to the PDU session.
- MAX_ACTIVE_SESSIONS_EXCEEDED, if the RAT type is NB-IoT, and the UE already has 2 PDU Sessions with active user plane resources.
- REJECTION_DUE_TO_PAGING_RESTRICTION, if Paging Restrictions information restricts the N1N2MessageTransfer request from causing paging as specified in 3GPP TS 23.501 [2] clause 5.38.5

See table 6.1.7.3-1 for the description of these errors.

The AMF may additionally provide the "retryAfter" IE in order for the NF service consumer to throttle sending further N1/N2 Message Transfer request for a short period, e.g. when there is ongoing paging procedure with higher or same priority or a ongoing registration procedure. | +| N1N2MessageTransferError | O | 0..1 | 504
Gateway
Timeout | This represents the case where the UE is not reachable at the AMF and the AMF is unable to page the UE. The cause attribute of the ProblemDetails structure shall be set to:
- UE_NOT_REACHABLE, if the UE is not reachable for paging;
- UE_NOT_RESPONDING, if the UE is not responding for a previous paging.

See table 6.1.7.3-1 for the description of these errors.

The AMF may additionally provide the "retryAfter" IE in order for the NF service consumer to throttle sending further N1/N2 Message Transfer request for a short period, e.g. when UE is not responding to paging. | +| ProblemDetails | O | 0..1 | 504
Gateway
Timeout | This error shall only be returned by an SCP or a SEPP for errors they originate. | +| NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | | +| NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. | | | | | + +**Table 6.1.3.5.3.1-3: Headers supported by the 202 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | The URI of the resource located on the AMF to which the status of the N1N2 message transfer is held | + +**Table 6.1.3.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | The URI of the resource located on an alternative service instance within the same AMF or AMF (service) set to which the request is redirected.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.5.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 on an alternative service instance within the same AMF or AMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.3.6 Resource: subscriptions collection + +### 6.1.3.6.1 Description + +This resource represents a collection of subscriptions of NF service consumers to the status change of the AMF identified by the GUAMI(s). + +This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +### 6.1.3.6.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.6.2-1. + +**Table 6.1.3.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | + +### 6.1.3.6.3 Resource Standard Methods + +#### 6.1.3.6.3.1 POST + +This method creates a new subscription. This method shall support the URI query parameters specified in table 6.1.3.6.3.1-1. + +**Table 6.1.3.6.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.6.3.1-2 and the response data structures and response codes specified in table 6.1.3.6.3.1-3. + +**Table 6.1.3.6.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | The request body contains the input parameters for the subscription. These parameters include, e.g.:
- GUAMI(s)
- amfStatusUri | + +**Table 6.1.3.6.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | 201
Created | This case represents the successful creation of a subscription.

Upon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNSPECIFIED

See table 6.1.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.6.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}/namf-comm//subscriptions/{subscriptionId} | + +**Table 6.1.3.6.3.1-5: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.6.3.1-6: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.3.7 Resource: individual subscription + +#### 6.1.3.7.1 Description + +This resource represents an individual subscription of a NF service consumer to the status change of the AMF identified by the GUAMI(s). + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +#### 6.1.3.7.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.7.2-1. + +**Table 6.1.3.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | +| subscriptionId | string | Represents a specific subscription | + +#### 6.1.3.7.3 Resource Standard Methods + +##### 6.1.3.7.3.1 DELETE + +This method terminates an existing subscription. This method shall support the URI query parameters specified in table 6.1.3.7.3.1-1. + +**Table 6.1.3.7.3.1-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 6.1.3.7.3.1-2 and the response data structures and response codes specified in table 6.1.3.7.3.1-3. + +**Table 6.1.3.7.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.7.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | 204 No Content | This case represents a successful deletion of the subscription. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | If the resource corresponding to the SubscriptionId cannot be found, the AMF shall return this status code. The "cause" attribute is set to:
- SUBSCRIPTION_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.7.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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.7.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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.7.3.2 PUT + +This method replaces an existing subscription completely. This method shall support the URI query parameters specified in table 6.1.3.7.3.2-1. + +**Table 6.1.3.7.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 6.1.3.7.3.2-2 and the response data structures and response codes specified in table 6.1.3.7.3.2-3. + +**Table 6.1.3.7.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | The request body contains the input parameters for the subscription. These parameters include, e.g.:
- GUAMI(s)
- amfStatusUri | + +**Table 6.1.3.7.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | 200 OK | This case represents a successful replacement of the subscription. | +| n/a | | | 204 No Content | Represents the events subscription modification provided by the NF Service Consumer is accepted entirely. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents the failure update of an existing subscription. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.7.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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.7.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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.3.8 Resource: Non UE N2 Messages Collection + +### 6.1.3.8.1 Description + +This resource represents the collection on which custom operations to transfer the N2 message towards the 5G-AN are specified. This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +### 6.1.3.8.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//non-ue-n2-messages + +This resource shall support the resource URI variables defined in table 6.1.3.8.2-1. + +**Table 6.1.3.8.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|------------|-----------|-------------------| +| apiRoot | String | See clause 6.1.1 | +| apiVersion | String | See clause 6.1.1. | + +### 6.1.3.8.3 Resource Standard Methods + +There are no resource standard methods for the non-ue-n2-messages collection resource in this release of this specification. + +### 6.1.3.8.4 Resource Custom Operations + +#### 6.1.3.8.4.1 Overview + +**Table 6.1.3.8.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|------------------------|--------------------|-----------------------------------| +| transfer | {resourceUri}/transfer | POST | Transfer the N2 message to 5G-AN. | + +#### 6.1.3.8.4.2 Operation: transfer + +##### 6.1.3.8.4.2.1 Description + +The {resourceUri}/transfer custom operation is used to initiate a non UE associated N2 information transfer to the identified 5G-AN nodes. This custom operation uses the HTTP POST method. + +##### 6.1.3.8.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.8.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.8.4.2.2-2. + +**Table 6.1.3.8.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|------------------------------------------------------------------------| +| N2InformationTransferReqData | M | 1 | Representation of the data to be sent to the 5G-AN node(s) by the AMF. | + +**Table 6.1.3.8.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| N2InformationTransferRspData | M | 1 | 200 OK | Indicates AMF has successfully initiated the transferring of N2 Information to the AN.. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| N2InformationTransferError | O | 0..1 | 400 Bad Request | The "cause" attribute may be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 400 Bad Request | This error shall only be returned by an SCP or a SEPP for errors they originate. | +| N2InformationTransferError | O | 0..1 | 403 Forbidden | The "cause" attribute may be set to one of the following application errors:
- UNSPECIFIED
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This error shall only be returned by an SCP or a SEPP for errors they originate. | +| N2InformationTransferError | O | 0..1 | 404 Not Found | The "cause" attribute may be set to one of the following application errors:
- CONTEXT_NOT_FOUND
See table 6.1.7.3-1 for the description of these errors. | +| N2InformationTransferError | O | 0..1 | 500 Internal Server Error | The "cause" attribute may be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | This error shall only be returned by an SCP or a SEPP for errors they originate. | +| N2InformationTransferError | O | 0..1 | 503 Service Unavailable | The "cause" attribute may be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 503 Service Unavailable | This error shall only be returned by an SCP or a SEPP for errors they originate. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.8.4.2.2-3: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.8.4.2.2-4: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.3.9 Resource: Non UE N2 Messages Subscriptions Collection + +#### 6.1.3.9.1 Description + +This resource represents the collection on which individual subscriptions for non UE N2 messages from the 5G-AN are stored. This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +#### 6.1.3.9.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//non-ue-n2-messages/subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.9.2-1. + +**Table 6.1.3.9.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | + +#### 6.1.3.9.3 Resource Standard Methods + +##### 6.1.3.9.3.1 POST + +This method creates an individual N2 information subscription resource for non UE related N2 information. This method is used by NF Service Consumers (e.g. LMF, CBCF/PWS-IWF) to subscribe for notifications about non UE related N2 Information from a specific 5G-AN node, or from any 5G-AN node. + +This method shall support the request data structures specified in table 6.1.3.9.3.1-2 and the response data structures and response codes specified in table 6.1.3.9.3.1-3. + +**Table 6.1.3.9.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------------|---|-------------|---------------------------------------------------------------------| +| NonUeN2InfoSubscriptionCreateData | M | 1 | Representation of the subscription for N2 information notification. | + +**Table 6.1.3.9.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NonUeN2InfoSubscriptionCreated Data | M | 1 | 201
Created | This case represents the successful creation of the subscription for N2 information notification.

Upon success, a response body is returned containing the representation describing the status of the request. The Location header shall carry the location (URI) of the created subscription resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | If the NF Service Consumer is not authorized to subscribe for non UE N2 message notifications, the AMF shall return this status code with the ProblemDetails | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.9.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}/namf-comm//non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId} | + +**Table 6.1.3.9.3.1-5: 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 on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.9.3.1-6: 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 on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.9.4 Resource Custom Operations + +There are no custom operations supported on this resource. + +### 6.1.3.10 Resource: Non UE N2 Message Notification Individual Subscription + +#### 6.1.3.10.1 Description + +This resource represents the individual subscription for the notifications of non UE specific N2 message types (e.g. NRPPa, PWS Notifications). + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +#### 6.1.3.10.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.10.2-1. + +**Table 6.1.3.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------------------|-----------|----------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1. | +| n2NotifySubscriptionId | string | Represents the individual subscription to the non UE specific N2 message notification. | + +#### 6.1.3.10.3 Resource Standard Methods + +##### 6.1.3.10.3.1 DELETE + +This method deletes an individual N2 message notification subscription resource for non UE associated N2 information. This method is used by NF Service Consumers (e.g. LMF) to unsubscribe for notifications about non UE related N2 information. + +This method shall support the request data structures specified in table 6.1.3.10.3.1-2 and the response data structures and response codes specified in table 6.1.3.10.3.1-3. + +**Table 6.1.3.10.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.10.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | If the resource corresponding to the SubscriptionId cannot be found the AMF shall return this status code. The "cause" attribute is set to:
- SUBSCRIPTION_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.10.3.1-5: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.10.3.1-6: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.10.4 Resource Custom Operations + +There are no custom operations supported on this resource. + +### 6.1.4 Custom Operations without associated resources + +There are no custom operations without associated resources supported on Namf\_Communication Service. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +The notifications provided by the Namf\_Communication service are specified in this clause. + +**Table 6.1.5.1-1: Callback overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------------|--------------------------|---------------------------------|---------------------------------| +| AMF Status Change Notification | {amfStatusUri} | POST | | +| Non UE N2 Information Notification | {n2NotifyCallbackUri} | POST | | +| N1 Message Notification | {n1NotifyCallbackUri} | POST | | +| UE Specific N2 Information Notification | {n2NotifyCallbackUri} | POST | | +| N1N2 Transfer Failure Notification | {n1n2FailureTxfNotifURI} | POST | | + +## 6.1.5.2 AMF Status Change Notification + +### 6.1.5.2.1 Description + +If a NF service consumer (e.g. SMF) has subscribed to AMF Status Change on Namf\_Communication Service, when AMF aware of a change of its own status, AMF shall create a notification including the current state, and shall deliver the notification to the call-back URI, following Subscribe/Notify mechanism defined in 3GPP TS 29.501 [5]. + +### 6.1.5.2.2 Notification Definition + +Call-back URI: {amfStatusUri} + +Call-back URI is provided by NF Service Consumer during creation of the subscription. + +### 6.1.5.2.3 Notification Standard Methods + +#### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-2. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|-------------------------------------------------------| +| AmfStatusChangeNotification | M | 1 | Representation of the AMF status change notification. | + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the AMF status change. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | When context of the notification is not found, the "cause" attribute shall be set to:
- CONTEXT_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.5.3 Non UE N2 Information Notification + +### 6.1.5.3.1 Description + +This resource represents the callback reference provided by the NF Service Consumer (e.g. LMF, CBCF/PWS-IWF) to receive notifications about N2 information that are not related to a UE. + +### 6.1.5.3.2 Notification Definition + +Callback URI: {n2NotifyCallbackUri} + +This notification shall support the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.3.2-1: Callback URI variables for this notification** + +| Name | Definition | +|---------------------|------------------------------------------------------------------------------------------------------| +| n2NotifyCallbackUri | Callback reference provided by the NF Service Consumer during the subscription to this notification. | + +### 6.1.5.3.3 Notification Standard Methods + +#### 6.1.5.3.3.1 POST + +This method sends an N2 information notification to the NF Service Consumer (e.g. LMF, CBCF/PWS-IWF). + +This method shall support the request data structures specified in table 6.1.5.3.3.1-2 and the response data structures and response codes specified in table 6.1.5.3.3.1-3. + +**Table 6.1.5.3.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|----------------------------------------------------| +| N2InformationNotification | M | 1 | Representation of the N2 information notification. | + +**Table 6.1.5.3.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the N2 information to the NF service consumer. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | + +**Table 6.1.5.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.5.4 N1 Message Notification + +### 6.1.5.4.1 Description + +This resource represents the callback reference provided by the NF Service Consumer (e.g. LMF) to receive notifications about N1 message from the UE (e.g. LPP messages). + +### 6.1.5.4.2 Notification Definition + +Callback URI: { n1NotifyCallbackUri } + +Callback URI is provided by the NF Service Consumer during the subscription to this notification. . The callback URI for N1 message notification may also be obtained from the NRF, if the NF Service Consumer has registered it in the NF Profile with the NRF. + +### 6.1.5.4.3 Notification Standard Methods + +#### 6.1.5.4.3.1 POST + +This method sends an N1 message notification to the NF Service Consumer (e.g. LMF). + +This method shall support the request data structures specified in table 6.1.5.4.3.1-2 and the response data structures and response codes specified in table 6.1.5.4.3.1-3. + +**Table 6.1.5.4.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------------------------------| +| N1MessageNotification | M | 1 | Representation of the N1 message notification. | + +**Table 6.1.5.4.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the N1 message to the NF service consumer. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents, the NF service consumer failing to accept the processing of the notified N1 message. The detailed information shall be provided in the ProblemDetails structure. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.4.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.4.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.5.5 UE Specific N2 Information Notification + +### 6.1.5.5.1 Description + +This resource represents the callback reference provided by the NF Service Consumer (e.g. LMF) to receive notifications about UE specific N2 information. + +### 6.1.5.5.2 Notification Definition + +Callback URI: {n2NotifyCallbackUri} + +Callback URI is provided by the NF Service Consumer during the subscription to this notification. + +### 6.1.5.5.3 Notification Standard Methods + +#### 6.1.5.5.3.1 POST + +This method sends an N2 information notification to the NF Service Consumer (e.g. LMF). + +This method shall support the request data structures specified in table 6.1.5.5.3.1-2 and the response data structures and response codes specified in table 6.1.5.5.3.1-3. + +**Table 6.1.5.5.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|----------------------------------------------------| +| N2InformationNotification | M | 1 | Representation of the N2 information notification. | + +**Table 6.1.5.5.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the N2 information to the NF service consumer. | +| N2InfoNotificationRspData | M | 1 | 200 OK | This case represents a successful notification of the N2 information to the NF service consumer when information needs to be returned in the response. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent'.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.1.5.6 N1N2 Transfer Failure Notification + +### 6.1.5.6.1 Description + +This resource represents the callback reference provided by the NF Service Consumer (e.g. SMF) to receive notifications about failure to deliver N1 / N2 message. + +### 6.1.5.6.2 Notification Definition + +Callback URI: {n1n2FailureTxfNotifURI} + +Callback URI is provided by the NF Service Consumer during the UE specific N1N2MessageTransfer operation (see clause 6.1.3.5.3.1). + +### 6.1.5.6.3 Notification Standard Methods + +#### 6.1.5.6.3.1 POST + +This method sends an N1/N2 message transfer failure notification to the NF Service Consumer (e.g. SMF). + +This method shall support the request data structures specified in table 6.1.5.6.3.1-1 and the response data structures and response codes specified in table 6.1.5.6.3.1-3. + +**Table 6.1.5.6.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| N1N2MsgTxfrFailureNotification | M | 1 |

Representation of the N1/N2 message transfer failure notification.

The "cause" attribute shall be set to one of following cause values (see clause 6.1.6.3.6):

  • - UE_NOT_RESPONDING
  • - UE_NOT_REACHABLE_FOR_SESSION
  • - TEMPORARY_REJECT_REGISTRATION_ONGOING
  • - TEMPORARY_REJECT_HANDOVER_ONGOING
  • - REJECTION_DUE_TO_PAGING_RESTRICTION
  • - AN_NOT_RESPONDING
  • - FAILURE_CAUSE_UNSPECIFIED

The AMF may additionally provide the "retryAfter" IE in order for the NF service consumer to throttle sending further N1/N2 Message Transfer request for a short period, e.g. when UE is not responding to paging.

| + +**Table 6.1.5.6.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the N1 / N2 message transfer to the NF service consumer. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.6.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 |

A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4].

| +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.6.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.5.7 Void + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Namf\_Communication service based interface protocol. + +**Table 6.1.6.1-1: Namf\_Communication specific Data Types** + +| Data type | Clause defined | Description | +|------------------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | 6.1.6.2.2 | Data within an AMF Status Change Subscription request and response. | +| AmfStatusChangeNotification | 6.1.6.2.3 | Data within an AMF Status Change Notification request. | +| AmfStatusInfo | 6.1.6.2.4 | AMF Status Information | +| AssignEbiData | 6.1.6.2.5 | Data within an EBI assignment request. | +| AssignedEbiData | 6.1.6.2.6 | Data within a successful response to an EBI assignment request. | +| AssignEbiFailed | 6.1.6.2.7 | Represents failed assignment of EBI(s) | +| UEContextRelease | 6.1.6.2.8 | Data within a Release UE Context request. | +| N2InformationTransferReqData | 6.1.6.2.9 | Data within a N2 Information Transfer request containing the N2 information requested to be transferred to 5G AN. | +| NonUeN2InfoSubscriptionCreateData | 6.1.6.2.10 | Data within a create subscription request for non-UE specific N2 information notification. | +| NonUeN2InfoSubscriptionCreatedData | 6.1.6.2.11 | Data for the created subscription for non-UE specific N2 information notification. | +| UeN1N2InfoSubscriptionCreateData | 6.1.6.2.12 | Data within a create subscription request for UE specific N1 and/or N2 information notification. | +| UeN1N2InfoSubscriptionCreatedData | 6.1.6.2.13 | Data for the created subscription for UE specific N1 and/or N2 information notification. | +| N2InformationNotification | 6.1.6.2.14 | Data within a N2 information notification request. | +| N2InfoContainer | 6.1.6.2.15 | N2 information container. | +| N1MessageNotification | 6.1.6.2.16 | Data within a N1 message notification request. | +| N1MessageContainer | 6.1.6.2.17 | N1 Message Container. | +| N1N2MessageTransferReqData | 6.1.6.2.18 | Data within a N1/N2 message transfer request. | +| N1N2MessageTransferRspData | 6.1.6.2.19 | Data within a N1/N2 message transfer response. | +| RegistrationContextContainer | 6.1.6.2.20 | Registration Context Container used to send the UE context information, N1 message from UE, AN address etc during Registration with AMF re-allocation procedure. | +| AreaOfValidity | 6.1.6.2.21 | Area of validity information for N2 information transfer | +| UeContextTransferReqData | 6.1.6.2.23 | Data within a UE Context Transfer Request to start transferring of an individual ueContext resource from old AMF to new AMF. | +| UeContextTransferRspData | 6.1.6.2.24 | Data within a successful response to the UE Context Transfer request. | +| UeContext | 6.1.6.2.25 | Represents an individual ueContext resource | +| N2SmInformation | 6.1.6.2.26 | Represents the session management SMF related N2 information data part. | +| N2InfoContent | 6.1.6.2.27 | Represents a transparent N2 information content to be relayed by AMF. | +| NrppaInformation | 6.1.6.2.28 | Represents a NRPPa related N2 information data part. | +| PwsInformation | 6.1.6.2.29 | Represents a PWS related information data part. | +| N1N2MsgTxfrFailureNotification | 6.1.6.2.30 | Data within a N1/N2 Message Transfer Failure Notification request | +| N1N2MessageTransferError | 6.1.6.2.31 | Data within a N1/N2 Message Transfer Error response. | +| N1N2MsgTxfrErrDetail | 6.1.6.2.32 | N1/N2 Message Transfer Error Details | +| N2InformationTransferRspData | 6.1.6.2.33 | Data within a successful response to the N2 Information Transfer request to transfer N2 Information to the AN. | +| MmContext | 6.1.6.2.34 | Represents a Mobility Management Context in UE Context | +| SeafData | 6.1.6.2.35 | Represents SEAF data derived from data received from AUSF | + +| | | | +|-----------------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------| +| NasSecurityMode | 6.1.6.2.36 | Indicates the NAS Security Mode | +| PduSessionContext | 6.1.6.2.37 | Represents a PDU Session Context in UE Context | +| NssaiMapping | 6.1.6.2.38 | Represents the mapping between a S-NSSAI in serving PLMN to a S-NSSAI in home PLMN. | +| UeRegStatusUpdateReqData | 6.1.6.2.39 | Data within a UE registration status update request to indicate a completion of transferring at a target AMF. | +| AssignEbiError | 6.1.6.2.40 | Data within a failure response to the EBI assignment request. | +| UeContextCreateData | 6.1.6.2.41 | Data within a request to create an individual ueContext resource | +| UeContextCreatedData | 6.1.6.2.42 | Data within a successful response for creating an individual ueContext resource | +| UeContextCreateError | 6.1.6.2.43 | Data within a failure response for creating a UE context | +| NgRanTargetId | 6.1.6.2.44 | Indicates a NG RAN as target of the handover | +| N2InformationTransferError | 6.1.6.2.45 | Data within a failure response for a non-UE related N2 Information Transfer. | +| PWSResponseData | 6.1.6.2.46 | Data related PWS included in a N2 Information Transfer response. | +| PWSErrorData | 6.1.6.2.47 | Data related to PWS error included in a N2 Information Transfer failure response. | +| NgKsi | 6.1.6.2.49 | Represents the ngKSI (see 3GPP TS 33.501 [27]) | +| KeyAmf | 6.1.6.2.50 | Represents the K amf or K' amf . (see 3GPP TS 33.501 [27]). | +| ExpectedUeBehavior | 6.1.6.2.51 | Represents the expected UE behavior (e.g. UE moving trajectory) and its validity period. | +| UeRegStatusUpdateRspData | 6.1.6.2.52 | Data within a UE registration status update response to provides the status of UE context transfer status update at a source AMF. | +| N2RanInformation | 6.1.6.2.53 | Represents the RAN related N2 information data part. | +| N2InfoNotificationRspData | 6.1.6.2.54 | Data within a N2 information notification response. | +| SmallDataRateStatusInfo | 6.1.6.2.55 | Represents the small data rate status | +| SmfChangeInfo | 6.1.6.2.56 | SMF change information for PDU session(s) | +| V2xContext | 6.1.6.2.57 | Represents the V2X services related parameters | +| ImmediateMdtConf | 6.1.6.2.58 | Immediate MDT Configuration | +| V2xInformation | 6.1.6.2.59 | V2X related N2 information | +| EpsNasSecurityMode | 6.1.6.2.60 | Indicates the EPS NAS Security Mode | +| UeContextRelocateData | 6.1.6.2.61 | Data within a Relocate UE Context request | +| UeContextRelocatedData | 6.1.6.2.62 | Data within a Relocate UE Context | +| EcRestrictionDataWb | 6.1.6.2.64 | Enhanced Coverage Restriction Data for WB-N1 mode. | +| ExtAmfEventSubscription | 6.1.6.2.65 | AMF event subscription extended with additional information received for the subscription | +| AmfEventSubscriptionAddInfo | 6.1.6.2.66 | Additional information received for an AMF event subscription, e.g. binding indications. | +| UeContextCancelRelocateData | 6.1.6.2.67 | Data structure used for cancellation of UE Context Relocation. | +| UeDifferentiationInfo | 6.1.6.2.68 | Represents the UE Differentiation Information and its validity time. | +| CeModeBlnd | 6.1.6.2.69 | CE-mode-B Support Indicator | +| LteMInd | 6.1.6.2.70 | LTE-M Indication | +| NpnAccessInfo | 6.1.6.2.71 | NPN Access Information | +| ProseContext | 6.1.6.2.72 | Represents the ProSE services related parameters | +| AnalyticsSubscription | 6.1.6.2.73 | Analytics subscriptions created in the NWDAF. | +| NwdafSubscription | 6.1.6.2.74 | Individual NWDAF subscription identified by the subscription Id. | +| UpdpSubscriptionData | 6.1.6.2.75 | UE policy delivery related N1 message notification subscription data | +| ProSelInformation | 6.1.6.2.76 | 5G ProSe related N2 information. | + +| | | | +|--------------------------------|------------|--------------------------------------------------------------------------------------------| +| ReleaseSessionInfo | 6.1.6.2.77 | PDU session Id(s) and the cause for triggering the release | +| AreaOfInterestEventState | 6.1.6.2.78 | Area Of Interest Event State in old AMF | +| TssInformation | 6.1.6.2.79 | TSS related N2 information | +| AmPolicyInfoContainer | 6.1.6.2.80 | AM Policy Information Container | +| RslpInformation | 6.1.6.2.81 | Ranging/SL positioning related N2 information | +| A2xContext | 6.1.6.2.82 | Represents the A2X services related parameters | +| A2xInformation | 6.1.6.2.83 | A2X related N2 information | +| LcsUpContext | 6.1.6.2.84 | Represents the LCS UP related parameters | +| EpsBearerId | 6.1.6.3.2 | EPS Bearer Identifier | +| Ppi | 6.1.6.3.2 | Paging Policy Indicator | +| NasCount | 6.1.6.3.2 | Represents a NAS COUNT | +| 5GMMCapability | 6.1.6.3.2 | Represents a 5GMM capability | +| UeSecurityCapability | 6.1.6.3.2 | Represents a UE Security Capability | +| S1UeNetworkCapability | 6.1.6.3.2 | Represents a S1 UE Network Capability | +| DrxParameter | 6.1.6.3.2 | Indicates the UE DRX Parameters | +| OmcIdentifier | 6.1.6.3.2 | Represents the OMC Identifier | +| MsClassmark2 | 6.1.6.3.2 | Indicates the MS Classmark 2 of a 5G SRVCC UE | +| SupportedCodec | 6.1.6.3.2 | Indicates the supported codec of a 5G SRVCC UE | +| StatusChange | 6.1.6.3.3 | Enumeration for AMF status | +| N2InformationClass | 6.1.6.3.4 | Enumeration for N2 Information Class | +| N1MessageClass | 6.1.6.3.5 | Enumeration for N1 Message Class | +| N1N2MessageTransferCause | 6.1.6.3.6 | Enumeration for N1N2Message Transfer Cause | +| UeContextTransferStatus | 6.1.6.3.7 | Describes the status of an individual ueContext resource in UE Context Transfer procedures | +| N2InformationTransferResult | 6.1.6.3.8 | Describes the result of N2 information transfer by AMF to the AN. | +| CipheringAlgorithm | 6.1.6.3.9 | Indicates the supported Ciphering Algorithm | +| IntegrityAlgorithm | 6.1.6.3.10 | Indicates the supported Integrity Algorithm | +| SmsSupport | 6.1.6.3.11 | Indicates the supported SMS delivery of a UE. | +| ScType | 6.1.6.3.12 | Indicates the security context type. | +| KeyAmfType | 6.1.6.3.13 | Indicates the K amf type. | +| TransferReason | 6.1.6.3.14 | Indicates UE Context Transfer Reason | +| PolicyReqTrigger | 6.1.6.3.15 | Policy Request Triggers | +| RatSelector | 6.1.6.3.16 | Indicates the RAT type for the transfer of N2 information | +| NgapleType | 6.1.6.3.17 | Indicates the supported NGAP IE types | +| N2InfoNotifyReason | 6.1.6.3.18 | N2 Information Notify Reason | +| SmfChangeIndication | 6.1.6.3.19 | Indicates the I-SMF or V-SMF change or removal | +| SbiBindingLevel | 6.1.6.3.20 | SBI Binding Level | +| EpsNasCipheringAlgorithm | 6.1.6.3.21 | Indicates the supported EPS NAS Ciphering Algorithm | +| EpsNasIntegrityAlgorithm | 6.1.6.3.22 | Indicates the supported EPS NAS Integrity Algorithm | +| PeriodicCommunicationIndicator | 6.1.6.3.23 | Indicates the Periodic Communication Indicator | +| UuaaMmStatus | 6.1.6.3.24 | Indicates UUAA-MM status | +| ReleaseCause | 6.1.6.3.25 | The cause for triggering the release | + +Table 6.1.6.1-2 specifies data types re-used by the Namf 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 Namf service based interface. + +**Table 6.1.6.1-2: Namf re-used Data Types** + +| Data type | Reference | Comments | +|------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Snssai | 3GPP TS 29.571 [6] | | +| Arp | 3GPP TS 29.571 [6] | | +| PduSesisonId | 3GPP TS 29.571 [6] | | +| Guami | 3GPP TS 29.571 [6] | Globally Unique AMF Identifier | +| AmfName | 3GPP TS 29.571 [6] | The name of the AMF | +| Supi | 3GPP TS 29.571 [6] | Subscription Permanent Identifier | +| Cause | 3GPP TS 29.571 [6] | 5G-AN Cause | +| ProblemDetails | 3GPP TS 29.571 [6] | Detailed problems in failure case | +| supportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| TimeZone | 3GPP TS 29.571 [6] | | +| UserLocation | 3GPP TS 29.571 [6] | | +| AccessType | 3GPP TS 29.571 [6] | | +| AllowedNssai | 3GPP TS 29.531 [18] | | +| NfInstanceId | 3GPP TS 29.571 [6] | | +| Uri | 3GPP TS 29.571 [6] | | +| Ecgi | 3GPP TS 29.571 [6] | EUTRA Cell Identifier | +| Ncgi | 3GPP TS 29.571 [6] | NR Cell Identifier | +| Uint16 | 3GPP TS 29.571 [6] | | +| 5Qi | 3GPP TS 29.571 [6] | 5G QoS Identifier | +| CorrelationID | 3GPP TS 29.572 [25] | LCS Correlation ID | +| Pei | 3GPP TS 29.571 [6] | | +| Dnn | 3GPP TS 29.571 [6] | | +| Gpsi | 3GPP TS 29.571 [6] | | +| GroupId | 3GPP TS 29.571 [6] | | +| PlmnId | 3GPP TS 29.571 [6] | | +| RfspIndex | 3GPP TS 29.571 [6] | | +| EbiArpMapping | 3GPP TS 29.502 [16] | EBI - ARP mapping | +| NsiId | 3GPP TS 29.531 [18] | | +| TraceData | 3GPP TS 29.571 [6] | Trace control and configuration parameters | +| ConfiguredSnssai | 3GPP TS 29.531 [18] | | +| NgApCause | 3GPP TS 29.571 [6] | Represents the NG AP cause IE | +| Area | 3GPP TS 29.571 [6] | | +| ServiceAreaRestriction | 3GPP TS 29.571 [6] | | +| CoreNetworkType | 3GPP TS 29.571 [6] | | +| Ambr | 3GPP TS 29.571 [6] | | +| SliceMbr | 3GPP TS 29.571 [6] | | +| GlobalRanNodeId | 3GPP TS 29.571 [6] | | +| NfGroupId | 3GPP TS 29.571 [6] | Network Function Group Id | +| DurationSec | 3GPP TS 29.571 [6] | | +| StnSr | 3GPP TS 29.571 [6] | Session Transfer Number for SRVCC | +| CMSisdN | 3GPP TS 29.571 [6] | Correlation MSISDN | +| DateTime | 3GPP TS 29.571 [6] | | +| SmallDataRateStatus | 3GPP TS 29.571 [6] | | +| NfSetId | 3GPP TS 29.571 [13] | NF Set ID | +| NfServiceSetId | 3GPP TS 29.571 [13] | NF Service Set ID | +| LMFIdentification | 3GPP TS 29.572 [25] | LMF Identification | +| PlmnAssiUeRadioCapId | 3GPP TS 29.571 [6] | | +| ManAssiUeRadioCapId | 3GPP TS 29.571 [6] | | +| NrV2xAuth | 3GPP TS 29.571 [6] | NR V2X services authorized | +| LteV2xAuth | 3GPP TS 29.571 [6] | LTE V2X services authorized | +| BitRate | 3GPP TS 29.571 [6] | Bit Rate | +| Pc5QoSPara | 3GPP TS 29.571 [6] | PC5 QoS parameters | +| PduSessionInfo | 3GPP TS 29.571 [6] | The Slice and DNN combination of a PDU session. | +| PcfUeCallbackInfo | 3GPP TS 29.571 [6] | The callback information of the PCF for the UE to allow the PCF for the PDU session to send SM Policy Association Establishment and Termination events notification. | +| CnAssistedRanPara | 3GPP TS 29.502 [16] | SMF derived CN assisted RAN Parameters Tuning | +| MoExpDataCounter | 3GPP TS 29.571 [6] | MO Exception Data Counter | +| CagData | 3GPP TS 29.503 [35] | Closed Access Group Data | +| NssaaStatus | 3GPP TS 29.571 [6] | Subscribed S-NSSAI subject to NSSAA procedure and the status | +| JobType | 3GPP TS 29.571 [6] | Job Type in the trace | + +| | | | +|--------------------------------|---------------------|-----------------------------------------------------------------| +| MeasurementLteForMdt | 3GPP TS 29.571 [6] | Measurements used for MDT in LTE in the trace | +| MeasurementNrForMdt | 3GPP TS 29.571 [6] | Measurements used for MDT in NR in the trace | +| ReportingTrigger | 3GPP TS 29.571 [6] | Reporting Triggers for MDT in the trace | +| ReportIntervalMdt | 3GPP TS 29.571 [6] | Report Interval for MDT in LTE in the trace | +| ReportAmountMdt | 3GPP TS 29.571 [6] | Report Amount for MDT in the trace | +| CollectionPeriodRmmLteMdt | 3GPP TS 29.571 [6] | Collection period for RRM measurements LTE for MDT in the trace | +| MeasurementPeriodLteMdt | 3GPP TS 29.571 [6] | Measurement period LTE for MDT in the trace in | +| AreaScope | 3GPP TS 29.571 [6] | Area Scope | +| PositioningMethodMdt | 3GPP TS 29.571 [6] | Positioning Method for MDT in the trace in LTE | +| ReportIntervalNrMdt | 3GPP TS 29.571 [6] | Report Interval for MDT in NR in the trace | +| CollectionPeriodRmmNrMdt | 3GPP TS 29.571 [6] | Collection period for RRM measurements NR for MDT in the trace | +| SensorMeasurement | 3GPP TS 29.571 [6] | Sensor information for MDT in the trace | +| ScheduledCommunicationTime | 3GPP TS 29.571 [6] | Scheduled Communication Time | +| StationaryIndication | 3GPP TS 29.571 [6] | Stationary Indication | +| TrafficProfile | 3GPP TS 29.571 [6] | Traffic Profile | +| BatteryIndication | 3GPP TS 29.571 [6] | Battery Indication | +| NFType | 3GPP TS 29.510 [29] | NF type | +| UeAuth | 3GPP TS 29.571 [6] | UE authorisation for PC5 service | +| PartitioningCriteria | 3GPP TS 29.571 [6] | Partitioning Criteria | +| RedirectResponse | 3GPP TS 29.571 [6] | Response body of the redirect response message. | +| CagId | 3GPP TS 29.571 [6] | CAG ID | +| NnwdafEventsSubscription | 3GPP TS 29.520 [52] | Represents an Individual NWDAF Event Subscription resource | +| PresenceInfo | 3GPP TS 29.571 [6] | | +| UePositioningCapabilities | 3GPP TS 29.572 [25] | Indicates the positioning capabilities supported by the UE. | +| SmfSelectionData | 3GPP TS 29.507 [32] | | +| EpsInterworkingInfo | 3GPP TS 29.503 [35] | | +| IpAddress | 3GPP TS 29.503 [35] | | +| Fqdn | 3GPP TS 29.571 [6] | | +| PresenceState | 3GPP TS 29.571 [6] | Presence State | +| SatelliteBackhaulCategory | 3GPP TS 29.571 [6] | Satellite Backhaul Category | +| WirelineServiceAreaRestriction | 3GPP TS 29.571 [6] | | +| PartiallyAllowedSnssai | 3GPP TS 29.571 [6] | S-NSSAI with TAI information | +| VarRepPeriod | 3GPP TS 29.571 [6] | Variable Reporting Periodicity | +| AsTimeDistributionParam | 3GPP TS 29.507 [32] | | +| Prulnd | 3GPP TS 29.503 [35] | PRU Indicator | +| SliceUsageControlInfo | 3GPP TS 29.571 [6] | Slice Usage Control Information | +| MbsrOperationAllowed | 3GPP TS 29.503 [35] | MBSR Operation Information | +| UpConnectionStatus | 3GPP TS 29.572 [25] | Satellite Backhaul Category | +| LMFIdentification | 3GPP TS 29.572 [25] | | +| TaiRange | 3GPP TS 29.510 [29] | TAI range | + +## 6.1.6.2 Structured data types + +### 6.1.6.2.1 Introduction + +Structured data types used in Namf\_Communication service are specified in this clause. + +## 6.1.6.2.2 Type: SubscriptionData + +**Table 6.1.6.2.2-1: Definition of type SubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| amfStatusUri | Uri | M | 1 | This IE shall include the callback URI to receive notification of AMF status change. | +| guamiList | array(Guami) | C | 1..N | This IE shall be absent for subscribing to status change for any GUAMI supported by the AMF, it shall be present for subscribing to specific GUAMIs supported by the AMF. | + +## 6.1.6.2.3 Type: AmfStatusChangeNotification + +**Table 6.1.6.2.3-1: Definition of type AmfStatusChangeNotification** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|----------------------|---|-------------|-------------------------------------------------------------------| +| amfStatusInfoList | array(AmfStatusInfo) | M | 1..N | This IE shall contain the status change information about the AMF | + +## 6.1.6.2.4 Type: AmfStatusInfo + +**Table 6.1.6.2.4-1: Definition of type AmfStatusInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------| +| guamiList | array(Guami) | M | 1..N | This IE shall contain the GUAMIs | +| statusChange | StatusChange | M | 1 | This IE shall contain the Status change of the related GUAMIs | +| targetAmfRemoval | AmfName | C | 0..1 | This IE shall contain the AMF Name of the target AMF in the AMF planned removal without UDSF scenario | +| targetAmfFailure | AmfName | C | 0..1 | This IE shall contain the AMF Name of the target AMF in the AMF Auto-recovery without UDSF scenario. | + +## 6.1.6.2.5 Type: AssignEbiData + +**Table 6.1.6.2.5-1: Definition of type AssignEbiData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduSessionId | PduSessionId | M | 1 | Represents the identifier of the PDU Session requesting EBI(s) to be assigned. | | +| arpList | array(Arp) | C | 1..N | This IE shall be present if the NF Service Consumer (e.g SMF) requests the AMF to assign EBI(s) for the PDU session. When present, this IE shall contain the list of ARP(s) of the QoS flow(s) for which EBI(s) are requested. | | +| releasedEbiList | array(EpsBearerId) | C | 1..N | This IE shall be present if the NF Service Consumer (e.g. SMF) needs to release the assigned EBI(s) from QoS flows (e.g. when the QoS flow is released). | | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | | +| modifiedEbiList | array(EbiArpMapping) | C | 1..N | This IE shall be present if a PDU session modification procedure resulted in the change of ARP for a QoS flow to which an EBI is already allocated. | EAEA | + +## 6.1.6.2.6 Type: AssignedEbiData + +**Table 6.1.6.2.6-1: Definition of type AssignedEbiData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduSessionId | PduSessionId | M | 1 | Represents the identifier of the PDU Session requesting EBI(s) to be assigned. | | +| assignedEbiList | array(EbiArpMapping) | M | 0..N | This IE shall be present if the AMF assigned the requested EBI(s). This IE shall contain the successfully assigned EBIs. (NOTE) | | +| failedArpList | array(Arp) | C | 1..N | This IE shall be present if the AMF fails to allocate EBIs for a set of ARP(s). (NOTE) | | +| releasedEbiList | array(EpsBearerId) | C | 1..N | This IE shall be present if the NF Service Consumer requested the release of EBI(s) or if the AMF revoked an already assigned EBI towards the same PDU session. This IE shall contain the list of EBI(s) released at the AMF. | | +| modifiedEbiList | array(EpsBearerId) | C | 1..N | This IE shall be present if the NF Service Consumer requested to update the ARP for a QoS flow to which an EBI is already allocated. This IE shall contain the list of EBI(s) whose ARP has been updated at the AMF. | EAEA | + +NOTE: The same ARP value may be returned in the assignedEbiList and in the failedArpList, if the request included the same ARP value more than once in the arpList and the AMF is not able to allocate an EBI for every occurrence of this ARP value. + +## 6.1.6.2.7 Type: AssignEbiFailed + +**Table 6.1.6.2.7-1: Definition of type AssignEbiFailed** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|--------------------------------------------------------------------------------| +| pduSessionId | PduSessionId | M | 1 | Represents the identifier of the PDU Session requesting EBI(s) to be assigned. | +| failedArpList | array(Arp) | C | 1..N | This IE shall be present if the AMF fails to allocate EBIs for a set of ARPs. | + +## 6.1.6.2.8 Type: UEContextRelease + +**Table 6.1.6.2.8-1: Definition of type UEContextRelease** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supi | Supi | C | 0..1 | This IE shall be present if the UE is emergency registered and the SUPI is not authenticated. | +| unauthenticatedSupi | boolean | C | 0..1 | When present, this IE shall be set as follows:
  • - true: unauthenticated SUPI;
  • - false (default): authenticated SUPI.
This IE shall be present if the SUPI is present in the message but is not authenticated and is for an emergency registered UE. | +| ngapCause | NgApCause | M | 1 | This IE shall contain the cause value received from the source 5G-AN in the handover Cancel message received over the NGAP interface. | + +## 6.1.6.2.9 Type: N2InformationTransferReqData + +**Table 6.1.6.2.9-1: Definition of type N2InformationTransferReqDataTransfer** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| taiList | array(Tai) | C | 1..N | This IE shall be included if the N2 information needs to be sent to the 5G-AN nodes that serve the list of tracking areas provided. | +| ratSelector | RatSelector | C | 0..1 | This IE shall be included to indicate if the N2 information shall be transferred to ng-eNBs or gNBs exclusively. | +| globalRanNodeList | array(GlobalRanNodeId) | C | 1..N | This IE shall be included if the N2 information needs to be sent to the list of RAN nodes provided. | +| n2Information | N2InfoContainer | M | 1 | This IE includes the information to be sent on the N2 interface to the identified 5G-AN nodes and additional information required for the processing of the message by the AMF. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +## 6.1.6.2.10 Type: NonUeN2InfoSubscriptionCreateData + +Table 6.1.6.2.10-1: Definition of type NonUeN2InfoSubscriptionCreateData + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| globalRanNodeList | array(GlobalRanNodeID) | C | 1..N | This IE shall be included if the subscription is for N2 information from RAN node(s) for which the N2 information notification is subscribed (i.e N3IWF identifier or gNB identifier or Ng-eNB identifier).
(NOTE) | +| anTypeList | array(AccessType) | C | 1..N | This IE shall be included, if the globalRanNodeID IE is not included and if the N2 information from a specific access network needs to be subscribed. When included this IE shall contain the access type of the access network from which Non UE specific N2 information is to be notified.
(NOTE) | +| n2InformationClass | N2InformationClass | M | 1 | This IE represents the class of N2 information that the NF Service Consumer requires to be notified. | +| n2NotifyCallbackUri | Uri | M | 1 | This IE represents the callback URI on which the N2 information shall be notified. | +| nflId | NfInstanceId | C | 0..1 | This IE shall be present if the subscription is for "NRPPa" N2 information class and/or "LPP" N1 information class. When present, this IE shall carry the value to be used for NGAP "Routing ID" IE, which identifies the Network Function (e.g. LMF) instance handling the NRPPa and/or LPP data.

This IE may also be present if the subscription is for "PWS" N2 information class. When present, this IE shall carry the instance identity of the network function (e.g. CBCF or PWS-IWF) creating the subscription. This IE should be included when more than one CBCF/PWS-IWF instances are deployed in the network. The AMF may use this IE to identify whether the same CBCF/PWS-IWF instance has subscribed for N2 PWS information to receive the PWS Response data from the RAN.

This IE shall be present if the subscription is for "TSS" N2 information class. When present, this IE shall identify the TSCTSF NF instance subscribing the TSS data. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| notifCorrelationId | string | O | 0..1 | When present, this IE shall contain the notification correlation ID of the subscription. | +| NOTE: Absence of both IEs means the subscription is for N2 information from all connected Access Network node(s) via any access type. | | | | | + +## 6.1.6.2.11 Type: NonUeN2InfoSubscriptionCreatedData + +Table 6.1.6.2.11-1: Definition of type NonUeN2InfoSubscriptionCreatedData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------| +| n2NotifySubscriptionId | string | M | 1 | Represents the Id created by the AMF for the subscription to notify a non-UE related N2 information. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| n2InformationClass | N2InformationClass | O | 0..1 | This IE represents the class of N2 information that the NF Service Consumer subscribed to. | + +## 6.1.6.2.12 Type: UeN1N2InfoSubscriptionCreateData + +Table 6.1.6.2.12-1: Definition of type UeN1N2InfoSubscriptionCreateData + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n2InformationClass | N2InformationClass | C | 0..1 | This IE shall be present if the NF service consumer subscribes for a N2 information notification. This IE represents the class of N2 information that the NF Service Consumer requires to be notified. | +| n2NotifyCallbackUri | Uri | C | 0..1 | This IE shall be present if the NF service consumer subscribes for a N2 information notification. This IE represents the callback URI on which the N2 information shall be notified. | +| n1MessageClass | N1MessageClass | C | 0..1 | This IE shall be present if the NF service consumer subscribes for a N1 message notification. This IE represents the class of N1 message that the NF Service Consumer requires to be notified. | +| n1NotifyCallbackUri | Uri | C | 0..1 | This IE shall be present if the NF service consumer subscribes for a N1 message notification. This IE represents the callback URI on which the N1 message shall be notified. | +| nflId | NfInstanceId | C | 0..1 | This IE shall be present if the subscription is for "NRPPa" N2 information class and/or "LPP" N1 information class. When present, this IE shall carry the value to be used for NGAP "Routing ID" IE, which identifies the Network Function (e.g. LMF) instance handling the NRPPa and/or LPP data. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | + +## 6.1.6.2.13 Type: UeN1N2InfoSubscriptionCreatedData + +Table 6.1.6.2.13-1: Definition of type UeN1N2InfoSubscriptionCreatedData + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| n1n2NotifySubscriptionId | string | M | 1 | Represents the Id created by the AMF for the subscription to notify a UE related N1/N2 information. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +6.1.6.2.14 Type: N2InformationNotification + +**Table 6.1.6.2.14-1: Definition of type N2InformationNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| n2NotifySubscriptionId | string | M | 1 | Represents the subscription Id for which the notification is generated. The NF Service Consumer uses this to co-relate the notification against a corresponding subscription. If the notification is due to an implicit subscription via NRF, then the value shall be set as "implicit". During the AMF planned removal procedure with UDSF deployed procedure, this IE shall be set to "" (empty string) and be ignored by the NF Service Consumer. | | +| n2InfoContainer | N2InfoContainer | C | 0..1 | This IE shall be present, except during Inter NG-RAN node N2 based handover procedure (see clause 5.2.2.3.6.2).

When present, this IE shall contain the N2 information related to the corresponding N2 information class. | | +| toReleaseSessionList | array(PduSessionId) | C | 1..N | This IE shall be present during N2 based handover procedure, if there are any PDU session(s) associated with Network Slice(s) which become no longer available.

When present, this IE shall include all the PDU session(s) associated with no longer available S-NSSAI(s). | | +| lcsCorrelationId | CorrelationID | C | 0..1 | This IE shall be present, if an LCS correlation identifier is received in corresponding N1/N2 Message Transfer service operation.

When present, this IE shall carry the LCS correlation identifier. | | +| notifyReason | N2InfoNotifyReason | C | 0..1 | This IE shall be present, if "n2InfoContainer" attribute is not present; this IE may be present otherwise.

When present, this IE indicates the reason for the N2 information notification. | | +| smfChangeInfoList | array(SmfChangeInfo) | C | 1..N | This IE shall be present during N2 based handover procedure, if there is I-SMF or V-SMF change or removal for the related PDU session(s).

When present, this IE shall indicate the I-SMF/V-SMF situation after successful HO complete. | DTSSA | +| ranNodeId | GlobalRanNodeId | C | 0..1 | This IE shall be present during the AMF planned removal procedure with UDSF deployed procedure. When present, it shall contain the Global RAN Node ID. The IE shall contain either the gNB ID or the NG-eNB ID. | | +| initialAmfName | AmfName | C | 0..1 | This IE shall be present during the AMF planned removal procedure with UDSF deployed procedure. When present, it shall contain the AMF Name of the initial AMF. | | +| anN2IPv4Addr | Ipv4Addr | C | 0..1 | This IE shall be present during the AMF planned removal procedure with | | + +| | | | | | | +|--------------------|----------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | UDSF deployed procedure, if the Access Network N2 interface is using IPv4 address. | | +| anN2IPv6Addr | Ipv6Addr | C | 0..1 | This IE shall be present during the AMF planned removal procedure with UDSF deployed procedure, if the Access Network N2 interface is using IPv6 address. | | +| guami | Guami | C | 0..1 | This IE shall be present during Location Services procedures (see clause 5.2.2.3.6.3) and it may be present otherwise.

When present, it shall contain the GUAMI serving the UE. | | +| notifySourceNgRan | boolean | C | 0..1 | This IE shall be present during an Inter NG-RAN node N2 based DAPS handover procedure , if the target AMF receives this indication in the Handover Notify from the target NG-RAN node (see clause 4.9.1.3.3a of 3GPP TS 23.502 [3]).
When present, it shall be set as follows:
  • - true: Notify the Source NG-RAN about Handover Success
  • - false (default): Do not notify the Source NG-RAN about Handover Success
| | +| notifCorrelationId | string | O | 0..1 | When present, this IE shall contain the notification correlation ID of the subscription. | | + +## 6.1.6.2.15 Type: N2InfoContainer + +**Table 6.1.6.2.15-1: Definition of type N2InfoContainer** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| n2InformationClass | N2InformationClass | M | 1 | This IE represents the class of N2 information to be transferred. | | +| smInfo | N2SmInformation | C | 0..1 | This IE shall be present if session management N2 information is to be transferred. When present, it represents a session management SMF related N2 information data part. | | +| ranInfo | N2RanInformation | C | 0..1 | This IE shall be present if RAN related N2 information is to be transferred (i.e. n2InformationClass is "RAN"). When present, it shall contain the RAN related N2 information data part. | | +| nrppaInfo | NrppaInformation | C | 0..1 | This IE shall be present if location service related N2 information is to be transferred. When present, it represents a NRPPa related N2 information data part. | | +| pwsInfo | PwsInformation | C | 0..1 | This IE shall be present if PWS related N2 information is to be transferred. | | +| v2xInfo | V2xInformation | C | 0..1 | This IE shall be present if V2X related N2 information is to be transferred. | | +| proseInfo | ProSeInformation | C | 0..1 | This IE shall be present if 5G ProSe related N2 information is to be transferred. | ProSe | +| tssInfo | TssInformation | C | 0..1 | This IE shall be present if TSS related N2 information is to be transferred. | NTSSM | +| rsIpInfo | RsIpInformation | C | 0..1 | This IE shall be present if Ranging/SL positioning related N2 information is to be transferred. | Ranging_SL | +| a2xInfo | A2xInformation | C | 0..1 | This IE shall be present if A2X related N2 information is to be transferred. | A2X | + +## 6.1.6.2.16 Type: N1MessageNotification + +Table 6.1.6.2.16-1: Definition of type N1MessageNotification + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n1NotifySubscriptionId | string | C | 0..1 | Represents the subscription Id for which the notification is generated. The NF Service Consumer uses this to correlate the notification against a corresponding subscription. If the notification is due to an implicit subscription via NRF, then the value shall be set as "implicit".
This IE shall be present if the notification is based on a subscription to N1MessageNotification. An exception is for the case when initial AMF forwards NAS message to target AMF during AMF re-allocation procedure. | +| n1MessageContainer | N1MessageContainer | M | 1 | Contains the N1 message class and N1 message content. | +| lcsCorrelationId | CorrelationID | O | 0..1 | If the N1 message notified is for LCS procedures or PRU procedures, the NF Service Producer (e.g. AMF) may include an LCS correlation identifier. | +| registrationCtxtContainer | RegistrationContextContainer | C | 0..1 | If the N1 message notified is of type 5GMM (i.e. during Registration with AMF re-allocation procedure), the NF Service Producer (e.g. AMF) shall include this IE, if available. | +| newLmfIdentification | LMFIdentification | O | 0..1 | If a new LMF is selected by AMF, this IE may include the new selected LMF Identification. | +| guami | Guami | C | 0..1 | This IE shall be present during UE Assisted and UE Based Positioning Procedure (see clause 5.2.2.3.5.3) or the LCS Event Report, Event Reporting in RRC INACTIVE state procedures, LCS Cancel Location and LCS Periodic-Triggered Invoke Procedures (see clause 5.2.2.3.5.5) and it may be present otherwise.

When present, it shall contain the GUAMI serving the UE. | +| cloT5GSOptimisation | boolean | C | 0..1 | This IE shall be present when the N1 message class is "LPP/LCS" and the N1 message is received from the UE with Control Plane CloT 5GS Optimisation. When present, it shall be set as follows:
- true: Control Plane CloT 5GS Optimisation was used and no signalling or data is currently pending for the UE at the AMF.
- false (default): Control Plane CloT 5GS Optimisation was not used or signalling or data is currently pending for the UE at the AMF. | +| ecgi | Ecgi | O | 0..1 | When present, this IE shall indicate the identifier of the E-UTRAN cell serving the UE.
This IE may be present if the N1 message notified is for LCS procedures. | +| ncgi | Ncgi | O | 0..1 | When present, this IE shall indicate the identifier of the NR cell serving the UE or the PRU.
This IE may be present if the N1 message notified is for LCS procedures or PRU procedures. | +| tai | Tai | O | 0..1 | When present, this IE shall indicate the identifier of the tracking area serving the PRU.
This IE may be present if the N1 message notified is for PRU procedures. | +| supi | Supi | O | 0..1 | When present, this IE shall indicate the SUPI of the PRU.
This IE may be present if the N1 message notified is for PRU procedures. | +| prulnd | Prulnd | O | 0..1 | When present, this IE shall indicate whether the UE is allowed to serve as a PRU.
This IE may be present if the N1 message notified is for PRU procedures. | + +## 6.1.6.2.17 Type: N1MessageContainer + +**Table 6.1.6.2.17-1: Definition of type N1MessageContainer** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n1MessageClass | N1MessageClass | M | 1 | This IE shall contain the N1 message class for the message content specified in n1MessageContent. | +| n1MessageContent | RefToBinaryData | M | 1 | This IE shall reference the N1 message binary data corresponding to the n1MessageClass. See 3GPP TS 24.501 [11]. See clause 6.1.6.4.2. | +| nflId | NfInstanceId | C | 0..1 | This IE shall be present when the n1MessageClass IE is set to "LPP", or "LCS". It should be present when the n1MessageClass IE is set to "SM". It may be present otherwise.
When present, this IE shall carry the identifier of the Network Function (e.g. LMF or SMF) instance sending the N1 message. (NOTE) | +| serviceInstanceId | string | O | 0..1 | When present, this IE shall carry the Service Instance Identifier of the Service Instance (e.g. LMF) sending the N1 message. | +| NOTE: For a Home-routed PDU session, this IE shall carry the NF instance ID of the V-SMF; for a PDU session with I-SMF, this IE shall carry the NF instance ID of the I-SMF. | | | | | + +6.1.6.2.18 Type: N1N2MessageTransferReqData + +**Table 6.1.6.2.18-1: Definition of type N1N2MessageTransferReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| n1MessageContainer | N1MessageContainer | C | 0..1 | This IE shall be included if a N1 message needs to be transferred. | | +| n2InfoContainer | N2InfoContainer | C | 0..1 | This IE shall be included if a N2 information needs to be transferred. | | +| mtData | RefToBinaryData | C | 0..1 | This IE shall be included if mobile terminated data (i.e. CIoT user data container) needs to be transferred. When present, it shall reference the mobile terminated data (see clause 6.1.6.4.4). | CIoT | +| skipInd | boolean | C | 0..1 | This IE shall be present and set to "true" if the service consumer (e.g. SMF) requires the N1 message to be sent to the UE only when UE is in CM-CONNECTED, e.g. during SMF initiated PDU session release procedure (see clause 4.3.4.2 of 3GPP TS 23.502 [3]).

When present, this IE shall be set as following:
- true: AMF should skip sending N1 message to UE, when the UE is in CM-IDLE.
- false (default): the AMF shall send the N1 message to the UE. | | +| lastMsgIndication | boolean | O | 0..1 | This flag when present shall indicate that the message transferred is the last message. (See clause 4.13.3.3 and clause 4.13.3.6 of 3GPP TS 23.502 [3]). | | +| pduSessionId | PduSessionId | O | 0..1 | PDU Session ID for which the N1 / N2 message is sent, if the N1 / N2 message class is SM. | | +| lcsCorrelationId | CorrelationID | O | 0..1 | LCS Correlation ID, for which the N1/N2 message is sent, if

- the N1 message class is LPP (see clause 6.11.1 of 3GPP TS 23.273 [42]) or LCS (see clause 6.3 of 3GPP TS 23.273 [42]) and clause 6.17 of 3GPP TS 23.273 [42]); and/or

- the N2 Information class is NRPPa (see clause 6.11.2 of 3GPP TS 23.273 [42]). | | +| ppi | Ppi | O | 0..1 | This IE when present shall indicate the Paging policy to be applied. The paging policies are configured at the AMF. | | +| arp | Arp | O | 0..1 | This IE when present shall indicate the Allocation and Retention Priority of the PDU session for which the N1/N2 message transfer is initiated. To support priority paging, the AMF shall use this IE to determine whether to include the Paging Priority IE in the NGAP Paging Message (see clause 5.4.3.3 of 3GPP TS 23.501 [2]). The set of ARP values associated with priority paging and mapping to Paging Priority IE values are configured at the AMF. | | + +| | | | | | | +|--|--|--|--|----------------------------------------------------------------------|--| +| | | | | This IE shall not be present when the N1/N2 message class is not SM. | | +|--|--|--|--|----------------------------------------------------------------------|--| + +| | | | | | | +|------------------------|-------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| 5qi | 5Qi | O | 0..1 | This IE when present shall indicate the 5QI associated with the PDU session for which the N1 / N2 message transfer is initiated. This IE shall not be present when the N1/N2 message class is not SM. | | +| n1n2FailureTxfNotifURI | Uri | O | 0..1 | If included, this IE represents the callback URI on which the AMF shall notify the N1/N2 message transfer failure. | | +| smfReallocationInd | boolean | O | 0..1 | This IE shall indicate that the SMF is requested to be reallocated (see clause 4.3.5.2 of 3GPP TS 23.502 [3]).
When present, this IE shall be set as follows:
- true: the SMF is requested to be reallocated.
- false (default): the SMF is not requested to be reallocated. | | +| areaOfValidity | AreaOfValidity | O | 0..1 | This IE represents the list of TAs where the provided N2 information is valid. See clause 5.2.2.2.7 and 4.2.3.3 of 3GPP TS 23.502 [3]. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | | +| maAcceptedInd | boolean | C | 0..1 | This IE shall be present if a request to establish a MA PDU session was accepted or if a single access PDU session was upgraded into a MA PDU session (see clauses 4.22.2 and 4.22.3 of 3GPP TS 23.502 [3]).

When present, it shall be set as follows:
- true: MA PDU session
- false (default): single access PDU session | MAPDU | +| extBufSupport | boolean | O | 0..1 | This IE may be present with value "true" if Extended Buffering is permitted, during Network triggered Service Request Procedure (see clause 4.2.3.3 of 3GPP TS 23.502 [3]), UPF anchored Mobile Terminated Data Transport in Control Plane CLoT 5GS Optimisation procedure (see clause 4.24.2 of 3GPP TS 23.502 [3]) or NEF Anchored Mobile Terminated Data Transport (see clause 4.25.5 of 3GPP TS 23.502 [3]).

When present, this IE shall indicate whether Extended Buffering applies or not:

- true: Extended Buffering applies
- false (default) Extended Buffering | | + +| | | | | | | +|--------------|--------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------| +| | | | | does not apply | | +| targetAccess | AccessType | C | 0..1 |

This IE shall be included by a SMF for a MA PDU session to indicate the target access type (i.e. 3GPP access or Non-3GPP access) towards which the N2 information and optionally N1 information is requested to be sent.

This IE may be included by an LMF to indicate the access type through which an LPP message shall be transmitted to the UE.

This IE shall be included by an SMF and set to the old access type during an intra-AMF handover between 3GPP and non-3GPP accesses, when releasing the N2 PDU session resources in the old access.

|

MAPDU

ELCS

3GA-N3GA-HO

| +| nflId | NfInstanceId | C | 0..1 |

This IE should be included by the SMF when invoking N1N2MessageTransfer service operation, if the n1MessageContainer IE is not present.

When present, this IE shall carry the identifier of the NF instance invoking the service operation, i.e. the SMF instance hosting the SM Context for the PDU session. (NOTE 3)

| | +| pruInd | boolean | O | 0..1 |

When present, this IE shall be set to the value true to indicate that the LMF as NF consumer is requesting to initiate a positioning procedure towards a PRU, as specified in clause 6.11.2 of 3GPP TS 23.273 [42].

| | + +NOTE 1: For N1 message class "UPDP", as per 3GPP TS 24.501 [11] Annex D, the messages between UE and PCF carry PTI which is used by the PCF to correlate the received N1 message in the notification with a prior transaction initiated by the PCF. + +NOTE 2: During Downlink Data Notification procedure, if the SMF receives the PPI value (=DSCP(0..63)) from the UPF and wants to set the PPI value in the N1N2MessageTransfer message, the SMF shall map the PPI value received from N4 message to correct PPI value (0..7) used in N11 message. + +NOTE 3: If the n1MessageContainer IE is present, the nflId attribute in the n1MessageContainer IE should be used by the SMF and the AMF to identify the NF instance ID of the sending SMF. + +#### 6.1.6.2.19 Type: N1N2MessageTransferRspData + +**Table 6.1.6.2.19-1: Definition of type N1N2MessageTransferRspData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|--------------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| cause | N1N2MessageTransferCause | M | 1 | This IE shall provide the result of the N1/N2 message transfer processing at the AMF. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +6.1.6.2.20 Type: RegistrationContextContainer + +**Table 6.1.6.2.20-1: Definition of type RegistrationContextContainer** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ueContext | UeContext | M | 1 | This IE shall contain the UE Context information. | +| localTimeZone | TimeZone | O | 0..1 | This IE contains the time zone UE is currently located. | +| anType | AccessType | M | 1 | This IE shall contain the current access type of the UE. | +| anN2ApId | integer | M | 1 | This IE shall contain the RAN UE NGAP ID over N2 interface. | +| ranNodeId | GlobalRanNodeId | M | 1 | This IE shall contain the Global RAN Node ID. The IE shall contain either the gNB ID or the NG-eNB ID. | +| initialAmfName | AmfName | M | 1 | This IE shall contain the AMF Name of the initial AMF. | +| userLocation | UserLocation | M | 1 | This IE shall contain the user location received from 5G-AN. | +| anN2IPv4Addr | Ipv4Addr | C | 0..1 | If the Access Network N2 interface is using IPv4 address, this IE shall be included. | +| anN2IPv6Addr | Ipv6Addr | C | 0..1 | If the Access Network N2 interface is using IPv6 address, this IE shall be included. | +| rrcEstCause | string | C | 0..1 | This IE shall contain the RRC Establishment Cause, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1).
It carries the value in hexadecimal representation
Pattern: "[0-9a-fA-F]+" | +| ueContextRequest | boolean | C | 0..1 | This IE shall contain the indication on whether UE context including security information needs to be setup at the NG-RAN, if received from the NG-RAN by the initial AMF (See 3GPP TS 38.413 [12], clause 9.2.5.1).

When present, it shall be set as follows:
- true: UE context including security information needs to be setup at the NG-RAN.
- false (default): UE context including security information does not need to be setup at the NG-RAN. | +| initialAmfN2ApId | integer | C | 0..1 | This IE shall contain the AMF UE NGAP ID of the initial AMF over N2 interface, if available. | +| allowedNssai | AllowedNssai | O | 0..1 | This IE contains the allowed NSSAI of the UE. This IE also contains the mapped home network S-NSSAI for each allowed S-NSSAI. | +| configuredNssai | array(ConfiguredSnssai) | O | 1..N | This IE shall contain the configured S-NSSAI(s) authorized by the NSSF in the serving PLMN, if received from the NSSF. | +| rejectedNssaiInPlmn | array(SNSSAI) | O | 1..N | This IE shall contain the rejected NSSAI in the PLMN, if received from the NSSF. | +| rejectedNssaiInTa | array(SNSSAI) | O | 1..N | This IE shall contain the rejected NSSAI in the current TA, if received from the NSSF. | +| selectedPlmnId | PlmnId | O | 0..1 | This IE shall contain the selected PLMN Id for the non-3GPP access, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). | +| iabNodeId | boolean | O | 0..1 | This IE shall contain the IAB Node Indication, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1).

When present, it shall be set as follows:
- true: 5G-AN is an IAB Node.
- false (default): 5G-AN is not an IAB Node. | +| mbsrNodeId | boolean | O | 0..1 | This IE shall contain the MBSR Node Indication, if received from the 5G-AN.

When present, it shall be set as follows:
- true: 5G-AN is an MBSR Node.
- false (default): 5G-AN is not an MBSR Node. | +| ceModeBInd | CeModeBInd | O | 0..1 | This IE shall contain the CE-mode-B Support Indicator, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). | + +| | | | | | +|------------------|---------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lteMInd | LteMInd | O | 0..1 | This IE shall contain the LTE-M Indication, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). | +| authenticatedInd | boolean | O | 0..1 | This IE shall contain the Authenticated Indication, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1).

This IE shall be set as follows:
- true: authenticated by the 5G-AN;
- false (default): unauthenticated by the 5G-AN. | +| npnAccessInfo | NpnAccessInfo | O | 0..1 | This IE shall contain the NPN Access Information, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). | + +#### 6.1.6.2.21 Type: AreaOfValidity + +**Table 6.1.6.2.21-1: Definition of type AreaOfValidity** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------|---------------| +| tailList | array(Tai i) | M | 0..N | An array of TAI representing the area of validity of the associated N2 information provided. | | +| tailRangeList | array(Tai iRange) | O | 1..N | A list of TAI ranges representing the area of validity of the associated N2 information provided.

(NOTE) | AoV-En | + +NOTE: When the tailRangeList is present, the aggregation of tailList attribute and tailRangeList indicates the entire area of validity of the associated N2 information. + +#### 6.1.6.2.22 Void + +#### 6.1.6.2.23 Type: UeContextTransferReqData + +**Table 6.1.6.2.23-1: Definition of type UeContextTransferReqData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reason | TransferReason | M | 1 | Indicate the reason for the UEContextTransfer service request | +| accessType | AccessType | M | 1 | This IE shall contain the access type of the UE. | +| plmnId | PlmnIdNid | O | 0..1 | If present, this IE shall contain the PLMN ID or SNPN ID of the NF service consumer (e.g target AMF). | +| regRequest | N1MessageContainer | O | 0..1 | If present, this IE shall refer to the registration request message which triggers the UE Context Transfer. The message class shall be "5GMM" and message content shall be reference to N1 Message Content binary data, See clause 6.1.6.4.2. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +## 6.1.6.2.24 Type: UeContextTransferRspData + +Table 6.1.6.2.24-1: Definition of type UeContextTransferRspData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueContext | UeContext | M | 1 | Represents an individual ueContext resource after the modification is applied. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | +| ueRadioCapability | N2InfoContent | C | 0..1 | This IE shall be included to contain the "UE Radio Capability Information" if available during context transfer procedure. UE Radio Capability Information does not include NB-IoT UE radio capability, see clause 5.4.4.1 of 3GPP TS 23.501 [2] (NOTE) | | +| ueRadioCapabilityForPaging | N2InfoContent | C | 0..1 | This IE shall be included to contain the "UE Radio Capability for Paging" if available during context transfer procedure. (NOTE) | | +| ueNbiotRadioCapability | N2InfoContent | C | 0..1 | This IE shall be included to contain "NB-IoT UE radio capability Information" if available during context transfer procedure, see clause 5.4.4.1 of 3GPP TS 23.501 [2] | CIOT | + +NOTE: The source AMF may decide to not include ueRadioCapability and ueRadioCapabilityForPaging if the target AMF supports the RACS feature and if: +a. the PlmnAssiUeRadioCapId is included in the MM Context for an intra-PLMN AMF mobility procedure; or +b. the ManAssiUeRadioCapId is included in the MM Context for an intra-PLMN or an inter-PLMN AMF mobility procedure. + +## 6.1.6.2.25 Type: UeContext + +**Table 6.1.6.2.25-1: Definition of type UeContext** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | This IE shall be present if available. When present, this IE contains SUPI of the UE. | | +| supiUnauthInd | boolean | C | 0..1 | This IE shall be present if SUPI is present. When present, it shall indicate whether the SUPI is unauthenticated. | | +| gpsiList | array(Gpsi) | C | 1..N | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall contain the GPSI(s) of the UE. | | +| pei | Pei | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall contain Mobile Equipment Identity of the UE. | | +| udmGroupId | NfGroupId | O | 0..1 | When present, it shall indicate the identity of the UDM Group serving the UE. | | +| ausfGroupId | NfGroupId | O | 0..1 | When present, it shall indicate the identity of the AUSF Group serving the UE. | | +| pcfGroupId | NfGroupId | O | 0..1 | When present, it shall indicate the identity of the PCF Group serving the UE. | | +| routingIndicator | string | O | 0..1 | When present, it shall indicate the Routing Indicator of the UE. | | +| hNwPubKeyId | integer | O | 0..1 | When present, it shall indicate the Home Network Public Key Identifier of the UE. (NOTE 4). | | +| groupList | array(GroupId) | C | 1..N | This IE shall be present if the UE belongs to any subscribed internal group(s) and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall list the subscribed internal group(s) to which the UE belongs to. | | +| drxParameter | DrxParameter | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall contain the DRX parameter of the UE. | | +| subRfsp | RfspIndex | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, it shall indicate the subscribed RFSP Index of the UE. | | +| pcfRfsp | RfspIndex | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a.

When present, this IE shall indicate the PCF determined RFSP Index of the UE. | | +| usedRfsp | RfspIndex | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, it shall indicate the used RFSP Index of the UE. | | +| subUeAmbr | Ambr | C | 0..1 | This IE shall be present if subscribed UE-AMBR has been retrieved from UDM and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a.

When present, this IE shall indicate the value of subscribed UE AMBR of the UE. | | +| pcfUeAmbr | Ambr | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a.

When present, this IE shall indicate the value of the PCF determined UE AMBR of the UE. | | +| subUeSliceMbrList | map(SliceMbr) | C | 1..N | Map of SliceMbr, where the S-NSSAI shall be used as the key of the map.

This IE shall be present if the list of subscribed UE-Slice-MBR(s) has been retrieved from UDM and if it is not case b) | | + +| | | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | specified in clause 5.2.2.2.1.1 step 2a.
When present, this IE shall indicate the list of subscribed UE-Slice-MBR(s) per S-NSSAI for the UE. | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | +|------------------------|-------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| smsfId | NfInstanceId | C | 0..1 | This IE shall be present if the SMS service for UE is activated and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, it indicates the identifier of the SMSF network function instance serving the UE. The NF service consumer (e.g. target AMF) may use this information to identify the SMSF NF service profile from among the SMSF NF service profiles it received from the NRF. | +| seafData | SeafData | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a or the case specified in clause 5.2.2.2.1.2. When present, this IE contains the security data derived from data received from AUSF of the UE. | +| 5gMmCapability | 5GMmCapability | C | 0..1 | This IE shall be present if the UE had provided this IE during Registration Procedure and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall contain 5G MM capability of the UE. | +| pcfId | NfInstanceId | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE indicates the identity of the PCF for AM Policy and/or UE Policy. | +| pcfSetId | NfSetId | C | 0..1 | This IE shall be present, if available. When present, it shall contain the NF Set ID of the PCF for AM Policy and/or UE Policy. | +| pcfAmpServiceSetId | NfServiceSetId | C | 0..1 | This shall be present, if available. When present, it shall contain the NF Service Set ID of the PCF's AM Policy service. | +| pcfUepServiceSetId | NfServiceSetId | C | 0..1 | This shall be present, if available. When present, it shall contain the NF Service Set ID of the PCF's UE Policy service. | +| pcfBindingLevel | SbiBindingLevel | C | 0..1 | This IE shall be present if available. When present, this IE shall contain the SBI binding level of the PCF's AM policy and UE Policy association resources. (NOTE 6) | +| pcfAmPolicyUri | Uri | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present this IE shall contain the URI of the individual AM policy resource (see 3GPP TS 29.507 [32] clause 5.3.3.2) used by the AMF. | +| amPolicyReqTriggerList | array(PolicyReqTrigger) | C | 1..N | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present this IE shall indicate the AM policy request triggers towards the PCF. The NF Service Consumer (e.g. target AMF) shall use these triggers to request AM policy from the PCF whenever these triggers are met.

The possible AM policy control request triggers are specified in clause 6.1.2.5 of 3GPP TS 23.503 [7]. | +| pcfUePolicyUri | Uri | C | 0..1 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present this IE shall contain the URI of the individual UE policy resource (see 3GPP TS 29.507 [32] clause 5.3.3.2) used by the AMF. | +| uePolicyReqTriggerList | array(PolicyReqTrigger) | C | 1..N | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present this IE shall indicate the UE policy request triggers towards the PCF. The NF Service Consumer (e.g. target | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

AMF) shall use these triggers to request UE policy from the PCF whenever these triggers are met.

The possible UE policy control request triggers are specified in clause 6.1.2.5 of 3GPP TS 23.503 [7].

| | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | +|------------------------|--------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| hpcfId | NfInstanceId | O | 0..1 | This IE indicates the identity of PCF for UE Policy in home PLMN, when the UE is roaming. | +| hpcfSetId | NfSetId | O | 0..1 | When present, this IE shall contain the NF Set ID of the PCF for UE Policy in home PLMN, when the UE is roaming. | +| restrictedRatList | array(RatType) | O | 1..N | When present, this IE shall indicate the list of RAT types that are restricted for the UE; see 3GPP TS 29.571 [6] (NOTE 1) | +| forbiddenAreaList | array(Area) | O | 1..N | When present, this IE shall indicate the list of forbidden areas of the UE. | +| serviceAreaRestriction | ServiceAreaRestriction | O | 0..1 | When present, this IE shall indicate subscribed Service Area Restriction for the UE. | +| restrictedCnList | array(CoreNetworkType) | O | 1..N | When present, this IE shall indicate the list of Core Network Types that are restricted for the UE. | +| eventSubscriptionList | array(ExtAmfEventSubscription) | C | 1..N |

This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, it shall indicate the event subscription(s) targeting the UE or the group the UE is part of.

If the source AMF supports binding procedures and if it received binding indications for event notifications (i.e. with "callback" scope) or for subscription change event notifications (i.e. with "subscription-events" scope) for certain subscriptions, these binding indications should also be included.

If the source AMF knows the NF type of the NF that created the subscription, this information should also be indicated.

| +| mmContextList | array(MmContext) | C | 1..2 | This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE contains the MM Contexts of the UE. | +| sessionContextList | array(PduSessionContext) | C | 1..N | This IE shall be present if available and if it is neither case a) nor case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE contains the PDU Session Contexts of the UE. (NOTE 2) | +| epsInterworkingInfo | EpsInterworkingInfo | C | 0..1 | This IE shall contain the associations between APN/DNN and PGW-C+SMF for EPS interworking, if available. | +| traceData | TraceData | C | 0..1 | This IE shall be present if signalling based trace has been activated (see 3GPP TS 32.422 [30]) and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. | +| serviceGapExpiryTime | DateTime | C | 0..1 |

This IE shall be present if Service Gap Control is enabled and if the AMF has started a Service Gap Timer which has not expired yet (see clause 5.31.16 of 3GPP TS 23.501 [2]).

The value of the IE shall indicate the expiry time (in UTC) of the active Service Gap Timer for the UE.

| +| stnSr | StnSr | O | 0..1 |

This IE shall be present if available, for UE supporting 5G-SRVCC (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]).

When present, this IE contains STN-SR of the UE.

| +| cMsisdn | CMSisdn | O | 0..1 | This IE shall be present if available, for UE | + +| | | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------|--| +| | | | | supporting 5G-SRVCC (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]).
When present, this IE contains C-MSISDN of the UE. | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|----------------------------|--------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| msClassmark2 | MSClassmark2 | O | 0..1 | This IE shall be present if available, for UE supporting 5G-SRVCC (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]).
When present, this IE contains Mobile Station Classmark 2 of the UE. | | +| supportedCodecList | array(SupportedCodec) | O | 1..N | This IE shall be present if available, for UE supporting 5G-SRVCC (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]).
When present, this IE shall indicate the list of speech codecs supported by the UE. | | +| smallDataRateStatusInfos | array(SmallDataRateStatusInfo) | O | 1..N | List of Small Data Rate Control Statuses for released PDU Sessions, see clause 5.31.14.3 of TS 23.501 [2]. | CIOT | +| restrictedPrimaryRatList | array(RatType) | O | 1..N | When present, this IE shall indicate the list of RAT types that are restricted for use as primary RAT for the UE; see 3GPP TS 29.571 [6] (NOTE 1) | | +| restrictedSecondaryRatList | array(RatType) | O | 1..N | When present, this IE shall indicate the list of RAT types that are restricted for use as secondary RAT for the UE; see 3GPP TS 29.571 [6] (NOTE 1) | | +| v2xContext | V2xContext | O | 0..1 | This IE shall be present if available (see clause 6.5.4 of 3GPP TS 23.287 [47]).
When present, this IE shall indicate the parameters related to the V2X services. | | +| lteCatMInd | boolean | C | 0..1 | This IE shall be present with value "true" if the UE is a LTE Category M UE based on indication provided by the NG-RAN or by the MME at EPS to 5GS handover, as specified in 3GPP TS 23.502 [3].

When present, this IE shall be set as following:
- true: the UE is a Category M UE
- false (default): this UE is not a Category M UE. | | +| redCapInd | boolean | C | 0..1 | This IE shall be present with value "true" if the UE is a NR RedCap UE based on indication provided by the NG-RAN, as specified in 3GPP TS 23.502 [3].

When present, this IE shall be set as following:
- true: the UE is a NR RedCap UE
- false (default): this UE is not a NR RedCap UE. | | +| moExpDataCounter | MoExpDataCounter | C | 0..1 | This IE shall be present if a non-zero MO Exception counter has not been reported yet to SMF.

When present, this IE shall contain the MO Exception Data Counter, as specified in clause 5.31.14.3 of 3GPP TS 23.501 [2]. | | +| cagData | CagData | O | 0..1 | Closed Access Group Data
When present, the provisioningTime attribute (from the CagData data type) shall be absent. | NPN | +| managementMdtInd | boolean | C | 0..1 | This flag shall be present with value "true" if Management Based Minimization of Drive Tests (MDT) is allowed, as specified in 3GPP TS 32.422 [30].

When present, this IE shall be set as following:
- true: management based MDT is allowed.
- false (default): management based MDT is not allowed. | | +| immediateMdtConf | ImmediateMdtConf | C | 0..1 | This IE shall be sent by the source AMF to the target AMF, if the Job Type indicates | | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------|--| +| | | | | Immediate MDT. See clause 4.10 of
3GPP TS 32.422 [30]. | | +|--|--|--|--|-----------------------------------------------------------|--| + +| | | | | | | +|----------------------------|-------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| ecRestrictionDataWb | EcRestrictionDataWb | C | 0..1 | This IE shall be present if the AMF determines whether Enhanced Coverage is restricted or not for the UE for WB-N1 mode. If absent, this IE indicates Enhanced Coverage is not restricted for WB-N1 mode. (NOTE 3) | | +| ecRestrictionDataNb | boolean | C | 0..1 | This IE shall be present if the AMF determines whether Enhanced Coverage is restricted or not for the UE for NB-N1 mode.

If present, this IE shall indicate whether Enhanced Coverage for NB-N1 mode is restricted or not.

  • - true: Enhanced Coverage for NB-N1 mode is restricted.
  • - false or absent: Enhanced Coverage for NB-N1 mode is allowed. (NOTE 3)
| | +| iabOperationAllowed | boolean | O | 0..1 | This IE shall be present if the UE is allowed for IAB operation. It may be present otherwise.

When present, it shall indicate whether the UE is allowed for IAB operation, as follows:
  • - true: indicates that the UE is allowed for IAB operation.
  • - false: indicates that the UE is not allowed for IAB operation.
| | +| mbsrOperationAllowed | MbsrOperationAllowed | O | 0..1 | Indicates whether the subscriber is allowed for MBSR operation as specified in clause 5.35A.4 of 3GPP TS 23.501 [2], optionally, with corresponding location and time period. | | +| proseContext | ProseContext | O | 0..1 | This IE shall be present if available (see clause 6.7 of 3GPP TS 23.304 [51]). When present, this IE shall indicate the parameters related to the ProSe services. | ProSe | +| analyticsSubscriptionList | array(Analytics Subscription) | C | 1..N | This IE shall be present if the AMF has created analytics subscription(s) towards NWDAF related to the UE.

If present, this IE shall include the list of analytics subscriptions, as specified in clauses 5.2.2.2.2 and 5.2.2.2.11 of 3GPP TS 23.502 [3]. | | +| pcfUepBindingInfo | string | C | 0..1 | This IE shall be present if Binding Indication was received for UE Policy Association resource from the PCF. When present, this IE shall contain the Binding indication of the PCF's UE Policy Association resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | | +| pcfAmpBindingInfo | string | C | 0..1 | This IE shall be present if Binding Indication was received for AM Policy Association resource from the PCF. When present, this IE shall contain the Binding indications of the PCF's AM policy Association resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | | +| usedServiceAreaRestriction | ServiceAreaRestriction | O | 0..1 | When present, this IE shall include the Service Area Restriction from PCF. | | +| pralnAmPolicy | map(PresenceI) | O | 1..N | When present, this IE shall include the map | | + +| | | | | | | +|--|------|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | nfo) | | |

of PRA Information for the subscribed "PRA_CHANGE" PolicyReqTrigger in the AM Policy Association.

The key of the map shall be the "prald" attribute within the PresenceInfo data type. The "presenceState" attribute within the PresenceInfo data type shall not be supplied here.

| | +|--|------|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|----------------------------|---------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| pralNUePolicy | map(PresenceInfo) | O | 1..N | When present, this IE shall include the map of PRA Information for the subscribed "PRA_CHANGE" PolicyReqTrigger in the UE Policy Association.

The key of the map shall be the "pralid" attribute within the PresenceInfo data type. The "presenceState" attribute within the PresenceInfo data type shall not be supplied here. | | +| updpSubscriptionData | UpdpSubscriptionData | O | 0..1 | When present, this IE shall include the subscription resource in the AMF for a UE policy delivery related N1 message notification. | | +| smPolicyNotifyPduList | array(PduSessionInfo) | C | 1..N | This IE shall be present if it has been received from the PCF for the UE, i.e. the PCF for the AM Policy Association and possibly the UE Policy Association.

When present, this IE shall contain the information (Slice and DNN combination) of the PDU session(s) applicable for the notification of SM Policy Association Establishment and Termination events. (NOTE 5) | SPAE | +| pcfUeCallbackInfo | PcfUeCallbackInfo | C | 0..1 | This IE shall be present if the smPolicyNotifyPduList IE is present.

When present, this IE shall contain the callback information of the PCF for the UE to receive SM Policy Association Establishment and Termination events notification from the PCF for the SM Policy. (NOTE 5) | SPAE | +| uePositioningCap | UePositioningCapabilities | O | 0..1 | When present, this IE shall indicate the positioning capabilities supported by the UE. | | +| snpnOnboardInd | boolean | C | 0..1 | This IE shall be present if the UE is registered for onboarding in an SNPN.

When present, it shall indicate the following:
- true: indicates that the UE is registered for onboarding in an SNPN.

- false (default): indicates that the UE is not registered for onboarding in an SNPN. | eNPN | +| astiDistributionIndication | boolean | O | 0..1 | When present, this IE shall indicate whether the access stratum time distribution via Uu reference point should be activated or deactivated for the UE.
When present, this IE shall be set as following:
- true: ASTI distribution is activated for the UE.

- false (default): ASTI distribution is deactivated for the UE. | | +| tsErrorBudget | integer | O | 0..1 | When present, this IE shall indicate the Uu time synchronization error budget for the time synchronization service (as described in clause 5.27.1 in TS 23.501 [2]). It indicates the value in nano seconds. | | +| smfSelInfo | SmfSelectionData | C | 0..1 | This IE shall be present if conditions for SMF Selection information replacement are received from the PCF for AM Policy.

When present, It shall include the conditions | | + +| | | | | | | +|--|--|--|--|-------------------------------------------------------------------------|--| +| | | | | for SMF selection information replacement,
as determined by the PCF. | | +|--|--|--|--|-------------------------------------------------------------------------|--| + +| | | | | | | +|-----------------------|--------------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| pcfUeSliceMbrList | map(SliceMbr) | C | 1..N |

This IE shall be present when UE Slice MBR(s) were received from the PCF for AM Policy.

When present, this IE shall include one or more UE-Slice-MBR(s) as determined by the PCF for allowed S-NSSAI(s). The key of the map is the S-NSSAI in the allowed NSSAI to which the UE-Slice-MBR belongs.

| | +| smsfSetId | NfSetId | C | 0..1 |

This IE shall be present if available.

When present, this IE shall contain the NF Set ID of the SMSF serving the UE.

| | +| smsfServiceSetId | NfServiceSetId | C | 0..1 |

This shall be present, if available.

When present, it shall contain the NF Service Set ID of the SMSF's service instance serving the UE.

| | +| smsfBindingInfo | string | C | 0..1 |

This IE shall be present if available.

When present, this IE shall contain the binding indication of the UE Context for SMS in SMSF and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name.

| | +| disasterRoamingInd | boolean | C | 0..1 |

This IE shall be present if the UE is registered for disaster roaming. It may be present otherwise.

When present, this IE shall be set as follows:

  • - true: UE is registered for Disaster Roaming service;
  • - false (default): UE is not registered for Disaster Roaming service.
| | +| disasterPlmn | PlmnId | C | 0..1 |

This IE shall be included if the disasterRoamingInd is present and set to "true".

When present, this IE includes the PLMN of the UE which has faced disaster condition

| | +| satelliteBackhaulCat | SatelliteBackhaulCategory | O | 0..1 |

When present, this IE shall be set to the last value that has been reported to the PCF if the satellite backhaul category change is subscribed with the "SAT_BACKHAUL_CHANGE" PolicyReqTrigger in the UE Policy Association.

| | +| wlServAreaRes | WirelineServiceAreaRestriction | C | 0..1 |

This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a.

When present, this IE shall indicate the value of the PCF determined Wireline Service Area Restriction.

| | +| asTimeDisParam | AsTimeDistributionParam | C | 0..1 |

This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a.

When present, this IE shall contain the 5G access stratum time distribution parameters received from the PCF for AM Policy.

| | +| amPolicyInfoContainer | AmPolicyInfoContainer | C | 0..1 |

This IE shall be present if any of the information in the container is available and if

| | + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| | | | | it is not case b) specified in clause 5.2.2.2.1.1 step 2a.

When present, this IE shall contain the AM Policy information parts received from the PCF for AM Policy. | | +| a2xContext | A2xContext | O | 0..1 | This IE shall be present if available (see clause 6.3.5.4 of 3GPP TS 23.256 [56]).
When present, this IE shall indicate the parameters related to the A2X services. | A2X | +| lcsUpContext | LcsUpContext | O | 0..1 | This IE shall be present if available (see clause 4.3.7 of 3GPP TS 23.273 [42]).
When present, this IE shall indicate the parameters related to the LCS UP services. | | +| reconnectInd | boolean | O | 0..1 | Indicates whether the UE is to reconnect to the network in the case the UE determines that it does not have the latest available clock quality information as described in clause 5.27.1.12 in 3GPP TS 23.501 [2].

When present, this IE shall be set as follows:
- true: the UE reconnects to the network in the case the UE determines that the reference report ID has changed;
- false (default): the UE does not have an indication from CN to reconnect to the network in the case that the reference report ID has changed. | | +| NOTE 1: If the restrictedPrimaryRatList and restrictedSecondaryRatList attributes are supported by the sender, the sender shall include the list of RAT Types that are restricted, if any, in the restrictedRatList attribute, shall include the list of RAT Types that are restricted for use as primary RAT, if any, in the restrictedPrimaryRatList attribute and shall include the list of RAT Types that are restricted for use as secondary RAT, if any, in the restrictedSecondaryRatList attribute. If the restrictedPrimaryRatList and restrictedSecondaryRatList attributes are supported by the receiver, the receiver shall use the data in the restrictedPrimaryRatList attribute, if received, as the list of RAT Types that are restricted for use as primary RAT for the UE, and shall use the data in the restrictedSecondaryRatList attribute, if received, as the list of RAT Types that are restricted for use as secondary RAT for the UE, otherwise the receiver shall use the data in the restrictedRatList attribute, if received, as the list of RAT Types that are restricted for the UE. | | | | | | +| NOTE 2: A particular PDU session not supported by the target AMF shall not be transferred, e.g. MA-PDU session context shall not be transferred if target AMF does not support ATSSS. | | | | | | +| NOTE 3: After ecRestrictionDataWb and/or ecRestrictionDataNb attributes are sent from source AMF to target AMF to build the UeContext in the target AMF, the target AMF shall re-determine the EC restriction information based on the received subscription data from UDM and UE 5GMM capability because EC restriction information may change (e.g. due to that subscription data in UDM is changed but not notified the old AMF yet) and then compare the re-determined EC restriction information with the one received in the UeContext. If the target AMF finds EC restriction information has changed after comparing, the target AMF shall proceed as described in clause 5.31.12, 3GPP TS 23.501 [2]. | | | | | | +| NOTE 4: If present, this attribute shall be used together with routingIndicator. This attribute is only used by the HPLMN in roaming scenarios. | | | | | | +| NOTE 5: If the information as indicated in both IEs were received from the PCF for the UE or from the old AMF in UE Context, the AMF shall identify whether a non-roaming or local breakout PDU session is applicable for SM Policy Association events, i.e, whether the slice and DNN combination of the PDU session is listed in the smPolicyNotifyPduList IE or not. If the PDU session is applicable for notification of SM Policy Association events , the AMF shall provide the callback information for the PCF of the UE contained in the pcfUeCallbackInfo IE to the SMF of a new PDU session via Create SM Context service operation, or to the SMF for an ongoing PDU session via Update SM Context service operation, together with the indication for notification of SM Policy Association events. See clause 4.3.2.2.1 and clause 4.3.3.2 of 3GPP TS 23.502 [3]. | | | | | | +| NOTE 6: This IE is deprecated. An AMF complying with this version of specification shall use the pcfAmpBindingInfo IE to carry the Binding indication of the AM Policy Association resource and use the pcfUepBindingInfo IE to carry the binding indication of the UE Policy Association resource. | | | | | | + +## 6.1.6.2.26 Type: N2SmInformation + +Table 6.1.6.2.26-1: Definition of type N2SmInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduSessionId | PduSessionId | M | 1 | Indicates the PDU Session Identity | | +| n2InfoContent | N2InfoContent | C | 0..1 | This IE shall be present if a SMF related IE should be transferred. When present, the IE contains one of NGAP SMF related IEs specified in clause 9.3.4 of 3GPP TS 38.413 [12]. | | +| sNssai | Snssai | C | 0..1 | This IE shall be present if network slice information to be transferred for session management. When present, the IE indicates the network slice the PDU session belongs to. (NOTE) | | +| homePlmnSnssai | Snssai | C | 0..1 | This IE shall be present during EPS to 5GS handover procedure for Home Routed PDU session. When present, it shall carry the S-NSSAI for home PLMN. | ENS | +| iwkSnssai | Snssai | C | 0..1 | This IE shall be present during EPS to 5GS handover procedure with AMF relocation for Home Routed PDU session, or during EPS to 5GS handover using N26 interface with AMF relocation and with I-SMF insertion, if S-NSSAI for interworking is configured and used in the initial AMF, as specified in clause 4.11.1.2.2 and clause 4.23.12.7.1 of 3GPP TS 23.502 [3].

When present, this IE shall carry the S-NSSAI for interworking configured and used in the initial AMF for the PDU session. | ENS | +| subjectToHo | boolean | C | 0..1 | This IE shall be present if n2InfoContent carries a "Handover Required Transfer" IE. When present, it Indicates whether the PDU session shall be subject to handover to the target node. | | + +NOTE: During EPS to 5GS handover procedure for Home Routed PDU session with AMF relocation, the source AMF shall set this IE to the S-NSSAI in the serving PLMN mapped from the S-NSSAI in home PLMN indicated by the homePlmnSnssai IE in the N2SmInformation data structure sent to target AMF. + +## 6.1.6.2.27 Type: N2InfoContent + +**Table 6.1.6.2.27-1: Definition of type N2InfoContent** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ngapMessageType | Uinteger | C | 0..1 | This IE shall be present if PWS or TSS related N2 information is to be transferred, or during the AMF planned removal procedure with UDSF deployed procedure to transfer a RAN N2 message. When present, it shall indicate the NGAP Message type of the ngapData as specified in clause 6.1.6.4.3.3. Its value equals the value of the Procedure Code defined in ASN.1 in clause 9.4.7 in 3GPP TS 38.413 [12]. | +| ngapleType | NgapleType | C | 0..1 | This IE shall be present if SM, RAN, V2X, ProSe, Ranging_SL or NRPPa related N2 information is to be transferred. When present, it shall indicate the NGAP IE type of the ngapData as specified in clause 6.1.6.4.3.2. | +| ngapData | RefToBinaryData | M | 1 | This IE reference the N2 Information binary data corresponding to the N2 information class. See clause 6.1.6.4.3. | + +## 6.1.6.2.28 Type: NrppaInformation + +**Table 6.1.6.2.28-1: Definition of type NrppaInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| nflId | NfInstanceId | M | 1 | This IE shall carry the identifier of the Network Function (e.g. LMF) instance that is sending or receiving the NRPPa data. | +| nrppaPdu | N2InfoContent | M | 1 | This IE represents the encoded NGAP NRPPa-PDU IE, which is transparent to AMF. | +| serviceInstanceId | string | O | 0..1 | When present, this IE shall carry the Service Instance Identifier of the Service Instance (e.g. LMF) that is sending or receiving the NRPPa data. | + +6.1.6.2.29 Type: PwsInformation + +**Table 6.1.6.2.29-1: Definition of type PwsInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| messageIdentifier | Uint16 | M | 1 | Identifies the warning message. Sender shall set this field to 0, if the pwsContainer IE carries PWS Failure Indication or PWS Restart Indication. The receiver shall ignore this IE if the pwsContainer IE carries PWS Failure Indication or PWS Restart Indication. | +| serialNumber | Uint16 | M | 1 | identifies a particular message from the source and type indicated by the Message Identifier. Sender shall set this field to 0, if the pwsContainer IE carries PWS Failure Indication or PWS Restart Indication. The receiver shall ignore this IE if the pwsContainer IE carries PWS Failure Indication or PWS Restart Indication. | +| pwsContainer | N2InfoContent | M | 1 | This IE represents the PWS N2 information data part to be relayed between CBCF and AN. | +| bcEmptyAreaList | array(GlobalRanNodeId) | C | 1..N |

This IE shall be present if the NF consumer has previously requested the AMF to send the N2 response information for:

  • - WRITE-REPLACE-WARNING-REQUEST and the AMF has received WRITE-REPLACE-WARNING-RESPONSE from RAN node(s) not including the Broadcast Completed Area List IE, or
  • - PWS-CANCEL-REQUEST and the AMF has received PWS-CANCEL-RESPONSE from RAN node(s) not including the Broadcast Cancelled Area List IE.

When present, this IE shall list the RAN node(s) that has sent a

  • - WRITE-REPLACE-WARNING-RESPONSE not including the Broadcast Completed Area List IE, or
  • - PWS-CANCEL-RESPONSE not including the Broadcast Cancelled Area List IE.
| +| sendRanResponse | boolean | O | 0..1 |

This IE shall be present to request the AMF to send the N2 response information it has received from the RAN nodes to the NF Service Consumer.

When present, this IE shall be set as follows:

  • - true: send RAN response
  • - false (default): do not send RAN response.

The N2 information received from the RAN corresponds to the Broadcast-Completed-Area-List IE or the Broadcast-Cancelled-Area-List IE defined in 3GPP TS 38.413 [12]. See clause 6.1.6.4.3.3.

| +| omcId | OmcIdentifier | O | 0..1 | IE shall be present if the AMF is required to write the n2Information it has received from the RAN nodes into trace records on the OMC. When present, it indicates the identifier of OMC. | +| nflId | NfInstanceId | O | 0..1 |

When present, this IE shall carry the instance identity of the NF Service Consumer (e.g. CBCF or PWS-IWF).

This IE should be included when more than one CBCF/PWS-IWF instances are deployed in the network and the sendRanResponse IE is present with the value "true". The AMF may use this IE to identify whether the same CBCF/PWS-IWF instance

| + +| | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------| +| | | | | has subscribed for N2 PWS information to receive the PWS Response data from the RAN. | +|--|--|--|--|--------------------------------------------------------------------------------------| + +6.1.6.2.30 Type: N1N2MsgTxfrFailureNotification + +**Table 6.1.6.2.30-1: Definition of type N1N2MsgTxfrFailureNotification** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cause | N1N2MessageTransferCause | M | 1 | This IE shall provide the result of the N1/N2 message transfer at the AMF. | +| n1n2MsgDataUri | Uri | M | 1 |

This IE shall contain the N1N2MessageTransfer request resource URI returned in the Location header when the N1/N2 message transfer was initiated (see clause 6.1.3.5.3.1).

This IE shall be used by the NF Service Consumer to correlate the notification with the UE or session for which the earlier N1/N2 message transfer was initiated.

If no Location header was returned when the N1/N2 message transfer was initiated, e.g. when a 200 OK response was sent for a UE in RRC inactive state, this IE shall be set to a dummy URI, i.e. an URI with no authority and an empty path (e.g. "http://").

| +| retryAfter | Uinteger | O | 0..1 |

This IE may be included if the AMF requests the NF Service Consumer to throttle sending further N1/N2 Message Transfer request for a short period, e.g. when UE is not responding to paging.

When present, this IE indicates the period in number of seconds. The NF consumer should not send new N1/N2 message transfer request during the indicated period.

(NOTE)

| + +NOTE: This IE should be configured with a value less than 10 minutes, i.e. 600 seconds. + +6.1.6.2.31 Type: N1N2MessageTransferError + +**Table 6.1.6.2.31-1: Definition of type N1N2MessageTransferError** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------------|---|-------------|---------------------------------------------------------------------------------------| +| error | ProblemDetails | M | 1 | This IE shall provide the result of the N1/N2 message transfer processing at the AMF. | +| errInfo | N1N2MsgTxfrErrDetail | O | 0..1 | This IE may be included to provide additional information related to the error. | + +## 6.1.6.2.32 Type: N1N2MsgTxfrErrDetail + +Table 6.1.6.2.32-1: Definition of type N1N2MsgTxfrErrDetail + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| retryAfter | UInteger | O | 0..1 | This IE may be included if the AMF requests the NF Service Consumer to stop sending the N1/N2 message before timeout, and to retry the N1/N2 message transfer request that was rejected after a timeout. The value shall be in seconds.

When included, the value shall be set to an estimate of the AMF on how long it will take before the AMF considers paging procedure as completed.
(NOTE) | +| highestPrioArp | Arp | O | 0..1 | This IE may be included if the "cause" attribute in the ProblemDetails is set to "HIGHER_PRIORITY_REQUEST_ONGOING". When included this IE shall contain the ARP value of the highest priority QoS flow for which currently paging is ongoing.
The NF Service Consumer shall not initiate an Namf_Communication_N1N2MessageTransfer operation for the same UE with an ARP value having a lower priority than this or the same priority as this, until the retryAfter timer expires. | +| maxWaitingTime | DurationSec | C | 0..1 | This IE shall be present when:
- extBufSupport attribute with value "true" received in the request; and
- the UE is not reachable due to the UE in MICO mode or the UE using extended idle mode DRX.

When present, this IE shall indicate the estimated maximum waiting time in seconds before the UE will be reachable.

If the UE is in MICO mode, the AMF determines the Estimated Maximum Wait time based on the next expected periodic registration by the UE or by implementation. If the UE is using extended idle mode DRX, the AMF determines the Estimated Maximum Wait time based on the start of the next Paging Time Window.

(see clause 4.25.5 of 3GPP 23.502 [3]) | + +NOTE: This IE should be configured with a value less than 10 minutes, i.e. 600 seconds. + +## 6.1.6.2.33 Type: N2InformationTransferRspData + +Table 6.1.6.2.33-1: Definition of type N2InformationTransferRspData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| result | N2InformationTransferResult | M | 1 | This IE shall provide the result of the N2 information transfer processing at the AMF. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| pwsRspData | PWSResponseData | C | 0..1 | This IE shall be present if the n2InformationClass is "PWS" in N2InformationTransferReqData. | + +6.1.6.2.34 Type: MmContext + +**Table 6.1.6.2.34-1: Definition of type MmContext** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| accessType | AccessType | M | 1 | This IE shall contain the access type of the MM context. | | +| nasSecurityMode | NasSecurityMode | C | 0..1 | This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the used NAS security mode of the UE. | | +| epsNasSecurityMode | EpsNasSecurityMode | C | 0..1 | This IE shall be present in 3GPP access MM context if selected EPS NAS security algorithms have been previously provided to the UE, as specified in clause 6.7.2 of 3GPP TS 33.501 [27].

When present, this IE shall contain the selected EPS NAS security algorithms provided to the UE. | | +| nasDownlinkCount | NasCount | C | 0..1 | This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the NAS downlink count of the UE. | | +| nasUplinkCount | NasCount | C | 0..1 | This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the NAS uplink count of the UE. | | +| ueSecurityCapability | UeSecurityCapability | C | 0..1 | This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the UE security capability | | +| s1UeNetworkCapability | S1UeNetworkCapability | C | 0..1 | This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the S1 UE network capabilities. | | +| allowedNssai | array(Snssai) | C | 1..N | This IE shall be present if the source AMF and the target AMF are in the same PLMN and if available. When present, this IE shall contain the allowed NSSAI for the access type. | | +| nssaiMappingList | array(NssaiMapping) | C | 1..N | This IE shall be present if the source AMF and the target AMF are in the same PLMN and if available. When present, this IE shall contain the mapping of the allowed NSSAI and if available the partially allowed NSSAI for the UE. | | +| allowedHomeNssai | array(Snssai) | C | 1..N | This IE shall be present if the source AMF and the target AMF are in different PLMNs and if available. When present, this IE shall contain the home S-NSSAIs corresponding to the allowed NSSAI and if available the partially allowed NSSAI for the access type. | | +| partiallyAllowedNssai | array(PartiallyAllowedSnssai) | C | 1..N | This IE shall be present if the source and target AMF supports the partially allowed S-NSSAI feature and if the source AMF and target AMF pertain to the same PLMN.
When present, this IE shall contain the partially allowed S-NSSAI list and the TAI list where the S-NSSAI(s) are allowed.
See 3GPP TS 23.502 [3] clause 4.2.2.2.2. | PAR-NS | +| nsInstanceList | array(Nsild) | C | 1..N | This IE shall be present if available. When present, it shall indicate the Network Slice Instances selected for the UE. | | +| expectedUEbehavior | ExpectedUeBehavior | C | 0..1 | This IE shall be present if available. When present it shall indicate the expected UE moving trajectory and its validity period. See 3GPP TS 23.502 [3] clause 4.15.6.3. | | +| ueDifferentiationInfo | UeDifferentiationInfo | C | 0..1 | This IE shall be present if available. When present it shall indicate UE Differentiation Information and its validity period. | | +| plmnAssiUeRadioCapId | PlmnAssiUeRadioCapId | C | 0..1 | This IE shall be present if the source AMF supports RACS feature and if available. When present it shall be the PLMN-assigned UE Radio Capability ID.
(NOTE 1) | | +| manAssiUeRadioCapId | ManAssiUeRadioCapId | C | 0..1 | This IE shall be present if the source AMF supports RACS feature and if available. When present it shall be the Manufacturer-assigned UE | | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | Radio Capability ID. | | +| ucmfDicEntryId | string | C | 0..1 | This IE shall be present if the source AMF supports RACS feature and if available. When present it shall be the UCMF allocated dicEntryId received from the UCMF. | | +| n3iwfId | GlobalRanNodeId | C | 0..1 | This IE shall be present during Registration procedure with AMF changes as specified in clause 4.2.2.2 of 3GPP TS 23.502 [3] and inter AMF handover procedure, if the old AMF holds UE context established via N3IWF and if the PDU sessions associated with the non-3GPP access are transferred to the new AMF (see clause 5.2.2.2.1.1 and 5.2.2.2.3.1). When present, this IE shall contain the Global RAN Node ID of N3IWF. | | +| wagfId | GlobalRanNodeId | C | 0..1 | This IE shall be present during Registration procedure with AMF changes as specified in clause 4.2.2.2 of 3GPP TS 23.502 [3] and inter AMF handover procedure, if the old AMF holds UE context established via W-AGF and if the PDU sessions associated with the non-3GPP access are transferred to the new AMF (see clause 5.2.2.2.1.1 and 5.2.2.2.3.1). When present, this IE shall contain the Global RAN Node ID of W-AGF. | | +| tngfId | GlobalRanNodeId | C | 0..1 | This IE shall be present during Registration procedure with AMF changes as specified in clause 4.2.2.2 of 3GPP TS 23.502 [3] and inter AMF handover procedure, if the old AMF holds UE context established via TNGF and if the PDU sessions associated with the non-3GPP access are transferred to the new AMF (see clause 5.2.2.2.1.1 and 5.2.2.2.3.1). When present, this IE shall contain the Global RAN Node ID of TNGF. | | +| anN2ApId | integer | C | 0..1 | This IE shall be present during Registration procedure with AMF changes, as specified in clause 4.2.2.2 of 3GPP TS 23.502 [3] and inter AMF handover procedure, if the old AMF holds UE context established via N3IWF/W-AGF/TNGF and the UE is in CM-CONNECTED state via N3IWF/W-AGF/TNGF and if the PDU sessions associated with the non-3GPP access are transferred to the new AMF (see clause 5.2.2.2.1.1 and 5.2.2.2.3.1). When present, this IE shall contain the RAN UE NGAP ID over N2 interface. | | +| nssaaStatusList | array(NssaaStatus) | C | 1..N | This IE shall be present if available. When present, it shall contain the subscribed S-NSSAIs subject to NSSAA procedure and for which a status information is available. See 3GPP TS 23.501 [2] clause 5.15.5.2.1 and 3GPP TS 23.502 [3] clause 5.2.2.2.2. | | +| pendingNssaiMappingList | array(NssaiMapping) | C | 1..N | This IE shall be present if available. When present, this IE shall contain the mapping of the pending NSSAI for the UE. | | +| uuamMmStatus | UuamMmStatus | C | 0..1 | This IE shall be present if available in 3GPP access MM context. When present, this IE shall indicate the status of UUAM-MM if the AMF is configured to perform the UAV authentication/authorization at 5GS registration as described in clause 5.2.2 of 3GPP TS 23.256 [56]. | | +| NOTE 1: If the AMF supports RACS and the AMF detects that the selected PLMN during a service request procedure is different from the currently registered PLMN for the UE, the AMF stores the UE Radio Capability ID of the newly selected PLMN in the UE context as described in clause 5.2.3.2 of 3GPP TS 23.502 [3], and provides this UE Radio Capability ID to the target AMF during any subsequent inter-AMF mobility. | | | | | | + +Editor's note: It is FFS whether and how to address a partially allowed S-NSSAI upon inter-AMF mobility in a same PLMN when the source AMF would support partially allowed S-NSSAIs but the target AMF would not, e.g. whether the Source AMF should in such a case send the partially allowed S-NSSAI in the allowedNssai IE. + +6.1.6.2.35 Type: SeafData + +Table 6.1.6.2.35-1: Definition of type SeafData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ngKsi | NgKsi | M | 1 | Indicates the KSI used for the derivation of the keyAmf sent. | +| keyAmf | KeyAmf | M | 1 | Indicates the $K_{amf}$ or $K'_{amf}$ | +| nh | string | C | 0..1 | This IE shall be present during N2 handover procedure as specified in clause 6.9.2.3.3 of 3GPP TS 33.501 [27]. When present, this IE indicates the Next Hop value used for the key derivation. The value is encoded as a string of hexadecimal characters.
Pattern: '^[A-Fa-f0-9]+\$' | +| ncc | integer | C | 0..1 | This IE shall be present during N2 handover procedure as specified in clause 6.9.2.3.3 of 3GPP TS 33.501 [27]. When present, this IE indicates the NH Chaining Counter. The value is within the range 0 to 7. | +| keyAmfChangeInd | boolean | C | 0..1 | This IE shall be included, with a value "true", if the source AMF requires the target AMF to perform AS key re-keying, during N2 handover procedure as specified in clause 6.9.2.3.3 of 3GPP TS 33.501 [27]. | +| keyAmfHDerivationInd | boolean | C | 0..1 | This IE shall be included, with a value "true", if the source AMF has performed horizontal $K_{AMF}$ derivation, which means a new $K_{AMF}$ has been calculated. | + +6.1.6.2.36 Type: NasSecurityMode + +Table 6.1.6.2.36-1: Definition of type NasSecurityMode + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|----------------------------------------------| +| integrityAlgorithm | IntegrityAlgorithm | M | 1 | Indicates the integrity protection algorithm | +| cipheringAlgorithm | CipheringAlgorithm | M | 1 | Indicates the ciphering algorithm | + +## 6.1.6.2.37 Type: PduSessionContext + +**Table 6.1.6.2.37-1: Definition of type PduSessionContext** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduSessionId | PduSessionId | M | 1 | Indicates the identifier of the PDU Session. | | +| smContextRef | Uri | M | 1 | Indicates the resource URI of the SM context, including the apiRoot (see clause 6.1.3.3.2 of 3GPP TS 29.502 [16]).

When present, it shall carry the URI of SM Context of:
- I-SMF, for a PDU session with I-SMF; or
- V-SMF, for HR PDU session; or
- SMF, for non-roaming PDU session without I-SMF, or LBO roaming PDU session; | | +| sNssai | Snssai | M | 1 | Indicates the associated S-NSSAI for the PDU Session. It shall be the S-NSSAI in HPLMN in non-roaming, LBO roaming or HR roaming. | | +| additionalSnssai | Snssai | C | 0..1 | This IE shall be present in intra-VPLMN mobility of LBO roaming and HR roaming.
When present, this IE shall indicate the associated S-NSSAI in VPLMN for the PDU Session. | | +| dnn | Dnn | M | 1 | This IE shall indicate the Data Network Name. The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. | | +| selectedDnn | Dnn | C | 0..1 | This IE shall be present, if another DNN other than the UE requested DNN is selected for this PDU session. When present, it shall contain the selected DNN. The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. | | +| accessType | AccessType | M | 1 | Indicates the access type of the PDU session. | | +| additionalAccessType | AccessType | C | 0..1 | Indicates the additional access type for a MA PDU session, if the UE registers to both 3GPP access and Non-3GPP access. | | +| allocatedEbiList | array(EbiArpMapping) | C | 1..N | This IE shall be present when at least one EBI is allocated to the PDU session.

When present, this IE shall contain the EBIs currently allocated to the PDU session. | | +| hsmfld | NfInstanceId | C | 0..1 | This IE shall be present for non-roaming and home-routed PDU sessions.

When present, it shall indicate the associated: | | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | - home SMF for HR PDU Session, or
- SMF, for non-roaming PDU session,
regardless of whether an I-SMF is
involved or not. | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|----------------------|-----------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| hsmfSetId | NfSetId | C | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the NF Set ID of the home SMF or the SMF indicated by hsmfId. | | +| hsmfServiceSetId | NfServiceSetId | C | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the NF Service Set ID of the selected PDUSession service instance of home SMF or the SMF indicated by hsmfId. | | +| smfBinding | SbiBindingLevel | C | 0..1 | This IE shall be present if available, for a non-roaming PDU session. When present, this IE shall contain the SBI binding level of the SMF's SM context resource. | | +| vsmfId | NfInstanceId | C | 0..1 | This IE shall be present for roaming PDU sessions. When present, it shall indicate the associated visited SMF for home-routed the PDU Session, or the SMF for the local-breakout PDU session (regardless of whether an I-SMF is involved or not). | | +| vsmfSetId | NfSetId | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the NF Set ID of the V-SMF. | | +| vsmfServiceSetId | NfServiceSetId | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the NF Service Set ID of the V-SMF's PDUSession service instance. | | +| vsmfBinding | SbiBindingLevel | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the SBI binding level of the V-SMF's SM context resource. | | +| ismfId | NfInstanceId | C | 0..1 | This IE shall be present if I-SMF is involved in the PDU session. When present, it shall indicate the associated I-SMF for the PDU Session. | DTSSA | +| ismfSetId | NfSetId | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the NF Set ID of the I-SMF. | DTSSA | +| ismfServiceSetId | NfServiceSetId | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the NF Service Set ID of the I-SMF's PDUSession service instance. | DTSSA | +| ismfBinding | SbiBindingLevel | C | 0..1 | This IE shall be present if available. When present, this IE shall contain the SBI binding level of the I-SMF's SM Context resource. | DTSSA | +| nsInstance | NsId | C | 0..1 | This IE shall be present if available. When present, this IE shall Indicate Network Slice Instance for the PDU Session | | +| smfServiceInstanceId | string | O | 0..1 | When present, this IE shall contain the serviceInstanceId of the SMF PDUSession service instance serving the SM Context, i.e. of:
  • - the I-SMF, for a PDU session with I-SMF;
  • - the V-SMF, for a HR PDU session; or
  • - the SMF, for a non-roaming or an LBO roaming PDU session without I-SMF.
| | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | This IE may be used by the AMF to identify PDU session contexts affected by a failure or restart of the SMF service instance (see clause 6.2 of 3GPP TS 23.527 [33]). | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------|-------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| maPduSession | boolean | C | 0..1 | This IE shall be present if available.
When present, this IE shall indicate whether it is an MA PDU session.

true: indicates the PDU session is MA PDU session;
false (default): the PDU session is not MA PDU session. | | +| cnAssistedRanPara | CnAssistedRanPara | C | 0..1 | This IE shall be present if available.

When present, this IE shall contain the PDU Session specific parameters received from the SMF and used by the AMF to derive the Core Network assisted RAN parameters tuning. | | +| nrfManagementUri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the NFManagement Service (see clause 6.1.1 of 3GPP TS 29.510 [29]) of the NRF or hNRF.

It shall be present if it is returned from the NSSF or hNSSF (see clause 6.1.6.2.7 of 3GPP TS 29.531 [18]). | | +| nrfDiscoveryUri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the NFDiscovery Service (see clause 6.2.1 of 3GPP TS 29.510 [29]) of the NRF or hNRF.

It shall be present if it is returned from the NSSF or hNSSF (see clause 6.1.6.2.7 of 3GPP TS 29.531 [18]). | | +| nrfAccessTokenUri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the Access Token Service (see clause 6.3.2 of 3GPP TS 29.510 [29]) of the NRF or hNRF.

It shall be present if it is returned from the NSSF or hNSSF (see clause 6.1.6.2.7 of 3GPP TS 29.531 [18]). | | +| smfBindingInfo | string | C | 0..1 | This IE shall be present if available, for a non-roaming PDU session. When present, this IE shall contain the Binding indications of the SMF's SM context resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | | +| vsmfBindingInfo | string | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the Binding indications of the V-SMF's SM context resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | | +| ismfBindingInfo | string | C | 0..1 | This IE shall be present if available. When present, this IE shall contain the Binding indications of the I-SMF's SM Context resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | DTSSA | +| interPlmnApiRoot | Uri | C | 0..1 | This IE shall be present if this information is available.
When present, it shall contain the | | + +| | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | apiRoot of the SM context to be used in inter-PLMN signalling request targeting the SM context.
(NOTE) | | +| pgwFqdn | Fqdn | O | 0..1 | FQDN of the PGW in the PGW-C+SMF, to be included for interworking with EPS. | | +| pgwIpAddr | IpAddress | O | 0..1 | IP Address of the PGW in the PGW-C+SMF, to be included for interworking with EPS. | | +| plmnId | PlmnId | O | 0..1 | PLMN where the PGW-C+SMF is located. | | +| anchorSmfSupported Features | SupportedFeatures | O | 0..1 | When present, this IE shall include the features of the Nsmf_PDUSession service (see clause 6.1.8 of 3GPP TS 29.502 [16]) that are supported by the H-SMF (or the SMF for a PDU sessions with I-SMF).
(NOTE 2) | | +| anchorSmfOauth2Required | boolean | O | 0..1 | This IE may be present when new AMF and old AMF belong to the same PLMN.

When present, this IE shall indicate whether the H-SMF (or the SMF for a PDU session with I-SMF) requires Oauth2-based authorization for accessing its Nsmf_PDUSession service

- true: OAuth2 based authorization is required.
- false: OAuth2 based authorization is not required.

The absence of this IE means that no indication is available about the usage of Oauth2 for authorization of the anchor SMF's Nsmf_PDUSession service. | | +| hrsboAllowedInd | boolean | C | 0..1 | This IE shall be present during an intra-PLMN N2 handover, if this information is available (see clause 6.7.2.6 of 3GPP TS 23.548 [58]).

When present, it shall indicate whether HR-SBO is allowed for the PDU session and it shall be set as follows:
- true: HR-SBO is allowed
- false: HR-SBO is not allowed

The absence of this IE shall not be interpreted as meaning that HR-SBO is allowed or not allowed. | | +| NOTE 1: During an inter-PLMN mobility, the target AMF shall replace the apiRoot of the smContextRef with the interPlmnApiRoot if available and send the resulting smContextRef in the Create SM Context request towards the target V-SMF, I-SMF or anchor SMF. See 3GPP TS 29.502 [16]. | | | | | | +| NOTE 2: The new AMF may use this IE to know the supported features of the H-SMF (or the SMF for a PDU session with I-SMF) and take action based on the supported features, e.g. the new AMF shall release the PDU session when V-SMF needs to be changed but the H-SMF does not support V-SMF change. | | | | | | + +## 6.1.6.2.38 Type: NssaiMapping + +Table 6.1.6.2.38-1: Definition of type NssaiMapping + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------| +| mappedSnssai | Snssai | M | 1 | Indicates the mapped S-NSSAI in the serving PLMN | +| hSnssai | Snssai | M | 1 | Indicates the S-NSSAI in home PLMN | + +## 6.1.6.2.39 Type: UeRegStatusUpdateReqData + +Table 6.1.6.2.39-1: Definition of type UeRegStatusUpdateReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| transferStatus | UeContextTransferStatus | M | 1 | This IE shall indicate if the previous UE context transfer was completed. | | +| toReleaseSessionList | array(PduSessionId) | C | 1..N | This IE shall be present during UE Context Transfer procedure, if there are any PDU session(s) associated with Network Slice(s) which become no longer available.

When present, this IE shall include all the PDU session(s) associated with no longer available S-NSSAI(s). | | +| pcfReselectedInd | boolean | C | 0..1 | This IE shall be present and set to true if the target AMF has decided to select a new PCF for AM Policy and/or UE Policy other than the one which was included in the UeContext by the old AMF.

When present, it shall be set as follows:
- true: the target AMF has selected new PCF(s) other than the one which was included in the UeContext by the old AMF for AM Policy and/or UE Policy. | | +| smfChangeInfoList | array(SmfChangeInfo) | C | 1..N | This IE shall be present during an inter-AMF registration procedure, if there is an I-SMF or V-SMF change or removal for the related PDU session(s).

When present, this IE shall indicate the I-SMF/V-SMF situation after the registration completion at the target AMF. | DTSSA | +| analyticsNotUsedList | array(Uri) | C | 1..N | This IE shall be present to include the list of resource URIs of the analytics subscription(s) that are not taken over in the target AMF. | | +| toReleaseSessionInfo | array(ReleaseSessionInfo) | C | 1..N | This IE shall be present during UE Context Transfer procedure, if there are any PDU session(s) that cannot be supported in the target AMF for a reason other than no longer available S-NSSAI(s) as specified in step 1 of clause 5.2.2.2.2.1.

When present, this IE shall include list of the PDU session(s) and the release cause. | | + +## 6.1.6.2.40 Type: AssignEbiError + +**Table 6.1.6.2.40-1: Definition of type AssignEbiError** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------| +| error | ProblemDetails | M | 1 | Represents the application error information. The application level error cause shall be encoded in the "cause" attribute. | +| failureDetails | AssignEbiFailed | M | 1 | Describes the details of the failure including the list of ARPs for which the EBI assignment failed. | + +## 6.1.6.2.41 Type: UeContextCreateData + +**Table 6.1.6.2.41-1: Definition of type UeContextCreateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueContext | UeContext | M | 1 | Represents an individual ueContext resource to be created | | +| targetId | NgRanTargetId | M | 1 | Represents the identification of target RAN | | +| sourceToTargetData | N2InfoContent | M | 1 | This IE shall be included to contain the "Source to Target Transparent Container". | | +| pduSessionList | array(N2SmInformation) | M | 1..N | This IE shall be included to contain the list of N2SmInformation, where each N2SmInformation includes the "Handover Required Transfer" received from the source RAN per PDU session ID. | | +| n2NotifyUri | Uri | M | 1 | This IE shall contain a callback URI to receive the N2 Information Notification. | | +| ueRadioCapability | N2InfoContent | C | 0..1 | This IE shall be included to contain the "UE Radio Capability Information" if available.
(NOTE) | | +| ueRadio_capabilityForPaging | N2InfoContent | C | 0..1 | This IE shall be included to contain the "UE Radio Capability for Paging" if available.
(NOTE) | | +| ngapCause | NgApCause | C | 0..1 | This IE shall be present, if available. When present, it shall represent the NGAP Cause received from RAN. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | +| servingNetwork | PlmnIdNid | C | 0..1 | A Source AMF complying with this release of the specification shall include this IE to indicate the current Serving Network.
When present, this IE shall contain the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN. | | + +NOTE: The source AMF may decide to not include ueRadio\_capability and ueRadio\_capabilityForPaging if the target AMF supports the RACS feature and if: +a. the PlmnAssiUeRadioCapId is included in the MM Context for an intra-PLMN AMF mobility procedure; +or +b. the ManAssiUeRadioCapId is included in the MM Context for an intra-PLMN or an inter-PLMN AMF mobility procedure. + +## 6.1.6.2.42 Type: UeContextCreatedData + +Table 6.1.6.2.42-1: Definition of type UeContextCreatedData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ueContext | UeContext | M | 1 | Represents the newly created individual ueContext resource | +| targetToSourceData | N2InfoContent | M | 1 | This IE shall contain the "Target to Source Transparent Container". | +| pduSessionList | array(N2SmInformation) | M | 1..N | This IE shall be included to contain the list of N2SmInformation, where each N2SmInformation includes the "Handover Command Transfer" received from the SMF, per PDU session ID. | +| pcfReselectedInd | boolean | C | 0..1 | This IE shall be present and set to true if the target AMF has decided to select a new PCF for AM Policy and/or UE Policy other than the one which was included in the UeContext by the old AMF.

When present, it shall be set as follows:
- true: the target AMF has selected a new PCF other than the one which was included in the UeContext by the old AMF for AM Policy and/or UE Policy. | +| failedSessionList | array(N2SmInformation) | C | 1..N | This IE shall be included to contain a list of N2SmInformation, where each N2SmInformation includes the "Handover Preparation Unsuccessful Transfer" N2 SM content either received from the SMF for a PDU session failed to be handed over or generated by the target AMF for a PDU session not accepted by the target AMF (e.g. due to no response from the SMF within a maximum wait timer or due to non-available S-NSSAI in the target AMF). See NOTE. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| analyticsNotUsedList | array(Uri) | C | 1..N | This IE shall be present to include the list of resource URIs of the analytics subscription(s) that are not taken over in the target AMF. | + +NOTE: As an exception, the AMF generates N2 SM Information (Handover Preparation Unsuccessful Transfer IE) for a PDU session not accepted by the AMF, since this N2 SM IE needs to be included in the Handover Command sent by the source AMF to the source NG-RAN; this N2 SM IE carries a Cause value. + +## 6.1.6.2.43 Type: UeContextCreateError + +Table 6.1.6.2.43-1: Definition of type UeContextCreateError + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| error | ProblemDetails | M | 1 | Represents the detailed application error information. The application level error cause shall be encoded in the "cause" attribute. | | +| ngapCause | NgApCause | C | 0..1 | This IE shall be present, if available. When present, it shall represent the NGAP Cause received from RAN. | | +| targetToSourceFailureData | N2InfoContent | C | 0..1 | This IE shall be present if a "Target to Source Failure Transparent Container" has been received from the target NG-RAN. When present, this IE shall contain this container. | NPN | + +## 6.1.6.2.44 Type: NgRanTargetId + +**Table 6.1.6.2.44-1: Definition of type NgRanTargetId** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------| +| ranNodeId | GlobalRanNodeId | M | 1 | Indicates the identity of the RAN node. The IE shall contain either the gNB ID or the NG-eNB ID. | +| tai | Tai | M | 1 | Indicates the selected TAI. | + +## 6.1.6.2.45 Type: N2InformationTransferError + +**Table 6.1.6.2.45-1: Definition of type N2InformationTransferError** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|-------------------------------------------------------------------------------------------------------------| +| error | ProblemDetails | M | 1 | More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure. | +| pwsErrorInfo | PWSErrorData | C | 0..1 | This IE shall be present if the n2InformationClass is "PWS" in N2InformationTransferReqData. | + +## 6.1.6.2.46 Type: PWSResponseData + +**Table 6.1.6.2.46-1: Definition of type PWSResponseData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ngapMessageType | UInteger | M | 1 | This IE shall identify the message type of the message being sent. Its value is the numeric code of the Procedure Code defined in ASN.1 in clause 9.4.7 in 3GPP TS 38.413 [12]. | +| serialNumber | UInt16 | M | 1 | This IE shall contain the Serial Number of the associated PWS response message. | +| messageIdentifier | integer | M | 1 | This IE shall contain the Message Identifier of the associated PWS response message. | +| unknownTAIList | array(Tai) | O | 1..N | This IE shall contain the Unknown Tracking Area List which may be present in the associated PWS response message. | +| n2PwsSubMissInd | boolean | C | 0..1 | This IE should be present when sendRanResponse IE with the value true is included in the request, i.e. the RAN responses are expected to be notified to the NF service consumer (i.e. the sender CBCF or PWS-IWF), and the corresponding N2 information subscription subscription is not available in the AMF.

When present, this IE shall be set as following:
- true: Corresponding N2 information subscription to receive the requested RAN responses is missing in the AMF. | + +## 6.1.6.2.47 Type: PWSErrorData + +Table 6.1.6.2.47-1: Definition of type PWSErrorData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| namfCause | integer | M | 1 | Represents the cause value for the error that the AMF detected.
Cause values:
0 - Message accepted
1 - Parameter not recognised
2 - Parameter value invalid
3 - Valid message not identified
4 - Tracking area not valid
5 - Unrecognised message
6 - Missing mandatory element
7 - AMF capacity exceeded
8 - AMF memory exceeded
9 - Warning broadcast not supported
10 - Warning broadcast not operational
11 - Message reference already used
12 - Unspecified error
13 - Transfer syntax error
14 - Semantic error
15 - Message not compatible with receiver state | + +## 6.1.6.2.48 Void + +## 6.1.6.2.49 Type: NgKsi + +Table 6.1.6.2.49-1: Definition of type NgKsi + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------| +| tsc | ScType | M | 1 | Indicates whether the security context type is native or mapped. | +| ksi | integer | M | 1 | Indicates the key set identifier value. The value is within the range 0 to 6. | + +## 6.1.6.2.50 Type: KeyAmf + +Table 6.1.6.2.50-1: Definition of type KeyAmf + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|---------------------------------------------------------------------------------------------------------------------| +| keyType | KeyAmfType | M | 1 | Indicates whether the keyAmf represents $K_{amf}$ or $K'_{amf}$ . | +| keyVal | string | M | 1 | Indicates the key value. The key value is encoded as a string of hexadecimal characters.
Pattern: '[A-Fa-f0-9]{' | + +## 6.1.6.2.51 Type: ExpectedUeBehavior + +Table 6.1.6.2.51-1: Definition of type ExpectedUeBehavior + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|---------------------|---|-------------|---------------------------------------------------------------------------------------| +| expMoveTrajectory | array(UserLocation) | M | 1..N | This IE shall contain a list of user location areas where the UE is expected to move. | +| validityTime | DateTime | M | 1 | This IE shall contain the UTC time upto which the UE moving trajectory is valid. | + +## 6.1.6.2.52 Type: UeRegStatusUpdateRspData + +**Table 6.1.6.2.52-1: Definition of type UeRegStatusUpdateRspData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| regStatusTransferComplete | boolean | M | 1 | This IE shall indicate if the status update of UE context transfer is completed successfully at the source AMF or not.
The value shall be set to true if the context transfer is completed successfully and false if the context transfer did not complete successfully. | + +## 6.1.6.2.53 Type: N2RanInformation + +**Table 6.1.6.2.53-1: Definition of type N2RanInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|-----------------------------------------------------------| +| n2InfoContent | N2InfoContent | M | 1 | This IE shall contain the N2 RAN information to transfer. | + +## 6.1.6.2.54 Type: N2InfoNotificationRspData + +**Table 6.1.6.2.54-1: Definition of type N2InfoNotificationRspData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| secRatDataUsageList | array(N2SmInformation) | C | 1..N | This IE shall be present in the N2InfoNotify response sent by the source AMF to the target AMF during an Inter NG-RAN node N2 based handover procedure (see clause 5.2.2.3.6.2), if Secondary Rat Usage Data are available at the source AMF for one or more PDU sessions.

When present, this IE shall contain a list of N2SmInformation, where each N2SmInformation includes the "Secondary RAT Data Usage Report Transfer" information received from the source RAN for a given PDU session.

The sNssai IE and subjectToHo IE shall not be included in N2SmInformation. | + +## 6.1.6.2.55 Type: SmallDataRateStatusInfo + +**Table 6.1.6.2.55-1: Definition of type SmallDataRateStatusInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| singleNssai | Snssai | M | 1 | S-NSSAI | +| dnn | Dnn | M | 1 | This IE shall indicate the Data Network Name. The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. | +| smallDataRateStatus | SmallDataRateStatus | M | 1 | Small data rate status related to the S-NSSAI and Dnn. | + +## 6.1.6.2.56 Type: SmfChangeInfo + +**Table 6.1.6.2.56-1: Definition of type SmfChangeInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|---------------------|---|-------------|-------------------------------------------------------| +| pduSessionIdList | array(PduSessionId) | M | 1..N | PDU Session ID(s) for which the smfChangeInd applies. | +| smfChangeInd | SmfChangeIndication | M | 1 | Indicates the I-SMF or V-SMF change or removal. | + +## 6.1.6.2.57 Type: V2xContext + +**Table 6.1.6.2.57-1: Definition of type V2xContext** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nrV2xServicesAuth | NrV2xAuth | C | 0..1 | This IE shall be present if the UE is authorized to use the NR sidelink for V2X services. | +| lteV2xServicesAuth | LteV2xAuth | C | 0..1 | This IE shall be present if the UE is authorized to use the LTE sidelink for V2X services. | +| nrUeSidelinkAmbr | BitRate | C | 0..1 | This IE shall be present if the UE is authorized for NR V2X services.
When present, this IE contains subscription data on UE-PC5-AMBR for NR V2X services. | +| lteUeSidelinkAmbr | BitRate | C | 0..1 | This IE shall be present if the UE is authorized for LTE V2X services.
When present, this IE contains subscription data on UE-PC5-AMBR for LTE V2X services. | +| pc5QoSPara | Pc5QoSPara | C | 0..1 | This IE shall be present if the UE is authorized for NR V2X services.
When present, this IE contains policy data on the PC5 QoS parameters. | + +6.1.6.2.58 Type: ImmediateMdtConf + +**Table 6.1.6.2.58-1: Definition of type ImmediateMdtConf** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| jobType | JobType | M | 1 | This IE shall indicate the Job type for MDT, see 3GPP TS 32.422 [30]. | +| measurementLteList | array(MeasurementLteForMdt) | C | 1..N | This IE shall be present if available. When present, this IE shall contain a list of the measurements that shall be collected for LTE. | +| measurementNrList | array(MeasurementNrForMdt) | C | 1..N | This IE shall be present if available, when present, this IE shall contain a list of the measurements that shall be collected for NR. | +| reportingTriggerList | array(ReportingTrigger) | C | 1..N | This IE shall be present if available. When present, this IE shall contain a list of the reporting triggers. | +| reportInterval | ReportIntervalMdt | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the interval between the periodical measurements to be taken when UE is in connected in LTE. | +| reportIntervalNr | ReportIntervalNrMdt | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the interval between the periodical measurements to be taken when UE is in connected in NR. | +| reportAmount | ReportAmountMdt | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the number of measurement reports that shall be taken for periodical reporting while UE is in connected. | +| eventThresholdRsrp | integer | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the Event Threshold for RSRP. Minimum = 0. Maximum = 97. | +| eventThresholdRsrq | integer | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the Event Threshold for RSRQ. Minimum = 0. Maximum = 34. | +| eventThresholdRsrpNr | integer | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the Event Threshold for RSRP in NR. Minimum = 0. Maximum = 127. | +| eventThresholdRsrqNr | integer | C | 0..1 | This IE shall be present if available. When present, this IE shall indicate the Event Threshold for RSRQ in NR. Minimum = 0. Maximum = 127. | +| collectionPeriodRmmLte | CollectionPeriodRmmLteMdt | C | 0..1 | This IE shall be present if available. When present, it shall contain the collection period that should be used to collect available measurement samples in case of RRM configured measurements. | +| collectionPeriodRmmNr | CollectionPeriodRmmNrMdt | C | 0..1 | This IE shall be present if available. When present, it shall contain the collection period that should be used to collect available measurement samples in case of RRM configured measurements when UE is in NR. | +| measurementPeriodLte | MeasurementPeriodLteMdt | C | 0..1 | This IE shall be present if available. When present, it shall contain the measurement period that should be used for the Data Volume and Scheduled IP Throughput measurements in LTE. | +| areaScope | AreaScope | O | 0..1 | When present, this IE shall contain the area in Cells or Tracking Areas where the MDT data collection shall take place, see 3GPP TS 32.422 [30]. | +| positioningMethod | PositioningMethodMdt | O | 0..1 | When present, it shall indicate the positioning method that shall be used for the MDT job in LTE. | +| addPositioningMethodList | array(PositioningMethodMdt) | O | 1..N | This IE may be present if positioningMethod IE is present. When present, it shall indicate a list of the additional positioning methods that shall be used for the MDT job | +| mdtAllowedPlmnIdList | array(PlmnId) | O | 1..16 | When present, this IE shall contain the PLMNs related to MDT. | +| sensorMeasurementList | array(SensorMea | C | 1..N | This IE shall be present if available. | + +| | | | | | +|--|-----------|--|--|------------------------------------------------------------------------------------------------------------------------| +| | surement) | | | When present, this IE shall include a list the sensor measurements to be collected for UE in NR if they are available. | +|--|-----------|--|--|------------------------------------------------------------------------------------------------------------------------| + +6.1.6.2.59 Type: V2xInformation + +**Table 6.1.6.2.59-1: Definition of type V2xInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n2Pc5Pol | N2InfoContent | C | 0..1 | This IE shall be present if N2 PC5 policy should be transferred. When present, the IE contains the NGAP V2X related IEs specified in clause 9.3.1.150 of 3GPP TS 38.413 [12]. | + +6.1.6.2.60 Type: EpsNasSecurityMode + +**Table 6.1.6.2.60-1: Definition of type EpsNasSecurityMode** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------------|---|-------------|----------------------------------------------------------| +| integrityAlgorithm | EpsNasIntegrityAlgorithm | M | 1 | Indicates the integrity protection algorithm for EPS NAS | +| cipheringAlgorithm | EpsNasCipheringAlgorithm | M | 1 | Indicates the ciphering algorithm for EPS NAS. | + +6.1.6.2.61 Type: UeContextRelocateData + +**Table 6.1.6.2.61-1: Definition of type UeContextRelocateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueContext | UeContext | M | 1 | Represents an individual ueContext resource to be relocated. | | +| targetId | NgRanTargetId | M | 1 | Represents the identification of target RAN | | +| sourceToTargetData | N2InfoContent | M | 1 | This IE shall be included to contain the "Source to Target Transparent Container". | | +| forwardRelocationRequest | RefToBinaryData | M | 1 | This IE shall be present, and it shall contain the reference to the binary data carrying the Forward Relocation Request message (see clause 6.1.6.4). | | +| pduSessionList | array(N2SmInformation) | C | 1..N | This IE shall contain the list of N2SmInformation, where each N2SmInformation includes a PDU Session Resource Setup Request Transfer IE (see clause 9.3.4.1 of 3GPP TS 38.413 [24]) received from the SMF(s) per PDU session ID. | | +| ueRadioCapability | N2InfoContent | C | 0..1 | This IE shall be included to contain the "UE Radio Capability Information" if available. | | +| ngapCause | NgApCause | C | 0..1 | This IE shall be present, if available. When present, it shall represent the NGAP Cause mapped from the received S1-AP cause from the source E-UTRAN. Refer to 3GPP TS 29.010 [50] for the mapping of cause values between S1AP and NGAP. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | + +## 6.1.6.2.62 Type: UeContextRelocatedData + +Table 6.1.6.2.62-1: Definition of type UeContextRelocatedData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------| +| ueContext | UeContext | M | 1 | Represents an individual ueContext resource relocated to a new AMF. | + +## 6.1.6.2.63 Void + +## 6.1.6.2.64 Type: EcRestrictionDataWb + +Table 6.1.6.2.64-1: Definition of type EcRestrictionData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ecModeARestricted | boolean | O | 0..1 | If present, indicates whether Enhanced Coverage Mode A is restricted or not.
true: Enhanced Coverage Mode A is restricted.
false or absent: Enhanced Coverage Mode A is not restricted. | +| ecModeBRestricted | boolean | M | 1 | This IE indicates whether Enhanced Coverage Mode B is restricted or not.
true: Enhanced Coverage Mode B is restricted.
false: Enhanced Coverage Mode B is not restricted. | + +## 6.1.6.2.65 Type: ExtAmfEventSubscription + +Table 6.1.6.2.65-1: Definition of type ExtAmfEventSubscription as a list of to be combined data types + +| Data type | Cardinality | Description | Applicability | +|-----------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------|---------------| +| AmfEventSubscription | 1 | AMF event subscription | | +| AmfEventSubscriptionAddInfo | 1 | Additional information for the AMF event subscription, e.g. Binding Indications, NF type of the NF that created the subscription. | | + +## 6.1.6.2.66 Type: AmfEventSubscriptionAddInfo + +Table 6.1.6.2.66-1: Definition of type AmfEventSubscriptionAddInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| bindingInfo | array(string) | O | 1..2 |

Binding indications received for event notifications (i.e. with "callback" scope) or for subscription change event notifications (i.e. with "subscription-events" scope) for an AMF event subscription.

When present, entries of the array shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name.

Example of an array entry: "bl= nf-set; nfset=set1.udmset.5gc.mnc012.mcc345; servname=nudm-ee;scope=subscription-events"

| +| subscribingNFType | NFType | C | 0..1 |

This IE should be present if the information is available. When present, it shall contain the NF type of the NF that created the subscription.

(NOTE X)

| +| eventSyncInd | boolean | C | 0..1 |

This IE should be present with value "true" when the event subscription shall be synchronized with UDM during EPS to 5GS mobility registration procedure, as specified in clause 5.3.2.4.2.

When present, this IE shall be set as following:
- true: the event subscription shall be synchronized with UDM.
- false: the event subscription shall not be synchronized with UDM.

| +| nfConsumerInfo | array(string) | C | 1..N |

When present, this IE shall contain the NF Service Consumer information received together with the AMF event subscription and entries of the array shall be set to the value of the 3gpp-Sbi-Consumer-Info header defined in clause 5.2.3.3.7 of 3GPP TS 29.500 [4], without the header name.

| +| aoiStateList | map(AreaOfInterestEventState) | O | 1..N |

Map of subscribed Area of Interest (AoI) Event State in the old AMF.

For the subscribed AoI Event(s), the JSON pointer to an AmfEventArea element in the areaList IE (or a PresenceInfo element in presenceInfoList IE) of the AmfEvent data type (see clause 6.2.6.2.3) shall be the key of the map.

(NOTE 2)

| +| accessToken | string | O | 0..1 |

See clause 13.4.1.4 of 3GPP TS 33.501 [27], and clause 5.2.2.2.1.1 and 5.2.2.2.3.1 for the use of this IE.

When present, this IE shall contain a JWS Compact Serialized representation of the JWS signed JSON object containing AccessTokenClaims (see clause 6.3.5.2.4 of 3GPP TS 29.510 [29]) that was received by the source AMF for authorizing the subscription.

| + +NOTE 1: In scenarios where an "intermediate NF" (e.g. UDM) creates a subscription on behalf of a "source NF" (e.g. NEF), this IE shall contain the NF type of the "intermediate NF". The NF type of the "source NF" may be available in the AmfEventSubscription. + +NOTE 2: The new AMF may use the information to determine whether the UE presence state in the AOI(s) has changed, thus should be reported to the NF consumer. + +## 6.1.6.2.67 Type: UeContextCancelRelocateData + +**Table 6.1.6.2.67-1: Definition of type UeContextCancelRelocateData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supi | Supi | C | 0..1 | This IE shall be present if the UE is emergency registered and the SUPI is not authenticated. | +| relocationCancelRequest | RefToBinaryData | M | 1 | This IE shall be present, and it shall contain the reference to the binary data carrying the GTP-C Relocation Cancel Request message (see clause 6.1.6.4). | + +## 6.1.6.2.68 Type: UeDifferentiationInfo + +**Table 6.1.6.2.68-1: Definition of type UeDifferentiationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| periodicComInd | PeriodicCommunicationIndicator | O | 0..1 | This IE indicates whether the UE communicates periodically or not, e.g. only on demand. | +| periodicTime | DurationSec | O | 0..1 | This IE indicates the interval time of periodic communication (see TS 23.502 [3] clause 4.15.6.3). | +| scheduledComTime | ScheduledCommunicationTime | O | 0..1 | This IE indicates time and day of the week when the UE is available for communication (see TS 23.502 [3] clause 4.15.6.3). | +| stationaryInd | StationaryIndication | O | 0..1 | This IE indicates whether the UE is stationary or mobile (see TS 23.502 [3] clause 4.15.6.3). | +| trafficProfile | TrafficProfile | O | 0..1 | This IE indicates the type of data transmission: single packet transmission (UL or DL), dual packet transmission (UL with subsequent DL or DL with subsequent UL), multiple packets transmission | +| batteryInd | BatteryIndication | O | 0..1 | This IE indicates the power consumption type(s) of the UE (see TS 23.502 [3] clause 4.15.6.3). | +| validityTime | DateTime | O | 0..1 | When present, this IE identifies the UTC time when the expected UE behaviour parameters expire and shall be deleted locally if it expire (see TS 23.502 [3] clause 4.15.6.3).
When absent, no expiry for the expected UE behaviour parameters applies. | + +## 6.1.6.2.69 Type: CeModeBlnd + +**Table 6.1.6.2.69-1: Definition of type CeModeBlnd** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ceModeBSupportInd | boolean | M | 1 | This IE shall contain the CE-mode-B Support Indicator (See 3GPP TS 38.413 [12], clause 9.3.1.156).

This IE shall be set as follows:
- true: CE-mode-B is supported;
- false: CE-mode-B is not supported. | + +## 6.1.6.2.70 Type: LteMInd + +Table 6.1.6.2.70-1: Definition of type LteMInd + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lteCatMInd | boolean | M | 1 | This IE shall contain the LTE-M Indication (See 3GPP TS 38.413 [12], clause 9.3.1.157).

This IE shall be set as follows:
- true: LTE-M is indicated by the UE;
- false: LTE-M is not indicated by the UE. | + +## 6.1.6.2.71 Type: NpnAccessInfo + +Table 6.1.6.2.71-1: Definition of type NpnAccessInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|-----------------------------------------------------| +| cellCagInfo | array(CagId) | O | 1..N | This IE shall contain the CAG List of the CAG cell. | + +## 6.1.6.2.72 Type: ProseContext + +Table 6.1.6.2.72-1: Definition of type ProseContext + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| directDiscovery | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to use the NR sidelink for the ProSe Direct Discovery service. | +| directComm | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to use the NR sidelink for the ProSe Direct Communication service. | +| l2Relay | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-2 UE-to-Network Relay. | +| l3Relay | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-3 UE-to-Network Relay. | +| l2Remote | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-2 Remote UE. | +| l3Remote | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-3 Remote UE. | +| l2UeRelay | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-2 UE-to-UE Relay. | +| l3UeRelay | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-3 UE-to-UE Relay. | +| l2End | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-2 End UE. | +| l3End | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to act as a 5G ProSe Layer-3 End UE. | +| multiPathComm | UeAuth | C | 0..1 | This IE shall be present if the UE is authorized to use multi-path communication via direct Uu path and via 5G ProSe Layer-2 UE-to-Network Relay as a 5G ProSe Layer-2 Remote UE. | +| nrUePc5Ambr | BitRate | C | 0..1 | This IE shall be present if the UE is authorized to use the NR sidelink for the ProSe services. When present, this IE contains the ProSe NR UE-PC5-AMBR. | +| pc5QoSPara | Pc5QoSPara | C | 0..1 | This IE shall be present if the UE is authorized to use the NR sidelink for the ProSe services. When present, this IE contains policy data on the PC5 QoS parameters for the ProSe services on the NR sidelink. | + +## 6.1.6.2.73 Type: AnalyticsSubscription + +**Table 6.2.6.2.73-1: Definition of type AnalyticsSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------| +| nwdafId | NfInstanceId | C | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the NF Instance ID of the NWDAF.
(NOTE). | +| nwdafSetId | NfSetId | C | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the NF Set ID of the NWDAF.
(NOTE). | +| nwdafSubscriptionList | array(NwdafSubscription) | M | 1..N | List of NWDAF subscriptions identified by subscription Id. | +| NOTE: At least one nwdafId or nwdafSetId shall be included. | | | | | + +## 6.1.6.2.74 Type: NwdafSubscription + +**Table 6.2.6.2.74-1: Definition of type NwdafSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|--------------------------|---|-------------|----------------------------------------------------------------------| +| nwdafEvtSubsServiceUri | Uri | M | 1 | It identifies the resource URI of the individual NWDAF subscription. | +| nwdafEventsSubscription | NnwdafEventsSubscription | M | 1 | The created Individual NWDAF Event Subscription resource | + +## 6.1.6.2.75 Type: UpdpSubscriptionData + +**Table 6.1.6.2.75-1: Definition of type UpdpSubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| updpNotifySubscriptionId | string | M | 1 | Represents the Id created by the AMF for the subscription to notify a UE policy delivery related N1 information. | +| updpNotifyCallbackUri | Uri | M | 1 | This IE represents the callback URI on which the UE policy delivery related N1 message shall be notified. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported by the NF service consumer. | +| updpCallbackBinding | string | C | 0..1 | This IE shall be present if Binding Indication was received for the PCF for the callback URI.

When present, this IE shall contain the Binding indication of callback URI and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | + +## 6.1.6.2.76 Type: ProSeInformation + +**Table 6.1.6.2.76-1: Definition of type ProSeInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| n2Pc5ProSePol | N2InfoContent | M | 0..1 | This attribute contains the N2 PC5 policy for 5G ProSe. This IE contains the NGAP ProSe related IEs specified in 3GPP TS 38.413 [12]. | + +## 6.1.6.2.77 Type: ReleaseSessionInfo + +**Table 6.1.6.2.77-1: Definition of type ReleaseSessionInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|---------------------|---|-------------|----------------------------------------------------------------| +| releaseSessionList | array(PduSessionId) | M | 1..N | This IE shall include the PDU session Id(s) to be released. | +| releaseCause | ReleaseCause | M | 1 | This IE shall include the cause to release the PDU session(s). | + +## 6.1.6.2.78 Type: AreaOfInterestEventState + +**Table 6.1.6.2.78-1: Definition of type AreaOfInterestEventState** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| presence | PresenceState | M | 1 | This IE shall contain the UE presence state for the indicated area of interest. | +| individualPraidList | array(string) | C | 1..N | This IE shall be present if the indicated area of interest referring to a set of Core Network predefined Presence Reporting Areas and the UE is in at least one individual PRA within the set of Core Network predefined Presence Reporting Areas.

When present, this IE shall contain the PRA Identifier of the individual PRA(s) where the UE is located. | + +## 6.1.6.2.79 Type: TssInformation + +**Table 6.1.6.2.79-1: Definition of type TssInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nflId | NfInstanceId | C | 0..1 | This IE shall be present when the N2InfoContainer containing the TssInformation is included in N2InformationTransferReqData. When present, this IE shall carry the NF instance identity of the NF Service Consumer (e.g. TSCTSF). | +| tssContainer | N2InfoContent | M | 1 | This IE represents the TSS N2 information data part to be relayed between TSCTSF and AN. | + +## 6.1.6.2.80 Type: AmPolicyInfoContainer + +**Table 6.1.6.2.80-1: Definition of type AmPolicyInfoContainer** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sliceUsgCtrlInfoSets | map(SliceUsageControlInfo) | C | 1..N | This IE shall be present when available.

When present, this IE shall indicate the network slice usage control related information received from PCF of AM Policy.

The key of the map is the S-NSSAI to which the network slice usage control related information (the value part of the map) is related. | + +## 6.1.6.2.8.1 Type: RslpInformation + +Table 6.1.6.2.8.1-1: Definition of type RslpInformation + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n2Pc5RslpPol | N2InfoContent | M | 1 | This attribute contains the N2 PC5 policy for Ranging/SL positioning. This IE contains the Ranging and Sidelink Positioning Service Information specified in 3GPP TS 38.413 [12]. | + +## 6.1.6.2.8.2 Type: A2xContext + +Table 6.1.6.2.8.2-1: Definition of type A2xContext + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nrA2xServicesAuth | NrA2xAuth | C | 0..1 | This IE shall be present if the UE is authorized to use the NR sidelink for A2X services. | +| lteA2xServicesAuth | LteA2xAuth | C | 0..1 | This IE shall be present if the UE is authorized to use the LTE sidelink for V2X services. | +| nrUeSidelinkAmbr | BitRate | C | 0..1 | This IE shall be present if the UE is authorized for NR A2X services.
When present, this IE contains subscription data on UE-PC5-AMBR for NR A2X services. | +| lteUeSidelinkAmbr | BitRate | C | 0..1 | This IE shall be present if the UE is authorized for LTE A2X services.
When present, this IE contains subscription data on UE-PC5-AMBR for LTE A2X services. | +| pc5QoSPara | Pc5QoSPara | C | 0..1 | This IE shall be present if the UE is authorized for NR A2X services.
When present, this IE contains policy data on the PC5 QoS parameters. | + +## 6.1.6.2.8.3 Type: A2xInformation + +Table 6.1.6.2.8.3-1: Definition of type A2xInformation + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n2Pc5Pol | N2InfoContent | C | 0..1 | This IE shall be present if N2 PC5 policy should be transferred. When present, the IE contains the NGAP A2X related IEs specified in clause 9.3.1.150 of 3GPP TS 38.413 [12]. | + +## 6.1.6.2.8.4 Type: LcsUpContext + +Table 6.1.6.2.8.4-1: Definition of type LcsUpContext + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|--------------------|---|-------------|----------------------| +| upConnectionStatus | UpConnectionStatus | O | 0..1 | UP Connection Status | +| servingLMFIdentification | LMFIdentification | O | 0..1 | Serving LMF ID | + +### 6.1.6.3 Simple data types and enumerations + +#### 6.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. + +#### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EpsBearerId | integer | Integer identifying an EPS bearer, within the range 0 to 15, as specified in clause 11.2.3.1.5, bits 5 to 8, of 3GPP TS 24.007 [15]. | +| Ppi | integer | This represents the Paging Policy Indicator. The value is within the range 0 to 7. | +| NasCount | UInteger | Unsigned integer identifying the NAS COUNT as specified in 3GPP TS 33.501 [27] | +| 5GMmCapability | Bytes | String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the "5GMM capability" IE as specified in clause 9.11.3.1 of 3GPP TS 24.501 [11] (starting from octet 1). | +| UeSecurityCapability | Bytes | String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the " UE security capability" IE as specified in clause 9.11.3.54 of 3GPP TS 24.501 [11] (starting from octet 1). | +| S1UeNetworkCapability | Bytes | String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the " S1 UE network capability" IE as specified in clause 9.11.3.48 of 3GPP TS 24.501 [11] (starting from octet 1). | +| DrxParameter | Bytes | String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the "5GS DRX Parameters" IE as specified in clause 9.11.3.2A of 3GPP TS 24.501 [11] (starting from octet 1). | +| OmciIdentifier | string | The OMC Identifier indicates the identity of an Operation and Maintenance Centre to which Trace Records shall be sent.
minLength: 1
maxLength: 20 | +| MSClassmark2 | Bytes | String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the Mobile Station Classmark 2 as specified in clause 9.11.3.31C of 3GPP TS 24.501 [11] (starting from octet 1). | +| SupportedCodec | Bytes | String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the Supported Codec as specified in clause 9.11.3.51A of 3GPP TS 24.501 [11] (starting from octet 1). | + +#### 6.1.6.3.3 Enumeration: StatusChange + +**Table 6.1.6.3.3-1: Enumeration StatusChange** + +| Enumeration value | Description | +|-------------------|---------------------------------------------------------------------| +| "AMF_UNAVAILABLE" | The AMF is unavailable to serve the UEs identified by the GUAMI(s). | +| "AMF_AVAILABLE" | The AMF is available to serve the UEs identified by the GUAMI(s). | + +## 6.1.6.3.4 Enumeration: N2InformationClass + +**Table 6.1.6.3.4-1: Enumeration N2InformationClass** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------------------|---------------| +| "SM" | N2 SM information. | | +| "NRPPa" | N2 NRPPa information. | | +| "PWS" | N2 PWS information of PWS type. | | +| "PWS-BCAL" | N2 Broadcast Completed Area List or the Broadcast Cancelled Area List. | | +| "PWS-RF" | N2 Restart Indication or Failure Indication | | +| "RAN" | N2 RAN related information. | | +| "V2X" | N2 V2X information | | +| "PROSE" | N2 5G ProSe information. | ProSe | +| "TSS" | N2 Timing Synchronisation Status information | | +| "RANGING_SL" | N2 ranging and sidelink positioning information transport over PC5 | Ranging_SL | +| "A2X" | N2 A2X information | A2X | + +## 6.1.6.3.5 Enumeration: N1MessageClass + +**Table 6.1.6.3.5-1: Enumeration N1MessageClass** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "5GMM" | The whole NAS message as received (for e.g. used in forwarding the Registration message to target AMF during Registration procedure with AMF redirection). | +| "SM" | N1 Session Management message | +| "LPP" | N1 LTE Positioning Protocol message | +| "SMS" | N1 SMS message as specified in 3GPP TS 23.040 [44] and 3GPP TS 24.011 [45] | +| "UPDP" | The N1 messages for UE Policy Delivery (See Annex D of 3GPP TS 24.501 [11]). | +| "LCS" | The N1 message of Location service message type | + +## 6.1.6.3.6 Enumeration: N1N2MessageTransferCause + +**Table 6.1.6.3.6-1: Enumeration N1N2MessageTransferCause** + +| Enumeration value | Description | +|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "ATTEMPTING_TO_REACH_UE" | This cause represents the case where the AMF has initiated paging to reach the UE in order to deliver the N1 message. | +| "N1_N2_TRANSFER_INITIATED" | This cause represents the case where the AMF has initiated the N1/N2 message transfer towards the UE and/or the AN. | +| "WAITING_FOR_ASYNCHRONOUS_TRANSFER" | This cause represents the case where the AMF has stored the N1/N2 message due to Asynchronous Transfer. | +| "UE_NOT_RESPONDING" | This cause represents the case that the AMF has initiated paging to reach the UE but the UE is not responding to the paging, or the case of a UE in RRC Inactive state when NG-RAN paging is not successful (e.g. NG-RAN initiated a UE context release with a cause indicating the non-delivery of the N1 message). | +| "N1_MSG_NOT_TRANSFERRED" | This cause represents the case where the AMF has skipped sending N1 message to the UE, when UE is in CM-IDLE and the "skipInd" is set to "true" in the request. | +| "N2_MSG_NOT_TRANSFERRED" | This cause indicates that the AMF has skipped sending the N2 message (i.e. PDU Session Resource Setup Request) as well as the possibly included N1 message to the 5G-AN, when the UE is in CM-CONNECTED state and the UE is outside of the validity area included in the N1N2MessageTransfer Request. | +| "UE_NOT_REACHABLE_FOR_SESSION" | This cause indicates that the UE is not reachable for the non-3GPP PDU session, due to the UE being in CM-IDLE for non-3GPP access and the PDU session is not allowed to move to 3GPP access. | +| "TEMPORARY_REJECT_REGISTRATION_ONGOING" | This cause represents the case that the AMF has initiated paging to reach the UE but there is an ongoing registration procedure. | +| "TEMPORARY_REJECT_HANDOVER_ONGOING" | This cause indicates that the AMF has initiated N1 signalling towards the UE but the N1 message could not be delivered due to an ongoing Xn or N2 handover procedure. | +| "REJECTION_DUE_TO_PAGING_RESTRICTION" | This cause represents the case that the UE has rejected the page as specified in 3GPP TS 23.501 [2] clause 5.38.4. | +| "AN_NOT_RESPONDING" | This cause indicates that the AMF has initiated a N2 request to transfer a N2 PDU (e.g. to setup, modify or release PDU session resources) but the AN is not responding to the N2 request. | +| "FAILURE_CAUSE_UNSPECIFIED" | This cause indicates that the N1/N2 message transfer failed due to unspecified reasons. | + +## 6.1.6.3.7 Enumeration: UeContextTransferStatus + +**Table 6.1.6.3.7-1: Enumeration UeContextTransferStatus** + +| Enumeration value | Description | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "TRANSFERRED" | Indicates a UE Context Transfer procedure is completed successful for the individual ueContext resource | +| "NOT_TRANSFERRED" | Indicates a UE Context Transfer procedure either did not complete successfully or the Registration request from the UE is redirected to another NF Service Consumer (e.g. AMF). | + +## 6.1.6.3.8 Enumeration: N2InformationTransferResult + +**Table 6.1.6.3.8-1: Enumeration N2InformationTransferResult** + +| Enumeration value | Description | +|------------------------------|-------------------------------------------------------------------------------------------------------------| +| "N2_INFO_TRANSFER_INITIATED" | This cause code represents the case where the AMF has initiated the N2 information transfer towards the AN. | + +## 6.1.6.3.9 Enumeration: CipheringAlgorithm + +**Table 6.1.6.3.9-1: Enumeration CipheringAlgorithm** + +| Enumeration value | Description | +|-------------------|---------------------------------| +| "NEA0" | Null ciphering algorithm | +| "NEA1" | 128-bit SNOW 3G based algorithm | +| "NEA2" | 128-bit AES based algorithm | +| "NEA3" | 128-bit ZUC based algorithm | + +## 6.1.6.3.10 Enumeration: IntegrityAlgorithm + +**Table 6.1.6.3.10-1: Enumeration IntegrityAlgorithm** + +| Enumeration value | Description | +|-------------------|-------------------------------------| +| "NIA0" | Null Integrity Protection algorithm | +| "NIA1" | 128-bit SNOW 3G based algorithm | +| "NIA2" | 128-bit AES based algorithm | +| "NIA3" | 128-bit ZUC based algorithm | + +## 6.1.6.3.11 Enumeration: SmsSupport + +**Table 6.1.6.3.11-1: Enumeration SmsSupport** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------| +| "3GPP" | Support SMS delivery over NAS in 3GPP access | +| "NON_3GPP" | Support SMS delivery via non-3GPP access | +| "BOTH" | Support SMS delivery over NAS or via non-3GPP access | +| "NONE" | Don't support SMS delivery | + +## 6.1.6.3.12 Enumeration: ScType + +**Table 6.1.6.3.12-1: Enumeration ScType** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------| +| "NATIVE" | Native security context (for KSI AMF ) | +| "MAPPED" | Mapped security context (for KSI ASME ) | + +## 6.1.6.3.13 Enumeration: KeyAmfType + +**Table 6.1.6.3.13-1: Enumeration KeyAmfType** + +| Enumeration value | Description | +|-------------------|--------------------------------------| +| "KAMF" | The K amf value is sent. | +| "KPRIMEAMF" | The K' amf value is sent. | + +## 6.1.6.3.14 Enumeration: TransferReason + +**Table 6.1.6.3.14-1: Enumeration TransferReason** + +| Enumeration value | Description | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| "INIT_REG" | It indicates the AMF requests UE context for initial registration or disaster roaming initial registration. | +| "MOBI_REG" | It indicates the AMF requests UE context for mobility registration or disaster roaming mobility registration. | +| "MOBI_REG_UE_VALIDATED" | It indicates the AMF requests UE context for mobility registration or disaster roaming mobility registration of a validated UE. | + +## 6.1.6.3.15 Enumeration: PolicyReqTrigger + +**Table 6.1.6.3.15-1: Enumeration PolicyReqTrigger** + +| Enumeration value | Description | +|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "LOCATION_CHANGE" | The AM policy request shall be triggered when the UE's location (Tracking Area) changes. | +| "PRA_CHANGE" | The AM policy request shall be triggered when the UE is entering / leaving a Presence Reporting Area. | +| "ALLOWED_NSSAI_CHANGE" | The policy request shall be triggered when the allowed NSSAI of the UE has changed. | +| "NWDAF_DATA_CHANGE" | The AM policy request shall be triggered when the NWDAF instance IDs used for the UE and/or associated Analytics IDs have changed. | +| "PLMN_CHANGE" | The UE policy request shall be triggered when the serving PLMN of UE has changed. | +| "CON_STATE_CHANGE" | The UE policy request shall be triggered when the connectivity state of UE has changed. | +| "SMF_SELECT_CHANGE" | The AM policy request shall be triggered when the UE request for an unsupported DNN or the UE request for a DNN within the list of DNN candidates for replacement per S-NSSAI. | +| "ACCESS_TYPE_CHANGE" | The AM policy request shall be triggered when the access type and the RAT type combinations available in the AMF for a UE with simultaneous 3GPP and non-3GPP connectivity have changed. | +| "SAT_BACKHAUL_CHANGE" | The UE policy request shall be triggered when the UE's satellite backhaul category changes. | + +## 6.1.6.3.16 Enumeration: RatSelector + +**Table 6.1.6.3.16-1: Enumeration RatSelector** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------| +| "E-UTRA" | The N2 information shall be transferred to ng-eNBs only. | +| "NR" | The N2 information shall be transferred to gNBs only. | + +## 6.1.6.3.17 Enumeration: NgapleType + +Table 6.1.6.3.17-1: Enumeration NgapleType + +| Enumeration value | Description | +|----------------------------------|------------------------------------------------| +| "PDU_RES_SETUP_REQ" | PDU Session Resource Setup Request Transfer | +| "PDU_RES_REL_CMD" | PDU Session Resource Release Command Transfer | +| "PDU_RES_MOD_REQ" | PDU Session Resource Modify Request Transfer | +| "HANDOVER_CMD" | Handover Command Transfer | +| "HANDOVER_REQUIRED" | Handover Required Transfer | +| "HANDOVER_PREP_FAIL" | Handover Preparation Unsuccessful Transfer | +| "SRC_TO_TAR_CONTAINER" | Source to Target Transparent Container | +| "TAR_TO_SRC_CONTAINER" | Target to Source Transparent Container | +| "TAR_TO_SRC_FAIL_CONTAINER" | Target to Source Failure Transparent Container | +| "RAN_STATUS_TRANS_CONTAINER" | RAN Status Transfer Transparent Container | +| "SON_CONFIG_TRANSFER" | SON Configuration Transfer | +| "NRPPA_PDU" | NRPPa-PDU | +| "UE_RADIO_CAPABILITY" | UE Radio Capability | +| "RIM_INFO_TRANSFER" | RIM Information Transfer | +| "SECONDARY_RAT_USAGE" | Secondary RAT Data Usage Report Transfer | +| "PC5_QOS_PARA" | PC5 QoS Parameters | +| "EARLY_STATUS_TRANS_CONTAINER" | Early Status Transfer Transparent Container | +| "UE_RADIO_CAPABILITY_FOR_PAGING" | UE Radio Capability for Paging | + +## 6.1.6.3.18 Enumeration: N2InfoNotifyReason + +Table 6.1.6.3.18-1: Enumeration N2InfoNotifyReason + +| Enumeration value | Description | +|----------------------|--------------------------------------------------------------------------------------------------------------------| +| "HANDOVER_COMPLETED" | Indicates that the N2 Information Notification is delivered when the handover procedure is completed successfully. | + +## 6.1.6.3.19 Enumeration: SmfChangeIndication + +Table 6.1.6.3.19-1: Enumeration SmfChangeIndication + +| Enumeration value | Description | +|-------------------|-------------------------------------| +| "CHANGED" | I-SMF or V-SMF changed. (NOTE 1) | +| "REMOVED" | I-SMF or V-SMF is removed. (NOTE 2) | + +NOTE 1: This enumeration value shall also be used if the UE moves from HPLMN to a VPLMN, a V-SMF is inserted and the I-SMF is removed, or from VPLMN to HPLMN, an I-SMF is inserted and the V-SMF is removed. + +NOTE 2: This enumeration value shall also be used if the UE moves from VPLMN to HPLMN, without an I-SMF inserted in the HPLMN. + +## 6.1.6.3.20 Enumeration: SbiBindingLevel + +Table 6.1.6.3.20-1: Enumeration SbiBindingLevel + +| Enumeration value | Description | +|-------------------------------|------------------------------------------| +| "NF_INSTANCE_BINDING" | Indicates binding to NF instance | +| "NF_SET_BINDING" | Indicates binding to NF Set | +| "NF_SERVICE_SET_BINDING" | Indicates binding to NF Service Set | +| "NF_SERVICE_INSTANCE_BINDING" | Indicates binding to NF Service instance | + +#### 6.1.6.3.21 Enumeration: EpsNasCipheringAlgorithm + +This data type enumerates the algorithms for data ciphering in EPS NAS, as specified in clause 5.1.3.2 of 3GPP TS 33.401 [49]. + +**Table 6.1.6.3.21-1: Enumeration EpsNasCipheringAlgorithm** + +| Enumeration value | Description | +|-------------------|---------------------------------| +| "EEA0" | Null ciphering algorithm | +| "EEA1" | 128-bit SNOW 3G based algorithm | +| "EEA2" | 128-bit AES based algorithm | +| "EEA3" | 128-bit ZUC based algorithm | + +#### 6.1.6.3.22 Enumeration: EpsNasIntegrityAlgorithm + +This data type enumerates the algorithms for data integrity protection in EPS NAS, as specified in clause 5.1.4.2 of 3GPP TS 33.401 [49]. + +**Table 6.1.6.3.22-1: Enumeration EpsNasIntegrityAlgorithm** + +| Enumeration value | Description | +|-------------------|-------------------------------------| +| "EIA0" | Null Integrity Protection algorithm | +| "EIA1" | 128-bit SNOW 3G based algorithm | +| "EIA2" | 128-bit AES based algorithm | +| "EIA3" | 128-bit ZUC based algorithm | + +#### 6.1.6.3.23 Enumeration: PeriodicCommunicationIndicator + +This data type enumerates types of Periodic Communication Indicator. + +**Table 6.1.6.3.23-1: Enumeration PeriodicCommunicationIndicator** + +| Enumeration value | Description | +|-------------------|--------------| +| "PERIODICALLY" | Periodically | +| "ON_DEMAND" | On demand | + +#### 6.1.6.3.24 Enumeration: UuaaMmStatus + +This data type enumerates types of UUAA-MM status. + +**Table 6.1.6.3.24-1: Enumeration UuaaMmStatus** + +| Enumeration value | Description | +|-------------------|-------------| +| "SUCCESS" | Success | +| "PENDING" | Pending | +| "FAILED" | Failed | + +### 6.1.6.3.25 Enumeration: ReleaseCause + +**Table 6.1.6.3.25-1: Enumeration ReleaseCause** + +| Enumeration value | Description | +|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "SNPN_SNPN_MOBILITY" | This cause represents the case where the continuity of the PDU Session(s) cannot be supported between networks due to SNPN-SNPN mobility. | +| "NO_HR_AGREEMENT" | This cause represents the case where the continuity of the PDU Session(s) cannot be supported between networks due to inter-PLMN mobility where no HR agreement exists. | +| "UNSPECIFIED" | This cause indicates that the continuity of the PDU Session(s) cannot be supported between networks due to unspecified reasons. | + +### 6.1.6.4 Binary data + +#### 6.1.6.4.1 Introduction + +This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.1.2.2.2 and 6.1.2.4). + +**Table 6.1.6.4.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------------------------|----------------|----------------| +| N1 Message | 6.1.6.4.2 | vnd.3gpp.5gnas | +| N2 Information | 6.1.6.4.3 | vnd.3gpp.ngap | +| Mobile Terminated Data | 6.1.6.4.3 | vnd.3gpp.5gnas | +| GTP-C message | 6.1.6.4.5 | vnd.3gpp.gtpc | + +#### 6.1.6.4.2 N1 Message + +N1 Message shall encode a 5GS NAS message of a specified type (e.g. SM, LPP) as specified in 3GPP TS 24.501 [11], using the vnd.3gpp.5gnas content-type. + +N1 Message may encode e.g. the following 5GS NAS messages: + +- For message class SM: + - PDU Session Modification Command (see clause 8.3.7 of 3GPP TS 24.501 [11]) during network initiated PDU session modification procedure (see clause 4.3.3 of 3GPP TS 23.502 [3]); + - PDU Session Release Command (see clause 8.3.12 of 3GPP TS 24.501 [11]) during network initiated PDU session release procedure (see clause 4.3.4 of 3GPP TS 23.502 [3]). + - PDU Session Establishment Accept (see clause 8.3.2 in 3GPP TS 24.501 [11]) during UE-requested PDU Session Establishment (see clause 4.3.2.2 in 3GPP TS 23.502 [3]). +- For message class LPP: + - UE Positioning Request messages as specified in 3GPP TS 36.355 [13] during UE assisted and UE based positioning procedure (see clause 6.11.1 of 3GPP TS 23.273 [42]). +- For message class 5GMM: + - REGISTRATION REQUEST message as specified in see clause 8.2.5 of 3GPP TS 24.501 [11], during registration procedures (see clause 4.2.2.2 of 3GPP TS 23.502 [3]). +- For message class UPDP: + - MANAGE UE POLICY COMMAND / MANAGE UE POLICY COMPLETE / MANAGE UE POLICY REJECT (see Annex D.5.1 to Annex D.5.3 of 3GPP TS 24.501 [11]) during network initiated UE policy management procedure (see Annex D.2.1 of 3GPP TS 24.501 [11]); + +- UE STATE INDICATION (see Annex D.5.4 of 3GPP TS 24.501 [11]) during UE initiated UE state indication procedure (see Annex D.2.2 of 3GPP TS 24.501 [11]). +- UE POLICY PROVISIONING REQUEST / UE POLICY PROVISIONING REJECT (see clause 7.2 of 3GPP TS 24.587 [53]) during UE-requested V2X policy provisioning procedure and/or 5G ProSe policy provisioning procedure (see clause 5.3.2 of 3GPP TS 24.587 [53] and/or clause 5.3.2 of 3GPP TS 24.554 [54] respectively) and/or UE-requested A2X policy provisioning procedure (see clause 5.3.2 of 3GPP TS 24.577 [60]). +- For message class LCS: + - Location services messages between UE and LMF (lcs-PeriodicTriggeredInvoke/lcs-EventReport/lcs-CancelDeferredLocation) as specified in 3GPP TS 24.080 [43] during deferred 5GC-MT-LR procedure (see clause 6.3 of 3GPP TS 23.273 [42]). + - Location services messages between PRU and LMF during PRU association and disassociation procedures (see clause 6.17 of 3GPP TS 23.273 [42]). +- For message class SMS: + - SMS payload information as specified in 3GPP TS 23.040 [44] and 3GPP TS 24.011 [45], e.g. CP-DATA, CP-ACK, CP-ERROR. + +#### 6.1.6.4.3 N2 Information + +##### 6.1.6.4.3.1 Introduction + +N2 Information shall encode NG Application Protocol (NGAP) IEs, as specified in clause 9.4 of 3GPP TS 38.413 [12] (ASN.1 encoded), using the vnd.3gpp.ngap content-type. + +##### 6.1.6.4.3.2 NGAP IEs + +For N2 information class SM, N2 Information may encode following NGAP SMF related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-1. + +**Table 6.1.6.4.3.2-1: N2 Information content for class SM** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|-----------------------------------------------|------------------------------------|--------------------------------------| +| PDU Session Resource Setup Request Transfer | 9.3.4.1 | PDU SESSION RESOURCE SETUP REQUEST | +| PDU Session Resource Release Command Transfer | 9.3.4.12 | PDU SESSION RESOURCE RELEASE COMMAND | +| PDU Session Resource Modify Request Transfer | 9.3.4.3 | PDU SESSION RESOURCE MODIFY REQUEST | +| Handover Command Transfer | 9.3.4.10 | HANDOVER COMMAND | +| Handover Required Transfer | 9.3.4.14 | HANDOVER REQUIRED | +| Handover Preparation Unsuccessful Transfer | 9.3.4.18 | HANDOVER COMMAND | +| Secondary RAT Data Usage Report Transfer | 9.3.4.23 | SECONDARY RAT DATA USAGE REPORT | + +For N2 information class RAN, N2 Information may encode one of the following NGAP Transparent Container IEs specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-2. + +**Table 6.1.6.4.3.2-2: N2 Information content for class RAN** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|------------------------------------------------|------------------------------------|---------------------------------------------------------------------------| +| Source to Target Transparent Container | 9.3.1.20 | HANDOVER REQUIRED, HANDOVER REQUEST | +| Target to Source Transparent Container | 9.3.1.21 | HANDOVER COMMAND, HANDOVER REQUEST
ACKNOWLEDGE | +| Target to Source Failure Transparent Container | 9.3.1.186 | HANDOVER FAILURE | +| UE Radio Capability | 9.3.1.74 | UE RADIO CAPABILITY INFO INDICATION. (NOTE 1). | +| UE Radio Capability for Paging | 9.3.1.68 | UE RADIO CAPABILITY INFO INDICATION. (NOTE 1). | +| SON Configuration Transfer | 9.3.3.6 | UPLINK RAN CONFIGURATION TRANSFER, DOWNLINK
RAN CONFIGURATION TRANSFER | +| RAN Status Transfer Transparent Container | 9.2.3.13, 9.2.3.14 | UPLINK RAN STATUS TRANSFER, DOWNLINK RAN
STATUS TRANSFER | +| Early Status Transfer Transparent Container | 9.2.3.16, 9.2.3.17 | UPLINK RAN EARLY STATUS TRANSFER
DOWNLINK RAN EARLY STATUS TRANSFER | +| RIM Information Transfer | 9.3.3.28 | UPLINK RIM INFORMATION TRANSFER, DOWNLINK
RIM INFORMATION TRANSFER | + +NOTE 1: The AMF receives the UE Radio Capability and UE Radio Capability for Paging within a UE CAPABILITY INFO INDICATION message and then the AMF shall store the UE Radio Capability information and UE Radio Capability for Paging, and transfer them to the target AMF during an inter AMF mobility procedure. + +For N2 information class NRPPa, N2 Information may encode the following NGAP NRPPa Transport related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-3 + +**Table 6.1.6.4.3.2-3: N2 Information content for class NRPPa** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|-----------|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NRPPa-PDU | 9.3.3.14 | DOWNLINK UE ASSOCIATED NRPPA TRANSPORT
UPLINK UE ASSOCIATED NRPPA TRANSPORT
DOWNLINK NON UE ASSOCIATED NRPPA TRANSPORT
UPLINK NON UE ASSOCIATED NRPPA TRANSPORT | + +For N2 information class V2X, N2 Information may encode the following V2X related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-4 + +**Table 6.1.6.4.3.2-4: N2 Information content for class V2X** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|--------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| PC5 QoS Parameters | 9.3.1.150 | INITIAL CONTEXT SETUP REQUEST
UE CONTEXT MODIFICATION REQUEST
HANDOVER REQUEST
PATH SWITCH REQUEST ACKNOWLEDGE | + +For N2 information class PROSE, N2 Information may encode the following ProSe related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-5 + +**Table 6.1.6.4.3.2-5: N2 Information content for class PROSE** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|--------------------------------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| 5G ProSe PC5 QoS Parameters | 9.3.1.234 | INITIAL CONTEXT SETUP REQUEST
UE CONTEXT MODIFICATION REQUEST
HANDOVER REQUEST
PATH SWITCH REQUEST ACKNOWLEDGE | +| 5G ProSe Authorized | 9.3.1.233 | INITIAL CONTEXT SETUP REQUEST
UE CONTEXT MODIFICATION REQUEST
HANDOVER REQUEST
PATH SWITCH REQUEST ACKNOWLEDGE | +| 5G ProSe UE PC5 Aggregate Maximum Bit Rate | 9.3.1.148 | INITIAL CONTEXT SETUP REQUEST
UE CONTEXT MODIFICATION REQUEST
HANDOVER REQUEST
PATH SWITCH REQUEST ACKNOWLEDGE | + +**Table 6.1.6.4.3.2-6: Void** + +For N2 information class RANGING\_SL, N2 Information may encode one of the following related IEs specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-7. + +**Table 6.1.6.4.3.2-7: N2 Information content for class RANGING\_SL** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|------------------------------------------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| Ranging and Sidelink Positioning Service Information | 9.3.1.x | INITIAL CONTEXT SETUP REQUEST
UE CONTEXT MODIFICATION REQUEST
HANDOVER REQUEST
PATH SWITCH REQUEST ACKNOWLEDGE | + +For N2 information class A2X, N2 Information may encode the following A2X related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.2-8 + +**Table 6.1.6.4.3.2-8: N2 Information content for class A2X** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|--------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| PC5 QoS Parameters | 9.3.1.150 | INITIAL CONTEXT SETUP REQUEST
UE CONTEXT MODIFICATION REQUEST
HANDOVER REQUEST
PATH SWITCH REQUEST ACKNOWLEDGE | + +#### 6.1.6.4.3.3 NGAP Messages + +For N2 information class PWS, N2 Information shall encode NGAP Messages specified in 3GPP TS 38.413 [12]. + +**Table 6.1.6.4.3.3-1: N2 PWS Request Information content** + +| NGAP message | Reference
(3GPP TS 38.413 [12]) | +|-------------------------------|------------------------------------| +| WRITE-REPLACE WARNING REQUEST | 9.2.8.1 | +| PWS CANCEL REQUEST | 9.2.8.3 | + +**Table 6.1.6.4.3.3-2: N2 PWS Response Information content** + +| NGAP message | Reference
(3GPP TS 38.413 [12]) | +|--------------------------------|--------------------------------------------| +| WRITE-REPLACE WARNING RESPONSE | 9.2.8.2 | +| PWS CANCEL RESPONSE | 9.2.8.4 | + +N2 Information received by the AMF for PWS may be processed by the AMF before re-encoding and transferring to the Service Consumer. + +If a subscription exists for N2InformationClass "PWS-BCAL" and the received N2 Message Type is a WRITE-REPLACE-WARNING-RESPONSE, then the AMF may aggregate the Broadcast Completed Area Lists it has received from the NG-RAN nodes for a message identified by its Serial Number and Message Identifier (see table 6.1.6.4.3.3-1) and transfer the ASN.1 (re-)encoded Message Type, Message Identifier, Serial Number and the (aggregated) Broadcast Completed Area List IE in the N2 Info Container in the N2InfoNotify, and the "bcEmptyAreaList" attribute if the Broadcast Completed Area List IE is not present in the PWS N2 information. + +If a subscription exists for N2InformationClass "PWS-BCAL" and the received N2 Message Type is a PWS-CANCEL-RESPONSE, then the AMF may aggregate the Broadcast Cancelled Area Lists IE it has received from the NG-RAN nodes for a message identified by its Serial Number and Message Identifier (see table 6.1.6.4.3.3-1) and transfer the ASN.1 (re-)encoded the Message Type, Message Identifier, Serial Number, the (aggregated) Broadcast Cancelled Area List IE in the N2 Info Container in the N2InfoNotify, and the "bcEmptyAreaList" attribute if the PWS-CANCEL-RESPONSE does not contain a Broadcast Cancelled Area List, in the PWS N2 information. + +For the ASN.1 definition for encoding the WRITE-REPLACE-WARNING-RESPONSE and the PWS-CANCEL-RESPONSE, see clause 9.4 of 3GPP TS 38.413 [12]. + +If a subscription exists for N2InformationClass "PWS-RF" and the received N2 Message Type is a PWS-RESTART-INDICATION, then the AMF may transfer the ASN.1 encoded string from the PWS-RESTART-INDICATION (see table 6.1.6.4.3.3-3) in the N2 Info Container in the N2InfoNotify. + +If a subscription exists for N2InformationClass "PWS-RF" and the received N2 Message Type is a PWS-FAILURE-INDICATION (see table 6.1.6.4.3.3-3), then the AMF may transfer the ASN.1 encoded string from the PWS-FAILURE-INDICATION in the N2 Info Container in the N2InfoNotify. + +**Table 6.1.6.4.3.3-3: N2 PWS Indication Information content** + +| NGAP message | Reference
(3GPP TS 38.413 [12]) | +|------------------------|--------------------------------------------| +| PWS RESTART INDICATION | 9.2.8.5 | +| PWS FAILURE INDICATION | 9.2.8.6 | + +The Message Type shall be present and encoded as the first N2 PWS Indication IE in any NonUeN2InfoNotify for PWS messages to enable the receiver to decode the N2 PWS IEs. + +For N2 information class RAN, N2 Information shall encode one of the following NGAP messages specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.3-4. + +**Table 6.1.6.4.3.3-4: N2 Information content for class RAN** + +| NGAP message | Reference
(3GPP TS 38.413 [12]) | +|-------------------------------------|--------------------------------------------| +| Any UE specific Uplink NGAP message | | + +For N2 information class TSS, N2 Information shall encode the following NGAP message specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.3-5. + +**Table 6.1.6.4.3.3-5: N2 Information content for class TSS** + +| NGAP message | Reference
(3GPP TS 38.413 [12]) | +|--------------------------------------|------------------------------------| +| TIMING SYNCHRONISATION STATUS REPORT | 9.2.yy.4 | + +Editor's note: Further details on the new NGAP message to be aligned with RAN WG3. + +#### 6.1.6.4.4 Mobile Terminated Data + +Mobile Terminated Data shall encode the user data to be sent by the AMF to the UE in the Payload Container specified in 3GPP TS 24.501 [7], using the vnd.3gpp.5gnas content-type, as summarized in Table 6.1.6.4.4-1. + +**Table 6.1.6.4.4-1: Mobile Terminated Data** + +| Mobile Terminated Data | Reference
(3GPP TS 24.501 [7]) | Related NAS SM message | +|---------------------------------------------|-----------------------------------|------------------------| +| Payload container contents in octets 4 to n | 9.11.3.39
(Figure 9.11.3.39.1) | DL NAS Transport | + +#### 6.1.6.4.5 GTP-C Message + +GTP-C Message shall encode a GTP-C message of a specified type (e.g. Forward Relocation Request) as specified in 3GPP TS 29.274 [41], using the vnd.3gpp.gtpc content-type. The GTP-C message carried in the HTTP multipart message shall include the UDP/IP headers. + +GTP-C Message may encode e.g. the following GTP-C messages: + +- Mobility Management message: + - Forward Relocation Request (see clause 7.3.1 of 3GPP TS 29.274 [41]) during EPS to 5GS handover with AMF re-allocation procedure (see clause 4.11.1.2.2 of 3GPP TS 23.502 [3]); + - Relocation Cancel Request (see clause 7.3.16 of 3GPP TS 29.274 [41]) during EPS to 5GS handover with AMF re-allocation procedure (see clause 4.11.1.2.3 of 3GPP TS 23.502 [3]), if handover cancel is triggered. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.1.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7.2 of 3GPP TS 29.500 [4]. + +### 6.1.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Namf\_Communication service. The following application errors listed in Table 6.1.7.3-1 are specific for the Namf\_Communication service. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NF_CONSUMER_REDIRECT_ONE_TXN | 307
Temporary Redirect | The request has been asked to be redirected to a specified target. | +| HANDOVER_FAILURE | 403
Forbidden | Creation of UE context or relocation in the target AMF failed during Handover procedure causing a failure of handover. | +| INTEGRITY_CHECK_FAIL | 403
Forbidden | Integrity check of the complete registration message included in the UE context transfer request failed. | +| EBI_EXHAUSTED | 403
Forbidden | Allocation of EPS Bearer ID failed due to exhaustion of EBI as the maximum number of EBIs has already been allocated to the UE. | +| EBI_REJECTED_LOCAL_POLICY | 403
Forbidden | Allocation of EPS Bearer ID failed due to local policy at the AMF as specified in clause 4.11.1.4.1 of 3GPP TS 23.502 [3]. | +| EBI_REJECTED_NO_N26 | 403
Forbidden | The allocation of EPS Bearer ID was rejected when the AMF is in a serving PLMN that does not support 5GS-EPS interworking procedures with N26 interface. | +| SUPI_OR_PEI_UNKNOWN | 403
Forbidden | The SUPI or PEI included in the message is unknown. | +| UE_IN_NON_ALLOWED_AREA | 403
Forbidden | UE is currently in a non-allowed area hence the N1/N2 message transfer cannot be completed because the request is not associated with a regulatory prioritized service. | +| UNSPECIFIED | 403
Forbidden | The request is rejected due to unspecified reasons. | +| SM_CONTEXT_RELOCATION_REQUIRED | 403
Forbidden | The request is rejected because the SM Context should be relocated to another SMF, e.g. when AMF detects that an I-SMF or V-SMF insertion, change or removal is needed, as specified in clause 4.23 of 3GPP TS 23.502 [3]. | +| UE_WITHOUT_N1_LPP_SUPPORT | 403
Forbidden | UE does not support LPP in N1 mode hence the N1 LPP message cannot be sent to the UE. | +| INVALID_SM_CONTEXT | 403
Forbidden | The request is rejected because the SM Context is invalid for the PDU session, i.e. active SM Context for the PDU session (with same PDU Session ID) has been created on another SMF. (NOTE) | +| INVALID_PRU | 403
Forbidden | The request is rejected because the request is to initiate a positioning procedure towards a PRU and the target UE is not a valid PRU. | +| CONTEXT_NOT_FOUND | 404
Not Found | The requested UE Context does not exist on the AMF | +| HIGHER_PRIORITY_REQUEST_ONGOING | 409
Conflict | Paging triggered N1/N2 transfer cannot be initiated since already there is a paging due to a higher priority session ongoing. | +| TEMPORARY_REJECT_REGISTRATION_ONGOING | 409
Conflict | N1/N2 message transfer towards UE / AN cannot be initiated or the EBI assignment fails due to an ongoing registration procedure. | +| TEMPORARY_REJECT_HANDOVER_ONGOING | 409
Conflict | N1/N2 message transfer towards UE / AN cannot be initiated due to an ongoing Xn or N2 handover procedure, or the EBI assignment fails due to an ongoing N2 handover procedure or an ongoing Xn handover procedure. | +| UE_IN_CM_IDLE_STATE | 409
Conflict | N2 message transfer towards 5G-AN cannot be initiated due to the UE being in CM-IDLE state for the Access Network Type associated to the PDU session. | +| MAX_ACTIVE_SESSIONS_EXCEEDED | 409
Conflict | If the RAT type is NB-IoT, and the UE already has 2 PDU Sessions with active user plane resources. | +| REJECTION_DUE_TO_PAGING_RESTRICTION | 409
Conflict | If Paging Restrictions information restricts the N1N2MessageTransfer request from causing | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-----------------------------------------------------------| +| | | paging as defined in 3GPP TS 23.501 [2]
clause 5.38.5. | +| UE_NOT_REACHABLE | 504
Gateway
Timeout | The UE is not reachable for paging. | +| UE_NOT_RESPONDING | 504
Gateway
Timeout | The UE is not responding for paging. | +| NOTE: More than one SM Contexts may be present in the network for the same PDU Session ID, e.g. when the UE established a new PDU session with the same PDU Session ID and the AMF failed to release the old SM Context in the old SMF. In such a scenario, if the old SMF tries to send N1 and/or N2 Message to the RAN/UE, the AMF shall respond with this application error if the AMF identified that service operation is invoked by the SMF holding the old SM Context. | | | + +## 6.1.8 Feature Negotiation + +The feature negotiation mechanism specified in clause 6.6 of 3GPP TS 29.500 [4] shall be used to negotiate the optional features applicable between the AMF and the NF Service Consumer, for the Namf\_Communication service, if any. + +The NF Service Consumer shall indicate the optional features it supports for the Namf\_Communication service, if any, by including the supportedFeatures attribute in content of the HTTP Request Message for following service operations: + +- N1N2MessageTransfer, as specified in clause 5.2.2.3.1; +- N1N2MessageSubscribe, as specified in clause 5.2.2.3.3; +- NonUeN2InfoSubscribe, as specified in clause 5.2.2.4.2; +- UeContextTransfer, as specified in clause 5.2.2.2.1; +- CreateUEContext, as specified in clause 5.2.2.2.3 + +The AMF shall determine the supported features for the service operations as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in content of the HTTP response for the service operation. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [6]. + +The following features are defined for the Namf\_Communication service. + +**Table 6.1.8-1: Features of supportedFeatures attribute used by Namf\_Communication service** + +| Feature Number | Feature | M/O | Description | +|----------------|---------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | DTSSA | O | Deployments Topologies with specific SMF Service Areas.

An AMF that supports this feature shall support the procedures specified in clause 5.34 of 3GPP TS 23.501 [2] and in clause 4.23 of 3GPP TS 23.502 [3]. | +| 2 | ENS | O | This feature bit indicates whether the AMF supports procedures related to Network Slicing (see 3GPP TS 23.501 [2] clause 5.15.7). This includes supporting the RelocateUEContext service operation (see clause 5.2.2.2.5). | +| 3 | CIOT | O | Cellular IoT

Support of this feature implies the support of all the CIoT features specified in clause 5.31 of 3GPP TS 23.501 [2], including in particular corresponding service's extensions to support:
  • - NB-IoT and LTE-M RAT types;
  • - Control Plane CIoT 5GS Optimisation;
  • - Rate control of user data.
| +| 4 | MAPDU | O | This feature bit indicates whether the AMF supports Multi-Access PDU session procedures related to Access Traffic Steering, Switching and Splitting (see clauses 4.2.10 and 5.32 of 3GPP TS 23.501 [2]). | +| 5 | NPN | O | Non-Public Network

Support of this feature implies support of NPN information and receipt of a Create UE context error response with a binary part during an Inter-AMF N2 Handover. | +| 6 | ELCS | O | This feature indicates supports of enhanced LCS, including the capability for the AMF to send an LCS message through the target access type requested by the LMF. | +| 7 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. SMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Namf_Communication service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 8 | EAEA | O | EBI and ARP mapping update in EBIAssignment

Support of this feature implies support of updating the mapping of EBI and ARP in EBIAssignment for a QoS flow to which an EBI is already allocated. | +| 9 | ProSe | O | This feature indicates the support of UE policy and N2 information provisioning for 5G ProSe. | +| 10 | UAV | O | Uncrewed Aerial Vehicle
This feature indicates the support of UAV feature at AMF. When this feature is supported at the AMF, the AMF shall perform the UUAA-MM procedure defined in 3GPP TS 23.256 [56]. | +| 11 | SPAE | O | SM Policy Association Events

This feature bit indicates whether the AMF supports the SM Policy Association establishment and termination event notification information handling, i.e. whereby the PCF for UE subscribes to SM Policy Association events to the PCF for SM Policy via the AMF and SMF, as specified in clause 4.3.2.2.1 and clause 4.3.3.2 of 3GPP TS 23.502 [3]. | +| 12 | eNPN | O | Enhanced support of Non-Public Networks (eNPN)

This feature indicates the AMF supports UE registration for onboarding in an SNPn, see clause 5.30.2.10.2.6 and clause 5.30.2.10.2.7 in 3GPP TS 23.501 [2]. | + +| | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 13 | 3GA-N3GA-HO | O |

Handover between 3GPP and non-3GPP accesses

An AMF and SMF that supports Handover between 3GPP and non-3GPP accesses shall support this feature, i.e. setting the targetAccess IE in N1N2MessageTransfer Request to the old access type when releasing the N2 PDU session resources in the old access (see clauses 5.2.2.3.1.1 and 6.1.6.2.18)

| +| 14 | PAR-NS | O |

Partially Allowed/Rejected Network Slice

This feature indicates the AMF supports the partially allowed network slice and the partially reject Network slice. See 3GPP TS 23.501 [2] clause 5.15.17.

| +| 15 | NTSSM | O |

Network Timing Synchronization Status Monitoring

This feature bit indicates that the AMF supports transferring TSS related information in the N2InformationTransferReqData and a subscription, e.g. created by a TSCTSF, to get notification for Non-UE related N2 Information for the Network Timing Synchronization Status information.

| +| 16 | RACS | O |

Support of RACS feature as specified in clause 5.4.4.1a in 3GPP TS 23.501 [2].

During an Inter AMF mobility procedure, the source AMF may decide to not include ueRadioCapability and ueRadioCapabilityForPaging in the UeContextTransferRspData or UeContextCreateData if the target AMF supports RACS feature, the target AMF can retrieve the same using UE Radio Capability ID Id(s) included in the MM Context.

| +| 17 | Ranging_SL | O |

This feature indicates the support of UE policy and N2 information provisioning for Ranging/SL positioning as specified in 3GPP TS 23.586 [59].

| +| 18 | A2X | O |

This feature indicates the support of UE policy and N2 information provisioning for A2X communication as specified in 3GPP TS 23.256 [56]

| +| 19 | AoV-En | O |

This feature indicates the support of enhanced AreaOfValidity handling.

When invoking N1N2MessageTransfer to deliver N2 information, the SMF may use the TAI range list to efficiently indicate the area scope to deliver the N2 information, if the AMF supports this feature.

| +|

Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1).
Feature: A short name that can be used to refer to the bit and to the feature.
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.

| | | | + +## 6.1.9 Security + +As indicated in 3GPP TS 33.501 [27], the access to the Namf\_Communication API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [28]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [29]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Namf\_Communication API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [29], 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 Namf\_Communication service. + +The Namf\_Communication API defines the following scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [27]. + +**Table 6.1.9-1: OAuth2 scopes defined in Namf\_Communications API** + +| Scope | Description | +|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "namf-comm" | Access to the Namf_Communications API. | +| "namf-comm:ue-contexts:mobility" | Access to service operations applying to UE context resources for inter-AMF mobility, i.e., UEContextTransfer, RegistrationStatusUpdate, CreateUEContext, ReleaseUEContext, RelocateUEContext and CancelRelocateUEContext. | +| "namf-comm:ue-contexts:assign-ebi" | Access to service operations applying to UE context resources for EBI assignment, i.e., EBIAssignment. | +| "namf-comm:n1-n2-messages" | Access to service operations applying to the n1-n2-messages resource, i.e., N1N2MessageSubscribe, N1N2MessageUnSubscribe, N1N2MessageTransfer, N1MessageNotify, and N2InfoNotify. | +| "namf-comm:non-ue-n2-messages" | Access to service operations applying to the non-ue-n2-messages resource, i.e., NonUeN2MessageTransfer, NonUeN2InfoSubscribe, NonUeN2InfoUnSubscribe, and NonUeN2InfoNotify. | + +## 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different AMF service instance, within the same AMF or a different AMF of an AMF set, e.g. when an AMF service instance is part of an AMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See the ES3XX feature in clause 6.1.8. + +An SCP that reselects a different AMF producer instance will return the NF Instance ID of the new AMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AMF within an AMF set redirects a service request to a different AMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Namf\_EventExposure Service API + +### 6.2.1 API URI + +The Namf\_EventExposure shall use the Namf\_EventExposure API. + +The API URI of the Namf\_EventExposure API shall be: + +**{apiRoot}//** + +The request URI 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}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "namf-evts". + +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +## 6.2.2 Usage of HTTP + +### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [19], 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]. + +HTTP messages and bodies for the Namf\_EventExposure service shall comply with the OpenAPI [23] specification contained in Annex A. + +### 6.2.2.2 HTTP standard headers + +#### 6.2.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [36]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". +- JSON Patch (IETF RFC 6902 [14]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json". + +### 6.2.2.3 HTTP custom headers + +#### 6.2.2.3.1 General + +In this release of this specification, no custom headers specific to the Namf\_EventExposure service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.2.3 Resources + +### 6.2.3.1 Overview + +![Figure 6.2.3.1-1: Resource URI structure of the Namf_EventExposure API. The diagram shows a hierarchical tree structure of URI components. The root component is {apiRoot}/namf-evts/. It branches to /subscriptions, which in turn branches to /{subscriptionId}.](b303fb8b2c64e30aac9c32b5753d3670_img.jpg) + +``` + +graph TD + Root["{apiRoot}/namf-evts/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Figure 6.2.3.1-1: Resource URI structure of the Namf\_EventExposure API. The diagram shows a hierarchical tree structure of URI components. The root component is {apiRoot}/namf-evts/. It branches to /subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 6.2.3.1-1: Resource URI structure of the Namf\_EventExposure API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------|-------------------|---------------------------------|--------------------------------------------------------------------------| +| Subscriptions collection | /subscriptions | POST | Mapped to the service operation Subscribe, when to create a subscription | +| Individual subscription | /{subscriptionId} | PATCH | Mapped to the service operation Subscribe, when to modify | +| | | DELETE | Mapped to the service operation Unsubscribe | + +### 6.2.3.2 Resource: Subscriptions collection + +#### 6.2.3.2.1 Description + +This resource represents a collection of subscriptions created by NF service consumers of Namf\_EventExposure service. + +This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +#### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/namf-evts//subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------| +| apiRoot | string | See clause 6.2.1 | +| apiVersion | string | See clause 6.2.1. | + +### 6.2.3.2.3 Resource Standard Methods + +#### 6.2.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|------------------------------------------------------| +| AmfCreateEventSubscription | M | 1 | Describes of an AMF Event Subscription to be created | + +**Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AmfCreatedEventSubscription | M | 1 | 201
Created | Represents successful creation of an AMF Event Subscription | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | Indicates the creation of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
  • - UE_NOT_SERVED_BY_AMF (for a subscription targeting a specific UE)
  • - MUTING_EXC_INSTR_NOT_ACCEPTED
| + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.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}/namf-evts//subscriptions/{subscriptionId} | + +**Table 6.2.3.2.3.1-5: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.2.3.1-6: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.2.3.2.4 Resource Custom Operations + +None. + +## 6.2.3.3 Resource: Individual subscription + +### 6.2.3.3.1 Description + +This resource represents an individual of subscription created by NF service consumers of Namf\_EventExposure service. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/namf-evts//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| apiVersion | string | See clause 6.2.1. | +| subscriptionId | string | String identifies an individual subscription to the AMF event exposure service | + +### 6.2.3.3.3 Resource Standard Methods + +#### 6.2.3.3.3.1 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| array(AmfUpdateEventSubscriptionItem) | M | 1..N | Document describes the modification(s) to a AMF Event Subscription | +| array(AmfUpdateEventOptionItem) | M | 1..1 | Document describing the modification to the event subscription options (e.g subscription expiry time). | + +**Table 6.2.3.3.3.1-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AmfUpdatedEventSubscription | M | 1 | 200 OK | Represents a successful update on AMF Event Subscription | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- MUTING_EXC_INSTR_NOT_ACCEPTED | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.2.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.3.3.2-1. + +**Table 6.2.3.3.3.2-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 6.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3. + +**Table 6.2.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND. | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.2.3.3.4 Resource Custom Operations + +None. + +### 6.2.4 Custom Operations without associated resources + +There are no custom operations without associated resources supported on Namf\_EventExposure Service. + +### 6.2.5 Notifications + +#### 6.2.5.1 Void + +This clause specifies the notifications provided by the Namf\_EventExposure service. + +**Table 6.2.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------------|-----------------------|---------------------------------|---------------------------------| +| AMF Event Notification | {eventNotifyUri} | POST | | +| AMF Event Notification | {subsChangeNotifyUri} | POST | | + +#### 6.2.5.2 AMF Event Notification + +If a NF service consumer has subscribed to an event(s) supported by Namf\_EventExposure service, when AMF aware of a state change of the event, AMF shall create a notification including the event state report, and shall deliver the notification to the call-back URI, following Subscribe/Notify mechanism defined in 3GPP TS 29.501 [5]. + +##### 6.2.5.2.1 Notification Definition + +Call-back URI: {callbackUri} + +Call-back URI is provided by NF Service Consumer during creation of the subscription. If the notification is to inform the change of subscription ID and if the "subsChangeNotifyUri" was provided in the AmfEventSubscription, then this callback URI shall be the "subsChangeNotifyUri" provided in the AmfEventSubscription. Otherwise, this callback URI shall be the "eventNotifyUri" provided in the AmfEventSubscription. + +##### 6.2.5.2.3 Notification Standard Methods + +###### 6.2.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.2.5.2.3.1-1 and the response data structures and response codes specified in table 6.2.5.2.3.1-2. + +**Table 6.2.5.2.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|---------------------------------------------| +| AmfEventNotification | M | 1 | Represents the notification to be delivered | + +**Table 6.2.5.2.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.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 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | + +**Table 6.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 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.2.6 Data Model + +### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Namf\_EventExposure service based interface protocol. + +**Table 6.2.6.1-1: Namf\_EventExposure specific Data Types** + +| Data type | Clause defined | Description | +|---------------------------------|-----------------------|--------------------------------------------------------------------------| +| AmfEventSubscription | 6.2.6.2.2 | Represents an individual event subscription resource on AMF | +| AmfEvent | 6.2.6.2.3 | Describes an event to be subscribed | +| AmfEventNotification | 6.2.6.2.4 | Data within an AMF Event Notification request. | +| AmfEventReport | 6.2.6.2.5 | Represents a report triggered by a subscribed event type | +| AmfEventMode | 6.2.6.2.6 | Describes how the reports shall be generated by a subscribed event | +| AmfEventState | 6.2.6.2.7 | Represents the state of a subscribed event | +| RmInfo | 6.2.6.2.8 | Represents the registration state of a UE for an access type | +| CmInfo | 6.2.6.2.9 | Represents the connection management state of a UE for an access type | +| CommunicationFailure | 6.2.6.2.11 | Describes a communication failure detected by AMF | +| AmfCreateEventSubscription | 6.2.6.2.12 | Data within a create AMF event subscription request | +| AmfCreatedEventSubscription | 6.2.6.2.13 | Data within a create AMF event subscription response | +| AmfUpdateEventSubscriptionItem | 6.2.6.2.14 | Document describing the modification(s) to an AMF Event Subscription | +| AmfUpdatedEventSubscription | 6.2.6.2.15 | Represents a successful update on an AMF Event Subscription | +| AmfEventArea | 6.2.6.2.16 | Represents an area to be monitored by an AMF event. | +| LadnInfo | 6.2.6.2.17 | LADN Information | +| AmfUpdateEventOptionItem | 6.2.6.2.18 | Document describing the modifications to AMF event subscription options. | +| 5GsUserInfo | 6.2.6.2.19 | Represents the 5GS User state of the UE for an access type | +| TrafficDescriptor | 6.2.6.2.20 | Represents the Traffic Descriptor | +| UEIdExt | 6.2.6.2.21 | UE Identity | +| AmfEventSubsSyncInfo | 6.2.6.2.22 | AMF Event Subscriptions Information for synchronization | +| AmfEventSubscriptionInfo | 6.2.6.2.23 | Individual AMF Event Subscription Information | +| TargetArea | 6.2.6.2.24 | TA list or TAI range list or any TA | +| SnsaiTaiMapping | 6.2.6.2.25 | List of restricted or unrestricted S-NSSAIs per TAI(s) | +| SupportedSnsai | 6.2.6.2.26 | Supported S-NSSAIs | +| UeInAreaFilter | 6.2.6.2.27 | Describe the filter related to UEs In Area Report event. | +| IdleStatusIndication | 6.2.6.2.28 | Represents the idle status indication. | +| UeAccessBehaviorReportItem | 6.2.6.2.29 | Report Item for UE Access Behavior Trends event. | +| UeLocationTrendsReportItem | 6.2.6.2.30 | Report Item for UE Location Trends event. | +| DispersionArea | 6.2.6.2.31 | Dispersion Area | +| MmTransactionLocationReportItem | 6.2.6.2.32 | UE MM Transaction Report Item per Location | +| MmTransactionSliceReportItem | 6.2.6.2.33 | UE MM Transaction Report Item per Slice | +| AmfEventType | 6.2.6.3.3 | Describes the supported event types of Namf_EventExposure Service | +| AmfEventTrigger | 6.2.6.3.4 | Describes how AMF should generate the report for the event | +| LocationFilter | 6.2.6.3.5 | Describes the supported filters of LOCATION_REPORT event type | +| UeReachability | 6.2.6.3.7 | Describes the reachability of the UE | +| RmState | 6.2.6.3.9 | Describes the registration management state of a UE | +| CmState | 6.2.6.3.10 | Describes the connection management state of a UE | +| 5GsUserState | 6.2.6.3.11 | Describes the 5GS User State of a UE | +| LossOfConnectivityReason | 6.2.6.3.12 | Describes the reason for loss of connectivity | +| ReachabilityFilter | 6.2.6.3.13 | Event filter for REACHABILITY_REPORT event type. | +| UeType | 6.2.6.3.14 | Describe UE type | +| AccessStateTransitionType | 6.2.6.3.15 | Access State Transition Type | +| SubTerminationReason | 6.2.6.3.16 | Subscription Termination Reason | + +Table 6.2.6.1-2 specifies data types re-used by the Namf\_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 Namf\_EventExposure service based interface. + +**Table 6.2.6.1-2: Namf\_EventExposure re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------------|---------------------|------------------------------------------------------------------------| +| Supi | 3GPP TS 29.571 [6] | | +| GroupId | 3GPP TS 29.571 [6] | | +| DurationSec | 3GPP TS 29.571 [6] | | +| Gpsi | 3GPP TS 29.571 [6] | | +| Uri | 3GPP TS 29.571 [6] | | +| Pei | 3GPP TS 29.571 [6] | | +| UserLocation | 3GPP TS 29.571 [6] | | +| Tal | 3GPP TS 29.571 [6] | | +| TimeZone | 3GPP TS 29.571 [6] | | +| AccessType | 3GPP TS 29.571 [6] | | +| Ecgi | 3GPP TS 29.571 [6] | EUTRA Cell Identifier | +| Ncgi | 3GPP TS 29.571 [6] | NR Cell Identifier | +| NfInstanceId | 3GPP TS 29.571 [6] | | +| ProblemDetails | 3GPP TS 29.571 [6] | Problem Details | +| SupportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| DateTime | 3GPP TS 29.571 [6] | | +| NgApCause | 3GPP TS 29.571 [6] | | +| PresenceInfo | 3GPP TS 29.571 [6] | Presence Reporting Area Information | +| PresenceState | 3GPP TS 29.571 [6] | Describes the presence state of the UE to a specified area of interest | +| Dnn | 3GPP TS 29.571 [6] | | +| Snssai | 3GPP TS 29.571 [6] | | +| DddTrafficDescriptor | 3GPP TS 29.571 [6] | Downlink Data Delivery Traffic Descriptor | +| SamplingRatio | 3GPP TS 29.571 [6] | Sampling Ratio. | +| RedirectResponse | 3GPP TS 29.571 [6] | Response body of the redirect response message. | +| NotificationFlag | 3GPP TS 29.571 [6] | Notification flag | +| ExtSnssai | 3GPP TS 29.571 [6] | | +| N3gaLocation | 3GPP TS 29.571 [6] | Non-3GPP Location | +| SnssaiDnnItem | 3GPP TS 29.571 [6] | Combination of S-NSSAIs and DNNs | +| ReferenceId | 3GPP TS 29.503 [35] | | +| NsId | 3GPP TS 29.531 [18] | NSI ID | +| NFType | 3GPP TS 29.510 [29] | NF type | +| TaiRange | 3GPP TS 29.510 [29] | | +| MutingExceptionInstructions | 3GPP TS 29.571 [6] | Muting exception instructions. | +| MutingNotificationsSettings | 3GPP TS 29.571 [6] | Muting notifications settings. | + +## 6.2.6.2 Structured data types + +### 6.2.6.2.1 Introduction + +Structured data types used in Namf\_EventExposure service are specified in this clause. + +## 6.2.6.2.2 Type: AmfEventSubscription + +**Table 6.2.6.2.2-1: Definition of type AmfEventSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventList | array(AmfEvent) | M | 1..N | Describes the events to be subscribed in subscription request or the events successfully subscribed for this subscription in subscription response. | | +| eventNotifyUri | Uri | M | 1 | Identifies the recipient of notifications sent by AMF for this subscription (NOTE 1) | | +| notifyCorrelationId | string | M | 1 | Identifies the notification correlation ID. The AMF shall include this ID in the notifications. The value of this IE shall be unique per subscription for a given NF service consumer. | | +| nflD | NfInstanceId | M | 1 | Indicates the instance identity of the network function creating the subscription. | | +| subsChangeNotifyUri | Uri | C | 0..1 | This IE shall be present if the subscription is created by an NF service consumer on behalf of another NF (e.g UDM creating event subscription at AMF for event notifications towards NEF). When present, this IE identifies the recipient of notifications sent by AMF, for the creation of a new subscription ID, that is considered as a change of subscription ID by the NF service consumer for event subscriptions related to single UE or as the creation of a new subscription Id for event subscriptions related to UE groups (e.g during mobility procedures involving AMF change). (NOTE 3). | | +| subsChangeNotifyCorrelationId | string | C | 0..1 | This IE shall be present when an NF Service Consumer (e.g. UDM) is subscribing for events on behalf of another NF Service Consumer (e.g. NEF). When present, this IE shall contain the notification correlation ID. The AMF shall include it in the notifications for the creation of a new subscription ID that is considered as a change of subscription ID by the NF service consumer for event subscriptions related to single UE or as the creation of a new subscription Id for event subscriptions related to UE groups. The value of this IE shall be unique per subscription for a given NF service consumer that is sending this IE. (NOTE 3).. | | +| supi | Supi | C | 0..1 | Subscription Permanent Identifier (NOTE 2) | | +| groupId | GroupId | C | 0..1 | Identifies a group of UEs. (NOTE 2) | | +| excludeSupiList | array(Supi) | O | 1..N | This IE may be present for a group subscription.

When present, this IE shall carry the SUPI of the group member UE(s) that are excluded from the group subscription. | DGEM | +| excludeGpsiList | array(Gpsi) | O | 1..N | This IE may be present for a group subscription.

When present, this IE shall carry the GPSI of the group member UE(s) that are excluded from the group subscription. | DGEM | +| includeSupiList | array(Supi) | O | 1..N | This IE may be present for a group subscription.

When present, this IE shall carry the SUPI of the group member UE(s) that are included for the group subscription. | DGEM | +| includeGpsiList | array(Gpsi) | O | 1..N | This IE may be present for a group subscription.

When present, this IE shall carry the GPSI of | DGEM | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| | | | | the group member UE(s) that are included for the group subscription. | | +| gpsi | Gpsi | C | 0..1 | Generic Public Subscription Identifier (NOTE 2) | | +| pei | Pei | C | 0..1 | Permanent Equipment Identifier (NOTE 2) | | +| anyUE | boolean | C | 0..1 | This IE shall be present if the event subscription is applicable to any UE. Default value "FALSE" is used, if not present. The attribute shall be set to "TRUE", when the AMF event type is "SNSSAI_TA_MAPPING_REPORT".

(NOTE 2) | | +| options | AmfEventMode | O | 0..1 | This IE may be included if the NF service consumer wants to describe how the reports of the event have to be generated. The absence of this IE, when creating an AMF event subscription or when transferring the UE context to another AMF, shall be interpreted as a "ONE_TIME" AMF event trigger. | | +| sourceNfType | NFType | C | 0..1 | This IE should be present for a subscription that is created by an "intermediate NF" (e.g. UDM) on behalf of a "source NF" (e.g. NEF). When present, it shall contain the NF type of the "source NF". | | +| termNotifyInd | boolean | O | 0..1 | When present this IE shall indicate whether the notification of event subscription termination from the AMF is requested by the NF consumer.

- true: Event subscription termination notification requested
- false (default) Event subscription termination notification not requested | STEN | +| NOTE 1: When an NF Service Consumer subscribes on behalf of another NF, the Notification URI identifies a resource under the authority of the other NF. | | | | | | +| NOTE 2: Either information about a single UE (i.e. SUPI, GPSI, PEI) or groupId, or anyUE set to "TRUE" shall be included. | | | | | | +| NOTE 3: Same values of "subsChangeNotifyUri" and "subsChangeNotifyCorrelationId" shall be provided by an NF service consumer to all the serving AMF if the subscriptions apply to a group and triggered by one subscription from another NF. This allows the NF service consumer to associate the subscription Id creation notifications received from different serving AMFs to the same group Id subscription, | | | | | | + +### 6.2.6.2.3 Type: AmfEvent + +**Table 6.2.6.2.3-1: Definition of type AmfEvent** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|--------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| type | AmfEventType | M | 1 | Describes the AMF event type to be reported | | +| immediateFlag | boolean | O | 0..1 |

Indicates if an immediate event report containing the currently available value / status of the event is requested. The report contains the value / status of the event currently available at the AMF at the time of the subscription (NOTE 1). If the flag is not present then immediate reporting shall not be done and the first report is sent at event detection time.

When the subscribing NF subscribes on behalf of another NF, the IERSR feature controls whether or not an immediate report is sent within the subscribe response message or within a notification request message (see clause 5.3.2.2.2). Otherwise immediate reports are always sent within the subscribe response message.

The default value is false.

| | +| areaList | array(AmfEventArea) | O | 1..N |

Identifies the area to be applied.

More than one instance of AmfEventArea IE shall be used only when the AmfEventArea is provided during event subscription for Presence Reporting Area subscription.

| | +| locationFilterList | array(LocationFilter) | O | 1..N |

Describes the filters to be applied for LOCATION_REPORT event type.

If this attribute is not present in the request, it indicates the change of the TA used by the UE should be reported.

| | +| refId | ReferenceId | O | 0..1 | Indicates the Reference Id associated with the event. (NOTE 3) | | +| trafficDescriptorList | array(TrafficDescriptor) | O | 1..N | Indicates the filters to be applied for AVAILABILITY_AFTER_DDN_FAILURE event type. | | +| reportUeReachable | boolean | C | 0..1 |

This IE shall be present and set to value "true" by the source AMF to request the target AMF to notify the subscriber when UE becomes reachable, during inter-AMF mobility procedures.

When present, this IE shall be set as following:

  • - true: target AMF shall notify the subscriber when UE becomes reachable
  • - false (default): target AMF shall not notify the subscriber when UE becomes reachable, until next reporting trigger is detected, i.e. DDN failure detected (for AVAILABILITY_AFTER_DDN_FAILURE event) or UE becomes unreachable for downlink traffic (for "UE Reachable for DL Traffic" of REACHABILITY_REPORT event)

This IE only applies to following Event

| | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------|--| +| | | | | Types:
- AVAILABILITY_AFTER_DDN_FAILURE
- REACHABILITY_REPORT (for "UE
Reachable for DL Traffic") | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|--------------------|--------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| reachabilityFilter | ReachabilityFilter | O | 0..1 |

When present, this IE shall indicate the filter to be applied for the REACHABILITY_REPORT event type.

If the subscription of REACHABILITY_REPORT is for "UE Reachability Status Change", the AMF shall report current reachability state and subsequent updated reachability state of the UE, when AMF becomes aware of a UE reachability state change between REACHABLE, UNREACHABLE and REGULATORY_ONLY.

If the subscription of REACHABILITY_REPORT is for "UE Reachable for DL Traffic", the AMF shall report the "REACHABLE" state, when the UE transitions to CM-CONNECTED mode or when the UE will become reachable for paging, as specified in table 4.15.3.1-1, clauses 4.2.5 and 4.3.3 of 3GPP TS 23.502 [3].

If this IE is absent, the subscription of REACHABILITY_REPORT is for "UE Reachability Status Change".

| | +| udmDetectInd | boolean | O | 0..1 |

The IE may be present for subscription for "UE Reachable for DL Traffic".

When present, this IE shall indicate whether the UE Reachability Event will be detected at UDM (i.e. with Nudm_UECM_Registration) or not:

  • - true: UE Reachability will be detected at UDM
  • - false (default) UE Reachability will not be detected at UDM
| | +| maxReports | integer | O | 0..1 |

This IE may be present if the trigger is set to "CONTINUOUS" or "PERIODIC". When present, this IE describes the maximum number of reports that can be generated by the subscribed event.

If the AMF event subscription is for a group of UEs, this parameter shall be applied to each individual member UE of the group.

If the event subscription is transferred from source AMF to a target AMF, this IE shall contain:

  • - the remaining number of reports for the event subscription, in the case of individual UE event subscription; or
  • - the remaining number of reports for the event subscription for this specific UE, in the case of a group event subscription. If the group subscription has not expired and all reports have been sent already for this event, the remaining number of reports shall be set to "0".

(NOTE 2)

| | +| presenceInfoList | map(PresenceInfo) | O | 1..N | Map of PRA Information, the "prald" attribute within the PresenceInfo data type shall also be the key of the map. The | MPRA | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | "presenceState" attribute within the PresenceInfo data type shall not be supplied.
When present, the areaList shall be absent. | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-----------------|------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| maxResponseTime | DurationSec | C | 0..1 | This IE shall be present, when the UDM subscribes to "REACHABILITY_REPORT" event for "UE Reachable for DL Traffic" on behalf of the AF and the AF sets the Maximum Response Time in the Monitoring Configuration.

When present, this IE shall indicate the Maximum Response Time configured by the AF. | | +| targetArea | TargetArea | C | 0..1 | The IE shall be present for subscription for SNSSAI_TA_MAPPING_REPORT event type.

When present, this IE shall indicate the TAI list to be applied. | | +| snssaiFilter | array(ExtSnssai) | O | 1..N | The IE may be present for subscription for SNSSAI_TA_MAPPING_REPORT event type.

This IE shall be present for subscription of UE_MM_TRANSACTION_REPORT event to receive the UE Mobility Management Transaction numbers based on slices.

When present, this IE shall indicate the S-NSSAI list to be applied.

(NOTE 4) | | +| ueInAreaFilter | UeInAreaFilter | O | 0..1 | Indicates the filter to be applied for UES_IN_AREA_REPORT event type related to UAVs.

When present, this IE shall indicate the list of items to be applied together as filter. | UARF | +| minInterval | DurationSec | O | 0..1 | This IE may be present when the NF consumer subscribes to "REACHABILITY_REPORT" event for "UE Reachable for DL Traffic".

When present, this IE indicates the minimal interval to report the event, i.e. when an event is reported, a subsequent event report shall not be sent during the interval. | | +| nextReport | DateTime | O | 0..1 | This IE may be present when the event subscription is transferred from source AMF to a target AMF and minInterval is configured for this event.

When present, this IE shall indicate the UTC time point before when a subsequent event report shall be throttled. | | +| idleStatusInd | boolean | O | 0..1 | Idle Status Indication request.
May be present if type is REACHABILITY_REPORT or AVAILABILITY_AFTER_DDN_FAILURE
true: Idle status indication is requested
false (default): Idle status indication is not requested | | +| dispersionArea | DispersionArea | C | 0..1 | This IE shall be present for subscription to the UE_MM_TRANSACTION_REPORT event to receive the UE Mobility Management Transaction numbers based on location, or for subscription to the UE_LOCATION_TRENDS event.

When present, this IE indicates the target area where the related events to be reported for dispersion analytics. | | + +| | | | | | | +|--|--|--|--|----------|--| +| | | | | (NOTE x) | | +|--|--|--|--|----------|--| + +| | | | | | | +|--------------------------------------|-----------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| nextPeriodicReportTime | DateTime | C | 0..1 |

This IE should be present when the event subscription is transferred from source AMF to a target AMF and there are periodic report(s) to be generated for the event.

When present, this IE shall indicate the timestamp (in UTC) when the next periodic report for the event to be generated and notified to the NF consumer.

| | +| adjustAolOnRa | boolean | O | 0..1 |

This IE may be present if the (event) type IE is set to "PRESENCE_IN_AOI_REPORT".

When present, it shall be set as follows:

  • - true: the AMF may adjust the received AoI based on the UE's registration area.
  • - false (default) the AoI shall remain unchanged, i.e. it shall not be adjusted based on the UE's registration area.

See clause 5.3.4.4 of 3GPP TS 23.501 [2] and clauses 4.15.9.3.2, 4.15.9.4, 5.2.2.3.1 and Annex D.1 of 3GPP TS 23.502 [3].

| | +| ranTimingSynchronizationStatusChange | boolean | O | 0..1 |

This IE may be present if the (event) type IE is set to "PRESENCE_IN_AOI_REPORT".

When present, it shall be set as follows:

  • - true: this is a subscription for RAN timing synchronization status change event.
  • - false (default): this is not a subscription for RAN timing synchronization status change event

See clause 5.3.1 for the handling of this IE by the AMF.

| | +| notifyForSupiList | array(Supi) | O | 1..N |

This IE may be present if the (event) type IE is set to "PRESENCE_IN_AOI_REPORT" and the subscription targets Any UE.

If this IE is present with a non-empty list, the AMF shall report the AoI events only if an event concerns a UE belonging to the provided list of SUPIs.

If the IE is not present or if it is present with an empty list, the AMF shall report the AoI events for any UE, i.e. without checking SUPIs.

See clause 5.3.4.4 of 3GPP TS 23.501 [2] and clause 5.2.2.3.1 of 3GPP TS 23.502 [3].

| AOIEF | +| notifyForSnssaiDnnList | array(SNSSAI DNNItem) | O | 1..N |

This IE may be present if the (event) type IE is set to "PRESENCE_IN_AOI_REPORT" and the subscription targets Any UE.

If this IE is present with a non-empty list, the AMF shall report the AoI events only if an event concerns a UE having a PDU session established for the provided DNN(s)/S-NSSAI(s).

If the IE is not present or if it is present with an empty list, the AMF shall report the AoI events for any UE, i.e. without checking

| AOIEF | + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|---------------------------------------------------------------------------------------------------------------|--| +| | | | | DNNs/S-NSSAIs.

See clause 5.3.4.4 of 3GPP TS 23.501 [2]
and clause 5.2.2.3.1 of 3GPP TS 23.502 [3]. | | +| NOTE 1: The requested value of the location is the last known location (i.e. age of location may be greater than zero) if the immediate Flag is set to true. An NF Service Consumer requesting to receive the current location (i.e. age of location equal to zero) shall not set the immediateFlag to true when subscribing to a location event report.
NOTE 2: When creating an AMF event subscription with multiple events, the same maximum number of reports shall apply to each event. Accordingly, maxReports in this attribute should not be present when creating an AMF event subscription; if it is present, it shall contain the same value for all events and maxReports in the AmfEventMode shall have precedence over the maxReports in this attribute. maxReports in this attribute and maxReports in the AmfEventMode have different semantics when transferring the event subscription from a source AMF to a target AMF.
NOTE 3: Each Monitoring Configuration subscribed via UDM Event Exposure service uses a Reference Id as the key. This IE shall carry the Reference Id when UDM subscribes to the AMF event for the corresponding Monitoring Configuration.
NOTE 4: For a subscription to the UE_MM_TRANSACTION_REPORT event, either the snssaiFilter IE or the dispersionArea shall be present. The AMF shall report the UE MM Transaction numbers based on slices or location according to the presence of the IE. | | | | | | + +#### 6.2.6.2.4 Type: AmfEventNotification + +**Table 6.2.6.2.4-1: Definition of type AmfEventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifyCorrelationId | string | C | 0..1 |

This IE shall be included if the notification is not for informing creation of a new subscription Id.

This IE shall also be included if the notification is for informing the creation of a new subscription Id and the corresponding event subscription did not contain subsChangeNotifyCorrelationId attribute (see clause 6.2.6.2.2).

When present, this IE shall indicate the notification correlation Id provided by the NF service consumer during event subscription. This parameter can be useful if the NF service consumer uses a common call-back URI for multiple subscriptions.

| | +| subsChangeNotifyCorrelationId | string | C | 0..1 |

This IE shall be included if the notification is for informing the creation of a new subscription Id at the AMF and the corresponding event subscription contains the subsChangeNotifyCorrelationId attribute (see clause 6.2.6.2.2).

When present, this IE shall be set to the value of the subsChangeNotifyCorrelationId provided during subscription (see clause 6.2.6.2.2).

| | +| reportList | array(AmfEventReport) | C | 1..N |

This IE shall be present if a event is reported. When present, this IE represents the event reports to be delivered.

| | +| eventSubsSyncInfo | AmfEventSubsSyncInfo | C | 0..1 |

This IE may be present for AMF to initiate event subscription synchronization with UDM during UE mobility procedures.

When present, this IE shall contain the information for event subscription synchronization, including all active event subscriptions specifically targeting the UE.

| ESSYNC | + +6.2.6.2.5 Type: AmfEventReport + +**Table 6.2.6.2.5-1: Definition of type AmfEventReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| type | AmfEventType | M | 1 | Describes the type of the event which triggers the report | | +| state | AmfEventState | M | 1 | Describes the state of the event which triggered the report. This IE shall be set to "TRUE" when subscriptionId IE is present. | | +| timeStamp | DateTime | M | 1 | This IE shall contain the UTC time at which the event is generated. | | +| subscriptionId | Uri | C | 0..1 | This IE shall be included when the event notification is for informing the creation of a subscription Id at the AMF during mobility of a UE across AMFs.

When present, this IE shall contain the URI of the created subscription resource at the AMF; this shall contain an absolute URI set to the Resource URI specified in clause 6.2.3.3.2.

The type IE shall be set to:
- SUBSCRIPTION_ID_CHANGE, when the AMF creates a subscription Id for a UE specific event subscription during mobility registration and handover procedures involving an AMF change.
- SUBSCRIPTION_ID_ADDITION, when the AMF creates a subscription Id for a group Id specific event subscription during mobility registration and handover procedures involving an AMF change. | | +| anyUe | boolean | C | 0..1 | This IE shall be included and shall be set to "true", if the event subscription is a bulk subscription for number of UEs and the event reported is for one of those UEs. (NOTE 3) | | +| supi | Supi | C | 0..1 | This IE shall be present if available.

When present, this IE identifies the SUPI of the UE associated with the report (NOTE 1, NOTE 3). | | +| areaList | array(AmfEventArea) | C | 1..N | This IE shall be present when the AMF event type is "PRESENCE_IN_AOI_REPORT". When present, this IE represents the specified Area(s) of Interest the UE is currently IN / OUT / UNKNOWN.

If the AMF event is subscribed towards a PRA identifier referring to a Set of Core Network predefined Presence Reporting Areas, the AMF shall report both the subscribed PRA Identifier and the additional PRA identifier of the actually individual PRA(s) where the UE is currently IN / OUT, as specified in clause 5.6.11 of 3GPP TS 23.501 [2]. (NOTE 3) | | +| refId | ReferenceId | C | 0..1 | This IE shall be present if a Reference Id has previously been associated with the event triggering the report.

When present, this IE shall indicate the Reference Id associated with the event which triggers the report. | | +| gpsi | Gpsi | C | 0..1 | This IE shall be present if available.

When present, this IE identifies the GPSI of the UE associated with the report (NOTE 1, NOTE 3). | | +| pei | Pei | O | 0..1 | This IE may be included if the event reported is for a particular UE or any UE. This IE | | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------|--| +| | | | | identifies the PEI of the UE associated with the report (NOTE 1, NOTE 3). | | +|--|--|--|--|---------------------------------------------------------------------------|--| + +| | | | | | | +|--------------------|-------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| location | UserLocation | O | 0..1 | Represents the location information of the UE

This IE shall convey exactly one of the following:
- E-UTRA user location
- NR user location
- Non-3GPP access user location.

If the additionalLocation IE is present, this IE shall contain either an E-UTRA user location or NR user location. | | +| additionalLocation | UserLocation | O | 0..1 | This IE shall be present if the "location IE" is present and the AMF reports both a 3GPP user location and a non-3GPP access user location.

When present, this IE shall convey the non-3GPP access user location. | | +| timezone | TimeZone | O | 0..1 | Describes the time zone of the UE | | +| accessTypeList | array(Access Type) | O | 1..N | Describes the access type(s) of the UE.

When reporting that the UE is reachable for DL traffic, this IE shall indicate the access type(s) through which the UE is reachable.

This attribute shall be absent if the AMF event type is "SNSSAI_TA_MAPPING_REPORT". | | +| rmInfoList | array(RmInfo) | O | 1..N | Describes the registration management state of the UE | | +| cmInfoList | array(CmInfo) | O | 1..N | Describes the connection management state of the UE | | +| reachability | UeReachability | O | 0..1 | Describes the reachability of the UE | | +| commFailure | CommunicationFailure | O | 0..1 | Describes a communication failure for the UE. | | +| numberOfUes | integer | O | 0..1 | Represents the number of UEs in the specified area | | +| 5gsUserStateList | array(5GsUserStateInfo) | O | 1..N | Represents the 5GS User State of the UE per access type | | +| typeCode | string | C | 0..1 | This IE shall be present when the AMF event type is "TYPE_ALLOCATION_CODE_REPORT". When present, this IE represents the Type Allocation code (TAC), to indicate terminal model and vendor information of the UE. Pattern: '^[0-9]{8}\$'. | ENA | +| registrationNumber | integer | C | 0..1 | This IE shall be present when the AMF event type is "FREQUENT_MOBILITY_REGISTRATION_REPORT". When present, this IE represents the number of the mobility registration procedures during a period identified by the expiry time included in the event subscription request. | ENA | +| ueIdExtList | array(UEIdExt) | C | 1..N | This IE shall be present if multiple SUPIs and / or GPSIs need to be included and the subscribing NF indicated support of the ENA feature, unless the subscribing NF indicated to omit UE IDs in the event reports by including ueIdOmitInd IE with the value true.

This attribute provides additional SUPIs and / or GPSIs to the supi attribute or gpsci attribute if present. The ueIdExtList attribute may be present even if both the supi and gpsci | ENA | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------|--| +| | | | | attributes are absent, e.g., in a report of "UES_IN_AREA_REPORT" event type.
(NOTE 3) | | +|--|--|--|--|------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------------|----------------------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| lossOfConnectReason | LossOfConnectivityReason | O | 0..1 | Describes the reason for loss of connectivity. This IE should be present when the AMF event type is "LOSS_OF_CONNECTIVITY". | | +| maxAvailabilityTime | DateTime | O | 0..1 | Indicates the time (in UTC) until which the UE is expected to be reachable.

This IE may be present in REACHABILITY_REPORT event report for "UE Reachable_for DL Traffic".

This information may be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Message to UEs using a power saving mechanism (eDRX, PSM etc.). | | +| snssaiTaiList | array(SNSSAITaiMapping) | C | 1..N | This IE shall be present when the AMF event type is "SNSSAI_TA_MAPPING_REPORT". When present, this IE represents the list of supported S-NSSAIs at the TAI(s). It shall also include the indication if S-NSSAI is restricted at the AMF. | | +| idleStatusIndication | IdleStatusIndication | O | 0..1 | Idle Status Indication
May be present when type is REACHABILITY_REPORT or AVAILABILITY_AFTER_DDN_FAILURE | | +| ueAccessBehaviorTrends | array(UeAccessBehaviorReportItem) | C | 1..N | This IE shall be present to report "UE_ACCESS_BEHAVIOR_TRENDS" event.

When present, this IE shall include the UE access behavior trends within the report period. | | +| ueLocationTrends | array(UeLocationTrendsReportItem) | C | 1..N | This IE shall be present to report "UE_LOCATION_TRENDS" event.

When present, this IE shall include the UE location trends within the report period.
(NOTE 2) | | +| mmTransLocationReportList | array(MmTransactionLocationReportItem) | C | 1..N | This IE shall be present to report "UE_MM_TRANSACTION_REPORT" event based on location.

When present, this IE shall include the number of UE MM transactions per location within the report period. | | +| mmTransSliceReportList | array(MmTransactionSliceReportItem) | C | 1..N | This IE shall be present to report "UE_MM_TRANSACTION_REPORT" event based on slices.

When present, this IE shall include the number of UE MM transactions per slice within the report period. | | +| termReason | SubTerminationReason | O | 0..1 | This IE may be present when the event type is SUBSCRIPTION_TERMINATION.

When present, this IE shall indicate the reason for the subscription termination. | | +| unavailabilityPeriod | DurationSec | O | 0..1 | This IE shall be present when the event type is LOSS_OF_CONNECTIVITY and Unavailability Period Duration is reported by the UE.

When present, it contains the Unavailability Period Duration reported by the UE. If the UE is already not available when the event is subscribed, it is set to the remaining value of | | + +| | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|---------------------------------|--| +| | | | | Unavailability Period Duration. | | +|

NOTE 1: If the event report corresponds to an event subscription of a single UE, then the same UE identifier (i.e. SUPI and/or GPSI and/or PEI) received during subscription creation shall be included in the report. If the event report corresponds to an event subscription for group of UEs or any UE, then the SUPI and if available the GPSI shall be included in the event report. SUPI, PEI and GPSI shall not be present in report for UES_IN_AREA_REPORT event type.

NOTE 2: The items shall be listed in descending order by the value of "duration" attribute.

NOTE 3: When a subscription for "PRESENCE_IN_AOI_REPORT" event targets any UE but no UE is "IN" the AOI when the AMF generates the first notification (e.g. for one-time reporting or for the first notification for continuously reporting), the anyUe IE shall be present with the value true and IEs indicating UE IDs (Supi, Gpsi, Pei and ueIdExtList) shall not be present; the areaList IE shall be present including the subscribed AOI with the Presence Status set to "IN", i.e. no UE is "IN" the AOI.

| | | | | | + +## 6.2.6.2.6 Type: AmfEventMode + +**Table 6.2.6.2.6-1: Definition of type AmfEventMode** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| trigger | AmfEventTrigger | M | 1 | Describes how the reports are triggered. | | +| maxReports | integer | C | 0..1 |

This IE shall be present if the trigger is set to "CONTINUOUS" while "expiry" attribute is not present. This IE may be present if the trigger is set to "PERIODIC". When present, this IE describes the maximum number of reports that can be generated by each subscribed event in the subscription.

If the AMF event subscription is for a list of events, this parameter shall be applied to each individual event in the list.

If the AMF event subscription is for a group of UEs, this parameter shall be applied to each individual member UE of the group.

If the event subscription is transferred from source AMF to target AMF, this IE shall contain:

  • - the remaining number of reports for the event subscription, in the case of individual UE event subscription;
  • - the maximum number of reports for each event of the AMF event subscription for each individual member of the group, in the case of a group event subscription.

(NOTE 1)

(NOTE 2)

| | +| expiry | DateTime | C | 0..1 |

This IE shall be included in an event subscription response, if, based on operator policy and taking into account the expiry time included in the request, the AMF needs to include an expiry time.

This IE may be included in an event subscription request.

When present, this IE shall represent the UTC time after which the subscribed event(s) shall stop generating report and the subscription becomes invalid. If the trigger value included in an event subscription response is "ONE_TIME" and if an event report is included in the subscription response then the value of the expiry included in the response shall be an immediate timestamp.

(NOTE 1)

| | +| repPeriod | DurationSec | C | 0..1 |

This IE shall be present if the trigger is set to "PERIODIC". When present, this IE describes the period time for the event reports. If the AMF event subscription is for a group of UEs, this parameter shall be applied to each individual member UE of the group.

(NOTE 3)

| | +| sampRatio | SamplingRatio | O | 0..1 |

This IE may be included in an event subscription request for a group of UEs or any UE to indicate the ratio of the random subset to target UEs. Event reports only relate to the subset.

If the AMF event subscription is for a list of AMF event, this parameter shall be applied to each individual event.

| | +| partitioningCriteria | array(PartitioningCriteria) | O | 1..N | This IE may be included in an event subscription request for a group of UEs or any | | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| | | | | UE when sampRatio is provided.

When present, this IE shall define the criteria for determining the UEs for which the sampling ratio shall apply. | | +| notifFlag | NotificationFlag | O | 0..1 | Indicates the notification flag, which is used to mute/unmute notifications and to retrieve events stored during a period of muted notifications. | EneNA | +| mutingExclInstructions | MutingExceptionInstructions | O | 0..1 | This IE may be included in the event subscription request if the notifFlag IE is present and set to "DEACTIVATE".
When present, it shall indicate the instructions for the subscription and stored events when an exception (e.g. the buffer of stored event reports is full, or the number of stored event reports exceeds a certain number) occurs at AMF while the events are muted.
See 3GPP TS 23.288 [38], clause 6.2.7.2.
Write-Only: true | ENAPH3 | +| mutingNotSettings | MutingNotificationsSettings | O | 0..1 | This IE may be included if the event notifications muting is activated.
This IE Indicates the AMF muting notification settings.
See 3GPP TS 23.288 [38], clause 6.2.7.2.
Read-Only: true | ENAPH3 | +| varRepPeriodInfo | array(VarRepPeriod) | O | 1..N | This IE may be present if the trigger is set to "PERIODIC".
This IE Indicates the variable reporting periodicity information.
See 3GPP TS 23.502 [3], clause 4.15.1.
(NOTE 3) | ENAPH3 | +| NOTE 1: If the AmfEventTrigger is set to "CONTINUOUS", at least one of the "maxReports" and "expiry" attributes shall be included. | | | | | | +| NOTE 2: See NOTE 2 of Table 6.2.6.2.3-1 regarding the precedence between maxReports in AmfEvent and maxReports in this attribute. | | | | | | +| NOTE 3: If both repPeriod and varRepPeriodInfo attributes are present, the repPeriod shall be applied if none of the conditions trigger the variable reporting is met. | | | | | | + +#### 6.2.6.2.7 Type: AmfEventState + +**Table 6.2.6.2.7-1: Definition of type AmfEventState** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| active | boolean | M | 1 | Represents the active state of the subscribe event. "TRUE" value indicates the event will continue generating reports; "FALSE" value indicates the event will not generate further report. | +| remainReports | integer | O | 0..1 | Represents the number of remain reports to be generated by the subscribed event. | +| remainDuration | DurationSec | O | 0..1 | Represents how long the subscribed event will continue generating reports. | + +#### 6.2.6.2.8 Type: RmInfo + +**Table 6.2.6.2.8-1: Definition of type RmInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|-------------------------------------------------------------------------------------------------| +| rmState | RmState | M | 1 | Describes the registration management state of the UE | +| accessType | AccessType | M | 1 | Describes the access type of the UE that applies to the registration management state reported. | + +## 6.2.6.2.9 Type: CmInfo + +Table 6.2.6.2.9-1: Definition of type CmInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|-----------------------------------------------------------------------------------------------| +| cmState | CmState | M | 1 | Describes the Connection management state of the UE | +| accessType | AccessType | M | 1 | Describes the access type of the UE that applies to the Connection management state reported. | + +## 6.2.6.2.10 Void + +## 6.2.6.2.11 Type: CommunicationFailure + +Table 6.2.6.2.11-1: Definition of type CommunicationFailure + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nasReleaseCode | string | O | 0..1 | Describes the NAS release code for the communication failure. This IE shall be formatted following the regular expression pattern:
"^(MM SM)-[0-9]{1,3}\$"

Examples:
MM-7
SM-27 | +| ranReleaseCode | NgApCause | O | 0..1 | Describes the RAN release code for the communication failure. If present, this IE shall contain the decimal value of the NG AP cause code values as specified in 3GPP TS 38.413 [12]. | + +## 6.2.6.2.12 Type: AmfCreateEventSubscription + +Table 6.2.6.2.12-1: Definition of type AmfCreateEventSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subscription | AmfEventSubscription | M | 1 | Represents the AMF Event Subscription resource to be created. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported. | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | + +## 6.2.6.2.13 Type: AmfCreatedEventSubscription + +**Table 6.2.6.2.13-1: Definition of type AmfCreatedEventSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subscription | AmfEventSubscription | M | 1 | Represents the newly created AMF Event Subscription resource. | +| subscriptionId | Uri | M | 1 | Represents the URI of the newly created AMF Event Subscription resource. This shall contain an absolute URI set to the Resource URI specified in clause 6.2.3.3.2. (NOTE 2) | +| reportList | array(AmfEventReport ) | O | 1..N | Represents the immediate event reports (i.e. the current value / status of the events subscribed), if available (NOTE 1). | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported. | + +NOTE 1: If the subscription is on behalf of another NF and the NF service consumer has not indicated supporting of IERSR feature (see 6.2.8), then the reports attribute shall be absent. +NOTE 2: 3GPP TS 23.502 [3] specifies this attribute as "Subscription Correlation ID". + +6.2.6.2.14 Type: AmfUpdateEventSubscriptionItem + +**Table 6.2.6.2.14-1: Definition of type AmfUpdateEventSubscriptionItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| op | string | M | 1 |

This IE indicates the patch operation as defined in IETF RFC 6902 [14] to be performed on resource.

This IE shall support the following values:
Enum: "add"
Enum: "replace"
Enum: "remove"

| | +| path | string | M | 1 |

This IE contains a JSON pointer value (as defined in IETF RFC 6901 [40]) that references a location of a resource on which the patch operation shall be performed.

This IE shall contain the JSON pointer to a valid index of the "/eventList" array in the AMF Event Subscription, formatted with following pattern:
'^VeventListV[0-9\$] VeventListV[1-9][0-9]*\$'

Example:
"/eventList/0" stands for the first member of the array;
"/eventList/10" stands for the 11th member of the array;
"/eventList/-" stands for a new (non-existent) member after the last existing array element. Only allowed with "add" operation.

To update the PRA Information, this IE shall contain the JSON pointer to a valid key of the "/presenceInfoList" object in the AMF Event Subscription, the key shall be formatted as the "pralD" attribute within the PresenceInfo data type.
Pattern: '^(\VeventListV0 VeventListV[1-9][0-9]*\}{1}(\VpresenceInfoListV0 VpresenceInfoListV[1-9][0-9]*\})?\$'

Example:
"/eventList/10/presenceInfoList/123" stands for the PresenceInfo with PRA ID 123 for the 11th member of the array.
(NOTE 1)

To remove list of group member UE(s) from a group subscription, this IE shall contain the JSON pointer to the "/excludeSupiList" object or "/excludeGpsiList" object in the AMF Event Subscription,

Pattern:
'^VexcludeSupiList VexcludeGpsiList\$'

(NOTE 2)

To add list of group member UE(s) into a group subscription, this IE shall contain the JSON pointer to the "/includeSupiList" object or "/includeGpsiList" object in the AMF Event Subscription,

Pattern:
'^VincludeSupiList VincludeGpsiList\$'

(NOTE 3)

To modify the notifyForSupiList IE or the

| | + +| | | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

notifyForSnssaiDnnList IE, this IE shall contain the JSON pointer to the "/notifyForSupiList" or "/notifyForSnssaiDnnList" attribute in the AMF Event Subscription. The new list of SUPIs or DNN/S-NSSAIs shall replace any earlier received list of SUPIs or DNNs/S-NSSAIs respectively.

Pattern: '^(VeventListV0 VeventListV[1-9][0-9]*)(1)(VnotifyForSupiList)\$'

Pattern: '^(VeventListV0 VeventListV[1-9][0-9]*)(1)(VnotifyForSnssaiDnnList)\$'

(NOTE 4)

| | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|------------------------|------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| value | AmfEvent | C | 0..1 | This IE indicates a new AMF event to be added or updated value of an existing AMF event to be modified.
It shall be present if the patch operation is "add" or "replace" | | +| presenceInfo | PresenceInfo | O | 0..1 | This IE indicates a new PresenceInfo to be added or an existing PresenceInfo to be modified. The "presenceState" attribute within the PresenceInfo data type shall not be supplied.

It shall be present if the patch operation is "add". | MPRA | +| excludeSupiList | array(Supi) | O | 1..N | When present, this IE shall carry the SUPI of the group member UE(s) that are excluded from the group subscription.

This IE shall be present if the path attribute containing JSON pointer to "/excludeSupiList" object and the patch operation is "add" and "replace". | DGEM | +| excludeGpsiList | array(Gpsi) | O | 1..N | When present, this IE shall carry the GPSI of the group member UE(s) that are excluded from the group subscription.

This IE shall be present if the path attribute containing JSON pointer to "/excludeGpsiList" object and the patch operation is "add" and "replace". | DGEM | +| includeSupiList | array(Supi) | O | 1..N | When present, this IE shall carry the SUPI of the group member UE(s) that are included for the group subscription.

This IE shall be present if the path attribute containing JSON pointer to "/includeSupiList" object and the patch operation is "add" and "replace". | DGEM | +| includeGpsiList | array(Gpsi) | O | 1..N | When present, this IE shall carry the GPSI of the group member UE(s) that are included for the group subscription.

This IE shall be present if the path attribute containing JSON pointer to "/includeGpsiList" object and the patch operation is "add" and "replace". | DGEM | +| notifyForSupiList | array(Supi) | C | 1..N | When present, this IE shall contain the list of SUPIs for which the AMF shall report the AoI events.

This IE shall be present if the path attribute contains a JSON pointer to the "/notifyForSupiList" attribute in the AMF Event Subscription and the patch operation is "add" or "replace". | AOIEF | +| notifyForSnssaiDnnList | array(SNSSAI DNN Item) | C | 1..N | When present, this IE shall contain the list of DNNs/S-NSSAIs for which the AMF shall report the AoI events.

This IE shall be present if the path attribute contains a JSON pointer to the "/notifyForSnssaiDnnList" attribute in the AMF Event Subscription and the patch operation is "add" or "replace". | AOIEF | + +NOTE 1: Update of PRA information by extending the schema of the path IE with JSON pointer to a valid key of the "/presenceInfoList" object shall only be used if the AMF supports the MPRA feature. + +NOTE 2: Remove group member UE(s) by extending the schema of the path IE with JSON pointer to the "/excludeSupiList" object or "/excludeGpsiList" object shall only be used if the AMF supports the DGEM feature. + +NOTE 3: Add group member UE(s) by extending the schema of the path IE with JSON pointer to the "/includeSupiList" object or "/includeGpsiList" object shall only be used if the AMF supports the DGEM feature. +NOTE 4: Modifying the list of SUPIs or DNNs/S-NSSAIs shall only be used if the AMF supports the AOIEF feature. + +#### 6.2.6.2.15 Type: AmfUpdatedEventSubscription + +**Table 6.2.6.2.15-1: Definition of type AmfUpdatedEventSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------| +| subscription | AmfEventSubscription | M | 1 | Represents the updated AMF Event Subscription resource. | +| reportList | array(AmfEventReport) | O | 1..N | Represents the immediate event reports (i.e. the current value / status of the events subscribed), if available (NOTE). | +| NOTE: For newly added AMF event subscription(s) with the immediateFlag attribute set to true, immediate event report(s) of the corresponding AMF event subscription shall be provided if available. | | | | | + +#### 6.2.6.2.16 Type: AmfEventArea + +**Table 6.2.6.2.16-1: Definition of type AmfEventArea** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| presenceInfo | PresenceInfo | C | 0..1 | This IE shall be present if the Area of Interest subscribed is not a LADN service area (e.g Presence Reporting Area or a list of TAI / cell Ids) . (See NOTE1, NOTE 2) | | +| ladnInfo | LadnInfo | C | 0..1 | This IE shall be present if the Area of Interest subscribed is a LADN service area. | | +| sNssai | SNSSAI | O | 0..1 | When present, it shall contain the associated S-NSSAI of the area. | ENA | +| nsId | NsId | O | 0..1 | When present, this IE shall contain the associated NSI ID of the S-NSSAI. | ENA | +| NOTE 1: When the AmfEventArea is provided during event subscription, then for UE specific presence reporting area subscription, the prald along with what constitutes that UE specific presence reporting area (i.e. set of Tai and/or set of ecgi and/or set of ncgi and/or set of globalRanNodeId) shall be provided. | | | | | | +| NOTE 2: If the subscription is for a Set of Core Network Predefined Presence Reporting Areas and both the AMF and the NF service consumer support the "APRA" feature, the PRA Identifier for the Set shall be carried in the "prald" IE and the individual PRA identifier shall be carried in the "additionalPrald" IE; if the subscription is for a Set of Core Network Predefined Presence Reporting Areas and the AMF or NF service consumer does not support the "APRA" feature, the individual PRA identifier shall be carried in the "prald" IE and the "additionalPrald" IE shall not be present. | | | | | | + +#### 6.2.6.2.17 Type: LadnInfo + +**Table 6.2.6.2.17-1: Definition of type LadnInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ladn | string | M | 1 | Represents the Local Access Data Network DNN. The AMF shall identify the list of tracking areas corresponding to the LADN DNN based on local configuration. | +| presence | PresenceState | C | 0..1 | This IE shall be included when the UE presence in area of interest is reported. When present, this IE contains the status of UE presence within the Area of Interest (IN / OUT / UNKNOWN). | + +## 6.2.6.2.18 Type: AmfUpdateEventOptionItem + +Table 6.2.6.2.18-1: Definition of type AmfUpdateEventOptionItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| op | string | M | 1 | This IE indicates the patch operation as defined in IETF RFC 6902 [14] to be performed on resource.
This IE shall support the following values:
Enum: "replace" | | +| path | string | M | 1 | This IE contains a JSON pointer value (as defined in IETF RFC 6901 [40]) that references a location of a resource on which the patch operation shall be performed.

This IE shall contain the JSON pointer to "/options/expiry" attribute of the event subscription resource.

Pattern: "^/optionsV/expiry\$"

To update the notifFlag attribute, this IE shall contain the JSON pointer to "/options/notifFlag" attribute of the event subscription resource.

Pattern: "^/optionsV/notifFlag\$"

To update the mutingExclInstructions attribute, this IE shall contain the JSON pointer to "/options/mutingExclInstructions" attribute of the event subscription resource.

Pattern: "^/optionsV/mutingExclInstructions\$" | | +| value | DateTime | M | 1 | This IE indicates the updated expiry timer value (in UTC) as suggested by the NF service consumer.

For update the notifFlag attribute, it shall contain the Null value. AMF shall ignore the value and not modify the expiry attribute. | | +| notifFlag | Notification Flag | O | 0..1 | Indicates the notification flag, which is used to mute/unmute notifications and to retrieve events stored during a period of muted notifications. | EneNA | +| mutingExclInstructions | MutingExceptionInstructions | O | 0..1 | This IE may be included if the event notifications muting is being activated. It shall be present if the path IE contains a JSON pointer to the mutingExclInstructions IE of the event subscription resource.
When present, it shall indicate the instructions for the subscription and stored events when an exception (e.g. the buffer of stored event reports is full, or the number of stored event reports exceeds a certain number) occurs at AMF while the events notification is muted.
See 3GPP TS 23.288 [38], clause 6.2.7.2. | ENAPH3 | + +## 6.2.6.2.19 Type: 5GsUserInfo + +Table 6.2.6.2.19-1: Definition of type 5GsUserInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|----------------------------------------------------------------------------------| +| 5gsUserInfo | 5GsUserInfo | M | 1 | Describes the 5GS user state of the UE | +| accessType | AccessType | M | 1 | Describes the access type of the UE that applies to the 5GS user state reported. | + +## 6.2.6.2.20 Type: TrafficDescriptor + +Table 6.2.6.2.20-1: Definition of type TrafficDescriptor + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | C | 0..1 | This IE shall be present if it is available. When present, it shall indicate the Data Network Name. | +| sNssai | Snssai | C | 0..1 | This IE shall be present if it is available. When present, it shall indicate the associated S-NSSAI for the PDU Session. | +| dddTrafficDescriptorList | array(DddTrafficDescriptor) | C | 1..N | This IE shall be present if it is available. When present, it shall indicate the Traffic Descriptor related to the traffic. | + +## 6.2.6.2.21 Type: UEIdExt + +Table 6.2.6.2.21-1: Definition of type UEIdExt + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| supi | Supi | C | 0..1 | This IE shall be present if available.
When present, this IE identifies the SUPI of the UE associated with the report. | +| gpsi | Gpsi | C | 0..1 | This IE shall be present if available.
When present, this IE identifies the GPSI of the UE associated with the report. | + +## 6.2.6.2.22 Type: AmfEventSubsSyncInfo + +Table 6.2.6.2.22-1: Definition of type AmfEventSubsSyncInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| subscriptionList | array(AmfEventSubscriptionInfo) | M | 1..N | This IE shall contain all active subscriptions in the AMF for the target UE.

Transferred subscriptions that are not authorized by the target AMF shall not be regarded active. Based on local policy, the target AMF may consider that transferred subscriptions containing no or an invalid access token are not authorized. | | + +## 6.2.6.2.23 Type: AmfEventSubscriptionInfo + +Table 6.2.6.2.23-1: Definition of type AmfEventSubscriptionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| subId | Uri | M | 1 | This IE shall contain the URI of the subscription resource of events with Reference Id. | | +| notifyCorrelationId | string | M | 1 | This IE shall contain the notification correlation ID of the subscription. | | +| refIdList | array(ReferenceId) | M | 1..N | This IE shall contain the Reference Ids of the events in the subscription, one Reference Id per event. | | +| oldSubId | Uri | C | 0..1 | This IE shall be present if new event subscription Id is created in the new AMF, i.e. the event subscription has been retrieved from an old AMF in UE context during EPS to 5GS mobility.

When present, this IE shall include the URI of the subscription resource on the source AMF. | | + +## 6.2.6.2.24 Type: TargetArea + +Table 6.2.6.2.24-1: Definition of type TargetArea + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| taList | array(Tai) | C | 1..N | When present, this IE shall contain the list of TAs. (NOTE) | +| taiRangeList | array(TaiRange) | C | 1..N | When present, this IE shall contain range(s) of TAs. (NOTE) | +| anyTa | boolean | C | 0..1 | This IE shall be present if the event subscription is applicable to any TA. Default value "FALSE" is used, if not present (NOTE) | + +NOTE: Either information about taList or taiRangeList or anyTa set to "TRUE" shall be included. + +## 6.2.6.2.25 Type: SnssaiTaiMapping + +Table 6.2.6.2.25-1: Definition of type SnssaiTaiMapping + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reportingArea | TargetArea | M | 1 | This IE shall contain the list of TAs/TAI ranges or anyTa. The taList and taiRangeList shall be absent, and the anyTa shall be set to "TRUE", if the mapping is related to all of the TAs in the AMF. | +| accessTypeList | array(AccessType) | O | 1..N | Describes the access type(s) of the reportingArea. | +| supportedSnssaiList | array(SupportedSnssai) | C | 1..N | This IE shall be present if available.

When present, this IE represents the list of S-NSSAIs (including indication of S-NSSAIs restricted by AMF) at the reportingArea. | + +## 6.2.6.2.26 Type: SupportedSnssai + +Table 6.2.6.2.26-1: Definition of type SupportedSnssai + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | This IE shall contain the supported S-NSSAI. | +| restrictionInd | boolean | O | 0..1 |

If present, this IE shall contain the indication if the S-NSSAI available in sNssai IE is restricted at the AMF.

When present, this IE shall be set as follows:

  • - true: the S-NSSAI available in sNssai IE is restricted at the AMF;
  • - false (default): the S-NSSAI available in sNssai IE is not restricted at the AMF.
| + +## 6.2.6.2.27 Type: UeInAreaFilter + +Table 6.2.6.2.27-1: Definition of type UeInAreaFilter + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ueType | UeType | C | 0..1 |

When present, this IE shall contain the list of UE types.

When this IE is received, The AMF shall report the number of UEs with the indicated UE type in the area.

| +| aerialSrvDnnInd | boolean | C | 0..1 |

When present, this IE shall contain an indication of DNN(s) subject to aerial service.

Default value "FALSE" is used, if not present.

This IE may be set to "TRUE" if the NF service consumer wants to retrieve the number of UEs in the area with established PDU sessions for DNN(s) subject to aerial service.

| +| ueIdOmitInd | boolean | O | 0..1 |

When present, this IE shall indicate whether UE ID(s) should be omitted in the event reports:

  • - true: UE ID(s) to be omitted in report
  • - false (default): UE IDs are not to be omitted in report.
| + +NOTE: When the value of IE ueType is AERIAL\_UE, the IE ueType and IE aerialSrvDnnInd shall be considered with "AND" for filtering. + +## 6.2.6.2.28 Type: IdleStatusIndication + +Table 6.2.6.2.28-1: Definition of type IdleStatusIndication + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-------------|---|-------------|-----------------------------------------------------|---------------| +| timeStamp | DateTime | O | 0..1 | Point in UTC time when the UE returned to Idle | | +| activeTime | DurationSec | O | 0..1 | Active Time granted to the UE. | | +| subsregTimer | DurationSec | O | 0..1 | Subscribed periodic registration time. | | +| edrxCycleLength | integer | O | 0..1 | Contains the eDRX cycle length in milliseconds. | | +| suggestedNumOfDIPackets | integer | O | 0..1 | Suggested number of downlink packets to be buffered | | + +## 6.2.6.2.29 Type: UeAccessBehaviorReportItem + +Table 6.2.6.2.29-1: Definition of type UeAccessBehaviorReportItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| stateTransitionType | AccessStateTransitionType | M | 1 | Indicate the type the state transition behavior. | | +| spacing | DurationSec | M | 1 | Indicates the average and variance of the time interval separating two consecutive occurrences of the state transition as indicated by the stateTransitionType IE. | | +| duration | DurationSec | M | 1 | Indicate the average and variance of duration in the resulting state as indicated by stateTransitionType IE. | | + +## 6.2.6.2.30 Type: UeLocationTrendsReportItem + +Table 6.2.6.2.30-1: Definition of type UeLocationTrendsReportItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| tai | Tai | C | 0..1 | Indicates the TAI where the UE arrived.
(NOTE) | | +| ncgi | Ncgi | C | 0..1 | Indicates the NR cell where the UE arrived.
(NOTE) | | +| ecgi | Ecgi | C | 0..1 | Indicates the EUTRAN cell where the UE arrived.
(NOTE) | | +| n3gaLocation | N3gaLocation | C | 0..1 | Indicates the Non-3GPP location where the UE arrived.
(NOTE) | | +| spacing | DurationSec | M | 1 | Indicates the average and variance of the time interval separating two consecutive arrivals at the indicated location. | | +| duration | DurationSec | M | 1 | Indicate the average and variance of duration of stay in the indicated location. | | +| timestamp | DateTime | M | 1 | Indicates the date and time (in UTC) of UE last arrival to the indicated location. | | + +NOTE: At least one of the "tai", "ncgi", "ecgi" and "n3gaLocation" shall be present. + +## 6.2.6.2.31 Type: DispersionArea + +Table 6.2.6.2.31-1: Definition of type DispersionArea + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tailList | array(Tai) | C | 1..N | Indicates the TAI where the UE information to be counted for Dispersion Analytics.
(NOTE) | | +| ncgiList | array(Ncgi) | C | 1..N | Indicates the NR cells where the UE information to be counted for Dispersion Analytics.
(NOTE) | | +| ecgiList | array(Ecgi) | C | 1..N | Indicates the EUTRAN cells where the UE information to be counted for Dispersion Analytics.
(NOTE) | | +| n3galnd | boolean | C | 0..1 | Indicates whether that the UE information shall be counted for Non-3GPP access or not.

When present, it should be set as following:
- true: The UE information shall be counted for Non-3GPP access.
- false (default): the UE information for Non-3GPP access shall not be counted. | | + +NOTE: One and only one of the "tailList", "ncgiList", "ecgiList" or "n3galnd" shall be present. + +## 6.2.6.2.32 Type: MmTransactionLocationReportItem + +Table 6.2.6.2.32-1: Definition of type MmTransactionLocationReportItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|---------------------------------------------------------------------------------|---------------| +| tai | Tai | C | 0..1 | Indicates the TAI where the UE MM transactions are counted.
(NOTE) | | +| ncgi | Ncgi | C | 0..1 | Indicates the NR cell where the UE MM transactions are counted.
(NOTE) | | +| ecgi | Ecgi | C | 0..1 | Indicates the EUTRAN cell where the UE MM transactions are counted.
(NOTE) | | +| n3gaLocation | N3gaLocation | C | 0..1 | Indicates the Non-3GPP location where UE MM transactions are counted.
(NOTE) | | +| timestamp | DateTime | M | 1 | Indicates the timestamp (in UTC) when the UE enters the location. | | +| transactions | integer | M | 1 | Totally number of UE MM Transactions counted within the location. | | + +NOTE: At least one of the "tai", "ncgi" or "ecgi" shall be present. + +## 6.2.6.2.33 Type: MmTransactionSliceReportItem + +**Table 6.2.6.2.33-1: Definition of type MmTransactionSliceReportItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Indicates the S-NSSAI of the slice where the UE MM Transactions are counted. | | +| timestamp | DateTime | M | 1 | Indicates the timestamp (in UTC) when the slice is assigned to the UE.
(NOTE) | | +| transactions | integer | M | 1 | Totally number of UE MM Transactions counted for the indicated slice. | | + +NOTE: The timestamps for assigned slices of a UE are not passed between AMFs, i.e. when a UE moves to a new AMF the timestamps for assigned slices of the UE are set to the date and time when the mobility happened in the new AMF. + +## 6.2.6.3 Simple data types and enumerations + +## 6.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. + +## 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +### 6.2.6.3.3 Enumeration: AmfEventType + +**Table 6.2.6.3.3-1: Enumeration AmfEventType** + +| Enumeration value | Description | +|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "LOCATION_REPORT" | A NF subscribes to this event to receive the Last Known Location or the current Location of a UE or a group of UEs, and Updated Location of the UE or any UE in the group when AMF becomes aware of a location change of the UE. | +| "PRESENCE_IN_AOI_REPORT" | A NF subscribes to this event to receive the current present state of a UE in a specific Area of Interest (AOI), and notification when a specified UE enters or leaves the specified area. The area could be identified by a TA list, an area ID or specific interest area name like "LADN". | +| "TIMEZONE_REPORT" | A NF subscribes to this event to receive the current time zone of a UE or a group of UEs, and updated time zone of the UE or any UE in the group when AMF becomes aware of a time zone change of the UE. | +| "ACCESS_TYPE_REPORT" | A NF subscribes to this event to receive the current access type(s) of a UE or a group of UEs, and updated access type(s) of the UE or any UE in the group when AMF becomes aware of the access type change of the UE. | +| "REGISTRATION_STATE_REPORT" | A NF subscribes to this event to receive the current registration state of a UE or a group of UEs, and report for updated registration state of a UE or any UE in the group when AMF becomes aware of a registration state change of the UE. | +| "CONNECTIVITY_STATE_REPORT" | A NF subscribes to this event to receive the current connection management state of a UE or a group of UEs, and report for updated connection management state of a UE or any UE in the group when AMF becomes aware of a connection management state change of the UE. | +| "REACHABILITY_REPORT" | A NF subscribes to this event to receive the current reachability of a UE or a group of UEs, and report for updated reachability of a UE or any UE in the group when AMF becomes aware of a reachability change of the UE. | +| "COMMUNICATION_FAILURE_REPORT" | A NF subscribes to this event to receive the Communication failure report of a UE or group of UEs or any UE. | +| "UES_IN_AREA_REPORT" | A NF subscribes to this event to receive the number of UEs in a specific area. | +| "SUBSCRIPTION_ID_CHANGE" | This event type is used by the AMF to inform the NF service consumer that the subscription Id for the event subscription is changed (e.g. Subscription Id creation at the target AMF for individual UE level event subscriptions, during mobility registration or handover procedures involving an AMF change). This event needs no explicit subscription form an NF service consumer. | +| "SUBSCRIPTION_ID_ADDITION" | This event type is used by the AMF to inform the NF service consumer that a new subscription Id is added (e.g creation of an event subscription for a UE group level event subscription at the target AMF, during mobility registration or handover procedures involving AMF change for a UE belonging to a group Id and when such a UE is the first UE of the group registering at the target AMF). This event needs no explicit subscription form the NF service consumer. | +| "SUBSCRIPTION_TERMINATION" | This event type is used by the AMF to inform the NF service consumer that the subscription is terminated at the AMF, e.g. the AMF inform the UDM that the subscription is terminated because the AMF has identified the subscription is no longer valid at the NEF. | + +| | | +|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "LOSS_OF_CONNECTIVITY" | An NF subscribes to this event to receive the event report of a UE or group of UEs when AMF detects that a target UE is no longer reachable for either signalling or user plane communication. Such condition is identified when Mobile Reachable timer expires in the AMF (see 3GPP TS 23.501 [2]), when the UE detaches and when AMF deregisters from UDM for an active UE. If the UE is already not reachable for either signalling or user plane communication when the event is subscribed, the AMF reports the event directly. | +| "5GS_USER_STATE_REPORT" | A NF subscribes to this event to receive the 5GS user state of a UE. | +| "AVAILABILITY_AFTER_DDN_FAILURE" | A NF subscribes to this event to be notified about the Availability of a UE after a DDN failure. | +| "TYPE_ALLOCATION_CODE_REPORT" | A NF subscribes to this event to receive the TAC of a UE or group of UEs. | +| "FREQUENT_MOBILITY_REGISTRATION_REPORT" | A NF subscribes to this event to receive the number of mobility registration procedures during a period of a UE or group of UEs. | +| "SNSSAI_TA_MAPPING_REPORT" | A NF subscribes to this event to receive the related access type and the list of supported S-NSSAIs (including indication of S-NSSAIs restricted by AMF) at the TAI(s). | +| "UE_ACCESS_BEHAVIOR_TRENDS" | A NF subscribes to this event to receive the UE access behavior trends (e.g. access type change, handover, etc.) during a period for a UE or a group of UEs, as specified in clause 4.15.4.2 of 3GPP TS 23.502 [3]. | +| "UE_LOCATION_TRENDS" | A NF subscribes to this event to receive the UE Location Trends within a period for a UE or a group of UEs, as specified in clause 4.15.4.2 of 3GPP TS 23.502 [3]. | +| "UE_MM_TRANSACTION_REPORT" | A NF subscribes to this event to receive the Total Number of Mobility Management transactions during a period for a UE or a group of UEs, as specified in clause 5.2.2.3.1 of 3GPP TS 23.502 [3]. | + +#### 6.2.6.3.4 Enumeration: AmfEventTrigger + +**Table 6.2.6.3.4-1: Enumeration AmfEventTrigger** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "ONE_TIME" | Defines that AMF should generate report for the event only once. After reporting, the subscription to this event will be terminated. | +| "CONTINUOUS" | Defines that AMF should continuously generate reports for the event, until the subscription to this event ends, due to end of report duration or up to the maximum number of reports or the event being unsubscribed explicitly | +| "PERIODIC" | Defines that AMF should periodically generate reports for the event, until the subscription to this event ends, due to end of report duration or up to the maximum number of reports or the event being unsubscribed explicitly. | + +## 6.2.6.3.5 Enumeration: LocationFilter + +**Table 6.2.6.3.5-1: Enumeration LocationFilter** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------| +| "TAI" | Indicates any change of the TA used by the UE should be reported | +| "CELL_ID" | Indicates any change of the Cell used by the UE should be reported | +| "RAN_NODE" | Indicates any change of the RAN node serving the UE shall be reported. | +| "N3IWF" | Indicates any change of the N3IWF node used by the UE should be reported | +| "UE_IP" | Indicates any change of the UE local IP address should be reported | +| "UDP_PORT" | Indicates any change of local UDP port used by the UE reported | +| "TNAP_ID" | Indicates any change of the TNAP ID used by the UE should be reported | +| "GLI" | Indicates any change of the Global Line Id used by the UE should be reported | +| "TWAP_ID" | Indicates any change of the TWAP ID used by the UE should be reported | + +## 6.2.6.3.6 Void + +## 6.2.6.3.7 Enumeration: UeReachability + +**Table 6.2.6.3.7-1: Enumeration UeReachability** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------------------------------| +| "UNREACHABLE" | Indicates the UE is not reachable, e.g. when the Mobile Reachable Timer in AMF expires. | +| "REACHABLE" | Indicates the UE is reachable for services and downlink traffic. | +| "REGULATORY_ONLY" | Indicates the UE is reachable only for Regulatory Prioritized Service as the UE is in Not Allowed Areas. | + +## 6.2.6.3.8 Void + +## 6.2.6.3.9 Enumeration: RmState + +**Table 6.2.6.3.9-1: Enumeration RmState** + +| Enumeration value | Description | +|-------------------|-------------------------------------------| +| "REGISTERED" | Indicates the UE in RM-REGISTERED state | +| "DEREGISTERED" | Indicates the UE in RM-DEREGISTERED state | + +## 6.2.6.3.10 Enumeration: CmState + +**Table 6.2.6.3.10-1: Enumeration CmState** + +| Enumeration value | Description | +|-------------------|-------------------------------------------| +| "IDLE" | Indicates the UE is in CM-IDLE state | +| "CONNECTED" | Indicates the UE is in CM-CONNECTED state | + +## 6.2.6.3.11 Enumeration: 5GsUserState + +**Table 6.2.6.3.11-1: Enumeration 5GsUserState** + +| Enumeration value | Description | +|---------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| +| "DEREGISTERED" | Indicates the UE in RM-DEREGISTERED state | +| "CONNECTED_NOT_REACHABLE_FOR_PAGING" | Indicates the UE is in the RM-REGISTERED state in 5GS and the UE is not reachable for paging. | +| "CONNECTED_REACHABLE_FOR_PAGING" | Indicates the UE is in the RM-REGISTERED state in 5GS and the UE is reachable for paging. | +| "NOT_PROVIDED_FROM_AMF" | Indicates that the 5GS User State cannot be retrieved from the AMF
(NOTE) | +| NOTE: This value is not sent by AMF (it may be sent by UDM to HSS). | | + +## 6.2.6.3.12 Enumeration: LossOfConnectivityReason + +**Table 6.2.6.3.12-1: Enumeration LossOfConnectivityReason** + +| Enumeration value | Description | +|------------------------------|--------------------------------------------------| +| "DEREGISTERED" | Indicates the UE is deregistered. | +| "MAX_DETECTION_TIME_EXPIRED" | Indicates the mobile reachable timer is expired. | +| "PURGED" | Indicates the UE is purged. | +| "UNAVAILABLE_PERIOD" | Indicates the UE reported unavailability period. | + +## 6.2.6.3.13 Enumeration: ReachabilityFilter + +**Table 6.2.6.3.13-1: Enumeration ReachabilityFilter** + +| Enumeration value | Description | +|---------------------------------|-------------------------------------------------------------| +| "UE_REACHABILITY_STATUS_CHANGE" | Indicates subscription for "UE Reachability Status Change". | +| "UE_REACHABLE_DL_TRAFFIC" | Indicates subscription for "UE Reachable for DL Traffic". | + +## 6.2.6.3.14 Enumeration: UeType + +**Table 6.2.6.3.14-1: Enumeration UeType** + +| Enumeration value | Description | +|-------------------|----------------------------------| +| "AERIAL_UE" | Indicates the UE is an Aerial UE | + +### 6.2.6.3.15 Enumeration: AccessStateTransitionType + +**Table 6.2.6.3.15-1: Enumeration AccessStateTransitionType** + +| Enumeration value | Description | +|--------------------------------|--------------------------------------------------------------------------------| +| "ACCESS_TYPE_CHANGE_3GPP" | Indicates that the UE's access type has changed to 3GPP access. | +| "ACCESS_TYPE_CHANGE_N3GPP" | Indicates that the UE's access type has changed to non-3GPP access. | +| "RM_STATE_CHANGE_DEREGISTERED" | Indicates that the UE's RM state has change to RM-DEREGISTERED. | +| "RM_STATE_CHANGE_REGISTERED" | Indicates that the UE's RM state has change to RM-REGISTERED. | +| "CM_STATE_CHANGE_IDLE" | Indicates that the UE's CM state has change to CM-IDLE. | +| "CM_STATE_CHANGE_CONNECTED" | Indicates that the UE's CM state has change to CM-CONNECTED | +| "HANDOVER" | Indicates that the UE has performed a successful handover. | +| "MOBILITY_REGISTRATION_UPDATE" | Indicates that the UE has performed a successful mobility registration update. | + +### 6.2.6.3.16 Enumeration: SubTerminationReason + +**Table 6.2.6.3.16-1: Enumeration SubTerminationReason** + +| Enumeration value | Description | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "INVALID_SUBSCRIPTION" | Indicates that the subscription is terminated because the AMF has identified that the subscription is no longer valid on the NF hosting the notification URI. | +| "SUBSCRIPTION_NOT_AUTHORIZED" | Indicates that the subscription is terminated because the AMF identified that the subscription is no longer authorized. This may occur during an inter-AMF mobility, based on local policy of the target AMF, e.g. if the transferred subscription contains no or an invalid access token. | + +## 6.2.6.4 Binary data + +None. + +## 6.2.7 Error Handling + +### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.2.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.2.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Namf\_EventExposure service, and the following application errors listed in Table 6.2.7.3-1 are specific for the Namf\_EventExposure service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UE_NOT_SERVED_BY_AMF | 403 Forbidden | Indicates the creation of a subscription targeting a specific UE has failed due to an application error when the UE is not served by the AMF (i.e. it is not known to the AMF). | +| UNSPECIFIED | 403 Forbidden | The request is rejected due to unspecified reasons. | +| MUTING_EXC_INSTR_NOT_ACCEPTED | 403 Forbidden | Indicates the AMF does not accept the received muting exception instructions. | +| SUBSCRIPTION_NOT_FOUND | 404 Not Found | Indicates the modification of subscription has failed due to an application error when the subscription is not found in the AMF. | + +## 6.2.8 Feature Negotiation + +The feature negotiation mechanism specified in clause 6.6 of 3GPP TS 29.500 [4] shall be used to negotiate the optional features applicable between the AMF and the NF Service Consumer, for the Namf\_EventExposure service, if any. + +The NF Service Consumer shall indicate the optional features it supports for the Namf\_EventExposure service, if any, by including the supportedFeatures attribute in content of the HTTP Request Message for subscription resource creation. + +The AMF shall determine the supported features for the service operations as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in content of the HTTP response for subscription resource creation. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [6]. + +The following features are defined for the Namf\_EventExposure service: + +**Table 6.2.8-1: Features of supportedFeatures attribute used by Namf\_EventExposure service** + +| Feature Number | Feature | M/O | Description | +|----------------|---------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ENA | O | Enablers for Network Automation for 5G

An AMF and an NF that support this feature shall support the procedures specified in 3GPP TS 23.288 [38]. | +| 2 | APRA | O | Additional Presence Reporting Area

An AMF that supports this feature shall support subscription of "PRESENCE_IN_AOI_REPORT" event with a Set of Core Network Predefined Presence Reporting Areas and generating event report including both PRA Set ID and additional PRA ID referring to an individual PRA in the Set.

An NF service consumer that supports this feature shall support receiving "PRESENCE_IN_AOI_REPORT" event with additional PRA ID referring to an individual PRA in the Set. | +| 3 | ESSYNC | O | Event Subscription Synchronization

An AMF and UDM that supports this feature shall support the event subscription synchronization procedure, as specified in clause 5.3.2.4.2. | +| 4 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. NEF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Namf_EventExposure service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 5 | IERSR | O | Immediate Event Report in Subscription Creation Response for Subscriptions on behalf of another NF

An NF consumer (e.g. UDM) supporting this feature shall be able to handle the immediate event reports in the Subscription Creation Response for subscriptions on behalf of another NF, as specified in clause 5.3.2.2.2. | +| 6 | EneNA | O | Enhancement of Enablers for Network Automation for 5G

An AMF and an NF that support this feature shall support the enhancement of network data analytics specified in 3GPP TS 23.288 [38]. | +| 7 | DGEM | O | Dynamic Group-based Event Monitoring

An AMF supporting this feature shall allow the NF consumer to remove or add list of group member UE(s) for a group-based event monitoring subscription (see clause 5.3.2.2.4). | +| 8 | UARF | O | UEs in Area Report Filter

This feature indicates the support of enhanced filter for UEs-In-Area-Report event. When this feature is supported at the AMF, the AMF shall apply additional filters provided in ueInAreaFilter IE. | +| 9 | MPRA | O | Map type PRA information

Support of this feature implies support of map type presenceInfoList during subscription creation and support of PresenceInfo modification during subscription modification (see clauses 6.2.6.2.3 and 6.2.6.2.14). | +| 10 | STEN | O | Subscription Termination Event Notification

An AMF supporting this feature shall support sending a notification to the NF consumer to inform that the AMF event subscription is terminated if requested by NF consumer; an NF consumer supporting this feature shall support processing the Subscription Termination Event Notification from the AMF, e.g. clean-up the local context for the indicated AMF event subscription. | +| 11 | ENAPH3 | O | Enablers for Network Automation for 5G, Phase 3

An AMF supporting this feature shall support the handling of event muting exception instructions as specified in clause 6.2.7.2 of 3GPP TS 23.288 [38]. | + +| | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 12 | AOIEF | O |

AOI Event Filters for Subscriptions targeting any UE

An AMF supporting this feature shall support an AMF event subscription targeting any UE including the notifyForSupiList IE or notifyForSnssaiDnnList IE and shall support notifying the NF service consumer about AOI events only if the event is for a UE belonging to the provided list of SUPIs and/or for a UE having a PDU session established with the provided DNN/S-NSSAI. See clause 5.3.1.

| +|

Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1).
Feature: A short name that can be used to refer to the bit and to the feature.
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.

| | | | + +## 6.2.9 Security + +As indicated in 3GPP TS 33.501 [27], the access to the Namf\_EventExposure API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [28]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [29]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Namf\_EventExposure API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [29], 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 Namf\_EventExposure service. + +The Namf\_EventExposure API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [27]; it defines a single scope consisting on the name of the service (i.e., "namf-evts"), and it does not define any additional scopes at resource or operation level. + +## 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different AMF service instance, within the same AMF or a different AMF of an AMF set, e.g. when an AMF service instance is part of an AMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See the ES3XX feature in clause 6.2.8. + +An SCP that reselects a different AMF producer instance will return the NF Instance ID of the new AMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AMF within an AMF set redirects a service request to a different AMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# 6.3 Namf\_MT Service API + +## 6.3.1 API URI + +The Namf\_MT shall use the Namf\_MT API. + +The API URI of the Namf\_MT API shall be: + +**{apiRoot}/** + +The request URI 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}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "namf-mt". +- The shall be "v1". +- The shall be set as described in clause 6.3.3. + +## 6.3.2 Usage of HTTP + +### 6.3.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [19], 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]. + +HTTP messages and bodies for the Namf\_MT service shall comply with the OpenAPI [23] specification contained in Annex A. + +### 6.3.2.2 HTTP standard headers + +#### 6.3.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.3.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [36]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +### 6.3.2.3 HTTP custom headers + +#### 6.3.2.3.1 General + +In this release of this specification, no custom headers specific to the Namf\_MT service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.3.3 Resources + +### 6.3.3.1 Overview + +![Figure 6.3.3.1-1: Resource URI structure of the Namf_MT Service API. The diagram shows a hierarchical tree structure of resource URIs. The root is ///namf-mt/. It branches into /ue-contexts. /ue-contexts branches into / and /enable-group-reachability. / branches into /ue-reachind. /enable-group-reachability is shown with a dashed border.](f609bd3fda53d5be094991a96addbf84_img.jpg) + +``` + +graph TD + Root["///namf-mt/"] --> UEContexts["/ue-contexts"] + UEContexts --> UEContextId["/"] + UEContexts --> EnableGroupReachability["/enable-group-reachability"] + UEContextId --> UEReachInd["/ue-reachind"] + style EnableGroupReachability stroke-dasharray: 5 5 + +``` + +Figure 6.3.3.1-1: Resource URI structure of the Namf\_MT Service API. The diagram shows a hierarchical tree structure of resource URIs. The root is ///namf-mt/. It branches into /ue-contexts. /ue-contexts branches into / and /enable-group-reachability. / branches into /ue-reachind. /enable-group-reachability is shown with a dashed border. + +**Figure 6.3.3.1-1: Resource URI structure of the Namf\_MT Service API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.3.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------|----------------------------------------|----------------------------------|---------------------------------------------------------------------| +| ueReachInd | /ue-contexts//ue-reachind | PUT | Update the ueReachInd to UE Reachable | +| ueContext | /ue-contexts/ | GET | Map to following service operation:
- ProvideDomainSelectionInfo | +| ueContexts collection | /ue-contexts/enable-group-reachability | enable-group-reachability (POST) | Update the state of the list of UEs to CM-CONNECTED state | + +### 6.3.3.2 Resource: ueReachInd + +#### 6.3.3.2.1 Description + +This resource represents the ueReachInd for a SUPI. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +#### 6.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/namf-mt//ue-contexts//ue-reachind + +This resource shall support the resource URI variables defined in table 6.3.3.2.2-1. + +**Table 6.3.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| apiVersion | string | See clause 6.3.1. | +| ueContextId | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: see pattern of type Supi in 3GPP TS 29.571 [6] | + +### 6.3.3.2.3 Resource Standard Methods + +#### 6.3.3.2.3.1 PUT + +This method shall support the URI query parameters specified in table 6.3.3.2.3.1-1. + +**Table 6.3.3.2.3.1-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 6.3.3.2.3.1-2 and the response data structures and response codes specified in table 6.3.3.2.3.1-3. + +**Table 6.3.3.2.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|----------------------------------------------------------------------| +| EnableUeReachabilityReqData | M | 1 | Contain the State of the UE, the value shall be set to UE Reachable. | + +**Table 6.3.3.2.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------|---|-------------|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EnableUeReachabilityRspData | M | 1 | 200 OK | Indicate the ueReachInd is updated to UE Reachable. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
When the related UE context is not fully available at the target NF Service Producer (e.g. AMF) during a planned maintenance case (e.g. AMF planned maintenance without UDSF case) the "cause" attribute may be used to include the following application error:
- NF_CONSUMER_REDIRECT_ONE_TXN

See table 6.3.7.3-1 for the description of these errors

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetailsEnableUeReachability | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNABLE_TO_PAGE_UE
- UNSPECIFIED
- UE_IN_NON_ALLOWED_AREA

See table 6.3.7.3-1 for the description of this error. | +| ProblemDetails | O | 0..1 | 404
Not Found | When the related UE is not found in the NF Service Producer (e.g. AMF) the "cause" attribute shall be set to:
- CONTEXT_NOT_FOUND

See table 6.3.7.3-1 for the description of these errors | +| ProblemDetails | O | 0..1 | 409
Conflict | The "cause" attribute may be used to indicate the following application error:
-

REJECTION_DUE_TO_PAGING_RESTRICTION

See table 6.3.7.3-1 for the description of this error. | +| ProblemDetails | O | 0..1 | 503
Service Unavailable | The "cause" attribute may be used to indicate one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4].

The HTTP header field "Retry-After" shall not be included in this scenario. | +| ProblemDetailsEnableUeReachability | O | 0..1 | 504
Gateway Timeout | The "cause" attribute may be used to indicate one of the following application errors:
- UE_NOT_RESPONDING
- UE_NOT_REACHABLE

See table 6.3.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.3.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | The URI of the resource located on an alternative service instance within the same AMF or AMF (service) set to which the request is redirected.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.3.3.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 of the resource located on an alternative service instance within the same AMF or AMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.3.3.2.4 Resource Custom Operations + +There is no custom operation supported on this resource. + +### 6.3.3.3 Resource: ueContext + +#### 6.3.3.3.1 Description + +This resource represents the UeContext for a UE. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +#### 6.3.3.3.2 Resource Definition + +Resource URI: {apiRoot}/namf-mt//ue-contexts/{ueContextId} + +This resource shall support the resource URI variables defined in table 6.3.3.3.2-1. + +**Table 6.3.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| apiVersion | string | See clause 6.3.1. | +| ueContextId | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: see pattern of type Supi in 3GPP TS 29.571 [6] | + +#### 6.3.3.3.3 Resource Standard Methods + +##### 6.3.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.3.3.3.3.1-1. + +**Table 6.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| info-class | UeContextInfoClass | M | 1 | Indicates the class of the UE Context information elements to be fetched. | +| supported-features | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.8 is supported. | +| old-guami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | + +This method shall support the request data structures specified in table 6.3.3.3.1-2 and the response data structures and response codes specified in table 6.3.3.3.1-3. + +**Table 6.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeContextInfo | M | 1 | 200 OK | This represents the operation is successful and request UE Context information is returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
When the related UE context is not fully available at the target NF Service Consumer (e.g. AMF) during a planned maintenance case (e.g. AMF planned maintenance without UDSF case) the "cause" attribute shall be set to:
- NF_CONSUMER_REDIRECT_ONE_TXN
See table 6.3.7.3-1 for the description of these errors

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | Indicates the operation has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- UNABLE_TO_PAGE_UE
- UE_DEREGISTERED
- UNSPECIFIED

See table 6.3.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 404
Not Found | Indicates the operation has failed due to application error.
The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.3.7.3-1 for the description of these errors | +| ProblemDetails | O | 0..1 | 409
Conflict | This indicates that the request could not be completed due to a temporary conflict with the current state of the target resource.

The cause attribute of the ProblemDetails structure shall be set to:
- TEMPORARY_REJECT_REGISTRATION_ONGOING, if there is an on-going registration procedure. | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.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 | The URI of the resource located on the target NF Service Consumer (e.g. AMF) to which the request is redirected.
For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.3.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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.3.3.3.4 Resource Custom Operations + +There is no custom operation supported on this resource. + +### 6.3.3.4 Resource: ueContexts collection + +#### 6.3.3.4.1 Description + +This resource represents the collection of the individual UeContexts created in the AMF. + +This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +#### 6.3.3.4.2 Resource Definition + +Resource URI: {apiRoot}/namf-mt//ue-contexts + +This resource shall support the resource URI variables defined in table 6.3.3.4.2-1. + +**Table 6.3.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------| +| apiRoot | string | See clause 6.3.1 | +| apiVersion | string | See clause 6.3.1. | + +#### 6.3.3.4.3 Resource Standard Methods + +There is no standard operation supported on this resource. + +#### 6.3.3.4.4 Resource Custom Operations + +##### 6.3.3.4.4.1 Overview + +**Table 6.3.3.4.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|---------------------------|----------------------------------------|--------------------|---------------------------------------------| +| enable-group-reachability | /ue-contexts/enable-group-reachability | POST | Enable Group Reachability service operation | + +##### 6.3.3.4.4.2 Operation: enable-group-reachability + +###### 6.3.3.4.4.2.1 Description + +###### 6.3.3.4.4.2.2 Operation Definition + +This custom operation updates the state of the list of UEs to CM-CONNECTED state. + +This operation shall support the request data structures specified in table 6.3.3.4.4.2.2-1 and the response data structure and response codes specified in table 6.3.3.4.4.2.2-2. + +**Table 6.3.3.4.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|-------------------------------------------------------------------------------------| +| EnableGroupReachabilityReqData | M | 1 | Contain the list of UEs involved in the MBS Session identified by the related TMGI. | + +**Table 6.3.3.4.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------|---|-------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EnableGroupReachabilityRspData | M | 1 | 200 OK | Successful response indicating the list of UEs in CM-CONNECTED state if any, and indicating the supported features. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | When none of the UEs in the list of UEs are found in the AMF, the "cause" attribute shall be set to:
- CONTEXT_NOT_FOUND
See table 6.3.7.3-1 for the description of these errors | +| ProblemDetails | O | 0..1 | 503 Service Unavailable | The "cause" attribute may be used to indicate one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.3.3.4.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | The URI of the resource located on an alternative service instance within the same AMF or AMF (service) set to which the request is redirected.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.3.3.4.4.2.2-4: 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 on an alternative service instance within the same AMF or AMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.3.4 Custom Operations without associated resources + +There are no custom operations without associated resources supported on Namf\_MT service. + +## 6.3.5 Notifications + +### 6.3.5.1 General + +This clause specifies the notifications provided by the Namf\_MT service. + +**Table 6.3.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------|-------------------------|---------------------------------|---------------------------------| +| UE Reachability Info Notify | {reachabilityNotifyUri} | POST | | + +### 6.3.5.2 UE Reachability Info Notify + +If a NF service consumer has implicitly subscribed to the UE Reachability Info Notify supported by Namf\_MT service, the AMF shall deliver the notification to the call-back URI for the UE(s) which are reachable or do not respond to paging, following Subscribe/Notify mechanism defined in 3GPP TS 29.501 [5]. + +#### 6.3.5.2.1 Notification Definition + +Call-back URI: {callbackUri} + +This callback URI shall be the "reachabilityNotifyUri" provided in the "EnableGroupReachabilityReqData" IE. + +#### 6.3.5.2.3 Notification Standard Methods + +##### 6.3.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.3.5.2.3.1-1 and the response data structures and response codes specified in table 6.3.5.2.3.1-2. + +**Table 6.3.5.2.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------------------|---|-------------|---------------------------------------------| +| ReachabilityNotification Data | M | 1 | Represents the notification to be delivered | + +**Table 6.3.5.2.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.3.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 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.3.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 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.3.6 Data Model + +### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.3-1 specifies the data types defined for the Namf\_MT service based interface protocol. + +**Table 6.3.6.3-1: Namf\_MT specific Data Types** + +| Data type | Clause defined | Description | +|------------------------------------|----------------|-------------------------------------------------------------------------------| +| EnableUeReachabilityReqData | 6.3.6.2.2 | Data within the Enable UE Reachability Request | +| EnableUeReachabilityRspData | 6.3.6.2.3 | Data within the Enable UE Reachability Response | +| UeContextInfo | 6.3.6.2.4 | Contains the UE Context Information | +| ProblemDetailsEnableUeReachability | 6.3.6.2.5 | Enable UE Reachability Error Detail | +| AdditionInfoEnableUeReachability | 6.3.6.2.6 | Additional information to be returned in EnableUeReachability error response. | +| EnableGroupReachabilityReqData | 6.3.6.2.7 | Data within the Enable Group Reachability Request | +| EnableGroupReachabilityRspData | 6.3.6.2.8 | Data within the Enable Group Reachability Response | +| UeInfo | 6.3.6.2.9 | list of UEs requested to be made reachable for the MBS Session | +| ReachabilityNotificationData | 6.3.6.2.10 | Data within the UE Reachability Info Notify | +| ReachableUeInfo | 6.3.6.2.11 | Contains the reachable UE Information | +| UeContextInfoClass | 6.3.6.3.3 | Indicates the UE Context information class | + +Table 6.3.6.3-2 specifies data types re-used by the Namf\_MT 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 Namf\_MT service based interface. + +**Table 6.3.6.3-2: Namf\_MT re-used Data Types** + +| Data type | Reference | Comments | +|--------------------|--------------------|-------------------------------------------------------------------| +| ProblemDetails | 3GPP TS 29.571 [6] | Common data type used in response bodies | +| supportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| AccessType | 3GPP TS 29.571 [6] | Access Type | +| RatType | 3GPP TS 29.571 [6] | RAT Type | +| DurationSec | 3GPP TS 29.571 [6] | | +| RedirectResponse | 3GPP TS 29.571 [6] | Response body of the redirect response message. | +| Supi | 3GPP TS 29.571 [6] | SUPI | +| Tmgi | 3GPP TS 29.571 [6] | TMGI | +| PduSessionId | 3GPP TS 29.571 [6] | PDU Session Id | +| Uri | 3GPP TS 29.571 [6] | URI | +| UserLocation | 3GPP TS 29.571 [6] | User Location Information | +| MbsServiceAreaInfo | 3GPP TS 29.571 [6] | MBS Service Area Information for a Location dependent MBS session | +| Qfi | 3GPP TS 29.571 [6] | QoS Flow Identifier | +| UeReachability | 6.2.6.3.7 | Describes the reachability of the UE | +| Ppi | 6.1.6.3.2 | Paging Policy | + +## 6.3.6.2 Structured data types + +### 6.3.6.2.1 Introduction + +Structured data types used in Namf\_MT service are specified in this clause. + +### 6.3.6.2.2 Type: EnableUeReachabilityReqData + +**Table 6.3.6.3.2-1: Definition of type EnableUeReachabilityReqData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reachability | UeReachability | M | 1 | Indicates the desired reachability of the UE | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.8 is supported. | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | +| extBufSupport | boolean | C | 0..1 | This IE shall be present and set to "true", if the extended buffering is supported(see clauses 4.24.2 and clause 4.25.5 of 3GPP TS 23.502 [3]),

When present, the IE shall be set as following:
- true: the extended buffering is supported
- false (default): the extended buffering is not supported | +| ppi | Ppi | O | 0..1 | This IE may be included by the SMF during the Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling. When present, it shall contain the Paging policy to be applied. | +| arp | Arp | O | 0..1 | This IE may be included by the SMF during the Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling.

When present, it shall contain the Allocation and Retention Priority of the QoS flow of the PDU session triggering the procedure, e.g., for which DL packets have been received by the UPF. | +| 5qi | 5Qi | O | 0..1 | This IE may be included by the SMF during the Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling.

When present, it shall indicate the 5QI of the QoS flow of the PDU session triggering the procedure, e.g., for which DL packets have been received by the UPF. | +| qfi | Qfi | O | 0..1 | This IE may be included by the SMF during the Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling.

When present, it shall indicate the QFI of the QoS flow of the PDU session triggering the procedure, e.g., for which DL packets have been received by the UPF. | +| pduSessionId | PduSessionId | O | 0..1 | This IE may be included by the SMF during the Network Triggered Connection Resume in RRC Inactive with CN based MT communication handling.

When present, it shall indicate the PDU Session ID of the PDU session triggering the procedure, e.g., for which DL packets have been received by the UPF. | + +## 6.3.6.2.3 Type: EnableUeReachabilityRspData + +**Table 6.3.6.2.3-1: Definition of type EnableUeReachabilityRspData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| reachability | UeReachability | M | 1 | Indicates the current reachability of the UE | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.8 is supported. | + +## 6.3.6.2.4 Type: UeContextInfo + +**Table 6.3.6.2.3-1: Definition of type UeContextInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supportVoPS | boolean | C | 0..1 | This IE shall be present when following UE Context Information class are required:
- "TADS"

When present, this IE shall indicate whether or not IMS voice over PS Session is supported in the registration area (s) where the UE is currently registered in 3GPP access. | +| supportVoPSn3gpp | boolean | C | 0..1 | This IE shall be present when the UE is registered in WLAN non 3GPP access and the following UE Context Information class are required:
- "TADS"

When present, this IE shall indicate whether or not IMS voice over PS Session Supported Indication over non-3GPP access is supported in the WLAN where the UE is currently registered. | +| lastActTime | DateTime | C | 0..1 | This IE shall be present when following UE Context Information class are required:
- "TADS"

When present, this IE shall indicate the UTC time stamp of the last radio contact with the UE. | +| accessType | AccessType | C | 0..1 | This IE shall be present when following UE Context Information class are required:
- "TADS"

When present, this IE shall indicate the current access type of the UE. | +| ratType | RatType | C | 0..1 | This IE shall be present when following UE Context Information class are required:
- "TADS"

When present, this IE shall indicate the current RAT type of the UE. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.8 is supported. | + +## 6.3.6.2.5 Type: ProblemDetailsEnableUeReachability + +**Table 6.3.6.2.5-1: Definition of type ProblemDetailsEnableUeReachability as a list of to be combined data** + +| Data type | Cardinality | Description | Applicability | +|----------------------------------|-------------|----------------------------------------------------------|---------------| +| ProblemDetails | 1 | Detail information of the problem | | +| AdditionInfoEnableUeReachability | 1 | Additional information to be returned in error response. | | + +## 6.3.6.2.6 Type: AdditionInfoEnableUeReachability + +Table 6.3.6.2.6-1: Definition of type AdditionInfoEnableUeReachability + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-------------------------------------------------------------------------------------------------------------| +| maxWaitingTime | DurationSec | C | 0..1 | This IE shall contain the estimated maximum wait time (see clauses 4.24.2 and 4.8.2.2b of 3GPP 23.502 [3]). | + +## 6.3.6.2.7 Type: EnableGroupReachabilityReqData + +Table 6.3.6.2.7-1: Definition of type EnableGroupReachabilityReqData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ueList | array(UeInfo) | M | 1..N | This IE shall indicate the list of UEs requested to be made reachable for the MBS Session and may indicate the PDU Session Id of the associated PDU Session for the UE(s). | +| tmgi | Tmgi | M | 1 | This IE shall indicate the TMGI of the MBS session. | +| reachabilityNotifyUri | Uri | O | 0..1 | The callback URI on which UEReachabilityInfoNotify is reported. | +| mbsServiceAreaInfoList | array(MbsServiceAreaInfo) | O | 1..N | List of MBS Service Area and related Area Session ID for location dependent content. | +| arp | Arp | O | 0..1 | This IE when present shall indicate the most demanding Allocation and Retention Priority of all MBS QoS Flow within the MBS session. The AMF may use this IE for paging differentiation (see clause 6.12 of 3GPP TS 23.247 [55]). | +| 5qi | 5Qi | O | 0..1 | This IE when present shall indicate the most demanding 5QI of all MBS QoS Flow within the MBS session. The AMF may use this IE for paging differentiation (see clause 6.12 of 3GPP TS 23.247 [55]). | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.8 is supported. | + +## 6.3.6.2.8 Type: EnableGroupReachabilityRspData + +Table 6.3.6.2.8-1: Definition of type EnableGroupReachabilityRspData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ueConnectedList | array(Supi) | C | 1..N | This IE shall be present if there is at least one UE in the list of UEs received in the request that is already in CM-CONNECTED state. When present, this IE shall indicate the list of UEs in CM-CONNECTED state. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.8 is supported. | + +## 6.3.6.2.9 Type: UeInfo + +Table 6.3.6.2.9-1: Definition of type UeInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|--------------------------------------------------------------------------------------------| +| ueList | array(Supi) | M | 1..N | This IE shall indicate the list of UEs requested to be made reachable for the MBS Session. | +| pduSessionId | PduSessionId | O | 0..1 | Represents the identifier of the associated PDU Session for the UEs in ueList IE. | + +### 6.3.6.2.10 Type: ReachabilityNotificationData + +**Table 6.3.6.2.10-1: Definition of type ReachabilityNotificationData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------------|---|-------------|-----------------------------------------------------| +| reachableUeList | array(ReachableUeInfo) | C | 1..N | This IE shall indicate the list of reachable UEs. | +| unreachableUeList | array(Supi) | C | 1..N | This IE shall indicate the list of unreachable UEs. | + +### 6.3.6.2.11 Type: ReachableUeInfo + +**Table 6.3.6.2.11-1: Definition of type ReachableUeInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|----------------------------------------------------------------| +| ueList | array(Supi) | M | 1..N | This IE shall indicate the list of reachable UEs. | +| userLocation | UserLocation | C | 0..1 | This IE shall indicate the User Location of the reachable UEs. | + +## 6.3.6.3 Simple data types and enumerations + +### 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 6.3.6.3.2 Simple data types + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +**Table 6.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +### 6.3.6.3.3 Enumeration: UeContextInfoClass + +**Table 6.3.6.3.3-1: Enumeration UeContextInfoClass** + +| Enumeration value | Description | +|-------------------|--------------------------------------------------------------------------------------------| +| "TADS" | Defines the UE Context Information for Terminating Domain Selection for IMS Voice over PS. | + +## 6.3.6.4 Binary data + +None. + +## 6.3.7 Error Handling + +### 6.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.3.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.3.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Namf\_MT service, and the following application errors listed in Table 6.3.7.3-1 are specific for the Namf\_MT service. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NF_CONSUMER_REDIRECT_ONE_TXN | 307
Temporary Redirect | The request has been asked to be redirected to a specified target. | +| UNABLE_TO_PAGE_UE | 403
Forbidden | AMF is unable page the UE, temporarily. | +| UE_IN_NON_ALLOWED_AREA | 403
Forbidden | UE is currently in a non-allowed area and the service request is not for a regulatory prioritized service. | +| UE_DEREGISTERED | 403
Forbidden | The user is in RM-DEREGISTERED state in the AMF. | +| UNSPECIFIED | 403
Forbidden | The request is rejected due to unspecified reasons. | +| CONTEXT_NOT_FOUND | 404
Not Found | The related UE is not found in the NF Service Consumer. | +| TEMPORARY_REJECT_REGISTRATION ONGOING | 409
Conflict | The request fails due to an on-going registration procedure. | +| REJECTION_DUE_TO_PAGING_RESTRICTION | 409
Conflict | If Paging Restriction Information restrict the EnableUEReachability request from causing paging as defined in 3GPP TS 23.501 [2] clause 5.38.5 or if the UE rejects the paging as defined in 3GPP TS 23.501 [2] clause 5.38.4. | +| UE_NOT_RESPONDING | 504
Gateway Timeout | UE is not responding to the request initiated by the network, e.g. Paging. | +| UE_NOT_REACHABLE | 504
Gateway Timeout | The UE is not reachable for paging, e.g., when UE is in MICO mode or the UE has entered the UE has entered Extended DRX in CM-IDLE or Extended DRX for RRC-INACTIVE state. | + +### 6.3.8 Feature Negotiation + +The feature negotiation mechanism specified in clause 6.6 of 3GPP TS 29.500 [4] shall be used to negotiate the optional features applicable between the AMF and the NF Service Consumer, for the Namf\_MT service, if any. + +The NF Service Consumer shall indicate the optional features it supports for the Namf\_MT service, if any, by including the supportedFeatures attribute in content of the HTTP Request Message for following service operations: + +- EnableUEReachability, as specified in clause 5.4.2.2; +- ProvideDomainSelectionInfo, as specified in clause 5.4.2.3; +- EnableGroupReachability, as specified in clause 5.4.2.4. + +The AMF shall determine the supported features for the service operations as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in content of the HTTP response for the service operation. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [6]. + +The following features are defined for the Namf\_MT service. + +**Table 6.3.8-1: Features of supportedFeatures attribute used by Namf\_MT service** + +| Feature Number | Feature | M/O | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. SMSF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Namf_MT service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 2 | GRCAP | O | Group Reachability Capability

An AMF and SMF that supports this feature shall support the EnableGroupReachability and UEReachabilityInfoNotify service operations, as specified in clause 5.4.2.4 and clause 5.4.2.5. | +| Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1).
Feature: A short name that can be used to refer to the bit and to the feature.
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature. | | | | + +### 6.3.9 Security + +As indicated in 3GPP TS 33.501 [27], the access to the Namf\_MT API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [28]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [29]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Namf\_MT API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [29], 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 Namf\_MT service. + +The Namf\_MT API defines the following scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [27]. + +**Table 6.3.9-1: OAuth2 scopes defined in Namf\_MT API** + +| Scope | Description | +|-------------------------------------|----------------------------------------------------------| +| "namf-mt" | Access to the Namf_MT API. | +| "namf-mt:ue-reachind" | Access to the EnableUeReachability service operation. | +| "namf-mt:enable-group-reachability" | Access to the EnableGroupReachability service operation. | + +### 6.3.10 HTTP redirection + +An HTTP request may be redirected to a different AMF service instance, within the same AMF or a different AMF of an AMF set, e.g. when an AMF service instance is part of an AMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See the ES3XX feature in clause 6.3.8. + +An SCP that reselects a different AMF producer instance will return the NF Instance ID of the new AMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AMF within an AMF set redirects a service request to a different AMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.4 Namf\_Location Service API + +### 6.4.1 API URI + +The Namf\_Location shall use the Namf\_Location API. + +The API URI of the Namf\_Location API shall be: + +**{apiRoot}//** + +The request URI 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}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "namf-loc". +- The shall be "v1". +- The shall be set as described in clause 6.4.3. + +### 6.4.2 Usage of HTTP + +#### 6.4.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [19], 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]. + +HTTP messages and bodies for the Namf\_Location service shall comply with the OpenAPI [23] specification contained in Annex A. + +#### 6.4.2.2 HTTP standard headers + +##### 6.4.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.4.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [36]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +#### 6.4.2.3 HTTP custom headers + +##### 6.4.2.3.1 General + +In this release of this specification, no custom headers specific to the Namf\_Location service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.4.3 Resources + +#### 6.4.3.1 Overview + +![Diagram showing the resource URI structure of the Namf_Location Service API. A central box labeled '{ueContextId}' branches out to three dashed boxes: '/provide-pos-info', '/provide-loc-info', and '/cancel-pos-info'.](44b5421412b6a548e6e32adda52dfeab_img.jpg) + +``` + +graph LR + A["/{ueContextId}"] --- B[/provide-pos-info] + A --- C[/provide-loc-info] + A --- D[/cancel-pos-info] + style B stroke-dasharray: 5 5 + style C stroke-dasharray: 5 5 + style D stroke-dasharray: 5 5 + +``` + +Diagram showing the resource URI structure of the Namf\_Location Service API. A central box labeled '{ueContextId}' branches out to three dashed boxes: '/provide-pos-info', '/provide-loc-info', and '/cancel-pos-info'. + +**Figure 6.4.3.1-1: Resource URI structure of the Namf\_Location Service API** + +Table 6.4.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.4.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------|-------------------|---------------------------------|------------------------| +| Individual UE context | /provide-pos-info | provide-pos-info (POST) | ProvidePositioningInfo | +| | /provide-loc-info | provide-loc-info (POST) | ProvideLocationInfo | +| | /cancel-pos-info | cancel-pos-info (POST) | CancelLocation | + +### 6.4.3.2 Resource: Individual UE Context + +#### 6.4.3.2.1 Description + +This resource represents an individual ueContextId. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +#### 6.4.3.2.2 Resource Definition + +Resource URI: {apiRoot}/namf-loc// + +This resource shall support the resource URI variables defined in table 6.4.3.2.2-1. + +**Table 6.4.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.4.1 | +| apiVersion | string | See clause 6.4.1. | +| ueContextId | string | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: see pattern of type Supi in 3GPP TS 29.571 [6]
Or represents the Permanent Equipment Identifier (see 3GPP TS 23.501 [2] clause 5.9.3) pattern: "(imei-[0-9]{15} imeisv-[0-9]{16} .+)" | + +#### 6.4.3.2.3 Resource Standard Methods + +There are no standard methods supported on this resource. + +#### 6.4.3.2.4 Resource Custom Operations + +##### 6.4.3.2.4.1 Overview + +**Table 6.4.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|------------------|---------------------------------|--------------------|-------------------------------------------------------------------------------------------------------------| +| provide-pos-info | /{ueContextId}/provide-pos-info | POST | Request the positioning information of the UE. It is used for the ProvidePositioningInfo service operation. | +| provide-loc-info | /{ueContextId}/provide-loc-info | POST | Request the Network Provided Location Information of the UE. | +| cancel-pos-info | /{ueContextId}/cancel-pos-info | POST | Cancels periodic or triggered location for the UE. | + +##### 6.4.3.2.4.2 Operation: provide-pos-info (POST) + +###### 6.4.3.2.4.2.1 Description + +This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI. + +###### 6.4.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.4.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.4.3.2.4.2.2-2. + +**Table 6.4.3.2.4.2.2-1: Data structures supported by (POST) the provide-pos-info operation Request Body** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-------------------------------------------------------------------| +| RequestPosInfo | M | 1 | The information to request the positioning information of the UE. | + +**Table 6.4.3.2.4.2.2-2: Data structures supported by the (POST) provide-pos-info operation Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ProvidePosInfoExt | M | 1 | 200 OK | This case represents a successful query of the UE positioning information, the AMF returns the related information in the response. | +| n/a | | | 204 No Content | Shall return 204 if no information is to be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
  • - USER_UNKNOWN
  • - DETACHED_USER
  • - POSITIONING_DENIED
  • - UNSPECIFIED
  • - REQUESTED_LMF_NOT_AVAILABLE
See table 6.4.7.3-1 for the description of these errors. | +| ProblemDetailsProvidePosInfo | O | 0..1 | 409 Conflict | The request could not be completed due to a conflict with the current state of the resource.
The "cause" attribute may be used to indicate
  • - HO_TO_EPS
See table 6.4.7.3-1 for the description of these errors.
The response should contain the target MME name and realm, if available, and it may contain the location information available from the LMF. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | The "cause" attribute may be used to indicate one of the following application errors:
  • - POSITIONING_FAILED
See table 6.4.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 504 Gateway Timeout | The "cause" attribute may be used to indicate one of the following application errors:
  • - UNREACHABLE_USER
  • - PEER_NOT_RESPONDING
See table 6.4.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.4.3.2.4.2.2-3: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.4.3.2.4.2.2-4: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +6.4.3.2.4.3 Operation: provide-loc-info (POST) + +6.4.3.2.4.3.1 Description + +This ueContextId identifies the individual ueContext resource is composed by UE's SUPI or PEI. + +6.4.3.2.4.3.2 Operation Definition + +This operation shall support the request data structures specified in table 6.4.3.2.4.3.2-1 and the response data structure and response codes specified in table 6.4.3.2.4.3.2-2. + +**Table 6.4.3.2.4.3.2-1: Data structures supported by the (POST) provideLocInfo operation Request Body** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|------------------------------------------------| +| RequestLocInfo | M | 1 | The information to request the NPLI of the UE. | + +**Table 6.4.3.2.4.3.2-2: Data structures supported by the (POST) provide-loc-info operation Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ProvideLocInfo | M | 1 | 200 OK | This case represents a successful query of the NPLI of the target UE, the AMF returns the related information in the response. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNSPECIFIED

See table 6.4.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 404
Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT NOT_FOUND

See table 6.4.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.4.3.2.4.3.2-3: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.4.3.2.4.3.2-4: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**6.4.3.2.4.4 Operation: cancel-pos-info (POST)****6.4.3.2.4.4.1 Description** + +This ueContextId identifies the individual ueContext resource and is composed by UE's SUPI or PEI. + +**6.4.3.2.4.4.2 Operation Definition** + +This operation shall support the request data structures specified in table 6.4.3.2.4.4.2-1 and the response data structure and response codes specified in table 6.4.3.2.4.4.2-2. + +**Table 6.4.3.2.4.4.2-1: Data structures supported by the (POST) cancel-pos-info operation Request Body** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-------------------------------------------------------------------| +| CancelPosInfo | M | 1 | The information to identify the location session to be cancelled. | + +**Table 6.4.3.2.4.4.2-2: Data structures supported by the (POST) cancel-pos-info operation Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful cancellation of location. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
  • - USER_UNKNOWN
  • - LOCATION_SESSION_UNKNOWN
  • - UNSPECIFIED
See table 6.4.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 504 Gateway Timeout | The "cause" attribute may be used to indicate one of the following application errors:
  • - UNREACHABLE_USER
  • - PEER_NOT_RESPONDING
See table 6.4.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.4.3.2.4.4.2-3: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.4.3.2.4.4.2-4: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.4.4 Custom Operations without associated resources + +There are no custom operations without associated resources supported on Namf\_Location service. + +## 6.4.5 Notifications + +### 6.4.5.1 General + +This clause provides the definition of the EventNotify notification of the Namf\_Location service. + +**Table 6.4.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------|---------------------------|---------------------------------|---------------------------------| +| Event Notify | {locationNotificationUri} | POST | | + +### 6.4.5.2 Event Notify + +#### 6.4.5.2.1 Description + +This resource represents the callback reference of the NF Service Consumer (e.g. GMLC) to receive LCS event notify. + +#### 6.4.5.2.2 Notification Definition + +Callback URI: {locationNotificationUri} + +See clause 5.5.2.3.1 for the description of how the AMF obtains the Callback URI of the NF Service Consumer (e.g. GMLC). + +#### 6.4.5.2.3 Notification Standard Methods + +##### 6.4.5.2.3.1 POST + +This method sends an LCS event notify to the NF Service Consumer. + +This method shall support the request data structures specified in table 6.4.5.2.3.1-1 and the response data structures and response codes specified in table 6.4.5.2.3.1-2. + +**Table 6.4.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|--------------------------------------------| +| NotifiedPosInfoEx
t | M | 1 | Representation of the LCS event(s) notify. | + +**Table 6.4.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the LCS event. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.4.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.4.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.4.6 Data Model + +### 6.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.6.1-1 specifies the data types defined for the Namf\_Location service based interface protocol. + +**Table 6.4.6.1-1: Namf\_Location specific Data Types** + +| Data type | Clause defined | Description | +|------------------------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RequestPosInfo | 6.4.6.2.2 | Data within Provide Positioning Information Request | +| ProvidePosInfo | 6.4.6.2.3 | Data within Provide Positioning Information Response | +| NotifiedPosInfo | 6.4.6.2.4 | Data within EventNotify notification | +| RequestLocInfo | 6.4.6.2.5 | Data within Provide Location Information Request | +| ProvideLocInfo | 6.4.6.2.6 | Data within Provide Location Information Response | +| CancelPosInfo | 6.4.6.2.7 | Data within a Cancel Location Request | +| ProblemDetailsProvidePosInfo | 6.4.6.2.8 | Detailed problems with positioning information in failure case | +| AddProvidePosInfos | 6.4.6.2.9 | Additional UE positioning information with more than one corresponding UEs | +| AddNotifiedPosInfos | 6.4.6.2.10 | Additional LCS event notify with more than one corresponding UEs. | +| ProvidePosInfoExt | 6.4.6.2.11 | Data within Provide Positioning Information Response in addition to ProvidePosInfo for the UE positioning information with more than one corresponding UEs | +| NotifiedPosInfoExt | 6.4.6.2.12 | Data within EventNotify notification in addition to NotifiedPosInfo for LCS event notify with more than one corresponding UEs. | +| LocationType | 6.4.6.3.3 | Type of location measurement requested | +| LocationEvent | 6.4.6.3.4 | Type of events initiating location procedures | +| LocationPrivacyVerResult | 6.4.6.3.5 | The result of location privacy verification by UE | +| LpHapType | 6.4.6.3.6 | Type of Low Power and/or High Accuracy Positioning | + +Table 6.4.6.1-2 specifies data types re-used by the Namf\_Location 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 Namf\_Location service based interface. + +**Table 6.4.6.1-2: Namf\_Location re-used Data Types** + +| Data type | Reference | Comments | +|-------------------------------|---------------------|---------------------------------------------------------------------------| +| Supi | 3GPP TS 29.571 [6] | Subscription Permanent Identifier | +| Gpsi | 3GPP TS 29.571 [6] | General Public Subscription Identifier | +| Pei | 3GPP TS 29.571 [6] | Permanent Equipment Identifier | +| ExternalClientType | 3GPP TS 29.572 [25] | LCS Client Type (Emergency, Lawful Interception ...) | +| LocationQoS | 3GPP TS 29.572 [25] | LCS QoS (accuracy, response time) | +| SupportedGADShapes | 3GPP TS 29.572 [25] | LCS supported GAD shapes | +| GeographicArea | 3GPP TS 29.572 [25] | Estimate of the location of the UE | +| AccuracyFulfilmentIndicator | 3GPP TS 29.572 [25] | Requested accuracy was fulfilled or not | +| AgeOfLocationEstimate | 3GPP TS 29.572 [25] | Age Of Location Estimate | +| PositioningMethodAndUsage | 3GPP TS 29.572 [25] | Usage of each non-GNSS positioning method | +| VelocityEstimate | 3GPP TS 29.572 [25] | Estimate of the velocity of the target UE | +| VelocityRequested | 3GPP TS 29.572 [25] | Indication of the Velocity requirement | +| LcsPriority | 3GPP TS 29.572 [25] | Priority of the LCS client | +| GnssPositioningMethodAndUsage | 3GPP TS 29.572 [25] | Usage of each GNSS positioning method | +| CivicAddress | 3GPP TS 29.572 [25] | Civic address | +| BarometricPressure | 3GPP TS 29.572 [25] | Barometric Pressure | +| Altitude | 3GPP TS 29.572 [25] | Altitude estimate of the UE | +| LocalArea | 3GPP TS 29.572 [25] | Local area specified by different shape | +| MinorLocationQoS | 3GPP TS 29.572 [25] | Minor Location QoS | +| Ecgi | 3GPP TS 29.571 [6] | UE EUTRAN cell information | +| Ncgi | 3GPP TS 29.571 [6] | UE NR cell information | +| SupportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| RatType | 3GPP TS 29.571 [6] | RAT type | +| TimeZone | 3GPP TS 29.571 [6] | Time Zone | +| DateTime | 3GPP TS 29.571 [6] | Date and Time | +| UserLocation | 3GPP TS 29.571 [6] | User Location | +| LcsServiceType | 3GPP TS 29.572 [25] | The LCS service type | +| LdrType | 3GPP TS 29.572 [25] | The type of LDR for deferred location | +| Uri | 3GPP TS 29.571 [6] | URI | +| LdrReference | 3GPP TS 29.572 [25] | LDR Reference Number for deferred location | +| LirReference | 3GPP TS 29.572 [25] | LIR Reference Number for immediate location | +| PeriodicEventInfo | 3GPP TS 29.572 [25] | Information for periodic event reporting | +| AreaEventInfo | 3GPP TS 29.572 [25] | Information for area event reporting | +| MotionEventInfo | 3GPP TS 29.572 [25] | Information for motion event reporting | +| ExternalClientId | 3GPP TS 29.515 [46] | External LCS client identification | +| NFInstanceId | 3GPP TS 29.571 [6] | Identification of an NF or AF | +| CodeWord | 3GPP TS 29.515 [46] | Codeword for a 5GC-MT-LR or deferred 5GC-MT-LR | +| LMFIdentification | 3GPP TS 29.572 [25] | Identification of a serving LMF for periodic or triggered location | +| TerminationCause | 3GPP TS 29.572 [25] | Termination cause for a deferred location | +| UePrivacyRequirements | 3GPP TS 29.515 [46] | The location related privacy requirements on UE | +| DiameterIdentity | 3GPP TS 29.571 [6] | Diameter Identity | +| ProblemDetails | 3GPP TS 29.571 [6] | Detailed problems in failure case | +| RedirectResponse | 3GPP TS 29.571 [6] | Response body of the redirect response message. | +| E164Number | 3GPP TS 29.503 [35] | The E.164 number. | +| DurationSec | 3GPP TS 29.571 [6] | Duration Second | +| ReportingArea | 3GPP TS 29.572 [25] | Indicates an area for event reporting | +| ReportingInd | 3GPP TS 29.515 [46] | Reporting Indication | +| RangingSIResult | 3GPP TS 29.572 [25] | Indicates result type for ranging and sidelink positioning | +| RelatedUE | 3GPP TS 29.572 [25] | Indicates information for related UE for ranging and sidelink positioning | +| LosNlosMeasureInd | 3GPP TS 29.572 [25] | LOS/NLOS measurement indication | +| IndoorOutdoorInd | 3GPP TS 29.572 [25] | Indicates Indoor Outdoor Indication | +| IntegrityRequirements | 3GPP TS 29.515 [46] | Integrity Requirements | +| HighAccuracyGnssMetrics | 3GPP TS 29.572 [25] | High Accuracy GNSS Metrics | + +| | | | +|----------------------|---------------------|------------------------------------------------------------------------------------| +| UpLocRepInfoAf | 3GPP TS 29.515 [46] | Information for the location reporting over user plane | +| MappedLocationQoSEps | 3GPP TS 29.572 [25] | Mapped Location QoS for EPS | +| RangeDirection | 3GPP TS 29.572 [25] | Represents the range and direction between two points. | +| 2DRelativeLocation | 3GPP TS 29.572 [25] | Represents 2D local co-ordinates with origin corresponding to another known point. | +| 3DRelativeLocation | 3GPP TS 29.572 [25] | Represents 3D local co-ordinates with origin corresponding to another known point. | + +## 6.4.6.2 Structured data types + +### 6.4.6.2.1 Introduction + +Structured data types used in Namf\_Location service are specified in this clause. + +6.4.6.2.2 Type: RequestPosInfo + +**Table 6.4.6.2.2-1: Definition of type RequestPosInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lcsClientType | ExternalClientType | M | 1 | This IE shall contain the type of LCS client (Emergency, Lawful Interception etc.,) issuing the location request | +| lcsLocation | LocationType | M | 1 | This IE shall contain the type of location measurement requested, such as current location, current or last known location, deferred location, etc.
(NOTE 2) | +| supi | Supi | C | 0..1 | If the SUPI is available, this IE shall be present. | +| gpsi | Gpsi | C | 0..1 | If the GPSI is available, this IE shall be present. | +| requestedRangingSIResult | array(RangingSIResult) | C | 1..N | This IE shall contain the type of result requested for ranging and sidelink positioning, such as absolute locations, relative locations or ranges and directions related to the UEs, etc. | +| relatedUEs | array(RelatedUE) | C | 1..N | This IE contains a list of the information for the related UEs for the ranging and sidelink positioning. | +| lmfId | LMFIdentification | O | 0..1 | LMF identification.
If present, this IE shall indicate the LMF ID that should be used to select the LMF. | +| priority | LcsPriority | O | 0..1 | If present, this IE shall contain the priority of the LCS client issuing the positioning request. | +| lcsQoS | LocationQoS | O | 0..1 | If present, this IE shall contain the quality of service requested, such as the accuracy of the positioning measurement and the response time of the positioning operation.

Multiple QoS Class (lcsQoSClass sets to "MULTIPLE_QOS") shall only be used when AMF support MUTIQOS feature. | +| velocityRequested | VelocityRequested | O | 0..1 | If present, this IE shall contain an indication of whether or not the Velocity of the target UE is requested. | +| lcsSupportedGADShapes | SupportedGADShapes | O | 0..1 | If present, this IE shall contain one GAD shape supported by the LCS client. | +| additionalSuppGADShapes | array(SupportedGADShapes) | C | 1..N | Shall be absent if lcsSupportedGADShapes is absent.
Shall be present if the LCS client supports more than one GAD shape. | +| locationNotificationUri | Uri | O | 0..1 | The callback URI on which location change event notification is reported. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.4.8 is supported. | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | +| pei | Pei | C | 0..1 | This IE shall be present if supi and gpsi are not available. | +| lcsServiceType | LcsServiceType | O | 0..1 | This IE contains the LCS service type for an external client.
(NOTE 1) | +| ldrType | LdrType | C | 0..1 | This IE contains the type of LDR for a deferred location request. This IE shall be present when lcsLocation is set to "DEFERRED_LOCATION". | +| hgmlcCallBackURI | Uri | C | 0..1 | This IE contains the callback URI of the H-GMLC. This IE shall be present when lcsLocation is set to "DEFERRED_LOCATION".

This IE shall also be present for location service in PNI-NPN with signalling optimisation, as specified in 3GPP TS 23.273 [42] clause 6.1.2. | +| lirGmlcCallBackUri | Uri | C | 0..1 | This IE shall be present when the intermediateLocationInd IE is present with the value "true". | + +| | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------| +| | | | | When present, this IE shall contain callback URI of the GMLC to receive the intermediate location reports. | +|--|--|--|--|------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-------------------------|-----------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ldrReference | LdrReference | C | 0..1 | This IE contains the LDR Reference Number.
This IE shall be present when lcsLocation is set to "DEFERRED_LOCATION".

This IE shall be present for location service in PNI-NPN with signalling optimisation, as specified in 3GPP TS 23.273 [42] clause 6.1.2. | +| lirReference | LirReference | C | 0..1 | This IE shall be present when the intermediateLocationInd IE is present with the value "true".

When present, this IE shall contain the LIR Reference Number for a multiple location request | +| periodicEventInfo | PeriodicEventInfo | C | 0..1 | This IE contains information for periodic event reporting for a deferred location request. This IE shall be present when ldrType is set to "PERIODIC". | +| areaEventInfo | AreaEventInfo | C | 0..1 | This IE contains information for area event reporting for a deferred location request. This IE shall be present when ldrType is set to "ENTERING_INTO_AREA", "LEAVING_FROM_AREA" or "BEING_INSIDE_AREA". | +| motionEventInfo | MotionEventInfo | C | 0..1 | This IE contains information for motion event reporting for a deferred location request. This IE shall be present when ldrType is set to "MOTION". | +| externalClientId | ExternalClientId | O | 0..1 | This IE provides the external LCS client identification (e.g. the name of the LCS client).
(NOTE 1) | +| afID | NfInstanceId | O | 0..1 | This IE provides the identification of an AF that initiated the location request.
(NOTE 1) | +| codeWord | CodeWord | O | 0..1 | This IE provides a codeword for a location request which is provided by an external Client or AF and is sent to and verified by a target UE as part of privacy verification.
(NOTE 1) | +| uePrivacyRequirements | UePrivacyRequirements | O | 0..1 | If present, the IE provides the indication of location related notification or verification for the target UE, the indication of codeword check in UE | +| scheduledLocTime | DateTime | O | 0..1 | If present, the IE provides the scheduled UTC time that the UE needs to be located. | +| reliableLocReq | boolean | C | 0..1 | This IE shall be included with the value "true" to indicate that reliable UE location information is required, as specified in 3GPP TS 33.256 [57] clause 5.3.2.

When present, this IE shall be set as following:
- true: the reliable UE location information is required
- false (default): the reliable UE location information is not required | +| intermediateLocationInd | boolean | C | 0..1 | This IE shall be present with the value "true" to indicate the acceptance of intermediate location responses for the NF consumer (i.e., the GMLC), during a 5GC-MT-LR multiple location procedure for the regulatory location service (see clause 6.1.3 and clause 6.10.4 of 3GPP TS 23.273 [42]).

When present, this IE shall indicate the acceptance of intermediate location response at the NF consumer:
- true: intermediate location response acceptable
- false (default): intermediate location response not acceptable | +| maxRespTime | DurationSec | C | 0..1 | This IE shall be present when the intermediateLocationInd IE is present with the value "true". | + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | When present, this IE shall contain the maximum response time for the NF consumer to receive the FINAL location response.

The AMF may overwrite the maximum response time when passing it to the LMF, e.g., to avoid timeout of the HTTP service request. | +| ueUnawareInd | boolean | C | 0..1 | This IE shall be included and set to "true", if the UE Unaware Positioning is required, as specified in clause 6.1.1 of 3GPP TS 23.273 [42].

Presence of this IE with false value shall be prohibited. | +| lpHapType | LpHapType | C | 0..1 | This IE shall be included and set to "LOW_POW_HIGH_ACCU_POS" to request low power and high accuracy positioning, as specified in clause 6.1.2 of 3GPP TS 23.273 [42]. | +| evtRptAllowedAreas | array(ReportingArea) | O | 1..250 | If present, this IE shall contain the list of event report allowed areas, where UE is allowed to generate and send the event report to network during the deferred 5GC-MT-LR procedure for UE power saving purpose. | +| reportingInd | ReportingInd | O | 0..1 | This IE may be present if the evtRptAllowedAreas is present.

When present, this IE shall indicate whether the UE is allowed to generate and send the reports inside or outside the event report allowed areas:
- Inside reporting (default)
- Outside reporting
(see 3GPP TS 23.273 [42] clause 5.14 and 6.3.1) | +| integrityRequirements | IntegrityRequirements | O | 0..1 | When present, this IE shall indicate the integrity requirements. | +| upLocRepInfoAf | UpLocRepInfoAf | C | 0..1 | This IE shall be present if the request is for the location reporting over user plane.
When present, the IE may include additional information for the location reporting over user plane. | +| mappedQoSEps | MappedLocationQoSEps | C | 0..1 | This IE may only be present if the Multiple QoS Class is indicated in the locationQoS IE.

When present, this IE shall indicate the mapped Location QoS applicable to EPS ("BEST EFFORT" or "ASSURED") based on the Multiple Location QoS (see clause 6.19 of 3GPP TS 23.273 [42]). | +| NOTE 1: At least one of these IEs should be present when uePrivacyCallSessionUnrelatedClass indicates notification and/or verification for the target UE. | | | | | +| NOTE 2: If the lcsLocation IE is set to value "NOTIFICATION_VERIFICATION_ONLY", then the lcsServiceAuthInfo attribute in the uePrivacyRequirements IE, if present, shall be set to either "NOTIFICATION_ONLY" or "NOTIFICATION_AND_VERIFICATION_ONLY". | | | | | + +## 6.4.6.2.3 Type: ProvidePosInfo + +**Table 6.4.6.2.3-1: Definition of type ProvidePosInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|--------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| locationEstimate | GeographicArea | O | 0..1 | If present, this IE shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate. | | +| localLocationEstimate | LocalArea | O | 0..1 | When present, this IE shall indicate a local area in reference system. | | +| accuracyFulfilmentIndicator | AccuracyFulfilmentIndicator | O | 0..1 | If present, this IE shall contain an indication of whether the requested accuracy (as indicated in the LcsQoS in the request message) was fulfilled or not. | | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | If present, this IE shall contain an indication of how long ago the location estimate was obtained. | | +| timestampOfLocationEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same). | | +| velocityEstimate | VelocityEstimate | O | 0..1 | If present, this IE shall contain an estimate of the velocity of the target UE, composed by horizontal speed, vertical speed, and their respective uncertainty. | | +| positioningDataList | array(PositioningMethodAndUsage) | O | 0..9 | If present, this IE shall indicate the usage of each non- GANSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| gnssPositioningDataList | array(GnssPositioningMethodAndUsage) | O | 0..9 | If present, this IE shall indicate the usage of each GANSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| ecgi | Ecgi | O | 0..1 | If present, this IE shall contain the current EUTRAN cell location of the target UE as delivered by the 5G-AN. | | +| ncgi | Ncgi | O | 0..1 | If present, this IE shall contain the current NR cell location of the target UE as delivered by the 5G-AN. | | +| targetServingNode | NfInstanceId | O | 0..1 | If present, this IE shall contain the address of the target side serving node for intra-5GS handover of an IMS Emergency Call. | | +| targetMmeName | DiameterIdentity | C | 0..1 | This IE shall be present for handover of IMS emergency call to EPS, i.e. the target node is an MME.

This IE may also be present for a handover from 5GS to EPS.

When present, this IE shall indicate the Diameter host name of the target MME. | | +| targetMmeRealm | DiameterIdentity | C | 0..1 | This IE shall be present for handover of IMS emergency call to EPS, i.e. the target node is an MME.

This IE may also be present for a handover from 5GS to EPS.

When present, this IE shall indicate the Diameter realm of the target MME. | | +| utranSrvccInd | boolean | C | 0..1 | This IE shall be present with value "true" for 5G-SRVCC to 3GPP UTRAN of IMS emergency call, i.e. target node is an MSC.

When present, this IE shall be set for the | | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | following value:
  • - true: IMS emergency call handover to UTRAN
  • - false: No IMS emergency call handover to UTRAN
| | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------------|--------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| civicAddress | CivicAddress | O | 0..1 | If present, this IE contains a location estimate for the target UE expressed as a Civic address. | | +| barometricPressure | BarometricPressure | O | 0..1 | If present, this IE contains the barometric pressure measurement as reported by the target UE. | | +| altitude | Altitude | O | 0..1 | If present, this IE indicates the altitude of the positioning estimate. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.4.8 is supported. | | +| servingLMFIdentification | LMFIdentification | O | 0..1 | If present, this IE contains the identification of a serving LMF for periodic or triggered location | | +| locationPrivacyVerResult | LocationPrivacyVerResult | O | 0..1 | If present, this IE contains the result of location privacy verification by UE (NOTE) | | +| achievedQoS | MinorLocationQoS | C | 0..1 | When present, this IE shall contain the achieved Location QoS Accuracy of the estimated location.

This IE shall be present if received from LMF. | MUTIQOS | +| directReportInd | boolean | C | 0..1 | When present, this IE shall be set for the following value:
  • - true: location determination will be sent by LMF to GMLC directly
  • - false (default): location determination will not be sent by LMF to GMLC directly
This IE shall be present if received from LMF. | | +| acceptedPeriodicEventInfo | PeriodicEventInfo | C | 0..1 | This IE shall be present if received from LMF.

When present, this IE shall provide the accepted periodic event reporting information. | | +| haGnssMetrics | HighAccuracyGnssMetrics | C | 0..1 | This IE should be included when received from LMF.

When present, this IE shall indicate the high accuracy GNSS metrics for the location estimate. | | +| indoorOutdoorInd | IndoorOutdoorInd | O | 0..1 | When present, this IE shall indicate whether the UE is indoor or outdoor. | | +| losNlosMeasureInd | LosNlosMeasureInd | O | 0..1 | When present, this IE shall indicate whether LOS measurement or NLOS measurement is used. | | +| losNlosMeasureInd | LosNlosMeasureInd | O | 0..1 | When present, this IE shall indicate whether LOS measurement or NLOS measurement is used. | | +| relatedApplicationlayerId | ApplicationlayerId | O | 0..1 | Identifies the application layer ID of the related UE for ranging and sidelink positioning, such as located UE, reference UE, etc. | Ranging_SL | +| rangeDirection | RangeDirection | O | 0..1 | When present, this IE identifies a range and direction from a point A to a point B, comprising a range from point A to point B, an azimuth direction from point A to point B and an elevation direction from point A to point B. | Ranging_SL | +| 2dRelativeLocation | 2DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 2D location with uncertainty ellipse, characterised by a point described in 2D | Ranging_SL | + +| | | | | | | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| | | | | local co-ordinates with origin corresponding to another known point, distances r1 and r2 and an angle of orientation A. | | +| 3dRelativeLocation | 3DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 3D location with uncertainty ellipsoid, characterised by a point described in 3D local co-ordinates with origin corresponding to another known point, distances r1 (the "semi-major uncertainty"), r2 (the "semi-minor uncertainty") and r3 (the "vertical uncertainty") and an angle of orientation A (the "angle of the major axis"). | Ranging_SL | +| relativeVelocity | VelocityEstimate | O | 0..1 | When present, this IE identifies UE velocity relative to the UE identified with relatedApplicationLayerId. | Ranging_SL | +| NOTE: | The IE may be included to indicate the result of location privacy verification by UE to (H)GMLC when a location request with notification and privacy verification only indication is sent to the serving AMF by (H)GMLC during location request procedure. | | | | | + +6.4.6.2.4 Type: NotifiedPosInfo + +**Table 6.4.6.2.4-1: Definition of type NotifiedPosInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|--------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| locationEvent | LocationEvent | M | 1 | This IE shall contain the type of event that caused the location procedure to be initiated. | | +| supi | Supi | C | 0..1 | This IE shall contain the SUPI if available (see NOTE 1). | | +| gpsi | Gpsi | C | 0..1 | This IE shall contain the GPSI if available (see NOTE 1). | | +| pei | Pei | C | 0..1 | This IE shall contain the PEI if available (see NOTE 1). | | +| locationEstimate | GeographicArea | O | 0..1 | If present, this IE shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate. | | +| localLocationEstimate | LocalArea | O | 0..1 | When present, this IE shall indicate a local area in reference system. | | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | If present, this IE shall contain an indication of how long ago the location estimate was obtained. | | +| timestampOfLocationEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same). | | +| velocityEstimate | VelocityEstimate | O | 0..1 | If present, this IE shall contain an estimate of the velocity of the target UE, composed by horizontal speed, vertical speed, and their respective uncertainty. | | +| positioningDataList | array(PositioningMethodAndUsage) | O | 0..9 | If present, this IE shall indicate the usage of each non-GNSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| gnssPositioningDataList | array(GNSSPositioningMethodAndUsage) | O | 0..9 | If present, this IE shall indicate the usage of each GNSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| ecgi | Ecgi | O | 0..1 | If present, this IE shall contain the current EUTRAN cell location of the target UE as delivered by the 5G-AN. | | +| ncgi | Ncgi | O | 0..1 | If present, this IE shall contain the current NR cell location of the target UE as delivered by the 5G-AN. | | +| servingNode | NfInstanceId | O | 0..1 | If present, this IE shall contain the address of the serving node. For intra-5GS handover of an IMS Emergency Call, this IE shall contain the address of the target side serving node. For mobility of a UE with periodic or triggered location, this IE shall contain the address of the new serving node, if available. | | +| targetMmeName | DiameterIdentity | C | 0..1 | This IE shall be present for handover of IMS emergency call to EPS, i.e. the target node is an MME.

When present, this IE shall indicate the Diameter host name of the target MME. | | +| targetMmeRealm | DiameterIdentity | C | 0..1 | This IE shall be present for handover of IMS emergency call to EPS, i.e. the target node is an MME.

When present, this IE shall indicate the Diameter realm of the target MME. | | +| utranSrvccInd | boolean | C | 0..1 | This IE shall be present with value "true" for 5G-SRVCC to 3GPP UTRAN of IMS emergency call, i.e. target node is an MSC.

When present, this IE shall be set for the | | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------|--| +| | | | | following value:
true: IMS emergency call handover to
UTRAN
false: No IMS emergency call handover
to UTRAN | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------------|-------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| civicAddress | CivicAddress | O | 0..1 | If present, this IE contains a location estimate for the target UE expressed as a Civic address. | | +| barometricPressure | BarometricPressure | O | 0..1 | If present, this IE contains the barometric pressure measurement as reported by the target UE. | | +| altitude | Altitude | O | 0..1 | If present, this IE indicates the altitude of the positioning estimate. | | +| hgmlcCallBackURI | Uri | C | 0..1 | This IE contains the callback URI of the H-GMLC
This IE shall be included for a locationEvent related to deferred location when the consumer NF is not the H-GMLC. | | +| ldrReference | LdrReference | C | 0..1 | This IE contains an LDR Reference.
This IE shall be included for a locationEvent related to deferred location. | | +| servingLMFIdentification | LMFIdentification | C | 0..1 | This IE contains the identification of a serving LMF and shall be included for a locationEvent related to deferred location with periodic or triggered location if a serving LMF is used. | | +| terminationCause | TerminationCause | C | 0..1 | This IE indicates a reason for termination and shall be included for a locationEvent related to deferred location if deferred location has been terminated. | | +| achievedQos | MinorLocationQoS | O | 0..1 | When present, this IE shall contain the achieved Location QoS Accuracy of the estimated location.

This IE shall be present if received from LMF. | MUTIQOS | +| mscServerId | E164Number | O | 0..1 | This IE may be sent from AMF to GMLC, during a 5G-SRVCC handover from NG-RAN to UTRAN procedure.
When present, it shall contain the international E.164 number of the MSC Server selected by the MME_SRVCC. | | +| haGnssMetrics | HighAccuracyGnssMetrics | C | 0..1 | This IE should be included when received from LMF.

When present, this IE shall indicate the high accuracy GNSS metrics for the location estimate. | | +| indoorOutdoorInd | IndoorOutdoorInd | O | 0..1 | When present, this IE shall indicate whether the UE is indoor or outdoor. | | +| relatedApplicationlayerId | ApplicationlayerId | O | 0..1 | Identifies the application layer ID of the related UE for ranging and sidelink positioning, such as located UE, reference UE, etc. | Ranging_SL | +| rangeDirection | RangeDirection | O | 0..1 | When present, this IE identifies a range and direction from a point A to a point B, comprising a range from point A to point B, an azimuth direction from point A to point B and an elevation direction from point A to point B. | Ranging_SL | +| 2dRelativeLocation | 2DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 2D location with uncertainty ellipse, characterised by a point described in 2D local co-ordinates with origin corresponding to another known point, distances r1 and r2 and an angle of orientation A. | Ranging_SL | +| 3dRelativeLocation | 3DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 3D location with uncertainty ellipsoid, characterised by a point described in 3D local co-ordinates with origin corresponding to another known point, distances r1 (the "semi-major uncertainty"), r2 (the "semi- | Ranging_SL | + +| | | | | | | +|--------------------------------------------------------------------|------------------|---|------|------------------------------------------------------------------------------------------------------------------------|------------| +| | | | | minor uncertainty") and r3 (the "vertical uncertainty") and an angle of orientation A (the "angle of the major axis"). | | +| relativeVelocity | VelocityEstimate | O | 0..1 | When present, this IE identifies UE velocity relative to the UE identified with relatedApplicationlayerId. | Ranging_SL | +| NOTE 1: At least one of these IEs shall be present in the message. | | | | | | + +#### 6.4.6.2.5 Type: RequestLocInfo + +**Table 6.4.6.2.5-1: Definition of type RequestLocInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| req5gsLoc | boolean | C | 0..1 | This IE shall be present and set to "true", if 5GS location information is requested in NPLI.

When present, the IE shall be set as following:
- true: the location of the UE is requested
- false (default): the location of the UE is not requested | +| reqCurrentLoc | boolean | C | 0..1 | This IE may be present if 5GS location information is requested in NPLI.

When present, the IE shall be set as following:
- true: the current location of the UE is requested
- false (default): the current location of the UE is not requested | +| reqRatType | boolean | C | 0..1 | This IE shall be present and set to "true", if the RAT Type of the UE is requested in NPLI.

When present, the IE shall be set as following:
- true: the RAT type of the UE is requested
- false (default): the RAT type of the UE is not requested | +| reqTimeZone | boolean | C | 0..1 | This IE shall be present and set to "true", if the local timezone of the UE is requested in NPLI.

When present, the IE shall be set as following:
- true: the local timezone of the UE is requested
- false (default): the local timezone of the UE is not requested. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.4.8 is supported. | +| oldGuami | Guami | C | 0..1 | This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). | + +## 6.4.6.2.6 Type: ProvideLocInfo + +Table 6.4.6.2.6-1: Definition of type ProvideLocInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| currentLoc | boolean | C | 0..1 | This IE shall be present, if the 5GS location information is requested by the NF Service consumer.

When present, this IE shall be set as following:
- true: the current location of the UE is returned
- false: the last known location of the UE is returned. | +| location | UserLocation | O | 0..1 | If present, this IE shall contain the location information of the UE.

This IE shall convey exactly one of the following:
- E-UTRA user location
- NR user location
- Non-3GPP access user location.

If the additionalLocation IE is present, this IE shall contain either an E-UTRA user location or NR user location. | +| additionalLocation | UserLocation | O | 0..1 | This IE shall be present if the "location IE" is present and the AMF reports both a 3GPP user location and a non-3GPP access user location.

When present, this IE shall convey the non-3GPP access user location. | +| geoInfo | GeographicArea | O | 0..1 | If present, this IE shall contain the geographical information of the UE (see NOTE 1). | +| locationAge | AgeOfLocationEstimate | O | 0..1 | If present, this IE shall contain the age of the location information (see NOTE 2). | +| ratType | RatType | O | 0..1 | If present, this IE shall contain the current RAT type of the UE. | +| timezone | TimeZone | O | 0..1 | If present, this IE shall contain the local time zone of the UE. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.4.8 is supported. | + +NOTE 1: If geographical information is returned by the AMF, it shall be encoded in the "geoInfo" attribute and the "geographicalInformation" attribute within the "location" attribute shall not be used. + +NOTE 2: If age of location estimate is returned by the AMF, it may be provided either in the "locationAge" attribute or in the "ageOfLocationInformation" attribute within the "location" attribute. + +## 6.4.6.2.7 Type: CancelPosInfo + +Table 6.4.6.2.7-1: Definition of type CancelPosInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| supi | Supi | M | 1 | SUPI | +| hGmlcCallbackURI | Uri | M | 1 | Callback URI of the H-GMLC | +| ldrReference | LdrReference | M | 1 | LDR Reference | +| servingLMFIdentification | LMFIdentification | C | 0..1 | Serving LMF identification. This IE shall be included if available. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.4.8 is supported. | + +## 6.4.6.2.8 Type: ProblemDetailsProvidePosInfo + +**Table 6.4.6.2.8-1: Definition of type ProblemDetailsProvidePosInfo as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|----------------|-------------|---------------------------------------------------------------------------------------------------|---------------| +| ProblemDetails | 1 | Detail information of the problem | | +| ProvidePosInfo | 1 | Additional information to be returned in error response. (See clause 6.19.1 of 3GPP 23.273 [42]). | | + +## 6.4.6.2.9 Type: AddProvidePosInfos + +**Table 6.1.6.2.9-1: Definition of type AddProvidePosInfos** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-----------------------|---|-------------|-----------------------------------|---------------| +| addProvidePosInfos | array(ProvidePosInfo) | O | 1..N | Contains a set of ProvidePosInfo. | | + +## 6.4.6.2.10 Type: AddNotifiedPosInfos + +**Table 6.1.6.2.10-1: Definition of type AddNotifiedPosInfos** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|------------------------|---|-------------|------------------------------------|---------------| +| addNotifiedPosInfos | array(NotifiedPosInfo) | O | 1..N | Contains a set of NotifiedPosInfo. | | + +## 6.4.6.2.11 Type: ProvidePosInfoExt + +**Table 6.4.6.2.11-1: Definition of type ProvidePosInfoExt as a list of data types to be combined** + +| Data type | Cardinality | Description | Applicability | +|--------------------|-------------|------------------------------------|---------------| +| ProvidePosInfo | 1 | Positioning information | | +| AddProvidePosInfos | 1 | Additional positioning information | | + +## 6.4.6.2.12 Type: NotifiedPosInfoExt + +**Table 6.4.6.2.12-1: Definition of type NotifiedPosInfoExt as a list of data types to be combined data** + +| Data type | Cardinality | Description | Applicability | +|---------------------|-------------|----------------------------------------|---------------| +| NotifiedPosInfo | 1 | Positioning event notify | | +| AddNotifiedPosInfos | 1 | Additional positioning event(s) notify | | + +## 6.4.6.3 Simple data types and enumerations + +## 6.4.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.4.6.3.2 Simple data types + +The simple data types defined in table 6.4.6.3.2-1 shall be supported. + +**Table 6.4.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +#### 6.4.6.3.3 Enumeration: LocationType + +The enumeration LocationType represents the type of location measurement requested. + +**Table 6.4.6.3.3-1: Enumeration LocationType** + +| Enumeration value | Description | +|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| "CURRENT_LOCATION" | This value indicates that the current location of the target UE is required. | +| "CURRENT_OR_LAST_KNOWN_LOCATION" | This value indicates that the current location or last known location of the target UE is required. | +| "NOTIFICATION_VERIFICATION_ONLY" | This value indicates that notification or verification of location by the target UE is required but a location estimate shall not be obtained. | +| "DEFERRED_LOCATION" | Deferred Location Request | + +#### 6.4.6.3.4 Enumeration: LocationEvent + +The enumeration LocationEvent represents the type of events initiating location procedures. + +**Table 6.4.6.3.4-1: Enumeration LocationEvent** + +| Enumeration value | Description | +|-------------------------------------|-------------------------------------------------------------------------------| +| "EMERGENCY_CALL_ORIGINATION" | Emergency session initiation | +| "EMERGENCY_CALL_RELEASE" | Emergency session termination | +| "EMERGENCY_CALL_HANDOVER" | Handover of an Emergency session | +| "ACTIVATION_OF_DEFERRED_LOCATION" | Confirmation of activation of periodic or triggered location in the target UE | +| "UE_MOBILITY_FOR_DEFERRED_LOCATION" | Mobility of the target UE to a different NF | +| "CANCELLATION_OF_DEFERRED_LOCATION" | Cancellation of a deferred location request | + +#### 6.4.6.3.5 Enumeration: LocationPrivacyVerResult + +The enumeration LocationPrivacyVerResult represents the type of the result of location privacy verification by UE. + +**Table 6.4.6.3.5-1: Enumeration LocationPrivacyVerResult** + +| Enumeration value | Description | +|------------------------|-------------------------------| +| "LOCATION_ALLOWED" | Location is allowed by UE | +| "LOCATION_NOT_ALLOWED" | Location is not allowed by UE | +| "RESPONSE_TIME_OUT" | UE response times out | + +#### 6.4.6.3.6 Enumeration: LpHapType + +The enumeration LpHapType represents the type of the Low Power and/or High Accuracy Positioning. + +**Table 6.4.6.3.6-1: Enumeration LpHapType** + +| Enumeration value | Description | +|-------------------------|-----------------------------------------| +| "LOW_POW_HIGH_ACCU_POS" | Low Power and High Accuracy Positioning | + +## 6.4.7 Error Handling + +### 6.4.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.4.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.4.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.501 [5] may also be used for the Namf\_Location service, and the following application errors listed in Table 6.4.7.3-1 are specific for the Namf\_Location service. + +**Table 6.4.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------|---------------------------|------------------------------------------------------------------------------------| +| USER_UNKNOWN | 403 Forbidden | The user is unknown. | +| DETACHED_USER | 403 Forbidden | The user is detached (i.e. it is in RM-DEREGISTERED state) in the AMF. | +| POSITIONING_DENIED | 403 Forbidden | The positioning procedure was denied. | +| UNSPECIFIED | 403 Forbidden | The request is rejected due to unspecified reasons. | +| LOCATION_SESSION_UNKNOWN | 403 Forbidden | The location session is unknown. | +| REQUESTED_LMF_NOT_AVAILABLE | 403 Forbidden | The request is rejected due to the AMF not being able to access the requested LMF. | +| CONTEXT_NOT_FOUND | 404 Not Found | The requested UE Context does not exist in the AMF. | +| HO_TO_EPS | 409 Conflict | The request is rejected due to a handover from 5GS to EPS. | +| POSITIONING_FAILED | 500 Internal Server Error | The positioning procedure failed. | +| UNREACHABLE_USER | 504 Gateway Timeout | The user could not be reached in order to perform positioning procedure. | +| PEER_NOT_RESPONDING | 504 Gateway Timeout | No response is received from a remote peer, e.g. from the LMF. | + +## 6.4.8 Feature Negotiation + +The feature negotiation mechanism specified in clause 6.6 of 3GPP TS 29.500 [4] shall be used to negotiate the optional features applicable between the AMF and the NF Service Consumer, for the Namf\_Location service, if any. + +The NF Service Consumer shall indicate the optional features it supports for the Namf\_Location service, if any, by including the supportedFeatures attribute in content of the HTTP Request Message for following service operations: + +- ProvidePositioningInfo, as specified in clause 5.5.2.2; +- ProvideLocationInfo, as specified in clause 5.5.2.4; +- CancelLocation, as specified in clause 5.5.2.5 + +The AMF shall determine the supported features for the service operations as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in content of the HTTP response for the service operation. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [6]. + +The following features are defined for the Namf\_Location service. + +**Table 6.1.8-1: Features of supportedFeatures attribute used by Namf\_Location service** + +| Feature Number | Feature | M/O | Description | +|----------------|------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. GMLC) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Namf_Location service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 2 | MUTIQOS | O | Support of Multiple Location QoSes.

This feature bit indicates whether the AMF support that more than one Location QoSes during consuming location service are required. | +| 3 | Ranging_SL | O | This feature supports the enhanced location exposure service (e.g. location information for ranging and sidelink positioning), and requires the support of eLCS feature.
The feature is not applicable to pre-5G (e.g. 4G). | + +Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1). +Feature: A short name that can be used to refer to the bit and to the feature. +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. + +## 6.4.9 Security + +As indicated in 3GPP TS 33.501 [27], the access to the Namf\_Location API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [28]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [29]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Namf\_Location API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [29], 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 Namf\_Location service. + +The Namf\_Location API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [27]; it defines a single scope consisting on the name of the service (i.e., "namf-loc"), and it does not define any additional scopes at resource or operation level. + +## 6.4.10 HTTP redirection + +An HTTP request may be redirected to a different AMF service instance, within the same AMF or a different AMF of an AMF set, e.g. when an AMF service instance is part of an AMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See the ES3XX feature in clause 6.4.8. + +An SCP that reselects a different AMF producer instance will return the NF Instance ID of the new AMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AMF within an AMF set redirects a service request to a different AMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.5 Namf\_MBSBroadcast Service API + +### 6.5.1 API URI + +The Namf\_MBSBroadcast service shall use the Namf\_MBSBroadcast API. + +The API URI of the Namf\_MBSBroadcast API shall be: + +**{apiRoot}/** + +The request URI 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}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "namf-mbs-bc". +- The shall be "v1". +- The shall be set as described in clause 6.5.3. + +### 6.5.2 Usage of HTTP + +#### 6.5.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [19], 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]. + +HTTP messages and bodies for the Namf\_MBSBroadcast service shall comply with the OpenAPI [23] specification contained in Annex A. + +#### 6.5.2.2 HTTP standard headers + +##### 6.5.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.5.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [36]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +Multipart messages shall also be supported (see clause 6.5.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one or more binary body parts with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.5.2.2.2-1 shall be supported. + +**Table 6.5.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| vnd.3gpp.ngap | Binary encoded content, encoding NG Application Protocol (NGAP) IEs, as specified in clause 9.3 of 3GPP TS 38.413 [9] (ASN.1 encoded). | +| NOTE: | Using 3GPP vendor content subtypes allows to describe the nature of the opaque content (i.e. NGAP information) without having to rely on metadata in the JSON content. | + +See clause 6.5.2.4 for the binary contents supported in the binary body part of multipart messages. + +## 6.5.2.3 HTTP custom headers + +### 6.5.2.3.1 General + +In this release of this specification, no custom headers specific to the Namf\_MBSBroadcast service are defined. For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.5.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported, to transfer opaque N2 Information in the following service operations (and HTTP messages): + +- ContextCreate Request and Response (POST); +- ContextUpdate Request and Response (POST); +- ContextStatusNotify service operation (POST). + +HTTP multipart messages shall include one JSON body part and one or more binary body parts comprising: + +- N2 payload (see clause 6.1.6.4). + +The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [9]) specifying the media type of the root body part, i.e. "application/json". + +- NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [9]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message. + +For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [10]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part. + +## 6.5.3 Resources + +### 6.5.3.1 Overview + +![Figure 6.5.3.1-1: Resource URI structure of the Namf_MBSBroadcast Service API. The diagram shows a hierarchical tree structure of URI paths. The root is {apiRoot}/namf-mbs-bc/{apiVersion}. It branches to /mbs-contexts. This branches to /{mbsContextRef}. Finally, /{mbsContextRef} branches to /update, which is shown in a dashed box.](f00bfb547ad2bc48f7d04944cbedcb8e_img.jpg) + +``` + +graph TD + Root["{apiRoot}/namf-mbs-bc/{apiVersion}"] --> MBSContexts["/mbs-contexts"] + MBSContexts --> MBSContextRef["/{mbsContextRef}"] + MBSContextRef --> Update["/update"] + style Update stroke-dasharray: 5 5 + +``` + +Figure 6.5.3.1-1: Resource URI structure of the Namf\_MBSBroadcast Service API. The diagram shows a hierarchical tree structure of URI paths. The root is {apiRoot}/namf-mbs-bc/{apiVersion}. It branches to /mbs-contexts. This branches to /{mbsContextRef}. Finally, /{mbsContextRef} branches to /update, which is shown in a dashed box. + +**Figure 6.5.3.1-1: Resource URI structure of the Namf\_MBSBroadcast Service API** + +Table 6.5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description (service operation) | +|-------------------------------------------|--------------------------------------|---------------------------------|---------------------------------| +| Broadcast MBS session contexts collection | /mbs-contexts | POST | ContextCreate | +| Individual broadcast MBS session context | /mbs-contexts/{mbsContextRef}/update | update (POST) | ContextUpdate | +| | /mbs-contexts/{mbsContextRef} | DELETE | ContextRelease | + +### 6.5.3.2 Resource: Broadcast MBS session contexts collection + +#### 6.5.3.2.1 Description + +This resource represents a collection of Broadcast MBS session contexts created by NF service consumers of the Namf\_MBSBroadcast service. + +This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +#### 6.5.3.2.2 Resource Definition + +Resource URI: {apiRoot}/namf-mbs-bc/{apiVersion}/mbs-contexts + +This resource shall support the resource URI variables defined in table 6.5.3.2.2-1. + +**Table 6.5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------| +| apiRoot | string | See clause 6.5.1 | +| apiVersion | string | See clause 6.5.1. | + +### 6.5.3.2.3 Resource Standard Methods + +#### 6.5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.5.3.2.3.1-1. + +**Table 6.5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.5.3.2.3.1-2 and the response data structures and response codes specified in table 6.5.3.2.3.1-3. + +**Table 6.5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------| +| ContextCreateReqData | M | 1 | Data within ContextCreate Request | + +**Table 6.5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|---------------------------|------------------------------------------------| +| ContextCreateRspData | M | 1 | 201
Created | Successful creation of a broadcast MBS context | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.5.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}/namf-mbs-bc//mbs-contexts/{mbsContextRef} | + +**Table 6.5.3.2.3.1-5: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.5.3.2.3.1-6: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.5.3.2.4 Resource Custom Operations + +None. + +## 6.5.3.3 Resource: Individual broadcast MBS session context + +### 6.5.3.3.1 Description + +This resource represents an Individual broadcast MBS session context created by an NF service consumer of the Namf\_MBSBroadcast service. + +This resource is modelled as the Document resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +### 6.5.3.3.2 Resource Definition + +Resource URI: {apiRoot}/namf-mbs-bc//mbs-contexts/{mbsContextRef} + +This resource shall support the resource URI variables defined in table 6.5.3.3.2-1. + +**Table 6.5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------------|-----------|----------------------------------------------------------------| +| apiRoot | string | See clause 6.5.1 | +| apiVersion | string | See clause 6.5.1 | +| mbsContextRef | string | String identifying an individual broadcast MBS session context | + +### 6.5.3.3.3 Resource Standard Methods + +#### 6.5.3.3.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.5.3.3.3.1-1. + +**Table 6.5.3.3.3.1-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 6.5.3.3.3.1-2 and the response data structures and response codes specified in table 6.5.3.3.3.1-3. + +**Table 6.5.3.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.5.3.3.3.1-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 deletion of a broadcast MBS context | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.5.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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.5.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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.5.3.3.4 Resource Custom Operations + +### 6.5.3.2.4.1 Overview + +**Table 6.5.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|-------------------------------------|--------------------|---------------------------------| +| update | /mbscontexts/{mbsContextRef}/update | POST | ContextUpdate service operation | + +### 6.5.3.2.4.2 Operation: update (POST) + +#### 6.5.3.2.4.2.1 Description + +This {mbsContextRef} identifies the individual broadcast MBS session context to be updated. + +#### 6.5.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.5.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.5.3.2.4.2.2-2. + +**Table 6.5.3.2.4.2.2-1: Data structures supported by (POST) the update operation Request Body** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|---------------------------------------| +| ContextUpdateReqData | M | 1 | Data within the ContextUpdate Request | + +**Table 6.5.3.2.4.2.2-2: Data structures supported by the (POST) update operation Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------| +| ContextUpdateRspData | M | 1 | 200 OK | Successful update of the broadcast MBS session context, with content in the response | +| n/a | | | 204 No Content | Successful update of the broadcast MBS session context, without content in the response | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.5.3.2.4.2.2-3: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.5.3.2.4.2.2-4: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.5.4 Custom Operations without associated resources + +There are no custom operations without associated resources supported by the Namf\_MBSBroadcast Service in this release of the specification. + +## 6.5.5 Notifications + +### 6.5.5.1 General + +This clause specifies the notifications provided by the Namf\_MBSBroadcast service. + +**Table 6.5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------------------------|--------------|---------------------------------|---------------------------------| +| Broadcast MBS Session Context Status Notification | {notifyUri} | POST | ContextStatusNotify | + +## 6.5.5.2 Broadcast MBS Session Context Status Notification + +### 6.5.5.2.1 Description + +The Broadcast MBS session context notification is used by the AMF to report one or several status changes of a Broadcast MBS session context to a NF service consumer. + +### 6.5.5.2.2 Target URI + +The Callback URI "{notifyUri}" shall be used with the callback URI variables defined in table 6.5.5.2.2-1. + +**Table 6.5.5.2.2-1: Callback URI variables** + +| Name | Definition | +|-----------|-----------------------------------------------| +| notifyUri | String formatted as URI with the Callback URI | + +### 6.5.5.2.3 Notification Standard Methods + +#### 6.5.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.5.5.2.3.1-1 and the response data structures and response codes specified in table 6.5.5.2.3.1-2. + +**Table 6.5.5.2.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|---------------------------------------------| +| ContextStatusNotification | M | 1 | Represents the notification to be delivered | + +**Table 6.5.5.2.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------|---|-------------|------------------------|-------------------------------------| +| n/a | | | 204 No Content | Successful response without content | +| ContextStatusNotificationResponse | M | 1 | 200 OK | Successful response with content | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.5.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 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.5.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 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.5.6 Data Model + +### 6.5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.5.6.1-1 specifies the data types defined for the Namf\_MBSBroadcast service based interface protocol. + +**Table 6.5.6.1-1: Namf\_MBSBroadcast specific Data Types** + +| Data type | Clause defined | Description | +|-----------------------------------|----------------|------------------------------------------| +| ContextCreateReqData | 6.5.6.2.2 | Data within ContextCreate Request | +| ContextCreateRspData | 6.5.6.2.3 | Data within ContextCreate Response | +| ContextStatusNotification | 6.5.6.2.4 | Data within ContextStatusNotify Request | +| ContextUpdateReqData | 6.5.6.2.5 | Data within ContextUpdate Request | +| ContextUpdateRspData | 6.5.6.2.6 | Data within ContextUpdate Response | +| N2MbsSmlInfo | 6.5.6.2.7 | N2 MBS Session Management Information | +| OperationEvent | 6.5.6.2.8 | Operation Event | +| NgranFailureEvent | 6.5.6.2.9 | NG-RAN failure event | +| ContextStatusNotificationResponse | 6.5.6.2.10 | Data within ContextStatusNotify Response | +| OperationStatus | 6.5.6.3.3 | Operation Status | +| NgapleType | 6.5.6.3.4 | NGAP Information Element Type | +| OpEventType | 6.5.6.3.5 | Operation Event Type | +| NgranFailureIndication | 6.5.6.3.6 | Indication of a NG-RAN failure event | + +Table 6.5.6.1-2 specifies data types re-used by the Namf 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 Namf service based interface. + +**Table 6.5.6.1-2: Namf re-used Data Types** + +| Data type | Reference | Comments | +|---------------------|--------------------|-------------------------------------------------------------------| +| MbsSessionId | 3GPP TS 29.571 [6] | MBS Session Id | +| AreaSessionId | 3GPP TS 29.571 [6] | Area Session Id | +| MbsServiceArea | 3GPP TS 29.571 [6] | MBS Service Area | +| RefToBinaryData | 3GPP TS 29.571 [6] | Reference to binary body part | +| Uri | 3GPP TS 29.571 [6] | URI | +| DurationSec | 3GPP TS 29.571 [6] | Duration in seconds | +| MbsServiceAreaInfo | 3GPP TS 29.571 [6] | MBS Service Area Information for a Location dependent MBS session | +| GlobalRanNodeId | 3GPP TS 29.571 [6] | Global RAN Node Identifier | +| AssociatedSessionId | 3GPP TS 29.571 [6] | Associated Session ID | + +## 6.5.6.2 Structured data types + +### 6.5.6.2.1 Introduction + +Structured data types used in Namf\_MBSSroadcast service are specified in this clause. + +### 6.5.6.2.2 Type: ContextCreateReqData + +**Table 6.5.6.2.2-1: Definition of type ContextCreateReqData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | M | 1 | MBS Session ID | +| mbsServiceArea | MbsServiceArea | C | 1 | MBS Service Area
This IE shall be present if this is a Local broadcast MBS session. (NOTE 1) | +| mbsServiceAreaInfoList | array(MbsServiceAreaInfo) | C | 1..N | List of MBS service areas and their related Area Session IDs.
This IE shall be present if this is a Location dependent broadcast MBS service. (NOTE 1) | +| n2MbsSmInfo | N2MbsSmInfo | M | 1 | This IE shall be present and shall contain N2 MBS Session Management related information.(see clause 6.5.6.4). | +| notifyUri | Uri | M | 1 | This IE shall contain the notification URI where to be notified about the status change of the broadcast MBS session context. | +| maxResponseTime | DurationSec | O | 0..1 | Maximum response time (in seconds) to receive information about the completion of the Broadcast MBS session establishment. | +| snssai | Snssai | M | 1 | This IE shall be included to indicate the S-NSSAI of the MBS session. (NOTE 2). | +| mbsmfId | NfInstanceId | O | 0..1 | This IE may be present to contain the NF Instance ID of the MB-SMF. | +| mbsmfServiceInstanceId | string | O | 0..1 | This IE may be present to contain the NF Service Instance ID within the NF Instance of the MB-SMF. | +| associatedSessionId | AssociatedSessionId | O | 0..1 | Associated Session ID to enable NG-RAN to identify the multiple MBS sessions delivering the same content when AF creates multiple broadcast MBS Sessions via different Core Networks to deliver the same content. | + +NOTE 1: Either the mbsServiceAreaInfoList IE or the mbsServiceArea IE shall be present. +NOTE 2: If an MB-SMF does not receive the S-NSSAI from the NEF/MBSF, the MB-SMF shall include a pre-configured default SNSSAI. + +### 6.5.6.2.3 Type: ContextCreateRspData + +**Table 6.5.6.2.3-1: Definition of type ContextCreateRspData** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | M | 1 | MBS session identifier. | +| n2MbsSmInfoList | array(N2MbsSmInfo) | O | 1..10 | When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4). | +| operationStatus | OperationStatus | C | 0..1 | This IE shall be present and indicate the completion of the MBS session start operation, if the AMF received the NG-RAN responses from all involved NG-RAN(s). (NOTE) | + +NOTE: If this IE is not present, it indicates either of the following conditions (a) not all response are received from NG-RANs, while the maximum response timer is still running, or (b) the AMF has not received the maximum response timer in the request from the MB-SMF and not all response are received from NG-RANs. + +## 6.5.6.2.4 Type: ContextStatusNotification + +Table 6.5.6.2.4-1: Definition of type ContextStatusNotification + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | M | 1 | MBS Session ID | +| areaSessionId | AreaSessionId | C | 0..1 | Area Session ID
This IE shall be present if this is a Location dependent broadcast MBS service. | +| n2MbsSmInfoList | array(N2MbsSmInfo) | O | 1..10 | When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4). | +| operationStatus | OperationStatus | C | 0..1 | This IE shall be present and indicate the completion of the MBS session start or update operation, if the NF Service Consumer has requested to establish or update the Broadcast MBS session context and a response has been received from all NG-RANs.

This IE shall be present and indicate the incompletion of the MBS session start or update operation, if the NF Service Consumer has requested to establish or update the Broadcast MBS session context within a maximum response time and the AMF has not received responses from all NG-RANs before the maximum response time elapses.
(NOTE) | +| operationEvents | array(OperationEvent) | O | 1..N | This IE may be present to report a list of operation events related to the Broadcast MBS Session, e.g., when the Broadcast MBS Session is released in one of NG-RANs as required by the NG-RAN, a failure of a NG-RAN. | +| releasedInd | boolean | C | 0..1 | This shall be present and set to "true" if all NG-RANs serving the Broadcast MBS session requested the AMF to release the Broadcast MBS session and the Broadcast MBS session (context) has been released in the AMF. | +| NOTE: | If this IE is not present, it indicates either of the following conditions (a) not all response are received from NG-RANs, while the maximum response timer is still running, or (b) the AMF has not received the maximum response timer in the request from the MB-SMF and not all response are received from NG-RANs. | | | | + +## 6.5.6.2.5 Type: ContextUpdateReqData + +Table 6.5.6.2.5-1: Definition of type ContextUpdateReqData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsServiceArea | MbsServiceArea | O | 0..1 | MBS Service Area

This IE may be present for a Location independent broadcast MBS session.
(NOTE) | +| mbsServiceAreaInfoList | array(MbsServiceAreaInfo) | O | 1..N | List of MBS service areas and their related Area Session IDs.
This IE may be present for a Local broadcast MBS service.
(NOTE) | +| n2MbsSmInfo | N2MbsSmInfo | O | 0..1 | When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4). | +| ranIdList | array(GlobalRanNodeId) | O | 1..N | This IE may be included when the MBS session update is to be performed only in a list of specific NG-RAN(s) as specified in clause 8.3.2.3 of 3GPP TS 23.527 [33]). | +| noNgapSignallingInd | boolean | O | 0..1 | This IE may be present during the restoration procedure to select an alternative AMF for a Broadcast MBS Session at AMF failure as specified in clause 8.3.2.4 of 3GPP TS 23.527 [33]).

When present, this IE shall be set as following:
- true: the AMF may consider to not trigger a NGAP signaling message to any NG-RAN. | +| notifyUri | Uri | O | 0..1 | When present, this IE shall contain the notification URI where to be notified about the status change of the broadcast MBS session context. | +| maxResponseTime | DurationSec | O | 0..1 | Maximum response time (in seconds) to receive information about the completion of the Broadcast MBS session update. | +| n2MbsInfoChangeInd | boolean | O | 0..1 | When present, this IE shall indicate whether the information within the N2 MBS Session Management container has changed or not, as follows:
- true: the information has changed;

- false: the information has not changed. | +| NOTE: Either the mbsServiceAreaInfoList IE or the mbsServiceArea IE may be present. | | | | | + +## 6.5.6.2.6 Type: ContextUpdateRspData + +Table 6.5.6.2.6-1: Definition of type ContextUpdateRspData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n2MbsSmInfoList | array(N2MbsSmInfo) | O | 1..10 | When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4). | +| operationStatus | OperationStatus | C | 0..1 | This IE shall be present and indicate the completion of the MBS session start operation, if the AMF received the NG-RAN responses from all involved NG-RAN(s). (NOTE) | +| NOTE: If this IE is not present, it indicates either of the following conditions (a) not all response are received from NG-RANs, while the maximum response timer is still running, or (b) the AMF has not received the maximum response timer in the request from the MB-SMF and not all response are received from NG-RANs. | | | | | + +## 6.5.6.2.7 Type: N2MbsSmInfo + +Table 6.5.6.2.7-1: Definition of type N2MbsSmInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ngapType | NgapType | M | 1 | This IE shall indicate the NGAP IE type of the ngapData as specified in clause 6.5.6.3.4. | +| ngapData | RefToBinaryData | M | 1 | This IE shall contain the reference to the binary data part carrying the NGAP data. | +| ranId | GlobalRanNodeId | M | 1 |

This IE shall indicate the Global RAN ID of the gNB that generated the N2 MBS Session Management related information, or of the gNB towards which the N2 MBS Session Management related information is to be sent.

The IE shall be present when the N2MbsSmInfo is included in the ContextCreate Response, ContextUpdate Response, or ContextStatusNotify Request messages which are sent from the AMF to the NF service consumer (e.g., MB-SMF).

The IE shall be present when the N2MbsSmInfo is included in the ContextStatusNotify Response messages which are sent from the NF service consumer (e.g., MB-SMF) to the AMF.

| + +## 6.5.6.2.8 Type: OperationEvent + +Table 6.5.6.2.8-1: Definition of type OperationEvent + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| opEventType | OpEventType | M | 1 | Indicates the event type of an operation event related to the Broadcast MBS Session. | +| amfId | NfInstanceId | C | 0..1 | This IE shall be present to contain the NF Instance ID of the AMF sending the Context Status Notify Request message if the operation event type indicates an AMF change event. | +| ngranFailureEventList | array(NgranFailureEvent) | C | 1..N | This IE shall be present if the event type is related to a NG-RAN. | + +## 6.5.6.2.9 Type: NgranFailureEvent + +Table 6.5.6.2.9-1: Definition of type NgranFailureEvent + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|------------------------|---|-------------|--------------------------------------------------------------------------| +| ngranId | GlobalRanNodeId | M | 1 | Indicates the identity of the RAN node. The IE shall contain the gNB ID. | +| ngranFailureIndication | NgranFailureIndication | M | 1 | This IE shall contain the information related to the NG-RAN failure. | + +### 6.5.6.2.10 Type: ContextStatusNotificationResponse + +**Table 6.5.6.2.10-1: Definition of type ContextStatusNotificationResponse** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | M | 1 | MBS Session ID | +| areaSessionId | AreaSessionId | C | 0..1 | Area Session ID
This IE shall be present if this is a Location dependent broadcast MBS service. | +| n2MbsSmInfoList | array(N2MbsSmInfo) | O | 1..10 | When present, this IE shall contain N2 MBS Session Management related information.(see clause 6.5.6.4). | + +### 6.5.6.3 Simple data types and enumerations + +#### 6.5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.5.6.3.2 Simple data types + +The simple data types defined in table 6.5.6.3.2-1 shall be supported. + +**Table 6.5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +#### 6.5.6.3.3 Enumeration: OperationStatus + +The enumeration OperationStatus represents the status of a Broadcast MBS session start or update operation. + +**Table 6.5.6.3.3-1: Enumeration OperationStatus** + +| Enumeration value | Description | +|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "MBS_SESSION_START_COMPLETE" | This value indicates the completion of the Broadcast MBS session establishment, i.e. that the AMF has received a response from all NG-RANs. | +| "MBS_SESSION_START_INCOMPLETE" | This value indicates the incompletion of the Broadcast MBS session establishment because the AMF has not received responses from all NG-RANs before the maximum response time that was indicated in the request elapses. | +| "MBS_SESSION_UPDATE_COMPLETE" | This value indicates the completion of the Broadcast MBS session update, i.e. that the AMF has received a response from all NG-RANs. | +| "MBS_SESSION_UPDATE_INCOMPLETE" | This value indicates incompletion of the Broadcast MBS session update because the AMF has not received responses from all NG-RANs before the maximum response time that was indicated in the request elapses. | + +### 6.5.6.3.4 Enumeration: NgapleType + +**Table 6.5.6.3.4-1: Enumeration NgapleType** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------------| +| "MBS_SES_REQ" | MBS Session Setup or Modification Request Transfer | +| "MBS_SES_RSP" | MBS Session Setup or Modification Response Transfer | +| "MBS_SES_FAIL" | MBS Session Setup or Modification Failure Transfer | +| "MBS_SES_REL_RSP" | MBS Session Release Response Transfer | +| "BC_TRA_REQ" | Broadcast Transport Request Transfer | +| "BC_TRA_RSP" | Broadcast Transport Response Transfer | +| "BC_TRA_FAIL" | Broadcast Transport Failure Transfer | + +### 6.5.6.3.5 Enumeration: OpEventType + +**Table 6.5.6.3.5-1: Enumeration: OpEventType** + +| Enumeration value | Description | +|-------------------|-------------------------------------------------------------------------------------------------------| +| "AMF_CHANGE" | This value indicates that the AMF has taken over of the Broadcast MBS Session. | +| "NG_RAN_EVENT" | This value indicates that an event related to a NG-RAN for the Broadcast MBS Session has taken place. | + +### 6.5.6.3.6 Enumeration: NgranFailureIndication + +The enumeration NgranFailureIndication indicates a NG-RAN failure event. + +**Table 6.5.6.3.6-1: Enumeration NgranFailureIndication** + +| Enumeration value | Description | +|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| "NG_RAN_RESTART_OR_START" | This value indicates that the AMF has detected a (re)start of a NG-RAN. | +| "NG_RAN_FAILURE_WITHOUT_RESTART" | This value indicates that the AMF has detected a NG-RAN failure without a restart. | +| "NG_RAN_NOT_REACHABLE" | This value indicates that the AMF has failed to reach the NG-RAN when sending a NGAP MBS Session Setup/Modification/Release Request message. | +| "NG_RAN_REQUIRED_RELEASE" | This value indicates that the NG-RAN has requested to release the Broadcast MBS Session in the NG-RAN. | + +## 6.5.6.4 Binary data + +### 6.5.6.4.1 Introduction + +This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.5.2.2.2 and 6.5.2.4). + +**Table 6.5.6.4.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|----------------|----------------|---------------| +| N2 Information | 6.5.6.4.3 | vnd.3gpp.ngap | + +#### 6.5.6.4.2 N2 Information + +##### 6.5.6.4.2.1 Introduction + +N2 Information shall encode NG Application Protocol (NGAP) IEs, as specified in clause 9.3.A of 3GPP TS 38.413 [12] (ASN.1 encoded), using the vnd.3gpp.ngap content-type. + +##### 6.5.6.4.2.2 NGAP IEs + +N2 Information may encode following NGAP MB-SMF related IE specified in clause 9.3.5 of 3GPP TS 38.413 [12], as summarized in Table 6.5.6.4.2.2-1. + +**Table 6.5.6.4.2.2-1: N2 Information content for class MBS-SM** + +| NGAP IE | Reference
(3GPP TS 38.413 [12]) | Related NGAP message | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|-----------------------------------------------------------------------------| +| MBS Session Setup or Modification Request Transfer | 9.3.5.3 | BROADCAST SESSION SETUP REQUEST
BROADCAST SESSION MODIFICATION REQUEST | +| MBS Session Setup or Modification Response Transfer | 9.3.5.5 | BROADCAST SESSION SETUP RESPONSE
BROADCAST SESSION MODIFICATION RESPONSE | +| MBS Session Setup or Modification Failure Transfer | 9.3.5.6 | BROADCAST SESSION SETUP FAILURE
BROADCAST SESSION MODIFICATION FAILURE | +| MBS Session Release Response Transfer | 9.3.5.14 | BROADCAST SESSION RELEASE RESPONSE
(NOTE) | +| Broadcast Transport Request Transfer | 9.3.5.x | BROADCAST SESSION TRANSPORT REQUEST | +| Broadcast Transport Response Transfer | 9.3.5.y | BROADCAST SESSION TRANSPORT RESPONSE | +| Broadcast Transport Failure Transfer | 9.3.5.z | BROADCAST SESSION TRANSPORT FAILURE | +| NOTE: An MBS Session Release Response Transfer IE shall only be sent to the MB-SMF during a Broadcast MBS Session Release Require procedure (see clause 7.3.6 of 3GPP TS 23.247 [55]), when unicast transport applies over N3mb, to transfer the DL F-TEID of the NG-RAN node in which the MBS session has been released and towards which the delivery of MBS data shall be stopped. | | | + +### 6.5.7 Error Handling + +#### 6.5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.5.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.5.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Namf\_MBSSroadcast service, and the following application errors listed in Table 6.5.7.3-1 are specific for the Namf\_MBSSroadcast service. + +**Table 6.5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 6.5.8 Feature Negotiation + +The optional features in table 6.5.8-1 are defined for the Namf\_MBSBroadcast API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.5.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Namf\_MBSBroadcast 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 Namf\_MBSBroadcast 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 Namf\_MBSBroadcast service. + +The Namf\_MBSBroadcast API defines a single scope "namf-mbs-bc" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 6.5.10 HTTP redirection + +An HTTP request may be redirected to a different AMF service instance, within the same AMF or a different AMF of an AMF set, e.g. when an AMF service instance is part of an AMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different AMF producer instance will return the NF Instance ID of the new AMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AMF within an AMF set redirects a service request to a different AMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# 6.6 Namf\_MBSCommunication Service API + +## 6.6.1 API URI + +The Namf\_MBSCommunication service shall use the Namf\_MBSCommunication API. + +The API URI of the Namf\_MBSCommunication API shall be: + +**{apiRoot}/** + +The request URI 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}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "namf-mbs-comm". +- The shall be "v1". +- The shall be set as described in clause 6.6.3. + +## 6.6.2 Usage of HTTP + +### 6.6.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [19], 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]. + +HTTP messages and bodies for the Namf\_MBSCommunication service shall comply with the OpenAPI [23] specification contained in Annex A. + +### 6.6.2.2 HTTP standard headers + +#### 6.6.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.6.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [36]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +Multipart messages shall also be supported (see clause 6.6.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one binary body part with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.6.2.2.2-1 shall be supported. + +**Table 6.6.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| vnd.3gpp.ngap | Binary encoded content, encoding NG Application Protocol (NGAP) IEs, as specified in clause 9.3 of 3GPP TS 38.413 [9] (ASN.1 encoded). | +| NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque content (i.e. NGAP information) without having to rely on metadata in the JSON content. | | + +See clause 6.6.2.4 for the binary contents supported in the binary body part of multipart messages. + +### 6.6.2.3 HTTP custom headers + +#### 6.6.2.3.1 General + +In this release of this specification, no custom headers specific to the Namf\_MBSCommunication service are defined. For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.6.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported, to transfer opaque N2 Information MBS, in the following service operations (and HTTP messages): + +- N2MessageTransfer Request and Response (POST). + +HTTP multipart messages shall include one JSON body part and one binary body part comprising: + +- N2 payload (see clause 6.1.6.4). + +The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [9]) specifying the media type of the root body part, i.e. "application/json". + +NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [9]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message. + +For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [10]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part. + +## 6.6.3 Resources + +### 6.6.3.1 Overview + +Figure 6.6.3.1-1 describes the resource URI structure of the Namf\_MBSCCommunication API. + +![Diagram showing the resource URI structure of the Namf_MBSCCommunication API. The root is {apiRoot}/namf-mbs-comm/{apiVersion}. It branches into /n2-messages, which further branches into /transfer.](e59fc6db8cfc5ea2b861f3c59a03eaf3_img.jpg) + +``` + +graph TD + Root["{apiRoot}/namf-mbs-comm/{apiVersion}"] --> N2["/n2-messages"] + N2 --> Transfer["/transfer"] + +``` + +Diagram showing the resource URI structure of the Namf\_MBSCCommunication API. The root is {apiRoot}/namf-mbs-comm/{apiVersion}. It branches into /n2-messages, which further branches into /transfer. + +**Figure 6.6.3.1-1: Resource URI structure of the Namf\_MBSCCommunication API** + +Table 6.6.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.6.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------------|-----------------------|---------------------------------|---------------------------------| +| N2 Message Handler (Custom Operation) | /n2-messages/transfer | transfer (POST) | N2MessageTransfer | + +### 6.6.3.1 Resource: N2 Message Handler (Custom Operation) + +#### 6.6.3.1.1 Description + +This resource represents the N2 Message Handler used to transfer a N2 message related to support a Multicast MBS session towards NG-RANs. + +#### 6.6.3.1.2 Resource Definition + +Resource URI: {apiRoot}/namf-comm//n2-messages + +This resource shall support the resource URI variables defined in table 6.6.3.1.2-1. + +**Table 6.6.3.1.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|------------|-----------|-------------------| +| apiRoot | string | See clause 6.6.1 | +| apiVersion | string | See clause 6.6.1. | + +#### 6.6.3.1.3 Resource Standard Methods + +There are no resource standard methods for the N2 Message Handler resource in this release of this specification + +#### 6.6.3.1.4 Resource Custom Operations + +##### 6.6.3.1.4.1 Overview + +**Table 6.6.3.1.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description (service operation) | +|----------------|-----------------------|--------------------|---------------------------------| +| transfer | /n2-messages/transfer | POST | N2MessageTransfer | + +##### 6.6.3.1.4.2 Operation: transfer + +###### 6.6.3.1.4.2.1 Description + +The /n2-messages/transfer custom operation is used to initiate the transfer of N2 MBS Session Management information to the NG-RAN nodes serving a multicast MBS session. This custom operation uses the HTTP POST method. + +###### 6.6.3.1.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.6.3.1.4.2-1 and the response data structure and response codes specified in table 6.6.3.1.4.2-2. + +**Table 6.6.3.1.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| MbsN2MessageTransferReqData | M | 1 | Representation of the data related to a multicast MBS session to be sent to the NG-RAN node(s) by the AMF. | + +**Table 6.6.3.1.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MbsN2MessageTransferRspData | M | 1 | 200 OK | Indicates that the AMF has successfully initiated the transfer of N2 Information to the AN. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | When the MBS Session ID is not found in the NF Service Producer (i.e. AMF) the "cause" attribute shall be set to:
- MBS_SESSION_NOT_FOUND
See table 6.6.7.3-1 for the description of these errors | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.6.3.1.4.2.2-3: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.6.3.1.4.2.2-4: 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 on an alternative service instance within the same AMF or AMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.6.4 Custom Operations without associated resources + +## 6.6.5 Notifications + +### 6.6.5.1 General + +The notifications provided by the Namf\_MBSCommunication service are specified in this clause. + +**Table 6.6.5.1-1: Callback overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|--------------|--------------|---------------------------------|---------------------------------| +| Notification | {notifyUri} | POST | Notify | + +## 6.6.5.2 Notification + +### 6.6.5.2.1 Description + +The notification is used by the AMF to report the failure of an MBS related N2 procedure with an NG-RAN node to a NF service consumer. + +### 6.6.5.2.2 Notification Definitionn + +The Callback URI "{notifyUri}" shall be used with the callback URI variables defined in table 6.6.5.2.2-1. + +**Table 6.6.5.2.2-1: Callback URI variables** + +| Name | Definition | +|-----------|-----------------------------------------------| +| notifyUri | String formatted as URI with the Callback URI | + +### 6.6.5.2.3 Notification Standard Methods + +#### 6.6.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.6.5.2.3.1-1 and the response data structures and response codes specified in table 6.6.5.2.3.1-2. + +**Table 6.6.5.2.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|---------------------------------------------| +| Notification | M | 1 | Represents the notification to be delivered | + +**Table 6.6.5.2.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.6.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 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.6.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 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +## 6.6.6 Data Model + +### 6.6.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.6.6.1-1 specifies the data types defined for the Namf\_MBSCommunication service based interface protocol. + +**Table 6.6.6.1-1: Namf\_MBSCommunication specific Data Types** + +| Data type | Clause defined | Description | +|-----------------------------|----------------|----------------------------------------------| +| MbsN2MessageTransferReqData | 6.6.6.2.2 | Data within MBS N2 Message Transfer Request | +| MbsN2MessageTransferRspData | 6.6.6.2.3 | Data within MBS N2 Message Transfer Response | +| N2MbsSmInfo | 6.6.6.2.4 | N2 MBS Session Management Information | +| Notification | 6.6.6.2.5 | Data within Notify Request | +| RanFailure | 6.6.6.2.6 | Description of an NG RAN failure | +| MbsNgapleType | 6.6.6.3.3 | NGAP Information Element Type for MBS | +| RanFailureIndication | 6.6.6.3.4 | NG RAN failure indication | + +Table 6.6.6.3-2 specifies data types re-used by the Namf\_MBSCommunication 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 Namf\_MBSCommunication service based interface. + +**Table 6.6.6.1-2: Namf\_MBSCommunication re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------------|--------------------|------------------------------------------------| +| ProblemDetails | 3GPP TS 29.571 [6] | Common data type used in response bodies | +| supportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| RedirectResponse | 3GPP TS 29.571 [6] | Response body of the redirect response message | +| MbsSessionId | 3GPP TS 29.571 [6] | MBS Session Identifier | +| NgApCause | 3GPP TS 29.571 [6] | NGAP Cause | +| N2InformationTransferResult | 6.1.6.3.8 | Enumeration N2 Message Transfer Result | + +### 6.6.6.2 Structured data types + +#### 6.6.6.2.1 Introduction + +Structured data types used in Namf\_MBSCommunication service are specified in this clause. + +### 6.6.6.2.2 Type: MbsN2MessageTransferReqData + +**Table 6.6.6.2.2-1: Definition of type MbsN2MessageTransferReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsSessionId | MbsSessionId | M | 1 | This IE shall be included to identify the MBS session to which the N2 information to be transferred is related. | | +| areaSessionId | AreaSessionId | O | 0..1 | Area Session ID
This IE may be present, if this is a Location dependent multicast MBS session. | | +| n2MbsSmInfo | N2MbsSmInfo | M | 1 | This IE shall contain the N2 MBS Session Information to be transferred to the NG-RAN nodes serving the MBS session and additional information required for the processing of the message by the AMF. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | +| ranNodeIdList | array(GlobalRanNodeId) | O | 1..N | When present, this IE shall contain the list of NG RAN Node IDs towards which the MBS related N2 message is requested to be distributed. | RAN-ID-LIST | +| notifyUri | Uri | O | 0..1 | When present, this IE shall contain the notification URI to be used for receiving notifications about possible failures of the MBS related N2 procedure with an NG RAN node in the ranNodeIdList. | RAN-ID-LIST | +| notifyCorrelationId | string | O | 0..1 | When present, this IE shall contain the notification correlation ID to be sent within notifications. | RAN-ID-LIST | + +### 6.6.6.2.3 Type: MbsN2MessageTransferRspData + +**Table 6.6.6.2.3-1: Definition of type MbsN2MessageTransferRspData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| result | N2InformationTransferResult | M | 1 | This IE shall provide the result of the MBS N2 information transfer processing at the AMF. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| failureList | array(RanFailure) | O | 1..N | List of MBS related N2 procedure failures | + +### 6.6.6.2.4 Type: N2MbsSmInfo + +**Table 6.6.6.2.4-1: Definition of type N2MbsSmInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------| +| ngapType | MbsNgapType | M | 1 | This IE shall indicate the NGAP IE type of the ngapData as specified in clause 6.6.6.4.2.2. | +| ngapData | RefToBinaryData | M | 1 | This IE shall contain the reference the binary data part carrying the NGAP data. | + +### 6.6.6.2.5 Type: Notification + +**Table 6.6.6.2.5-1: Definition of type Notification** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | M | 1 | MBS Session ID | +| areaSessionId | AreaSessionId | C | 0..1 | Area Session ID
This IE shall be present, if present in the N2Message Transfer request. | +| failureList | array(RanFailure) | M | 1..N | List of MBS related N2 procedure failures | +| notifyCorrelationId | string | C | 0..1 | This IE shall be present if the same IE is present in the N2Message Transfer request. When present, it shall contain the same value as received in the request. | + +### 6.6.6.2.6 Type: RanFailure + +**Table 6.6.6.2.6-1: Definition of type RanFailure** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------| +| ranId | GlobalRanNodeId | M | 1 | Indicates the identity of the NG RAN node. | +| ranFailureCause | NgApCause | C | 0..1 | When present, this IE shall contain the NGAP failure cause received from the NG-RAN. (NOTE) | +| ranFailureIndication | RanFailureIndication | C | 0..1 | This IE shall be present if the AMF cannot deliver the MBS related N2 message to the NG-RAN node. (NOTE) | + +NOTE: Either the ranFailureCause IE or the ranFailureIndication IE shall be present. + +### 6.6.6.3 Simple data types and enumerations + +#### 6.6.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.6.6.3.2 Simple data types + +The simple data types defined in Table 6.6.6.3.2-1 shall be supported. + +#### 6.6.6.3.3 Enumeration: MbsNgapleType + +**Table 6.6.6.3.3-1: Enumeration MbsNgapleType** + +| Enumeration value | Description | +|---------------------|-------------------------------------------------| +| "MBS_SES_ACT_REQ" | Multicast Session Activation Request Transfer | +| "MBS_SES_DEACT_REQ" | Multicast Session Deactivation Request Transfer | +| "MBS_SES_UPD_REQ" | Multicast Session Update Request Transfer | + +#### 6.6.6.3.4 Enumeration: RanFailureIndication + +The enumeration RanFailureIndication indicates a NG-RAN failure event. + +**Table 6.5.6.3.4-1: Enumeration RanFailureIndication** + +| Enumeration value | Description | +|----------------------------------|-------------------------------------------------------------------------------| +| "NG_RAN_FAILURE_WITHOUT_RESTART" | The NG-RAN node failed without restart. | +| "NG_RAN_NOT_REACHABLE" | The AMF cannot reach the NG RAN node when sending the MBS related N2 message. | + +## 6.6.6.4 Binary data + +### 6.6.6.4.1 Introduction + +This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.6.2.2.2 and 6.6.2.4). + +**Table 6.6.6.4.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|---------------------------------------|----------------|---------------| +| N2 MBS Session Management Information | 6.6.6.4.2 | vnd.3gpp.ngap | + +### 6.6.6.4.2 N2 Information + +#### 6.6.6.4.2.1 Introduction + +N2 Information shall encode NG Application Protocol (NGAP) IEs, as specified in clause 9.3.A of 3GPP TS 38.413 [12] (ASN.1 encoded), using the vnd.3gpp.ngap content-type. + +#### 6.6.6.4.2.2 NGAP IEs + +N2 Information may encode following NGAP MB-SMF related IE specified in in clause 9.3.5 of 3GPP TS 38.413 [12], as summarized in Table 6.6.6.4.2.2-1. + +**Table 6.6.6.4.2.2-1: N2 Information content for class MBS-SM** + +| NGAP IE | Reference (3GPP TS 38.413 [12]) | Related NGAP message | +|-------------------------------------------------|---------------------------------|----------------------------------------| +| Multicast Session Activation Request Transfer | 9.3.5.11 | MULTICAST SESSION ACTIVATION REQUEST | +| Multicast Session Deactivation Request Transfer | 9.3.5.12 | MULTICAST SESSION DEACTIVATION REQUEST | +| Multicast Session Update Request Transfer | 9.3.5.13 | MULTICAST SESSION UPDATE REQUEST | + +## 6.6.7 Error Handling + +### 6.6.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.6.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.6.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Namf\_MBSCCommunication service, and the following application errors listed in Table 6.6.7.3-1 are specific for the Namf\_MBSCCommunication service. + +**Table 6.6.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------|------------------|--------------------------------------------------------------------------------------------------------------| +| MBS_SESSION_NOT_FOUND | 404 Not Found | Indicates the MBS related N2 Message transfer has failed due to the MBS Session ID being unknown to the AMF. | + +### 6.6.8 Feature Negotiation + +The optional features in table 6.6.8-1 are defined for the Namf\_MBSCCommunication API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +The NF Service Consumer shall indicate the optional features it supports for the Namf\_MBSCCommunication service, if any, by including the supportedFeatures attribute in content of the HTTP Request Message for following service operations: + +- N2MessageTransfer, as specified in clause 5.7.2.2. + +The AMF shall determine the supported features for the service operations as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in content of the HTTP response for the service operation. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [6]. + +The following features are defined for the Namf\_MBSCCommunication service. + +**Table 6.6.8-1: Features of supportedFeatures attribute used by Namf\_MBSCCommunication service** + +| Feature Number | Feature | M/O | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | RAN-ID-LIST | O |

N2 MBS session request distribution with list of NG RAN Node IDs provided by NF Service Consumer to AMF

An NF Service Consumer (e.g. MB-SMF) and an AMF that support this feature shall support:

  • - Namf_MBSCCommunication_N2MessageTransfer Request including the list of NG RAN node IDs towards which the MBS related N2 message is requested to be distributed; and
  • - the AMF notifying an MBS related N2 procedure failure with an NG RAN node in this list, detected by the AMF or reported by the NG-RAN node.

See clause 8.4.1.2 of 3GPP TS 23.527 [33] and clauses 5.7.2.2 and 5.7.2.3.

| +|

Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1).
Feature: A short name that can be used to refer to the bit and to the feature.
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.

| | | | + +### 6.6.9 Security + +As indicated in 3GPP TS 33.501 [27], the access to the Namf\_MBSCCommunication API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [28]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [29]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Namf\_MBSCCommunication API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [29], 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 Namf\_MBSCCommunication service. + +The Namf\_MBSCCommunication API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [27]; it defines a single scope consisting on the name of the service (i.e., "namf-mbs-comm"), and it does not define any additional scopes at resource or operation level. + +## 6.6.10 HTTP redirection + +An HTTP request may be redirected to a different AMF service instance, within the same AMF or a different AMF of an AMF set, e.g. when an AMF service instance is part of an AMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different AMF producer instance will return the NF Instance ID of the new AMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AMF within an AMF set redirects a service request to a different AMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +--- + +## Annex A (normative): OpenAPI specification + +### A.1 General + +This Annex specifies the API definition of the service provided by AMF in this document. The APIs are defined by OpenAPI 3.0.0 specifications in YAML format, following guidelines in 3GPP TS 29.501 [5]. + +The APIs for specified for following services: + +- Namf\_Communication Service +- Namf\_EventExposure Service +- Namf\_MT Service +- Namf\_Location Service + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE : The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [37] clause 5B). + +--- + +## A.2 Namf\_Communication API + +openapi: 3.0.0 + +info: + +``` + +version: 1.3.0-alpha.5 +title: Namf_Communication +description: | + AMF Communication Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +security: +- {} +- oAuth2ClientCredentials: + - namf-comm + +externalDocs: + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' + +servers: +- url: '{apiRoot}/namf-comm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +paths: + /ue-contexts/{ueContextId}: + put: + summary: Namf_Communication CreateUEContext service Operation + tags: + - Individual ueContext (Document) + operationId: CreateUEContext + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+))$' + requestBody: + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextCreateData' + binaryDataN2Information: + type: string + format: binary + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + binaryDataN2InformationExt3: + type: string + format: binary + binaryDataN2InformationExt4: + type: string + format: binary + binaryDataN2InformationExt5: + type: string + format: binary + binaryDataN2InformationExt6: + type: string + format: binary + binaryDataN2InformationExt7: + type: string + format: binary + +``` + +``` +binaryDataN2InformationExt8: + type: string + format: binary +binaryDataN2InformationExt9: + type: string + format: binary +binaryDataN2InformationExt10: + type: string + format: binary +binaryDataN2InformationExt11: + type: string + format: binary +binaryDataN2InformationExt12: + type: string + format: binary +binaryDataN2InformationExt13: + type: string + format: binary +binaryDataN2InformationExt14: + type: string + format: binary +binaryDataN2InformationExt15: + type: string + format: binary +binaryDataN2InformationExt16: + type: string + format: binary +binaryDataN2InformationExt17: + type: string + format: binary +encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt7: + contentType: application/vnd.3gpp.ngap + headers: +``` + +``` + + Content-Id: + schema: + type: string +binaryDataN2InformationExt8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt11: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt12: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt13: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt14: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt15: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt16: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt17: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +required: true +callbacks: + onN2MessageNotify: + '{ $request.body#/n2NotifyUri }': + post: + summary: Namf_Communication N2 Info Notify (UE Specific) service Operation + tags: + - N2 Info Notify + operationId: N2InfoNotifyHandoverComplete + requestBody: + description: UE Specific N2 Information Notification + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationNotification' + +``` + +``` +responses: + '200': + description: N2 Information Notification Response. + content: + application/json: + schema: + $ref: '#/components/schemas/N2InfoNotificationRspData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/N2InfoNotificationRspData' + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + binaryDataN2InformationExt3: + type: string + format: binary + binaryDataN2InformationExt4: + type: string + format: binary + binaryDataN2InformationExt5: + type: string + format: binary + binaryDataN2InformationExt6: + type: string + format: binary + binaryDataN2InformationExt7: + type: string + format: binary + binaryDataN2InformationExt8: + type: string + format: binary + binaryDataN2InformationExt9: + type: string + format: binary + binaryDataN2InformationExt10: + type: string + format: binary + binaryDataN2InformationExt11: + type: string + format: binary + binaryDataN2InformationExt12: + type: string + format: binary + binaryDataN2InformationExt13: + type: string + format: binary + binaryDataN2InformationExt14: + type: string + format: binary + binaryDataN2InformationExt15: + type: string + format: binary + binaryDataN2InformationExt16: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt3: + contentType: application/vnd.3gpp.ngap +``` + +``` +headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt11: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt12: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt13: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt14: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt15: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt16: + contentType: application/vnd.3gpp.ngap +``` + +``` + + headers: + Content-Id: + schema: + type: string + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +responses: + '201': + description: UE context successfully created. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/namf-comm//ue-contexts/{ueContextId} + required: true + schema: + type: string + 3gpp-Sbi-Producer-Id: + description: > + Indicating the AMF serving the UE Context. This header shall be included when the + UE Context is created in a target AMF other than the initial AMF sending the + response. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextCreatedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextCreatedData' + binaryDataN2Information: + type: string + format: binary + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + binaryDataN2InformationExt3: + type: string + format: binary + binaryDataN2InformationExt4: + type: string + format: binary + binaryDataN2InformationExt5: + type: string + format: binary + +``` + +``` + binaryDataN2InformationExt6: + type: string + format: binary + binaryDataN2InformationExt7: + type: string + format: binary + binaryDataN2InformationExt8: + type: string + format: binary + binaryDataN2InformationExt9: + type: string + format: binary + binaryDataN2InformationExt10: + type: string + format: binary + binaryDataN2InformationExt11: + type: string + format: binary + binaryDataN2InformationExt12: + type: string + format: binary + binaryDataN2InformationExt13: + type: string + format: binary + binaryDataN2InformationExt14: + type: string + format: binary + binaryDataN2InformationExt15: + type: string + format: binary +encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt7: +``` + +``` + Content-Id: + schema: + type: string +binaryDataN2InformationExt8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt11: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt12: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt13: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt14: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt15: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextCreateError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextCreateError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object +``` + +``` + +properties: # Response parts + jsonData: + $ref: '#/components/schemas/UeContextCreateError' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextCreateError' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +/ue-contexts/{ueContextId}/release: + post: + summary: Namf_Communication ReleaseUEContext service Operation + tags: + - Individual ueContext (Document) + operationId: ReleaseUEContext + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+))$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UEContextRelease' + required: true + responses: + '204': + description: UE Context successfully released + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + +``` + +``` + +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +/ue-contexts/{ueContextId}/assign-ebi: + post: + summary: Namf_Communication EBI Assignment service Operation + tags: + - Individual ueContext (Document) + operationId: EBIAssignment + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:assign-ebi + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiData' + required: true + responses: + '200': + description: EBI Assignment successfully performed. + content: + application/json: + schema: + $ref: '#/components/schemas/AssignedEbiData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiError' + application/problem+json: # error originated by an SCP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiError' + application/problem+json: # error originated by an SCP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiError' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiError' + application/problem+json: # error originated by an SCP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/ue-contexts/{ueContextId}/transfer: + post: + summary: Namf_Communication UEContextTransfer service Operation + tags: + - Individual ueContext (Document) + operationId: UEContextTransfer + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextTransferReqData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextTransferReqData' + binaryDataN1Message: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1Message: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + +``` + +``` + +description: UE context transfer successfully initiated. +content: + application/json: + schema: + $ref: '#/components/schemas/UeContextTransferRspData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextTransferRspData' + binaryDataN2Information: + type: string + format: binary + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/ue-contexts/{ueContextId}/transfer-update: + post: + summary: Namf_Communication RegistrationStatusUpdate service Operation + tags: + - Individual ueContext (Document) + operationId: RegistrationStatusUpdate + security: + - {} + - oAuth2ClientCredentials: + +``` + +``` + + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility +parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((5g-guti-[0-9]{5,6}|[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$)' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UeRegStatusUpdateReqData' + required: true +responses: + '200': + description: UE context transfer status successfully updated. + content: + application/json: + schema: + $ref: '#/components/schemas/UeRegStatusUpdateRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/ue-contexts/{ueContextId}/relocate: + post: + summary: Namf_Communication RelocateUEContext service Operation + tags: + - Individual ueContext (Document) + operationId: RelocateUEContext + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((5g-guti-[0-9]{5,6}|[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$)' + requestBody: + content: + +``` + +``` +multipart/related: # message with binary body part(s) +schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextRelocateData' + binaryDataForwardRelocationRequest: + type: string + format: binary + binaryDataN2Information: + type: string + format: binary + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + binaryDataN2InformationExt3: + type: string + format: binary + binaryDataN2InformationExt4: + type: string + format: binary + binaryDataN2InformationExt5: + type: string + format: binary + binaryDataN2InformationExt6: + type: string + format: binary + binaryDataN2InformationExt7: + type: string + format: binary + binaryDataN2InformationExt8: + type: string + format: binary + binaryDataN2InformationExt9: + type: string + format: binary + binaryDataN2InformationExt10: + type: string + format: binary + binaryDataN2InformationExt11: + type: string + format: binary + binaryDataN2InformationExt12: + type: string + format: binary + binaryDataN2InformationExt13: + type: string + format: binary + binaryDataN2InformationExt14: + type: string + format: binary + binaryDataN2InformationExt15: + type: string + format: binary + binaryDataN2InformationExt16: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataForwardRelocationRequest: + contentType: application/vnd.3gpp.gtpc + headers: + Content-Id: + schema: + type: string + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: +``` + +``` + Content-Id: + schema: + type: string +binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt11: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt12: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt13: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2InformationExt14: + contentType: application/vnd.3gpp.ngap + headers: +``` + +``` + + Content-Id: + schema: + type: string + binaryDataN2InformationExt15: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt16: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + required: true + responses: + '201': + description: UE context successfully relocated. + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/namf-comm//ue-contexts/{ueContextId}/relocate' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextRelocatedData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + /ue-contexts/{ueContextId}/cancel-relocate: + post: + summary: Namf_Communication CancelRelocateUEContext service Operation + tags: + - Individual ueContext (Document) + operationId: CancelRelocateUEContext + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + +``` + +``` + +pattern: '^((5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+| +imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' +requestBody: +content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextCancelRelocateData' + binaryDataGtpcMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataGtpcMessage: + contentType: application/vnd.3gpp.gtpc + headers: + Content-Id: + schema: + type: string + required: true +responses: + '204': + description: UE Context successfully released + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/ue-contexts/{ueContextId}/n1-n2-messages: + post: + summary: Namf_Communication N1N2 Message Transfer (UE Specific) service Operation + tags: + - n1N2Message collection (Collection) + operationId: N1N2MessageTransfer + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:n1-n2-messages + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|cid-. +{1,255}|.+)$' + requestBody: + content: + +``` + +``` + +application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferReqData' +multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/N1N2MessageTransferReqData' + binaryDataN1Message: + type: string + format: binary + binaryDataN2Information: + type: string + format: binary + binaryMtData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1Message: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryMtData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + required: true +responses: + '202': + description: N1N2 Message Transfer accepted. + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferRspData' + headers: + Location: + description: > + The URI of the resource located on the AMF In this release, the URI shall only be + used by NF Service Consumer to correlate the possible N1/N2 Message Transfer Failure + Notification With the related N1/N2 Message Transfer Operation. The NF service + consumer shall not send any service requests towards the URI received in the + Location header. + required: true + schema: + type: string + '200': + description: N1N2 Message Transfer successfully initiated. + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + description: Conflicts + +``` + +``` + +content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferError' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +default: + description: Unexpected error +callbacks: + onN1N2TransferFailure: + '{ $request.body#/n1n2FailureTxfrNotifURI }': + post: + summary: Namf_Communication N1N2Transfer Failure Notification service Operation + tags: + - N1N2 Transfer Failure Notification + operationId: N1N2TransferFailureNotification + requestBody: + description: N1N2Transfer Failure Notification + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MsgTxfrFailureNotification' + responses: + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/ue-contexts/{ueContextId}/n1-n2-messages/subscriptions: + post: + summary: Namf_Communication N1N2 Message Subscribe (UE Specific) service Operation + tags: + - N1N2 Subscriptions Collection for Individual UE Contexts (Collection) + operationId: N1N2MessageSubscribe + +``` + +``` + +security: +- {} +- oAuth2ClientCredentials: +- namf-comm +- oAuth2ClientCredentials: +- namf-comm +- namf-comm:n1-n2-messages +parameters: +- name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^^(imsi-[0-9]{5,15}|nai-\.+\|gli-\.+\|gci-\.+\|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' +requestBody: +content: + application/json: + schema: + $ref: '#/components/schemas/UeN1N2InfoSubscriptionCreateData' +required: true +responses: +'201': + description: N1N2 Message Subscription successfully created. + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/namf-comm//ue-contexts/{ueContextId}/n1-n2-messages/subscriptions/ +{subscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/UeN1N2InfoSubscriptionCreatedData' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +callbacks: + onN1N2MessageNotify: + '{ $request.body#/n1NotifyCallbackUri }': + post: + summary: Namf_Communication N1 Message Notify service Operation + tags: + - N1 Message Notify + operationId: N1MessageNotify + requestBody: + description: N1 Message Notification + content: + multipart/related: # message with binary body part(s) + schema: + type: object + +``` + +``` + +properties: # Request parts + jsonData: + $ref: '#/components/schemas/N1MessageNotification' + binaryDataN1Message: + type: string + format: binary +encoding: + jsonData: + contentType: application/json + binaryDataN1Message: + contentType: application/vnd.3gpp.5gnas +headers: + Content-Id: + schema: + type: string +responses: + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'{ $request.body#/n2NotifyCallbackUri }': +post: + summary: Namf_Communication N2 Info Notify (UE Specific) service Operation + tags: + - N2 Info Notify + operationId: N2InfoNotify + requestBody: + description: UE Specific N2 Information Notification + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/N2InformationNotification' + binaryDataN1Message: + type: string + format: binary + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1Message: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + +``` + +``` + + schema: + type: string + responses: + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/ue-contexts/{ueContextId}/nl-n2-messages/subscriptions/{subscriptionId}: + delete: + summary: Namf_Communication N1N2 Message UnSubscribe (UE Specific) service Operation + tags: + - N1N2 Individual Subscription (Document) + operationId: N1N2MessageUnSubscribe + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:n1-n2-messages + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + - name: subscriptionId + in: path + description: Subscription Identifier + required: true + schema: + type: string + responses: + '204': + description: N1N2 Message Subscription successfully removed. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/non-ue-n2-messages/transfer: + post: + summary: Namf_Communication Non UE N2 Message Transfer service Operation + tags: + - Non UE N2Messages collection (Collection) + operationId: NonUeN2MessageTransfer + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:non-ue-n2-messages + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferReqData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/N2InformationTransferReqData' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + description: Non UE N2 Message Transfer successfully initiated. + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + +``` + +``` + +description: Not Found +content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + description: Service Unavailable + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +default: + description: Unexpected error +/non-ue-n2-messages/subscriptions: + post: + summary: Namf_Communication Non UE N2 Info Subscribe service Operation + tags: + - Non UE N2Messages Subscriptions collection (Collection) + operationId: NonUeN2InfoSubscribe + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:non-ue-n2-messages + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NonUeN2InfoSubscriptionCreateData' + required: true + responses: + '201': + description: Non UE N2 Info Subscription successfully created. + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/namf-comm//non-ue-n2-messages/subscriptions/ +{n2NotifySubscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NonUeN2InfoSubscriptionCreatedData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + onN2InfoNotify: + '{$request.body#/n2NotifyCallbackUri}': + post: + summary: Namf_Communication Non UE N2 Info Notify service Operation + tags: + - Non UE N2 Info Notify + operationId: NonUeN2InfoNotify + requestBody: + description: Non UE N2 Information Notification + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationNotification' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/N2InformationNotification' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + +``` + +``` + + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId}: + delete: + summary: Namf_Communication Non UE N2 Info UnSubscribe service Operation + tags: + - Non UE N2 Message Notification Individual Subscription (Document) + operationId: NonUeN2InfoUnSubscribe + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:non-ue-n2-messages + parameters: + - name: n2NotifySubscriptionId + in: path + description: N2 info Subscription Identifier + required: true + schema: + type: string + responses: + '204': + description: Non UE N2 INfo Subscription successfully removed. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/subscriptions: + post: + summary: Namf_Communication AMF Status Change Subscribe service Operation + tags: + - subscriptions collection (Collection) + operationId: AMFStatusChangeSubscribe + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + required: true + responses: + '201': + description: N1N2 Message Subscription successfully created. + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/namf-comm//subscriptions/{subscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + onAmfStatusChange: + '{$request.body#/amfStatusUri}': + post: + summary: Amf Status Change Notify service Operation + tags: + - Amf Status Change Notify + operationId: AmfStatusChangeNotify + requestBody: + description: Amf Status Change Notification + content: + application/json: + schema: + $ref: '#/components/schemas/AmfStatusChangeNotification' + responses: + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/subscriptions/{subscriptionId}: + delete: + summary: Namf_Communication AMF Status Change UnSubscribe service Operation + tags: + - individual subscription (Document) + operationId: AMFStatusChangeUnSubscribe + parameters: + - name: subscriptionId + in: path + description: AMF Status Change Subscription Identifier + required: true + schema: + type: string + responses: + +``` + +``` + + '204': + description: N1N2 Message Subscription successfully removed. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +put: + summary: Namf_Communication AMF Status Change Subscribe Modify service Operation + tags: + - individual subscription (Document) + operationId: AMFStatusChangeSubscribeModify + parameters: + - name: subscriptionId + in: path + description: AMF Status Change Subscription Identifier + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + required: true + responses: + '200': + description: Subscription modified successfully + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + '204': + description: Events subscription modification is accepted entirely + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + +``` + +``` + + description: Unexpected error + callbacks: + OnAmfStatusChange: + '{ $request.body#/amfStatusUri }': + post: + summary: Amf Status Change Notify service Operation + tags: + - Amf Status Change Notify + operationId: AmfStatusChangeNotify + requestBody: + description: Amf Status Change Notification + content: + application/json: + schema: + $ref: '#/components/schemas/AmfStatusChangeNotification' + responses: + '204': + description: Expected response to a successful callback processing + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + namf-comm: Access to the Namf_Communication API + namf-comm:ue-contexts:mobility: > + Access to service operations applying to UE context resources, i.e., + UEContextTransfer, RegistrationStatusUpdate, CreateUEContext, ReleaseUEContext, + RelocateUEContext, and CancelRelocateUEContext. + namf-comm:ue-contexts:assign-ebi: > + Access to service operations applying to UE context resources for EBI assignment, + i.e., EBIAssignment. + namf-comm:n1-n2-messages: > + Access to service operations applying to n1-n2-messages resources, i.e., + N1N2MessageSubscribe, N1N2MessageUnSubscribe, N1N2MessageTransfer, N1MessageNotify and + N2InfoNotify + namf-comm:non-ue-n2-messages: > + Access to service operations applying to the non-ue-n2-messages resources, i.e., + NonUeN2MessageTransfer, NonUeN2InfoSubscribe, NonUeN2InfoUnSubscribe, and + NonUeN2InfoNotify + +schemas: +# +# STRUCTURED DATA TYPES +# + SubscriptionData: + description: Data within an AMF Status Change Subscription request and response + type: object + properties: + amfStatusUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + +``` + +``` + guamiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + required: + - amfStatusUri +AmfStatusChangeNotification: + description: Data within an AMF Status Change Notification request + type: object + properties: + amfStatusInfoList: + type: array + items: + $ref: '#/components/schemas/AmfStatusInfo' + minItems: 1 + required: + - amfStatusInfoList +AmfStatusInfo: + description: AMF Status Information + type: object + properties: + guamiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + statusChange: + $ref: '#/components/schemas/StatusChange' + targetAmfRemoval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' + targetAmfFailure: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' + required: + - guamiList + - statusChange +AssignEbiData: + description: Data within an EBI assignment request + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + arpList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + releasedEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + modifiedEbiList: + type: array + items: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/EbiArpMapping' + minItems: 1 + required: + - pduSessionId +AssignedEbiData: + description: Data within a successful response to an EBI assignment request + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + assignedEbiList: + type: array + items: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/EbiArpMapping' + minItems: 0 + failedArpList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + releasedEbiList: +``` + +``` + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + modifiedEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + required: + - pduSessionId + - assignedEbiList +AssignEbiFailed: + description: Represents failed assignment of EBI(s) + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + failedArpList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + required: + - pduSessionId +UEContextRelease: + description: Data within a Release UE Context request + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + unauthenticatedSupi: + type: boolean + default: false + ngapCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + required: + - ngapCause +N2InformationTransferReqData: + description: Data within a N2 Information Transfer request containing the N2 information + requested to be transferred to 5G AN + type: object + properties: + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + ratSelector: + $ref: '#/components/schemas/RatSelector' + globalRanNodeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + n2Information: + $ref: '#/components/schemas/N2InfoContainer' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - n2Information +NonUeN2InfoSubscriptionCreateData: + description: Data within a create subscription request for non-UE specific N2 information + notification + type: object + properties: + globalRanNodeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + anTypeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + n2InformationClass: + $ref: '#/components/schemas/N2InformationClass' +``` + +``` +n2NotifyCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +notifCorrelationId: + type: string +required: +- n2InformationClass +- n2NotifyCallbackUri +NonUeN2InfoSubscriptionCreatedData: +description: Data for the created subscription for non-UE specific N2 information notification +type: object +properties: + n2NotifySubscriptionId: + type: string + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + n2InformationClass: + $ref: '#/components/schemas/N2InformationClass' +required: +- n2NotifySubscriptionId +UeN1N2InfoSubscriptionCreateData: +description: Data within a create subscription request for UE specific N1 and/or N2 +information notification +type: object +properties: + n2InformationClass: + $ref: '#/components/schemas/N2InformationClass' + n2NotifyCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + n1MessageClass: + $ref: '#/components/schemas/N1MessageClass' + n1NotifyCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' +UeN1N2InfoSubscriptionCreatedData: +description: Data for the created subscription for UE specific N1 and/or N2 information +notification +type: object +properties: + n1n2NotifySubscriptionId: + type: string + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +required: +- n1n2NotifySubscriptionId +N2InformationNotification: +description: Data within a N2 information notification request +type: object +properties: + n2NotifySubscriptionId: + type: string + n2InfoContainer: + $ref: '#/components/schemas/N2InfoContainer' + toReleaseSessionList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 + lcsCorrelationId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CorrelationID' + notifyReason: + $ref: '#/components/schemas/N2InfoNotifyReason' + smfChangeInfoList: + type: array + items: + $ref: '#/components/schemas/SmfChangeInfo' + minItems: 1 + ranNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + initialAmfName: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' + anN2IPV4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + anN2IPV6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + notifySourceNgRan: + type: boolean + default: false + notifCorrelationId: + type: string + required: + - n2NotifySubscriptionId + +N2InfoContainer: + description: N2 information container + type: object + properties: + n2InformationClass: + $ref: '#/components/schemas/N2InformationClass' + smInfo: + $ref: '#/components/schemas/N2SmInformation' + ranInfo: + $ref: '#/components/schemas/N2RanInformation' + nrppaInfo: + $ref: '#/components/schemas/NrppaInformation' + pwsInfo: + $ref: '#/components/schemas/PwsInformation' + v2xInfo: + $ref: '#/components/schemas/V2xInformation' + proseInfo: + $ref: '#/components/schemas/ProSeInformation' + tssInfo: + $ref: '#/components/schemas/TssInformation' + rslpInfo: + $ref: '#/components/schemas/RslpInformation' + a2xInfo: + $ref: '#/components/schemas/A2xInformation' + required: + - n2InformationClass + +N1MessageNotification: + description: Data within a N1 message notification request + type: object + properties: + n1NotifySubscriptionId: + type: string + n1MessageContainer: + $ref: '#/components/schemas/N1MessageContainer' + lcsCorrelationId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CorrelationID' + registrationCtxtContainer: + $ref: '#/components/schemas/RegistrationContextContainer' + newLmfIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + cIoT5GSOptimisation: + type: boolean + default: false + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + pruInd: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/PruInd' + required: + - n1MessageContainer + +N1MessageContainer: + description: N1 Message container + type: object + properties: + n1MessageClass: + $ref: '#/components/schemas/N1MessageClass' +``` + +``` + + nlMessageContent: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + serviceInstanceId: + type: string + required: + - nlMessageClass + - nlMessageContent + N1N2MessageTransferReqData: + description: Data within a N1/N2 message transfer request + type: object + properties: + nlMessageContainer: + $ref: '#/components/schemas/N1MessageContainer' + n2InfoContainer: + $ref: '#/components/schemas/N2InfoContainer' + mtData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + skipInd: + type: boolean + default: false + lastMsgIndication: + type: boolean + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + lcsCorrelationId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CorrelationID' + ppi: + $ref: '#/components/schemas/Ppi' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + nln2FailureTxfNotifURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smfReallocationInd: + type: boolean + default: false + areaOfValidity: + $ref: '#/components/schemas/AreaOfValidity' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + maAcceptedInd: + type: boolean + default: false + extBufSupport: + type: boolean + default: false + targetAccess: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pruInd: + type: boolean + enum: + - true + + N1N2MessageTransferRspData: + description: Data within a N1/N2 message transfer response + type: object + properties: + cause: + $ref: '#/components/schemas/N1N2MessageTransferCause' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - cause + RegistrationContextContainer: + description: Registration Context Container used to send the UE context information, N1 + message from UE, AN address etc during Registration with AMF re-allocation procedure + type: object + properties: + ueContext: + +``` + +``` +$ref: '#/components/schemas/UeContext' +localTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' +anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' +anN2ApId: + type: integer +ranNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' +initialAmfName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' +userLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' +rrcEstCause: + type: string + pattern: '^[0-9a-fA-F]+$' +ueContextRequest: + type: boolean + default: false +initialAmfN2ApId: + type: integer +anN2IPv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +anN2IPv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' +allowedNssai: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/AllowedNssai' +configuredNssai: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/ConfiguredSnssai' + minItems: 1 +rejectedNssaiInPlmn: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 +rejectedNssaiInTa: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 +selectedPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +iabNodeInd: + type: boolean + default: false +mbsrNodeInd: + type: boolean + default: false +ceModeBInd: + $ref: '#/components/schemas/CeModeBInd' +lteMInd: + $ref: '#/components/schemas/LteMInd' +authenticatedInd: + type: boolean + default: false +npnAccessInfo: + $ref: '#/components/schemas/NpnAccessInfo' +required: +- ueContext +- anType +- anN2ApId +- ranNodeId +- initialAmfName +- userLocation + +AreaOfValidity: + description: Area of validity information for N2 information transfer + type: object + properties: + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 0 + taiRangeList: + type: array +``` + +``` + + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TaiRange' + minItems: 1 + required: + - taiList + UeContextTransferReqData: + description: Data within a UE Context Transfer Request to start transferring of an individual + ueContext resource from old AMF to new AMF + type: object + properties: + reason: + $ref: '#/components/schemas/TransferReason' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + regRequest: + $ref: '#/components/schemas/N1MessageContainer' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - reason + - accessType + UeContextTransferRspData: + description: Data within a successful response to the UE Context Transfer request + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + ueRadioCapability: + $ref: '#/components/schemas/N2InfoContent' + ueRadioCapabilityForPaging: + $ref: '#/components/schemas/N2InfoContent' + ueNbiotRadioCapability: + $ref: '#/components/schemas/N2InfoContent' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ueContext + UeContext: + description: Represents an individual ueContext resource + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + supiUnauthInd: + type: boolean + gpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + ausfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + pcfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + routingIndicator: + type: string + hNwPubKeyId: + type: integer + groupList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + drxParameter: + $ref: '#/components/schemas/DrxParameter' + subRfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + pcfRfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + usedRfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + subUeAmbr: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' +pcfUeAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' +subUeSliceMbrList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceMbr' + minProperties: 1 + description: A map(list of key-value pairs) where Snssai serves as key. +smfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +seafData: + $ref: '#/components/schemas/SeafData' +5gMmCapability: + $ref: '#/components/schemas/5GMmCapability' +pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +pcfAmpServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +pcfUepServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +pcfBinding: + $ref: '#/components/schemas/SbiBindingLevel' +pcfAmPolicyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +amPolicyReqTriggerList: + type: array + items: + $ref: '#/components/schemas/PolicyReqTrigger' + minItems: 1 +pcfUePolicyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +uePolicyReqTriggerList: + type: array + items: + $ref: '#/components/schemas/PolicyReqTrigger' + minItems: 1 +hpcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +hpcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +restrictedRatList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 +forbiddenAreaList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Area' + minItems: 1 +serviceAreaRestriction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' +restrictedCoreNwTypeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CoreNetworkType' + minItems: 1 +eventSubscriptionList: + type: array + items: + $ref: '#/components/schemas/ExtAmfEventSubscription' + minItems: 1 +mmContextList: + type: array + items: + $ref: '#/components/schemas/MmContext' + minItems: 1 + maxItems: 2 +sessionContextList: + type: array + items: + $ref: '#/components/schemas/PduSessionContext' + minItems: 1 +epsInterworkingInfo: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/EpsInterworkingInfo' +``` + +``` +traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' +serviceGapExpiryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +stnSr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StnSr' +cMsisdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CMsisdn' +msClassmark2: + $ref: '#/components/schemas/MSClassmark2' +supportedCodecList: + type: array + items: + $ref: '#/components/schemas/SupportedCodec' + minItems: 1 +smallDataRateStatusInfos: + type: array + items: + $ref: '#/components/schemas/SmallDataRateStatusInfo' + minItems: 1 +restrictedPrimaryRatList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 +restrictedSecondaryRatList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 +v2xContext: + $ref: '#/components/schemas/V2xContext' +lteCatMInd: + type: boolean + default: false +redCapInd: + type: boolean + default: false +moExpDataCounter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter' +cagData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/CagData' +managementMdtInd: + type: boolean + default: false +immediateMdtConf: + $ref: '#/components/schemas/ImmediateMdtConf' +ecRestrictionDataWb: + $ref: '#/components/schemas/EcRestrictionDataWb' +ecRestrictionDataNb: + type: boolean + default: false +iabOperationAllowed: + type: boolean +proseContext: + $ref: '#/components/schemas/ProseContext' +analyticsSubscriptionList: + type: array + items: + $ref: '#/components/schemas/AnalyticsSubscription' + minItems: 1 +pcfAmpBindingInfo: + type: string +pcfUepBindingInfo: + type: string +usedServiceAreaRestriction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' +praInAmPolicy: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: A map(list of key-value pairs) where praId serves as key. +praInUePolicy: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 +``` + +``` + + description: A map(list of key-value pairs) where praId serves as key. + updpSubscriptionData: + $ref: '#/components/schemas/UpdpSubscriptionData' + smPolicyNotifyPduList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionInfo' + minItems: 1 + pcfUeCallbackInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' + uePositioningCap: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/UePositioningCapabilities' + astiDistributionIndication: + type: boolean + default: false + tsErrorBudget: + type: integer + snpnOnboardInd: + type: boolean + default: false + smfSelInfo: + $ref: 'TS29507_Npcf_AMPolicyControl.yaml#/components/schemas/SmfSelectionData' + pcfUeSliceMbrList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceMbr' + minProperties: 1 + description: A map(list of key-value pairs) where Snssai serves as key. + smfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + smfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + smfBindingInfo: + type: string + disasterRoamingInd: + type: boolean + default: false + disasterPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + satelliteBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + wlServAreaRes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/WirelineServiceAreaRestriction' + asTimeDisParam: + $ref: 'TS29507_Npcf_AMPolicyControl.yaml#/components/schemas/AsTimeDistributionParam' + amPolicyInfoContainer: + $ref: '#/components/schemas/AmPolicyInfoContainer' + a2xContext: + $ref: '#/components/schemas/A2xContext' + mbsrOperationAllowed: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/MbsrOperationAllowed' + lcsUpContext: + $ref: '#/components/schemas/LcsUpContext' + reconnectInd: + type: boolean + default: false + +N2SmInformation: + description: Represents the session management SMF related N2 information data part + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + n2InfoContent: + $ref: '#/components/schemas/N2InfoContent' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + homePlmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + iwkSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + subjectToHo: + type: boolean + required: + - pduSessionId + N2InfoContent: + +``` + +``` +description: Represents a transparent N2 information content to be relayed by AMF +type: object +properties: + ngapMessageType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + ngapIeType: + $ref: '#/components/schemas/NgapIeType' + ngapData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +required: + - ngapData +NrppaInformation: +description: Represents a NRPPa related N2 information data part +type: object +properties: + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nrppaPdu: + $ref: '#/components/schemas/N2InfoContent' + serviceInstanceId: + type: string +required: + - nfId + - nrppaPdu +PwsInformation: +description: Represents a PWS related information data part +type: object +properties: + messageIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + serialNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + pwsContainer: + $ref: '#/components/schemas/N2InfoContent' + bcEmptyAreaList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + sendRanResponse: + type: boolean + default: false + omcId: + $ref: '#/components/schemas/OmcIdentifier' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +required: + - messageIdentifier + - serialNumber + - pwsContainer +N1N2MsgTxfrFailureNotification: +description: Data within a N1/N2 Message Transfer Failure Notification request +type: object +properties: + cause: + $ref: '#/components/schemas/N1N2MessageTransferCause' + n1n2MsgDataUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +required: + - cause + - n1n2MsgDataUri +N1N2MessageTransferError: +description: Data within a N1/N2 Message Transfer Error response +type: object +properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + errInfo: + $ref: '#/components/schemas/N1N2MsgTxfrErrDetail' +required: + - error +N1N2MsgTxfrErrDetail: +description: N1/N2 Message Transfer Error Details +type: object +properties: +``` + +``` + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + highestPrioArp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + maxWaitingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + N2InformationTransferRspData: + description: Data within a successful response to the N2 Information Transfer request to +transfer N2 Information to the AN + type: object + properties: + result: + $ref: '#/components/schemas/N2InformationTransferResult' + pwsRspData: + $ref: '#/components/schemas/PWSResponseData' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - result + MmContext: + description: Represents a Mobility Management Context in UE Context + type: object + properties: + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + nasSecurityMode: + $ref: '#/components/schemas/NasSecurityMode' + epsNasSecurityMode: + $ref: '#/components/schemas/EpsNasSecurityMode' + nasDownlinkCount: + $ref: '#/components/schemas/NasCount' + nasUplinkCount: + $ref: '#/components/schemas/NasCount' + ueSecurityCapability: + $ref: '#/components/schemas/UeSecurityCapability' + slUeNetworkCapability: + $ref: '#/components/schemas/S1UeNetworkCapability' + allowedNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + nssaiMappingList: + type: array + items: + $ref: '#/components/schemas/NssaiMapping' + minItems: 1 + allowedHomeNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + partiallyAllowedNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartiallyAllowedSnssai' + minItems: 1 + nsInstanceList: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' + minItems: 1 + expectedUEbehavior: + $ref: '#/components/schemas/ExpectedUeBehavior' + ueDifferentiationInfo: + $ref: '#/components/schemas/UeDifferentiationInfo' + plmnAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId' + manAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ManAssiUeRadioCapId' + ucmfDicEntryId: + type: string + n3IwfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + wagfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + tngfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' +``` + +``` +anN2ApId: + type: integer +nssaaStatusList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NssaaStatus' + minItems: 1 +pendingNssaiMappingList: + type: array + items: + $ref: '#/components/schemas/NssaiMapping' + minItems: 1 +uuaaMmStatus: + $ref: '#/components/schemas/UuaaMmStatus' +required: +- accessType +SeafData: + description: Represents SEAF data derived from data received from AUSF + type: object + properties: + ngKsi: + $ref: '#/components/schemas/NgKsi' + keyAmf: + $ref: '#/components/schemas/KeyAmf' + nh: + type: string + pattern: '^[A-Fa-f0-9]+$' + ncc: + type: integer + minimum: 0 + maximum: 7 + keyAmfChangeInd: + type: boolean + keyAmfHDerivationInd: + type: boolean + required: + - ngKsi + - keyAmf +NasSecurityMode: + description: Indicates the NAS Security Mode + type: object + properties: + integrityAlgorithm: + $ref: '#/components/schemas/IntegrityAlgorithm' + cipheringAlgorithm: + $ref: '#/components/schemas/CipheringAlgorithm' + required: + - integrityAlgorithm + - cipheringAlgorithm +PduSessionContext: + description: Represents a PDU Session Context in UE Context + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + smContextRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + selectedDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + additionalAccessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + allocatedEbiList: + type: array + items: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/EbiArpMapping' + minItems: 1 + hsmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + hsmfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + hsmfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +``` + +``` + +smfBinding: + $ref: '#/components/schemas/SbiBindingLevel' +vsmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +vsmfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +vsmfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +vsmfBinding: + $ref: '#/components/schemas/SbiBindingLevel' +ismfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +ismfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +ismfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +ismfBinding: + $ref: '#/components/schemas/SbiBindingLevel' +nsInstance: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' +smfServiceInstanceId: + type: string +maPduSession: + type: boolean + default: false +cnAssistedRanPara: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/CnAssistedRanPara' +nrfManagementUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +nrfDiscoveryUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +nrfAccessTokenUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +smfBindingInfo: + type: string +vsmfBindingInfo: + type: string +ismfBindingInfo: + type: string +additionalSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +pgwIpAddr: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpAddress' +plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +anchorSmfSupportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +anchorSmfOAuth2Required: + type: boolean +hrsboAllowedInd: + type: boolean +required: + - pduSessionId + - smContextRef + - sNssai + - dnn + - accessType +NssaiMapping: + description: Represents the mapping between a S-NSSAI in serving PLMN to a S-NSSAI in home +PLMN + type: object + properties: + mappedSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + hSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - mappedSnssai + - hSnssai +UeRegStatusUpdateReqData: + description: Data within a UE registration status update request to indicate a completion of +transferring at a target AMF + type: object + properties: + +``` + +``` +transferStatus: + $ref: '#/components/schemas/UeContextTransferStatus' +toReleaseSessionList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 +pcfReselectedInd: + type: boolean +smfChangeInfoList: + type: array + items: + $ref: '#/components/schemas/SmfChangeInfo' + minItems: 1 +analyticsNotUsedList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 +toReleaseSessionInfo: + type: array + items: + $ref: '#/components/schemas/ReleaseSessionInfo' + minItems: 1 +required: +- transferStatus +UeRegStatusUpdateRspData: + description: Data within a UE registration status update response to provide the status of UE +context transfer status update at a source AMF + type: object + properties: + regStatusTransferComplete: + type: boolean + required: + - regStatusTransferComplete +AssignEbiError: + description: Data within a failure response to the EBI assignment request + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + failureDetails: + $ref: '#/components/schemas/AssignEbiFailed' + required: + - error + - failureDetails +UeContextCreateData: + description: Data within a request to create an individual ueContext resource + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + targetId: + $ref: '#/components/schemas/NgRanTargetId' + sourceToTargetData: + $ref: '#/components/schemas/N2InfoContent' + pduSessionList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 + n2NotifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ueRadioCapability: + $ref: '#/components/schemas/N2InfoContent' + ueRadioCapabilityForPaging: + $ref: '#/components/schemas/N2InfoContent' + ngapCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + required: + - ueContext + - targetId + - sourceToTargetData + - pduSessionList +``` + +``` +UeContextCreatedData: + description: Data within a successful response for creating an individual ueContext resource + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + targetToSourceData: + $ref: '#/components/schemas/N2InfoContent' + pduSessionList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 + failedSessionList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + pcfReselectedInd: + type: boolean + analyticsNotUsedList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + required: + - ueContext + - targetToSourceData + - pduSessionList +UeContextCreateError: + description: Data within a failure response for creating a UE context + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + ngapCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + targetToSourceFailureData: + $ref: '#/components/schemas/N2InfoContent' + required: + - error +UeContextRelocateData: + description: Data within a Relocate UE Context request + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + targetId: + $ref: '#/components/schemas/NgRanTargetId' + sourceToTargetData: + $ref: '#/components/schemas/N2InfoContent' + forwardRelocationRequest: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + pduSessionList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 + ueRadioCapability: + $ref: '#/components/schemas/N2InfoContent' + ngapCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ueContext + - targetId + - sourceToTargetData + - forwardRelocationRequest +UeContextRelocatedData: + description: Data within a Relocate UE Context response + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + required: +``` + +- ueContext + +UeContextCancelRelocateData: +description: Data structure used for cancellation of UE Context Relocation +type: object +properties: + supi: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/Supi' + relocationCancelRequest: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/RefToBinaryData' +required: +- relocationCancelRequest + +NgRanTargetId: +description: Indicates a NG RAN as target of the handover +type: object +properties: + ranNodeId: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/GlobalRanNodeId' + tai: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/Tai' +required: +- ranNodeId +- tai + +PWSResponseData: +description: Data related PWS included in a N2 Information Transfer response +type: object +properties: + ngapMessageType: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/UInteger' + serialNumber: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/Uint16' + messageId: + type: integer + unknownTaiList: + type: array + items: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + n2PwsSubMissInd: + type: boolean + enum: + - true +required: +- ngapMessageType +- serialNumber +- messageId + +PWSErrorData: +description: Data related to PWS error included in a N2 Information Transfer failure response +type: object +properties: + namfCause: + type: integer +required: +- namfCause + +N2InformationTransferError: +description: Data within a failure response for a non-UE related N2 Information Transfer +type: object +properties: + error: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/ProblemDetails' + pwsErrorInfo: + \$ref: '#/components/schemas/PWSErrorData' +required: +- error + +NgKsi: +description: Represents the ngKSI +type: object +properties: + tsc: + \$ref: '#/components/schemas/ScType' + ksi: + type: integer + minimum: 0 + maximum: 6 +required: +- tsc +- ksi + +KeyAmf: + +``` +description: Represents the Kamf or K'amf +type: object +properties: + keyType: + $ref: '#/components/schemas/KeyAmfType' + keyVal: + type: string +required: +- keyType +- keyVal +ExpectedUeBehavior: +description: Represents the expected UE behavior (e.g. UE moving trajectory) and its validity +period +type: object +properties: + expMoveTrajectory: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + minItems: 1 + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +required: +- expMoveTrajectory +- validityTime +N2RanInformation: +description: Represents the RAN related N2 information data part +type: object +properties: + n2InfoContent: + $ref: '#/components/schemas/N2InfoContent' +required: +- n2InfoContent +N2InfoNotificationRspData: +description: Data within a N2 information notification response +type: object +properties: + secRatDataUsageList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 +SmallDataRateStatusInfo: +description: Represents the small data rate status +type: object +properties: + Snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + Dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + SmallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' +required: +- Snssai +- Dnn +- SmallDataRateStatus +SmfChangeInfo: +description: SMF change information for PDU session(s) +type: object +properties: + pduSessionIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 + smfChangeInd: + $ref: '#/components/schemas/SmfChangeIndication' +required: +- pduSessionIdList +- smfChangeInd +V2xContext: +description: Represents the V2X services related parameters +type: object +properties: + nrV2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NrV2xAuth' + lteV2xServicesAuth: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/LteV2xAuth' +nrUeSidelinkAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' +lteUeSidelinkAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' +pc5QoSPara: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pc5QoSPara' + +V2xInformation: + description: V2X related N2 information + type: object + properties: + n2Pc5Pol: + $ref: '#/components/schemas/N2InfoContent' + +ProSeInformation: + description: Represents 5G ProSe related N2 information. + type: object + properties: + n2Pc5ProSePol: + $ref: '#/components/schemas/N2InfoContent' + +ImmediateMdtConf: + description: Immediate MDT Configuration + type: object + properties: + jobType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/JobType' + measurementLteList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MeasurementLteForMdt' + minItems: 1 + measurementNrList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MeasurementNrForMdt' + minItems: 1 + reportingTriggerList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReportingTrigger' + minItems: 1 + reportInterval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReportIntervalMdt' + reportIntervalNr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReportIntervalNrMdt' + reportAmount: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReportAmountMdt' + eventThresholdRsrp: + type: integer + minimum: 0 + maximum: 97 + eventThresholdRsrq: + type: integer + minimum: 0 + maximum: 34 + eventThresholdRsrpNr: + type: integer + minimum: 0 + maximum: 127 + eventThresholdRsrqNr: + type: integer + minimum: 0 + maximum: 127 + collectionPeriodRmmLte: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CollectionPeriodRmmLteMdt' + collectionPeriodRmmNr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CollectionPeriodRmmNrMdt' + measurementPeriodLte: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MeasurementPeriodLteMdt' + areaScope: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaScope' + positioningMethod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PositioningMethodMdt' + addPositioningMethodList: + type: array + items: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/PositioningMethodMdt' +minItems: 1 +mdtAllowedPlmnIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + maxItems: 16 +sensorMeasurementList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SensorMeasurement' + minItems: 1 +required: +- jobType + +EpsNasSecurityMode: + description: Indicates the EPS NAS Security Mode + type: object + properties: + integrityAlgorithm: + $ref: '#/components/schemas/EpsNasIntegrityAlgorithm' + cipheringAlgorithm: + $ref: '#/components/schemas/EpsNasCipheringAlgorithm' + required: + - integrityAlgorithm + - cipheringAlgorithm + +EcRestrictionDataWb: + description: Enhanced Coverage Restriction Data for WB-N1 mode + type: object + properties: + ecModeARestricted: + type: boolean + default: false + ecModeBRestricted: + type: boolean + required: + - ecModeBRestricted + +ExtAmfEventSubscription: + description: AMF event subscription extended with additional information received for the + subscription + allOf: + - $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/AmfEventSubscription' + - $ref: '#/components/schemas/AmfEventSubscriptionAddInfo' + +AmfEventSubscriptionAddInfo: + description: Additional information received for an AMF event subscription, e.g. binding + indications + type: object + properties: + bindingInfo: + type: array + items: + type: string + minItems: 1 + maxItems: 2 + subscribingNfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + eventSyncInd: + type: boolean + nfConsumerInfo: + type: array + items: + type: string + minItems: 1 + aoiStateList: + type: object + description: > + Map of subscribed Area of Interest (AoI) Event State in the old AMF. The JSON pointer to + an AmfEventArea element in the areaList IE (or a PresenceInfo element in + presenceInfoList IE) of the AmfEvent data type shall be the key of the map. + additionalProperties: + $ref: '#/components/schemas/AreaOfInterestEventState' + accessToken: + type: string + description: > +``` + +JWS Compact Serialized representation of JWS signed JSON object (AccessTokenClaims defined in 3GPP TS 29.510) + +``` + +UeDifferentiationInfo: + description: Represents the UE Differentiation Information and its validity time + type: object + properties: + periodicComInd: + $ref: '#/components/schemas/PeriodicCommunicationIndicator' + periodicTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + scheduledComTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime' + stationaryInd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StationaryIndication' + trafficProfile: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficProfile' + batteryInd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BatteryIndication' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +CeModeBInd: + description: CE-mode-B Support Indicator. + type: object + properties: + ceModeBSupportInd: + type: boolean + required: + - ceModeBSupportInd + +LteMInd: + description: LTE-M Indication. + type: object + properties: + lteCatMInd: + type: boolean + required: + - lteCatMInd + +NpnAccessInfo: + description: NPN Access Information. + type: object + properties: + cellCagInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CagId' + minItems: 1 + +ProseContext: + description: Represents the ProSe services related parameters. + type: object + properties: + directDiscovery: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + directComm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 12Relay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 13Relay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 12Remote: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 13Remote: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 12UeRelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 13UeRelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 12End: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + 13End: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + multiPathComm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + nrUePc5Ambr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + +``` + +``` +pc5QoSPara: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pc5QoSPara' + +AnalyticsSubscription: + description: Analytics subscriptions created in the NWDAF. + type: object + properties: + nwdafId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nwdafSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + nwdafSubscriptionList: + type: array + items: + $ref: '#/components/schemas/NwdafSubscription' + minItems: 1 + required: + - nwdafSubscriptionList + +NwdafSubscription: + description: Individual NWDAF subscription identified by the subscription Id. + type: object + properties: + nwdafEvtSubsServiceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nwdafEventsSubscription: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription' + required: + - nwdafEvtSubsServiceUri + - nwdafEventsSubscription + +UpdpSubscriptionData: + description: UE policy delivery related N1 message notification subscription data. + type: object + properties: + updpNotifySubscriptionId: + type: string + updpNotifyCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + updpCallbackBinding: + type: string + required: + - updpNotifySubscriptionId + - updpNotifyCallbackUri + +ReleaseSessionInfo: + description: PDU session Id(s) and the cause for triggering the release. + type: object + properties: + releaseSessionList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 + releaseCause: + $ref: '#/components/schemas/ReleaseCause' + required: + - releaseSessionList + - releaseCause + +AreaOfInterestEventState: + description: Event State of AoI event in old AMF + type: object + required: + - presence + properties: + presence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState' + individualPraiIdList: + type: array + items: + type: string + minItems: 1 + +TssInformation: +``` + +``` + +description: Represents a Tss related N2 information data part +type: object +properties: + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + tssContainer: + $ref: '#/components/schemas/N2InfoContent' +required: + - tssContainer + +RslpInformation: + description: Represents Ranging/SL positioning related N2 information. + type: object + properties: + n2Pc5RslpPol: + $ref: '#/components/schemas/N2InfoContent' + +A2xContext: + description: Represents the A2X services related parameters + type: object + properties: + nrA2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NrA2xAuth' + lteA2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LteA2xAuth' + nrUeSidelinkAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + lteUeSidelinkAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + pc5QoSPara: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pc5QoSPara' + +A2xInformation: + description: A2X related N2 information + type: object + properties: + n2Pc5Pol: + $ref: '#/components/schemas/N2InfoContent' + +AmPolicyInfoContainer: + description: AM Policy Information Container + type: object + properties: + sliceUsgCtrlInfoSets: + type: object + description: A map(list of key-value pairs) where Snssai serves as key. + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceUsageControlInfo' + minProperties: 1 + +LcsUpContext: + description: Represents the LCS UP related parameters + type: object + properties: + upConnectionStatus: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/UpConnectionStatus' + servingLMFIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + +# +# SIMPLE DATA TYPES +# + +EpsBearerId: + description: EPS Bearer Identifier + type: integer + minimum: 0 + maximum: 15 +Ppi: + description: Paging Policy Indicator + type: integer + minimum: 0 + maximum: 7 +NasCount: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +5GMmCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' +UeSecurityCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' +SlUeNetworkCapability: + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + DrxParameter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + OmcIdentifier: + description: Represents the OMC Identifier + type: string + MSClassmark2: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + SupportedCodec: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +# +# ENUMERATIONS +# + + StatusChange: + description: Enumeration for AMF status + anyOf: + - type: string + enum: + - AMF_UNAVAILABLE + - AMF_AVAILABLE + - type: string + N2InformationClass: + description: Enumeration for N2 Information Class + anyOf: + - type: string + enum: + - SM + - NRPPa + - PWS + - PWS-BCAL + - PWS-RF + - RAN + - V2X + - PROSE + - TSS + - RSPP + - A2X + - type: string + N1MessageClass: + description: Enumeration for N1 Message Class + anyOf: + - type: string + enum: + - 5GMM + - SM + - LPP + - SMS + - UPDP + - LCS + - type: string + N1N2MessageTransferCause: + description: Enumeration for N1N2Message Transfer Cause + anyOf: + - type: string + enum: + - ATTEMPTING_TO_REACH_UE + - N1_N2_TRANSFER_INITIATED + - WAITING_FOR_ASYNCHRONOUS_TRANSFER + - UE_NOT_RESPONDING + - N1_MSG_NOT_TRANSFERRED + - N2_MSG_NOT_TRANSFERRED + - UE_NOT_REACHABLE_FOR_SESSION + - TEMPORARY_REJECT_REGISTRATION ONGOING + - TEMPORARY_REJECT_HANDOVER ONGOING + - REJECTION_DUE_TO_PAGING_RESTRICTION + - AN_NOT_RESPONDING + - FAILURE_CAUSE_UNSPECIFIED + - type: string + UeContextTransferStatus: + description: Describes the status of an individual ueContext resource in UE Context Transfer +procedures + anyOf: + - type: string + enum: + - TRANSFERRED + - NOT_TRANSFERRED + - type: string +``` + +N2InformationTransferResult: +description: Describes the result of N2 information transfer by AMF to the AN +anyOf: +- type: string +enum: +- N2\_INFO\_TRANSFER\_INITIATED +- type: string +CipheringAlgorithm: +description: Indicates the supported Ciphering Algorithm +anyOf: +- type: string +enum: +- NEA0 +- NEA1 +- NEA2 +- NEA3 +- type: string +IntegrityAlgorithm: +description: Indicates the supported Integrity Algorithm +anyOf: +- type: string +enum: +- NIA0 +- NIA1 +- NIA2 +- NIA3 +- type: string +SmsSupport: +description: Indicates the supported SMS delivery of a UE +anyOf: +- type: string +enum: +- 3GPP +- NON\_3GPP +- BOTH +- NONE +- type: string +ScType: +description: Indicates the security context type +anyOf: +- type: string +enum: +- NATIVE +- MAPPED +- type: string +KeyAmfType: +description: Indicates the Kamf type +anyOf: +- type: string +enum: +- KAMF +- KPRIMEAMF +- type: string +TransferReason: +description: Indicates UE Context Transfer Reason +anyOf: +- type: string +enum: +- INIT\_REG +- MOBI\_REG +- MOBI\_REG\_UE\_VALIDATED +- type: string +PolicyReqTrigger: +description: Policy Request Triggers +anyOf: +- type: string +enum: +- LOCATION\_CHANGE +- PRA\_CHANGE +- ALLOWED\_NSSAI\_CHANGE +- NWDAF\_DATA\_CHANGE +- PLMN\_CHANGE +- CON\_STATE\_CHANGE +- SMF\_SELECT\_CHANGE +- ACCESS\_TYPE\_CHANGE +- SAT\_BACKHAUL\_CHANGE +- type: string +RatSelector: + +description: Indicates the RAT type for the transfer of N2 information +anyOf: +- type: string +enum: +- E-UTRA +- NR +- type: string + +NgapIeType: +description: Indicates the supported NGAP IE types +anyOf: +- type: string +enum: +- PDU\_RES\_SETUP\_REQ +- PDU\_RES\_REL\_CMD +- PDU\_RES\_MOD\_REQ +- HANDOVER\_CMD +- HANDOVER\_REQUIRED +- HANDOVER\_PREP\_FAIL +- SRC\_TO\_TAR\_CONTAINER +- TAR\_TO\_SRC\_CONTAINER +- TAR\_TO\_SRC\_FAIL\_CONTAINER +- RAN\_STATUS\_TRANS\_CONTAINER +- SON\_CONFIG\_TRANSFER +- NRPFA\_PDU +- UE\_RADIO\_CAPABILITY +- RIM\_INFO\_TRANSFER +- SECONDARY\_RAT\_USAGE +- PC5\_QOS\_PARA +- EARLY\_STATUS\_TRANS\_CONTAINER +- UE\_RADIO\_CAPABILITY\_FOR\_PAGING +- type: string + +N2InfoNotifyReason: +description: N2 Information Notify Reason +anyOf: +- type: string +enum: +- HANDOVER\_COMPLETED +- type: string + +SmfChangeIndication: +description: Indicates the I-SMF or V-SMF change or removal +anyOf: +- type: string +enum: +- CHANGED +- REMOVED +- type: string + +SbiBindingLevel: +description: SBI Binding Level +anyOf: +- type: string +enum: +- NF\_INSTANCE\_BINDING +- NF\_SET\_BINDING +- NF\_SERVICE\_SET\_BINDING +- NF\_SERVICE\_INSTANCE\_BINDING +- type: string + +EpsNasCipheringAlgorithm: +description: Indicates the supported EPS NAS Ciphering Algorithm +anyOf: +- type: string +enum: +- EEA0 +- EEA1 +- EEA2 +- EEA3 +- type: string + +EpsNasIntegrityAlgorithm: +description: Indicates the supported EPS NAS Integrity Algorithm +anyOf: +- type: string +enum: +- EIA0 +- EIA1 +- EIA2 +- EIA3 +- type: string + +``` +PeriodicCommunicationIndicator: + description: Indicates the Periodic Communication Indicator + anyOf: + - type: string + enum: + - PERIODICALLY + - ON_DEMAND + - type: string + +UuamMmStatus: + description: Indicates the UUAM-MM status + anyOf: + - type: string + enum: + - SUCCESS + - PENDING + - FAILED + - type: string + +ReleaseCause: + description: The cause for triggering the release. + anyOf: + - type: string + enum: + - SNPN_SNPN_MOBILITY + - NO_HR_AGREEMENT + - UNSPECIFIED + - type: string +``` + +--- + +## A.3 Namf\_EventExposure API + +openapi: 3.0.0 + +``` +info: + version: 1.3.0-alpha.4 + title: Namf_EventExposure + description: | + AMF Event Exposure Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +security: +- {} +- oAuth2ClientCredentials: + - namf-evts + +externalDocs: + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' + +servers: +- url: '{apiRoot}/namf-evts/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +paths: + /subscriptions: + post: + summary: Namf_EventExposure Subscribe service Operation + tags: + - Subscriptions collection (Collection) + operationId: CreateSubscription + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AmfCreateEventSubscription' + required: true + responses: + '201': + description: Subscription Created + headers: +``` + +``` + + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/namf-evts/{apiVersion}/subscriptions/{subscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AmfCreatedEventSubscription' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +callbacks: + onEventReport: + '{ $request.body#/subscription/eventNotifyUri }': + post: + summary: Event Notification Delivery + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AmfEventNotification' + required: true + responses: + '204': + description: Successful acknowledgement + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +``` + +``` + + default: + description: Unexpected error +onSubscriptionIdChangeEvtReport: + '{ $request.body#/subscription/subsChangeNotifyUri }': + post: + summary: Event Notification Delivery For Subscription Id Change + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AmfEventNotification' + required: true + responses: + '204': + description: Successful acknowledgement + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/subscriptions/{subscriptionId}: + patch: + summary: Namf_EventExposure Subscribe Modify service Operation + tags: + - Individual subscription (Document) + operationId: ModifySubscription + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be modified + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + oneOf: + - type: array + items: + $ref: '#/components/schemas/AmfUpdateEventSubscriptionItem' + minItems: 1 + - type: array + items: + $ref: '#/components/schemas/AmfUpdateEventOptionItem' + minItems: 1 + maxItems: 1 + required: true + responses: + '200': + description: Subscription modified successfully + content: + application/json: + schema: + $ref: '#/components/schemas/AmfUpdatedEventSubscription' + +``` + +``` +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +delete: + summary: Namf_EventExposure Unsubscribe service Operation + tags: + - Individual subscription (Document) + operationId: DeleteSubscription + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be deleted + schema: + type: string + responses: + '204': + description: Subscription deleted successfully + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' +``` + +``` +scopes: + namf-evts: Access to the Namf_EventExposure API +schemas: + AmfEventSubscription: + description: Represents an individual event subscription resource on AMF + type: object + properties: + eventList: + type: array + items: + $ref: '#/components/schemas/AmfEvent' + minItems: 1 + eventNotifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifyCorrelationId: + type: string + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + subsChangeNotifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + subsChangeNotifyCorrelationId: + type: string + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + excludeSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + excludeGpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + includeSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + includeGpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + anyUE: + type: boolean + options: + $ref: '#/components/schemas/AmfEventMode' + sourceNFType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + termNotifyInd: + type: boolean + required: + - eventList + - eventNotifyUri + - notifyCorrelationId + - nfId + + AmfEvent: + description: Describes an event to be subscribed + type: object + properties: + type: + $ref: '#/components/schemas/AmfEventType' + immediateFlag: + type: boolean + default: false + areaList: + type: array + items: + $ref: '#/components/schemas/AmfEventArea' + minItems: 1 +``` + +``` +locationFilterList: + type: array + items: + $ref: '#/components/schemas/LocationFilter' + minItems: 1 + refId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' +trafficDescriptorList: + type: array + items: + $ref: '#/components/schemas/TrafficDescriptor' + minItems: 1 +reportUeReachable: + type: boolean + default: false +reachabilityFilter: + $ref: '#/components/schemas/ReachabilityFilter' +udmDetectInd: + type: boolean + default: false +maxReports: + type: integer +presenceInfoList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: A map(list of key-value pairs) where prId serves as key. +maxResponseTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +targetArea: + $ref: '#/components/schemas/TargetArea' +snssaiFilter: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +ueInAreaFilter: + $ref: '#/components/schemas/UeInAreaFilter' +minInterval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +nextReport: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +idleStatusInd: + type: boolean + default: false +dispersionArea: + $ref: '#/components/schemas/DispersionArea' +nextPeriodicReportTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +adjustAoIonRa: + type: boolean + default: false +ranTimingSynchroStatusChange: + type: boolean + default: false +notifyForSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 +notifyForSnssaiDnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI_DNNItem' + minItems: 1 +required: +- type +AmfEventNotification: + description: Data within a AMF Event Notification request + type: object + properties: + notifyCorrelationId: + type: string + subsChangeNotifyCorrelationId: + type: string + reportList: + type: array +``` + +``` + items: + $ref: '#/components/schemas/AmfEventReport' + minItems: 1 + eventSubsSyncInfo: + $ref: '#/components/schemas/AmfEventSubsSyncInfo' +AmfEventReport: + description: Represents a report triggered by a subscribed event type + type: object + properties: + type: + $ref: '#/components/schemas/AmfEventType' + state: + $ref: '#/components/schemas/AmfEventState' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + subscriptionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + anyUe: + type: boolean + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + areaList: + type: array + items: + $ref: '#/components/schemas/AmfEventArea' + minItems: 1 + refId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + location: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + additionalLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + timezone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + accessTypeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + rmInfoList: + type: array + items: + $ref: '#/components/schemas/RmInfo' + minItems: 1 + cmInfoList: + type: array + items: + $ref: '#/components/schemas/CmInfo' + minItems: 1 + reachability: + $ref: '#/components/schemas/UeReachability' + commFailure: + $ref: '#/components/schemas/CommunicationFailure' + lossOfConnectReason: + $ref: '#/components/schemas/LossOfConnectivityReason' + numberOfUes: + type: integer + 5gsUserStateList: + type: array + items: + $ref: '#/components/schemas/5GsUserStateInfo' + minItems: 1 + typeCode: + type: string + pattern: '^imeitac-[0-9]{8}$' + registrationNumber: + type: integer + maxAvailabilityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ueIdExt: + type: array + items: + $ref: '#/components/schemas/UEIdExt' + minItems: 1 +``` + +``` +snssaiTaiList: + type: array + items: + $ref: '#/components/schemas/SNSSaiTaiMapping' + minItems: 1 +idleStatusIndication: + $ref: '#/components/schemas/IdleStatusIndication' +ueAccessBehaviorTrends: + type: array + items: + $ref: '#/components/schemas/UeAccessBehaviorReportItem' + minItems: 1 +ueLocationTrends: + type: array + items: + $ref: '#/components/schemas/UeLocationTrendsReportItem' + minItems: 1 +mmTransLocationReportList: + type: array + items: + $ref: '#/components/schemas/MmTransactionLocationReportItem' + minItems: 1 +mmTransSliceReportList: + type: array + items: + $ref: '#/components/schemas/MmTransactionSliceReportItem' + minItems: 1 +termReason: + $ref: '#/components/schemas/SubTerminationReason' +unavailabilityPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +required: +- type +- state +- timeStamp +AmfEventMode: + description: Describes how the reports shall be generated by a subscribed event + type: object + properties: + trigger: + $ref: '#/components/schemas/AmfEventTrigger' + maxReports: + type: integer + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + sampRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + partitioningCriteria: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartitioningCriteria' + minItems: 1 + notifFlag: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationFlag' + mutingExcInstructions: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingExceptionInstructions' + mutingNotSettings: + readOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingNotificationsSettings' + varRepPeriodInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarRepPeriod' + minItems: 1 + required: + - trigger +AmfEventState: + description: Represents the state of a subscribed event + type: object + properties: + active: + type: boolean + remainReports: +``` + +``` + type: integer + remainDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + required: + - active +RmInfo: + description: Represents the registration state of a UE for an access type + type: object + properties: + rmState: + $ref: '#/components/schemas/RmState' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + required: + - rmState + - accessType +CmInfo: + description: Represents the connection management state of a UE for an access type + type: object + properties: + cmState: + $ref: '#/components/schemas/CmState' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + required: + - cmState + - accessType +CommunicationFailure: + description: Describes a communication failure detected by AMF + type: object + properties: + nasReleaseCode: + type: string + ranReleaseCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' +AmfCreateEventSubscription: + description: Data within a create AMF event subscription request + type: object + properties: + subscription: + $ref: '#/components/schemas/AmfEventSubscription' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + required: + - subscription +AmfCreatedEventSubscription: + description: Data within a create AMF event subscription response + type: object + properties: + subscription: + $ref: '#/components/schemas/AmfEventSubscription' + subscriptionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reportList: + type: array + items: + $ref: '#/components/schemas/AmfEventReport' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - subscription + - subscriptionId +AmfUpdateEventSubscriptionItem: + description: Document describing the modification(s) to an AMF Event Subscription + type: object + properties: + op: + type: string + enum: + - add + - remove + - replace + path: + type: string +``` + +``` + + pattern: + '^(/eventList|/|(\|/eventList\|/0\|/eventList\|/[1-9][0-9]*){1}(\|/presenceInfoList\|/0\|/ +presenceInfoList\|/[1-9][0-9]* \|/notifyForSupiList\|/notifyForSnssaiDnnList)?\|/|/excludeSupiList\|/|/ +excludeGpsiList\|/|/includeSupiList\|/|/includeGpsiList$' + value: + $ref: '#/components/schemas/AmfEvent' + presenceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + excludeSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + excludeGpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + includeSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + includeGpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + notifyForSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + notifyForSnssaiDnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 + required: + - op + - path + AmfUpdateEventOptionItem: + description: Document describing the modifications to AMF event subscription options + type: object + properties: + op: + type: string + enum: + - replace + path: + type: string + pattern: '^(/options\|/expiry\|/options\|/notifFlag\|/options\|/mutingExcInstructions)$' + value: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + notifFlag: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationFlag' + mutingExcInstructions: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingExceptionInstructions' + required: + - op + - path + - value + AmfUpdatedEventSubscription: + description: Represents a successful update on an AMF Event Subscription + type: object + properties: + subscription: + $ref: '#/components/schemas/AmfEventSubscription' + reportList: + type: array + items: + $ref: '#/components/schemas/AmfEventReport' + minItems: 1 + required: + - subscription + AmfEventArea: + description: Represents an area to be monitored by an AMF event + type: object + +``` + +``` +properties: + presenceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + ladnInfo: + $ref: '#/components/schemas/LadnInfo' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + nsiId: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' +LadnInfo: + description: LADN Information + type: object + properties: + ladn: + type: string + presence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState' + required: + - ladn +5GsUserStateInfo: + description: Represents the 5GS User state of the UE for an access type + type: object + properties: + 5gsUserState: + $ref: '#/components/schemas/5GsUserState' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + required: + - 5gsUserState + - accessType +TrafficDescriptor: + description: Represents the Traffic Descriptor + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + dddTrafficDescriptorList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' + minItems: 1 +UEIdExt: + description: UE Identity + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' +AmfEventSubsSyncInfo: + description: AMF Event Subscriptions Information for synchronization + type: object + properties: + subscriptionList: + type: array + items: + $ref: '#/components/schemas/AmfEventSubscriptionInfo' + minItems: 1 + required: + - subscriptionList +AmfEventSubscriptionInfo: + description: Individual AMF Event Subscription Information + type: object + properties: + subId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifyCorrelationId: + type: string + refIdList: + type: array + items: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + minItems: 1 + oldSubId: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +required: +- subId +- refIdList + +TargetArea: +description: TA list or TAI range list or any TA +type: object +properties: + taList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TaiRange' + minItems: 1 + anyTa: + type: boolean + default: false + +SnssaiTaiMapping: +description: List of restricted or unrestricted S-NSSAIs per TAI(s) +type: object +properties: + reportingArea: + $ref: '#/components/schemas/TargetArea' + accessTypeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + supportedSnssaiList: + type: array + items: + $ref: '#/components/schemas/SupportedSnssai' + minItems: 1 +required: +- reportingArea + +UeAccessBehaviorReportItem: +description: Report Item for UE Access Behavior Trends event. +type: object +properties: + stateTransitionType: + $ref: '#/components/schemas/AccessStateTransitionType' + spacing: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + duration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +required: +- stateTransitionType +- spacing +- duration + +IdleStatusIndication: +description: Represents the idle status indication. +type: object +properties: + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + activeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + subsRegTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + edrxCycleLength: + type: integer + suggestedNumOfDLPackets: + type: integer + +UeInAreaFilter: +description: Additional filters for UE in Area Report event +type: object +properties: + ueType: + $ref: '#/components/schemas/UeType' +``` + +``` +aerialSrvDnnInd: + type: boolean + default: false +ueIdOmitInd: + type: boolean + default: false + +SupportedSnssai: + description: Supported S-NSSAIs + type: object + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + restrictionInd: + type: boolean + default: false + required: + - sNssai + +UeLocationTrendsReportItem: + description: Report Item for UE Location Trends event. + type: object + properties: + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + n3gaLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/N3gaLocation' + spacing: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + duration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + timestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - spacing + - duration + - timestamp + +DispersionArea: + description: Dispersion Area + type: object + properties: + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + ncgiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + minItems: 1 + ecgiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + minItems: 1 + n3gaInd: + type: boolean + default: false + +MmTransactionLocationReportItem: + description: UE MM Transaction Report Item per Location + type: object + properties: + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + n3gaLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/N3gaLocation' + timestamp: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +transactions: + type: integer +required: +- timestamp +- transactions + +MmTransactionSliceReportItem: +description: UE MM Transaction Report Item per Slice +type: object +properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + timestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + transactions: + type: integer +required: +- timestamp +- transactions + +AmfEventType: +description: Describes the supported event types of Namf_EventExposure Service +anyOf: +- type: string + enum: + - LOCATION_REPORT + - PRESENCE_IN_AOI_REPORT + - TIMEZONE_REPORT + - ACCESS_TYPE_REPORT + - REGISTRATION_STATE_REPORT + - CONNECTIVITY_STATE_REPORT + - REACHABILITY_REPORT + - COMMUNICATION_FAILURE_REPORT + - UES_IN_AREA_REPORT + - SUBSCRIPTION_ID_CHANGE + - SUBSCRIPTION_ID_ADDITION + - SUBSCRIPTION_TERMINATION + - LOSS_OF_CONNECTIVITY + - 5GS_USER_STATE_REPORT + - AVAILABILITY_AFTER_DDN_FAILURE + - TYPE ALLOCATION CODE REPORT + - FREQUENT MOBILITY REGISTRATION_REPORT + - SNSSAI TA MAPPING REPORT + - UE_LOCATION_TRENDS + - UE_ACCESS_BEHAVIOR_TRENDS + - UE_MM_TRANSACTION_REPORT +- type: string + +AmfEventTrigger: +description: Describes how AMF should generate the report for the event +anyOf: +- type: string + enum: + - ONE_TIME + - CONTINUOUS + - PERIODIC +- type: string + +LocationFilter : +description: Describes the supported filters of LOCATION_REPORT event type +anyOf: +- type: string + enum: + - TAI + - CELL_ID + - RAN_NODE + - N3IWF + - UE_IP + - UDP_PORT + - TNAP_ID + - GLI + - TWAP_ID +- type: string + +UeReachability: +description: Describes the reachability of the UE +anyOf: +- type: string + enum: + - UNREACHABLE +``` + +- REACHABLE +- REGULATORY\_ONLY +- type: string + +RmState: +description: Describes the registration management state of a UE +anyOf: +- type: string +enum: +- REGISTERED +- DEREGISTERED +- type: string + +CmState: +description: Describes the connection management state of a UE +anyOf: +- type: string +enum: +- IDLE +- CONNECTED +- type: string + +5GsUserState: +description: Describes the 5GS User State of a UE +anyOf: +- type: string +enum: +- DEREGISTERED +- CONNECTED\_NOT\_REACHABLE\_FOR\_PAGING +- CONNECTED\_REACHABLE\_FOR\_PAGING +- NOT\_PROVIDED\_FROM\_AMF +- type: string + +LossOfConnectivityReason: +description: Describes the reason for loss of connectivity +anyOf: +- type: string +enum: +- DEREGISTERED +- MAX\_DETECTION\_TIME\_EXPIRED +- PURGED +- UNAVAILABLE\_PERIOD +- type: string + +ReachabilityFilter: +description: Event filter for REACHABILITY\_REPORT event type +anyOf: +- type: string +enum: +- UE\_REACHABILITY\_STATUS\_CHANGE +- UE\_REACHABLE\_DL\_TRAFFIC +- type: string + +UeType: +description: Describes the type of UEs +anyOf: +- type: string +enum: +- AERIAL\_UE +- type: string + +AccessStateTransitionType: +description: Access State Transition Type. +anyOf: +- type: string +enum: +- ACCESS\_TYPE\_CHANGE\_3GPP +- ACCESS\_TYPE\_CHANGE\_N3GPP +- RM\_STATE\_CHANGE\_DEREGISTERED +- RM\_STATE\_CHANGE\_REGISTERED +- CM\_STATE\_CHANGE\_IDLE +- CM\_STATE\_CHANGE\_CONNECTED +- HANDOVER +- MOBILITY\_REGISTRATION\_UPDATE +- type: string + +SubTerminationReason: +description: Subscription Termination Reason. +anyOf: +- type: string +enum: +- INVALID\_SUBSCRIPTION + +- SUBSCRIPTION\_NOT\_AUTHORIZED +- type: string + +## A.4 Namf\_MT + +``` + +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.4 + title: Namf_MT + description: | + AMF Mobile Terminated Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +security: + - {} + - oAuth2ClientCredentials: + - namf-mt + +externalDocs: + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' + +servers: + - url: '{apiRoot}/namf-mt/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +paths: + '/ue-contexts/{ueContextId}': + get: + summary: Namf_MT Provide Domain Selection Info service Operation + tags: + - ueContext (Document) + operationId: Provide Domain Selection Info + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|.+)$' + - name: info-class + in: query + description: UE Context Information Class + schema: + $ref: '#/components/schemas/UeContextInfoClass' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: old-guami + in: query + description: Old GUAMI + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + + responses: + '200': + description: Requested UE Context Information returned + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextInfo' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + +``` + +``` + +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +/ue-contexts/{ueContextId}/ue-reachind: + put: + summary: Namf_MT EnableUeReachability service Operation + tags: + - ueReachInd (Document) + operationId: EnableUeReachability + security: + - {} + - oAuth2ClientCredentials: + - namf-mt + - oAuth2ClientCredentials: + - namf-mt + - namf-mt:ue-reachind + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableUeReachabilityReqData' + required: true + responses: + '200': + description: UE has become reachable as desired + content: + application/json: + schema: + $ref: '#/components/schemas/EnableUeReachabilityRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsEnableUeReachability' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + description: Gateway Timeout + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsEnableUeReachability' + default: + description: Unexpected error + +/ue-contexts/enable-group-reachability: + post: + summary: Namf_MT EnableGroupReachability service Operation + tags: + - ueContexts (collection) + operationId: EnableGroupReachability + security: + - {} + - oAuth2ClientCredentials: + - namf-mt + - oAuth2ClientCredentials: + - namf-mt + - namf-mt:enable-group-reachability + requestBody: + description: list of UEs requested to be made reachable for the related TMGI + content: + application/json: + schema: + $ref: '#/components/schemas/EnableGroupReachabilityReqData' + required: true + responses: + '200': + description: Successful response. + content: + application/json: + schema: + $ref: '#/components/schemas/EnableGroupReachabilityRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + description: Unexpected error + callbacks: + reachabilityNotification: + '{request.body#/reachabilityNotifyUri}': + post: + requestBody: + +``` + +``` + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ReachabilityNotificationData' + responses: + '204': + description: UE reachability notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + namf-mt: Access to the Namf_MT API + namf-mt:ue-reachind: > + Access to the EnableUeReachability service operation + namf-mt:enable-group-reachability: > + Access to the EnableGroupReachability service operation + +schemas: + EnableUeReachabilityReqData: + description: Data within the Enable UE Reachability Request + type: object + properties: + reachability: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + extBufSupport: + type: boolean + default: false + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + ppi: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/Ppi' + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + required: + - reachability + EnableUeReachabilityRspData: +``` + +``` +description: Data within the Enable UE Reachability Response +type: object +properties: + reachability: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - reachability +UeContextInfo: + description: UE Context Information + type: object + properties: + supportVoPS: + type: boolean + supportVoPSn3gpp: + type: boolean + lastActTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +ProblemDetailsEnableUeReachability: + description: Enable UE Reachability Error Detail + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionInfoEnableUeReachability' +AdditionInfoEnableUeReachability: + description: Additional information to be returned in EnableUeReachability error response + type: object + properties: + maxWaitingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +EnableGroupReachabilityReqData: + description: Data within the Enable Group Reachability Request + type: object + properties: + ueInfoList: + type: array + items: + $ref: '#/components/schemas/UeInfo' + minItems: 1 + tmgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tmgi' + reachabilityNotifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + mbsServiceAreaInfoList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceAreaInfo' + minItems: 1 + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ueInfoList + - tmgi +EnableGroupReachabilityRspData: + description: Data within the Enable Group Reachability Response + type: object + properties: + ueConnectedList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +UeInfo: + description: list of UEs requested to be made reachable for the MBS Session + type: object +``` + +``` + +properties: + ueList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' +required: + - ueList + +ReachabilityNotificationData: + description: Data within the UE Reachability Info Notify + type: object + properties: + reachableUeList: + type: array + items: + $ref: '#/components/schemas/ReachableUeInfo' + minItems: 1 + unreachableUeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + ReachableUeInfo: + description: Contains the reachable UE Information + type: object + properties: + ueList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + userLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + required: + - ueList + +UeContextInfoClass: + description: Indicates the UE Context information class + anyOf: + - type: string + enum: + - TADS + - type: string + +``` + +## A.5 Namf\_Location + +openapi: 3.0.0 + +``` + +info: + version: 1.3.0-alpha.5 + title: Namf_Location + description: | + AMF Location Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +security: + - {} + - oAuth2ClientCredentials: + - namf-loc + +externalDocs: + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' + +servers: + - url: '{apiRoot}/namf-loc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +paths: + +``` + +``` + +{/ueContextId}/provide-pos-info: + post: + summary: Namf_Location ProvidePositioningInfo service Operation + tags: + - Individual UE context (Document) + operationId: ProvidePositioningInfo + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+))$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RequestPosInfo' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ProvidePosInfoExt' + '204': + description: Successful accept of location request with no information returned. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + description: Conflict + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsProvidePosInfo' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + description: Unexpected error + callbacks: + onUELocationNotification: + "{$request.body#/locationNotificationUri}": + post: + requestBody: + description: UE Location Event Notification + content: + application/json: + schema: + $ref: '#/components/schemas/NotifiedPosInfoExt' + responses: + '204': + description: Expected response to a successful callback processing + +``` + +``` + + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +/{ueContextId}/provide-loc-info: + post: + summary: Namf_Location ProvideLocationInfo service Operation + tags: + - Individual UE context (Document) + operationId: ProvideLocationInfo + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+))$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RequestLocInfo' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ProvideLocInfo' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueContextId}/cancel-pos-info: + post: + summary: Namf_Location CancelLocation service operation + tags: + - Individual UE context (Document) + operationId: CancelLocation + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^((imsi-[0-9]{5,15}|nai-.+|glici-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+))$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelPosInfo' + required: true + responses: + '204': + description: Expected response to a successful cancellation + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + namf-loc: Access to the Namf_Location API + schemas: + RequestPosInfo: + description: Data within Provide Positioning Information Request + type: object + properties: + lcsClientType: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType' + lcsLocation: + $ref: '#/components/schemas/LocationType' + supi: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + requestedRangingSlResult: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangingSlResult' + minItems: 1 + relatedUEs: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RelatedUE' + minItems: 1 + lmfId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + priority: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsPriority' + lcsQoS: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS' + velocityRequested: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityRequested' + lcsSupportedGADShapes: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/SupportedGADShapes' + additionalLcsSuppGADShapes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/SupportedGADShapes' + minItems: 1 + locationNotificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + lcsServiceType: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsServiceType' + ldrType: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrType' + hgmlcCallbackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + lirGmlcCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference' + lirReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LirReference' + periodicEventInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PeriodicEventInfo' + areaEventInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AreaEventInfo' + motionEventInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MotionEventInfo' + externalClientIdentification: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/ExternalClientIdentification' + afID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + codeWord: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/CodeWord' + uePrivacyRequirements: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UePrivacyRequirements' + scheduledLocTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reliableLocReq: + type: boolean + default: false + intermediateLocationInd: + type: boolean + default: false + maxRespTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + ueUnawareInd: + type: boolean + enum: + - true + lpHapType: + $ref: '#/components/schemas/LpHapType' + +``` + +``` + evtRptAllowedAreas: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ReportingArea' + minItems: 1 + maxItems: 250 + reportingInd: + allOf: + - $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/ReportingInd' + default: INSIDE_REPORTING + integrityRequirements: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/IntegrityRequirements' + upLocRepInfoAf: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UpLocRepInfoAf' + mappedQoSEps: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MappedLocationQoSEps' + required: + - lcsClientType + - lcsLocation + +ProvidePosInfoExt: + description: Extended provided positioning information for UEs + allOf: + - $ref: '#/components/schemas/ProvidePosInfo' + - $ref: '#/components/schemas/AddProvidePosInfos' + +ProvidePosInfo: + description: Data within Provide Positioning Information Response + type: object + properties: + locationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + localLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocalArea' + accuracyFulfilmentIndicator: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AccuracyFulfilmentIndicator' + ageOfLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + velocityEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + positioningDataList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethodAndUsage' + minItems: 0 + maxItems: 9 + gnssPositioningDataList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GnssPositioningMethodAndUsage' + minItems: 0 + maxItems: 9 + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + targetServingNode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + targetMmeName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + targetMmeRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + utranSrvcInd: + type: boolean + civicAddress: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + barometricPressure: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/BarometricPressure' + altitude: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Altitude' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + servingLMFIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + locationPrivacyVerResult: +``` + +``` + + $ref: '#/components/schemas/LocationPrivacyVerResult' + achievedQos: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MinorLocationQoS' + directReportInd: + type: boolean + default: false + acceptedPeriodicEventInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PeriodicEventInfo' + haGnssMetrics: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/HighAccuracyGnssMetrics' + indoorOutdoorInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/IndoorOutdoorInd' + losNlosMeasureInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LosNlosMeasureInd' + relatedApplicationlayerId: + type: string + rangeDirection: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + +NotifiedPosInfoExt: + description: Extended notified positioning information for UEs + allOf: + - $ref: '#/components/schemas/NotifiedPosInfo' + - $ref: '#/components/schemas/AddNotifiedPosInfos' + +NotifiedPosInfo: + description: Data within EventNotify notification + type: object + properties: + locationEvent: + $ref: '#/components/schemas/LocationEvent' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + locationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + localLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocalArea' + ageOfLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + velocityEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + positioningDataList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethodAndUsage' + minItems: 0 + maxItems: 9 + gnssPositioningDataList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GnssPositioningMethodAndUsage' + minItems: 0 + maxItems: 9 + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + servingNode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + targetMmeName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + targetMmeRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + utranSrvccInd: + type: boolean + +``` + +``` + +civicAddress: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' +barometricPressure: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/BarometricPressure' +altitude: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Altitude' +hmlcCallbackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +ldrReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference' +servingLMFIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' +terminationCause: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/TerminationCause' +achievedQos: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MinorLocationQoS' +mscServerId: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/E164Number' +haGnssMetrics: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/HighAccuracyGnssMetrics' +indoorOutdoorInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/IndoorOutdoorInd' +losNlosMeasureInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LosNlosMeasureInd' +relatedApplicationlayerId: + type: string +rangeDirection: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangeDirection' +2dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/2DRelativeLocation' +3dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/3DRelativeLocation' +relativeVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' +required: +- locationEvent + +RequestLocInfo: + description: Data within Provide Location Information Request + type: object + properties: + req5gsLoc: + type: boolean + default: false + reqCurrentLoc: + type: boolean + default: false + reqRatType: + type: boolean + default: false + reqTimeZone: + type: boolean + default: false + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +ProvideLocInfo: + description: Data within Provide Location Information Response + type: object + properties: + currentLoc: + type: boolean + location: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + additionalLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + geoInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + locationAge: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + timezone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + +CancelPosInfo: + description: Data within a Cancel Location Request + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference' + servingLMFIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supi + - hgmlcCallBackURI + - ldrReference + +ProblemDetailsProvidePosInfo: + description: Handover from 5GS to EPS Error Details. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ProvidePosInfo' + +AddNotifiedPosInfos: + type: object + properties: + addProvidePosInfos: + type: array + items: + $ref: '#/components/schemas/NotifiedPosInfo' + minItems: 1 + +AddProvidePosInfos: + type: object + properties: + addProvidePosInfos: + type: array + items: + $ref: '#/components/schemas/ProvidePosInfo' + minItems: 1 + +LocationType: + description: Type of location measurement requested + anyOf: + - type: string + enum: + - CURRENT_LOCATION + - CURRENT_OR_LAST_KNOWN_LOCATION + - NOTIFICATION_VERIFICATION_ONLY + - DEFERRED_LOCATION + - type: string + +LocationEvent: + description: Type of events initiating location procedures + anyOf: + - type: string + enum: + - EMERGENCY_CALL_ORIGINATION + - EMERGENCY_CALL_RELEASE + - EMERGENCY_CALL_HANDOVER + - ACTIVATION_OF_DEFERRED_LOCATION + - UE_MOBILITY_FOR_DEFERRED_LOCATION + - CANCELLATION_OF_DEFERRED_LOCATION + - type: string + +LocationPrivacyVerResult: + description: The result of location privacy verification by UE + anyOf: + - type: string + enum: + - LOCATION_ALLOWED + - LOCATION_NOT_ALLOWED + - RESPONSE_TIME_OUT +``` + +``` + +- type: string + +LpHapType: + description: Type of Low Power and/or High Accuracy Positioning + anyOf: + - type: string + enum: + - LOW_POW_HIGH_ACCU_POS + - type: string + +``` + +## A.6 Namf\_MBSBroadcast API + +openapi: 3.0.0 + +``` + +info: + version: 1.1.0-alpha.3 + title: Namf_MBSBroadcast + description: | + AMF MBSBroadcast Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' + +servers: +- url: '{apiRoot}/namf-mbs-bc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: +- {} +- oAuth2ClientCredentials: + - namf-mbs-bc + +paths: +/mbs-contexts: + post: + summary: Namf_MBSBroadcast ContextCreate service Operation + tags: + - Broadcast MBS session contexts collection (Collection) + operationId: ContextCreate + requestBody: + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/ContextCreateReqData' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + required: true + callbacks: + contextStatusNotification: + '{ $request.body#/notifyUri }': + post: + requestBody: # notification request without binary body part + required: true + content: + application/json: + schema: + +``` + +``` +$ref: '#/components/schemas/ContextStatusNotification' +multipart/related: # notification request with binary body part(s) +schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/ContextStatusNotification' + binaryDataN2Information1: + type: string + format: binary + binaryDataN2Information2: + type: string + format: binary + binaryDataN2Information3: + type: string + format: binary + binaryDataN2Information4: + type: string + format: binary + binaryDataN2Information5: + type: string + format: binary + binaryDataN2Information6: + type: string + format: binary + binaryDataN2Information7: + type: string + format: binary + binaryDataN2Information8: + type: string + format: binary + binaryDataN2Information9: + type: string + format: binary + binaryDataN2Information10: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information7: + contentType: application/vnd.3gpp.ngap +``` + +``` +headers: + Content-Id: + schema: + type: string +binaryDataN2Information8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2Information9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +binaryDataN2Information10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +responses: + '200': + description: successful notification response with content + content: + multipart/related: # notification response with binary body part(s) + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/ContextStatusNotificationResponse' + binaryDataN2Information1: + type: string + format: binary + binaryDataN2Information2: + type: string + format: binary + binaryDataN2Information3: + type: string + format: binary + binaryDataN2Information4: + type: string + format: binary + binaryDataN2Information5: + type: string + format: binary + binaryDataN2Information6: + type: string + format: binary + binaryDataN2Information7: + type: string + format: binary + binaryDataN2Information8: + type: string + format: binary + binaryDataN2Information9: + type: string + format: binary + binaryDataN2Information10: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information3: +``` + +``` + + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'204': + description: successful notification +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +responses: + '201': + description: MBS Broadcast context created successfully + +``` + +``` + +headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/namf-mbs-bc/{apiVersion}/mbs-contexts/{mbsContextRef}' + required: true + schema: + type: string +content: + application/json: # message without binary body part(s) + schema: + $ref: '#/components/schemas/ContextCreateRspData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Response parts + jsonData: + $ref: '#/components/schemas/ContextCreateRspData' + binaryDataN2Information1: + type: string + format: binary + binaryDataN2Information2: + type: string + format: binary + binaryDataN2Information3: + type: string + format: binary + binaryDataN2Information4: + type: string + format: binary + binaryDataN2Information5: + type: string + format: binary + binaryDataN2Information6: + type: string + format: binary + binaryDataN2Information7: + type: string + format: binary + binaryDataN2Information8: + type: string + format: binary + binaryDataN2Information9: + type: string + format: binary + binaryDataN2Information10: + type: string + format: binary +encoding: + jsonData: + contentType: application/json + binaryDataN2Information1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + +``` + +``` + + schema: + type: string + binaryDataN2Information6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-contexts/{mbsContextRef}: + delete: + summary: Namf_MBSBroadcast ContextDelete service Operation + tags: + - Individual broadcast MBS session context (Document) + operationId: ContextDelete + parameters: + - name: mbsContextRef + in: path + required: true + description: Unique ID of the broadcast MSB session context to be deleted + schema: + type: string + responses: + '204': + description: successful deletion + '307': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-contexts/{mbsContextRef}/update: + post: + summary: Namf_MBSBroadcast ContextUpdate service Operation + tags: + - Individual broadcast MBS session context (Document) + operationId: ContextUpdate + parameters: + - name: mbsContextRef + in: path + description: Unique ID of the broadcast MSB session context to be updated + required: true + schema: + type: string + requestBody: + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/ContextUpdateReqData' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + description: MBS Broadcast context updated successfully + content: + application/json: # message without binary body part(s) + schema: + $ref: '#/components/schemas/ContextUpdateRspData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Response parts + jsonData: + $ref: '#/components/schemas/ContextUpdateRspData' + binaryDataN2Information1: + type: string + format: binary + binaryDataN2Information2: + type: string + format: binary + binaryDataN2Information3: + type: string + format: binary + +``` + +``` + binaryDataN2Information4: + type: string + format: binary + binaryDataN2Information5: + type: string + format: binary + binaryDataN2Information6: + type: string + format: binary + binaryDataN2Information7: + type: string + format: binary + binaryDataN2Information8: + type: string + format: binary + binaryDataN2Information9: + type: string + format: binary + binaryDataN2Information10: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +``` + +``` + + binaryDataN2Information10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'204': + description: MBS Broadcast context updated successfully. No Content. +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + namf-mbs-bc: Access to the Namf_MBSBroadcast API + +schemas: + +# +# STRUCTURED DATA TYPES +# + +ContextCreateReqData: + description: Data within ContextCreate Request + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + mbsServiceAreaInfoList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceAreaInfo' + minItems: 1 + mbsServiceArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceArea' + n2MbsSmInfo: + $ref: '#/components/schemas/N2MbsSmInfo' + notifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + maxResponseTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + mbsmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + mbsmfServiceInstId: + type: string + associatedSessionId: + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/AssociatedSessionId' + required: + - mbsSessionId + - n2MbsSmInfo + - notifyUri + - snssai + oneOf: + - required: [ mbsServiceArea ] + - required: [ mbsServiceAreaInfoList ] + +ContextCreateRspData: + description: Data within ContextCreate Response + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + n2MbsSmInfoList: + type: array + items: + $ref: '#/components/schemas/N2MbsSmInfo' + minItems: 1 + maxItems: 10 + operationStatus: + $ref: '#/components/schemas/OperationStatus' + required: + - mbsSessionId + +ContextUpdateReqData: + description: Data within ContextUpdate Request + type: object + properties: + mbsServiceArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceArea' + mbsServiceAreaInfoList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceAreaInfo' + minItems: 1 + n2MbsSmInfo: + $ref: '#/components/schemas/N2MbsSmInfo' + ranIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + noNgapSignallingInd: + type: boolean + enum: + - true + notifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + maxResponseTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + n2MbsInfoChangeInd: + type: boolean + not: + required: [ mbsServiceArea, mbsServiceAreaInfoList ] + +ContextStatusNotification: + description: Data within ContextStatusNotify Request + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + areaSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionId' + n2MbsSmInfoList: + type: array + items: + $ref: '#/components/schemas/N2MbsSmInfo' + minItems: 1 + maxItems: 10 + operationEvents: + type: array + items: + $ref: '#/components/schemas/OperationEvent' + minItems: 1 +``` + +``` + operationStatus: + $ref: '#/components/schemas/OperationStatus' + releasedInd: + type: boolean + enum: + - true + required: + - mbsSessionId + +ContextStatusNotificationResponse: + description: Data within ContextStatusNotify Response + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + areaSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionId' + n2MbsSmInfoList: + type: array + items: + $ref: '#/components/schemas/N2MbsSmInfo' + minItems: 1 + maxItems: 10 + required: + - mbsSessionId + +ContextUpdateRspData: + description: Data within ContextUpdate Response + type: object + properties: + n2MbsSmInfoList: + type: array + items: + $ref: '#/components/schemas/N2MbsSmInfo' + minItems: 1 + maxItems: 10 + operationStatus: + $ref: '#/components/schemas/OperationStatus' + +N2MbsSmInfo: + description: N2 MBS Session Management information + type: object + properties: + ngapIeType: + $ref: '#/components/schemas/NgapIeType' + ngapData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ranId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + required: + - ngapIeType + - ngapData + +OperationEvent: + description: Operation Event for a Broadcast MBS Session. + type: object + properties: + opEventType: + $ref: '#/components/schemas/OpEventType' + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + ngranFailureEventList: + type: array + items: + $ref: '#/components/schemas/NgranFailureEvent' + minItems: 1 + required: + - opEventType + +NgranFailureEvent: + description: NG-RAN failure event for a NG-RAN + type: object + properties: + ngranId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + ngranFailureIndication: +``` + +``` + + $ref: '#/components/schemas/NgranFailureIndication' + required: + - ngranId + - ngranFailureIndication + +# +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + +OperationStatus: + description: Status of a Broadcast MBS session start or update operation. + anyOf: + - type: string + enum: + - MBS_SESSION_START_COMPLETE + - MBS_SESSION_START_INCOMPLETE + - MBS_SESSION_UPDATE_COMPLETE + - MBS_SESSION_UPDATE_INCOMPLETE + - type: string + +NgapIeType: + description: NGAP Information Element Type + anyOf: + - type: string + enum: + - MBS_SES_REQ + - MBS_SES_RSP + - MBS_SES_FAIL + - MBS_SES_REL_RSP + - BC_TRA_REQ + - BC_TRA_RSP + - BC_TRA_FAIL + - type: string + +OpEventType: + description: Operation Event Type. + anyOf: + - type: string + enum: + - AMF_CHANGE + - NG_RAN_EVENT + - type: string + +NgranFailureIndication: + description: Indicates a NG-RAN failure event. + anyOf: + - type: string + enum: + - NG_RAN_RESTART_OR_START + - NG_RAN_FAILURE_WITHOUT_RESTART + - NG_RAN_NOT_REACHABLE + - NG_RAN_REQUIRED_RELEASE + - type: string + +``` + +## A.7 Namf\_MBSCommunication API + +openapi: 3.0.0 + +info: + +``` + + version: 1.1.0-alpha.1 + title: Namf_MBSCommunication + description: | + AMF Communication Service for MBS. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +externalDocs: + +``` + + description: 3GPP TS 29.518 V18.0.0; 5G System; Access and Mobility Management Services + +``` + +``` + +url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' + +servers: + - url: '{apiRoot}/namf-mbs-comm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - namf-mbs-comm + +paths: + /n2-messages/transfer: + post: + summary: Namf_MBSCommunication N2 Message Transfer service Operation + tags: + - N2Messages Handler (custom operation) + operationId: N2MessageTransfer + requestBody: + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/MbsN2MessageTransferReqData' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + required: true + callbacks: + notification: + '{ $request.body#/notifyUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Notification' + responses: + '204': + description: successful notification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +responses: + '200': + description: MBS N2 Message Transfer successfully initiated + content: + application/json: + schema: + $ref: '#/components/schemas/MbsN2MessageTransferRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + description: Not Found + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + namf-mbs-comm: Access to the Namf_MBSCommunication API + +schemas: + +# +# STRUCTURED DATA TYPES +# + +MbsN2MessageTransferReqData: + description: Data within MBS N2 Message Transfer Request + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + areaSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionId' + n2MbsSmInfo: + $ref: '#/components/schemas/N2MbsSmInfo' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + ranNodeIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + notifyUri: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifyCorrelationId: + type: string + required: + - mbsSessionId + - n2MbsSmInfo + +MbsN2MessageTransferRspData: + description: Data within MBS N2 Message Transfer Response + type: object + properties: + result: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InformationTransferResult' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + failureList: + type: array + items: + $ref: '#/components/schemas/RanFailure' + minItems: 1 + required: + - result + +N2MbsSmInfo: + description: N2 MBS Session Management information + type: object + properties: + ngapIeType: + $ref: '#/components/schemas/MbsNgapIeType' + ngapData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + required: + - ngapIeType + - ngapData + +Notification: + description: Data within Notify Request + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + areaSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionId' + failureList: + type: array + items: + $ref: '#/components/schemas/RanFailure' + minItems: 1 + notifyCorrelationId: + type: string + required: + - mbsSessionId + - failureList + +RanFailure: + description: Description of an MBS related N2 procedure failure + type: object + properties: + ranId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + ranFailureCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + ranFailureIndication: + $ref: '#/components/schemas/RanFailureIndication' + required: + - ranId + oneOf: + - required: [ ranFailureCause ] + - required: [ ranFailureIndication ] + +``` + +``` + +# +# SIMPLE DATA TYPES +# + +``` + +``` + +# +# ENUMERATIONS +# + +MbsNgapIeType: + description: NGAP Information Element Type + anyOf: + - type: string + enum: + - MBS_SES_ACT_REQ + - MBS_SES_DEACT_REQ + - MBS_SES_UPD_REQ + - type: string + +RanFailureIndication: + description: Indicates a NG-RAN failure event + anyOf: + - type: string + enum: + - NG_RAN_FAILURE_WITHOUT_RESTART + - NG_RAN_NOT_REACHABLE + - type: string + +``` + +--- + +## Annex B (Informative): HTTP Multipart Messages + +### B.1 Example of HTTP multipart message + +#### B.1.1 General + +This clause provides a (partial) example of HTTP multipart message. The example does not aim to be a complete representation of the HTTP message, e.g. additional information or headers can be included. + +This Annex is informative and the normative descriptions in this specification prevail over the description in this Annex if there is any difference. + +#### B.1.2 Example HTTP multipart message with N2 Information binary data + +``` + +POST /example.com/namf-comm/v1/ue-contexts/{ueContextId}/n1-n2-messages HTTP/2 +Content-Type: multipart/related; boundary=-----Boundary +Content-Length: xyz + +-----Boundary +Content-Type: application/json + +{ + "n2InfoContainer": { + "n2InformationClass": "SM", + "smInfo": { + "pduSessionId": 5, + "n2InfoContent": { + "ngapIeType": "PDU_RES_SETUP_REQ", + "ngapData": { + "contentId": "n2msg" + } + } + } + }, + "pduSessionId": 5 +} +-----Boundary + +``` + +Content-Type: application/vnd.3gpp.ngap +Content-Id: n2msg + +{ ... N2 Information binary data ...} +-----Boundary + +--- + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | CT4#80 | C4-175297 | | | | TS Skeleton | 0.1.0 | +| 2017-10 | CT4#80 | C4-175397 | | | | Implementation of pCRs agreed at CT4#80. | 0.2.0 | +| 2017-12 | CT4#81 | C4-176441 | | | | Implementation of pCRs agreed at CT4#81, including C4-176285, C4-176290, C4-176291, C4-176292, C4-176293, C4-176375, C4-176376, C4-176378, C4-176379, C4-176380 and C4-176404. | 0.3.0 | +| 2018-01 | CT4#82 | C4-181393 | | | | Implementation of pCRs agreed at CT4#82, including C4-181090, C4-181091, C4-181258, C4-181259, C4-181260, C4-181269, C4-181270, C4-181311, C4-181312, C4-181313, C4-181314, C4-181352, C4-181353 and C4-181354 | 0.4.0 | +| 2018-03 | CT4#83 | C4-182437 | | | | Implementation of pCRs agreed at CT4#83, including C4-182287, C4-182288, C4-182290, C4-182292, C4-182293, C4-182350, C4-182353, C4-182355, C4-182358, C4-182367, C4-182385, C4-182403, C4-182414, C4-182415 | 0.5.0 | +| 2018-03 | CT#79 | CP-180033 | | | | Presented for information | 1.0.0 | +| 2018-04 | CT4#84 | C4-183518 | | | | Implementation of pCRs agreed at CT4#84, including C4-183048, C4-183054, C4-183055, C4-183064, C4-183073, C4-183074, C4-183161, C4-183166, C4-183171, C4-183345, C4-183347, C4-183351, C4-183354, C4-183356, C4-183357, C4-183359, C4-183360, C4-183361, C4-183362, C4-183406, C4-183407, C4-183408, C4-183409, C4-183410, C4-183411, C4-183412, C4-183413, C4-183414, C4-183415, C4-183417, C4-183434, C4-183435, C4-183436, C4-183437, C4-183439, C4-183445, C4-183460, C4-183461, C4-183462, C4-183463, C4-183464, C4-183493, C4-183494, C4-183495, C4-183502 | 1.1.0 | +| 2018-05 | CT4#85 | C4-184629 | | | | Implementation of pCRs agreed at CT4#85, including: C4-184390, C4-184391, C4-184562, C4-184393, C4-184561, C4-184395, C4-194052, C4-184396, C4-184399, C4-184404, C4-184405, C4-184407, C4-184102, C4-184408, C4-184104, C4-184410, C4-184412, C4-184413, C4-184569, C4-184563, C4-184124, C4-184418, C4-184565, C4-184127, C4-184566, C4-184129, C4-184421, C4-184131, C4-184426, C4-184427, C4-184428, C4-184429, C4-184430, C4-184431, C4-184432, C4-184433, C4-184434, C4-184435, C4-184436, C4-184437, C4-184151, C4-184481, C4-184154, C4-184515, C4-184516, C4-184568, C4-184485, C4-184486, C4-184487, C4-184488 | 1.2.0 | +| 2018-06 | CT#80 | CP-181107 | | | | Presented for approval | 2.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80 | 15.0.0 | +| 2018-09 | CT#81 | CP-182062 | 0001 | 2 | F | RAT Selector for PWS | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0002 | 3 | F | AM Policy Triggers in MM Context | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0003 | 1 | F | Update UE context and MM context as per latest stage 2 agreements | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0004 | 1 | F | Corrections to EBI Assignment | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0005 | 1 | F | Clarify Max number of reports and Max duration of reporting in alignment with stage 2 | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0006 | | F | N1/N2 Message Transfer Temporary Reject | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0008 | | F | Remove AN Type from N1/N2 Message Transfer Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182165 | 0009 | 2 | F | Update SeafData as per agreements in SA3 | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0010 | 1 | F | Include TimeStamp in AMF Event Notification | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0011 | | F | Provide Domain Selection Info | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0012 | 1 | F | RAN UE NGAP ID in RegistrationContextContainer | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0013 | 1 | F | NG-RAN TargetId in RegistrationContextContainer | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0014 | 3 | F | BackUp AMF Info | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0015 | | F | Description of N1N2TransferFailureNotification Operation | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0016 | 1 | F | Add Quotes for Runtime Expression | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0017 | | F | Callback URI for N2InfoNotify during N2 based handover | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0018 | 1 | F | Resolve Editor's Note on regular expression pattern | 15.1.0 | +| 2018-09 | CT#81 | CP-182095 | 0019 | 4 | F | Location Service ProvideLocationInfo | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0020 | 2 | F | Location Service ProvidePositioningInfo | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0021 | 2 | F | N1N2MessageTransfer Rejection due to SAR | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0022 | 3 | F | N2 Content Type Definition | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0023 | | F | Selected TAI in NgRanTargetId | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0024 | 2 | F | Skip Indicator | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0025 | 1 | F | UEContextTransfer Integrity Check Failure | 15.1.0 | +| 2018-09 | CT#81 | CP-182068 | 0026 | 1 | B | Add support for 5G Trace | 15.1.0 | +| 2018-09 | CT#81 | CP-182094 | 0027 | 3 | F | NgApCause Definition | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0028 | 1 | F | N1N2 Transfer Failure Notification | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0029 | | F | N2 Container Data Type During Handover | 15.1.0 | +| 2018-09 | CT#81 | CP-182175 | 0031 | 1 | F | Correction to RegistrationCompleteNotify | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0032 | 3 | F | N1N2MessageTransfer and Notify for PCF | 15.1.0 | +| 2018-09 | CT#81 | CP-182166 | 0033 | 3 | F | Regular expression pattern for UeContextId parameter in OpenAPI | 15.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-------------------------------------------------------------------------|--------| +| 2018-09 | CT#81 | CP-182062 | 0036 | 2 | F | Presence Reporting Area | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0037 | 1 | F | Notification Correlation Id for subscription correlation Id change | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0038 | 1 | F | Default Subscription for Notification to LMF | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0039 | 1 | F | LCS Correlation Identifier in N2Notify | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0040 | 1 | F | Mobility Restriction | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0041 | | F | Not Allowed Slice | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0042 | 1 | F | UE-AMBR | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0044 | 1 | F | Array Attributes | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0045 | 2 | F | Default Response Codes | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0046 | | F | AMF service operations | 15.1.0 | +| 2018-09 | CT#81 | CP-182048 | 0047 | 2 | F | Passing NSSF information in N1MessageNotification | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0049 | 3 | F | Clarification on location information in immediate report | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0050 | 1 | F | Resource Figures | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0051 | | F | Correct reference for Event Report Information | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0052 | | F | Consistent use of "Correlation Id" | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0053 | 1 | F | API version number update | 15.1.0 | +| 2018-09 | CT#81 | CP-182062 | 0054 | 1 | F | Custom Operation Name Correction for EBI Assignment | 15.1.0 | +| 2018-09 | CT#81 | CP-192096 | 0055 | | F | Correction of CorrelationId Reference in OpenAPI | 15.1.0 | +| 2018-12 | CT#82 | CP-183020 | 56 | 1 | F | Editorial Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 57 | | F | Usage for EnableUEReachability Service Operation | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 58 | 1 | F | Update to SeafData | 15.2.0 | +| 2018-12 | CT#82 | CP-183232 | 60 | 4 | F | Transfer UE Radio Capability between AMFs | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 61 | 2 | F | Notification of the change of the PCF | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 62 | 1 | F | Information in N1MessageNotify | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 63 | | F | Event Exposure | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 64 | | F | Correct the references | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 65 | 5 | F | Subscription lifetime | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 67 | | F | Corrections to TADS Query API | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 69 | 5 | F | Transfer of Group Id Subscriptions | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 70 | 1 | F | Attributes corrections for RegistrationContextContainer and MmContext | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 71 | 1 | F | Correction on tables | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 72 | | F | Mandatory Status Code Correction | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 74 | 1 | F | N2InfoNotify correction for Handover Confirm | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 75 | 1 | F | Naming convention of provideLocInfo and providePosInfo | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 76 | 2 | F | OpenAPI specification alignments | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 77 | 1 | F | Remove Duplicated Common Application Errors | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 78 | | F | Required routingId | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 79 | 1 | F | Resource URIs Alignment | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 80 | | F | Seaf data type correction | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 81 | | F | UeContextId Pattern Complement | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 82 | | F | Use RefToBinaryData from common data types | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 83 | 3 | F | Range Definition in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 84 | | F | sessionId in N1N2MessageTransferReqData | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 85 | 1 | F | New rejection cause for UE in CM-IDLE state | 15.2.0 | +| 2018-12 | CT#82 | CP-183151 | 86 | 8 | F | Notifying Subscription ID Change | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 87 | 1 | F | SMF Reallocation requested Indication | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 88 | 1 | F | Paging Policy Indicator | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 89 | 1 | F | EPS bearer identity | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 90 | 1 | F | 29518 CR cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 92 | 1 | F | Editorial Correction to PduSessionContext | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 93 | 1 | F | Global RAN Node ID in RegistrationContextContainer | 15.2.0 | +| 2018-12 | CT#82 | CP-183154 | 97 | 2 | F | Update of Subscription Lifetime | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 98 | 1 | F | EBI Allocation Rejection Cause | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 100 | 2 | F | UE Context Transfer during initial registration via another access type | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 101 | 1 | F | RAN Status Transfer Transparent Container in N2 based handover | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 103 | 1 | F | NgapleType for X2 and N2 based handover | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 104 | | F | Update of N1N2 Message Operations | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 105 | 1 | F | Clarify the handling of EBI assignment | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 106 | | F | Align Usage of Tags | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 107 | 1 | F | Altitude in Provide Positioning Information | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 108 | | F | AmfStatusChangeSubscribe Modify in Resource Table | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 109 | 1 | F | API Root | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 110 | 1 | F | Case Convention | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 111 | 1 | F | Clarification of ProvideLocInfo when CM-CONNECTED | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 118 | 1 | F | N1 N2 Message for Positioning | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 119 | 3 | F | N3GPP DDN handling when UE CM-IDLE on N3GPP | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 121 | 1 | F | Alignment on TADS Query | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 122 | 1 | F | Configuration Transfer procedure over N14 | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 123 | | F | N1N2MessageTransfer Request message | 15.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|--------------------------------------------------------------------------------------------|--------| +| 2018-12 | CT#82 | CP-183020 | 124 | 2 | F | UDM group Id | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 125 | | F | Warning Request Transfer Procedure | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 126 | 1 | F | Location Header | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 127 | | F | Remove duplicate references | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 128 | 1 | F | 429 Response Codes | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 129 | | F | API Version | 15.2.0 | +| 2018-12 | CT#82 | CP-183020 | 130 | 1 | F | Oauth2 correction | 15.2.0 | +| 2018-12 | CT#82 | CP-183191 | 131 | | F | Editorial Correction to AMF Event Type Enumeration | 15.2.0 | +| 2018-12 | CT#82 | CP-183229 | 132 | | F | Correction to OpenAPI definition of UeContextTransferRspData | 15.2.0 | +| 2019-03 | CT#83 | CP-190025 | 133 | 1 | F | OpenAPI correction for HTTP method of EnableUEReachability | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 134 | | F | PDU sessions not accepted by target AMF in N2 based handover | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 135 | 1 | F | Sending Secondary RAT usage over N14 during N2 handover with AMF change | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 136 | | F | SM Context URI in UE context | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 137 | 2 | F | UE policy delivery and control | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 138 | | F | Correct Event Exposure Service Description | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 139 | 2 | F | Simplify N1N2MessageTransfer when UE is in CM-IDLE | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 140 | 2 | F | Update EBIAssignment Service Operation to Align with Stage 2 | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 141 | 1 | F | Corrections to the HTTP methods and URI | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 143 | 1 | F | Correction to Reponse Code for Positioning Failed | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 144 | 1 | F | Essential Clairfication on Event Subscription Creation | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 145 | 1 | F | OpenAPI Syntax Correction | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 146 | 1 | F | Reference Id | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 148 | 1 | F | SMF Service Instance during AMF change | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 149 | 1 | F | GMLC URI for Namf_Location EventNotify | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 150 | 1 | F | Correction of keyAmfChangeInd | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 151 | 1 | F | N2SmInformation in UeContextCreateData & UeContextCreatedData | 15.3.0 | +| 2019-03 | CT#83 | CP-190025 | 153 | | F | API version update | 15.3.0 | +| 2019-06 | CT#84 | CP-191036 | 154 | | F | ngapCause in UeContextCreatedData | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 160 | | F | Correction N1 N2 Message Transfer when CM-IDLE | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 161 | | F | Correction on CR0021 implementation | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 162 | | F | Event Notify Failure Response | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 164 | | F | UE Identities for Event Notification | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 155 | 1 | F | Content Type | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 163 | 1 | F | LPP Handling | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 165 | 1 | F | AMF Event Alignment | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 166 | 1 | F | Missing Loss Of Connectivity Event | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 171 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 172 | 1 | F | Location header in redirect response | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 173 | 1 | F | LMF Service Instance Id for N1N2MessageTransfer | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 174 | | F | Remove Subscribed-Data-Report event type and SARI data type | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 175 | 1 | F | Correction in PwsInformation Parameter | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 177 | 1 | F | Copyright Note in OpenAPI Spec | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 178 | 1 | F | Correction on EBI in PDU session context | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 179 | 1 | F | Major API version | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 181 | 1 | F | Status code of Namf_EventExposure Unsubscribe service operation | 15.4.0 | +| 2019-06 | CT#84 | CP-191036 | 187 | | F | 3GPP TS 29.518 API version update | 15.4.0 | +| 2019-06 | CT#84 | CP-191046 | 182 | 2 | F | Corrections of the references to retrieve Callback URI from NRF for N1and N2 notifications | 16.0.0 | +| 2019-06 | CT#84 | CP-191049 | 159 | 2 | B | Updates to CreateUEContext for eNS Support | 16.0.0 | +| 2019-06 | CT#84 | CP-191054 | 168 | 3 | B | Update N2InformationNotification for I-SMF insertion, change and removal | 16.0.0 | +| 2019-06 | CT#84 | CP-191050 | 184 | 3 | B | Add NB-IoT specific UE Radio Access Capability in UE context | 16.0.0 | +| 2019-06 | CT#84 | CP-191050 | 185 | 1 | B | Update to the UEContextTransfer service for adding Gap timer | 16.0.0 | +| 2019-06 | CT#84 | CP-191048 | 186 | | B | 3GPP TS 29.518 API version update | 16.0.0 | +| 2019-09 | CT#85 | CP-192110 | 0189 | 2 | A | Wrong Cardinality of IcsSupportedGADShapes in RequestPosInfo | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0190 | 1 | F | Correction for ngapMessageType | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0191 | 1 | F | NonUeN2InfoUnsubscribe for PWS | 16.1.0 | +| 2019-09 | CT#85 | CP-192188 | 0193 | 1 | B | Transfer 5G SRVCC Parameters between AMFs | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0194 | 1 | B | CreateUEContext – I-SMF and SM Context ID Information | 16.1.0 | +| 2019-09 | CT#85 | CP-192110 | 0197 | 1 | A | Use of ARP value for Priority Paging | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0198 | 1 | B | Correction of the smfChangeIndication | 16.1.0 | +| 2019-09 | CT#85 | CP-192110 | 0200 | | A | Signalling Old GUAMI to target AMF during the AMF planned removal procedure | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0201 | 1 | F | 5GS User State retrieval | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0202 | 1 | F | Forwarding UL N2 message to target AMF during AMF planned removal procedure | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0203 | 1 | F | MT SMS to UE in RRC INACTIVE state with NG-RAN paging failure | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0205 | | F | Corrections to Mapped Service Operations of Namf_Communication service | 16.1.0 | +| 2019-09 | CT#85 | CP-192110 | 0208 | 1 | A | Missing Location header | 16.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-----------------------------------------------------------------------------|--------| +| 2019-09 | CT#85 | CP-192110 | 0210 | 1 | A | Missing status codes | 16.1.0 | +| 2019-09 | CT#85 | CP-192134 | 0211 | | B | Transfer Information of MA PDU Session between AMFs | 16.1.0 | +| 2019-09 | CT#85 | CP-192110 | 0214 | 3 | A | OpenAPI Correction on Location Header | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0215 | | F | Error response of the EBIAssignment | 16.1.0 | +| 2019-09 | CT#85 | CP-192135 | 0216 | | B | Namf_EventExposure service invoked by NWDAF | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0217 | | B | ETSUN_N1N2MessageTransfer Failure due to SM Context relocation needed | 16.1.0 | +| 2019-09 | CT#85 | CP-192132 | 0218 | 1 | F | Service Gap Time | 16.1.0 | +| 2019-09 | CT#85 | CP-192132 | 0221 | 2 | B | HLCom extended buffering in MT Service | 16.1.0 | +| 2019-09 | CT#85 | CP-192132 | 0223 | 2 | B | Small Data Rate Control Status | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0224 | 1 | F | Example of HTTP multipart message | 16.1.0 | +| 2019-09 | CT#85 | CP-192132 | 0225 | 1 | B | Extended Buffering Support in Communication Service | 16.1.0 | +| 2019-09 | CT#85 | CP-192120 | 0227 | | F | 3GPP TS 29.518 API version update | 16.1.0 | +| 2019-10 | | | | | | Corrupted references fixed | 16.1.1 | +| 2019-12 | CT#86 | CP-193051 | 0229 | 1 | B | Target Access type in N1N2MessageTransfer Request for a MA PDU session | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0230 | | F | egiList and ncgiList in N2InformationTransferReqData not needed | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0231 | | B | Event exposure between AMF and SMF | 16.2.0 | +| 2019-12 | CT#86 | CP-193051 | 0233 | 1 | B | MA PDU session accepted indication | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0235 | 1 | A | Source AMF NGAP ID | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0239 | | A | N1N2MessageTransfer request during an on-going handover procedure | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0240 | | B | RIM Information Transfer procedure | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0241 | | B | User location report | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0244 | 4 | B | Update the service operation of AMF | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0246 | | A | Correction to ProvideLocInfo | 16.2.0 | +| 2019-12 | CT#86 | CP-193062 | 0248 | 3 | B | Transferring UE Radio Capability ID between AMFs | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0250 | 1 | A | Reference correction | 16.2.0 | +| 2019-12 | CT#86 | CP-193048 | 0251 | 1 | F | Reference correction | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0253 | 1 | F | Correction on MT Enable UE Reachability | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0254 | | F | Excluding security context in the UE context | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0255 | 1 | B | Adding Rate Control attributes to N1N2messageTransferReq data type | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0256 | 2 | B | Mobile Terminated Data Transfer for Control Plane CIoT 5GS Optimisation | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0257 | 1 | F | PDU Session Release for UE in RRC INACTIVE state with NG-RAN paging failure | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0260 | 2 | F | Add Corresponding OpenAPI descriptions in clause 5.1 | 16.2.0 | +| 2019-12 | CT#86 | CP-193164 | 0261 | 2 | B | Updating support for subscription-based access restriction | 16.2.0 | +| 2019-12 | CT#86 | CP-193166 | 0262 | 2 | B | AMF Location Service Operations for a Commercial and Deferred 5GC-MT-LR | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0263 | 1 | B | LMF identification for LMF change | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0264 | 1 | B | Location Service ProvidePositioningInfo | 16.2.0 | +| 2019-12 | CT#86 | CP-193122 | 0266 | 2 | B | NF/NF Service Set ID in UE Context Transfer | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0268 | 1 | A | Definition of hpcfld | 16.2.0 | +| 2019-12 | CT#86 | CP-193080 | 0270 | 3 | A | Secondary RAT Data Usage Report | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0273 | 1 | B | AMF forwarding Location services messages between UE and LMF | 16.2.0 | +| 2019-12 | CT#86 | CP-193044 | 0275 | | F | 3GPP TS 29.518 API version update | 16.2.0 | +| 2020-03 | CT#87 | CP-200017 | 0276 | 3 | F | SMF change indication during Inter-AMF registration | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0277 | 3 | F | DNN encoding in Namf_Communication API | 16.3.0 | +| 2020-03 | CT#87 | CP-200043 | 0279 | 2 | F | smsSupport attribute in UE context | 16.3.0 | +| 2020-03 | CT#87 | CP-200043 | 0280 | 2 | F | AMF event subscription without the "options" attribute | 16.3.0 | +| 2020-03 | CT#87 | CP-200039 | 0281 | 2 | D | Editorial corrections | 16.3.0 | +| 2020-03 | CT#87 | CP-200043 | 0282 | 1 | F | Correction of typos | 16.3.0 | +| 2020-03 | CT#87 | CP-200043 | 0283 | 2 | F | Class indication in subscription response | 16.3.0 | +| 2020-03 | CT#87 | CP-200043 | 0284 | 3 | F | Cause values for PWS errors detected by AMF | 16.3.0 | +| 2020-03 | CT#87 | CP-200039 | 0285 | 2 | F | Correction - formatting consistency | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0286 | 1 | B | 29518 CR optionality of ProblemDetails | 16.3.0 | +| 2020-03 | CT#87 | CP-200031 | 0287 | 1 | B | Additional Access Type in UE Context Transfer | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0288 | 1 | B | Granularity of the SMF change Indication | 16.3.0 | +| 2020-03 | CT#87 | CP-200179 | 0289 | 1 | B | V2X information in UE Context | 16.3.0 | +| 2020-03 | CT#87 | CP-200178 | 0290 | 1 | B | Availability after DDN Failure | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0294 | 1 | B | Ongoing registration or handover during paging | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0295 | 1 | B | 5G CIoT Attribute in UeContext | 16.3.0 | +| 2020-03 | CT#87 | CP-200030 | 0296 | 2 | B | Event Exposure invoked by NWDAF | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0297 | 1 | F | V-SMF insertion or removal | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0298 | | F | Feature definition for support of CIoT features | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0299 | | F | Mobile Terminated Data | 16.3.0 | +| 2020-03 | CT#87 | CP-200043 | 0300 | | F | UE_IN_NON_ALLOWED_AREA error in EnableUEReachability response | 16.3.0 | +| 2020-03 | CT#87 | CP-200035 | 0302 | 1 | B | SUPI pattern | 16.3.0 | +| 2020-03 | CT#87 | CP-200018 | 0303 | | B | LCS service authorization | 16.3.0 | +| 2020-03 | CT#87 | CP-200018 | 0305 | 3 | B | Cm state exposure | 16.3.0 | +| 2020-03 | CT#87 | CP-200052 | 0306 | | F | 3GPP TS 29.518 API Rel16 API External doc update | 16.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------|--------| +| 2020-06 | CT#88e | CP-201054 | 0307 | | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201031 | 0308 | | F | V-SMF and I-SMF service instance Id | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0309 | 1 | F | N1N2Transfer Failure Notification for UEs in RRC Inactive state | 16.4.0 | +| 2020-06 | CT#88e | CP-201045 | 0310 | 1 | B | NPN extensions for Inter-AMF N2 Handover | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0311 | 1 | F | Supported Headers Tables for Response codes 2xx and 3xx | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0312 | 1 | F | Binary Data Types Table | 16.4.0 | +| 2020-06 | CT#88e | CP-201046 | 0313 | 1 | B | Maximum UP resources activation of 2 PDU sessions | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0314 | 1 | F | Add new Notifications Overview Tables | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0315 | | F | subscriptionId in AmfCreatedEventSubscription and AmfEventReport | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0316 | | F | Non-delivery of N1 message to UE due to Xn/N2 handover | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0318 | | F | Reference Corrections | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0319 | 1 | F | Optionality of ProblemDetails in TS29.518 cleanup | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0321 | | F | Default LocationFilter | 16.4.0 | +| 2020-06 | CT#88e | CP-201067 | 0322 | 2 | B | MDT Configuration | 16.4.0 | +| 2020-06 | CT#88e | CP-201043 | 0323 | 2 | B | Update the event subscription and notification on area of interest | 16.4.0 | +| 2020-06 | CT#88e | CP-201047 | 0324 | 2 | B | Authentication and Authorization status | 16.4.0 | +| 2020-06 | CT#88e | CP-201048 | 0325 | 1 | F | Stage 2 procedures for wireline access | 16.4.0 | +| 2020-06 | CT#88e | CP-201048 | 0326 | 1 | F | TWAP ID change reporting | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0328 | 2 | F | Periodic reporting | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0330 | 1 | F | Reasons for loss of connectivity | 16.4.0 | +| 2020-06 | CT#88e | CP-201023 | 0331 | 2 | F | UEContextTransfer - N3IWF/W-AGF/TNGF ID and RAN NGAP ID | 16.4.0 | +| 2020-06 | CT#88e | CP-201018 | 0339 | 2 | A | Binary IE Encoding | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0340 | 1 | F | Broadcast Empty Area List | 16.4.0 | +| 2020-06 | CT#88e | CP-201044 | 0341 | 1 | F | Clarification on EBI Allocation for MAPDU | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0342 | | F | Correct Reference on Location Procedures | 16.4.0 | +| 2020-06 | CT#88e | CP-201046 | 0343 | 4 | B | UE Maximum Availability Time | 16.4.0 | +| 2020-06 | CT#88e | CP-201023 | 0344 | 3 | A | Event of UE Reachability | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0345 | 1 | F | GUAMI in N1/N2 Message Notification | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0346 | 1 | F | LCS Correlation Id for NRPPa Transfer | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0347 | 1 | F | PWS Message Transfer Precedence | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0348 | 1 | F | Data type column in Resource URI variables Table | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0349 | 1 | F | Add custom operation Name | 16.4.0 | +| 2020-06 | CT#88e | CP-201046 | 0350 | 2 | B | Monitoring Event Information | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0351 | 2 | F | LMF indicating access type for transmission of LPP message | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0352 | 1 | F | UePrivacyRequirements for Location Request | 16.4.0 | +| 2020-06 | CT#88e | CP-201044 | 0354 | 1 | F | Condition of MA-PDU Session Context Transfer | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0355 | 1 | F | N2 PDU Session Modification for a UE in CM-IDLE state | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0356 | 1 | F | GMLC authorization in RequestPosInfo | 16.4.0 | +| 2020-06 | CT#88e | CP-201197 | 0357 | 1 | F | PC5 policy container from PCF | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0358 | 2 | F | Maximum number of reports | 16.4.0 | +| 2020-06 | CT#88e | CP-201054 | 0359 | | F | Correction for implementation error | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0362 | 1 | B | Indication of control plane CLoT 5GS optimization to an LMF | 16.4.0 | +| 2020-06 | CT#88e | CP-201043 | 0367 | 1 | F | Sampling ratio for AMF event exposure | 16.4.0 | +| 2020-06 | CT#88e | CP-201032 | 0368 | 1 | F | The result of location verification by UE | 16.4.0 | +| 2020-06 | CT#88e | CP-201043 | 0369 | 2 | F | AMF event exposure for any UE | 16.4.0 | +| 2020-06 | CT#88e | CP-201018 | 0371 | 1 | A | pwdErrorInfo should be pwsErrorInfo in openAPI | 16.4.0 | +| 2020-06 | CT#88e | CP-201073 | 0375 | | F | 29.518 Rel-16 API version and External doc update | 16.4.0 | +| 2020-09 | CT#89e | CP-202097 | 0376 | 2 | F | DAPS Handover information | 16.5.0 | +| 2020-09 | CT#89e | CP-202114 | 0378 | 3 | F | Clarification on hSmfId in PduSessionContext transferred to target AMF | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0379 | 2 | F | Clarification on Max Number of Reports | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0380 | 2 | F | Event Report in Response to AMF Event Subscription Update | 16.5.0 | +| 2020-09 | CT#89e | CP-202109 | 0381 | 1 | F | SNSSAI during mobility procedure | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0382 | | F | Callback URI correction | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0383 | 1 | A | Definition of DRX | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0384 | 2 | A | Cardinality of AmfUpdateEventSubscriptionItem | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0385 | | F | Identifier of the NF service consumer sending an N1 message | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0386 | | F | Clarifications to EBI Assignment procedure | 16.5.0 | +| 2020-09 | CT#89e | CP-202043 | 0388 | | A | Correction of UE Context Transfer payload in case of UE initial registration | 16.5.0 | +| 2020-09 | CT#89e | CP-202043 | 0392 | 1 | A | Registration Status Update for PCF for UE Policy | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0394 | 1 | F | Additional Prald | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0395 | 1 | F | PCF Group Id | 16.5.0 | +| 2020-09 | CT#89e | CP-202040 | 0397 | 1 | A | Selected EPS NAS Security Algorithm Rel16 | 16.5.0 | +| 2020-09 | CT#89e | CP-202112 | 0398 | 1 | F | Removal of EN on CP 5G CLoT Optimisation | 16.5.0 | +| 2020-09 | CT#89e | CP-202112 | 0399 | 1 | F | Correction of Notification or Verification only for UE Positioning | 16.5.0 | +| 2020-09 | CT#89e | CP-202108 | 0400 | 2 | F | Managing RACS ID for mobility across ePLMNs | 16.5.0 | +| 2020-09 | CT#89e | CP-202093 | 0401 | 1 | F | Correction of n2InfoNotifyUrl in figures | 16.5.0 | +| 2020-09 | CT#89e | CP-202112 | 0402 | 2 | F | Add Response Codes on operation provide-pos-info | 16.5.0 | +| 2020-09 | CT#89e | CP-202112 | 0403 | | F | Corrections on N2InformationNotification | 16.5.0 | +| 2020-09 | CT#89e | CP-202096 | 0407 | | F | 29.518 Rel-16 API version and External doc update | 16.5.0 | +| 2020-12 | CT#90e | CP-203050 | 0409 | 1 | F | Broadcast of Assistance Data by an LMF | 16.6.0 | +| 2020-12 | CT#90e | CP-203050 | 0410 | 1 | F | Serving Cell Id in N1MessageNotification | 16.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------------------------------|--------| +| 2020-12 | CT#90e | CP-203080 | 0411 | 3 | F | Supplement to UeContext | 16.6.0 | +| 2020-12 | CT#90e | CP-203030 | 0413 | | F | Clarification on usage of "locationAge" and "geoInfo" in ProvideLocInfo | 16.6.0 | +| 2020-12 | CT#90e | CP-203030 | 0414 | | F | Incorrect NOTE | 16.6.0 | +| 2020-12 | CT#90e | CP-203163 | 0415 | 1 | F | HTTP 3xx redirection | 16.6.0 | +| 2020-12 | CT#90e | CP-203048 | 0417 | 1 | F | IMS AS query for UE IP Reachability | 16.6.0 | +| 2020-12 | CT#90e | CP-203035 | 0418 | 1 | F | UE Reachability Status Change | 16.6.0 | +| 2020-12 | CT#90e | CP-203040 | 0420 | 2 | F | Transfer N2 SM Info Received from SMF to Target AMF | 16.6.0 | +| 2020-12 | CT#90e | CP-203048 | 0421 | 2 | F | Miscellaneous corrections | 16.6.0 | +| 2020-12 | CT#90e | CP-203045 | 0422 | 1 | F | Partial failure of event subscription | 16.6.0 | +| 2020-12 | CT#90e | CP-203054 | 0423 | | F | SBI Binding Level | 16.6.0 | +| 2020-12 | CT#90e | CP-203030 | 0425 | 2 | F | Current location of a UE | 16.6.0 | +| 2020-12 | CT#90e | CP-203030 | 0426 | 1 | F | CreateUEContext Failure | 16.6.0 | +| 2020-12 | CT#90e | CP-203041 | 0430 | 1 | F | Event Subscription Synchronization | 16.6.0 | +| 2020-12 | CT#90e | CP-203054 | 0431 | 1 | F | HPCF Set Id | 16.6.0 | +| 2020-12 | CT#90e | CP-203027 | 0433 | 1 | A | Initial Location | 16.6.0 | +| 2020-12 | CT#90e | CP-203030 | 0437 | 3 | F | Corrections for unused data types and OperationId in OpenAPI | 16.6.0 | +| 2020-12 | CT#90e | CP-203048 | 0438 | | F | User Location | 16.6.0 | +| 2020-12 | CT#90e | CP-203027 | 0439 | | A | Event subscription update | 16.6.0 | +| 2020-12 | CT#90e | CP-203036 | 0441 | | F | 29.518 Rel-16 API version and External doc update | 16.6.0 | +| 2020-12 | CT#90e | CP-203064 | 0412 | 1 | F | Essential corrections | 17.0.0 | +| 2020-12 | CT#90e | CP-203057 | 0424 | 1 | F | EBI and ARP mapping update | 17.0.0 | +| 2020-12 | CT#90e | CP-203057 | 0427 | | F | N51 interface between NEF and AMF | 17.0.0 | +| 2020-12 | CT#90e | CP-203055 | 0442 | | F | 29.518 Rel-17 API version and External doc update | 17.0.0 | +| 2021-03 | CT#91e | CP-210178 | 0443 | 2 | F | Subscription not found inconsistency | 17.1.0 | +| 2021-03 | CT#91e | CP-210021 | 0444 | 2 | B | NF discovery based on SUCI information | 17.1.0 | +| 2021-03 | CT#91e | CP-210177 | 0446 | 2 | A | Handover Reject during EPS to 5GS Handover with AMF Re-allocation | 17.1.0 | +| 2021-03 | CT#91e | CP-210157 | 0448 | 1 | A | Handover Cancel during EPS to 5GS Handover with AMF Re-allocation | 17.1.0 | +| 2021-03 | CT#91e | CP-210159 | 0450 | 1 | A | Encoding of Forward Relocation Request | 17.1.0 | +| 2021-03 | CT#91e | CP-210040 | 0452 | 1 | A | DNN and Selected DNN | 17.1.0 | +| 2021-03 | CT#91e | CP-210037 | 0454 | 1 | A | Binding information of AMF event subscriptions | 17.1.0 | +| 2021-03 | CT#91e | CP-210173 | 0456 | | A | Error Responses for Indirect Communication | 17.1.0 | +| 2021-03 | CT#91e | CP-210043 | 0458 | 1 | A | UE context transfer during Inter-PLMN mobility registration | 17.1.0 | +| 2021-03 | CT#91e | CP-210043 | 0460 | | A | User Location in ProvideLocInfo | 17.1.0 | +| 2021-03 | CT#91e | CP-210059 | 0462 | | A | EBI allocation for Emergency PDU sessions | 17.1.0 | +| 2021-03 | CT#91e | CP-210059 | 0464 | 1 | A | Implementation error | 17.1.0 | +| 2021-03 | CT#91e | CP-210049 | 0468 | 2 | A | Interworking S-NSSAI during EPS to 5GS handover with AMF Relocation | 17.1.0 | +| 2021-03 | CT#91e | CP-210041 | 0470 | 1 | A | Target Node in Location continuity for handover from NG-RAN | 17.1.0 | +| 2021-03 | CT#91e | CP-210030 | 0471 | 1 | F | Wrong Reference for Reachable of Regulatory | 17.1.0 | +| 2021-03 | CT#91e | CP-210043 | 0473 | 1 | A | Corrections on resource and notification URI | 17.1.0 | +| 2021-03 | CT#91e | CP-210043 | 0475 | | A | Storage of YAML files | 17.1.0 | +| 2021-03 | CT#91e | CP-210161 | 0477 | 1 | A | Add the missing MDT parameters for NR | 17.1.0 | +| 2021-03 | CT#91e | CP-210048 | 0479 | 1 | A | Corrections on Enhanced Coverage information | 17.1.0 | +| 2021-03 | CT#91e | CP-210048 | 0481 | 1 | A | UE Differentiation Information | 17.1.0 | +| 2021-03 | CT#91e | CP-210021 | 0482 | 2 | F | Clarification to Communication-Failure-Report | 17.1.0 | +| 2021-03 | CT#91e | CP-210155 | 0483 | 3 | B | PRA Information update | 17.1.0 | +| 2021-03 | CT#91e | CP-210046 | 0485 | | A | 4xx codes during event notification | 17.1.0 | +| 2021-03 | CT#91e | CP-210048 | 0487 | 1 | F | Correction on UE Reachability | 17.1.0 | +| 2021-03 | CT#91e | CP-210046 | 0489 | | A | Support of immediate report | 17.1.0 | +| 2021-03 | CT#91e | CP-210029 | 0490 | | F | 29.518 Rel-17 API version and External doc update | 17.1.0 | +| 2021-06 | CT#92e | CP-211076 | 0493 | | A | Indicating the Serving PLMN ID to the Target AMF during inter-AMF handover | 17.2.0 | +| 2021-06 | CT#92e | CP-211076 | 0495 | | A | PDU session contexts transfer during a UE initial registration | 17.2.0 | +| 2021-06 | CT#92e | CP-211063 | 0497 | 1 | A | LMF using AMF event exposure service | 17.2.0 | +| 2021-06 | CT#92e | CP-211065 | 0499 | 1 | F | PPI mapping | 17.2.0 | +| 2021-06 | CT#92e | CP-211083 | 0502 | 1 | A | Incomplete Implementation of CR | 17.2.0 | +| 2021-06 | CT#92e | CP-211047 | 0503 | 2 | F | RAN Node Level Location Accuracy | 17.2.0 | +| 2021-06 | CT#92e | CP-211054 | 0504 | 2 | F | UE Reachability with Not Allowed Areas | 17.2.0 | +| 2021-06 | CT#92e | CP-211023 | 0507 | 1 | F | hNRF from NSSF in home PLMN | 17.2.0 | +| 2021-06 | CT#92e | CP-211058 | 0508 | | F | OpenAPI Reference | 17.2.0 | +| 2021-06 | CT#92e | CP-211059 | 0511 | | F | NF type of consumer subscribing to AMF event | 17.2.0 | +| 2021-06 | CT#92e | CP-211039 | 0512 | 1 | B | Authorization and QoS data for ProSe services | 17.2.0 | +| 2021-06 | CT#92e | CP-211036 | 0513 | 2 | B | Event Exposure enhancement with Partitioning criteria at AMF | 17.2.0 | +| 2021-06 | CT#92e | CP-211067 | 0515 | 2 | A | Maximum Response Time in the EE subscription request | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0518 | | F | Data Type Description for Namf_MT Service API | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0519 | | F | Data Type Description for Namf_Location Service API | 17.2.0 | +| 2021-06 | CT#92e | CP-211030 | 0521 | 1 | B | New parameter Subscribed-UE-Slice-MBR added | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0522 | 1 | F | Terminating Domain Selection request during on-going Registration | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0523 | 2 | F | Network Triggered Service Request for UE in CM-CONNECTED state outside of the validity area included in N1N2MessageTransfer | 17.2.0 | + +| | | | | | | | | +|--|--|--|--|--|--|---------|--| +| | | | | | | Request | | +|--|--|--|--|--|--|---------|--| + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------|--------| +| 2021-06 | CT#92e | CP-211065 | 0525 | | A | Network Provided Location Information for non-3GPP access | 17.2.0 | +| 2021-06 | CT#92e | CP-211076 | 0527 | 1 | A | Group subscription transfer during inter-AMF mobility | 17.2.0 | +| 2021-06 | CT#92e | CP-211077 | 0529 | 1 | A | IAB Authorization for Inter-AMF handover | 17.2.0 | +| 2021-06 | CT#92e | CP-211026 | 0530 | 1 | B | GMUC using AMF event exposure service | 17.2.0 | +| 2021-06 | CT#92e | CP-211032 | 0531 | 1 | B | N1N2MessageTransfer supporting MUSIM | 17.2.0 | +| 2021-06 | CT#92e | CP-211026 | 0533 | 1 | B | Add Local location | 17.2.0 | +| 2021-06 | CT#92e | CP-211076 | 0535 | 1 | A | Registration with AMF re-direction | 17.2.0 | +| 2021-06 | CT#92e | CP-211036 | 0536 | 1 | B | Analytics subscription information | 17.2.0 | +| 2021-06 | CT#92e | CP-211036 | 0537 | 1 | B | S-NSSAIs per TA mapping event | 17.2.0 | +| 2021-06 | CT#92e | CP-211059 | 0541 | | A | Redirect Response for Namf_Communication | 17.2.0 | +| 2021-06 | CT#92e | CP-211036 | 0545 | 1 | B | Support of Mute Reporting | 17.2.0 | +| 2021-06 | CT#92e | CP-211059 | 0546 | | A | Redirect Response for Namf_EventExposure | 17.2.0 | +| 2021-06 | CT#92e | CP-211059 | 0548 | | A | Redirect Response for Namf_MT | 17.2.0 | +| 2021-06 | CT#92e | CP-211059 | 0550 | 1 | A | Redirect Response for Namf_Location | 17.2.0 | +| 2021-06 | CT#92e | CP-211059 | 0555 | 1 | A | Missing 307 and 308 for Namf_Communication | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0556 | 1 | F | Data Type Description for Namf_Communication Service API | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0557 | 1 | F | Data Type Description for Namf_EventExposure Service API | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0558 | 1 | F | Corrections on cardinality issues | 17.2.0 | +| 2021-06 | CT#92e | CP-211062 | 0564 | | A | hSmfId in PduSessionContext transferred to target AMF | 17.2.0 | +| 2021-06 | CT#92e | CP-211050 | 0565 | | F | 29.518 Rel-17 API version and External doc update | 17.2.0 | +| 2021-09 | CT#93e | | | | | Broadcast Empty Area List for Write-Replace-Warning Request NG-RAN | | +| | | CP-212026 | 0568 | | C | | 17.3.0 | +| 2021-09 | CT#93e | CP-212026 | 0569 | 1 | F | Corrections to NGAP messages | 17.3.0 | +| 2021-09 | CT#93e | CP-212082 | 0572 | 1 | A | AM Policy Information | 17.3.0 | +| 2021-09 | CT#93e | CP-212051 | 0573 | 1 | F | The maxReports IE in AmfEvent or AmfEventMode | 17.3.0 | +| 2021-09 | CT#93e | CP-212051 | 0574 | | F | Resource archetype correction | 17.3.0 | +| 2021-09 | CT#93e | CP-212041 | 0575 | | B | NF Services consumed by DCCF | 17.3.0 | +| 2021-09 | CT#93e | CP-212051 | 0576 | | F | Binding Indication | 17.3.0 | +| 2021-09 | CT#93e | CP-212026 | 0578 | | F | Missing errors in AMF APIs | 17.3.0 | +| 2021-09 | CT#93e | CP-212034 | 0580 | 1 | B | Add UE Positioning Capabilities | 17.3.0 | +| 2021-09 | CT#93e | CP-212097 | 0582 | | A | 3xx description correction for SCP | 17.3.0 | +| 2021-09 | CT#93e | CP-212034 | 0585 | 1 | B | Multiple QoS Class | 17.3.0 | +| 2021-09 | CT#93e | CP-212037 | 0586 | | B | Dynamic management of group based event monitoring | 17.3.0 | +| 2021-09 | CT#93e | CP-212051 | 0591 | 1 | F | NfInstanceId of CBCF | 17.3.0 | +| 2021-09 | CT#93e | CP-212036 | 0592 | | F | Miscellaneous 5G ProSe related corrections and updates | 17.3.0 | +| 2021-09 | CT#93e | CP-212059 | 0593 | | F | 29.518 Rel-17 API version and External doc update | 17.3.0 | +| 2021-12 | CT#94e | CP-213097 | 0596 | | B | Introduction of new AMF services (MBSBroadcast and MBSSCommunication) to clauses 4.1 and 5.1 | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0597 | | B | MBSBroadcast API - Overview of MBSBroadcast service | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0598 | 4 | B | MBSBroadcast API - ContextCreate service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0599 | 2 | B | MBSBroadcast API - ContextUpdate service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0600 | | B | MBSBroadcast API - ContextRelease service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0601 | | B | MBSBroadcast API - Resources and methods overview | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0602 | | B | MBSBroadcast API - Resource Definition - Broadcast MBS session contexts collection | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0603 | | B | MBSBroadcast API - Resource Definition - Individual broadcast MBS session context | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0604 | 3 | B | MBSBroadcast API - Data Model & OpenAPI for ContextCreate and ContextStatusNotify service operations | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0605 | 3 | B | MBSBroadcast API - Data Model & OpenAPI for ContextUpdate service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0606 | 1 | B | MBSBroadcast API - Data Model & OpenAPI for ContextRelease service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0608 | 1 | B | Namf_MBSSCommunication service description | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0609 | 1 | B | Namf_MBSSCommunication resources and methods | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0610 | 2 | B | Namf_MBSSCommunication data type and openAPI | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0611 | 1 | B | Namf_MBSSCommunication error handling | 17.4.0 | +| 2021-12 | CT#94e | CP-213086 | 0612 | 2 | F | Transfer UE radio capability for paging between AMFs | 17.4.0 | +| 2021-12 | CT#94e | CP-213112 | 0613 | 1 | B | UUAA-MM status indication in UE Context | 17.4.0 | +| 2021-12 | CT#94e | CP-213112 | 0614 | 1 | B | N1N2MessageTransfer update | 17.4.0 | +| 2021-12 | CT#94e | CP-213112 | 0615 | 1 | B | Notification enhancement with additional filtering | 17.4.0 | +| 2021-12 | CT#94e | CP-213102 | 0616 | 1 | B | AMF event correction | 17.4.0 | +| 2021-12 | CT#94e | CP-213100 | 0617 | 2 | B | UEContext for SNPN | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0618 | 1 | B | EnableGroupReachability service procedure | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0619 | 1 | B | EnableGroupReachability resource and OpenAPI definition | 17.4.0 | +| 2021-12 | CT#94e | CP-213101 | 0622 | 1 | B | AM Policy Association modification Time synchronization enhancement | 17.4.0 | +| 2021-12 | CT#94e | CP-213108 | 0623 | 2 | B | Notification for SM Policy Association Events | 17.4.0 | +| 2021-12 | CT#94e | CP-213096 | 0624 | 1 | B | Higher Resolution Timestamp for Location Estimates | 17.4.0 | +| 2021-12 | CT#94e | CP-213096 | 0625 | 1 | F | UE Positioning Capabilities Data Type | 17.4.0 | +| 2021-12 | CT#94e | CP-213085 | 0627 | 1 | F | Correction on MT service | 17.4.0 | +| 2021-12 | CT#94e | CP-213087 | 0628 | 3 | F | S-NSSAI in PDU session context | 17.4.0 | + +| | | | | | | | | +|--|--|--|--|--|--|--|--| +| | | | | | | | | +|--|--|--|--|--|--|--|--| + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------|--------| +| 2021-12 | CT#94e | CP-213138 | 0630 | 1 | A | Idle Status Indication | 17.4.0 | +| 2021-12 | CT#94e | CP-213096 | 0633 | | B | Add scheduled location time | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0641 | | B | MBSBroadcast API - ContextStatusNotify service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213097 | 0642 | | B | MBSBroadcast API – Resource Definition - ContextStatusNotify service operation | 17.4.0 | +| 2021-12 | CT#94e | CP-213117 | 0643 | | F | One time location report when the current location cannot be obtained | 17.4.0 | +| 2021-12 | CT#94e | CP-213087 | 0644 | 1 | B | Minimal Report Interval | 17.4.0 | +| 2021-12 | CT#94e | CP-213117 | 0645 | | F | Event Subscription Modification Pattern | 17.4.0 | +| 2021-12 | CT#94e | CP-213138 | 0647 | 1 | A | Immediate Reporting | 17.4.0 | +| 2021-12 | CT#94e | CP-213138 | 0649 | 1 | A | Resolve EN for Event Subscription Sync | 17.4.0 | +| 2021-12 | CT#94e | CP-213145 | 0651 | 1 | A | 5GS User State Correction | 17.4.0 | +| 2021-12 | CT#94e | CP-213148 | 0654 | 1 | A | Essential Correction on N1N2MessageSubscribe for UE Policy | 17.4.0 | +| 2021-12 | CT#94e | CP-213098 | 0655 | 1 | B | MT_EnableUEReachability supporting MUSIM | 17.4.0 | +| 2021-12 | CT#94e | CP-213098 | 0656 | | F | Update MUSIM references | 17.4.0 | +| 2021-12 | CT#94e | CP-213117 | 0657 | 1 | F | Correcting citation to N1 messages | 17.4.0 | +| 2021-12 | CT#94e | CP-213110 | 0658 | 1 | B | Addition of UEs for group based event subscription | 17.4.0 | +| 2021-12 | CT#94e | CP-213086 | 0659 | | F | 3gpp-Sbi-Consumer-Info in UE Context | 17.4.0 | +| 2021-12 | CT#94e | CP-213087 | 0660 | 1 | F | Corrections related to the description fields in the OpenAPI descriptions | 17.4.0 | +| 2021-12 | CT#94e | CP-213121 | 0661 | | F | 29.518 Rel-17 API version and External doc update | 17.4.0 | +| 2022-03 | CT#95 | CP-220023 | 0664 | | F | New application error for ProvideDomainSelectionInfo (T-ADS) for a deregistered UE | 17.5.0 | +| 2022-03 | CT#95 | CP-220072 | 0665 | | F | Correction to CreateUEContext service operation regarding 5G-SRVCC | 17.5.0 | +| 2022-03 | CT#95 | CP-220081 | 0666 | 1 | A | Release of old access resources during Intra-AMF HO between 3GPP and non-3GPP accesses | 17.5.0 | +| 2022-03 | CT#95 | CP-220084 | 0667 | 1 | A | Secondary RAT data usage reporting over N14 during Inter-AMF handover | 17.5.0 | +| 2022-03 | CT#95 | CP-220034 | 0668 | 1 | B | Schedule location time for AMF | 17.5.0 | +| 2022-03 | CT#95 | CP-220051 | 0669 | | B | RedCap indication in UE context | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0670 | | F | Miscellaneous corrections | 17.5.0 | +| 2022-03 | CT#95 | CP-220048 | 0671 | 1 | F | Correction on time synchronization error budget | 17.5.0 | +| 2022-03 | CT#95 | CP-220055 | 0672 | | F | Essential Clarification for SMF ID in N1 Container | 17.5.0 | +| 2022-03 | CT#95 | CP-220049 | 0673 | 2 | B | UE Access Behavior Trends Event | 17.5.0 | +| 2022-03 | CT#95 | CP-220049 | 0674 | 2 | B | UE Location Trends Event | 17.5.0 | +| 2022-03 | CT#95 | CP-220049 | 0675 | 1 | B | UE MM Transactions Report Event | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0676 | | B | Correct the IEs included in EnableGroupReachability request | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0677 | | B | Service operation definition of UEReachabilityInfoNotify | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0678 | 1 | B | Resource and data types definition of UEReachabilityInfoNotify | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0679 | 1 | F | Rerouted Registration Request message | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0681 | 1 | F | Corrections related to the description fields in the OpenAPI descriptions | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0682 | 1 | B | Inter-PLMN mobility of PDU sessions | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0683 | | F | Miscellaneous corrections to the Namf_MBSBroadcast API | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0684 | | B | N2 MBS Session Management Information in Namf_MBSBroadcast API | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0685 | 1 | B | N2 MBS Session Management Information in Namf_MBSCommunication API | 17.5.0 | +| 2022-03 | CT#95 | CP-220065 | 0693 | | B | Additional Subscribed Policy Request Triggers in 3GPP R17 | 17.5.0 | +| 2022-03 | CT#95 | CP-220084 | 0696 | | A | Essential Correction on Policy Trigger | 17.5.0 | +| 2022-03 | CT#95 | CP-220081 | 0698 | | A | Missing Subscribed Policy Request Triggers in 3GPP R16 | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0699 | 2 | B | SM Context Consistency Validation | 17.5.0 | +| 2022-03 | CT#95 | CP-220076 | 0701 | 1 | A | Add UE triggered policy provisioning procedure in N1MessageNotify operation | 17.5.0 | +| 2022-03 | CT#95 | CP-220079 | 0705 | | A | V-SMF removal during Inter-AMF registration | 17.5.0 | +| 2022-03 | CT#95 | CP-220049 | 0706 | | F | Removal of Editor's Note | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0707 | 1 | F | 204 No Content in subscription modification response | 17.5.0 | +| 2022-03 | CT#95 | CP-220044 | 0709 | 1 | B | Update on AMF exposure events | 17.5.0 | +| 2022-03 | CT#95 | CP-220081 | 0711 | 1 | A | 200 OK in subscription modification response | 17.5.0 | +| 2022-03 | CT#95 | CP-220066 | 0712 | | F | 29.518 Rel-17 API version and External doc update | 17.5.0 | +| 2022-06 | CT#96 | CP-221043 | 0716 | | F | N1MessageNotify for ProSe | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0717 | 1 | F | NGAP MB-SMF related IE | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0718 | 1 | F | MBS Service Area Information for Location dependent MBS session | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0719 | | F | MBS Service Area in Namf_MBSCommunication N2MessageTransfer Request | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0720 | 2 | F | Location dependent MBS broadcast session | 17.6.0 | +| 2022-06 | CT#96 | CP-221043 | 0721 | | F | pc5QoSPara attribute name in ProseContext data type | 17.6.0 | +| 2022-06 | CT#96 | CP-221027 | 0722 | | F | Correction of typos in description fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0723 | | F | Paging strategy handling for multicast MBS session | 17.6.0 | +| 2022-06 | CT#96 | CP-221039 | 0724 | | F | Disaster Roaming Registration | 17.6.0 | +| 2022-06 | CT#96 | CP-221027 | 0725 | | F | Query parameters not complying with 29.501 naming conventions | 17.6.0 | +| 2022-06 | CT#96 | CP-221045 | 0726 | 1 | F | Released PDU Sessions during Registration | 17.6.0 | +| 2022-06 | CT#96 | CP-221045 | 0727 | 1 | F | Mobility between HPLMN and VPLMN | 17.6.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|---------------------------------------------------------------------------------|--------| +| 2022-06 | CT#96 | CP-221024 | 0729 | 3 | F | Adding MBS session ID to ContextCreateRspData | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0730 | 2 | F | Adding SNSSAI to ContextCreateReqData | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0733 | 1 | F | Corrections on HTTP Response | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0734 | 1 | F | Broadcast MBS Session Release Require procedure | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0735 | | F | N2 MBS Info Change Indicator | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0736 | 1 | F | Signaling of NG-RAN Node ID from AMF to MB-SMF | 17.6.0 | +| 2022-06 | CT#96 | CP-221061 | 0738 | | A | Updp Subscription Callback Binding | 17.6.0 | +| 2022-06 | CT#96 | CP-221061 | 0740 | 2 | A | Essential Correction for PCF Bindings | 17.6.0 | +| 2022-06 | CT#96 | CP-221033 | 0741 | | F | PCF Provided UE Slice MBR in UE Context | 17.6.0 | +| 2022-06 | CT#96 | CP-221068 | 0743 | | A | SmfSellInfo in UE Context | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0745 | 1 | F | Remove non-existent ngapData in the ContextCreateReqData as required in openAPI | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0746 | 1 | B | Reporting NG-RAN failure to MB-SMF | 17.6.0 | +| 2022-06 | CT#96 | CP-221022 | 0747 | 1 | F | Event Reporting in RRC inactive state | 17.6.0 | +| 2022-06 | CT#96 | CP-221033 | 0748 | 1 | F | Subscribed-UE-Slice-MBR | 17.6.0 | +| 2022-06 | CT#96 | CP-221068 | 0750 | | A | pc5QoSPara attribute name in V2xContext data type | 17.6.0 | +| 2022-06 | CT#96 | CP-221051 | 0751 | | F | 29.518 Rel-17 API version and External doc update | 17.6.0 | +| 2022-09 | CT#97 | CP-222047 | 0754 | 1 | F | Current Location | 17.7.0 | +| 2022-09 | CT#97 | CP-222031 | 0755 | 1 | F | NGAP MB-SMF related IE | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0758 | 1 | F | Handling of N1N2MessageTransfer Failure when UE in Non-Allowed Area | 17.7.0 | +| 2022-09 | CT#97 | CP-222053 | 0760 | | F | Correct the description of the provide-loc-info and the cancel-pos-info | 17.7.0 | +| 2022-09 | CT#97 | CP-222063 | 0764 | 1 | A | MSC Server Identity in Namf_Location_EventNotify during SRVCC handover | 17.7.0 | +| 2022-09 | CT#97 | CP-222031 | 0765 | | F | Corrections for the N2MbsSmInfo data type | 17.7.0 | +| 2022-09 | CT#97 | CP-222031 | 0766 | | F | Correction for the Namf_MBSBroadcast API | 17.7.0 | +| 2022-09 | CT#97 | CP-222061 | 0768 | 1 | A | SMSF Set and Binding Info | 17.7.0 | +| 2022-09 | CT#97 | CP-222043 | 0769 | 1 | F | SMF Security and Capability in PDU Session Context | 17.7.0 | +| 2022-09 | CT#97 | CP-222054 | 0770 | 2 | F | Create UE Context with AMF Relocation | 17.7.0 | +| 2022-09 | CT#97 | CP-222065 | 0772 | 1 | A | Timestamp for Periodic Event Reporting during Mobility | 17.7.0 | +| 2022-09 | CT#97 | CP-222047 | 0774 | 1 | F | EE Subscription Notification Error Handling | 17.7.0 | +| 2022-09 | CT#97 | CP-222068 | 0776 | 1 | A | 409 Response on Xn HO and Intra-AMF N2 HO | 17.7.0 | +| 2022-09 | CT#97 | CP-222053 | 0777 | 1 | F | Essential Clarification for N2 Info Subscription | 17.7.0 | +| 2022-09 | CT#97 | CP-222068 | 0783 | | A | AMF relocation in EPS to 5GS handover | 17.7.0 | +| 2022-09 | CT#97 | CP-222035 | 0785 | 1 | F | Removal of Editor's Note | 17.7.0 | +| 2022-09 | CT#97 | CP-222036 | 0786 | 1 | F | Indication of Network Assisted Positioning method | 17.7.0 | +| 2022-09 | CT#97 | CP-222031 | 0787 | 3 | F | Clarification to OperationStatus | 17.7.0 | +| 2022-09 | CT#97 | CP-222031 | 0788 | 1 | F | Correction to ContextCreateReqData | 17.7.0 | +| 2022-09 | CT#97 | CP-222057 | 0789 | 1 | F | EPS interworking Info in UE Context | 17.7.0 | +| 2022-09 | CT#97 | CP-222058 | 0790 | | F | 29.518 Rel-17 API version and External doc update | 17.7.0 | +| 2022-09 | CT#97 | CP-222232 | 0793 | | F | Inserting missing clarification on Max Number of Reports | 17.7.0 | +| 2022-12 | CT#98 | CP-223057 | 0794 | | F | Feature bit alignment | 17.8.0 | +| 2022-12 | CT#98 | CP-223036 | 0797 | 1 | F | Add MBS Update procedure to the ContextCreate service operation | 17.8.0 | +| 2022-12 | CT#98 | CP-223060 | 0799 | 1 | F | Inter AMF mobility when UE is registered in both 3GPP and non-3GPP | 17.8.0 | +| 2022-12 | CT#98 | CP-223036 | 0801 | 1 | F | Missing clauses for Namf_MBSBroadcast Service | 17.8.0 | +| 2022-12 | CT#98 | CP-223036 | 0802 | 1 | F | Missing clauses for Namf_MBSCommunication Service | 17.8.0 | +| 2022-12 | CT#98 | CP-223099 | 0810 | 3 | A | Area of Interest Event Status from Old AMF | 17.8.0 | +| 2022-12 | CT#98 | CP-223069 | 0812 | 1 | A | Missing IMEISV in N1N2 Message Subscription | 17.8.0 | +| 2022-12 | CT#98 | CP-223051 | 0815 | 1 | F | PLMN with disaster condition | 17.8.0 | +| 2022-12 | CT#98 | CP-223062 | 0817 | 1 | F | Correction of boolean type IEs | 17.8.0 | +| 2022-12 | CT#98 | CP-223066 | 0822 | | F | 29.518 Rel-17 API version and External doc update | 17.8.0 | +| 2022-12 | CT#98 | CP-223030 | 0800 | 1 | B | Inter AMF mobility when UE is registered in SNPN with different access | 18.0.0 | +| 2022-12 | CT#98 | CP-223035 | 0803 | 1 | B | Support of RRC_INACTIVE with long eDRX | 18.0.0 | +| 2022-12 | CT#98 | CP-223036 | 0804 | | B | Multicast MBS session (de)activation or update after an AMF failure | 18.0.0 | +| 2022-12 | CT#98 | CP-223036 | 0805 | | F | MBS session update for Broadcast | 18.0.0 | +| 2022-12 | CT#98 | CP-223028 | 0806 | 1 | F | Missing mandatory status codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98 | CP-223027 | 0808 | 1 | B | Retry Timer for N1N2 Transfer Failure | 18.0.0 | +| 2022-12 | CT#98 | CP-223058 | 0813 | 3 | F | Event Subscription Termination Notification | 18.0.0 | +| 2022-12 | CT#98 | CP-223062 | 0816 | 1 | F | Value of ageOfLocationInformation | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0821 | | F | 29.518 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230039 | 0825 | 1 | B | Support Unavailability Duration in Namf_ EE API | 18.1.0 | +| 2023-03 | CT#99 | CP-230090 | 0830 | | A | Essential Corrections on Resource URI | 18.1.0 | +| 2023-03 | CT#99 | CP-230062 | 0835 | | D | Editorial correction to ContextRelease | 18.1.0 | +| 2023-03 | CT#99 | CP-230036 | 0836 | 1 | B | Protocol support for MBS Session in MOCN | 18.1.0 | +| 2023-03 | CT#99 | CP-230077 | 0838 | 1 | A | Update operation status and event for broadcast session release | 18.1.0 | +| 2023-03 | CT#99 | CP-230049 | 0839 | | F | Miscellaneous Corrections | 18.1.0 | +| 2023-03 | CT#99 | CP-230030 | 0840 | 1 | B | Parameters used to consume Namf_MT_enableUeReachability service | 18.1.0 | +| 2023-03 | CT#99 | CP-230046 | 0841 | 1 | B | Manage Event Muting Impact on NFp | 18.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------------------|--------| +| 2023-03 | CT#99 | CP-230029 | 0843 | | B | OAuth2 scopes in the Namf_MT API | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0844 | 1 | B | OAuth2 scopes in the Namf_Communication API | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0845 | 1 | B | Local LMF and GMLC selection | 18.1.0 | +| 2023-03 | CT#99 | CP-230077 | 0847 | | A | Incorrect enable-group-reachability operation resource URI in the OpenAPI | 18.1.0 | +| 2023-03 | CT#99 | CP-230088 | 0849 | | A | Add nextPeriodicReportTime IE to Namf_EventExposure OpenAPI | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0852 | 2 | B | Support of Event Report Allowed Area | 18.1.0 | +| 2023-03 | CT#99 | CP-230093 | 0855 | 1 | A | Essential Corrections on AMF Events | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0856 | 2 | B | PWS N2 Subscription Unavailability Indication | 18.1.0 | +| 2023-03 | CT#99 | CP-230094 | 0859 | 1 | A | Missed AM Policy Information in UE Context | 18.1.0 | +| 2023-03 | CT#99 | CP-230031 | 0860 | 1 | B | Multiple location report for MT-LR Immediate Location Request for the regulatory service | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0863 | 1 | B | UE Unaware Positioning | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0864 | 2 | B | Support of low power and high accuracy positioning | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0865 | 1 | B | Location service in PNI-NPN with signalling optimisation | 18.1.0 | +| 2023-03 | CT#99 | CP-230041 | 0867 | 1 | B | Satellite backhaul category change | 18.1.0 | +| 2023-03 | CT#99 | CP-230042 | 0868 | | B | Event exposure subscribed by the TSCTSF | 18.1.0 | +| 2023-03 | CT#99 | CP-230062 | 0869 | 1 | F | Correct the name of the retry after timer | 18.1.0 | +| 2023-03 | CT#99 | CP-230062 | 0870 | 1 | F | Correction on UE Context Release | 18.1.0 | +| 2023-03 | CT#99 | CP-230071 | 0872 | | F | 29.518 Rel-18 API version and External doc update | 18.1.0 | +| 2023-06 | CT#100 | CP-231028 | 0871 | 4 | F | Location header description | 18.2.0 | +| 2023-06 | CT#100 | CP-231043 | 0876 | 1 | B | Presence-In-AOI-Report event with adjustment of the AoI based on the UE's RA | 18.2.0 | +| 2023-06 | CT#100 | CP-231043 | 0877 | 1 | B | Presence-In-AOI-Report event for RAN timing synchronization status change | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 0878 | | F | Correct the table of the HTTP status code for N1N2MessageTransfer | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0879 | 1 | B | Location service bi-directional continuity between EPS and 5GS | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0880 | 2 | B | Support of PRUs | 18.2.0 | +| 2023-06 | CT#100 | CP-231047 | 0885 | | F | Correction of Event muting mechanism | 18.2.0 | +| 2023-06 | CT#100 | CP-231064 | 0886 | | F | iwkSnssai in EPS to 5GS handover procedure with AMF relocation | 18.2.0 | +| 2023-06 | CT#100 | CP-231064 | 0887 | | F | Correction on service operations in Namf_Communication service | 18.2.0 | +| 2023-06 | CT#100 | CP-231081 | 0889 | 1 | A | Pattern of path in AmfUpdateEventOptionItem | 18.2.0 | +| 2023-06 | CT#100 | CP-231083 | 0891 | | A | Add group member UE(s) for a group subscription | 18.2.0 | +| 2023-06 | CT#100 | CP-231075 | 0893 | 1 | A | Missing finer periodicities than 1s and an infinite reporting amount | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0894 | 1 | B | PRU Indication in N1N2MessageTransfer | 18.2.0 | +| 2023-06 | CT#100 | CP-231028 | 0895 | 1 | B | Omit UE IDs for Number of UEs in Area Event | 18.2.0 | +| 2023-06 | CT#100 | CP-231064 | 0898 | 3 | B | Support of RACS feature | 18.2.0 | +| 2023-06 | CT#100 | CP-231043 | 0899 | 1 | B | Service Operations for Subscription and management of network timing synchronization status monitoring | 18.2.0 | +| 2023-06 | CT#100 | CP-231043 | 0900 | 1 | B | Data Type for Subscription and management of network timing synchronization status monitoring | 18.2.0 | +| 2023-06 | CT#100 | CP-231030 | 0901 | 1 | B | SMF as the NF consumer of Namf_MT_enableUeReachability service | 18.2.0 | +| 2023-06 | CT#100 | CP-231069 | 0906 | 1 | F | Essential Correction on 202 Location Header of N1N2MessageTransfer | 18.2.0 | +| 2023-06 | CT#100 | CP-231029 | 0908 | 1 | F | Event Synchronization with No EE Subscription Indication via UECM | 18.2.0 | +| 2023-06 | CT#100 | CP-231047 | 0910 | 1 | B | Variable reporting periodicity | 18.2.0 | +| 2023-06 | CT#100 | CP-231083 | 0912 | 1 | A | Correction the name of tailList attribute in TargetArea | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0914 | 2 | B | Add reporting indication | 18.2.0 | +| 2023-06 | CT#100 | CP-231042 | 0915 | 1 | B | Update on ProseContext | 18.2.0 | +| 2023-06 | CT#100 | CP-231069 | 0917 | | F | Correct the data type UeContextTransferReqData name | 18.2.0 | +| 2023-06 | CT#100 | CP-231069 | 0918 | | F | Correct the table in provide-pos-info response | 18.2.0 | +| 2023-06 | CT#100 | CP-231048 | 0919 | 2 | B | Partially allowed Network slice | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0920 | 2 | B | Requested LMF ID is not available | 18.2.0 | +| 2023-06 | CT#100 | CP-231090 | 0923 | 1 | F | Incorrect OpenAPI definition of aoiStateList in AmfEventSubscriptionAddInfo | 18.2.0 | +| 2023-06 | CT#100 | CP-231070 | 0925 | | F | 29.518 Rel-18 API version and External doc update | 18.2.0 | +| 2023-09 | CT#101 | CP-232033 | 0928 | 1 | F | Subscription authorization in Context Transfer | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0930 | 1 | B | Updating N1messageNotification during AMF re-allocation procedure to include partially Allowed NSSAI | 18.3.0 | +| 2023-09 | CT#101 | CP-232036 | 0933 | 1 | B | HR-SBO Allowed indication during intra-PLMN Handover | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0934 | 1 | F | Event subscription rejection with UE_NOT_SERVED_BY_AMF application error | 18.3.0 | +| 2023-09 | CT#101 | CP-232046 | 0935 | 2 | B | A2X information in UE Context | 18.3.0 | +| 2023-09 | CT#101 | CP-232057 | 0937 | 1 | B | Update the ProseContext data type | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 0938 | 1 | F | Correction on Reporting Indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0939 | 1 | B | Slice Usage Control Information in UE Context | 18.3.0 | +| 2023-09 | CT#101 | CP-232063 | 0941 | | A | Missed HA GNSS Metrics Support over SBI | 18.3.0 | +| 2023-09 | CT#101 | CP-232053 | 0942 | 4 | B | Support of Mobile Base Station Relay in AMF services | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0944 | 1 | F | Correction of NGAP IE type description in N2InfoContent | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0945 | | F | Correction of Unsubscribe procedure description | 18.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232058 | 0946 | | F | Correction of references to the tables in the description | 18.3.0 | +| 2023-09 | CT#101 | CP-232049 | 0949 | 2 | B | PC5 QoS parameters related to RSPP transport over PC5 | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 0950 | 1 | B | Support on Indoor/Outdoor indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232062 | 0953 | 1 | A | Add GNSS integrity requirement | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0954 | | F | Correction on the description of DateTime | 18.3.0 | +| 2023-09 | CT#101 | CP-232049 | 0956 | 2 | B | Update on AMF service for MT procedures for ranging_SL | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0957 | | F | Correcting the definition of the maxRespTime attribute | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 0958 | 1 | B | Support on NLOS/LOS measurement indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232060 | 0959 | | F | 29.518 Rel-18 API version and External doc update | 18.3.0 | +| 2023-12 | CT#102 | CP-233037 | 0936 | 2 | B | Periodic or triggered location events via user plane to an LCS Client or AF | 18.4.0 | +| 2023-12 | CT#102 | CP-233036 | 0955 | 3 | B | Updates to support Extended DRX for RRC-INACTIVE state with CN based MT communication handling | 18.4.0 | +| 2023-12 | CT#102 | CP-233028 | 0961 | 1 | B | Event subscription not authorized by the target AMF | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0963 | 2 | B | Add LCS-UP context | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 0964 | | F | Incorrect numbering for ExpectedUeBehavior | 18.4.0 | +| 2023-12 | CT#102 | CP-233063 | 0966 | 2 | A | Correct the N2MbsSMinfo in the MBS broadcast service | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 0967 | 1 | F | Editorial corrections and adding missing attributes in the procedure description | 18.4.0 | +| 2023-12 | CT#102 | CP-233041 | 0968 | 2 | B | Updates on the RAN Timing Synchronization Status Report related N2 information | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 0971 | 1 | F | Missed Service Operations in Tables | 18.4.0 | +| 2023-12 | CT#102 | CP-233045 | 0972 | 2 | F | Clarification on muting mechanism in AMF event exposure service | 18.4.0 | +| 2023-12 | CT#102 | CP-233041 | 0976 | 1 | B | UE reconnection indication in UE context in AMF | 18.4.0 | +| 2023-12 | CT#102 | CP-233041 | 0977 | 1 | B | Update Non-UE N2 subscription and notification | 18.4.0 | +| 2023-12 | CT#102 | CP-233033 | 0978 | 1 | B | Support for resource sharing across multiple broadcast MBS Sessions during network sharing | 18.4.0 | +| 2023-12 | CT#102 | CP-233050 | 0980 | 2 | B | Update on AMF services for ranging_SL | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 0981 | 1 | F | Clarification on Unavailability Period | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0983 | 1 | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0984 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0986 | 1 | F | Reporting Indication Definition Alignment to Stage 2 | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0987 | 1 | B | Multiple QoS for Deferred Location Service Continuation from 5GS to EPS | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0988 | 2 | B | TAI Range List in AreaOfValidity | 18.4.0 | +| 2023-12 | CT#102 | CP-233041 | 0991 | 1 | F | Network Timing Synchronization Status feature in Table 6.1.8-1 | 18.4.0 | +| 2023-12 | CT#102 | CP-233041 | 0992 | 1 | B | New event filters for Presence-In-AOI-Report event subscription targeting Any UE | 18.4.0 | +| 2023-12 | CT#102 | CP-233077 | 0993 | 2 | B | Broadcast Session Transport procedure support by the ContextStatusNotify service operation | 18.4.0 | +| 2023-12 | CT#102 | CP-233040 | 0995 | 1 | F | UE_NOT_RESPONDING Application Error for 504 Response Missing | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0996 | | F | Update the support of PRU related procedures | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 1000 | 2 | F | Corrections to support Extended DRX in CM-IDLE state | 18.4.0 | +| 2023-12 | CT#102 | CP-233050 | 1003 | 1 | B | Update on delivery of N2 information for rangingsl | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 1004 | 1 | F | Update on delivery of N2 information for 5G Prose | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 1006 | | F | 29.518 Rel-18 API version and External doc update | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29519/raw.md b/raw/rel-18/29_series/29519/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..aaa812c81b143c5729d2a26eca44f09ff42e80e8 --- /dev/null +++ b/raw/rel-18/29_series/29519/raw.md @@ -0,0 +1,15645 @@ + + +# 3GPP TS 29.519 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for Exposure; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above it and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. + +Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices + +## Keywords + +## **3GPP** + +## Postal address + +3GPP support office address +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + + +# Contents + +| | | +|-----------------------------------------------------------------|----| +| Foreword..... | 10 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions and abbreviations..... | 12 | +| 3.1 Definitions..... | 12 | +| 3.2 Abbreviations..... | 12 | +| 4 Overview..... | 13 | +| 5 Usage of Nudr_DataRepository Service API for Policy Data..... | 13 | +| 5.1 Introduction..... | 13 | +| 5.2 Resources..... | 13 | +| 5.2.1 Overview..... | 13 | +| 5.2.2 Resource Structure..... | 13 | +| 5.2.3 Resource: AccessAndMobilityPolicyData..... | 18 | +| 5.2.3.1 Description..... | 18 | +| 5.2.3.2 Resource definition..... | 18 | +| 5.2.3.3 Resource Standard Methods..... | 19 | +| 5.2.3.3.1 GET..... | 19 | +| 5.2.4 Resource: UEPolicySet..... | 19 | +| 5.2.4.1 Description..... | 19 | +| 5.2.4.2 Resource definition..... | 19 | +| 5.2.4.3 Resource Standard Methods..... | 19 | +| 5.2.4.3.1 PUT..... | 19 | +| 5.2.4.3.2 PATCH..... | 20 | +| 5.2.4.3.3 GET..... | 21 | +| 5.2.5 Resource: SessionManagementPolicyData..... | 21 | +| 5.2.5.1 Description..... | 21 | +| 5.2.5.2 Resource definition..... | 21 | +| 5.2.5.3 Resource Standard Methods..... | 22 | +| 5.2.5.3.1 GET..... | 22 | +| 5.2.5.3.2 PATCH..... | 22 | +| 5.2.6 Resource: UsageMonitoringInformation..... | 23 | +| 5.2.6.1 Description..... | 23 | +| 5.2.6.2 Resource definition..... | 23 | +| 5.2.6.3 Resource Standard Methods..... | 23 | +| 5.2.6.3.1 PUT..... | 23 | +| 5.2.6.3.2 DELETE..... | 24 | +| 5.2.6.3.3 GET..... | 25 | +| 5.2.7 Resource: SponsorConnectivityData..... | 25 | +| 5.2.7.1 Description..... | 25 | +| 5.2.7.2 Resource definition..... | 25 | +| 5.2.7.3 Resource Standard Methods..... | 26 | + +## Copyright Notification + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +| | | | +|------------|-------------------------------------------------|----| +| 5.2.7.3.1 | GET..... | 26 | +| 5.2.8 | Resource: BdtData..... | 26 | +| 5.2.8.1 | Description..... | 26 | +| 5.2.8.2 | Resource definition..... | 26 | +| 5.2.8.3 | Resource Standard Methods..... | 26 | +| 5.2.8.3.1 | GET..... | 26 | +| 5.2.9 | Resource: IndividualBdtData..... | 27 | +| 5.2.9.1 | Description..... | 27 | +| 5.2.9.2 | Resource definition..... | 27 | +| 5.2.9.3 | Resource Standard Methods..... | 27 | +| 5.2.9.3.1 | GET..... | 27 | +| 5.2.9.3.2 | PUT..... | 28 | +| 5.2.9.3.3 | DELETE..... | 28 | +| 5.2.9.3.4 | PATCH..... | 29 | +| 5.2.10 | Resource: PolicyDataSubscriptions..... | 29 | +| 5.2.10.1 | Description..... | 29 | +| 5.2.10.2 | Resource definition..... | 30 | +| 5.2.10.3 | Resource Standard Methods..... | 30 | +| 5.2.10.3.1 | POST..... | 30 | +| 5.2.10.3.2 | GET..... | 30 | +| 5.2.11 | Resource: IndividualPolicyDataSubscription..... | 31 | +| 5.2.11.1 | Description..... | 31 | +| 5.2.11.2 | Resource definition..... | 31 | +| 5.2.11.3 | Resource Standard Methods..... | 32 | +| 5.2.11.3.1 | PUT..... | 32 | +| 5.2.11.3.2 | DELETE..... | 32 | +| 5.2.11.3.3 | GET..... | 33 | +| 5.2.12 | Resource: OperatorSpecificData..... | 33 | +| 5.2.12.1 | Description..... | 33 | +| 5.2.12.2 | Resource Definition..... | 33 | +| 5.2.12.3 | Resource Standard Methods..... | 34 | +| 5.2.12.3.1 | GET..... | 34 | +| 5.2.12.3.2 | PATCH..... | 34 | +| 5.2.12.3.3 | PUT..... | 35 | +| 5.2.12.3.4 | DELETE..... | 36 | +| 5.2.13 | Resource: PlmnUePolicySet..... | 36 | +| 5.2.13.1 | Description..... | 36 | +| 5.2.13.2 | Resource definition..... | 36 | +| 5.2.13.3 | Resource Standard Methods..... | 37 | +| 5.2.13.3.1 | GET..... | 37 | +| 5.2.14 | Resource: PolicyDataForIndividualUe..... | 37 | +| 5.2.14.1 | Description..... | 37 | +| 5.2.14.2 | Resource definition..... | 37 | +| 5.2.14.3 | Resource Standard Methods..... | 37 | +| 5.2.14.3.1 | GET..... | 37 | +| 5.2.15 | Resource: SlicePolicyControlData..... | 38 | +| 5.2.15.1 | Description..... | 38 | +| 5.2.15.2 | Resource definition..... | 38 | +| 5.2.15.3 | Resource Standard Methods..... | 38 | +| 5.2.15.3.1 | GET..... | 38 | +| 5.2.15.3.2 | PATCH..... | 39 | +| 5.2.16 | Resource: MBSSessionPolicyControlData..... | 40 | +| 5.2.16.1 | Description..... | 40 | +| 5.2.16.2 | Resource definition..... | 40 | +| 5.2.16.3 | Resource Standard Methods..... | 40 | +| 5.2.16.3.1 | GET..... | 40 | +| 5.2.17 | Resource: PdtqData..... | 40 | +| 5.2.17.1 | Description..... | 40 | +| 5.2.17.2 | Resource definition..... | 40 | +| 5.2.17.3 | Resource Standard Methods..... | 41 | +| 5.2.17.3.1 | GET..... | 41 | + +| | | | +|------------|------------------------------------------|----| +| 5.2.18 | Resource: IndividualPdtqData..... | 41 | +| 5.2.18.1 | Description..... | 41 | +| 5.2.18.2 | Resource definition..... | 41 | +| 5.2.18.3 | Resource Standard Methods..... | 42 | +| 5.2.18.3.1 | GET..... | 42 | +| 5.2.18.3.2 | PUT..... | 42 | +| 5.2.18.3.3 | DELETE..... | 43 | +| 5.2.18.3.4 | PATCH..... | 43 | +| 5.2.19 | Resource: GroupPolicyControlData..... | 44 | +| 5.2.19.1 | Description..... | 44 | +| 5.2.19.2 | Resource definition..... | 44 | +| 5.2.19.3 | Resource Standard Methods..... | 44 | +| 5.2.19.3.1 | GET..... | 44 | +| 5.2.19.3.2 | PATCH..... | 45 | +| 5.3 | Notifications..... | 45 | +| 5.3.1 | General..... | 45 | +| 5.3.2 | Policy Data Change Notification..... | 46 | +| 5.4 | Data Model..... | 46 | +| 5.4.1 | General..... | 46 | +| 5.4.2 | Structured data types..... | 50 | +| 5.4.2.1 | Introduction..... | 50 | +| 5.4.2.2 | Type AmPolicyData..... | 50 | +| 5.4.2.3 | Type UePolicySection..... | 50 | +| 5.4.2.4 | Type UePolicySet..... | 51 | +| 5.4.2.5 | Type SmPolicyData..... | 52 | +| 5.4.2.6 | Type UsageMonDataLimit..... | 53 | +| 5.4.2.7 | Type UsageMonData..... | 54 | +| 5.4.2.8 | Type SponsorConnectivityData..... | 54 | +| 5.4.2.9 | Type BdtData..... | 55 | +| 5.4.2.10 | Type PolicyDataSubscription..... | 56 | +| 5.4.2.11 | Type PolicyDataChangeNotification..... | 58 | +| 5.4.2.12 | Type TimePeriod..... | 60 | +| 5.4.2.13 | Type UsageMonDataScope..... | 60 | +| 5.4.2.14 | Type SmPolicySnssaiData..... | 60 | +| 5.4.2.15 | Type SmPolicyDnnData..... | 61 | +| 5.4.2.16 | Type LimitIdToMonitoringKey..... | 63 | +| 5.4.2.17 | Type UePolicySetPatch..... | 63 | +| 5.4.2.18 | Type PlmnRouteSelectionDescriptor..... | 63 | +| 5.4.2.19 | Type SnssaiRouteSelectionDescriptor..... | 63 | +| 5.4.2.20 | Type DnnRouteSelectionDescriptor..... | 64 | +| 5.4.2.21 | Type SmPolicyDataPatch..... | 64 | +| 5.4.2.22 | Type SmPolicySnssaiDataPatch..... | 64 | +| 5.4.2.23 | Type SmPolicyDnnDataPatch..... | 65 | +| 5.4.2.24 | Type ResourceItem..... | 65 | +| 5.4.2.25 | Type NotificationItem..... | 65 | +| 5.4.2.26 | Type UpdatedItem..... | 65 | +| 5.4.2.27 | Type BdtDataPatch..... | 66 | +| 5.4.2.28 | Type PolicyDataForIndividualUe..... | 66 | +| 5.4.2.29 | Type SlicePolicyData..... | 67 | +| 5.4.2.31 | Type MbsSessPolCtrlData..... | 68 | +| 5.4.2.32 | Type MbsSessPolDataId..... | 68 | +| 5.4.2.33 | Type PdtqData..... | 69 | +| 5.4.2.34 | Type PdtqDataPatch..... | 70 | +| 5.4.2.35 | Type GroupPolicyData..... | 70 | +| 5.4.3 | Simple data types and enumerations..... | 71 | +| 5.4.3.1 | Introduction..... | 71 | +| 5.4.3.2 | Simple data types..... | 71 | +| 5.4.3.3 | Enumeration: UsageMonLevel..... | 71 | +| 5.4.3.4 | Enumeration: Periodicity..... | 71 | +| 5.4.3.5 | Enumeration: BdtPolicyStatus..... | 72 | +| 5.4.3.7 | void..... | 72 | + +| | | | +|------------|--------------------------------------------------------------------|----| +| 5.5 | Error handling..... | 72 | +| 5.5.1 | General..... | 72 | +| 5.5.2 | Protocol Errors..... | 72 | +| 5.5.3 | Application Errors..... | 73 | +| 5.6 | Feature negotiation..... | 73 | +| 6 | Usage of Nudr_DataRepository Service API for Application Data..... | 73 | +| 6.1 | Introduction..... | 73 | +| 6.2 | Resources..... | 73 | +| 6.2.1 | Overview..... | 73 | +| 6.2.2 | Resource Structure..... | 73 | +| 6.2.3 | Resource: PFD Data..... | 78 | +| 6.2.3.1 | Description..... | 78 | +| 6.2.3.2 | Resource definition..... | 78 | +| 6.2.3.3 | Resource Standard Methods..... | 78 | +| 6.2.3.3.1 | GET..... | 78 | +| 6.2.4 | Resource: Individual PFD Data..... | 79 | +| 6.2.4.1 | Description..... | 79 | +| 6.2.4.2 | Resource definition..... | 79 | +| 6.2.4.3 | Resource Standard Methods..... | 79 | +| 6.2.4.3.1 | GET..... | 79 | +| 6.2.4.3.2 | DELETE..... | 80 | +| 6.2.4.3.3 | PUT..... | 80 | +| 6.2.5 | Resource: Influence Data..... | 81 | +| 6.2.5.1 | Description..... | 81 | +| 6.2.5.2 | Resource definition..... | 81 | +| 6.2.5.3 | Resource Standard Methods..... | 81 | +| 6.2.5.3.1 | GET..... | 81 | +| 6.2.6 | Resource: Individual Influence Data..... | 83 | +| 6.2.6.1 | Description..... | 83 | +| 6.2.6.2 | Resource definition..... | 83 | +| 6.2.6.3 | Resource Standard Methods..... | 83 | +| 6.2.6.3.1 | PUT..... | 83 | +| 6.2.6.3.2 | PATCH..... | 84 | +| 6.2.6.3.3 | DELETE..... | 84 | +| 6.2.7 | Resource: Influence Data Subscription..... | 85 | +| 6.2.7.1 | Description..... | 85 | +| 6.2.7.2 | Resource definition..... | 85 | +| 6.2.7.3 | Resource Standard Methods..... | 85 | +| 6.2.7.3.1 | POST..... | 85 | +| 6.2.7.3.2 | GET..... | 86 | +| 6.2.8 | Resource: Individual Influence Data Subscription..... | 87 | +| 6.2.8.1 | Description..... | 87 | +| 6.2.8.2 | Resource definition..... | 87 | +| 6.2.8.3 | Resource Standard Methods..... | 87 | +| 6.2.8.3.1 | GET..... | 87 | +| 6.2.8.3.2 | PUT..... | 87 | +| 6.2.8.3.3 | DELETE..... | 88 | +| 6.2.9 | Resource: Applied BDT Policy Data..... | 88 | +| 6.2.9.1 | Description..... | 88 | +| 6.2.9.2 | Resource definition..... | 88 | +| 6.2.9.3 | Resource Standard Methods..... | 89 | +| 6.2.9.3.1 | GET..... | 89 | +| 6.2.10 | Resource: Individual Applied BDT Policy Data..... | 90 | +| 6.2.10.1 | Description..... | 90 | +| 6.2.10.2 | Resource definition..... | 90 | +| 6.2.10.3 | Resource Standard Methods..... | 90 | +| 6.2.10.3.1 | PUT..... | 90 | +| 6.2.10.3.2 | PATCH..... | 91 | +| 6.2.10.3.3 | DELETE..... | 91 | +| 6.2.11 | Resource: IPTV Configurations..... | 92 | +| 6.2.11.1 | Description..... | 92 | + +| | | | +|------------|-----------------------------------------------------------|-----| +| 6.2.11.2 | Resource definition..... | 92 | +| 6.2.11.3 | Resource Standard Methods..... | 92 | +| 6.2.11.3.1 | GET..... | 92 | +| 6.2.12 | Resource: Individual IPTV Configuration..... | 93 | +| 6.2.12.1 | Description..... | 93 | +| 6.2.12.2 | Resource definition..... | 93 | +| 6.2.12.3 | Resource Standard Methods..... | 93 | +| 6.2.12.3.1 | PUT..... | 93 | +| 6.2.12.3.2 | DELETE..... | 94 | +| 6.2.12.3.3 | PATCH..... | 94 | +| 6.2.13 | Resource: ApplicationDataSubscriptions..... | 95 | +| 6.2.13.1 | Description..... | 95 | +| 6.2.13.2 | Resource definition..... | 95 | +| 6.2.13.3 | Resource Standard Methods..... | 95 | +| 6.2.13.3.1 | POST..... | 95 | +| 6.2.13.3.2 | GET..... | 96 | +| 6.2.14 | Resource: IndividualApplicationDataSubscription..... | 97 | +| 6.2.14.1 | Description..... | 97 | +| 6.2.14.2 | Resource definition..... | 97 | +| 6.2.14.3 | Resource Standard Methods..... | 97 | +| 6.2.14.3.1 | PUT..... | 97 | +| 6.2.14.3.2 | DELETE..... | 97 | +| 6.2.14.3.3 | GET..... | 98 | +| 6.2.15 | Resource: Service Parameter Data..... | 98 | +| 6.2.15.1 | Description..... | 98 | +| 6.2.15.2 | Resource definition..... | 98 | +| 6.2.15.3 | Resource Standard Methods..... | 99 | +| 6.2.15.3.1 | GET..... | 99 | +| 6.2.16 | Resource: Individual Service Parameter Data..... | 101 | +| 6.2.16.1 | Description..... | 101 | +| 6.2.16.2 | Resource definition..... | 101 | +| 6.2.16.3 | Resource Standard Methods..... | 102 | +| 6.2.16.3.1 | PUT..... | 102 | +| 6.2.16.3.2 | PATCH..... | 102 | +| 6.2.16.3.3 | DELETE..... | 103 | +| 6.2.17 | Resource: AM Influence Data..... | 103 | +| 6.2.17.1 | Description..... | 103 | +| 6.2.17.2 | Resource definition..... | 103 | +| 6.2.17.3 | Resource Standard Methods..... | 104 | +| 6.2.17.3.1 | GET..... | 104 | +| 6.2.18 | Resource: Individual AM Influence Data..... | 105 | +| 6.2.18.1 | Description..... | 105 | +| 6.2.18.2 | Resource definition..... | 105 | +| 6.2.18.3 | Resource Standard Methods..... | 106 | +| 6.2.18.3.1 | PUT..... | 106 | +| 6.2.18.3.2 | PATCH..... | 106 | +| 6.2.18.3.3 | DELETE..... | 107 | +| 6.2.19 | Resource: EAS Deployment Information Data..... | 107 | +| 6.2.19.1 | Description..... | 107 | +| 6.2.19.2 | Resource definition..... | 107 | +| 6.2.19.3 | Resource Standard Methods..... | 108 | +| 6.2.19.3.1 | GET..... | 108 | +| 6.2.20 | Resource: Individual EAS Deployment Information Data..... | 108 | +| 6.2.20.1 | Description..... | 108 | +| 6.2.20.2 | Resource definition..... | 108 | +| 6.2.20.3 | Resource Standard Methods..... | 109 | +| 6.2.20.3.1 | GET..... | 109 | +| 6.2.20.3.2 | PUT..... | 109 | +| 6.2.20.3.3 | DELETE..... | 110 | +| 6.2.21 | Resource: AF Requested QoS Data Sets..... | 110 | +| 6.2.21.1 | Description..... | 110 | + +| | | | +|------------|-----------------------------------------------------|-----| +| 6.2.21.2 | Resource definition..... | 110 | +| 6.2.21.3 | Resource Standard Methods..... | 111 | +| 6.2.21.3.1 | GET..... | 111 | +| 6.2.22 | Resource: Individual AF Requested QoS Data Set..... | 112 | +| 6.2.22.1 | Description..... | 112 | +| 6.2.22.2 | Resource definition..... | 112 | +| 6.2.22.3 | Resource Standard Methods..... | 112 | +| 6.2.22.3.1 | PUT..... | 112 | +| 6.2.22.3.2 | PATCH..... | 113 | +| 6.2.22.3.3 | DELETE..... | 113 | +| 6.2.23 | Resource: Individual DNAI EAS Mapping..... | 114 | +| 6.2.23.1 | Description..... | 114 | +| 6.2.23.2 | Resource definition..... | 114 | +| 6.2.23.3 | Resource Standard Methods..... | 114 | +| 6.2.23.3.1 | GET..... | 114 | +| 6.2.24 | Resource: ECS Address Roaming Data..... | 115 | +| 6.2.24.1 | Description..... | 115 | +| 6.2.24.2 | Resource definition..... | 115 | +| 6.2.24.3 | Resource Standard Methods..... | 115 | +| 6.2.24.3.1 | GET..... | 115 | +| 6.2.25 | Resource: Individual ECS Address Roaming Data..... | 116 | +| 6.2.25.1 | Description..... | 116 | +| 6.2.25.2 | Resource definition..... | 116 | +| 6.2.25.3 | Resource Standard Methods..... | 116 | +| 6.2.25.3.1 | GET..... | 116 | +| 6.2.25.3.2 | PUT..... | 116 | +| 6.2.25.3.3 | DELETE..... | 117 | +| 6.3 | Notifications..... | 118 | +| 6.3.1 | General..... | 118 | +| 6.3.2 | Void..... | 118 | +| 6.3.3 | Influence Data Update Notification..... | 118 | +| 6.3.3.1 | Description..... | 118 | +| 6.3.3.2 | Operation Definition..... | 118 | +| 6.3.4 | Application Data Change Notification..... | 119 | +| 6.4 | Data Model..... | 119 | +| 6.4.1 | General..... | 119 | +| 6.4.2 | Structured data types..... | 123 | +| 6.4.2.1 | Introduction..... | 123 | +| 6.4.2.2 | Type TrafficInfluData..... | 124 | +| 6.4.2.5 | Void..... | 130 | +| 6.4.2.6 | Type: PfdDataForAppExt..... | 130 | +| 6.4.2.7 | Type BdtPolicyData..... | 130 | +| 6.4.2.9 | Type IptvConfigData..... | 131 | +| 6.4.2.10 | Type ApplicationDataSubs..... | 132 | +| 6.4.2.11 | Type ApplicationDataChangeNotif..... | 133 | +| 6.4.2.12 | Type DataFilter..... | 134 | +| 6.4.2.13 | Void..... | 136 | +| 6.4.2.14 | Type TrafficInfluDataNotif..... | 136 | +| 6.4.2.15 | Type ServiceParameterData..... | 137 | +| 6.4.2.15A | Type ServiceParameterDataPatch..... | 139 | +| 6.4.2.16 | Type AmInfluData..... | 141 | +| 6.4.2.17 | Type AmInfluDataPatch..... | 142 | +| 6.4.2.18 | Type AfRequestedQosData..... | 143 | +| 6.4.2.19 | Type AfRequestedQosDataPatch..... | 144 | +| 6.4.2.20 | Type TrafficCorrelationInfo..... | 145 | +| 6.4.2.21 | Type DnaiEasMapping..... | 145 | +| 6.4.2.22 | Type DnaiEasInfo..... | 145 | +| 6.4.2.23 | Type EcsAddrData..... | 146 | +| 6.4.3 | Simple data types and enumerations..... | 146 | +| 6.4.3.1 | Introduction..... | 146 | +| 6.4.3.2 | Simple data types..... | 146 | + +| | | | +|-----------|--------------------------------------------------------------------------------|-----| +| 6.4.3.3 | Enumeration: DataInd..... | 146 | +| 6.4.3.4 | Enumeration: CorrelationType..... | 147 | +| 6.5 | Error handling..... | 147 | +| 6.5.1 | General..... | 147 | +| 6.5.2 | Protocol Errors..... | 147 | +| 6.5.3 | Application Errors..... | 147 | +| 6.6 | Feature negotiation..... | 147 | +| 7 | Usage of Nudr_DataRepository Service API for Structured Data for Exposure..... | 147 | +| 7.1 | Introduction..... | 147 | +| 7.2 | Resources..... | 148 | +| 7.2.1 | Overview..... | 148 | +| 7.2.2 | Resource Structure..... | 148 | +| 7.2.3 | Resource: AccessAndMobilityData..... | 149 | +| 7.2.3.1 | Description..... | 149 | +| 7.2.3.2 | Resource definition..... | 149 | +| 7.2.3.3 | Resource Standard Methods..... | 149 | +| 7.2.3.3.1 | PUT..... | 149 | +| 7.2.3.3.2 | GET..... | 150 | +| 7.2.3.3.3 | DELETE..... | 151 | +| 7.2.3.3.4 | PATCH..... | 151 | +| 7.2.4 | Resource: PduSessionManagementData..... | 151 | +| 7.2.4.1 | Description..... | 151 | +| 7.2.4.2 | Resource definition..... | 152 | +| 7.2.4.3 | Resource Standard Methods..... | 152 | +| 7.2.4.3.1 | PUT..... | 152 | +| 7.2.4.3.2 | GET..... | 153 | +| 7.2.4.3.3 | DELETE..... | 153 | +| 7.2.5 | Resource: ExposureDataSubscriptions..... | 154 | +| 7.2.5.1 | Description..... | 154 | +| 7.2.5.2 | Resource Definition..... | 154 | +| 7.2.5.3 | Resource Standard Methods..... | 154 | +| 7.2.5.3.1 | POST..... | 154 | +| 7.2.6 | Resource: IndividualExposureDataSubscription..... | 155 | +| 7.2.6.1 | Description..... | 155 | +| 7.2.6.2 | Resource Definition..... | 155 | +| 7.2.6.3 | Resource Standard Methods..... | 155 | +| 7.2.6.3.1 | PUT..... | 155 | +| 7.2.6.3.2 | DELETE..... | 155 | +| 7.3 | Data Model..... | 156 | +| 7.3.1 | General..... | 156 | +| 7.3.2 | Structured data types..... | 157 | +| 7.3.2.1 | Introduction..... | 157 | +| 7.3.2.2 | Type AccessAndMobilityData..... | 158 | +| 7.3.2.3 | Type PduSessionManagementData..... | 159 | +| 7.3.2.4 | Type ExposureDataSubscription..... | 160 | +| 7.3.2.5 | Type ExposureDataChangeNotification..... | 161 | +| 7.3.3 | Simple data types and enumerations..... | 161 | +| 7.3.3.1 | Introduction..... | 161 | +| 7.3.3.2 | Simple data types..... | 161 | +| 7.3.3.3 | Enumeration: PduSessionStatus..... | 161 | +| 7.4 | Error handling..... | 161 | +| 7.4.1 | General..... | 161 | +| 7.4.2 | Protocol Errors..... | 162 | +| 7.4.3 | Application Errors..... | 162 | +| 7.5 | Feature negotiation..... | 162 | +| 7.6 | Notifications..... | 162 | +| 7.6.1 | General..... | 162 | +| 7.6.2 | Exposure Data Change Notification..... | 162 | + +**Annex A (normative): OpenAPI specification..... 163** + +A.1 General..... 163 + +A.2 Nudr\_DataRepository API for Policy Data..... 163 + +A.3 Nudr\_DataRepository API for Application Data..... 205 + +A.4 Nudr\_DataRepository API for Exposure Data..... 261 + +**Annex B (informative): Change history..... 274** + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd 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. + +# 1 Scope + +The present specification provides the stage 3 definition for the usage of the Unified Data Repository service (Nudr\_DataRepository) of 5G System for Policy Data, Application Data and Structured Data for Exposure. + +The Unified Data Repository (UDR) provides the Unified Data Repository service. This service provides a repository for policy data, application data and exposure data. + +The stage 3 protocol definition for Nudr Service Based Interface which is common for subscription data, policy data, application data and exposure data is specified in 3GPP TS 29.504 [6]. + +# 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] Void. +- [3] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 29.504: "5G System; Unified Data Repository Services; Stage 3". +- [7] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [8] 3GPP TS 29.551: "5G System; Packet Flow Description Management Service; Stage 3". +- [9] 3GPP TS 29.122: "T8 reference point for Northbound APIs". +- [10] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [11] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [12] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [13] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". +- [14] Void. +- [15] 3GPP TS 29.505: "5G System; Usage of the Unified Data Repository services for Subscription Data; Stage 3". +- [16] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [17] IETF RFC 4122: "A Universally Unique Identifier (UUID) URN Namespace". +- [18] 3GPP TR 21.900: "Technical Specification Group working methods". +- [19] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". + +- [20] IETF RFC 6901: "JavaScript Object Notation (JSON) Pointer". +- [21] IETF RFC 9110: "HTTP Semantics". +- [22] 3GPP TS 29.534: "5G System; Access and Mobility Policy Authorization Service; Stage 3". +- [23] 3GPP TS 29.591: "5G System; Network Exposure Function Southbound Services; Stage 3". +- [24] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [25] 3GPP TS 29.543: "5G System; Data Transfer Policy Control Services; Stage 3". +- [26] 3GPP TS 32.421: "Telecommunication management; Subscriber and equipment trace; Trace concepts and requirements". +- [27] 3GPP TS 29.565: "5G System; Time Sensitive Communication and Time Synchronization Function Services; Stage 3". + +--- + +## 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]. + +| | | +|---------|-------------------------------------------------------| +| A2X | Aircraft-to-Everything | +| AM | Access and Mobility Management | +| ATSSS | Access Traffic Steering, Switching, Splitting | +| BDT | Background Data Transfer | +| DNAI | DN Access Identifier | +| DNN | Data Network Name | +| EAS | Edge Application Server | +| ECS | Edge Configuration Server | +| GPSI | Generic Public Subscription Identifier | +| JSON | JavaScript Object Notation | +| MA | Multi Access | +| NEF | Network Exposure Function | +| NR | New Radio | +| NRF | Network Repository Function | +| PCF | Policy Control Function | +| PDTQ | Planned Data Transfer with QoS requirements | +| PFD | Packet Flow Description | +| PSA | PDU Session Anchor | +| SFC | Service Function Chain | +| SM | Session Management | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SUPI | Subscription Permanent Identifier | +| TNAP | Trusted Network Access Point | +| UDR | Unified Data Repository | +| UPF | User Plane Function | +| UPSI | UE Policy Section Identifier | +| URSP | UE Route Selection Policy | + +--- + +## 4 Overview + +The resources, data model and usage defined in the present document are used by the 5GC NFs (e.g. PCF, NEF) to access the policy data, application data or exposure data via the Unified Data Repository services as specified in 3GPP TS 29.504 [6]. + +--- + +## 5 Usage of Nudr\_DataRepository Service API for Policy Data + +### 5.1 Introduction + +The following clauses specify the usage of Nudr\_DataRepository service for policy data. The principles specified in 3GPP TS 29.504 [6] are followed unless explicitly specified otherwise in the following clauses. + +### 5.2 Resources + +#### 5.2.1 Overview + +This clause specifies the resources for the usage of the Unified Data Repository service for Policy Data. + +#### 5.2.2 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.2.2-1 depicts the resource URIs structure for the Nudr\_DataRepository API for policy data. + + + +![A hierarchical tree diagram showing the structure of API paths under {apiRoot}/nudr-dr/. The root path is /policy-data. Sub-paths include /ues, /sponsor-connectivity-data, /bdt-data, /subs-to-notify, /plmns, /slice-control-data, /mbs-session-pol-data, and /pdtq-data. Each sub-path has associated resource identifiers in curly braces, such as {ueId}, {sponsorId}, {bdtReferenceId}, {subsId}, {plmnId}, {snssai}, {polSessionId}, and {pdtqReferenceId}. Further sub-resources like /am-data, /ue-policy-set, /sm-data, and /operator-specific-data are shown under /ues/{ueId}. /sm-data has a {usageMonId} sub-resource. /ue-policy-set is also shown under /plmns/{plmnId}.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` +graph TD; Root["{apiRoot}/nudr-dr/"] --> PolicyData["/policy-data"]; PolicyData --> Ues["/ues"]; PolicyData --> SponsorData["/sponsor-connectivity-data"]; PolicyData --> BdtData["/bdt-data"]; PolicyData --> SubsNotify["/subs-to-notify"]; PolicyData --> Plmns["/plmns"]; PolicyData --> SliceControlData["/slice-control-data"]; PolicyData --> MbsSessionPolData["/mbs-session-pol-data"]; PolicyData --> PdtqData["/pdtq-data"]; Ues --> UeId["/{ueId}"]; UeId --> AmData["/am-data"]; UeId --> UePolicySet1["/ue-policy-set"]; UeId --> SmData["/sm-data"]; UeId --> OperatorSpecificData["/operator-specific-data"]; SmData --> UsageMonId["/{usageMonId}"]; SponsorData --> SponsorId["/{sponsorId}"]; BdtData --> BdtReferenceId["/{bdtReferenceId}"]; SubsNotify --> SubsId["/{subsId}"]; Plmns --> PlmnId["/{plmnId}"]; PlmnId --> UePolicySet2["/ue-policy-set"]; SliceControlData --> Snssai["/{snssai}"]; MbsSessionPolData --> PolSessionId["/{polSessionId}"]; PdtqData --> PdtqReferenceId["/{pdtqReferenceId}"]; +``` + +A hierarchical tree diagram showing the structure of API paths under {apiRoot}/nudr-dr/. The root path is /policy-data. Sub-paths include /ues, /sponsor-connectivity-data, /bdt-data, /subs-to-notify, /plmns, /slice-control-data, /mbs-session-pol-data, and /pdtq-data. Each sub-path has associated resource identifiers in curly braces, such as {ueId}, {sponsorId}, {bdtReferenceId}, {subsId}, {plmnId}, {snssai}, {polSessionId}, and {pdtqReferenceId}. Further sub-resources like /am-data, /ue-policy-set, /sm-data, and /operator-specific-data are shown under /ues/{ueId}. /sm-data has a {usageMonId} sub-resource. /ue-policy-set is also shown under /plmns/{plmnId}. + +**Figure 5.2.2-1: Resource URI structure of the Nudr\_DataRepository API for policy data** + +Table 5.2.2-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.2.2-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------|----------------------------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PolicyDataForIndividualUe | /policy-data/ues/{ueId} | GET | Retrieve multiple policy data sets (access and mobility policy data, UE policy set data, session management policy data, usage monitoring data, operator specific policy data) for a subscriber. | +| AccessAndMobilityPolicyData | /policy-data/ues/{ueId}/am-data | GET | Retrieve the access and mobility policy data for a subscriber. | +| UEPolicySet | /policy-data/ues/{ueId}/ue-policy-set | GET | Retrieve the UE policy set data for a subscriber. | +| | | PUT | Create or modify the UE policy set data for a subscriber. | +| | | PATCH | Modify the UE policy set data for a subscriber. | +| SessionManagementPolicyData | /policy-data/ues/{ueId}/sm-data | GET | Retrieve the session management policy data for a subscriber. | +| | | PATCH | When the feature "SessionManagementPolicyDataPatch" is supported, modify the session management policy data for a subscriber. | +| UsageMonitoringInformation | /policy-data/ues/{ueId}/sm-data/{usageMonId} | GET | Retrieve a usage monitoring resource. | +| | | PUT | Create a usage monitoring resource. | +| | | DELETE | Delete a usage monitoring resource. | +| OperatorSpecificData | /policy-data/ues/{ueId}/operator-specific-data | GET | Retrieve the operator specific policy data of a UE | +| | | PATCH | Modify the operator specific policy data of a UE. | +| | | PUT | Create or modify the operator specific policy data of a UE. | +| | | DELETE | Delete the operator specific policy data for a UE. | +| SponsorConnectivityData | /policy-data/sponsor-connectivity-data/{sponsorId} | GET | Retrieve the sponsored connectivity information for a given sponsorId. | +| BdtData | /policy-data/bdt-data | GET | Retrieve the BDT data collection. | +| IndividualBdtData | /policy-data/bdt-data/{bdtReferenceId} | GET | Retrieve the BDT data information associated with a BDT reference Id. | +| | | PUT | Create a BDT data resource associated with a BDT reference Id. | +| | | PATCH | Modifies an BDT data resource associated with an BDT reference Id. | +| | | DELETE | Delete a BDT data resource associated with a BDT reference Id. | +| PolicyDataSubscriptions | /policy-data/subs-to-notify | GET | Retrieve Individual Policy Data Subscriptions from the Policy Data Subscriptions collection. | +| | | POST | Create a subscription to receive notifications of policy data changes. | +| IndividualPolicyDataSubscription | /policy-data/subs-to-notify/{subsId} | GET | Retrieve a subscription identified by {subsId}. | +| | | PUT | Modify a subscription to receive | + +| | | | | +|----------------------------|--------------------------------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------| +| | | | notifications of policy data changes. | +| | | DELETE | Delete a subscription identified by {subsId}. | +| PlmnUePolicySet | /policy-data/plmns/{plmnId}/ue-policy-set | GET | Retrieve the UE policy set data for an H-PLMN. | +| SlicePolicyControlData | /policy-data/slice-control-data/{snssai} | GET | Retrieve network slice specific policy control data for a given S-NSSAI. | +| | | PATCH | Modify network slice specific policy control data for a given S-NSSAI. | +| MBSessionPolicyControlData | /policy-data/mbs-session-pol-data/{polSessionId} | GET | Retrieve MBS Session Policy Control Data for an MBS Session based on the MBS Session Identifier or an AF Application Identifier. | +| PdtqData | /policy-data/pdtq-data | GET | Retrieve the PDTQ data collection. | +| IndividualPdtqData | /policy-data/pdtq-data/{pdtqReferenceId} | GET | Retrieve the PDTQ data information associated with a PDTQ reference Id. | +| | | PUT | Create a PDTQ data resource associated with a PDTQ reference Id. | +| | | PATCH | Modifies a PDTQ data resource associated with an PDTQ reference Id. | +| | | DELETE | Delete a PDTQ data resource associated with a PDTQ reference Id. | +| GroupPolicyControlData | /policy-data/group-control-data/{intGroupId} | GET | Retrieve group specific policy control data for a 5G VN group. | +| | | PATCH | Modify group specific policy control data for a 5G VN group. | + +## 5.2.3 Resource: AccessAndMobilityPolicyData + +### 5.2.3.1 Description + +The resource represents all UE related mobility and access policies attributes in the UDR for a given "ueId". + +### 5.2.3.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/ues/{ueId}/am-data + +This resource shall support the resource URI variables defined in table 5.2.3.2-1. + +**Table 5.2.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7]. | + +### 5.2.3.3 Resource Standard Methods + +#### 5.2.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.3.3.1-1. + +**Table 5.2.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.2.3.3.1-2 and the response data structures and response codes specified in table 5.2.3.3.1-3. + +**Table 5.2.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.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------| +| AmPolicyData | M | 1 | 200 OK | Upon success, a response body containing access and mobility policies shall be returned. | +| 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. | | | | | + +### 5.2.4 Resource: UEPolicySet + +#### 5.2.4.1 Description + +The resource represents UE policy set for a given "ueId" stored in the UDR of the H-PLMN. + +#### 5.2.4.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/ues/{ueId}/ue-policy-set + +This resource shall support the resource URI variables defined in table 5.2.4.2-1. + +**Table 5.2.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1 | +| ueId | VarUeld | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeld is defined in 3GPP TS 29.571 [7]. | + +#### 5.2.4.3 Resource Standard Methods + +##### 5.2.4.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.4.3.1-1. + +**Table 5.2.4.3.1-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.2.4.3.1-2 and the response data structures and response codes specified in table 5.2.4.3.1-3. + +**Table 5.2.4.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|---------------------------------------------------------------------| +| UePolicySet | M | 1 | Create or modify the UE policy set resource for a given subscriber. | + +**Table 5.2.4.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UePolicySet | M | 1 | 201 Created | Successful case.
The resource has been successfully created and a response body containing a representation of the created UePolicySet resource shall be returned. | +| UePolicySet | M | 1 | 200 OK | Successful case.
The resource has been successfully updated and a response body containing UE policies shall be returned. | +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. | + +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.2.4.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}/nudr-dr//policy-data/ues/{ueId}/ue-policy-set | + +## 5.2.4.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.2.4.3.2-1. + +**Table 5.2.4.3.2-1: URI query parameters supported by the PATCH 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.4.3.2-2 and the response data structures and response codes specified in table 5.2.4.3.2-3. + +**Table 5.2.4.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------| +| UePolicySetPatch | M | 1 | Modify the UE policy set resource for a given subscriber. | + +**Table 5.2.4.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 5.2.4.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.4.3.3-1. + +**Table 5.2.4.3.3-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.2.4.3.3-2 and the response data structures and response codes specified in table 5.2.4.3.3-3. + +**Table 5.2.4.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.4.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------| +| UePolicySet | M | 1 | 200 OK | Upon success, a response body containing the UE policies shall be returned. | +| 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. | | | | | + +## 5.2.5 Resource: SessionManagementPolicyData + +### 5.2.5.1 Description + +The resource represents all PDU session related subscription attributes in the UDR for a given ueId. + +### 5.2.5.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/ues/{ueId}/sm-data + +This resource shall support the resource URI variables defined in table 5.2.5.2-1. + +**Table 5.2.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7]. | + +### 5.2.5.3 Resource Standard Methods + +#### 5.2.5.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.5.3.1-1. + +**Table 5.2.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| snssai | Snssai | O | 0..1 | Identifies a Single Network Slice Selection Assistance Information. | +| dnn | Dnn | O | 0..1 | Identifies a Data Network Name. | +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supp-feat | SupportedFeatures | O | 0..1 | Identifies the features supported by the NF service consumer. | + +When an optional query parameter is not included, the UDR shall return session management policy data per DNN matching the value of the included query parameter(s) for all the possible values of the omitted query parameter. E.g. if "snssai" is not included, and "dnn" is included, UDR shall return the session management policy data per DNN for the DNN identified by "dnn" for all network slices where such DNN is available. + +This method shall support the request data structures specified in table 5.2.5.3.1-2 and the response data structures and response codes specified in table 5.2.5.3.1-3. + +**Table 5.2.5.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.5.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------| +| SmPolicyData | M | 1 | 200 OK | Upon success, a response body containing SmPolicyData shall be returned. | +| 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. | | | | | + +NOTE: This release supports that only one PCF can access to the UDR to retrieve the SM Policy Data under one S-NSSAI and DNN association. + +#### 5.2.5.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.2.5.3.2-1. + +**Table 5.2.5.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 5.2.5.3.2-2 and the response data structures and response codes specified in table 5.2.5.3.2-3. + +**Table 5.2.5.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmPolicyDataPatch | M | 1 | When the "SessionManagementPolicyDataPatch" feature is supported, it requests the modification of the session management policy data for a subscriber. | + +**Table 5.2.5.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. (NOTE 2)(NOTE 3) | +| SmPolicyData | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) (NOTE 3) | + +NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer supported the "PatchReport" feature, the UDR shall respond with SmPolicyData. + +NOTE 3: When the resource is successfully updated, if the SmPolicyDataPatch in the request requires the creation, removal, or update of an entry of the "umData" attribute, the UDR shall create, remove or update the corresponding UsageMonitoringInformation resource for the indicated limit identifier. + +## 5.2.6 Resource: UsageMonitoringInformation + +### 5.2.6.1 Description + +The resource represents an individual usage monitoring resource created in the UDR and associated with a ueId and a usageMonId. + +### 5.2.6.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/ues/{ueId}/sm-data/{usageMonId} + +This resource shall support the resource URI variables defined in table 5.2.6.2-1. + +**Table 5.2.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7]. | +| usageMonId | string | Unique identifier of the individual SM Policy usage monitoring resource. It contains the identity of the corresponding limit as defined in the "limitId" attribute of the UsageMonDataLimit data type (see clause 5.4.2.6). | + +### 5.2.6.3 Resource Standard Methods + +#### 5.2.6.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.6.3.1-1. + +**Table 5.2.6.3.1-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.2.6.3.1-2 and the response data structures and response codes specified in table 5.2.6.3.1-3. + +**Table 5.2.6.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|---------------------------------------| +| UsageMonData | M | 1 | Create the usage monitoring resource. | + +**Table 5.2.6.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| UsageMonData | M | 1 | 201 Created | Successful case.
The resource has been successfully created and a response body is returned containing a representation of the resource.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: When the resource is successfully created, the UDR shall create a new entry within the "umData" attribute of the SessionManagementPolicyData resource for the corresponding "limitId" accordingly. + +**Table 5.2.6.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}/nudr-dr//policy-data/ues/{ueId}/sm-data/{usageMonId} | + +## 5.2.6.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.6.3.2-1. + +**Table 5.2.6.3.2-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.6.3.2-2 and the response data structures and response codes specified in table 5.2.6.3.2-3. + +**Table 5.2.6.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.6.3.2-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 resource has been successfully deleted.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: When the resource is successfully deleted, the UDR shall delete within the "umData" attribute of the SessionManagementPolicyData resource the corresponding "limitId" entry accordingly. + +### 5.2.6.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.6.3.3-1. + +**Table 5.2.6.3.3-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.2.6.3.3-2 and the response data structures and response codes specified in table 5.2.6.3.3-3. + +**Table 5.2.6.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.6.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------| +| UsageMonData | M | 1 | 200 OK | Successful case.
The usage monitoring data is returned. | +| n/a | | | 204 No Content | The resource was found but no usage monitoring data is available. | +| 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. | | | | | + +## 5.2.7 Resource: SponsorConnectivityData + +### 5.2.7.1 Description + +The resource represents sponsored data connectivity related information stored in the UDR for a given sponsorId. + +### 5.2.7.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/policy-data/sponsor-connectivity-data/{sponsorId} + +This resource shall support the resource URI variables defined in table 5.2.7.2-1. + +**Table 5.2.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| sponsorId | string | Represents the sponsor identity. | + +### 5.2.7.3 Resource Standard Methods + +#### 5.2.7.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.7.3.1-1. + +**Table 5.2.7.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.2.7.3.1-2 and the response data structures and response codes specified in table 5.2.7.3.1-3. + +**Table 5.2.7.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.7.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------| +| SponsorConnectivityData | M | 1 | 200 OK | Upon success, a response body containing Sponsor Connectivity Data shall be returned. | +| n/a | | | 204 No Content | The resource was found but no Sponsor Connectivity Data is available. | +| 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. | | | | | + +## 5.2.8 Resource: BdtData + +### 5.2.8.1 Description + +The resource represents background data transfer data stored in the UDR. + +### 5.2.8.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/bdt-data + +This resource shall support the resource URI variables defined in table 5.2.8.2-1. + +**Table 5.2.8.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 5.2.8.3 Resource Standard Methods + +#### 5.2.8.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.8.3.1-1. + +**Table 5.2.8.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| bdt-ref-ids | array(BdtReferenceId) | O | 1..N | If included, this IE shall contain a list of the BDT reference identifiers.
Each member of the array is an individual BDT reference identifier. | +| 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.2.8.3.1-2 and the response data structures and response codes specified in table 5.2.8.3.1-3. + +**Table 5.2.8.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.8.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------| +| array(BdtData) | M | 0..N | 200 OK | Upon success, a response body containing the BDT data shall be returned.
Each member of the array is an individual BDT data. | +| 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. | | | | | + +## 5.2.9 Resource: IndividualBdtData + +### 5.2.9.1 Description + +The resource represents individual background data transfer data stored in the UDR for a given "bdtReferenceId". + +### 5.2.9.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/bdt-data/{bdtReferenceId} + +This resource shall support the resource URI variables defined in table 5.2.9.2-1. + +**Table 5.2.9.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| bdtReferenceId | BdtReferenceId | Represents the transfer policy of background data transfer for provided ASP. Data type BdtReferenceId is defined in 3GPP TS 29.122 [9]. | + +### 5.2.9.3 Resource Standard Methods + +#### 5.2.9.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.9.3.1-1. + +**Table 5.2.9.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.2.9.3.1-2 and the response data structures and response codes specified in table 5.2.9.3.1-3. + +**Table 5.2.9.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.2.9.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------| +| BdtData | M | 1 | 200 OK | Upon success, a response body containing the BDT data shall be returned. | +| 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. | | | | | + +### 5.2.9.3.2 PUT + +This method shall support the URI query parameters specified in table 5.2.9.3.2-1. + +**Table 5.2.9.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.2.9.3.2-2 and the response data structures and response codes specified in table 5.2.9.3.2-3. + +**Table 5.2.9.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------------------------------------------|--| +| BdtData | M | 1 | Create the BDT data for a given bdtReferenceId. | | + +**Table 5.2.9.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------| +| BdtData | M | 1 | 201 Created | Successful case.
The resource has been successfully created. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The resource is not allowed to be updated.
(NOTE 2) | +| NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | +| NOTE 2: The "cause" attribute within the "ProblemDetails" data structure may be set to "MODIFICATION_NOT_ALLOWED" as defined in table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | | | | | + +**Table 5.2.9.3.2-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}/nudr-dr//policy-data/bdt-data/{bdtReferenceId} | + +### 5.2.9.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.2.9.3.3-1. + +**Table 5.2.9.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.9.3.3-2 and the response data structures and response codes specified in table 5.2.9.3.3-3. + +**Table 5.2.9.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.9.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 resource has been successfully deleted. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.9.3.4 PATCH + +This method shall support the URI query parameters specified in table 5.2.9.3.4-1. + +**Table 5.2.9.3.4-1: URI query parameters supported by the PATCH 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.9.3.4-2 and the response data structures and response codes specified in table 5.2.9.3.4-3. + +**Table 5.2.9.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|-------------------------------------------------| +| BdtDataPatch | M | 1 | Modify the BDT data for a given bdtReferenceId. | + +**Table 5.2.9.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------| +| BdtData | M | 1 | 200 OK | The resource has been successfully updated and a response body containing BDT data shall be returned. | +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.10 Resource: PolicyDataSubscriptions + +### 5.2.10.1 Description + +This resource is used to represent subscriptions to notification of policy data modification. + +## 5.2.10.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/subs-to-notify + +This resource shall support the resource URI variables defined in table 5.2.10.2-1. + +**Table 5.2.10.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +## 5.2.10.3 Resource Standard Methods + +### 5.2.10.3.1 POST + +This method shall support the URI query parameters specified in table 5.2.10.3.1-1. + +**Table 5.2.10.3.1-1: URI query parameters supported by the POST 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.10.3.1-2 and the response data structures and response codes specified in table 5.2.10.3.1-3. + +**Table 5.2.10.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|--------------------------------------------------------------------------| +| PolicyDataSubscription | M | 1 | Identifies the subscription to notification of policy data modification. | + +**Table 5.2.10.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PolicyDataSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of each Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 5.2.10.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}/nudr-dr//policy-data/subs-to-notify/{subId} | + +### 5.2.10.3.2 GET + +This method shall support the URI query parameters specified in table 5.2.10.3.2-1. + +**Table 5.2.10.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mon-resources | array(string) | C | 1..N | Indicate the resources for which it is requested to return the existing subscriptions to notifications on data changes. It contains the of a monitored resource.
When present, the UDR shall return the IndividualPolicyDataSubscription resource(s) for which one or more of the indicated resources in the "mon-resources" query parameter matches with the of one or more entries of the "monitoredResourceUris" property of the resource (i.e. within the resource representation in the PolicyDataSubscription data structure). | +| ue-id | VarUeld | C | 0..1 | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeld is defined in 3GPP TS 29.571 [7]. When present, the UDR shall return the IndividualPolicyDataSubscription resource(s) for the indicated UE. | +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer, as per clause 6.6 of 3GPP TS 29.500 [4]. | +| NOTE: Either the "mon-resources" or "ue-id" query parameters shall be present in the request. | | | | | + +This method shall support the request data structures specified in table 5.2.10.3.2-2 and the response data structures and response codes specified in table 5.2.10.3.2-3. + +**Table 5.2.10.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.10.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------| +| array(PolicyDataSubscription) | M | 0..N | 200 OK | Upon success, a response body containing the the requested Individual Policy Data Subscription(s) shall be returned. | +| 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. | | | | | + +## 5.2.11 Resource: IndividualPolicyDataSubscription + +### 5.2.11.1 Description + +This resource is used to represent an individual subscription to notification of policy data modification. + +### 5.2.11.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/subs-to-notify/{subsId} + +This resource shall support the resource URI variables defined in table 5.2.11.2-1. + +**Table 5.2.11.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| subsId | string | The subsId identifies an individual policy data subscription to notifications. The value is allocated by the UDR during creation of the PolicyDataSubscriptions resource. | + +## 5.2.11.3 Resource Standard Methods + +### 5.2.11.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.11.3.1-1. + +**Table 5.2.11.3.1-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.2.11.3.1-2 and the response data structures and response codes specified in table 5.2.11.3.1-3. + +**Table 5.2.11.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-----------------------------------------------------------------------| +| PolicyDataSubscription | M | 1 | Updates the subscription to notification of policy data modification. | + +**Table 5.2.11.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| PolicyDataSubscription | M | 1 | 200 OK | The individual subscription resource was updated successfully. | +| n/a | | | 204 No Content | The individual subscription resource was updated successfully and no additional content is to be sent in the response message. | +| 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. | | | | | + +### 5.2.11.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.11.3.2-1. + +**Table 5.2.11.3.2-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.11.3.2-2 and the response data structures and response codes specified in table 5.2.11.3.2-3. + +**Table 5.2.11.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 5.2.11.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 5.2.11.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.11.3.3-1. + +**Table 5.2.11.3.3-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.2.11.3.3-2 and the response data structures and response codes specified in table 5.2.11.3.3-3. + +**Table 5.2.11.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.11.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------| +| PolicyDataSubscription | M | 1 | 200 OK | Upon success, a response body containing the resource representation of the requested Individual Policy Data Subscription. | +| 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. | | | | | + +## 5.2.12 Resource: OperatorSpecificData + +### 5.2.12.1 Description + +This resource represents the UE's operator specific data. + +NOTE: This resource can be used for operator specific data that is related to any policy data (e.g., AM policy data). + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +### 5.2.12.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/ues/{ueId}/operator-specific-data + +This resource shall support the resource URI variables defined in table 5.2.12.2-1. + +**Table 5.2.12.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| ueId | VarUeld | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeld is defined in 3GPP TS 29.571 [7]. | + +## 5.2.12.3 Resource Standard Methods + +### 5.2.12.3.1 GET + +This method is used to retrieve operator specific data from the UDR. + +This method shall support the URI query parameters specified in table 5.2.12.3.1-1. + +**Table 5.2.12.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supp-feat | SupportedFeatures | O | 0..1 | Identifies the features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.2.12.3.1-2 and the response data structures and response codes specified in table 5.2.12.3.1-3. + +**Table 5.2.12.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.12.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| map(OperatorSpecificDataContainer) | M | 0..N | 200 OK | Upon success, a response body containing a map shall be returned. The key of the map is an operator specific data element name and the value is the operator specific data of such data element, for the current UE (identified by the {ueId} variable in the resource path).
If the resource does not contain any keys, the response consists of an empty JSON object (empty map). | +| 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. | | | | | + +### 5.2.12.3.2 PATCH + +This method is used to modify operator specific data in the UDR. + +This method shall support the URI query parameters specified in table 5.2.12.3.2-1. + +**Table 5.2.12.3.2-1: URI query parameters supported by the PATCH 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.12.3.2-2 and the response data structures and response codes specified in table 5.2.12.3.2-3. + +**Table 5.2.12.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the operator specific data | + +**Table 5.2.12.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message.(NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The resource is not allowed to be updated. (NOTE 3) | + +NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer supported the "PatchReport" feature, the UDR shall respond with PatchResult. + +NOTE 3: The "cause" attribute within the "ProblemDetails" data structure may be set to "MODIFICATION\_NOT\_ALLOWED" as defined in table 5.2.7.2-1 of 3GPP TS 29.500 [4]. + +### 5.2.12.3.3 PUT + +This method is used to create or modify operator specific data in the UDR. + +This method shall support the URI query parameters specified in table 5.2.12.3.3-1. + +**Table 5.2.12.3.3-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.2.12.3.3-2 and the response data structures and response codes specified in table 5.2.12.3.3-3. + +**Table 5.2.12.3.3-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| map(OperatorSpecificData Container) | M | 1..N | A map containing the new representation of the operator specific data. The key of the map is operator specific data element name and the value is the operator specific data of the UE. | + +**Table 5.2.12.3.3-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| map(OperatorSpecificDataContainer) | M | 1 | 200 OK | Upon successful modification a response body containing a map shall be returned. The key of the map is operator specific data element name and the value is the operator specific data of the UE. | +| map(OperatorSpecificDataContainer) | M | 1 | 201 Created | If the "OSDResource_Create_Delete" feature is supported and the resource has been successfully created, a response body is returned. The key of the map is operator specific data element name and the value is the operator specific data of the UE. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The resource is not allowed to be updated. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The "cause" attribute within the "ProblemDetails" data structure may be set to "MODIFICATION\_NOT\_ALLOWED" as defined in table 5.2.7.2-1 of 3GPP TS 29.500 [4]. + +**Table 5.2.12.3.3-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}/nudr-dr//policy-data/ues/{ueId}/operator-specific-data. | + +### 5.2.12.3.4 DELETE + +This method shall support the URI query parameters specified in table 5.2.12.3.4-1. + +**Table 5.2.12.3.4-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.12.3.4-2 and the response data structures and response codes specified in table 5.2.12.3.4-3. + +**Table 5.2.12.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.12.3.4-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, applicable when the "OSDResource_Create_Delete" feature is supported.
The resource has been successfully deleted. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.13 Resource: PlmnUePolicySet + +### 5.2.13.1 Description + +The resource represents the UE policy set for a given "plmnId" representing an H-PLMN stored in the UDR of a V-PLMN. + +### 5.2.13.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/plmns/{plmnId}/ue-policy-set + +This resource shall support the resource URI variables defined in table 5.2.13.2-1. + +**Table 5.2.13.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| plmnId | string | Concatenating a Mcc and Mnc as defined in 3GPP TS 29.505 [15]. | + +## 5.2.13.3 Resource Standard Methods + +### 5.2.13.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.13.3.1-1. + +**Table 5.2.13.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.2.13.3.1-2 and the response data structures and response codes specified in table 5.2.13.3.1-3. + +**Table 5.2.13.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.13.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------| +| UePolicySet | M | 1 | 200 OK | Upon success, a response body containing the UE policies shall be returned. | +| 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. | | | | | + +## 5.2.14 Resource: PolicyDataForIndividualUe + +### 5.2.14.1 Description + +The resource represents all UE related policy data sets in the UDR for a given "ueId". + +### 5.2.14.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/ues/{ueId} + +This resource shall support the resource URI variables defined in table 5.2.14.2-1. + +**Table 5.2.14.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7]. | + +### 5.2.14.3 Resource Standard Methods + +#### 5.2.14.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.14.3.1-1. + +**Table 5.2.14.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, as per clause 6.6 of 3GPP TS 29.500 [4]. | +| data-subset-names | array(PolicyDataSubsets) | O | 2..N | The policy data subsets (e.g. AM policies, SM policies, etc.) requested by the NF service consumer.
If this query parameter is not provided by the NF service consumer, this means that all the available policy data subsets shall be returned. | +| NOTE: When two or more policy data subsets shall be retrieved, it is recommended to use a single GET request with query parameters. | | | | | + +This method shall support the request data structures specified in table 5.2.14.3.1-2 and the response data structures and response codes specified in table 5.2.14.3.1-3. + +**Table 5.2.14.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.14.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| PolicyDataForIndividual UE | M | 1 | 200 OK | Upon success, a response body containing the policy data subsets requested by the NF service consumer or all the policy data subsets shall be returned. | +| 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. | | | | | + +## 5.2.15 Resource: SlicePolicyControlData + +### 5.2.15.1 Description + +The resource represents the network slice specific policy control subscription data stored in the UDR for a given S-NSSAI. + +### 5.2.15.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/slice-control-data/{snssai} + +This resource shall support the resource URI variables defined in table 5.2.15.2-1. + +**Table 5.2.15.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| snssai | Snssai | The S-NSSAI value used in the last segment of the resource URI is encoded as a string as defined in 3GPP TS 29.571 [7], clause 5.4.4.2. | + +### 5.2.15.3 Resource Standard Methods + +#### 5.2.15.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.15.3.1-1. + +**Table 5.2.15.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.2.15.3.1-2 and the response data structures and response codes specified in table 5.2.15.3.1-3. + +**Table 5.2.15.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.15.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------| +| SlicePolicyData | M | 1 | 200 OK | Upon success, a response body containing network slice specific policy control data shall be returned. | +| 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. | | | | | + +## 5.2.15.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.2.15.3.2-1. + +**Table 5.2.15.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 5.2.15.3.2-2 and the response data structures and response codes specified in table 5.2.15.3.2-3. + +**Table 5.2.15.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------------------------------| +| SlicePolicyDataPatch | M | 1 | Modify a network slice specific policy control data resource for a given S-NSSAI. | + +**Table 5.2.15.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| SlicePolicyData | M | 1 | 200 OK | The resource has been successfully updated and a response body containing network slice specific policy control data shall be returned. | +| n/a | | | 204 No Content | The resource has been successfully updated and no additional content is to be sent in the response message. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.16 Resource: MBSSessionPolicyControlData + +### 5.2.16.1 Description + +The resource represents the MBS Session Policy Control Data for an MBS Session. + +### 5.2.16.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/mbs-session-pol-data/{polSessionId} + +This resource shall support the resource URI variables defined in table 5.2.16.2-1. + +**Table 5.2.16.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|------------------|-------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| polSessionId | MbsSessPolDataId | Represents the identifier of the MBS Session Policy Control Data. | + +### 5.2.16.3 Resource Standard Methods + +#### 5.2.16.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.16.3.1-1. + +**Table 5.2.16.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. | + +**Table 5.2.16.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.16.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------| +| MbsSessPolCtrlData | M | 1 | 200 OK | Successful case. The requested MBS Session Policy Control Data is successfully returned. | +| 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. | | | | | + +## 5.2.17 Resource: PdtqData + +### 5.2.17.1 Description + +The resource represents planned data transfer with QoS requirements data stored in the UDR. + +### 5.2.17.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/pdtq-data + +This resource shall support the resource URI variables defined in table 5.2.17.2-1. + +**Table 5.2.17.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +## 5.2.17.3 Resource Standard Methods + +### 5.2.17.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.8.3.1-1. + +**Table 5.2.17.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| pdtq-ref-ids | array(PdtqReferenceId) | O | 1..N | If included, this IE shall contain a list of the PDTQ reference identifiers.
Each member of the array is an individual PDTQ reference identifier. | +| 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.2.17.3.1-2 and the response data structures and response codes specified in table 5.2.17.3.1-3. + +**Table 5.2.17.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.17.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------| +| array(PdtqData) | M | 0..N | 200 OK | Upon success, a response body containing the PDTQ data shall be returned.
Each member of the array is an individual PDTQ data. | + +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. + +## 5.2.18 Resource: IndividualPdtqData + +### 5.2.18.1 Description + +The resource represents individual planned data transfer with QoS requirements data stored in the UDR for a given "pdtqReferenceId". + +### 5.2.18.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/pdtq-data/{pdtqReferenceId} + +This resource shall support the resource URI variables defined in table 5.2.18.2-1. + +**Table 5.2.18.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| pdtqReferenceId | PdtqReferenceId | Represents the PDTQ policy of planned data transfer with QoS requirements for provided ASP. Data type PdtqReferenceId is defined in 3GPP TS 29.543 [25]. | + +## 5.2.18.3 Resource Standard Methods + +### 5.2.18.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.18.3.1-1. + +**Table 5.2.18.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.2.18.3.1-2 and the response data structures and response codes specified in table 5.2.9.3.1-3. + +**Table 5.2.18.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.18.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|---------------------------------------------------------------------------| +| PdtqData | M | 1 | 200 OK | Upon success, a response body containing the PDTQ data shall be returned. | + +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. + +### 5.2.18.3.2 PUT + +This method shall support the URI query parameters specified in table 5.2.18.3.2-1. + +**Table 5.2.18.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.2.18.3.2-2 and the response data structures and response codes specified in table 5.2.18.3.2-3. + +**Table 5.2.18.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|---------------------------------------------------| +| PdtqData | M | 1 | Create the PDTQ data for a given pdtqReferenceId. | + +**Table 5.2.18.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|-----------------------------------------------------------------| +| PdtqData | M | 1 | 201 Created | Successful case.
The resource has been successfully created. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The resource is not allowed to be updated.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The "cause" attribute within the "ProblemDetails" data structure may be set to "MODIFICATION\_NOT\_ALLOWED" as defined in table 5.2.7.2-1 of 3GPP TS 29.500 [4]. + +**Table 5.2.18.3.2-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}/nudr-dr//policy-data/pdtq-data/{pdtqReferenceId} | + +### 5.2.18.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.2.18.3.3-1. + +**Table 5.2.18.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.18.3.3-2 and the response data structures and response codes specified in table 5.2.18.3.3-3. + +**Table 5.2.18.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.18.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 resource has been successfully deleted. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +### 5.2.18.3.4 PATCH + +This method shall support the URI query parameters specified in table 5.2.18.3.4-1. + +**Table 5.2.18.3.4-1: URI query parameters supported by the PATCH 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.18.3.4-2 and the response data structures and response codes specified in table 5.2.18.3.4-3. + +**Table 5.2.18.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|---------------------------------------------------| +| PdtqDataPatch | M | 1 | Modify the PDTQ data for a given pdtqReferenceId. | + +**Table 5.2.18.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------| +| PdtqData | M | 1 | 200 OK | The resource has been successfully updated and a response body containing PDTQ data shall be returned. | +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +## 5.2.19 Resource: GroupPolicyControlData + +### 5.2.19.1 Description + +The resource represents the group specific policy control subscription data stored in the UDR for a 5G VN group. + +### 5.2.19.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/group-control-data/{intGroupId} + +This resource shall support the resource URI variables defined in table 5.2.19.2-1. + +**Table 5.2.19.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|----------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| intGroupId | GroupId | Identifies a 5G VN group as defined in clause 5.3.2 of 3GPP TS 29.571 [7]. | + +### 5.2.19.3 Resource Standard Methods + +#### 5.2.19.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.19.3.1-1. + +**Table 5.2.19.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.2.19.3.1-2 and the response data structures and response codes specified in table 5.2.19.3.1-3. + +**Table 5.2.19.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.19.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------| +| GroupPolicyData | M | 1 | 200 OK | Upon success, a response body containing group specific policy control data for a 5G VN group shall be returned. | +| 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. | | | | | + +### 5.2.19.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.2.19.3.2-1. + +**Table 5.2.19.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 5.2.19.3.2-2 and the response data structures and response codes specified in table 5.2.19.3.2-3. + +**Table 5.2.19.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-------------------------------------------------------------------------| +| GroupPolicyDataPatch | M | 1 | Modify a group specific policy control data resource for a 5G VN group. | + +**Table 5.2.19.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| GroupPolicyData | M | 1 | 200 OK | The resource has been successfully modified and a response body containing the updated group specific policy control data for the targeted 5G VN group shall be returned. | +| n/a | | | 204 No Content | The resource has been successfully modified and no additional content is to be sent in the response body. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.3 Notifications + +### 5.3.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +This clause describes the resources to provide notification to NF service consumers which have subscribed to be notified when policy data is changed. + +**Table 5.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------|-------------------|---------------------------------|------------------------------------------| +| Policy Data Change Notification | {notificationUri} | POST | Used for policy data change notification | + +## 5.3.2 Policy Data Change Notification + +The POST method shall be used for policy data change notification and the URI shall be provided during the subscription procedure. + +Callback URI: {notificationUri} + +This method shall support the URI query parameters specified in table 5.3.2-1. + +**Table 5.3.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2-2 and the response data structures and response codes specified in table 5.3.2-3. + +**Table 5.3.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------------------------|---|-------------|--------------------------------------| +| array(PolicyDataChangeNotification) | M | 1..N | Notification of policy data changes. | + +**Table 5.3.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------| +| n/a | | | 204 No Content | The reception of the notification is acknowledged. | +| 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. | | | | | + +## 5.4 Data Model + +### 5.4.1 General + +This clause specifies the application data model supported by the API. + +Table 5.4.1-1 specifies the data types defined for the Nudr\_DataRepository for Policy Data service based interface protocol. + +**Table 5.4.1-1: Nudr\_DataRepository specific Data Types for Policy Data** + +| Data type | Section defined | Description | Applicability | +|--------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| +| AmPolicyData | 5.4.2.2 | Contains the AM policy data for a given subscriber. | | +| BdtData | 5.4.2.9 | Contains the background data transfer data. | | +| BdtDataPatch | 5.4.2.27 | Contains the modifiable background data transfer data | | +| BdtPolicyStatus | 5.4.3.5 | Contains the validation status for a negotiated BDT policy. | | +| DnnRouteSelectionDescriptor | 5.4.2.20 | Contains the route selector parameters per DNN. | | +| UpdatedItem | 5.4.2.26 | An updated resource fragment, represented by its location in a resource and its data type. | ConditionalSubscriptionwithPartialNotification | +| LimitIdToMonitoringKey | 5.4.2.16 | Contains the limit identifier and the corresponding monitoring key for a given S-NSSAI and DNN. | | +| MbsSessPolCtrlData | 5.4.2.31 | Contains MBS Session Policy Control Data. | | +| MbsSessPolDataId | 5.4.2.32 | Represents the identifier used to access the MBS Session Policy Control Data. | | +| NotificationItem | 5.4.2.25 | Contains the list of resource fragments included in the notification triggered by the modification of a given resource fragment. | ConditionalSubscriptionwithPartialNotification | +| OsId | 5.4.3.2 | Operating System supported by the UE. | | +| PdtqData | 5.4.2.33 | Contains the planned data transfer with QoS requirements data. | | +| PdtqDataPatch | 5.4.2.34 | Contains the modifiable planned data transfer with QoS requirements data | | +| Periodicity | 5.4.3.4 | Indicates a type of time period. | | +| PlmnRouteSelectionDescriptor | 5.4.2.18 | Contains the route selectors for a serving PLMN. | | +| PolicyDataChangeNotification | 5.4.2.11 | Contains changed policy data for which notification was requested. | | +| PolicyDataForIndividualUe | 5.4.2.28 | Contains policy data sets for a given subscriber. | | +| PolicyDataSubscription | 5.4.2.10 | Identifies a subscription to policy data change notification. | | +| PolicyDataSubset | 5.4.3.6 | Indicates a policy data subset (e.g. AM policy data, SM policy data). | | +| SlicePolicyData | 5.4.2.29 | Contains network slice specific policy control information for an S-NSSAI. | | +| SlicePolicyDataPatch | 5.4.2.30 | Contains modifiable network slice specific policy control information for an S-NSSAI. | | +| SmPolicyData | 5.4.2.5 | Contains SM policy data for a subscriber. | | +| SmPolicyDataPatch | 5.4.2.21 | Contains modifiable SM policy data for a subscriber. | SessionManagementPolicyDataPatch | +| SmPolicyDnnData | 5.4.2.15 | Contains SM policy data for a DNN and S-NSSAI. | | +| SmPolicyDnnDataPatch | 5.4.2.23 | Contains modifiable SM policy data for a DNN and S-NSSAI. | SessionManagementPolicyDataPatch | +| SmPolicySnssaiData | 5.4.2.14 | Contains SM policy data for an S-NSSAI. | | +| SmPolicySnssaiDataPatch | 5.4.2.22 | Contains modifiable SM policy data for an S-NSSAI. | SessionManagementPolicyDataPatch | +| SnssaiRouteSelectionDescriptor | 5.4.2.19 | Contains the route selector parameters per SNSSAI. | | +| SponsorConnectivityData | 5.4.2.8 | Contains the sponsored data connectivity related information for a sponsor identifier. | | +| ResourceItem | 5.4.2.24 | Represents list of fragments of a resource, i.e. a list of subsets of resource data monitored for notification of data changes. | ConditionalSubscriptionwithPartialNotification | +| ItemPath | 5.4.3.2 | Represents a fragment of a resource, i.e. a subset of resource data. | ConditionalSubscriptionwithPartialNotification | +| TimePeriod | 5.4.2.12 | Contains the periodicity for the defined usage | | + +| | | | | +|-------------------|----------|-----------------------------------------------------------------------------------------|--| +| | | monitoring data limits. | | +| UePolicySetPatch | 5.4.2.17 | Contains the UE policy data that can be modified by the PCF. | | +| UePolicySection | 5.4.2.3 | Contains the UE policy section. | | +| UePolicySet | 5.4.2.4 | Contains the UE policy set for a given subscriber. | | +| UsageMonLevel | 5.4.3.3 | Indicates the level of the usage monitoring instance (PDU Session level or per Service) | | +| UsageMonData | 5.4.2.7 | Contains remain allowed usage data for a subscriber. | | +| UsageMonDataLimit | 5.4.2.6 | Contains usage monitoring control data for a subscriber. | | +| UsageMonDataScope | 5.4.2.13 | Contains SNSSAI and DNN combinations to which the UsageMonData instance belongs to. | | + +Table 5.4.1-2 specifies data types re-used by the Nudr\_DataRepository for Policy Data 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 Nudr\_DataRepository for Policy Data service based interface. + +**Table 5.4.1-2: Nudr\_DataRepository re-used Data Types for Policy Data** + +| Data type | Reference | Comments | Applicability | +|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| 5Qi | 3GPP TS 29.571 [7] | Indicates the 5G QoS Identifier. | | +| ApplicationId | 3GPP TS 29.571 [7] | Contains the application identifier. | | +| ArpPriorityLevel | 3GPP TS 29.571 [7] | Indicates the allocation and retention priority level. | | +| BdtReferenceId | 3GPP TS 29.122 [9] | Indicates the background data transfer reference ID for the transfer policy. | | +| BitRate | 3GPP TS 29.571 [7] | String representing a bit rate that shall be formatted as follows:
pattern: " ^ d+(\.\d+)? (bps Kbps Mbps Gbps Tbps)\$"
Examples:
"125 Mbps", "0.125 Gbps", "125000 Kbps". | | +| Bytes | 3GPP TS 29.571 [7] | String with format "byte" as defined in OpenAPI Specification [3], i.e., base64-encoded characters. | | +| ChargingInformation | 3GPP TS 29.512 [12] | The address(es), and if available, the instance ID and the set ID of the Charging Function. | | +| DateTime | 3GPP TS 29.571 [7] | String with format "date-time" as defined in OpenAPI Specification [3]. | | +| Dnn | 3GPP TS 29.571 [7] | Data Network Name. (NOTE) | | +| MbsSessionId | 3GPP TS 29.571 [7] | Contains the MBS Session Identifier. | | +| Metadata | 3GPP TS 29.571 [7] | Contains opaque information for the service functions in the N6-LAN that is provided by AF and transparently sent to UPF. | SFC | +| NetworkAreaInfo | 3GPP TS 29.554 [13] | Represents a network area information. | | +| OperatorSpecificDataContainer | 3GPP TS 29.505 [15] | Container for operator specific data | | +| PatchResult | 3GPP TS 29.571 [7] | | | +| PatchItem | 3GPP TS 29.571 [7] | Data structure used for JSON patch. | | +| PdtqPolicy | 3GPP TS 29.543 [25] | Represents a PDTQ policy. | | +| PdtqReferenceId | 3GPP TS 29.543 [25] | Indicates the planned data transfer with QoS requirements reference ID for the PDTQ policy. | | +| PduSessionType | 3GPP TS 29.571 [7] | PDU Session Type. | | +| Pei | 3GPP TS 29.571 [7] | Personal Equipment Identifier. | | +| PlmnId | 3GPP TS 29.571 [7] | PLMN Identity. | | +| PresenceInfo | 3GPP TS 29.571 [7] | Presence Reporting Area Information. | | +| ProblemDetails | 3GPP TS 29.571 [7] | Used in error responses to provide more detailed information about an error. | | +| SliceMbr | 3GPP TS 29.571 [7] | Contains the slice Maximum Bit Rate including UL and DL. | NSAC | +| Snssai | 3GPP TS 29.571 [7] | Identifies the S-NSSAI. | | +| SscMode | 3GPP TS 29.571 [7] | SSC mode. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features | | +| TnapId | 3GPP TS 29.571 [7] | Trusted Network Access Point identifier. | AfGuideTNAPs | +| TrafficDescriptor | 3GPP TS 29.122 [9] | Identifies the traffic descriptor of the background data. | | +| TransferPolicy | 3GPP TS 29.554 [13] | Represents a transfer policy. | | +| Uinteger | 3GPP TS 29.571 [7] | Unsigned Integer, i.e. only value 0 and integers greater than 0 are allowed. | | +| Uri | 3GPP TS 29.571 [7] | String providing an URI. | | +| UsageThreshold | 3GPP TS 29.122 [9] | Usage Thresholds (a data volume expected to be transferred per UE and/or time duration in seconds). | | +| VarUeId | 3GPP TS 29.571 [7] | String represents the SUPI or GPSI. | | +| NOTE: | The UDR uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. | | | + +## 5.4.2 Structured data types + +### 5.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 5.4.2.2 Type AmPolicyData + +**Table 5.4.2.2-1: Definition of type AmPolicyData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| pralInfos | map(PresenceInfo) | O | 1..N | Presence reporting area information. Each PresenceInfo element shall include the Presence Reporting Area Identifier within the "prald" attribute and, for a UE-dedicated presence reporting area, shall also include the list of elements composing the presence reporting area.
A "prald" may indicate a Presence Reporting Area Set.
The "prald" attribute within the PresenceInfo data type shall also be the key of the map.
The attribute "presenceState" shall not be present. | | +| subscCats | array(string) | O | 1..N | List of categories associated with the subscriber | | +| chfInfo | ChargingInformation | O | 0..1 | The address(es) and, if available, the CHF instance ID and the CHF set ID of the Charging Function.
(NOTE) | CHFInformation | +| subscSpendingLimits | boolean | O | 0..1 | Indicates whether the PCF must enforce Access and Mobility management related policies based on subscriber spending limits.
True: Spending limit control is enabled;
False: Spending limit control is not enabled.
The absence of this attribute means that spending limit control is not provisioned for the UE. | SLAMUP | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.
This parameter shall be provided if the NF service consumer has provided a list of supported features in its request. | | + +NOTE: When the feature "CHFInformation" is supported, the "secondaryChfAddress" may be omitted. + +### 5.4.2.3 Type UePolicySection + +**Table 5.4.2.3-1: Definition of type UePolicySection** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------| +| uePolicySectionInfo | Bytes | M | 1 | Contains the UE Policy Section Information for the given UPSI as specified in clause D.6.2 of 3GPP TS 24.501 [11]. | +| upsi | string | M | 1 | Identifier for UE Policy Section. The format is represented in 3GPP TS 24.501 [11] clause D.6.2. | + +## 5.4.2.4 Type UePolicySet + +**Table 5.4.2.4-1: Definition of type UePolicySet** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-----------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| pralnfos | map(PresenceInfo) | O | 1..N | Presence reporting area information. Each PresenceInfo element shall include the Presence Reporting Area Identifier within the "prald" attribute and, for a UE-dedicated presence reporting area, shall also include the list of elements composing the presence reporting area.
A "prald" may indicate a Presence Reporting Area Set.
The "prald" attribute within the PresenceInfo data type shall also be the key of the map.

The attribute "presenceState" shall not be present. | | +| subscCats | array(string) | O | 1..N | List of categories associated with the subscriber | | +| uePolicySections | map(UePolicySection) | O | 1..N | Contains the UE Policy Sections. The UPSI (UE Policy Section Identifier) is used as the key in the map. | | +| upsis | array(string) | O | 1..N | List of identifiers for the "uePolicySections". The format of the UPSI is represented in 3GPP TS 24.501 [11] clause D.6.2 | | +| allowedRouteSelDescs | map(PlmnRouteSelectionDescriptor) | O | 1..N | Contains allowed route selection descriptors per serving PLMN for a UE. The serving PLMN identifier is the key of the map. | | +| andspInd | boolean | O | 0..1 | Indication of UE supporting ANDSP.
True: The UE supports ANDSP;
False: The UE does not support ANDSP. | | +| epsUrspInd | boolean | O | 0..1 | Indication of UE supporting URSP provisioning in EPS.
True: The UE supports URSP provisioning in EPS;
False: The UE does not support URSP provisioning in EPS. | EpsUrsp | +| vpsUrspInd | boolean | O | 0..1 | Indication of UE supporting VPLMN-specific URSP.
True: The UE supports VPLMN-specific URSP;
False: The UE does not support VPLMN-specific URSP. | VPLMNSpecificURSP | +| urspEnfInd | boolean | O | 0..1 | Indication of UE supporting URSP enforcement report.
True: The UE supports URSP enforcement report;
False: The UE does not support URSP enforcement report. | URSPEnforcement | +| pei | Pei | O | 0..1 | Personal Equipment Identifier. | | +| oslds | array(OsId) | O | 1..N | Identification of the UE Operating System(s). | | +| chfInfo | ChargingInformation | O | 0..1 | The address(es) and, if available, the CHF instance ID and the CHF set ID of the Charging Function.
(NOTE 2) | CHFInformation | +| subscSpendingLimits | boolean | O | 0..1 | Indicates whether the PCF must enforce UE policies based on subscriber spending limits.
True: Spending limit control is enabled;
False: Spending limit control is not enabled.
The absence of this attribute means that spending limit control is not provisioned for the UE. | SLAMUP | +| tracingReq | array(string) | O | 1..N | Tracing requirements as defined in TS 32.421 [26] | EnhancedUePolicy | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.6.
This attribute shall be provided in the PUT request and in the response of successful resource creation, and in the HTTP GET | | + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | response if the "supp-feat" attribute query parameter is included in the HTTP GET request.
(NOTE 1). | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | +| NOTE 1: In the HTTP request, it represents the set of features supported by the NF service consumer. In the HTTP response, it represents the set of features supported by both the NF service consumer and the UDR. | | | | | | +| NOTE 2: When the feature "CHFInformation" is supported, the "secondaryChfAddress" may be omitted. | | | | | | + +#### 5.4.2.5 Type SmPolicyData + +**Table 5.4.2.5-1: Definition of type SmPolicyData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------------------------------------------------------------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| smPolicySnssaiData | map(SmPolicySnssaiData) | M | 1..N | Session Management Policy data per S-NSSAI for all the SNSSAIs of the subscriber.
The key of the map is the S-NSSAI.
(NOTE 2) | | +| umDataLimits | map(UsageMonDataLimit) | O | 1..N | Contains a list of usage monitoring profiles associated with the subscriber. The limit identifier is used as the key of the map. | | +| umData | map(UsageMonData) | O | 1..N | Contains the remaining allowed usage data associated with the subscriber.
The limit identifier is used as the key in the map. | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.
This parameter shall be supplied by the UDR in the response to the GET request when the GET request includes the "supp-feat" query parameter and the UDR supports feature negotiation for Session Management Policy Data. | | +| NOTE 1: In this Release of the specification the "limitId" corresponds to the Monitoring Key. | | | | | | +| NOTE 2: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[7], clause 5.4.4.2. | | | | | | + +## 5.4.2.6 Type UsageMonDataLimit + +**Table 5.4.2.6-1: Definition of type UsageMonDataLimit** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| limitId | string | M | 1 | Identifies the limit, i.e. the usage monitoring control instance | +| scopes | map(UsageMonDataScope) | O | 1..N | Identifies the SNSSAI and DNN combinations to which the usage monitoring data limit applies.
The S-NSSAI is the key of the map. (NOTE 2)
If the "scopes" attribute is omitted, the limit applies to every S-NSSAI and DNN. | +| umLevel | UsageMonLevel | O | 0..1 | Indicates the level of the usage monitoring instance (PDU Session level or per Service). | +| startDate | DateTime | C | 0..1 | Start date and time when the usage monitoring instance applies. It shall be provided when the resetPeriod attribute is provided. | +| endDate | DateTime | O | 0..1 | End date and time when the usage monitoring instance applies. | +| usageLimit | UsageThreshold | O | 0..1 | Maximum allowed traffic volume/time usage for a usage monitoring instance. If a resetPeriod is specified, this limit applies to every period separately and not for the entire time between the start and end dates. So for example, if the resetPeriod is daily, the usageLimit is applicable for each day until the end date is specified. | +| resetPeriod | TimePeriod | O | 0..1 | Time period to reset the remaining allowed usage for a periodic usage monitoring instance (postpaid subscriptions). This attribute along with the startDate determine the actual absolute time at which usage needs to be reset. | + +NOTE 1: In this Release of the specification the "limitId" attribute is the Monitoring Key, and the "scopes" attribute shall always be present including one distinct SNSSAI and DNN pair. + +NOTE 2: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[7], clause 5.4.4.2. + +## 5.4.2.7 Type UsageMonData + +**Table 5.4.2.7-1: Definition of type UsageMonData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| limitId | string | M | 1 | Identifies the limit as defined in the "limitId" attribute of the UsageMonDataLimit data type (see clause 5.4.2.6). | | +| scopes | map(UsageMonDataScope) | O | 1..N | Identifies the SNSSAI and DNN combinations to which the remaining usage monitoring data applies. The S-NSSAI is the key of the map. (NOTE 3) | | +| umLevel | UsageMonLevel | O | 0..1 | Indicates the level of the usage monitoring instance (PDU Session level or per Service). | | +| allowedUsage | UsageThreshold | O | 0..1 | Remaining allowed traffic volume usage and/or resource time usage. | | +| resetTime | DateTime | O | 0..1 | Time to reset the allowed usage back to the usageLimit of the corresponding UsageMonDataLimit. This is computed based on the corresponding startDate, resetPeriod and endDate of the corresponding UsageMonDataLimit. The allowedUsage is only applicable if the resetTime is in the future relative to the current time. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.6. This attribute shall be provided in the PUT request and in the response of successful resource creation, and in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE 2). | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource. This attribute may be provided in the response of successful resource creation. | | + +NOTE 1: In this Release of the specification the "limitId" attribute is the Monitoring Key, and the "scopes" attribute shall always be present including one distinct SNSSAI and DNN pair. + +NOTE 2: In the HTTP request, it represents the set of features supported by the NF service consumer. In the HTTP response, it represents the set of features supported by both the NF service consumer and the UDR. + +NOTE 3: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571 [7], clause 5.4.4.2. + +## 5.4.2.8 Type SponsorConnectivityData + +**Table 5.4.2.8-1: Definition of type SponsorConnectivityData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aspIds | array(string) | M | 1..N | Identifies a list of Application Service Provider Identifiers associated with the sponsor identity. | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features. This parameter shall be provided if the NF service consumer has provided a list of supported features in its request. | + +## 5.4.2.9 Type BdtData + +**Table 5.4.2.9-1: Definition of type BdtData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aspld | string | M | 1 | This IE contains an identity of an application service provider. | +| transPolicy | TransferPolicy | M | 1 | This IE contains the transfer policy. | +| bdtRefId | BdtReferenceId | O | 0..1 | This IE indicates the background data transfer reference ID for the transfer policy. | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | This IE represents a network area information. | +| numOfUes | UInteger | O | 0..1 | This IE contains the number of UEs using the indicated transfer policy. It shall be present when available. | +| volPerUe | UsageThreshold | O | 0..1 | This IE contains a data volume expected to be transferred per UE for the indicated transfer policy. It shall be present when available. | +| dnn | Dnn | O | 0..1 | This IE identifies a DNN. | +| snssai | Snssai | O | 0..1 | This IE identifies a slice. | +| trafficDes | TrafficDescriptor | O | 0..1 | Contains the traffic descriptor of the background data. | +| bdtPStatus | BdtPolicyStatus | O | 0..1 | Contains the validation status for a negotiated BDT policy. It shall be included when available. Default value is "VALID" if omitted. | +| warnNotifEnabled | boolean | O | 0..1 | This IE indicates whether the BDT warning notification is enabled or disabled.
true: enabled;
false: disabled (default value). | +| notifUri | Uri | O | 0..1 | This IE contains an URI of the recipient of the BDT warning notification. | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.6.
This attribute shall be provided in the PUT request and in the response of successful resource creation, and in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE). | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | + +NOTE: In the HTTP request, it represents the set of features supported by the NF service consumer. In the HTTP response, it represents the set of features supported by both the NF service consumer and the UDR. + +## 5.4.2.10 Type PolicyDataSubscription + +**Table 5.4.2.10-1: Definition of type PolicyDataSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------| +| notificationUri | Uri | M | 1 | URI provided by the NF service consumer indicating where to receive the subscribed notifications from the UDR. | | +| notifId | string | C | 0..1 | Notification Correlation ID assigned by the NF service consumer.
It shall be included when the "ConditionalSubscriptionWithPartialNotification" or the "ConditionalSubscriptionWithExcludeNotification" feature is supported. | ConditionalSubscriptionWithPartialNotification
ConditionalSubscriptionWithExcludeNotification | +| monitoredResourceUris | array(Uri) | M | 1..N | A set of URIs provided by the NF service consumer that identify the resources as defined in table 5.2.2-1 for which a modification triggers a notification.
(NOTE 1) | | +| monResItems | array(ResourceItem) | O | 1..N | A set of monitored resource fragments provided by the NF service consumer. When present, this IE indicates the trigger of the notification is conditioned to the data change occurs in one or more of the attributes contained in a resource fragment as defined by the ResourceItem data type, and that the triggered notification shall only include the resource fragment as defined by the ResourceItem data type.
(NOTE 2) | ConditionalSubscriptionWithPartialNotification | +| excludedResItems | array(ResourceItem) | O | 1..N | A set of resource fragments provided by the NF service consumer that are excluded from data change monitoring. When present, this IE indicates the trigger of the notification is conditioned to the data change occurs in any attribute contained in the resource(s) identified by "monitoredResourceUris", except when the changed data is in one or more of the attributes contained in a resource fragment as defined by the ResourceItem data type.
(NOTE 2) (NOTE 3) (NOTE 4) | ConditionalSubscriptionWithExcludeNotification | +| immRep | boolean | O | 0..1 | If provided by the NF service consumer and set to "true", it indicates to the UDR that existing entries that match this subscription shall be immediately reported within the "immReports" attribute in the response. The default value is false. | ImmediateReportPcc | +| immReports | array(PolicyDataChangeNotification) | C | 1..N | Contains entries stored in the UDR that match this subscription.
It shall be included in the POST response body of a subscription creation if the request included the "immRep" attribute set to true and the UDR needs to include an immediate report in the response.
It shall be included in the PUT response body of a subscription modification if the UDR needs to include an immediate report in the response and:
- if the modification request included the "immRep" attribute set to true and it was previously set to false or not provided;
- if the modification request added the monitoring of new resources within the "monitoredResourceUris" attribute and/or new monitored resource fragments within the "monResItems" attribute, and the "immRep" attribute was previously set to true; and/or
- if the modification request updated the set of excluded resources within the | ImmediateReportPcc | + +| | | | | | | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| | | | | "excludedResItems" attribute and the "immRep" attribute was previously set to true. | | +| expiry | DateTime | C | 0..1 | This IE shall be included in a subscription response if, based on operator policy and taking into account the expiry time included in the request, the UDR needs to include an expiry time.
This IE may be included in a subscription request. When present, this IE shall represent the time after which the subscription becomes invalid.
The absence of this attribute in the subscription response means the subscription to be valid without an expiry time. | | +| subsId | string | C | 0..1 | It represents the variable part of the IndividualPolicyDataSubscription resource URI, as specified in clause 5.2.11.2-1.
This attribute shall be present if the PolicyDataSubscription is sent in a GET response message to the PolicyDataSubscriptions collection resource.

This is a Read Only attribute and shall not be provided by the NF service consumer in any request. | PolSubscRetrieval | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of the optional features.
This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided by the UDR in the response of successful resource creation. | | +| NOTE 1: | Neither the resource URI of the IndividualPolicyDataSubscription resource nor the resource URI of the PolicyDataSubscriptions resource shall be included in the "monitoredResourceUris" attribute. | | | | | +| NOTE 2: | If both ConditionalSubscriptionwithPartialNotification and ConditionalSubscriptionWithExcludeNotification are supported, the fragments defined in "monResItems" attribute and in "excludedResItems" attribute shall refer to different resources defined in "monitoredResourceUris". | | | | | +| NOTE 3: | When "excludedResItems" attribute is included, and a change is detected in the monitored part of a resource (i.e., in those properties not included in the "excludedResItems" attribute), the triggered notification shall include the complete resource representation. | | | | | +| NOTE 4: | The "excludedResItems" attribute may only be used with the OperatorSpecificData resource. E.g. if the OperatorSpecificData resource contains a map with two elements, one with key "operatorSpecificData1" and the other one with key "operatorSpecificData2", to exclude the notification of changes in the "operatorSpecificData1" element the "excludedResItems" attribute will contain the value "/operatorSpecificData1" within the "items" array. | | | | | + +### 5.4.2.11 Type PolicyDataChangeNotification + +**Table 5.4.2.11-1: Definition of type PolicyDataChangeNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------|------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| amPolicyData | AmPolicyData | O | 0..1 | Access and Mobility Policy Data, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| uePolicySet | UePolicySet | O | 0..1 | UE Policy Set, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| plmnUePolicySet | UePolicySet | O | 0..1 | PLMN UE Policy Set, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| smPolicyData | SmPolicyData | O | 0..1 | Session Management Policy Data, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| usageMonData | UsageMonData | O | 0..1 | Usage Monitoring Data, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| SponsorConnectivityData

(NOTE 4) | SponsorConnectivityData | O | 0..1 | Sponsor data connectivity profile information, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| bdtdData | BdtData | O | 0..1 | Background Data Transfer Data, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| opSpecData | OperatorSpecificDataContainer | O | 0..1 | Operator Specific Data, if changed and notification was requested, or if it existed and immediate reporting was requested. It may only be used when the receiver of the notification is able to univocally identify the changed operator specific data. (NOTE 3) | | +| opSpecDataMap | map(OperatorSpecificDataContainer) | O | 1..N | Operator Specific Data resource data, if changed and notification was requested, or if it existed and immediate reporting was requested. The key of the map is operator specific data element name and the value is the operator specific data of the UE. | OpSpecDataMap Notification | +| ueId | VarUeId | C | 0..1 | Represents the UE subscription identifier SUPI or GPSI. It shall only be present when the "amPolicyData", "uePolicySet", "smPolicyData", "opSpecData" and/or "usageMonData" attribute is present. | | +| sponsorId | string | C | 0..1 | Represents the sponsor identity. It shall only be present when the "sponsorConnectivityData" attribute is present. | | +| bdtdRefId | BdtReferenceId | C | 0..1 | Represents the BDT reference identifier. It shall only be present when the "bdtdData" attribute is present. | | +| usageMonId | string | C | 0..1 | Represents the unique identifier of the individual SM Policy usage monitoring resource. It shall only be present when the "usageMonData" attribute is present. | | +| plmnId | PlmnId | C | 0..1 | Represents the PLMN identifier. It | | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------|--| +| | | | | shall only be present when the "plmnUePolicySet" attribute is present. | | +|--|--|--|--|------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------|-------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| +| delResources | array(Uri) | O | 1..N | The resources, as defined in table 5.2.2-1, if removed from UDR and notification on resource data change was requested. Not applicable for immediate reports. (NOTE 2) | ResourceRemovalNotificationPolicyData | +| notifId | string | C | 0..1 | Notification Correlation ID assigned by the NF service consumer. (NOTE 5) | ConditionalSubscriptionwithPartialNotification | +| reportedFragments | array(NotificationItem) | C | 1..N | This attribute contains the resource fragments indicated in the "monResItems" attribute of the PolicyDataSubscription data type. (NOTE 5) | ConditionalSubscriptionwithPartialNotification | +| slicePolicyData | SlicePolicyData | O | 0..1 | Network slice specific policy control data for an S-NSSAI, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| snssai | Snssai | C | 0..1 | Represents the S-NSSAI identifier, the unique identifier of the SlicePolicyControlData resource. It shall only be present when the "slicePolicyData" attribute is present. | | +| pdtqData | PdtqData | O | 0..1 | Planned Data Transfer with QoS requirements Data, if changed and notification was requested, or if it existed and immediate reporting was requested. | PDTQ | +| pdtqRefId | pdtqReferenceId | C | 0..1 | Represents the PDTQ reference identifier. It shall only be present when the "pdtqData" attribute is present. | PDTQ | +| groupPolicyData | GroupPolicyData | O | 0..1 | Contains group specific policy control data for a 5G VN group, if changed and notification was requested, or if it existed and immediate reporting was requested. | GMEC | +| intGroupId | GroupId | C | 0..1 | Represents the group identifier of a 5G VN group, the unique identifier of the GroupPolicyControlData resource.

It shall only be present when the "groupPolicyData" attribute is present. | GMEC | + +NOTE 1: When the "ResourceRemovalNotificationPolicyData" feature and/or + +"ConditionalSubscriptionwithPartialNotification" feature is not supported or supported but the applicable attribute(s) are not provided, at least one of the "amPolicyData", "uePolicySet", "smPolicyData", "usageMonData", "SponsorConnectivityData", "bdtData", "opSpecData", "plmnUePolicySet" or "slicePolicyData" or "groupPolicyData" shall be present. + +NOTE 2: When the "ResourceRemovalNotificationPolicyData" feature is supported, and the "delResources" attribute is present, the attributes that correspond with the values included in the "delResources" attribute shall be omitted. E.g., when the "delResources" attribute includes the value "../policy-data/ues/{ueId}/am-data" the attribute "amPolicyData" shall be omitted. + +NOTE 3: This attribute should not be used if the receiver of the notification is not able to univocally identify the changed operator specific data, and "opSpecDataMap" should be used instead. + +NOTE 4: The attribute does not follow the related naming convention (i.e. "lowerCamel") defined in clause 5.1.4 of 3GPP TS 29.501 [7]. This attribute is however kept as currently defined in this specification for backward compatibility considerations. + +NOTE 5: When the "ConditionalSubscriptionwithPartialNotification" feature is supported, the "notifId" and "reportedFragments" attributes shall be included in notification requests when a data change occurred in the resource fragments indicated in the "monResItems" attribute of the PolicyDataSubscription data type. When the feature "ImmediateReportPcc" is also supported, the "notifId" and "reportedFragments" attributes shall be included in subscription responses when the resource fragments existed when the immediate reporting was requested. + +#### 5.4.2.12 Type TimePeriod + +**Table 5.4.2.12-1: Definition of type TimePeriod** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| period | Periodicity | M | 1 | Indicates whether the periodicity is "YEARLY", "MONTHLY", "WEEKLY", "DAILY" or "HOURLY". | | +| maxNumPeriod | UInteger | O | 0..1 | Indicates the maximum number of periods after which the usage monitoring instance does not apply. If omitted, there is no limit in the number of periods. | | + +#### 5.4.2.13 Type UsageMonDataScope + +**Table 5.4.2.13-1: Definition of type UsageMonDataScope** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|-------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Represents the SNSSAI. | | +| dnn | array(Dnn) | O | 1..N | Represents the Dnn. If omitted, the usage monitoring scope applies to all the DNNs. | | + +NOTE: In this Release of the specification the "dnn" attribute shall always be present with one and only one entry. + +#### 5.4.2.14 Type SmPolicySnssaiData + +**Table 5.4.2.14-1: Definition of type SmPolicySnssaiData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | S-NSSAI associated with the data. | | +| smPolicyDnnData | map(SmPolicyDnnData) | O | 1..N | Session Management Policy data per DNN for all the DNNs of the indicated S-NSSAI. The key of the map is the DNN. | | +| ueSliceMbr | SliceMbr | O | 0..1 | Subscribed UE-Slice-MBR for the indicated S-NSSAI. | NSAC | + +## 5.4.2.15 Type SmPolicyDnnData + +**Table 5.4.2.15-1: Definition of type SmPolicyDnnData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dnn | Dnn | M | 1 | DNN associated with the data | | +| allowedServices | array(string) | O | 1..N | List of subscriber's allowed service identifiers | | +| subscCats | array(string) | O | 1..N | List of categories associated with the subscriber | | +| gbrUl | BitRate | O | 0..1 | Maximum aggregate UL bitrate that can be provided across all GBR QoS Flows in the DNN | | +| gbrDl | BitRate | O | 0..1 | Maximum aggregate DL bitrate that can be provided across all GBR QoS Flows in the DNN | | +| adcSupport | boolean | O | 0..1 | Indicates whether application detection and control is enabled for the PDU session.
True: Application detection and control is enabled for the PDU session;
False: Application detection and control is not enabled for the PDU session.
The absence of this attribute means that ADC support is not provisioned for the UE and PDU session. | | +| subscSpendingLimits | boolean | O | 0..1 | Indicates whether the PCF must enforce session management related policies based on subscriber spending limits.
True: Spending limit control is enabled;
False: Spending limit control is not enabled.
The absence of this attribute means that spending limit control is not provisioned for the UE and PDU session. | | +| ipv4Index | IpIndex | O | 0..1 | Information that identifies which IP pool or external server is used to allocate the IPv4 address. | | +| ipv6Index | IpIndex | O | 0..1 | Information that identifies which IP pool or external server is used to allocate the IPv6 address. | | +| offline | boolean | O | 0..1 | Indicates whether the offline charging is applicable to the PDU session.
True: Offline charging is applicable to the PDU session;
False: Offline charging is not applicable to the PDU session.
The absence of this attribute means that the charging method is not provisioned for the UE and PDU session. | | +| online | boolean | O | 0..1 | Indicates whether the online charging is applicable to the PDU session.
True: Online charging is applicable to the PDU session;
False: Online charging is not applicable to the PDU session.

The absence of this attribute means that the charging method is not provisioned for the UE and PDU session. | | +| chfInfo | ChargingInformation | O | 0..1 | The address(es) and, if available, the CHF instance ID and the CHF set ID of the Charging Function. (NOTE) | | +| refUmDataLimitIds | map(LimitIdToMonitoringKey) | O | 1..N | A reference to the "UsageMonDataLimit" or "UsageMonData" instances for this DNN and SNSAI that may also include the related monitoring key(s). The key of the map is the limit identifier. | | +| mpsPriority | boolean | O | 0..1 | True: Indicates subscription to the MPS priority service; priority applies to all traffic on the PDU Session.
False: MPS priority service is not subscribed.
The absence of this attribute means that MPS | | + +| | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| +| | | | | priority is not provisioned for the UE and PDU session. | | +| mcsPriority | boolean | O | 0..1 | True: Indicates subscription to the MCS priority service; priority applies to all traffic on the PDU Session.
False: IMS signalling priority service is not subscribed.
The absence of this attribute means that IMS signalling priority is not provisioned for the UE and PDU session. | | +| imsSignallingPrio | boolean | O | 0..1 | True: Indicates subscription to the IMS signalling priority service; priority only applies to IMS signalling traffic.
False: IMS signalling priority service is not subscribed.
The absence of this attribute means that IMS signalling priority is not provisioned for the UE and PDU session. | | +| mpsPriorityLevel | integer | O | 0..1 | Relative priority level for the multimedia priority services | | +| mcsPriorityLevel | integer | O | 0..1 | Relative priority level for the mission critical services | | +| pralInfos | map(PresenceInfo) | O | 1..N | Presence reporting area information. Each PresenceInfo element shall include the Presence Reporting Area Identifier within the "prald" attribute and, for a UE-dedicated presence reporting area, shall also include the list of elements composing the presence reporting area.
A "prald" may indicate a Presence Reporting Area Set.
The "prald" attribute within the PresenceInfo data type shall also be the key of the map.
The attribute "presenceState" shall not be present. | | +| bdtdRefls | map(BdtReferenceIdRm) | O | 1..N | Identifies transfer policies of background data transfer.
Any string value can be used as a key of the map. | EnhancedBackgroundData Transfer | +| locRoutNotAllowed | boolean | O | 0..1 | Identifies whether AF influence on traffic routing is allowed or not.
True: if no local routing is allowed;
False: local routing is allowed.
The absence of this attribute means that AF influence on traffic routing is not provisioned for the UE and PDU session. | | +| sfcNotAllowed | boolean | O | 0..1 | Identifies whether AF influence on Service Function Chaining is allowed or not.
True: if no AF influence on Service Function Chaining is allowed;
False: AF influence on Service Function Chaining allowed.
The absence of this attribute means that AF influence on Service Function Chaining is not provisioned for the UE and PDU session. | SFC | +| tnaps | array(TnapId) | O | 1..N | Contains the TNAP ID(s) collocated with the 5G-RG(s) of a specific user. | AfGuideTNAPs | +| NOTE: When the feature "CHFsetSupport" is supported, the "secondaryChfAddress" may be omitted (see 3GPP TS 29.512 [12], clause 4.2.2.3.1). | | | | | | + +### 5.4.2.16 Type LimitIdToMonitoringKey + +**Table 5.4.2.16-1: Definition of type LimitIdToMonitoringKey** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------|---------------| +| limitId | string | M | 1 | Limit Identifier. | | +| monkey | array(string) | O | 1..N | Monitoring Keys. | | + +NOTE: In this Release of the specification there is only one Monitoring Key per Limit Identifier + +### 5.4.2.17 Type UePolicySetPatch + +**Table 5.4.2.17-1: Definition of type UePolicySetPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| uePolicySections | map(UePolicySection) | O | 1..N | Contains the UE Policy Sections.
The UPSI (UE Policy Section Identifier) is used as the key in the map. | | +| upsis | array(string) | O | 1..N | List of identifiers for the "uePolicySections". The format of the UPSI is represented in 3GPP TS 24.501 [11] clause D.6.2. | | +| andsplnd | boolean | O | 0..1 | Indication of UE supporting ANDSP. | | +| epsUrsplnd | boolean | O | 0..1 | Indication of UE supporting URSP provisioning in EPS.
True: The UE supports URSP provisioning in EPS;
False: The UE does not support URSP provisioning in EPS. | EpsUrsp | +| vpsUrsplnd | boolean | O | 0..1 | Indication of UE supporting VPLMN-specific URSP.
True: The UE supports VPLMN-specific URSP;
False: The UE does not support VPLMN-specific URSP. | VPLMNSpecificURSP | +| urspenflnd | boolean | O | 0..1 | Indication of UE supporting URSP enforcement report.
True: The UE supports URSP enforcement report;
False: The UE does not support URSP enforcement report. | URSPEnforcement | +| pei | Pei | O | 0..1 | Personal Equipment Identifier. | | +| oslds | array(Osld) | O | 1..N | Identification of the UE Operating System(s). | | + +### 5.4.2.18 Type PlmnRouteSelectionDescriptor + +**Table 5.4.2.18-1: Definition of type PlmnRouteSelectionDescriptor** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------|---------------------------------------|---|-------------|----------------------------------------------------------------| +| servingPlmn | PlmnId | M | 1 | Identity of the serving PLMN. | +| snssaiRouteSelectionDescriptors | array(SNSSAIRouteSelectionDescriptor) | O | 1..N | Contains the route selection descriptor parameters per SNSSAI. | + +### 5.4.2.19 Type SnssaiRouteSelectionDescriptor + +**Table 5.4.2.19-1: Definition of type SnssaiRouteSelectionDescriptor** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|------------------------------------|---|-------------|-------------------------------------------------------------| +| snssai | Snssai | M | 1 | SNSSAI. | +| dnnRouteSelDescs | array(DnnRouteSelectionDescriptor) | O | 1..N | Contains the route selection descriptor parameters per DNN. | + +### 5.4.2.20 Type DnnRouteSelectionDescriptor + +**Table 5.4.2.20-1: Definition of type DnnRouteSelectionDescriptor** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| dnn | Dnn | M | 1 | DNN. | | +| sscModes | array(SscMode) | O | 1..N | Contains the allowed SSC modes for the traffic to this DNN. | | +| pduSessTypes | array(PduSessionType) | O | 1..N | Contains the allowed PDU Session types for the traffic to this DNN. | | +| atsssInfo | boolean | O | 0..1 | Indicates whether MA PDU session establishment is allowed for this DNN.
True: MA PDU session establishment is allowed for this DNN.
False: MA PDU session establishment is not allowed for this DNN.
The absence of this attribute means that the ATSSS information is not provisioned for the UE and PDU session. | | +| lboRoamAllowed | boolean | O | 0..1 | Indicates whether local breakout for the DNN and S-NSSAI is allowed when roaming.
true: allowed
false: not allowed.
If the attribute is absent it means not allowed. | VPLMNSpecificURSP | + +### 5.4.2.21 Type SmPolicyDataPatch + +**Table 5.4.2.21-1: Definition of type SmPolicyDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| umData | map(UsageMonData) | O | 1..N | Contains the remaining allowed usage data associated with the subscriber.
The value of the limit identifier is used as the key in the map. | | +| smPolicySnssaiData | map(SmPolicySnssaiDataPatch) | O | 1..N | Modifiable Session Management Policy data per S-NSSAI for all the SNSSAIs of the subscriber.
The key of the map is the S-NSSAI. (NOTE 2) | | + +NOTE 1: In this Release of the specification the "limitId" corresponds to the Monitoring Key. + +NOTE 2: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[7], clause 5.4.4.2. + +### 5.4.2.22 Type SmPolicySnssaiDataPatch + +**Table 5.4.2.22-1: Definition of type SmPolicySnssaiDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | S-NSSAI associated with the data. | | +| smPolicyDnnData | map(SmPolicyDnnDataPatch) | O | 1..N | Modifiable Session Management Policy data per DNN for all the DNNs of the indicated S-NSSAI. The key of the map is the DNN. | | + +### 5.4.2.23 Type SmPolicyDnnDataPatch + +**Table 5.4.2.23-1: Definition of type SmPolicyDnnDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------|----------------------------------------| +| dnn | Dnn | M | 1 | DNN associated with the data | | +| bdtRefls | map(BdtRefere
nceldRm) | O | 1..N | Updated transfer policies of background data transfer.
Any string value can be used as a key of the map. | EnhancedBac
kgroundData
Transfer | + +### 5.4.2.24 Type ResourceItem + +**Table 5.4.2.24-1: Definition of type ResourceItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| monResourceUri | Uri | M | 1 | Represents the URI that identifies the monitored resource as defined in table 5.2.2-1.
(NOTE) | | +| items | array(ItemPath) | M | 1..N | Represents fragments of the resource identified by the "monResourceUri" attribute, i.e. a subset of resource data, for which a modification triggers a notification. | | + +NOTE: The resource URI included in the "monResourceUri" attribute shall be one of the resource URIs included in the "monitoredResourceUris" attribute of the PolicyDataSubscription data type. + +### 5.4.2.25 Type NotificationItem + +**Table 5.4.2.25-1: Definition of type NotificationItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| resourceId | Uri | M | 1 | This IE contains the URI of the resource which has been changed. | | +| notifItems | array(UpdatedItem) | M | 1..N | This IE contains the fragments of the resource identified by the "resourceId" attribute which have been updated or requested to be notified. | | + +### 5.4.2.26 Type UpdatedItem + +**Table 5.4.2.26-1: Definition of type UpdatedItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| item | ItemPath | M | 1 | This IE contains a JSON pointer value (as defined in IETF RFC 6901 [20]) that references a target location within the resource that identifies the resource fragment. | | +| value | Any type | M | 1 | This IE indicates the value of the resource fragment located at the target location within the resource specified in the "item" attribute.
The data type of this attribute shall be the same as the type of the attribute or element located in the path.
The null value shall be allowed. | | + +### 5.4.2.27 Type BdtDataPatch + +**Table 5.4.2.27-1: Definition of type BdtDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------| +| bdtStatus | BdtPolicyStatus | O | 0..1 | Contains the validation status for a negotiated BDT policy. It shall be included when the BDT policy is re-negotiated. | +| transPolicy | TransferPolicy | O | 0..1 | This IE contains the transfer policy. | +| warnNotifEnabled | boolean | O | 0..1 | This IE indicates whether the BDT warning notification is enabled or disabled.
true: enabled;
false: disabled. | + +### 5.4.2.28 Type PolicyDataForIndividualUe + +**Table 5.4.2.28-1: Definition of type PolicyDataForIndividualUe** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uePolicyDataSet | UePolicySet | O | 0..1 | The IE contains UE policies. | | +| smPolicyDataSet | SmPolicyData | O | 0..1 | The IE contains SM policies. | | +| amPolicyDataSet | AmPolicyData | O | 0..1 | The IE contains AM policies. | | +| umData | map(UsageMonData) | C | 1..N | The IE contains UM policies.
The value of the limit identifier is used as the key of the map.
(NOTE) | | +| operatorSpecificDataSet | map(OperatorSpecificDataContainer) | O | 1..N | The IE contains operator specific data.
The key of the map is operator specific data element name and the value is the operator specific data of the UE. | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.
This parameter shall be provided if the NF service consumer has provided a list of supported features in its request. | | + +NOTE: The "umData" attribute shall be absent when the smPolicyDataSet attribute is present and includes the "umData" attribute. + +### 5.4.2.29 Type SlicePolicyData + +**Table 5.4.2.29-1: Definition of type SlicePolicyData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbrUI | BitRate | O | 0..1 | Maximum aggregate UL data rate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. (NOTE 1) | | +| mbrDI | BitRate | O | 0..1 | Maximum aggregate DL data rate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. (NOTE 1) | | +| remainMbrUI | BitRate | O | 0..1 | The remaining maximum aggregate UL data rate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. (NOTE 2)
It is set to the maximum allowed aggregate UL data rate across all GBR and Non-GBR QoS Flows in the S-NSSAI when the system is initially configured based on operator policies. | | +| remainMbrDI | BitRate | O | 0..1 | The remaining maximum aggregate DL data rate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. (NOTE 2)
It is set to the maximum allowed aggregate DL data rate across all GBR and Non-GBR QoS Flows in the S-NSSAI when the system is initially configured based on operator policies. | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.
It shall be provided in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. | | + +NOTE 1: The "mbrUI" and "mbrDI" attributes are only used for limiting data rate per network slice with assistance of the NWDAF. + +NOTE 2: The "remainMbrUI" and "remainMbrDI" attributes are only used for limiting data rate per network slice with PCF based monitoring. + +### 5.4.2.30 Type SlicePolicyDataPatch + +**Table 5.4.2.30-1: Definition of type SlicePolicyDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------|---------------| +| remainMbrUI | BitRate | O | 0..1 | The remaining maximum aggregate UL bitrate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. | | +| remainMbrDI | BitRate | O | 0..1 | The remaining maximum aggregate DL bitrate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. | | +| NOTE: At least one of the attributes shall be included. | | | | | | + +### 5.4.2.31 Type MbsSessPolCtrlData + +**Table 5.4.2.31-1: Definition of type MbsSessPolCtrlData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------|---------------| +| 5qis | array(5Qi) | O | 1..N | Contains the list of allowed 5QI(s) for an MBS PCC rule of the MBS Session. | | +| maxMbsArpLevel | ArpPriorityLevel | O | 0..1 | Contains the highest ARP level value allowed for any MBS PCC rule of the MBS Session. | | +| maxMbsSessionAmbr | BitRate | O | 0..1 | Contains the maximum MBS Session-AMBR for all non-GBR QoS flows of an MBS session in the downlink. | | +| maxGbr | BitRate | O | 0..1 | Contains the maximum aggregated bitrate that can be provided across all the GBR QoS Flows for an MBS session in the downlink. | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.
This parameter shall be provided if feature negotiation needs to take place. | | + +### 5.4.2.32 Type MbsSessPolDataId + +**Table 5.4.2.32-1: Definition of type MbsSessPolDataId** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|------------------------------------------------------------------------------------------|---------------| +| mbsSessionId | MbsSessionId | C | 0..1 | Contains the source specific multicast address used as MBS session identifier.
(NOTE) | | +| afAppId | string | C | 0..1 | Contains the AF application identifier.
(NOTE) | | + +NOTE: Either the "mbsSessionId" attribute or the "afAppId" attribute shall be provided. + +## 5.4.2.33 Type PdtqData + +Table 5.4.2.33-1: Definition of type PdtqData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aspld | string | M | 1 | This IE contains an identity of an application service provider. | +| pdtqPolicy | PdtqPolicy | M | 1 | This IE contains the PDTQ policy. | +| appld | ApplicationId | O | 0..1 | This IE contains an application identifier. | +| pdtqReflId | PdtqReferenceId | O | 0..1 | This IE indicates the PDTQ reference ID for the PDTQ policy. | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | This IE represents a network area information. | +| numOfUes | UInteger | O | 0..1 | This IE contains the number of UEs using the indicated PDTQ policy. It shall be present when available. | +| desTimeInts | array(TimeWindow) | O | 1..N | This IE contains a list of desired time windows for PDTQ. | +| dnn | Dnn | O | 0..1 | This IE identifies a DNN. | +| snssai | Snssai | O | 0..1 | This IE identifies a slice. | +| qosParamSet | QosParameterSet | O | 0..1 | Contains the requested QoS requirements expressed as one or more individual QoS parameters.
(NOTE 3) | +| qosReference | string | O | 0..1 | Contains the requested QoS requirements expressed as the QoS Reference which represents a pre-defined QoS information.
(NOTE 2) | +| altQosParamSets | array(AltQosParamSet) | O | 1..N | Contains the alternative QoS requirements expressed as the list of individual QoS parameter sets in a prioritized order. The lower the index of the array for a given entry, the higher the priority.
(NOTE 3) | +| altQosRefs | array(string) | O | 1..N | Contains the alternative QoS requirements expressed as the list of QoS References in a prioritized order. The lower the index of the array for a given entry, the higher the priority.
(NOTE 2) | +| notifUri | Uri | O | 0..1 | This IE contains an URI of the recipient of the PDTQ warning notification. | +| warnNotifEnabled | boolean | O | 0..1 | This IE indicates whether the PDTQ warning notification is enabled or disabled.

true: enabled;
false: disabled (default). | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.6.
This attribute shall be provided in the PUT request and in the response of successful resource creation, and in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE). | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | + +NOTE 1: In the HTTP request, it represents the set of features supported by the NF service consumer. In the HTTP response, it represents the set of features supported by both the NF service consumer and the UDR. + +NOTE 2: The "altQosRefs" attribute may be included only if the "qosReference" attribute is included. + +NOTE 3: The "altQosParamSets" attribute may be included only if the "qosParamSet" attribute is included. + +### 5.4.2.34 Type PdtqDataPatch + +**Table 5.4.2.34-1: Definition of type PdtqDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| pdtqPolicy | PdtqPolicy | O | 0..1 | This IE contains the PDTQ policy. | +| warnNotifEnabled | boolean | O | 0..1 | This IE indicates whether the PDTQ warning notification is enabled or disabled.

true: enabled;
false: disabled | +| notifUri | Uri | O | 0..1 | This IE contains an URI of the recipient of the PDTQ warning notification. | + +### 5.4.2.35 Type GroupPolicyData + +**Table 5.4.2.35-1: Definition of type GroupPolicyData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| remainGroupMbrUl | BitRate | O | 0..1 | The remaining maximum aggregate UL data rate that can be provided across all GBR and Non-GBR QoS Flows in the 5G VN group.

(NOTE) | | +| remainGroupMbrDl | BitRate | O | 0..1 | The remaining maximum aggregate DL data rate that can be provided across all GBR and Non-GBR QoS Flows in the 5G VN group.

(NOTE) | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.

It shall be provided only when feature negotiation needs to take place. | | + +NOTE: The initial value of these attributes shall be set based on the Maximum Group Data Rate information and/or operator policies. + +### 5.4.2.36 Type GroupPolicyDataPatch + +**Table 5.4.2.36-1: Definition of type GroupPolicyDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------|---------------| +| remainGroupMbrUl | BitRate | O | 0..1 | The remaining maximum aggregate UL bitrate that can be provided across all GBR and Non-GBR QoS Flows of the 5G VN group.

(NOTE) | | +| remainGroupMbrDl | BitRate | O | 0..1 | The remaining maximum aggregate DL bitrate that can be provided across all GBR and Non-GBR QoS Flows of the 5G VN group.

(NOTE) | | + +NOTE: At least one of these attributes shall be included. + +## 5.4.3 Simple data types and enumerations + +### 5.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 5.4.3.2 Simple data types + +The simple data types defined in table 5.4.3.2-1 shall be supported. + +**Table 5.4.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| +| BdtReferenceIdRm | string | This data type is defined in the same way as the "BdtReferenceId" data type defined in 3GPP TS 29.122 [9], but with the "nullable: true" property. | EnhancedBackgroundDataTransfer | +| IpIndex | integer | Information that identifies which IP pool or external server is used to allocate the IP address. | | +| ItemPath | string | It contains one JSON pointer value (as defined in IETF RFC 6901 [20]) that references a target location within the resource.
E.g. "/smPolicySnssaiData/" represents the subscription to data changes in the SmPolicyData data document, in particular to the element of the "smPolicySnssaiData" map whose key is identified by the value.
E.g. 2
"/smPolicySnssaiData//smPolicyDnnData/" represents the subscription to data changes in the SmPolicyData data document, in particular to the element of the "smPolicySnssaiData" map whose key is identified by the value and, within this one, to the element of the "smPolicyDnnData" map whose key is identified by the value.
(NOTE) | ConditionalSubscriptionwithPartialNotification | +| OsId | string | Operating System of the served UE. It contains a Universally Unique Identifier (UUID) as specified in IETF RFC 4122 [17]. The format of the OS Id is represented in 3GPP TS 24.501 [11]. | | + +NOTE: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[7], clause 5.4.4.2. + +### 5.4.3.3 Enumeration: UsageMonLevel + +The enumeration represents the usage monitoring level. It shall comply with the provisions defined in table 5.4.3.3-1. + +**Table 5.4.3.3-1: Enumeration UsageMonLevel** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------------------| +| SESSION_LEVEL | The usage monitoring is applicable for PDU session level. | +| SERVICE_LEVEL | The usage monitoring is applicable for service level. | + +### 5.4.3.4 Enumeration: Periodicity + +The enumeration represents the time period. It shall comply with the provisions defined in table 5.4.3.4-1. + +**Table 5.4.3.4-1: Enumeration Periodicity** + +| Enumeration value | Description | +|-------------------|------------------------| +| YEARLY | Time period is yearly | +| MONTHLY | Time period is monthly | +| WEEKLY | Time period is weekly | +| DAILY | Time period is daily | +| HOURLY | Time period is hourly | + +#### 5.4.3.5 Enumeration: BdtPolicyStatus + +The enumeration represents the validation status of the BDT policy. It shall comply with the provisions defined in table 5.4.3.5-1. + +**Table 5.4.3.5-1: Enumeration BdtPolicyStatus** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| INVALID | This value is used to indicate that the BDT policy is invalid while the BDT policy re-negotiation is ongoing because the network performance has degraded. | +| VALID | This value is used to indicate that the BDT policy is valid. | + +#### 5.4.3.6 Enumeration: PolicyDataSubset + +This enumeration indicates the policy data subsets (e.g. AM policy data, SM policy data, etc.). It shall comply with the provisions of table 5.4.3.6-1. + +**Table 5.4.3.6-1: Enumeration PolicyDataSubset** + +| Enumeration value | Description | +|------------------------|-------------------------| +| AM_POLICY_DATA | AM policy data. | +| SM_POLICY_DATA | SM policy data. | +| UE_POLICY_DATA | UE policy data. | +| UM_DATA | Usage Monitoring data. | +| OPERATOR_SPECIFIC_DATA | Operator specific data. | + +#### 5.4.3.7 void + +### 5.5 Error handling + +#### 5.5.1 General + +For the Nudr\_DataRepository service API for Policy Data, 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 Nudr\_DataRepository service API for Policy Data. + +#### 5.5.2 Protocol Errors + +No specific procedures for the Nudr\_DataRepository service API for Policy Data are specified. + +### 5.5.3 Application Errors + +The application errors defined for the Nudr\_DataRepository service API for Policy Data are listed in table 5.5.3-1. + +**Table 5.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------| +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated by other clauses in this document. | | | + +The application error handling shall follow 3GPP TS 29.504 [6] clause 6.1.6 unless explicitly specified in this document. + +## 5.6 Feature negotiation + +The optional features in table 6.1.8-1 of 3GPP TS 29.504 [6] are defined for the Nudr\_DataRepository API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +--- + +# 6 Usage of Nudr\_DataRepository Service API for Application Data + +## 6.1 Introduction + +The following clauses specify the usage of Nudr\_DataRepository service for application data. The principles specified in 3GPP TS 29.504 [6] are followed unless explicitly specified otherwise in the following clauses. + +## 6.2 Resources + +### 6.2.1 Overview + +This clause specifies the resources for the usage of the Unified Data Repository service for Application Data. + +### 6.2.2 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.2.2-1 depicts the resource URIs structure for the Nudr\_DataRepository API for application data + +![A hierarchical tree diagram showing the structure of {apiRoot}/nudr-dr//application-data. The root branches into several categories: /pfd, /influenceData, /bdtPolicyData, /iptvConfigData, /serviceParamData, /am-influence-data, /subs-to-notify, /eas-deploy-data, and /af-qos-data-sets. Each category has its own sub-elements, some with placeholder variables like {appId} or {influenceId}.](e7010c66da16316c2935dfbbef5056b3_img.jpg) + +``` +graph TD; Root["{apiRoot}/nudr-dr/"] --- AppData["/application-data"]; AppData --- Pfd["/pfd"]; AppData --- InfluenceData["/influenceData"]; AppData --- BdtPolicyData["/bdtPolicyData"]; AppData --- IptvConfigData["/iptvConfigData"]; AppData --- ServiceParamData["/serviceParamData"]; AppData --- AmInfluenceData["/am-influence-data"]; AppData --- SubsToNotify1["/subs-to-notify"]; AppData --- EasDeployData["/eas-deploy-data"]; AppData --- AfQosDataSets["/af-qos-data-sets"]; Pfd --- AppId["/{appId}"]; InfluenceData --- InfluenceId["/{influenceId}"]; InfluenceData --- SubsToNotify2["/subs-to-notify"]; SubsToNotify2 --- SubscriptionId["/{subscriptionId}"]; BdtPolicyData --- BdtPolicyId["/{bdtPolicyId}"]; IptvConfigData --- ConfigurationId["/{configurationId}"]; ServiceParamData --- ServiceParamId["/{serviceParamId}"]; AmInfluenceData --- AmInfluenceId["/{amInfluenceId}"]; SubsToNotify1 --- SubId["/{subId}"]; EasDeployData --- EasDeployInfoId["/{easDeployInfoId}"]; AfQosDataSets --- AfReqQosId["/{afReqQosId}"]; +``` + +A hierarchical tree diagram showing the structure of {apiRoot}/nudr-dr//application-data. The root branches into several categories: /pfd, /influenceData, /bdtPolicyData, /iptvConfigData, /serviceParamData, /am-influence-data, /subs-to-notify, /eas-deploy-data, and /af-qos-data-sets. Each category has its own sub-elements, some with placeholder variables like {appId} or {influenceId}. + +**Figure 6.2.2-1: Resource URI structure of the Nudr\_DataRepository API for application data** + +Table 6.2.2-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.2-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------------|------------------------------------------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PFD Data | /application-data/pfds | GET | Retrieve PFDs for application identifier(s) identified by query parameter(s).
Retrieve PFDs for all application identifier(s) if no query parameter is included in the Request URI. | +| Individual PFD Data | /application-data/pfds/{appId} | GET | Retrieve the corresponding PFDs of the specified application identifier. | +| | | DELETE | Delete the corresponding PFDs of the specified application identifier. | +| | | PUT | Create or update the corresponding PFDs for the specified application identifier. | +| Influence Data | /application-data/influenceData (NOTE) | GET | Retrieve the Session Influence Data of given services, S-NSSAIs and DNNs or Internal Group Identifier(s) or Subscriber Category(ies) or SUPIs. | +| Individual Influence Data | /application-data/influenceData/{influenceId} (NOTE) | PUT | Create an individual Influence Data resource identified by {influenceId}, or modify all of the properties of an individual Influence Data resource identified by {influenceId}. | +| | | PATCH | Modify part of the properties of an individual Influence Data resource identified by {influenceId}. | +| | | DELETE | Delete an individual Influence Data resource identified by {influenceId}. | +| Influence Data Subscription | /application-data/influenceData/subs-to-notify (NOTE) | POST | Create a new Individual Influence Data Subscription resource. | +| | | GET | Read subscriptions for a given S-NSSAI and DNN or Internal Group Identifier(s) or Subscriber Category(ies) or SUPI. | +| Individual Influence Data Subscription | /application-data/influenceData/subs-to-notify/{subscriptionId} (NOTE) | GET | Get an existing individual Influence Data Subscription resource identified by {subscriptionId}. | +| | | PUT | Modify an existing individual Influence Data Subscription resource identified by {subscriptionId}. | +| | | DELETE | Delete an individual Influence Data Subscription resource identified by {subscriptionId}. | +| Applied BDT Policy Data | /application-data/bdtPolicyData (NOTE) | GET | Retrieve the applied BDT policy data. | +| Individual Applied BDT Policy Data | /application-data/bdtPolicyData/{bdtPolicyId} (NOTE) | PUT | Create an individual applied BDT Policy Data resource identified by {bdtPolicyId}. | +| | | PATCH | Modify BDT Reference Id of an individual applied BDT Policy Data resource identified by {bdtPolicyId}. | +| | | DELETE | Delete an individual applied BDT Policy Data resource identified by {bdtPolicyId}. | +| IPTV Configurations | /application-data/iptvConfigData (NOTE) | GET | Retrieve IPTV configurations for configuration identifier(s), given S-NSSAI(s) and DNN(s), or SUPIs or Internal Group Identifiers | +| Individual IPTV Configuration | /application-data/iptvConfigData/{configurationId} (NOTE) | PUT | Create an Individual IPTV Configuration resource identified by {configurationId}, or modify all the properties of an Individual IPTV Configuration resource identified by {configurationId}. | +| | | PATCH | Modify some properties of an Individual IPTV Configuration resource | + +| | | | | +|--------------------------------------------|------------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | identified by {configurationId}. | +| | | DELETE | Delete an Individual IPTV Configuration resource identified by {configurationId} | +| Service Parameter Data | /application-data/serviceParamData (NOTE) | GET | Retrieve the Service Parameter Data of given services, S-NSSAIs and DNNs or Internal Group Identifiers or SUPIs. | +| Individual Service Parameter Data | /application-data/serviceParamData/{serviceParamId} (NOTE) | PUT | Create an individual Service Parameter Data resource identified by {serviceParamId}, or modify all of the properties of an individual Service Parameter Data resource identified by {serviceParamId}. | +| | | PATCH | Modify part of the properties of an individual Service Parameter Data resource identified by {serviceParamId}. | +| | | DELETE | Delete an individual Service Parameter Data resource identified by {serviceParamId}. | +| AM Influence Data | /application-data/am-influence-data | GET | Retrieve the AM Influence Data of given S-NSSAIs and DNNs and/or Internal Group Identifiers or SUPIs or for LBO roaming scenarios, any inbound roaming UEs identified by their home PLMN ID(s). | +| Individual AM Influence Data | /application-data/am-influence-data/{amInfluenceId} | PUT | Create an individual AM Influence Data resource identified by {amInfluenceId}, or modify all of the properties of an individual AM Influence Data resource identified by {amInfluenceId}. | +| | | PATCH | Modify part of the properties of an individual AM Influence Data resource identified by {amInfluenceId}. | +| | | DELETE | Delete an individual AM Influence Data resource identified by {amInfluenceId}. | +| ApplicationDataSubscriptions | /application-data/subs-to-notify | POST | Create a subscription to receive notification of application data changes. | +| | | GET | Read all the subscriptions, or subscriptions for given S-NSSAI and DNN or Internal Group Identifier or SUPI. | +| IndividualApplicationDataSubscription | /application-data/subs-to-notify/{subsId} | PUT | Modify a subscription to receive notification of application data changes identified by {subsId}. | +| | | DELETE | Delete a subscription identified by {subsId}. | +| | | GET | Read an existing individual Subscription resource identified by {subsId}. | +| EAS Deployment Information Data | /application-data/eas-deploy-data | GET | Retrieve the EAS Deployment Information Data, given DNN(s), S-NSSAI(s), Application ID or Internal Group Identifiers. | +| Individual EAS Deployment Information Data | /application-data/eas-deploy-data/{easDeployInfoId} | GET | Read an existing individual EAS Deployment Data identified by {easDeployInfoId}. | + +| | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | PUT | Create an individual EAS deployment information Data resource identified by {easDeployInfoId} or Update an individual EAS Deployment Data resource identified by {easDeployInfoId}. | +| | | DELETE | Delete an individual EAS Deployment Data resource identified by {easDeployInfoId}. | +| AF Requested QoS Data Sets | /application-data/af-qos-data-sets | GET | Retrieve one or several existing AF Requested QoS Data Set(s). | +| Individual AF Requested QoS Data Set | /application-data/af-qos-datasets/{afReqQosId} | PUT | Create an Individual AF Requested QoS Data Set or update an existing Individual AF Requested QoS Data Set. | +| | | PATCH | Modify an existing Individual AF Requested QoS Data Set. | +| | | DELETE | Delete an existing Individual AF Requested QoS Data Set. | +| Individual DNAI EAS Mapping | /application-data/dnai-eas-mappings/{dnai} | GET | Retrieve the EAS address information for a DNAI. | +| ECS Address Roaming Data | /application-data/ecs-address-roaming | GET | Retrieve all existing ECS Address Configuration Information for roaming UEs. | +| Individual ECS Address Roaming Data | /application-data/ecs-address-roaming/{ecsAddrInfoId} | GET | Retrieve an existing ECS Address Configuration Information entry for roaming UEs. | +| | | PUT | Create or Update an ECS Address Configuration Information entry for roaming UEs. | +| | | DELETE | Delete an existing ECS Address Configuration Information entry for roaming UEs. | +| NOTE: The path segment does not follow the related naming convention defined in 3GPP TS 29.501 [5]. The path segment is kept though as defined in the current specification for backward compatibility considerations. | | | | + +## 6.2.3 Resource: PFD Data + +### 6.2.3.1 Description + +The PFD Data resource represents all the PFD Datas to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.3.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/pfds + +**Table 6.2.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.3.3 Resource Standard Methods + +#### 6.2.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.3.1-1. + +**Table 6.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| appId
(NOTE) | array(ApplicationId) | O | 1..N | Contains the information of the application identifier(s) for the querying PFD Data resource.
If the appId query parameter is not included in the URI, the query applies to all application identifier(s) for the querying PFD Data resource.
If the appId array contains one or more ApplicationId entries, the UDR returns an Individual PFD Data resource representation for each matched ApplicationId. | +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +NOTE: The query parameter does not follow the related naming convention (i.e. "lower-with-hyphen") defined in clause 5.1.3.3 of 3GPP TS 29.501 [7]. This query parameter is however kept as currently defined in this specification for backward compatibility considerations. + +This method shall support the request data structures specified in table 6.2.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.1-3. + +**Table 6.2.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PfdDataForAppExt) | M | 0..N | 200 OK | A representation of PFDs for request applications is returned.
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. | + +## 6.2.4 Resource: Individual PFD Data + +### 6.2.4.1 Description + +The Individual PFD Data resource represents Individual PFD Datas to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.4.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/pfds/{appId} + +This resource shall support the resource URI variables defined in table 6.2.4.2-1. + +**Table 6.2.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|---------------|---------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| appId | ApplicationId | Indicates the application identifier for the request pfd(s).
Data type ApplicationId is defined in 3GPP TS 29.571 [7]. | + +### 6.2.4.3 Resource Standard Methods + +#### 6.2.4.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.4.3.1-1. + +**Table 6.2.4.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 6.2.4.3.1-2 and the response data structures and response codes specified in table 6.2.4.3.1-3. + +**Table 6.2.4.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.4.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| PfdDataForAppExt | M | 1 | 200 OK | A representation of PFDs for the request application identified by the application identifier is returned. | +| 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. | | | | | + +## 6.2.4.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.4.3.2-1. + +**Table 6.2.4.3.2-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 6.2.4.3.2-2 and the response data structures and response codes specified in table 6.2.4.3.2-3. + +**Table 6.2.4.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.4.3.2-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 PFD Data resource related to the application identifier was deleted. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.4.3.3 PUT + +This method shall support the URI query parameters specified in table 6.2.4.3.3-1. + +**Table 6.2.4.3.3-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 6.2.4.3.3-2 and the response data structures and response codes specified in table 6.2.4.3.3-3. + +**Table 6.2.4.3.3-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------------------------------------------| +| PfdDataForAppEx
t | M | 1 | Contains the information for the creation or modification of an individual PFD Data resource. | + +**Table 6.2.4.3.3-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| PfdDataForAppEx
t | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| PfdDataForAppEx
t | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | + +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 6.2.4.3.3-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}/nudr-dr//application-data/pfds/{appId} | + +## 6.2.5 Resource: Influence Data + +### 6.2.5.1 Description + +The Influence Data resource represents a Traffic Influence Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.5.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/influenceData + +This resource shall support the resource URI variables defined in table 6.2.5.2-1. + +**Table 6.2.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.5.3 Resource Standard Methods + +#### 6.2.5.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.5.3.1-1. + +**Table 6.2.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| influence-Ids
(NOTE 2) | array(string) | O | 1..N | Each element identifies a influenceId, i.e. an Individual Influence Data resource.
(NOTE 1) | +| dnns | array(Dnn) | O | 1..N | Each element identifies a DNN. The UDR shall return only Individual Influence Data resource(s) that match one of the provided DNNs.
(NOTE 1) | +| snssais | array(SNSSAI) | O | 1..N | Each element identifies a slice. The UDR shall return only Individual Influence Data resource(s) that match one of the provided S-NSSAIs.
(NOTE 1) | +| internal-Group-Ids
(NOTE 2) | array(GroupId) | O | 1..N | Each element identifies a group of users. The UDR shall return only Individual Influence Data resource(s) that match one of the provided internal group IDs within the "interGroupId" attribute.
(NOTE 1) | +| internal-group-ids-add | array(GroupId) | O | 1..N | Each element identifies an internal group id. The UDR shall return only Individual Influence Data resource(s) that match all the provided internal group IDs within the "interGroupIdList" attribute. | +| subscriber-categories | array(string) | O | 1..N | Each element identifies a subscriber category. The UDR shall return only Individual Influence Data resource(s) that match all the provided subscriber category(ies). | +| supis | array(Supi) | O | 1..N | Each element identifies a user. The UDR shall return only Individual Influence Data resource(s) that match one of the provided SUPIs.
(NOTE 1) | +| supp-feat | SupportedFeatures | O | 0..1 | Identifies the features supported by the NF service consumer. | + +NOTE 1: At least one of the "influence-Ids", "dnns", "snssais", "internal-Group-Ids", "internal-group-ids-add" (may be included when FinerGranUEs feature is supported) or "supis" query parameters shall be provided. + +NOTE 2: The query parameter does not follow the related naming convention (i.e. "lower-with-hyphen") defined in clause 5.1.3.3 of 3GPP TS 29.501 [7]. This query parameter is however kept as currently defined in this specification for backward compatibility considerations. + +NOTE: The combination of a. "internal-Group-Ids" and the "supis", b. "internal-group-ids-add" and the "supis", c. "subscriber-categories" and the "supis" and d. "internal-Group-Ids" and the "internal-group-ids-add" query parameter represent mutually exclusive resource properties, i.e., if both query parameters are simultaneously present in the same request, the search will not match any resource. + +When the request query contains more than one optional query parameters defined as an array, the UDR shall return the Individual Influence Data resources for each matching combination of the values of the elements of the array of the provided query parameters. + +EXAMPLE: If "snssais" query parameter is included with two S-NSSAI entries (S-NSSAI\_1 and S-NSSAI\_2) and "dnns" is included with two DNN entries (e.g. DNN\_A and DNN\_B), and the other optional query parameters are not included, the UDR shall return the Individual Influence Data resources for each matching S-NSSAI and DNN combination (for all the possible values for supi and groupId), i.e., the resource(s) matching SNSSAI\_1 and DNN\_A, the resource(s) matching SNSSAI\_1 and DNN\_B, the resource(s) matching SNSSAI\_2 and DNN\_A, and the resource(s) matching SNSSAI\_2 and DNN\_B. + +To query for the Individual Influence Data resource(s) that apply to any UE, an entry of the "internal-Group-Ids" shall be set to "AnyUE". + +This method shall support the request data structures specified in table 6.2.5.3.1-2 and the response data structures and response codes specified in table 6.2.5.3.1-3. + +**Table 6.2.5.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.5.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------| +| array(TrafficInfluData) | M | 0..N | 200 OK | The Traffic Influence Data stored in the UDR are returned. | +| 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. | | | | | + +## 6.2.6 Resource: Individual Influence Data + +### 6.2.6.1 Description + +The Individual Influence Data resource represents an Individual Traffic Influence Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.6.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/influenceData/{influenceId} + +This resource shall support the resource URI variables defined in table 6.2.6.2-1. + +**Table 6.2.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| influenceId | string | The Identifier of an Individual Influence Data to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. | + +### 6.2.6.3 Resource Standard Methods + +#### 6.2.6.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.6.3.1-1. + +**Table 6.2.6.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.6.3.1-2 and the response data structures and response codes specified in table 6.2.6.3.1-3. + +**Table 6.2.6.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------| +| TrafficInfluData | M | 1 | The Traffic Influence Data to be stored in the UDR. | + +**Table 6.2.6.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| TrafficInfluData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| TrafficInfluData | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| 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 6.2.6.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}/nudr-dr//application-data/influenceData/{influenceId} | + +## 6.2.6.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.6.3.2-1. + +**Table 6.2.6.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.6.3.2-2 and the response data structures and response codes specified in table 6.2.6.3.2-3. + +**Table 6.2.6.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------------------------------------| +| TrafficInfluDataPatch | M | 1 | The Traffic Influence Data to be updated in the UDR. | + +**Table 6.2.6.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| TrafficInfluData | M | 1 | 200 OK | The update of an Individual Traffic Influence Data resource is confirmed and a response body containing Traffic Influence Data shall be returned. | +| n/a | | | 204 No Content | The Individual Traffic Influence Data resource has been successfully updated. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.6.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.6.3.3-1. + +**Table 6.2.6.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.6.3.3-2 and the response data structures and response codes specified in table 6.2.6.3.3-3. + +**Table 6.2.6.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 6.2.6.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 | The Individual Influence Data was deleted successfully. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.7 Resource: Influence Data Subscription + +### 6.2.7.1 Description + +The Influence Data Subscription resource represents all Influence Data subscriptions to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.7.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/influenceData/subs-to-notify + +This resource shall support the resource URI variables defined in table 6.2.7.2-1. + +**Table 6.2.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.7.3 Resource Standard Methods + +#### 6.2.7.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.7.3.1-1. + +**Table 6.2.7.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.7.3.1-2 and the response data structures and response codes specified in table 6.2.7.3.1-3. + +**Table 6.2.7.3.1-2: 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 Traffic Influence Data. | + +**Table 6.2.7.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------| +| TrafficInfluSub | M | 1 | 201 Created | The subscription was created successfully. | +| 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 6.2.7.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}/nudr-dr//application-data/influenceData/subs-to-notify/{subscriptionId} | + +### 6.2.7.3.2 GET + +This method shall support the URI query parameters specified in table 6.2.7.3.2-1. + +**Table 6.2.7.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|---|-------------|----------------------------------------------------------------------------------------------| +| dnn | Dnn | O | 0..1 | Identifies a DNN. (NOTE 1) | +| snssai | Snssai | O | 0..1 | Identifies a slice. (NOTE 1) | +| internal-Group-Id (NOTE 3) | GroupId | O | 0..1 | Identifies a group of users. (NOTE 1) (NOTE 2) (NOTE 4) | +| internal-group-ids | array(GroupId) | O | 1..N | Identifies a group of users that belong to all the listed internal groups. (NOTE 1) (NOTE 4) | +| subscriber-categories | array(string) | O | 1..N | Identifies a list of subscriber category. | +| supi | Supi | O | 0..1 | Identifies a user. | +| NOTE 1: At least one of "dnn", "snssai" or "internal-Group-Id" or "internal-group-ids"(may be included when FinerGranUEs feature is supported) shall be provided. | | | | | +| NOTE 2: For the Traffic Influence Data applies to any UE, the "internal-Group-Id" sets to "AnyUE". | | | | | +| NOTE 3: The query parameter does not follow the related naming convention (i.e. "lower-with-hyphen") defined in clause 5.1.3.3 of 3GPP TS 29.501 [7]. This query parameter is however kept as currently defined in this specification for backward compatibility considerations. | | | | | +| NOTE 3: Attributes "internal-Group-Id" and "internal-group-ids" are mutually exclusive attributes. | | | | | + +This method shall support the request data structures specified in table 6.2.7.3.2-2 and the response data structures and response codes specified in table 6.2.7.3.2-3. + +**Table 6.2.7.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.7.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------| +| array(TrafficInfluSub) | M | 0..N | 200 OK | The subscription information as request in the request URI query parameter(s) are returned. | +| 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. | | | | | + +## 6.2.8 Resource: Individual Influence Data Subscription + +### 6.2.8.1 Description + +The Individual Influence Data Subscription resource represents a single Influence Data subscription to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.8.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/influenceData/subs-to-notify/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.8.2-1. + +**Table 6.2.8.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| subscriptionId | string | Identifies an Individual Influence Data Subscription resource. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. | + +### 6.2.8.3 Resource Standard Methods + +#### 6.2.8.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.8.3.1-1. + +**Table 6.2.8.3.1-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 6.2.8.3.1-2 and the response data structures and response codes specified in table 6.2.8.3.1-3. + +**Table 6.2.8.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.8.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|----------------|-------------------------------------------| +| TrafficInfluSub | M | 1 | 200 OK | The subscription information is returned. | + +#### 6.2.8.3.2 PUT + +This method shall support the URI query parameters specified in table 6.2.8.3.2-1. + +**Table 6.2.8.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 6.2.8.3.2-2 and the response data structures and response codes specified in table 6.2.8.3.2-3. + +**Table 6.2.8.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|------------------------------------------------------------| +| TrafficInfluSub | M | 1 | Modify an existing subscription to Traffic Influence Data. | + +**Table 6.2.8.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|----------------------------------------------------------------------------------------------------------------------|-------------|----------------|-------------------------------------------------| +| TrafficInfluSub | M | 1 | 200 OK | The subscription was updated successfully. | +| n/a | | | 204 No Content | The subscription has been successfully updated. | +| 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. | | | | + +### 6.2.8.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.8.3.3-1. + +**Table 6.2.8.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 6.2.8.3.3-2 and the response data structures and response codes specified in table 6.2.8.3.3-3. + +**Table 6.2.8.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.8.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 | The subscription was terminated successfully. | +| NOTE: | The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | + +## 6.2.9 Resource: Applied BDT Policy Data + +### 6.2.9.1 Description + +The Applied BDT Policy Data resource represents an applied BDT Policy Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.9.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/bdtPolicyData + +This resource shall support the resource URI variables defined in table 6.2.9.2-1. + +**Table 6.2.9.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +## 6.2.9.3 Resource Standard Methods + +### 6.2.9.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.9.3.1-1. + +**Table 6.2.9.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| bdtpolicy-ids | array(string) | O | 1..N | Each element identifies a bdtPolicyId, i.e., an identifier of an Individual BDT Policy Data resource. The UDR shall return an Individual Applied BDT Policy Data resource for each matched bdtPolicyId. | +| internal-group-ids | array(GroupId) | O | 1..N | Each element identifies a group of users. The UDR shall return only Individual Applied BDT Policy Data resource(s) that match one of the provided internal group ID(s). | +| supis | array(Supi) | O | 1..N | Each element identifies a user. The UDR shall return only Individual Applied BDT Policy Data resource(s) that match one of the provided SUPI(s). | + +NOTE: The "internal-group-ids" and the "supis" query parameters represent mutually exclusive resource properties, i.e., if both query parameters are simultaneously present in the same request, the search will not match any resource. + +When the request contains the "bdtpolicy-ids" and the "internal-group-ids" or "supis" query parameters, the UDR shall return the resource(s) that match any combination of the values of the "bdtpolicy-ids" and the "internal-group-ids" or "supis" arrays. + +EXAMPLE: If "bdtpolicy-ids" query parameter is included with two bdtPolicyId entries (bdtPolicyId\_1 and bdtPolicyId\_2) and "supis" is included with two SUPI entries (e.g. SUPI\_A and SUPI\_B), the UDR shall return the Individual BDT Policy Data resource(s) for each matching bdtPolicyId and SUPI combination i.e., the resource(s) matching bdtPolicyId\_1 and SUPI\_A or SUPI\_B, and the resource(s) matching bdtPolicyId\_2 and SUPI\_A or SUPI\_B (note that other combinations are not possible). + +This method shall support the request data structures specified in table 6.2.9.3.1-2 and the response data structures and response codes specified in table 6.2.9.3.1-3. + +**Table 6.2.9.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.9.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------| +| array(BdtPolicyData) | M | 0..N | 200 OK | The applied BDT Policy Data stored in the UDR are returned. | +| 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. | | | | | + +## 6.2.10 Resource: Individual Applied BDT Policy Data + +### 6.2.10.1 Description + +The Individual Applied BDT Policy Data resource represents an Individual Applied BDT Policy Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.10.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/bdtPolicyData/{bdtPolicyId} + +This resource shall support the resource URI variables defined in table 6.2.10.2-1. + +**Table 6.2.10.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| bdtPolicyId | string | The Identifier of an Individual BDT Policy Data to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. | + +### 6.2.10.3 Resource Standard Methods + +#### 6.2.10.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.10.3.1-1. + +**Table 6.2.10.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.10.3.1-2 and the response data structures and response codes specified in table 6.2.10.3.1-3. + +**Table 6.2.10.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|------------------------------------------------------| +| BdtPolicyData | M | 1 | The applied BDT Policy Data to be stored in the UDR. | + +**Table 6.2.10.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| BdtPolicyData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| 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 6.2.10.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}/nudr-dr//application-data/bdtPolicyData/{bdtPolicyId} | + +### 6.2.10.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.10.3.2-1. + +**Table 6.2.10.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.10.3.2-2 and the response data structures and response codes specified in table 6.2.10.3.2-3. + +**Table 6.2.10.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-------------------------------------------------------| +| BdtPolicyDataPatch | M | 1 | The applied BDT Policy Data to be updated in the UDR. | + +**Table 6.2.10.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------| +| BdtPolicyData | M | 1 | 200 OK | The update of an applied BDT Policy Data resource is confirmed and a response body containing applied BDT Policy Data shall be returned. | +| n/a | | | 204 No Content | The update of an applied BDT Policy Data resource is confirmed. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 6.2.10.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.10.3.3-1. + +**Table 6.2.10.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.10.3.3-2 and the response data structures and response codes specified in table 6.2.10.3.3-3. + +**Table 6.2.10.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.10.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 | The Individual Applied BDT Policy Data was deleted successfully. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.11 Resource: IPTV Configurations + +### 6.2.11.1 Description + +This resource allows the NF service consumer to read all active IPTV Configurations applicable for given configuration identifier(s), DNN(s) and/or S-NSSAI(s), SUPI(s) or Internal Group Identifier(s) stored at the UDR. + +### 6.2.11.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/iptvConfigData + +This resource shall support the resource URI variables defined in table 6.2.11.2-1. + +**Table 6.2.11.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.11.3 Resource Standard Methods + +#### 6.2.11.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.11.3.1-1. + +**Table 6.2.11.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| config-ids | array(string) | O | 1..N | Each element identifies a configurationId, i.e. an Individual IPTV Configuration resource. The UDR shall return an Individual IPTV Configuration resource for each matched configurationId. | +| dnns | array(Dnn) | O | 1..N | Each element identifies a DNN. The UDR shall return only Individual IPTV Configuration resource(s) that match one of the provided DNN(s). | +| snssais | array(SNSSAI) | O | 1..N | Each element identifies a slice. The UDR shall return only Individual IPTV Configuration resource(s) that match one of the provided S-NSSAI(s). | +| supis | array(SUPI) | O | 1..N | Each element identifies a SUPI. The UDR shall return only Individual IPTV Configuration resource(s) that match one of the provided SUPI(s). | +| inter-group-ids | array(GroupId) | O | 1..N | Each element identifies a group of users. The UDR shall return only Individual IPTV Configuration resource(s) that match one of the provided internal group ID(s). | + +NOTE: At least one of the above attributes shall be provided. + +NOTE: The "inter-group-ids" and the "supis" query parameters represent mutually exclusive resource properties, i.e., if both query parameters are simultaneously present in the same request, the search will not match any resource. + +When the request query contains more than one optional query parameters defined as an array, the UDR shall return the Individual IPTV Configuration resources for each matching combination of the values of the provided query parameters. + +EXAMPLE: If "snssais" query parameter is included with two S-NSSAI entries (S-NSSAI\_1 and S-NSSAI\_2) and "dnns" is included with two DNN entries (e.g. DNN\_A and DNN\_B), and the other optional query parameters are not included, the UDR shall return IPTV Configuration resources for each matching (for all the possible values for supi, and groupId), i.e. the resource(s) matching SNSSAI\_1 and DNN\_A, the resource(s) matching SNSSAI\_1 and DNN\_B, the resource(s) matching SNSSAI\_2 and DNN\_A, and the resources matching SNSSAI\_2 and DNN\_B. + +This method shall support the request data structures specified in table 6.2.11.3.1-2 and the response data structures and response codes specified in table 6.2.11.3.1-3. + +**Table 6.2.11.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.11.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|----------------|-------------------------------------------------------------| +| array(IptvConfigData) | M | 0..N | 200 OK | The IPTV configuration data stored in the UDR are returned. | + +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. + +## 6.2.12 Resource: Individual IPTV Configuration + +### 6.2.12.1 Description + +The resource allows the NF service consumer to create an Individual IPTV configuration Data, modify or delete an existing Individual IPTV configuration Data. + +### 6.2.12.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/iptvConfigData/{configurationId} + +This resource shall support the resource URI variables defined in table 6.2.12.2-1. + +**Table 6.2.12.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| configurationId | string | The Identifier of an Individual IPTV Configuration to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. | + +### 6.2.12.3 Resource Standard Methods + +#### 6.2.12.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.12.3.1-1. + +**Table 6.2.12.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.12.3.1-2 and the response data structures and response codes specified in table 6.2.12.3.1-3. + +**Table 6.2.12.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|------------------------------------------------------| +| IptvConfigData | M | 1 | The IPTV configuration data to be stored in the UDR. | + +**Table 6.2.12.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| IptvConfigData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| IptvConfigData | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| 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 6.2.12.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}/nudr-dr//application-data/iptvConfigData/{configurationId} | + +### 6.2.12.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.12.3.2-1. + +**Table 6.2.12.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.12.3.2-2 and the response data structures and response codes specified in table 6.2.12.3.2-3. + +**Table 6.2.12.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.12.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------| +| n/a | | | 204 No Content | The resource was deleted successfully. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 6.2.12.3.3 PATCH + +This method shall support the URI query parameters specified in table 6.2.12.3.3-1. + +**Table 6.2.12.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.12.3.3-2 and the response data structures and response codes specified in table 6.2.12.3.3-3. + +**Table 6.2.12.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|---------------------------------------------------------------| +| iptvConfigDataPatch | M | 1 | The IPTV configuration related data to be updated in the UDR. | + +**Table 6.2.12.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------| +| iptvConfigData | M | 1 | 200 OK | The resource has been successfully updated. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.13 Resource: ApplicationDataSubscriptions + +### 6.2.13.1 Description + +This resource is used to represent subscriptions to notification of application data modification, e.g. PFD data change, IPTV configuration data change, BDT policy data change, but not for Traffic Influence Data. + +### 6.2.13.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/subs-to-notify + +This resource shall support the resource URI variables defined in table 6.2.13.2-1. + +**Table 6.2.13.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.13.3 Resource Standard Methods + +#### 6.2.13.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.13.3.1-1. + +**Table 6.2.13.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.13.3.1-2 and the response data structures and response codes specified in table 6.2.13.3.1-3. + +**Table 6.2.13.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-------------------------------------------------------------------------------| +| ApplicationDataSubs | M | 1 | Identifies the subscription to notification of application data modification. | + +**Table 6.2.13.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ApplicationDataSubs | M | 1 | 201 Created | Upon success, a response body containing a representation of each Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 6.2.13.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}/nudr-dr//application-data/subs-to-notify/{subsId} | + +### 6.2.13.3.2 GET + +This method shall support the URI query parameters specified in table 6.2.13.3.2-1. + +**Table 6.2.13.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| data-filter | DataFilter | O | 0..1 | Indicate the data filter (e.g. dnn) for the query. When present, the UDR shall return the IndividualApplicationDataSubscription resource(s) for which the indicated information in the "data-filter" query parameter matches an entry of the "dataFilters" property of the resource (i.e. within the resource representation in the ApplicationDataSubs data structure). If the values of the "dataFilters" entry match the values provided in the "data-filter" query parameter, then the entry is considered to be a match even if it contains further attributes, for which no value was provided in the "data-filter" query parameter. | + +This method shall support the request data structures specified in table 6.2.13.3.2-2 and the response data structures and response codes specified in table 6.2.13.3.2-3. + +**Table 6.2.13.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.13.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------| +| array(ApplicationDataSubs) | M | 0..N | 200 OK | The subscription information as requested in the request URI query parameter(s) are returned. | +| 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. | | | | | + +## 6.2.14 Resource: IndividualApplicationDataSubscription + +### 6.2.14.1 Description + +This resource is used to represent an individual subscription to notification of application data modification. + +### 6.2.14.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/application-data/subs-to-notify/{subsId} + +This resource shall support the resource URI variables defined in table 6.2.14.2-1. + +**Table 6.2.14.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| subsId | string | The subsId identifies an individual application data subscription to notifications. The value is allocated by the UDR during creation of the ApplicationDataSubscriptions resource. | + +### 6.2.14.3 Resource Standard Methods + +#### 6.2.14.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.14.3.1-1. + +**Table 6.2.14.3.1-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 6.2.14.3.1-2 and the response data structures and response codes specified in table 6.2.14.3.1-3. + +**Table 6.2.14.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|----------------------------------------------------------------------------| +| ApplicationDataSubs | M | 1 | Updates the subscription to notification of application data modification. | + +**Table 6.2.14.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| ApplicationDataSubs | M | 1 | 200 OK | The individual subscription resource was updated successfully. | +| n/a | | | 204 No Content | The individual subscription resource was updated successfully and no additional content is to be sent in the response message. | +| 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. | | | | | + +#### 6.2.14.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.14.3.2-1. + +**Table 6.2.14.3.2-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 6.2.14.3.2-2 and the response data structures and response codes specified in table 6.2.14.3.2-3. + +**Table 6.2.14.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.14.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 6.2.14.3.3 GET + +This method shall support the URI query parameters specified in table 6.2.14.3.3-1. + +**Table 6.2.14.3.3-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 6.2.14.3.3-2 and the response data structures and response codes specified in table 6.2.14.3.3-3. + +**Table 6.2.14.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.14.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|----------------|-------------------------------------------| +| ApplicationDataSubs | M | 1 | 200 OK | The subscription information is returned. | + +## 6.2.15 Resource: Service Parameter Data + +### 6.2.15.1 Description + +The Service Parameter Data resource represents a Service Parameter Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.15.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/application-data/serviceParamData + +This resource shall support the resource URI variables defined in table 6.2.15.2-1. + +**Table 6.2.15.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.15.3 Resource Standard Methods + +#### 6.2.15.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.15.3.1-1. + +**Table 6.2.15.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|---------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| service-param-ids | array(string) | O | 1..N | Each element identifies a serviceParamId, i.e., an Individual Service Parameter Data. The UDR shall return an Individual Service Parameter Data resource for each matched serviceParamId. | | +| dnns | array(Dnn) | O | 1..N | Each element identifies a DNN. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided DNNs. | | +| snssais | array(Snssai) | O | 1..N | Each element identifies a slice. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided S-NSSAIs. | | +| internal-group-ids | array(GroupId) | O | 1..N | Each element identifies a group of users. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided internal group IDs. | | +| supis | array(Supi) | O | 1..N | Each element identifies a user. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided SUPIs. | | +| ue-ipv4s | array(Ipv4Addr) | O | 1..N | Each element identifies a user. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided IPv4 addresses. | | +| ue-ipv6s | array(Ipv6Addr) | O | 1..N | Each element identifies a user. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided IPv6 addresses. | | +| ue-macs | array(MacAddr48) | O | 1..N | Each element identifies a user. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided UE MAC addresses. | | +| any-ue | boolean | O | 0..1 | Indicates whether the request is for any UE:
- "true": the request is for any UE;
- "false"(default): the request is not for any UE.
The UDR shall return only Individual Service Parameter Data resource(s) that match the any UE indication. | FilterAnyUE | +| roam-ue-net-descs | array(NetworkDescription) | O | 1..N | Each element identifies one or more PLMNs for the roaming UE. The UDR shall return only Service Parameter Data resource(s) that match at least one of the provided PLMN as described in the NetworkDescription data type. | VPLMNSpecificURSP | +| supp-feat | SupportedFeatures | O | 0..1 | Identifies the features supported by the NF service consumer. | | + +NOTE 1: At least one of the "service-param-ids", "dnns", "snssais", "internal-group-ids", "supis", "ue-ipv4s", "ue-ipv6s" or "ue-macs", and if the feature FilterAnyUE is supported, or "any-ue", and if the feature VPLMNSpecificURSP is supported, or "roam-ue-net-descs" query parameters shall be provided. + +NOTE: The "any-ue" query parameter is commonly related to the search of the service parameter data resource(s) that relate to any UE using the service identified by a combination of DNN and S-NSSAI, and thus, it is commonly present together with the "dnns" and "snssais" query parameters. Note that, if the "any-ue" query parameter is present together with the "internal-group-ids", "supis", "ue-ipv4s", "ue-ipv6s" and/or "ue-macs" query parameters the search will not match any resource, since according to clause 6.4.2.15 only one of the the "supi", "anyUeInd", "interGroupId", "ueIpv4", "ueIpv6" or "ueMac" properties are simultaneously present in the resource. + +When the request query contains more than one optional query parameters defined as an array, the UDR shall return the Service Parameter Data resources for each matching combination of the values of the elements of the array of the provided query parameters. + +EXAMPLE: If "snssais" query parameter is included with two S-NSSAI entries (S-NSSAI\_1 and S-NSSAI\_2) and "dnns" is included with two DNN entries (e.g. DNN\_A and DNN\_B), and the other optional query parameters are not included, the UDR shall return the Individual Service Parameter Data resources for each matching S-NSSAI and DNN, i.e., the resource(s) matching SNSSAI\_1 and DNN\_A, the resource(s) matching SNSSAI\_1 and DNN\_B, the resource(s) matching SNSSAI\_2 and DNN\_A, and the resources matching SNSSAI\_2 and DNN\_B. + +This method shall support the request data structures specified in table 6.2.15.3.1-2 and the response data structures and response codes specified in table 6.2.15.3.1-3. + +**Table 6.2.15.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.15.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------| +| array(ServiceParameterData) | M | 0..N | 200 OK | The Service Parameter Data stored in the UDR are returned. | +| 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. | | | | | + +## 6.2.16 Resource: Individual Service Parameter Data + +### 6.2.16.1 Description + +The Individual Service Parameter Data resource represents an Individual Service Parameter Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.16.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/serviceParamData/{serviceParamId} + +This resource shall support the resource URI variables defined in table 6.2.16.2-1. + +**Table 6.2.16.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| serviceParamId | string | The Identifier of an Individual Service Parameter Data to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. | + +## 6.2.16.3 Resource Standard Methods + +### 6.2.16.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.16.3.1-1. + +**Table 6.2.16.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.16.3.1-2 and the response data structures and response codes specified in table 6.2.16.3.1-3. + +**Table 6.2.16.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------| +| ServiceParameterData | M | 1 | The Service Parameter Data to be stored in the UDR. | + +**Table 6.2.16.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| ServiceParameterData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| ServiceParameterData | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | + +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 6.2.16.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}/nudr-dr//application-data/serviceParamData/{serviceParamId} | + +### 6.2.16.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.16.3.2-1. + +**Table 6.2.16.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.6.3.2-2 and the response data structures and response codes specified in table 6.2.6.3.2-3. + +**Table 6.2.16.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|------------------------------------------------------| +| ServiceParameterData Patch | M | 1 | The Service Parameter Data to be updated in the UDR. | + +**Table 6.2.16.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceParameter Data | M | 1 | 200 OK | The update of an Individual Service Parameter Data resource is confirmed and a response body containing Service Parameter Data shall be returned. | +| n/a | | | 204 No Content | The Individual Service Parameter Data resource has been successfully updated. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 6.2.16.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.16.3.3-1. + +**Table 6.2.16.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.16.3.3-2 and the response data structures and response codes specified in table 6.2.16.3.3-3. + +**Table 6.2.16.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.16.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 | The Individual Service Parameter Data was deleted successfully. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.17 Resource: AM Influence Data + +### 6.2.17.1 Description + +The AM Influence Data resource represents an AM Influence Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.17.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/am-influence-data + +This resource shall support the resource URI variables defined in table 6.2.17.2-1. + +**Table 6.2.17.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +## 6.2.17.3 Resource Standard Methods + +### 6.2.17.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.17.3.1-1. + +**Table 6.2.17.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| am-influence-ids | array(string) | O | 1..N | Each element identifies a amInfluenceId, i.e., an identifier of an Individual AM Influence Data resource. The UDR shall return an Individual AM Influence Data resource that matches one of provided amInfluenceId(s). | | +| dnns | array(Dnn) | O | 1..N | Each element identifies a DNN. The UDR shall return only AM Influence Data resource(s) that match at least one of the DNN(s) of the array. (NOTE 2) | | +| snssais | array(Snssai) | O | 1..N | Each element identifies a slice. The UDR shall return only AM Influence Data resource(s) that match at least one of the S-NSSAI(s) of the array. (NOTE 2) | | +| dnn-snssai-infos | array(DnnSnssaiInformation) | O | 1..N | Each element identifies a combination of (DNN, S-NSSAI). The UDR shall return only AM Influence Data resource(s) that match at least one of the SNSSAI and DNN combination(s) of the array. (NOTE 2) | | +| internal-group-ids | array(GroupId) | O | 1..N | Each element identifies a group of users. The UDR shall return only AM Influence Data resource(s) that match one of the provided GroupId(s). | | +| supis | array(Supi) | O | 1..N | Each element identifies a user. The UDR shall return only AM Influence Data resource(s) that match one of the provided SUPI(s). | | +| any-ue | boolean | O | 0..1 | Indicates whether the request is for any non-roaming UE:
- "true": the request is for any non-roaming UE;
- "false"(default): the request is not for any non-roaming UE.
The UDR shall return only AM Influence Data resource(s) that contain the Any UE indication. | | +| roam-ue-plmn-ids | array(PlmnId) | O | 1..N | Each element identifies a PLMN ID for the roaming UE in LBO roaming scenario. The UDR shall return only AM Influence Data resource(s) that match at least one of the provided PLMN ID. | DCAMP_Roaming_LBO | +| supp-feat | SupportedFeatures | O | 0..1 | Identifies the features supported by the NF service consumer. | | +| NOTE 1: At least one of the query parameters other than the "supp-feat" query parameter shall be provided. | | | | | | +| NOTE 2: Only one of the "dnns", "snssais" or "dnn-snssai-infos" attributes may be simultaneously provided. | | | | | | + +NOTE: The "any-ue" query parameter is commonly related to the search of the AM influence data resource(s) that relate to any non-roaming UE using the service(s) identified by a combination of DNN and S-NSSAI, and thus, it is commonly present together with the "dnn-snssai-infos" query parameters. Note also that, if the "any-ue" query parameter is present together with the "internal-group-ids", and/or "supis" query parameters the search will not match any resource, since according to clause 6.4.2.16 only one of the the "supi", "anyUeInd" and "interGroupId" properties are simultaneously present in the resource. + +When the request query contains more than one optional query parameters defined as an array, the UDR shall return the Individual AM Influence Data resources for each matching combination of the values of the elements of the array of the provided query parameters. + +EXAMPLE 1: If the "dnn-snssai-infos" query parameter is included with two DNN and S-NSSAI combinations (comb\_1 and comb\_2) and the "supis" query parameter is included with two SUPI entries (e.g. SUPI\_A and SUPI\_B), and all of them are matching entries, the UDR shall return the Individual AM Influence Data resources for each matching S-NSSAI and DNN and SUPI combination, i.e. the resource(s) matching comb\_1 and SUPI\_A, comb\_2 and SUPI\_A, comb\_1 and SUPI\_B, and comb2 and SUPI\_B. + +EXAMPLE 2: If the "dnn-snssai-infos" query parameter is included with two DNN and S-NSSAI combination (comb\_1 and comb\_2) and the "supis" query parameter is included with two SUPI entries (e.g. SUPI\_A and SUPI\_B), and there are no matching entries for comb\_1, the UDR shall return the Individual AM Influence Data resources for the matching S-NSSAI and DNN and SUPI combination, i.e., the resource(s) matching comb\_2 and SUPI\_A, and comb2 and SUPI\_B. + +This method shall support the request data structures specified in table 6.2.17.3.1-2 and the response data structures and response codes specified in table 6.2.17.3.1-3. + +**Table 6.2.17.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.17.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|----------------------------------------------------------------------------------------------------------------------|-------------|----------------|-------------------------------------------------------| +| array(AmInfluData) | M | 0..N | 200 OK | The AM Influence Data stored in the UDR are returned. | +| 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. | | | | + +## 6.2.18 Resource: Individual AM Influence Data + +### 6.2.18.1 Description + +The Individual AM Influence Data resource represents an Individual AM Influence Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.18.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/am-influence-data/{amInfluenceId} + +This resource shall support the resource URI variables defined in table 6.2.18.2-1. + +**Table 6.2.18.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| amInfluenceId | string | The identifier of an Individual AM Influence Data to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. | + +## 6.2.18.3 Resource Standard Methods + +### 6.2.18.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.18.3.1-1. + +**Table 6.2.18.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.18.3.1-2 and the response data structures and response codes specified in table 6.2.18.3.1-3. + +**Table 6.2.18.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|------------------------------------------------| +| AmInfluData | M | 1 | The AM Influence Data to be stored in the UDR. | + +**Table 6.2.18.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| AmInfluData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| AmInfluData | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| 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 6.2.18.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}/nudr-dr//application-data/am-influence-data/{amInfluenceId} | + +### 6.2.18.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.18.3.2-1. + +**Table 6.2.18.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.18.3.2-2 and the response data structures and response codes specified in table 6.2.18.3.2-3. + +**Table 6.2.18.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-------------------------------------------------| +| AmInfluDataPatch | M | 1 | The AM Influence Data to be updated in the UDR. | + +**Table 6.2.18.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| AmInfluData | M | 1 | 200 OK | The update of an Individual AM Influence Data resource is confirmed and a response body containing the AM Influence Data shall be returned. | +| n/a | | | 204 No Content | The Individual AM Influence Data resource has been successfully updated. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 6.2.18.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.18.3.3-1. + +**Table 6.2.18.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.18.3.3-2 and the response data structures and response codes specified in table 6.2.18.3.3-3. + +**Table 6.2.18.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.18.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 | The Individual AM Influence Data was deleted successfully. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.19 Resource: EAS Deployment Information Data + +### 6.2.19.1 Description + +The EAS Deployment Information Data resource represents all EAS Deployment Information Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.19.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/eas-deploy-data + +This resource shall support the resource URI variables defined in table 6.2.19.2-1. + +**Table 6.2.19.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +## 6.2.19.3 Resource Standard Methods + +### 6.2.19.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.19.3.1-1. + +**Table 6.2.19.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------| +| dnn | Dnn | O | 0..1 | Identifies a DNN. | +| snssai | Snssai | O | 0..1 | Identifies a slice. | +| internal-group-id | GroupId | O | 0..1 | Identifies a group of users. | +| appId
(NOTE 2) | string | O | 0..1 | Identifies an application. | + +NOTE 1: At least one of the above attributes shall be provided. +NOTE 2: The query parameter does not follow the related naming convention (i.e. "lower-with-hyphen") defined in clause 5.1.3.3 of 3GPP TS 29.501 [7]. This query parameter is however kept as currently defined in this specification for backward compatibility considerations. + +This method shall support the request data structures specified in table 6.2.19.3.1-2 and the response data structures and response codes specified in table 6.2.19.3.1-3. + +**Table 6.2.19.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.19.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------| +| array(EasDeployInfoData) | M | 1..N | 200 OK | The subscribed EAS Deployment information as request in the request URI query parameter(s) are returned. | + +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. + +## 6.2.20 Resource: Individual EAS Deployment Information Data + +### 6.2.20.1 Description + +The Individual EAS Deployment Information Data resource represents a single EAS Deployment Information data resource in the Nudr\_DataRepository Service at a given UDR. + +### 6.2.20.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/eas-deploy-data/{easDeployInfoId} + +This resource shall support the resource URI variables defined in table 6.2.20.2-1. + +**Table 6.2.20.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| easDeployInfoId | string | Identifies an Individual EAS Deployment Information Data resource. | + +## 6.2.20.3 Resource Standard Methods + +### 6.2.20.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.20.3.1-1. + +**Table 6.2.20.3.1-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 6.2.20.3.1-2 and the response data structures and response codes specified in table 6.2.20.3.1-3. + +**Table 6.2.20.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.20.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|----------------|--------------------------------------| +| EasDeployInfoData | M | 1 | 200 OK | The EAS Deployment Data is returned. | + +### 6.2.20.3.2 PUT + +This method shall support the URI query parameters specified in table 6.2.20.3.1-1. + +**Table 6.2.20.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.20.3.1-2 and the response data structures and response codes specified in table 6.2.20.3.1-3. + +**Table 6.2.20.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------------------------| +| EasDeployInfoData | M | 1 | The EAS Deployment Information Data to be stored in the UDR. | + +**Table 6.2.20.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| EasDeployInfoData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| EasDeployInfoData | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| 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 6.2.20.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}/nudr-dr//application-data/eas-deploy-data/{easDeployInfoId} | + +### 6.2.20.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.20.3.3-1. + +**Table 6.2.20.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 6.2.20.3.3-2 and the response data structures and response codes specified in table 6.2.20.3.3-3. + +**Table 6.2.20.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.20.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 | The EAS Deployment Data was successfully deleted. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.21 Resource: AF Requested QoS Data Sets + +### 6.2.21.1 Description + +The AF Requested QoS Data Sets collection resource represents all AF Requested QoS Data Set(s) managed by the UDR. + +### 6.2.21.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/af-qos-data-sets + +This resource shall support the resource URI variables defined in table 6.2.21.2-1. + +**Table 6.2.21.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-----------------------------------------| +| apiRoot | string | See clause 6.1.1 of 3GPP TS 29.504 [6]. | + +## 6.2.21.3 Resource Standard Methods + +### 6.2.21.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.21.3.1-1. + +**Table 6.2.21.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnns | array(Dnn) | O | 1..N | Identifies the targeted DNN(s).

When this query parameter is provided, the UDR shall return only the resource(s) that match at least one of the provided DNN(s).

(NOTE 3) | +| snssais | array(Snssai) | O | 1..N | Identifies the targeted network slice(s).

When this query parameter is provided, the UDR shall return only the resource(s) that match at least one of the provided network slice(s).

(NOTE 3) | +| internal-group-ids | array(GroupId) | O | 1..N | Contains the targeted group(s) of UE(s).

When this query parameter is provided, the UDR shall return only the resource(s) that match at least one of the provided internal group ID(s).

(NOTE 2) | +| supis | array(Supi) | O | 1..N | Contains the identifier(s) of the targeted UE(s).

When this query parameter is provided, the UDR shall return only the resource(s) that match at least one of the provided SUPI(s).

(NOTE 2) | +| data-set-ids | array(string) | O | 1..N | Contains the identifier(s) of the requested Individual AF Requested QoS Data Set resource(s).

(NOTE 4) | +| supp-feat | SupportedFeatures | O | 0..1 | Identifies the features supported by the NF service consumer. | + +NOTE 1: At least one of the above query parameters, other than the "supp-feat" query parameter, shall be provided. +NOTE 2: These query parameters are mutually exclusive. Either one of them may be present. +NOTE 3: These query parameters are mutually exclusive. Either one of them may be present. +NOTE 4: When this query parameter is present, all the other query parameters shall not be present, except the "supp-feat" query parameter when needed. + +This method shall support the request data structures specified in table 6.2.21.3.1-2 and the response data structures and response codes specified in table 6.2.21.3.1-3. + +**Table 6.2.21.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.21.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------| +| array(AfRequestedQoS Data) | M | 0..N | 200 OK | Successful case. The requested Individual AF Requested QoS Data Set resource(s) are returned. | +| 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. | | | | | + +## 6.2.22 Resource: Individual AF Requested QoS Data Set + +### 6.2.22.1 Description + +The Individual AF Requested QoS Data Set resource represents a single AF Requested QoS data Set managed by the UDR. + +### 6.2.22.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/af-qos-data-sets/{afReqQoSId} + +This resource shall support the resource URI variables defined in table 6.2.22.2-1. + +**Table 6.2.22.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|----------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| afReqQoSId | string | Identifies an "Individual AF Requested QoS Data Set" resource. | + +### 6.2.22.3 Resource Standard Methods + +#### 6.2.22.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.22.3.1-1. + +**Table 6.2.22.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.22.3.1-2 and the response data structures and response codes specified in table 6.2.22.3.1-3. + +**Table 6.2.22.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|----------------------------------------------------------------| +| AfRequestedQoSData | M | 1 | Represents the AF Requested QoS Data to be created or updated. | + +**Table 6.2.22.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AfRequestedQoS Data | M | 1 | 201 Created | Successful case. The resource is successfully created and a response body is returned containing a representation of the created "Individual AF Requested QoS Data Set" resource. | +| AfRequestedQoS Data | M | 1 | 200 OK | Successful case. The resource is successfully updated and a response body is returned containing a representation of the updated "Individual AF Requested QoS Data Set" resource. | +| n/a | | | 204 No Content | Successful case. The resource has been successfully updated and no content is returned in the response body. | +| 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 6.2.22.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}/nudr-dr//application-data/af-qos-data-sets/{afReqQoSId} | + +## 6.2.22.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.22.3.2-1. + +**Table 6.2.22.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.22.3.2-2 and the response data structures and response codes specified in table 6.2.22.3.2-3. + +**Table 6.2.22.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-------------------------------------------------------------------------------------------| +| AfRequestedQoS DataPatch | M | 1 | Represents the requested modification to the targeted existing AF Requested QoS Data Set. | + +**Table 6.2.22.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AfRequestedQoS Data | M | 1 | 200 OK | Successful case. The "Individual AF Requested QoS Data Set" resource is successfully modified and a representation of the updated resource is returned in the response body. | +| n/a | | | 204 No Content | Successful case. The "Individual AF Requested QoS Data" resource is successfully modified and no content is returned in the response body. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.22.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.22.3.3-1. + +**Table 6.2.22.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 6.2.22.3.3-2 and the response data structures and response codes specified in table 6.2.22.3.3-3. + +**Table 6.2.22.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.22.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 targeted "Individual AF Requested QoS Data Set" resource is successfully deleted. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.23 Resource: Individual DNAI EAS Mapping + +### 6.2.23.1 Description + +The resource represents the EAS address information for a DNAI. + +NOTE: This information is configured by the OAM. + +### 6.2.23.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/dnai-eas-mappings/{dnai} + +This resource shall support the resource URI variables defined in table 6.2.23.2-1. + +**Table 6.2.23.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1 | +| dnai | Dnai | The DNAI. | + +### 6.2.23.3 Resource Standard Methods + +#### 6.2.23.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.23.3.1-1. + +**Table 6.2.23.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 6.2.23.3.1-2 and the response data structures and response codes specified in table 6.2.23.3.1-3. + +**Table 6.2.23.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.23.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------| +| DnaiEasMapping | M | 1 | 200 OK | Upon success, a response body containing the EAS information for the DNAI shall be returned. | +| 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. | | | | | + +## 6.2.24 Resource: ECS Address Roaming Data + +### 6.2.24.1 Description + +The ECS Address Roaming Data resource represents all ECS Address Roaming Data in the Nudr\_DataRepository Service at a given UDR. + +### 6.2.24.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/ecs-address-roaming + +This resource shall support the resource URI variables defined in table 6.2.24.2-1. + +**Table 6.2.24.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.24.3 Resource Standard Methods + +#### 6.2.24.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.24.3.1-1. + +**Table 6.2.24.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------| +| internal-group-id | GroupId | O | 0..1 | Identifies a group of users. | +| any-ue | boolean | O | 0..1 | Indicates that all UEs are targeted when included and set to "true", otherwise set to "false". Default value is "false" if omitted. | +| NOTE: At least one of the above attributes shall be provided. | | | | | + +This method shall support the request data structures specified in table 6.2.24.3.1-2 and the response data structures and response codes specified in table 6.2.24.3.1-3. + +**Table 6.2.24.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.24.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------| +| array(EcsAddrData) | M | 1..N | 200 OK | The ECS Address Data requested in the request URI query parameter(s) are returned. | +| 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. | | | | | + +## 6.2.25 Resource: Individual ECS Address Roaming Data + +### 6.2.25.1 Description + +The Individual ECS Address Roaming Data resource represents a single ECS Address Roaming Data entry at the Nudr\_DataRepository Service at a given UDR. + +### 6.2.25.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/ecs-address-roaming/{ecsAddrInfoId} + +This resource shall support the resource URI variables defined in table 6.2.25.2-1. + +**Table 6.2.25.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------------|-----------|-------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| ecsAddrInfoId | string | Identifies an Individual ECS Address Roaming Data resource. | + +### 6.2.25.3 Resource Standard Methods + +#### 6.2.25.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.25.3.1-1. + +**Table 6.2.25.3.1-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 6.2.25.3.1-2 and the response data structures and response codes specified in table 6.2.25.3.1-3. + +**Table 6.2.25.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.25.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------|---|-------------|----------------|----------------------------------------| +| EcsAddrData | M | 1 | 200 OK | The requested information is returned. | + +#### 6.2.25.3.2 PUT + +This method shall support the URI query parameters specified in table 6.2.25.3.1-1. + +**Table 6.2.25.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.25.3.1-2 and the response data structures and response codes specified in table 6.2.25.3.1-3. + +**Table 6.2.25.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|-------------------------------------------------------| +| EcsAddrData | M | 1 | The ECS Address Roaming Data to be stored in the UDR. | + +**Table 6.2.25.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| EcsAddrData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| EcsAddrData | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| 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 6.2.25.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}/nudr-dr//application-data/ecs-address-roaming/{ecsAddrInfoId} | + +### 6.2.25.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.25.3.3-1. + +**Table 6.2.25.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 6.2.25.3.3-2 and the response data structures and response codes specified in table 6.2.25.3.3-3. + +**Table 6.2.25.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.25.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 | The data was successfully deleted. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.3 Notifications + +### 6.3.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 6.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------------|-------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------| +| Influence Data Update Notification | {notificationUri} | POST | One of notification reference provided by the service consumer during the subscription of the AF Influence Data. | +| Application Data Change Notification | {notificationUri} | POST | Application Data Change Notification | + +### 6.3.2 Void + +### 6.3.3 Influence Data Update Notification + +#### 6.3.3.1 Description + +The Influence Update Notification is used by the UDR to report one or several observed Influence Data(s) to a NF service consumer that has subscribed to such Notifications. + +#### 6.3.3.2 Operation Definition + +The POST method shall be used for traffic influence data change notification and the URI shall be provided during the subscription procedure. + +Callback URI: {notificationUri} + +This method shall support the URI query parameters specified in table 6.3.3.2-1. + +**Table 6.3.3.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.3.3.2-2 and the response data structures and response codes specified in table 6.3.3.2-3. + +**Table 6.3.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(TrafficInfluData or TrafficInfluDataNotif) | M | 1..N | Provides Information about observed Influence Data. If the EnhancedInfluDataNotification feature is supported, the TrafficInfluDataNotif data type shall be sent. | + +**Table 6.3.3.2-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. | +| 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. | | | | | + +## 6.3.4 Application Data Change Notification + +The POST method shall be used for application data change notification and the URI shall be provided during the subscription procedure. + +Callback URI: {notificationUri} + +This method shall support the URI query parameters specified in table 6.3.4-1. + +**Table 6.3.4-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.3.4-2 and the response data structures and response codes specified in table 6.3.4-3. + +**Table 6.3.4-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------------------|---|-------------|-------------------------------------------| +| array(ApplicationDataChangeNotif) | M | 1..N | Notification of application data changes. | + +**Table 6.3.4-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------| +| n/a | | | 204 No Content | The reception of the notification is acknowledged. | +| 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. | | | | | + +## 6.4 Data Model + +### 6.4.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.1-1 specifies the data types defined for the Nudr\_DataRepository Service API for Application Data service based interface protocol. + +**Table 6.4.1-1: Nudr\_DataRepository specific Data Types for Application Data** + +| Data type | Section defined | Description | Applicability | +|----------------------------|------------------------|--------------------------------------------------------------------------------------------|--------------------------------| +| AfRequestedQoSData | 6.4.2.18 | Represents an AF Requested QoS Data Set. | GMEC | +| AfRequestedQoSDataPatch | 6.4.2.19 | Represents the requested modifications to an AF Requested QoS Data Set. | GMEC | +| AmInfluData | 6.4.2.16 | Contains AM influence data. | DCAMP | +| AmInfluDataPatch | 6.4.2.17 | Contains AM influence data that can be updated. | DCAMP | +| ApplicationDataSubs | 6.4.2.10 | Contains application data subscription data. | | +| ApplicationDataChangeNotif | 6.4.2.11 | Contains the new or updated application data or removed indication. | | +| BdtPolicyData | 6.4.2.7 | Contains applied BDT policy data. | EnhancedBackgroundDataTransfer | +| BdtPolicyDataPatch | 6.4.2.8 | Contains modification instructions to be performed on the applied BDT policy data. | EnhancedBackgroundDataTransfer | +| CorrelationType | 6.4.3.4 | Indicates that the EAS(es) corresponding to a common DNAI or common EAS should be selected | CommonEASDNAI | +| DataInd | 6.4.3.3 | Indicates the type of data. | | +| DataFilter | 6.4.2.12 | Indicates an application data filter. | | +| DnaiEasInfo | 6.4.2.22 | Contains EAS information for a DNAI. | DnaiEasMappings | +| DnaiEasMapping | 6.4.2.21 | Contains DNAI(s) to EAS mapping. | DnaiEasMappings | +| EcsAddrData | 6.4.2.23 | Represents ECS Address Configuration Data. | | +| IptvConfigData | 6.4.2.9 | Represents IPTV configuration data information. | | +| PfdDataForAppExt | 6.4.2.6 | The PFDs and related data for the application | | +| ServiceParameterData | 6.4.2.15 | Contains the service parameter data. | | +| TrafficCorrelationInfo | 6.4.2.18 | Contains the information for traffic correlation. | CommonEASDNAI | +| ServiceParameterDataPatch | 6.4.2.15A | Contains the service parameter data that can be updated. | | +| TrafficInfluData | 6.4.2.2 | Contains traffic influence data. | | +| TrafficInfluDataPatch | 6.4.2.3 | Contains modification instructions to be performed on the traffic influence data. | | +| TrafficInfluDataNotif | 6.4.2.14 | Contains traffic influence data for notification. | EnhancedInfluDataNotification | +| TrafficInfluSub | 6.4.2.4 | Contains traffic influence subscription data. | | + +**Editor's Note:** The feature to be used for EcsAddrData is FFS. + +Table 6.4.1-2 specifies data types re-used by the Nudr\_DataRepository Service API for Application Data 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 Nudr\_DataRepository Service API for Application Data service based interface. + +**Table 6.4.1-2: Nudr\_DataRepository re-used Data Types for Application Data** + +| Data type | Reference | Comments | Applicability | +|------------------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| A2xParamsPc5 | 3GPP TS 29.522 [19] | Contains the A2X service parameters data provisioned over PC5. | A2X | +| A2xParamsPc5Rm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the A2xParamsPc5 data type, but with the OpenAPI nullable property set to true. | A2X | +| AmInfluEvent | 3GPP TS 29.522 [19] | Identifies the type of AM related events of which the AF requests to be notified. | | +| AlternativeServiceRequirementsData | 3GPP TS 29.514 [52] | Contains alternative QoS related parameters and a reference to them. | GMEC | +| ApplicationId | 3GPP TS 29.571 [7] | Indicates an application identifier. | | +| BdtReferenceId | 3GPP TS 29.122 [9] | Identifies a selected policy of background data transfer. | EnhancedBackgroundDataTransfer | +| DateTime | 3GPP TS 29.571 [7] | Indicates a date and time. | | +| DateTimeRm | 3GPP TS 29.571 [7] | Indicates a date and time that can be updated. | | +| Dnai | 3GPP TS 29.571 [7] | Represents a DNAI. | DnaiEasMappings | +| DnaiChangeType | 3GPP TS 29.571 [7] | Describes the types of DNAI change. | | +| Dnn | 3GPP TS 29.571 [7] | Identifies a Data Network Name. (NOTE 2) | | +| DnnSnssaiInformation | 3GPP TS 29.522 [19] | Represents a DNN, S-NSSAI combination. | DCAMP | +| DurationSec | 3GPP TS 29.571 [7] | Represents a duration in seconds. | DCAMP | +| DurationSecRm | 3GPP TS 29.571 [7] | Represents a removable duration in seconds. | DCAMP | +| EasDeployInfoData | 3GPP TS 29.591 [23] | Represents the EAS Deployment Information. | EasDeployment | +| EcsServerAddr | 3GPP TS 29.571 [7] | Represents the Edge Configuration Server (ECS) address configuration information. | | +| EthFlowDescription | 3GPP TS 29.514 [16] | Contains the Ethernet data flow information. (NOTE) | | +| Event | 3GPP TS 29.522 [19] | Contains the outcome of the UE Policy Delivery related to the invocation of AF provisioned service parameters. | DeliveryOutcome | +| EventsSubscReqData | 3GPP TS 29.514 [16] | Identifies the events the application subscribes to. | GMEC | +| EventsSubscReqDataRm | 3GPP TS 29.514 [16] | This data type is defined in the same way as the EventsSubscReqData data type, but with the OpenAPI nullable property set to true. | GMEC | +| FlowInfo | 3GPP TS 29.122 [9] | Contains the flow information. | | +| FqdnPatternMatchingRule | 3GPP TS 29.571 [7] | Identifies an FQDN pattern matching rule. | DnaiEasMappings | +| GroupId | 3GPP TS 29.571 [7] | Identifies a group of users. | EasDeployment | +| IpAddr | 3GPP TS 29.571 [7] | IP address and/or prefix. | DnaiEasMappings | +| IptvConfigDataPatch | 3GPP TS 29.522 [19] | Contains the IPTV configuration data used for PATCH. | | +| Ipv4Addr | 3GPP TS 29.571 [7] | Identifies an IPv4 address. | | +| Ipv6Addr | 3GPP TS 29.571 [7] | Identifies an IPv6 address. | | +| Link | 3GPP TS 29.122 [9] | Identifies a referenced resource. | | +| MacAddr48 | 3GPP TS 29.571 [7] | MAC Address. | | +| MulticastAccessControl | 3GPP TS 29.522 [19] | Represents the multicast access control information. | | +| NetworkAreaInfo | 3GPP TS 29.554 [13] | Describes a network area information. | | +| NetworkDescription | 3GPP TS 29.522 [19] | Represents the description of a PLMN in terms of the PLMN ID, the MCC (and optionally, applicable MNCs) or the indication of any PLMN | VPLMNSpecificURSP | +| ParameterOverPc5 | 3GPP TS 29.522 [19] | Contains the V2X service parameters data provisioned over PC5. | | +| ParameterOverPc5Rm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParameterOverPc5 data type, but with the OpenAPI nullable property set to true. | | +| ParameterOverUu | 3GPP TS 29.522 [19] | Contains the V2X service parameters data provisioned over Uu. | | +| ParameterOverUuRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParameterOverUu data type, but with the OpenAPI nullable property set to true. | | +| ParamForProSeDc | 3GPP TS 29.522 [19] | Contains the service parameters for 5G ProSe direct communications. | ProSe | +| ParamForProSeDcRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParamForProSeDc data type, but with the | | + +| | | | | +|--|--|----------------------------------------|--| +| | | OpenAPI nullable property set to true. | | +|--|--|----------------------------------------|--| + +| | | | | +|-------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| ParamForProSeDd | 3GPP TS 29.522 [19] | Contains the service parameters for 5G ProSe direct discovery. | ProSe | +| ParamForProSeDdRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParamForProSeDd data type, but with the OpenAPI nullable property set to true. | | +| ParamForProSeEndUe | 3GPP TS 29.522 [19] | Contains the service parameters for 5G ProSe End UE. | ProSe_Ph2 | +| ParamForProSeEndUeRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParamForProSeEndUe data type, but with the OpenAPI nullable property set to true. | ProSe_Ph2 | +| ParamForProSeRemUe | 3GPP TS 29.522 [19] | Contains the service parameters for 5G ProSe remote UE. | ProSe | +| ParamForProSeRemUeRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParamForProSeRemUe data type, but with the OpenAPI nullable property set to true. | | +| ParamForProSeU2NRelUe | 3GPP TS 29.522 [19] | Contains the service parameters for 5G ProSe UE-to-network relay UE. | ProSe | +| ParamForProSeU2NRelUeRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParamForProSeU2NRelUe data type, but with the OpenAPI nullable property set to true. | | +| ParamForProSeU2URelUe | 3GPP TS 29.522 [19] | Contains the service parameters for 5G ProSe UE-to-UE Relay UE. | ProSe_Ph2 | +| ParamForProSeU2URelUeRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParamForProSeU2URelUe data type, but with the OpenAPI nullable property set to true. | ProSe_Ph2 | +| PfdChangeNotification | 3GPP TS 29.551 [8] | Describes the PFD change. | | +| PfdContent | 3GPP TS 29.551 [8] | Represents the content of a PFD for an application identifier. | | +| PlmnId | 3GPP TS 29.571 [7] | Identifies a PLMN. | DCAMP_Roaming_LBO | +| RouteToLocation | 3GPP TS 29.571 [7] | Identifies the N6 traffic routing requirement. | | +| ServiceAreaCoverageInfo | 3GPP TS 29.534 [22] | Contains service area coverage information. | DCAMP | +| Snssai | 3GPP TS 29.571 [7] | Identifies a Single Network Slice Selection Assistance Information. | | +| SpatialValidityCond | 3GPP TS 29.571 [7] | Indicates the spatial validity condition. | | +| SubscribedEvent | 3GPP TS 29.522 [19] | Identified the type of UP path management events of which the AF requests to be notified. | | +| Supi | 3GPP TS 29.571 [7] | Identifies a SUPI that shall contain either an IMSI or an NAI. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features. | | +| TemporalInValidity | 3GPP TS 29.565 [27] | Indicates the time interval during which the NF service consumer request shall not to be applied | GMEC | +| TemporalValidity | 3GPP TS 29.514 [16] | Indicates the time interval during which the AF request is to be applied. | MultiTemporalCondition | +| TnapId | 3GPP TS 29.571 [7] | Trusted Network Access Point identifier. | AfGuideTNAPs | +| Uinteger | 3GPP TS 29.571 [7] | Unsigned Integer, i.e. only value 0 and integers greater than 0 are allowed. | | +| UintegerRm | 3GPP TS 29.571 [7] | This data type is defined in the same way as the "Uinteger" data type, but with the OpenAPI "nullable: true" property. | | +| Uri | 3GPP TS 29.571 [7] | Identifies a URI. | | +| UriRm | 3GPP TS 29.571 [7] | Identifies a removable URI. | DCAMP | +| UrspRuleRequest | 3GPP TS 29.522 [19] | Contains service parameter data used to guide the URSP. | AfGuideURSP | +| ParamForRangingSIPos | 3GPP TS 29.522 [19] | Contains the service parameters for ranging and sidelink positioning. | Ranging_SL | +| ParamForRangingSIPosRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the "ParamForRangingSIPos" data type, but | Ranging_SL | + +| | | | | +|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|--| +| | | with the OpenAPI "nullable: true" property. | | +| NOTE 1: | In order to support a set of MAC addresses with a specific range in the traffic filter, feature MacAddressRange as specified in clause 6.1.8 of TS 29.504 [6] shall be supported. | | | +| NOTE 2: | The UDR uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. | | | + +**Editor's Note:** The feature to be used for EccServerAddr, Link, and SpatialValidityCondition is FFS. + +## 6.4.2 Structured data types + +### 6.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 6.4.2.2 Type TrafficInfluData + +**Table 6.4.2.2-1: Definition of type TrafficInfluData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| upPathChgNotifCorrId | string | C | 0..1 | Contains the Notification Correlation Id allocated by the NEF for the UP path change notification. It shall be included when the NEF requests the UP path change notification. | | +| appReloInd | boolean | O | 0..1 | Identifies whether an application can be relocated once a location of the application has been selected.
True: the application cannot be relocated;
False (default): the application can be relocated. | | +| afAppId | string | O | 0..1 | Identifies an application. (NOTE 1) (NOTE 3) | | +| dnn | Dnn | O | 0..1 | Identifies a DNN | | +| ethTrafficFilters | array(EthFlowDescription) | O | 1..N | Identifies Ethernet packet filters. (NOTE 1) (NOTE 3) | | +| snssai | Snssai | O | 0..1 | The identification of slice. | | +| interGroupId | GroupId | O | 0..1 | Identifies a group of users. (NOTE 2) (NOTE 3)(NOTE 5) | | +| interGroupIdList | array(GroupId) | O | 2..N | Identifies the list of Internal Groups. (NOTE 2) (NOTE 9) (NOTE 10) (NOTE 11) | FinerGranUEs | +| subscriberCatList | array(string) | O | 1..N | Identifies the list of subscriber category(ies). (NOTE 10) | FinerGranUEs | +| supi | Supi | O | 0..1 | Identifies a user. (NOTE 2) (NOTE 3) | | +| trafficFilters | array(FlowInfo) | O | 1..N | Identifies IP packet filters. (NOTE 1) (NOTE 3) | | +| trafficRoutes | array(RouteToLocation) | O | 1..N | Identifies the N6 traffic routing requirement. | | +| sfcdIdI (NOTE 11) | string | O | 0..1 | Reference to a pre-configured service function chain for downlink traffic. | SFC | +| sfcdIdUI (NOTE 11) | string | O | 0..1 | Reference to a pre-configured service function chain for uplink traffic. | SFC | +| metadata | Metadata | O | 0..1 | Contains opaque information for the service functions in the N6-LAN that is provided by AF and transparently sent to UPF. It may only be provided when sfcdIdI and/or sfcdIdUI are provided. | SFC | +| traffCorrInd | boolean | O | 0..1 | Indication of traffic correlation. May only be included when "interGroupId" attribute is included and not set to "AnyUE". It is used to indicate that for the group of UEs, the targeted PDU sessions should be correlated by a common DNAI. Set to "true" if it should be correlated; otherwise set to "false". Default value is "false" if omitted. (NOTE 7) | | +| tfcCorrInfo | TrafficCorrelationInfo | O | 0..1 | Contains the information for traffic correlation. | CommonEAS DNAI | +| validStartTime | DateTime | O | 0..1 | Identifies when the traffic routings start to be applicable. (NOTE 4) | | +| validEndTime | DateTime | O | 0..1 | Identifies when the traffic routings are not applicable. (NOTE 4) | | +| tempValidities | array(TemporalValidity) | O | 1..N | Indicates the time interval(s) during which the AF request is to be applied. (NOTE 4) | MultiTemporal ICondition | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | Identifies a network area information that the request applies only to the traffic of UE(s) located in this specific zone. | | +| upPathChgNotifUri | Uri | C | 0..1 | Contains the URI where the NEF receives the UP path change notification. It shall be included when the NEF requests the UP path change notification. | | + +| | | | | | | +|-------------------|------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| headers | array(string) | O | 1..N | Headers provisioned by the NEF to be used by other NFs to interact with the NEF. E.g. 3gpp-Sbi-Binding header with the binding indication for the URI where the NEF receives UP path change notification and whose information is used by the SMF.
The encoding of the header shall comply with clause 6.3 of IETF RFC 9110 [21].
(NOTE 6) | | +| subscribedEvents | array(SubscribedEvent) | O | 1..N | Identifies the requirement to be notified of the event(s). | | +| dnaiChgType | DnaiChangeType | O | 0..1 | Identifies a type of notification regarding UP path management event. | | +| afAckInd | boolean | O | 0..1 | Identifies whether the AF acknowledgement of UP path event notification is expected.
Set to "true" if the AF acknowledgement is expected; otherwise set to "false".
Default value is "false" if omitted. | URLLC | +| addrPreserInd | boolean | O | 0..1 | Indicates whether UE IP address should be preserved.
This attribute shall set to "true" if preserved, otherwise, set to "false".
Default value is false if omitted. | URLLC | +| maxAllowedUpLat | UInteger | O | 0..1 | Indicates the target user plane latency in units of milliseconds. The SMF may use this value to decide whether edge relocation is needed to ensure that the user plane latency does not exceed the value. | AF_latency | +| simConnInd | boolean | O | 0..1 | Indication of simultaneous connectivity temporarily maintained for the source and target PSA.
It is used to indicate whether the simultaneous connectivity should be temporarily maintained for the source and target PSA.
It is set to "true" if the temporary simultaneous connectivity should be temporarily maintained; otherwise, it is set to "false". Default value is "false" if omitted. | SimultConnectivity | +| simConnTerm | DurationSec | C | 0..1 | Indication of the minimum time interval to be considered for inactivity of the traffic routed via the source PSA during the edge re-location procedure before removing the source PSA.
It may be included when the "simConnInd" attribute is set to true. | SimultConnectivity | +| supportedFeatures | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.

This attribute shall be supplied by the UDR in the response to the PUT request when it was present in the PUT request and the UDR supports feature negotiation for Influence Data.

This attribute shall be supplied by the UDR in the response to the GET request when the GET request includes the "supp-feat" query parameter and the UDR supports feature negotiation for Influence Data. | | +| resUri | Uri | C | 0..1 | Represents the URI of Individual Influence Data.
It shall only be included in the HTTP | EnhancedInfluuDataNotification | + +| | | | | | | +|--------------|------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| | | | | GET response. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | +| nscSuppFeats | map(SupportedFeatures) | O | 1..N | A map of Network Function Service Consumer features supported per service. The key used in this map for each entry is the ServiceName value as defined in 3GPP TS 29.510[24] (e.g. for Nsmf_EventExposure API, the key shall be set to nsmf-event-exposure). | NscSupportedFeatures | + +NOTE 1: One of "afAppId", "trafficFilters" or "ethTrafficFilters" shall be included. + +NOTE 2: One of the "supi" or "interGroupId" or "interGroupIdList" (may be included when FinerGranUEs feature is supported) shall be included. + +NOTE 3: If the EnhancedInfluDataNotification feature is not supported, to indicate the deletion of a Traffic Individual Influence Data resource, only the appropriate combination of "supi" or "interGroupId", and "afAppId", "trafficFilters" or "ethTrafficFilters" that identify the resource shall be included. The rest of attributes shall be omitted. + +NOTE 4: Properties "validStartTime" and "validEndTime" shall only be included for single temporal validity condition. Property "tempValidities" shall only be included for multiple temporal validity conditions when the feature MultiTemporalCondition is supported. + +NOTE 5: If the Traffic Influence Data applies to any UE, then the "interGroupId" sets to "AnyUE". + +NOTE 6: In this release of the specification, the property "headers" only includes the 3gpp-Sbi-Binding header with the binding indication for the URI included in the property "upPathChgNotifUri". + +NOTE 7: The indication of traffic correlation shall be provided only when the AF indicated that all the PDU sessions related to the 5G VN group member UEs should be correlated by a common DNAI in the user plane for the traffic as described in 3GPP TS 29.522 [19]. + +NOTE 8: When FinerGranUEs feature is supported, the Traffic Influence Data applies to the UE(s) that belong to all the Internal Group Identifiers included within the attribute "interGroupIdList", if present. + +NOTE 9: When FinerGranUEs feature is supported, the Traffic Influence Data applies to the UE(s) that belong to all the subscriber categories included within the attribute "subscriberCatList", which is included only if either "interGroupIdList" is included or "interGroupId" is included. + +NOTE 10: Attributes "interGroupId" and "interGroupIdList" are mutually exclusive attributes. + +NOTE 11: When the SFC feature is supported, for the purpose of influencing Service Function Chaining, at least one of the "sfCldId" and "sfCldUri" attribute shall be present. + +### 6.4.2.3 Type TrafficInfluDataPatch + +**Table 6.4.2.3-1: Definition of type TrafficInfluDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| upPathChgNotifCorrId | string | O | 0..1 | Contains the Notification Correlation Id allocated by the NEF for the UP path change notification. | | +| appReloInd | boolean | O | 0..1 | Identifies whether an application can be relocated once a location of the application has been selected. | | +| ethTrafficFilters | array(EthFlowDescription) | O | 1..N | Identifies Ethernet packet filters. | | +| trafficFilters | array(FlowInfo) | O | 1..N | Identifies IP packet filters | | +| trafficRoutes | array(RouteToLocation) | O | 1..N | Identifies the N6 traffic routing requirement. | | +| sfcdId | string | O | 0..1 | Reference to a pre-configured service function chain for downlink traffic. | SFC | +| sfcdId | string | O | 0..1 | Reference to a pre-configured service function chain for uplink traffic. | SFC | +| metadata | Metadata | O | 0..1 | Contains opaque information for the service functions in the N6-LAN that is provided by AF and transparently sent to UPF. | SFC | +| traffCorrInd | boolean | O | 0..1 | Indication of traffic correlation. May only be included when "interGroupId" attribute was previously included in the "TrafficInfluData" data type and not set to "AnyUE". It is used to indicate that for the group of UEs, the targeted PDU sessions should be correlated by a common DNAI. | | +| tfcCorrInfo | TrafficCorrelationInfo | O | 0..1 | Contains the information for traffic correlation. | CommonEASD
NAI | +| validStartTime | DateTime | O | 0..1 | Identifies when the traffic routings start to be applicable. | | +| validEndTime | DateTime | O | 0..1 | Identifies when the traffic routings are not applicable. | | +| tempValidities | array(TemporalValidity) | O | 1..N | Indicates the time interval(s) during which the AF request is to be applied. | MultiTemporalCondition | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | Identifies a network area information that the request applies only to the traffic of UE(s) located in this specific zone. | | +| upPathChgNotifUri | Uri | O | 0..1 | Contains the URI where the NEF receives the UP path change notification. | | +| headers | array(string) | O | 1..N | Headers provisioned by the NEF. E.g. 3gpp-Sbi-Binding header with the binding indication for the URI where the NEF receives UP path change notification. The encoding of the header shall comply with clause 6.3 of IETF RFC 9110 [21]. | | +| afAckInd | boolean | O | 0..1 | Identifies whether the AF acknowledgement of UP path event notification is expected. | URLLC | +| addrPreserInd | boolean | O | 0..1 | Indicates UE IP address should be preserved. | URLLC | +| maxAllowedUpLat | UInteger | O | 0..1 | Indicates the target user plane latency in units of milliseconds. The SMF may use this value to decide whether edge relocation is needed to ensure that the user plane latency does not exceed the value. | AF_latency | +| simConnInd | boolean | O | 0..1 | Indication of simultaneous connectivity | SimultConnecti | + +| | | | | | | +|-------------|---------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| simConnTerm | DurationSecRm | C | 0..1 | Indication of the minimum time interval to be considered for inactivity of the traffic routed via the source PSA during the edge re-location procedure before removing the source PSA. | SimultConnectivity | +|-------------|---------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| + +## 6.4.2.4 Type TrafficInfluSub + +**Table 6.4.2.4-1: Definition of type TrafficInfluSub** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| dnns | array(Dnn) | O | 1..N | Each element identifies a DNN.
(NOTE 1) | | +| snssais | array(Snssai) | O | 1..N | Each element identifies an internal slice. | | +| internalGroupIds | array(GroupId) | O | 1..N | Each element identifies a group of users.
(NOTE 1) (NOTE 2) (NOTE 3) (NOTE 5) | | +| internalGroupIdsAdd | array(GroupId) | O | 1..N | Each element identifies an internal group of users.
(NOTE 1) (NOTE 2) (NOTE 4) (NOTE 5) | | +| subscriberCatList | array(string) | O | 1..N | Each element identifies a subscriber category.
(NOTE 6) | | +| supis | array(Supi) | O | 1..N | Each element identifies the user.
(NOTE 5) | | +| notificationUri | Uri | M | 1 | URI provided by the NF service consumer indicating where to receive the subscribed notifications from the UDR. | | +| expiry | DateTime | C | 0..1 | This IE shall be included in a subscription response if, based on operator policy and taking into account the expiry time included in the request, the UDR needs to include an expiry time.
This IE may be included in a subscription request. When present, this IE shall represent the time after which the subscription becomes invalid.
The absence of this attribute in the subscription response means the subscription to be valid without an expiry time. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of the optional features. This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | +| immRep | boolean | O | 0..1 | If provided and set to "true", it indicates that existing entries that match this subscription shall be immediately reported within the "immReports" attribute in the response. The default value is false. | ImmediateReportPcc | +| immReports | array(TrafficInfluDataNotif) | O | 1..N | Contains entries stored in the UDR that match this subscription.
It may be included only in the POST (or PUT) response body of a subscription creation (or modification), and only if the request included the "immRep" attribute set to true. | ImmediateReportPcc | +| NOTE 1: At least one of "dnns", "snssais", "internalGroupIds", "internalGroupIdsAdd" (may be included when FinerGranUEs feature is supported) or "supis" shall be provided. | | | | | | +| NOTE 2: For the Traffic Influence Data applies to any UE, the "internalGroupIds" needs to have an entry set to "AnyUE". | | | | | | +| NOTE 3: The "internalGroupIds" attribute shall be compared only with the "interGroupId" of the TrafficInfluData data type and there is a match only if they both exist and "interGroupId" is contained in "internalGroupIds". | | | | | | +| NOTE 4: The "internalGroupIdsAdd" attribute shall be compared only with the "interGroupIdList" of the TrafficInfluData data type and there is a match only if they both exist and are identical. | | | | | | +| NOTE 5: Attributes "internalGroupIds" and "internalGroupIdsAdd" are mutually exclusive attributes. | | | | | | +| NOTE 6: The "subscriberCatList" attribute of the TrafficInfluSub data type shall be compared with the "subscriberCatList" of the TrafficInfluData data type and there is a match only if they both exist and are identical. | | | | | | + +## 6.4.2.5 Void + +## 6.4.2.6 Type: PfdDataForAppExt + +Table 6.4.2.6-1: Definition of type PfdDataForAppExt + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| suppFeat | SupportedFeatures | O | 0..1 | Used to negotiate the applicability of the optional features.

This attribute shall be provided in the PUT request and in the response of successful resource creation.
This attribute shall be provided in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. | | +| applicationId | ApplicationId | M | 1 | Identifier of an application. | | +| pfds | array(PfdContent) | M | 1..N | PFDs for the application identifier. | | +| cachingTime | DateTime | O | 0..1 | Caching time for an application identifier. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | +| allowedDelay | DurationSec | O | 0..1 | Indicates that the list of PFDs in this request should be deployed within the time interval indicated by the Allowed Delay. | | + +## 6.4.2.7 Type BdtPolicyData + +Table 6.4.2.7-1: Definition of type BdtPolicyData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| interGroupId | GroupId | O | 0..1 | Identifies a group of users. (NOTE) | | +| supi | Supi | O | 0..1 | Identifies a user. (NOTE) | | +| bdtRefId | BdtReferenceId | M | 1 | Identifies a selected policy of background data transfer. | | +| dnn | Dnn | O | 0..1 | Identifies a DNN | | +| snssai | Snssai | O | 0..1 | The identification of slice. | | +| resUri | Uri | C | 0..1 | Represents the URI of Individual Applied BDT Policy Data.
It shall only be included in the HTTP GET response. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | + +NOTE: Either "supi" or "interGroupId" shall be included. + +#### 6.4.2.8 Type BdtPolicyDataPatch + +**Table 6.4.2.8-1: Definition of type BdtPolicyDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-----------------------------------------------------------|---------------| +| bdRefId | BdtReferenceId | M | 1 | Identifies a selected policy of background data transfer. | | + +#### 6.4.2.9 Type IptvConfigData + +**Table 6.4.2.9-1: Definition of type IptvConfigData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies a user. (NOTE) | | +| interGroupId | GroupId | C | 0..1 | Identifies a group of users. (NOTE) | | +| dnn | Dnn | O | 0..1 | Identifies a DNN | | +| snssai | Snssai | O | 0..1 | The identification of slice. | | +| afAppId | string | M | 1 | Identifies an application. | | +| multiAccCtrls | map(MulticastAccessControl) | M | 1..N | Identifies a list of multicast address access control information.
Any string value can be used as a key of the map. | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the negotiated supported features. This attribute shall be provided in the PUT request and in the response of successful resource creation. | | +| resUri | Uri | C | 0..1 | Represents the URI of Individual IPTV Configuration.
It shall only be included in the HTTP GET response. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | + +NOTE: Either "supi" or "interGroupId" shall be included. + +## 6.4.2.10 Type ApplicationDataSubs + +**Table 6.4.2.10-1: Definition of type ApplicationDataSubs** + +| Attribute name | Data type | P | Cardinality | Description | | +|-------------------|-----------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| notificationUri | Uri | M | 1 | URI provided by the NF service consumer indicating where to receive the subscribed notifications from the UDR. | Applicability | +| dataFilters | array(DataFilter) | O | 1..N | Each element identifies a data filter for subscription to data change.notification. If absent, the subscription applies to all data change notification except traffic influence data. | | +| expiry | DateTime | C | 0..1 | This IE shall be included in a subscription response if, based on operator policy and taking into account the expiry time included in the request, the UDR needs to include an expiry time. This IE may be included in a subscription request. When present, this IE shall represent the time after which the subscription becomes invalid. The absence of this attribute in the subscription response means the subscription to be valid without an expiry time. | | +| immRep | boolean | O | 0..1 | If the feature "ImmediateReportPcc" is not supported, this attribute is applicable only if the "dataFilters" attribute of the request includes an element with the "dataInd" attribute set to "AM". If provided and set to "true", it indicates that existing matching entries shall be immediately reported within the "amInfluEntries" attribute, or, if the feature "ImmediateReportPcc" is supported, within the "immReports" attribute in the response. The default value is "false" | DCAMP
ImmediateReportPcc | +| amInfluEntries | array(AmInfluData) | O | 1..N | The AM Influence Data stored in the UDR that match this subscription. It may be included only in the POST response body of a subscription creation or modification, and only if the request included the "immRep" attribute set to true and a "dataFilters" attribute that contained an element with the "dataInd" attribute set to "AM". | DCAMP | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of the optional features. This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource. This attribute may be provided in the response of successful resource creation. | | +| immReports | array(ApplicationDataChangeNotif) | O | 1..N | Contains entries stored in the UDR that match this subscription. It may be included only in the POST (or PUT) response body of a subscription creation (or modification), and only if the request included the "immRep" attribute set to true. | ImmediateReportPcc | + +When multiple attributes defined as an array are included within an entry of the "dataFilters" attribute, the UDR shall determine that the subscription is for all application data of type "dataInd" that contain a matching combination of the values of the elements of the array of the provided attributes. + +EXAMPLE: For a subscription to notification on changes of Service Parameter Data resources ("dataInd" is set to "SVC\_PARAM"), if "snssais" attribute is included with two S-NSSAI entries (S-NSSAI\_1 and S-NSSAI\_2) and "dnns" is included with two DNN entries (e.g. DNN\_A and DNN\_B), and the other optional attributes are not included, the UDR shall notify about changes of Service Parameter Data resources that contain a matching S-NSSAI and DNN combination, i.e. the resource(s) matching SNSSAI\_1 and DNN\_A, the resource(s) matching SNSSAI\_1 and DNN\_B, the resource(s) matching SNSSAI\_2 and DNN\_A, and the resources matching SNSSAI\_2 and DNN\_B. + +#### 6.4.2.11 Type ApplicationDataChangeNotif + +**Table 6.4.2.11-1: Definition of type ApplicationDataChangeNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| iptvConfigData | IptvConfigData | O | 0..1 | IPTV Configuration Data. (NOTE) | | +| pfdData | PfdChangeNotification | O | 0..1 | PFD Data. (NOTE) | | +| bdtPolicyData | BdtPolicyData | O | 0..1 | BDT Policy Data. (NOTE) | | +| serParamData | ServiceParameterData | O | 0..1 | Service Parameter Data, if changed and notification was requested. (NOTE) | | +| amlInfluData | AmlInfluData | O | 0..1 | AM Influence Data (NOTE) | DCAMP | +| dnaiEasData | DnaiEasMapping | O | 0..1 | DNAI EAS Mapping (NOTE) | DnaiEasMappings | +| afReqQosData | AfRequestedQosData | O | 0..1 | AF requested QoS data for a UE or Group of UE(s) not identified by UE address(es). (NOTE) | GMEC | +| ecsAddrData | EcsAddrData | O | 0..1 | ECS Address Roaming Data (NOTE) | | +| resUri | Uri | M | 1 | Identifies the resource in the corresponding data change. For notifying deletion, only resUri shall be provided in the ApplicationDataChangeNotif data type. | | + +NOTE: Only one among those attributes shall be provided in notifying data creation or update and in immediate reports. + +Editor's Note: The feature to be used for EcsAddrData is FFS. + +## 6.4.2.12 Type DataFilter + +**Table 6.4.2.12-1: Definition of type DataFilter** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dataInd | DataInd | M | 1 | Indicate the type of application data.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd", and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +| dnns | array(Dnn) | O | 1..N | Each element identifies a DNN.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the DNNs included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any).
(NOTE 3) | | +| snssais | array(Snssai) | O | 1..N | Each element identifies a slice.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the S-NSSAIs included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any).
(NOTE 3) | | +| internalGroupIds | array(GroupId) | O | 1..N | Each element identifies a group of users.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the Group IDs included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +| supis | array(Supi) | O | 1..N | Each element identifies the user.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the SUPIs included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +| appIds | array(ApplicationId) | O | 1..N | Each element identifies an application.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the ApplicationIds included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +| uelpv4s | array(Ipv4Addr) | O | 1..N | Each element identifies the user.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the IPv4 address(es) included in the array, | | + +| | | | | | +|--|--|--|--------------------------------------------------------------------------------------------|--| +| | | | and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +|--|--|--|--------------------------------------------------------------------------------------------|--| + +| | | | | | | +|----------------|------------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| uelpv6s | array(Ipv6Addr) | O | 1..N | Each element identifies the user. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the IPv6 addresses included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +| ueMacs | array(MacAddr48) | O | 1..N | Each element identifies the user. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the UE MAC address(es) included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +| anyUeInd | boolean | O | | Indicates whether the request is for any UE:
- "true": the request is for any UE;
- "false"(default): the request is not for any UE.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain an any UE indication, and match also the filters indicated in the rest of the attributes of DataFilter (if any). | FilterAnyUE | +| dnnSnssaiInfos | array(DnnSnssaiInformation ) | O | 1..N | Each element identifies a combination of (DNN, S-NSSAI). When used in subscription procedures, the UDR shall only notify about changes in resource(s) with "dataInd" value AM that contain at least one DNN and S-NSSAI combination indicated in the array, and match also the rest of the filters (if any). (NOTE 3) | DCAMP | +| dnais | array(Dnai) | O | 1..N | Each element identifies a DNAI. When used in subscription procedures, the UDR shall only notify about changes of application data of type "dataInd" that contain at least one of the DNais included in the array, and match also the rest of the filters (if any). | DnaiEasMappings | + +NOTE 1: The "dnns" and "snssais" attributes are applicable to the BDT Policy Data, IPTV Configuration Data, Service Parameter Data, AM Influence Data, and DNAI EAS Mappings, the "internalGroupIds" and "supis" attributes are applicable to the BDT Policy Data, IPTV Configuration Data, Service Parameter Data, and AM Influence Data, the "uelpv4s" "uelpv6s" and "ueMacs" attributes are applicable to the Service Parameter Data, the "appls" attribute is applicable to the PFD Data, Service Parameter Data and IPTV Configuration Data, the "anyUeInd" attribute is applicable to Service Parameter Data and AM Influence Data, the "dnnSnssaiInfos" is applicable to AM Influence Data, and the "dnais" attribute is applicable to DNAI EAS Mappings. The "internalGroupIds" and "anyUeInd" attributes are also applicable to ECS Address Roaming Data. + +NOTE 2: At application data changes, subscriptions to changes based on attributes of this table are considered to be matched, and the corresponding notifications are sent, no matter if the matching application data matches the provided values before the change, after the change, or both before and after the change. + +NOTE 3: For AM Influence Data, only one of the "dnns", "snssais", or "dnn-snssai-infos" attributes may be simultaneously provided. + +NOTE: When the "anyUeInd" attribute is related to the subscription to notification of changes of the service parameter data resource(s), and it refers to any UE using the service identified by a combination of DNN and S-NSSAI, the "anyUeInd" attribute is present together with the "dnns" and "snssais" properties. Note also that, if the "anyUeInd" attribute is present together with the "internalGroupIds", "supis", "uelpv4s", "uelpv6s" and/or "ueMacs" attributes the subscription will not match any resource, since according to clause 6.4.2.15 only one of the the "supi", "anyUeInd", "interGroupId", "uelpv4", "uelpv6" or "ueMac" properties are simultaneously present in the resource. + +When the "anyUeInd" attribute is related to the subscription to notification of changes of the AM Influence data resource(s), and it refers to any UE using the service(s) identified by the corresponding DNN and S-NSSAI, the "anyUeInd" attribute is present together with the "dnnSnssaiInfos" property. Note also that, if the "anyUeInd" attribute is present together with the "internalGroupIds" and/or "supis" attributes the subscription will not match any resource, since according to clause 6.4.2.16 only one of the the "supi", "anyUeInd", or "interGroupId" properties are simultaneously present in the resource. + +#### 6.4.2.13 Void + +#### 6.4.2.14 Type TrafficInfluDataNotif + +**Table 6.4.2.14-1: Definition of type TrafficInfluDataNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| resUri | Uri | M | 1 | Represents the URI of Individual Influence Data. For notifying deletion, only resUri shall be provided in the TrafficInfluDataNotif data type. | | +| trafficInfluData | TrafficInfluData | C | 0..1 | Traffic Influence Data. It shall be present for notifying Individual Influence Data creation or update and, if the feature "ImmediateReportPcc" is supported, also for providing immediate reports. | | + +## 6.4.2.15 Type ServiceParameterData + +**Table 6.4.2.15-1: Definition of type ServiceParameterData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| dnn | Dnn | O | 0..1 | Identifies a DNN. (NOTE 2) | | +| snssai | Snssai | O | 0..1 | Identifies an S-NSSAI. (NOTE 2) | | +| appld | string | O | 0..1 | Identifies an application identifier. (NOTE 2) | | +| supi | Supi | O | 0..1 | Identifies a user. (NOTE1) | | +| uelpv4 | Ipv4Addr | O | 0..1 | The IPv4 address of the served UE. (NOTE1) | | +| uelpv6 | Ipv6Addr | O | 0..1 | The IPv6 address of the served UE. (NOTE1) | | +| ueMac | MacAddr48 | O | 0..1 | The MAC address of the served UE. (NOTE1) | | +| interGroupId | GroupId | O | 0..1 | Identifies a group of users. (NOTE1) | | +| anyUeInd | boolean | O | 0..1 | Identifies whether the service parameters applies to any non-roaming UE. This attribute shall set to "true" if applicable for any UE, otherwise, set to "false". (NOTE1) | | +| roamUeNetDescs | array(NetworkDescription) | O | 1..N | Each element identifies one (e.g., combination of MCC and MNC) or more (e.g. a MCC only) PLMN ID(s).

It indicates the PLMN(s) of inbound roamers to which the provided AF guidance on VPLMN-specific URSP rules apply. (NOTE 1) | VPLMNSpecificURSP | +| paramOverPc5 | ParameterOverPc5 | O | 0..1 | Contains the V2X service parameters used over PC5 | | +| paramOverUu | ParameterOverUu | O | 0..1 | Contains the V2X service parameters used over Uu | | +| a2xParamsPc5 | A2xParamsPc5 | O | 0..1 | Contains the A2X service parameters used over PC5 | A2X | +| urspGuidance | array(UrspRuleRequest) | O | 1..N | Contains the service parameter used to guide the URSP and/or, when the VPLMNSpecificURSP feature is supported, to guide the VPLMN-specific URSP. | AfGuideURSP | +| paramForProSeDd | ParamForProSeDd | O | 0..1 | Contains the service parameters for 5G ProSe direct discovery. | ProSe | +| paramForProSeDc | ParamForProSeDc | O | 0..1 | Contains the service parameters for 5G ProSe direct communications. | ProSe | +| paramForProSeU2NRelUe | ParamForProSeU2NRelUe | O | 0..1 | Contains the service parameters for 5G ProSe UE-to-network relay UE. | ProSe | +| paramForProSeRemUe | ParamForProSeRemUe | O | 0..1 | Contains the service parameters for 5G ProSe remote UE. | ProSe | +| paramForProSeU2UReUe | ParamForProSeU2UReUe | O | 0..1 | Contains the service parameters for 5G ProSe UE-to-UE Relay UE. | ProSe_Ph2 | +| paramForProSeEndUe | ParamForProSeEndUe | O | 0..1 | Contains the service parameters for 5G ProSe End UE. | ProSe_Ph2 | +| tnaps | array(TnapId) | O | 1..N | Contains the TNAP ID(s) collocated with the 5G-RG(s) of a specific user. | AfGuideTNAPs | +| deliveryEvents | array(Event) | O | 1..N | Contains the events related to the outcome of UE policy | DeliveryOutcome | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| | | | | delivery. | | +| policDelivNotifCorrelId | string | C | 0..1 | Contains the Notification Correlation Id allocated by the NEF for the notification of UE Policy delivery outcome. It shall be included when the NEF requests the notification of UE Policy delivery outcome. | DeliveryOutcome | +| policDelivNotifUri | Uri | C | 0..1 | Contains the URI where the NEF receives the notification of UE Policy delivery outcome. It shall be included when the NEF requests the notification of UE policy delivery outcome. | DeliveryOutcome | +| headers | array(string) | O | 1..N | Headers provisioned by the NEF.
E.g. 3gpp-Sbi-Binding header (as specified in 3GPP TS 29.500 [4]) with the binding indication for the URI included in the policDelivNotifUri attribute. The encoding of the header shall comply with clause 6.3 of IETF RFC 9110 [21]. | DeliveryOutcome | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of Supported features used as described in clause 5.8.
This parameter shall be supplied in the PUT request that requested the creation of an individual Service parameter resource, and in the PUT response. | | +| resUri | Uri | C | 0..1 | Represents the URI of Individual Service Parameter Data.
It shall only be included in the HTTP GET response. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | +| paramForRangingSIPos | ParamForRangingSIPos | O | 0..1 | Contains the service parameters for ranging and sidelink positioning. | Ranging_SL | +| NOTE 1: Only one of the "supi", "anyUeInd", "interGroupId", "uelpv4", "uelpv6" or "ueMac" attribute, and when the feature "VPLMNSpecificURSP" is supported, or "roamUeNetDescs" attribute, shall be provided. When the "AfGuidance" feature is supported, and the attribute "tnaps" is included, only the "supi" attribute shall be provided. When the "VPLMNSpecificURSP" feature is supported, the "roamUeNetDescs" attribute only applies to URSP service parameter provisioning and shall be included when the "urspGuidance" attribute contains VPLMN(s) description. | | | | | | +| NOTE 2: Only the combination of "dnn" and "snssai" or "appld" attribute shall be provided. | | | | | | + +## 6.4.2.15A Type ServiceParameterDataPatch + +**Table 6.4.2.15A-1: Definition of type ServiceParameterDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| paramOverPc5 | ParameterOverPc5Rm | O | 0..1 | Contains the V2X service parameters used over PC5. When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | | +| paramOverUu | ParameterOverUuRm | O | 0..1 | Contains the V2X service parameters used over Uu. When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | | +| a2xParamsPc5 | A2xParamsPc5Rm | O | 0..1 | Contains the A2X service parameters used over PC5. | A2X | +| urspInfluence | array(UrspRuleRequest) | O | 1..N | Contains the service parameter used to influence the URSP. This attribute is deprecated by the "urspGuidance" attribute that should be used instead. | AfGuideURSP | +| urspGuidance | array(UrspRuleRequest) | O | 1..N | Contains the service parameter used to guide the URSP and/or, when the VPLMNSpecificURSP feature is supported, to guide the VPLMN-specific URSP. | AfGuideURSP
PatchCorrection | +| paramForProSeDd | ParamForProSeDdRm | O | 0..1 | Contains the service parameters for 5G ProSe direct discovery. When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | ProSe | +| paramForProSeDc | ParamForProSeDcRm | O | 0..1 | Contains the service parameters for 5G ProSe direct communications. When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | ProSe | +| paramForProSeU2NRelUe | ParamForProSeU2NRelUeRm | O | 0..1 | Contains the service parameters for 5G ProSe UE-to-network relay UE. When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | ProSe | +| paramForProSeRemUe | ParamForProSeRemUeRm | O | 0..1 | Contains the service parameters for 5G ProSe remote UE. When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | ProSe | +| paramForProSeU2URe | ParamForProSe | O | 0..1 | Contains the service | ProSe_Ph2 | + +| | | | | | | +|----------------------|------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| lUE | U2URElUeRm | | | parameters for 5G ProSe UE-to-UE Relay UE. | | +| paramForProSeEndUe | ParamForProSeEndUeRm | O | 0..1 | Contains the service parameters for 5G ProSe End UE. | ProSe_Ph2 | +| tnaps | array(TnapId) | O | 1..N | Contains the TNAP ID(s) collocated with the 5G-RG(s) of a specific user. | AfGuideTNAPs | +| deliveryEvents | array(Event) | O | 1..N | Contains the events related to the outcome of UE policy delivery.
When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | DeliveryOutcome | +| policDelivNotifUri | Uri | C | 0..1 | Contains the URI where the NEF receives the notification of UE Policy delivery outcome. It shall be included when the NEF requests the notification of UE policy delivery outcome. | DeliveryOutcome | +| headers | array(string) | O | 1..N | Headers provisioned by the NEF.
E.g. 3gpp-Sbi-Binding header (as specified in 3GPP TS 29.500 [4]) with the binding indication for the URI included in the policDelivNotifUri IE.
The encoding of the header shall comply with clause 6.3 of IETF RFC 9110 [21]. | DeliveryOutcome | +| paramForRangingSIPos | ParamForRangingSIPosRm | O | 0..1 | Contains the service parameters for ranging and sidelink positioning. | Ranging_SL | + +## 6.4.2.16 Type AmInfluData + +**Table 6.4.2.16-1: Definition of type AmInfluData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| appIds | array(string) | O | 1..N | Identifies one or more applications. | | +| dnnSnssaiInfos | array(DnnSnssaiInformation) | O | 1..N | Each element identifies a combination of (DNN, S-NSSAI). | | +| interGroupId | GroupId | O | 0..1 | Identifies a group of users. (NOTE 1) | | +| supi | Supi | O | 0..1 | Identifies a user. (NOTE 1) | | +| anyUeInd | boolean | O | 0..1 | Indicates whether the data applies to any non-roaming UE. If present and set to "true" the data is applicable for any non-roaming UE. Otherwise set to "false". Default value is "false" if omitted. (NOTE 1) | | +| roamUePlmnIds | array(PlmnId) | O | 1..N | Each element identifies a home PLMN Id for the inbound roaming UEs in LBO roaming scenario. (NOTE 1) (NOTE 3) | DCAMP_Roaming_LBO | +| policyDuration | DurationSec | O | 0..1 | Indicates the time duration that the policy shall last. | | +| evSubs | array(AmInfluEvent) | O | 1..N | List of AM related events for which a subscription is required. | | +| headers | array(string) | O | 1..N | Headers provisioned by the NEF. E.g. 3gpp-Sbi-Binding header (as specified in 3GPP TS 29.500 [4]) with the binding indication for the URI included in the notifUri IE. The encoding of the header shall comply with clause 6.3 of IETF RFC 9110 [21]. | | +| notifUri | Uri | C | 0..1 | Contains the Callback URI to receive notifications. It shall be present if the "evSubs" attribute is present. | | +| notifCorrId | string | O | 0..1 | Notification correlation identifier. | | +| thruReq | boolean | O | 0..1 | If present and set to "true", it indicates that high throughput is desired for the indicated UE traffic. Otherwise set to "false". Default value is "false" if omitted. (NOTE 2) | | +| covReq | array(ServiceAreaCoverageInfo) | O | 1..N | Identifies service area coverage requirements. (NOTE 2) | | +| supportedFeatures | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.

This attribute shall be supplied by the UDR in the response to the PUT request when it was present in the PUT request and the UDR supports feature negotiation for AM Influence Data.

This attribute shall be supplied by the UDR in the response to the GET request when the GET request includes the "supp-feat" query parameter and the UDR supports feature negotiation for AM Influence Data. | | +| resUri | Uri | C | 0..1 | Represents the URI of Individual AM Influence Data. It shall only be included in the HTTP GET response. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource. This attribute may be provided in the response of successful resource creation. | | + +NOTE 1: One of "supi", "interGroupId", "anyUeInd" and "roamUePlmnIds" shall be included. + +NOTE 2: At least one of these attributes shall be included. + +NOTE 3: "roamUePlmnIds" attribute applies only to LBO roaming scenarios and is associated with the inbound roaming + +| | +|----------------------------------------------------------------------------------------| +| UEs and applicable when "applds" attribute or "dnnSnssailInfos" attribute is provided. | +|----------------------------------------------------------------------------------------| + +## 6.4.2.17 Type AmInfluDataPatch + +**Table 6.4.2.17-1: Definition of type AmInfluDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| applds | array(string) | O | 1..N | Identifies one or more applications. | | +| dnnSnssailInfos | array(DnnSnssailInformation) | O | 1..N | Each element identifies a combination of (DNN, S-NSSAI). | | +| policyDuration | DurationSecRm | O | 0..1 | Indicates the time duration that the policy shall last. | | +| evSubs | array(AmInfluEvent) | O | 1..N | List of AM related events for which a subscription is required. | | +| headers | array(string) | O | 1..N | Headers provisioned by the NEF.
E.g. 3gpp-Sbi-Binding header (as specified in 3GPP TS 29.500 [4]) with the binding indication for the URI included in the notifUri IE.
The encoding of the header shall comply with clause 6.3 of IETF RFC 9110 [21]. | | +| notifUri | UriRm | C | 0..1 | Contains the Callback URL to receive notifications. | | +| notifCorrId | string | O | 0..1 | Notification correlation identifier. | | +| thruReq | boolean | O | 0..1 | Indicates whether high throughput is desired for the indicated UE traffic:
- "true": high throughput is desired for the indicated UE traffic;
- "false": high throughput is not desired for the indicated UE traffic. | | +| covReq | string | O | 0..1 | Identifies service area coverage requirements. | | + +## 6.4.2.18 Type AfRequestedQosData + +**Table 6.4.2.18-1: Definition of type AfRequestedQosData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies a UE.

(NOTE 1) | | +| interGroupId | GroupId | C | 0..1 | Identifies a group of UE(s).

(NOTE 1) | | +| afAppId | string | O | 0..1 | Identifies an AF Application. | | +| dnn | Dnn | O | 0..1 | Represents a DNN.
(NOTE 2) | | +| sliceInfo | Snssai | O | 0..1 | Represents the identifier of a network slice. | | +| flowInfos | array(FlowInfo) | O | 1..N | Describe the IP data flow(s) which requires QoS. | | +| evSubsc | EventsSubscReqData | O | 0..1 | Contains the requested event(s) subscription related information. | | +| qosReference | string | O | 0..1 | Identifies a pre-defined QoS information. | | +| altSerReqs | array(string) | O | 1..N | Ordered list of alternative service requirements that include a set of QoS references.. The lower the index of the array for a given entry, the higher the priority. | | +| altSerReqsData | array(AlternativeServiceRequirementsData) | O | 1..N | Identifies an ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority. | | +| disUeNotif | boolean | O | 0..1 | Indicates to disable QoS flow parameters signalling to the UE when it is included and set to "true".
The default value "false" shall apply, if the attribute is not present and has not been supplied previously. | | +| marBwUI | BitRate | O | 0..1 | Maximum requested bandwidth for the Uplink. | | +| marBwDI | BitRate | O | 0..1 | Maximum requested bandwidth for the Downlink. | | +| mirBwUI | BitRate | O | 0..1 | Minimum requested bandwidth for the Uplink. | | +| mirBwDI | BitRate | O | 0..1 | Minimum requested bandwidth for the Downlink. | | +| tempInValidity | TemporalInValidity | O | 0..1 | Indicates the time interval during which the AF request is not to be applied. | | +| suppFeat | SupportedFeatures | M | 1 | This IE represents a list of Supported features used as described in clause 6.1.8 of 3GPP TS 29.504. | | + +NOTE 1: Either "supi" or "interGroupId" shall be included. + +NOTE 2: Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. The PCF uses the DNN as obtained from UDR without applying any transformation (e.g. during SM Policy Association matching). To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. + +**Editor's Note: Whether all the parameters of the AF Request for QoS are covered is FFS (e.g., missing the representation of other individual QoS parameters and/or the indication of the applicable events).** + +## 6.4.2.19 Type AfRequestedQosDataPatch + +**Table 6.4.2.19-1: Definition of type AfRequestedQosDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| afAppId | string | O | 0..1 | Identifies the application Identifier. | | +| evSubsc | EventsSubscReqDataRm | O | 0..1 | Contains the requested event(s) subscription related information. | | +| flowInfos | array(FlowInfo) | O | 1..N | Describe the data flow(s) which requires QoS. | | +| qosReference | string | O | 0..1 | Pre-defined QoS reference. | | +| altSerReqs | array(string) | O | 0..N | Ordered list of alternative service requirements that include a set of QoS references.. The lower the index of the array for a given entry, the higher the priority. | | +| altSerReqsData | array(AlternativeServiceRequirementsData) | O | 1..N | Identifies an ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority. | | +| disUeNotif | boolean | O | 0..1 | Indicates to disable QoS flow parameters signalling to the UE when it is included and set to "true".
The default value "false" shall apply, if the attribute is not present and has not been supplied previously. | | +| marBwUl | BitRateRm | O | 0..1 | Maximum requested bandwidth for the Uplink. | | +| marBwDl | BitRateRm | O | 0..1 | Maximum requested bandwidth for the Downlink. | | +| mirBwUl | BitRateRm | O | 0..1 | Minimum requested bandwidth for the Uplink. | | +| mirBwDl | BitRateRm | O | 0..1 | Minimum requested bandwidth for the Downlink. | | +| tempInValidity | TemporalInValidity | O | 0..1 | Indicates the time interval during which the AF request is not to be applied. | | + +## 6.4.2.20 Type TrafficCorrelationInfo + +**Table 6.4.2.20-1: Definition of type TrafficCorrelationInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| corrType | CorrelationType | C | 0..1 | Indicates selecting a common DNAI or EAS for the application identified by the Application Identifier or traffic filtering information. It shall be provided when the traffic correlation information is provisioned for the first time. | | +| tfcCorrId | string | C | 0..1 | Identification of a set of UEs accessing the application identified by the Application Identifier or traffic filtering information. It shall be provided when the traffic correlation information is provisioned for the first time. | | +| comEasIpv4Addr | Ipv4AddrRm | C | 0..1 | IPv4 address of common EAS for the application identified by the Application Identifier or traffic filtering information for the UEs the AF request aims at. It may be provided when the "corrType" attribute includes "COMMON_EAS". | | +| comEasIpv6Addr | Ipv6AddrRm | C | 0..1 | IPv6 address of common EAS for the application identified by the Application Identifier or traffic filtering information for the UEs the AF request aims at. It may be provided when the "corrType" attribute includes "COMMON_EAS". | | +| fqdnRange | array(FqdnPatternMatchingRule) | C | 1..N | FQDN(s) used for influencing EASDF-based DNS query procedure. It may be provided when the "corrType" attribute includes "COMMON_EAS". | | +| notifUri | UriRm | O | 0..1 | Contains the Callback URL to receive notifications. | | +| notifCorrId | string | O | 0..1 | Notification correlation identifier. | | + +## 6.4.2.21 Type DnaiEasMapping + +**Table 6.4.2.21-1: Definition of type DnaiEasMapping** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------------------|---------------| +| dnaiEasInfos | array(DnaiEasInfo) | M | 1..N | Each element contains EAS information for the DNAI of a DNN/S-NSSAI. | | + +## 6.4.2.22 Type DnaiEasInfo + +**Table 6.4.2.22-1: Definition of type DnaiEasInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------|---------------| +| dnn | Dnn | C | 0..1 | DNN. (NOTE 1) | | +| snssai | Snssai | C | 0..1 | S-NSSAI. (NOTE 1) | | +| easIpAddrs | array(IpAddr) | C | 1..N | IP address(es) or IP address ranges (IPv4 subnetwork(s) and/or IPv6 prefix(es)) of the EAS of the DNAI. (NOTE 2) | | +| fqdns | array(FqdnPatternMatchingRule) | C | 1..N | FQDN(s) where the EAS is/are deployed. (NOTE 2) | | + +NOTE 1: At least one of "dnn" and "snssai" shall be provided. +NOTE 2: Exactly one of "easIpAddrs" and "fqdns" shall be provided. + +## 6.4.2.23 Type EcsAddrData + +**Table 6.4.2.23-1: Definition of type EcsAddrData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| self | Link | C | 0..1 | Identifies the individual resource. It shall be present in the HTTP GET response when reading multiples entries. | | +| ecsServerAddr | EcsServerAddr | M | 1 | Represents the ECS address(es). | | +| spatialValidityCond | SpatialValidityCond | O | 0..1 | Indicates the spatial validity condition. | | +| anyUeInd | boolean | C | 0..1 | If provided and set to "true" it indicates that any UE is targetted, while "false" indicates that not all UEs are targetted. The default value is "false" if omitted. (NOTE) | | +| internalGroupId | GroupId | C | 0..1 | Indicates the internal group identifier. (NOTE) | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the negotiated supported features. It shall be provided in an HTTP POST response if it was provided in the HTTP POST request. | | + +NOTE: One of the "internalGroupId" attribute or the "anyUeInd" attribute set to "true" shall be provided. + +## 6.4.3 Simple data types and enumerations + +### 6.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 6.4.3.2 Simple data types + +The simple data types defined in table 6.4.3.2-1 shall be supported. + +**Table 6.4.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +### 6.4.3.3 Enumeration: DataInd + +**Table 6.4.3.3-1: Enumeration DataInd** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------------------------------|-----------------| +| PFD | PFD data | | +| IPTV | IPTV configuration data | | +| BDT | BDT data | | +| SVC_PARAM | Service parameter data | | +| AM | AM influence data | DCAMP | +| DNAI_EAS | DNAI EAS mapping data | DnaiEasMappings | +| REQ_QOS | AF Requested QoS data for a UE or group of UE(s) not identified by UE address(es). | GMEC | +| ECS | ECS Address Roaming Data | | + +Editor's Note: The feature to be used for ECS is FFS. + +#### 6.4.3.4 Enumeration: CorrelationType + +**Table 6.4.3.4-1: Enumeration CorrelationType** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------------|---------------| +| COMMON_DNAI | Indicates that the EAS(es) corresponding to a common DNAI should be selected. | | +| COMMON_EAS | Indicates that the common EAS should be selected | | + +### 6.5 Error handling + +#### 6.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +For the Nudr\_DataRepository Service API for Application Data, 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 shall apply. + +#### 6.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nudr\_DataRepository Service API for Application Data. + +#### 6.5.3 Application Errors + +The application errors defined for the Nudr\_DataRepository Service API for Application Data are listed in table 6.5.3-1. + +**Table 6.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------| +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated by other clauses in this document. | | | + +The application error handling shall follow 3GPP TS 29.504 [6] clause 6.1.6 unless explicitly specified in this document. + +### 6.6 Feature negotiation + +The optional features in table 6.1.8-1 of 3GPP TS 29.504 [6] are defined for the Nudr\_DataRepository API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +--- + +## 7 Usage of Nudr\_DataRepository Service API for Structured Data for Exposure + +### 7.1 Introduction + +The following clauses specify the usage of Nudr\_DataRepository service for exposure data. The principles specified in 3GPP TS 29.504 [6] are followed unless explicitly specified otherwise in the following clauses. + +## 7.2 Resources + +### 7.2.1 Overview + +This clause specifies the resources for the usage of the Unified Data Repository service for Structured Data for Exposure. + +### 7.2.2 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.2.2-1 depicts the resource URIs structure for the Nudr\_DataRepository API for exposure data data. + +![Resource URI structure diagram for Nudr_DataRepository API](ec838a9b247a8176f8dec125c9d198ab_img.jpg) + +``` +graph TD; Root["{apiRoot}/nudr-dr/"] --- ED["/exposure-data"]; ED --- UEID["/{ueId}"]; ED --- STN["/subs-to-notify"]; UEID --- AM["/access-and-mobility-data"]; UEID --- SMD["/session-management-data"]; SMD --- PDU["/{pduSessionId}"]; STN --- SUBID["/{subId}"]; +``` + +The diagram illustrates the hierarchical structure of Resource URIs for the Nudr\_DataRepository API. It starts with a root path `{apiRoot}/nudr-dr/` which leads to `/exposure-data`. From `/exposure-data`, two main branches emerge: `/{ueId}` and `/subs-to-notify`. The `/{ueId}` branch further splits into `/access-and-mobility-data` and `/session-management-data`. The `/session-management-data` path then leads to `/{pduSessionId}`. The `/subs-to-notify` branch leads to `/{subId}`. + +Resource URI structure diagram for Nudr\_DataRepository API + +**Figure 7.2.2-1: Resource URI structure of the Nudr\_DataRepository API for exposure data** + +Table 7.2.2-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.2.2-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description | +|------------------------------------|--------------------------------------------------------------|-------------|------------------------------------------------------------------------------------------| +| AccessAndMobilityData | /exposure-data/{ueId}/access-and-mobility-data | PUT | Create and update the access and mobility exposure data for a UE | +| | | PATCH | Update the access and mobility exposure data for a UE. | +| | | GET | Retrieve the access and mobility exposure data for a UE | +| | | DELETE | Delete the access and mobility exposure data for a UE | +| PduSessionManagementData | /exposure-data/{ueId}/session-management-data/{pduSessionId} | PUT | Create and update the session management data for a UE and for an individual PDU session | +| | | GET | Retrieve the session management data for a UE and for an individual PDU session | +| | | DELETE | Delete the session management data for a UE and for an individual PDU session | +| ExposureDataSubscriptions | /exposure-data/subs-to-notify | POST | Create a subscription to receive notifications on exposure data changes. | +| IndividualExposureDataSubscription | /exposure-data/subs-to-notify/{subId} | PUT | Modify a subscription to receive notifications on exposure data changes. | +| | | DELETE | Delete a subscription identified by {subId}. | + +## 7.2.3 Resource: AccessAndMobilityData + +### 7.2.3.1 Description + +This resource represents the exposure data related to access and mobility. + +### 7.2.3.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//exposure-data/{ueId}/access-and-mobility-data + +This resource shall support the resource URI variables defined in table 7.2.3.2-1. + +**Table 7.2.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| ueId | VarUeId | Represents the SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7]. | + +### 7.2.3.3 Resource Standard Methods + +#### 7.2.3.3.1 PUT + +This method shall support the URI query parameters specified in table 7.2.3.3.1-1. + +**Table 7.2.3.3.1-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 7.2.3.3.1-2 and the response data structures and response codes specified in table 7.2.3.3.1-3. + +**Table 7.2.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------------------------------------------| +| AccessAndMobilityData | M | 1 | Access and mobility data for the UE is created or updated. | + +**Table 7.2.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AccessAndMobilityData | M | 1 | 201 Created | Successful case.
The resource has been successfully created and a response body containing a representation of the access and mobility data shall be returned. | +| AccessAndMobilityData | M | 1 | 200 OK | Successful case.
The resource has been successfully updated and a response body containing a representation of the access and mobility data shall be returned. | +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. | + +NOTE: The HTTP status code for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 7.2.3.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}/nudr-dr//exposure-data/{ueId}/access-and-mobility-data | + +### 7.2.3.3.2 GET + +This method shall support the URI query parameters specified in table 7.2.3.3.2-1. + +**Table 7.2.3.3.2-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.
See 3GPP TS 29.500 [4] clause 6.6.2 and 3GPP TS 29.571 [7]. | + +This method shall support the request data structures specified in table 7.2.3.3.2-2 and the response data structures and response codes specified in table 7.2.3.3.2-3. + +**Table 7.2.3.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.2.3.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|----------------|----------------------------------------------------------| +| AccessAndMobilityData | M | 1 | 200 OK | The response body contains the access and mobility data. | + +NOTE: The HTTP status code for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +### 7.2.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 7.2.3.3.3-1. + +**Table 7.2.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 7.2.3.3.3-2 and the response data structures and response codes specified in table 7.2.3.3.3-3. + +**Table 7.2.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.2.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 | Upon success, an empty response body shall be returned. | + +NOTE: The HTTP status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +### 7.2.3.3.4 PATCH + +This method shall support the URI query parameters specified in table 7.2.3.3.4-1. + +**Table 7.2.3.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.2.3.3.4-2 and the response data structures and response codes specified in table 7.2.3.3.4-3. + +**Table 7.2.3.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|--------------------------------------| +| AccessAndMobilityData | M | 1 | Access and mobility data for the UE. | + +**Table 7.2.3.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. | + +NOTE: The HTTP status code for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +## 7.2.4 Resource: PduSessionManagementData + +### 7.2.4.1 Description + +This resource represents the exposure data related to session and management data for a given subscriber and a given PDU session. + +## 7.2.4.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//exposure-data/{ueId}/session-management-data/{pduSessionId} + +This resource shall support the resource URI variables defined in table 7.2.4.2-1. + +**Table 7.2.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|--------------|------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| ueId | VarUeId | Represents the SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7]. | +| pduSessionId | PduSessionId | Identifies an individual PDU session. Data type PduSessionId is defined in 3GPP TS 29.571 [7]. | + +## 7.2.4.3 Resource Standard Methods + +### 7.2.4.3.1 PUT + +This method shall support the URI query parameters specified in table 7.2.4.3.1-1. + +**Table 7.2.4.3.1-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 7.2.4.3.1-2 and the response data structures and response codes specified in table 7.2.4.3.1-3. + +**Table 7.2.4.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|---------------------------------------------------------------------------| +| PduSessionManagementData | M | 1 | Session management data for a UE and a PDU session is created or updated. | + +**Table 7.2.4.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|--------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PduSessionManagementData | M | 1 | 201 Created | Successful case.
The resource has been successfully created and a response body containing a representation of the session management data shall be returned. | +| PduSessionManagementData | M | 1 | 200 OK | Successful case.
The resource has been successfully updated and a response body containing a representation of the session management data shall be returned. | +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. | + +NOTE: The HTTP status code for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 7.2.4.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}/nudr-dr//exposure-data/{ueId}/session-management-data/{pduSessionId} | + +### 7.2.4.3.2 GET + +This method shall support the URI query parameters specified in table 7.2.4.3.2-1. + +**Table 7.2.4.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipv4-addr | Ipv4Addr | O | 0..1 | UE IPv4 address. | +| ipv6-prefix | Ipv6Prefix | O | 0..1 | UE IPv6 prefix. | +| dnn | Dnn | O | 0..1 | Identifies a DNN. | +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer.
See 3GPP TS 29.500 [4] clause 6.6.2 and 3GPP TS 29.571 [7]. | + +This method shall support the request data structures specified in table 7.2.4.3.2-2 and the response data structures and response codes specified in table 7.2.4.3.2-3. + +**Table 7.2.4.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.2.4.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|-----------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| PduSessionManagement Data | M | 1 | 200 OK | The response body contains the session management data. | +| NOTE: The HTTP status code for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 7.2.4.3.3 DELETE + +This method shall support the URI query parameters specified in table 7.2.4.3.3-1. + +**Table 7.2.4.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 7.2.4.3.3-2 and the response data structures and response codes specified in table 7.2.4.3.3-3. + +**Table 7.2.4.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.2.4.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 | Upon success, an empty response body shall be returned. | +| NOTE: The HTTP status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 7.2.5 Resource: ExposureDataSubscriptions + +### 7.2.5.1 Description + +This resource is used to represent subscriptions to notifications of exposure data modifications. + +### 7.2.5.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//exposure-data/subs-to-notify + +This resource shall support the resource URI variables defined in table 7.2.5.2-1. + +**Table 7.2.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 7.2.5.3 Resource Standard Methods + +#### 7.2.5.3.1 POST + +This method shall support the URI query parameters specified in table 7.2.5.3.1-1. + +**Table 7.2.5.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.2.5.3.1-2 and the response data structures and response codes specified in table 7.2.5.3.1-3. + +**Table 7.2.5.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|----------------------------------------------------------------------------------------| +| ExposureDataSubscription | M | 1 | Identifies an individual subscription to notifications of exposure data modifications. | + +**Table 7.2.5.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ExposureDataSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of the Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 7.2.5.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}/nudr-dr//exposure-data/subs-to-notify/{subId} | + +## 7.2.6 Resource: IndividualExposureDataSubscription + +### 7.2.6.1 Description + +This resource represents an individual subscription to notifications of exposure data modifications. + +### 7.2.6.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//exposure-data/subs-to-notify/{subId} + +This resource shall support the resource URI variables defined in table 7.2.6.2-1. + +**Table 7.2.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| subId | string | Identifies an individual subscription to notifications. The value is allocated by the UDR during creation of the IndividualExposureDataSubscription resource. | + +### 7.2.6.3 Resource Standard Methods + +#### 7.2.6.3.1 PUT + +This method shall support the URI query parameters specified in table 7.2.6.3.1-1. + +**Table 7.2.6.3.1-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 7.2.6.3.1-2 and the response data structures and response codes specified in table 7.2.6.3.1-3. + +**Table 7.2.6.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|----------------------------------------------------------------------------------------| +| ExposureDataSubscription | M | 1 | Identifies an individual subscription to notifications of exposure data modifications. | + +**Table 7.2.6.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| ExposureDataSubscription | M | 1 | 200 OK | The individual subscription resource was updated successfully and a body with the modified subscription to notifications about exposure data is returned. | +| n/a | | | 204 No Content | The individual subscription resource was successfully modified. | +| 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. | | | | | + +#### 7.2.6.3.2 DELETE + +This method shall support the URI query parameters specified in table 7.2.6.3.2-1. + +**Table 7.2.6.3.1-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 7.2.6.3.2-2 and the response data structures and response codes specified in table 7.2.6.3.2-3. + +**Table 7.2.6.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 7.2.6.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 7.3 Data Model + +### 7.3.1 General + +This clause specifies the application data model supported by the API. + +Table 7.3.1-1 specifies the data types defined for the Nudr\_DataRepository for Exposure Data service based interface protocol. + +**Table 7.3.1-1: Nudr\_DataRepository specific Data Types for Exposure Data** + +| Data type | Section defined | Description | Applicability | +|--------------------------------|-----------------|---------------------------------------------------------------------------------|---------------| +| AccessAndMobilityData | 7.3.2.2 | | | +| ExposureDataChangeNotification | 7.3.2.5 | Contains changed exposure data for one UE for which Notification was requested. | | +| ExposureDataSubscription | 7.3.2.4 | Subscription to Notifications about Exposure Data. | | +| PduSessionManagementData | 7.3.2.3 | | | +| PduSessionStatus | 7.3.3.3 | Represents the state of the PDU session, i.e. active or released. | | + +Table 7.3.1-2 specifies data types re-used by the Nudr\_DataRepository for Exposure Data 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 Nudr\_DataRepository for Exposure Data service based interface. + +**Table 7.3.1-2: Nudr\_DataRepository re-used Data Types for Exposure Data** + +| Data type | Reference | Comments | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|------------------------------------------------------------------|----------------------| +| AccessType | 3GPP TS 29.571 [7] | Identifies the access type, i.e. 3GPP access or Non-3GPP access. | | +| CmlInfo | 3GPP TS 29.518 [10] | Describes the connectivity management state of a UE. | | +| DateTime | 3GPP TS 29.571 [7] | | | +| Dnai | 3GPP TS 29.571 [7] | Identifies a Data network access identifier. | | +| Dnn | 3GPP TS 29.571 [7] | Identifies a Data Network Name. (NOTE) | | +| Ipv4Addr | 3GPP TS 29.571 [7] | The IPv4 Address. | | +| Ipv6Addr | 3GPP TS 29.571 [7] | The Ipv6 Address. | | +| Ipv6Prefix | 3GPP TS 29.571 [7] | The Ipv6 Address Prefix. | | +| PduSessionId | 3GPP TS 29.571 [7] | PDU Session Identifier | | +| PduSessionType | 3GPP TS 29.571 [7] | PDU Session type. | | +| PlmnId | 3GPP TS 29.571 [7] | Identifies a PLMN. | | +| RatType | 3GPP TS 29.571 [7] | Identifies a RAT type. | | +| RmlInfo | 3GPP TS 29.518 [10] | Describes the registration management state of a UE. | | +| RouteToLocation | 3GPP TS 29.571 [7] | A traffic route to/from a DNAI. | | +| TimeZone | 3GPP TS 29.571 [7] | Identifies a time zone. | | +| SmsSupport | 3GPP TS 29.518 [10] | Indicates the supported SMS delivery of a UE. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features. | | +| UeReachability | 3GPP TS 29.518 [10] | Describes the reachability of the UE. | | +| Uri | 3GPP TS 29.571 [7] | | | +| UserLocation | 3GPP TS 29.571 [7] | Identifies the user location. | | +| VarUeld | 3GPP TS 29.571 [7] | String represents the SUPI or GPSI. | | +| NOTE: The UDR uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. | | | | + +## 7.3.2 Structured data types + +### 7.3.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 7.3.2.2 Type AccessAndMobilityData + +**Table 7.3.2.2-1: Definition of type AccessAndMobilityData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| location | UserLocation | O | 0..1 | Current location for the UE, which can be a combination of E-UTRA, NR and non-3GPP access location. | | +| locationTs | DateTime | O | 0..1 | Indicates when the location was last updated. | | +| timeZone | TimeZone | O | 0..1 | Current time zone for the UE. | | +| timeZoneTs | DateTime | O | 0..1 | Indicates when the timeZone was last updated. | | +| accessType | AccessType | O | 0..1 | Current access type for the UE (3GPP access or non-3GPP access). | | +| accessTypeTs | DateTime | O | 0..1 | Indicates when the accessType was last updated. | | +| regStates | array(RmlInfo) | O | 1..N | Describes the registration management state of the UE. | | +| regStatesTs | DateTime | O | 0..1 | Indicates when the regStates were last updated. | | +| connStates | array(CmlInfo) | O | 1..N | Describes the connectivity management state of the UE. | | +| connStatesTs | DateTime | O | 0..1 | Indicates when the connStates were last updated. | | +| reachabilityStatus | UeReachability | O | 0..1 | Describes the reachability of the UE. | | +| reachabilityStatusTs | DateTime | O | 0..1 | Indicates when the reachabilityStatus was last updated. | | +| smsOverNasStatus | SmsSupport | O | 0..1 | Indicates the supported SMS delivery of the UE. | | +| smsOverNasStatusTs | DateTime | O | 0..1 | Indicates when the smsOverNasStatus was last updated. | | +| roamingStatus | boolean | O | 0..1 | True: The serving PLMN of the UE is different from the HPLMN of the UE;
False: The serving PLMN of the UE is the HPLMN of the UE. | | +| roamingStatusTs | DateTime | O | 0..1 | Indicates when the roamingStatus was last updated. | | +| currentPlmn | PlmnId | O | 0..1 | The identity of the PLMN serving the UE. | | +| currentPlmnTs | DateTime | O | 0..1 | Indicates when the currentPlmn was last updated. | | +| ratTypes | array(RatType) | O | 1..N | RAT type(s) | | +| ratTypesTs | DateTime | O | 0..1 | Indicates when the ratTypes was last updated. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 7.5.
Shall be present in the HTTP PUT request/response; or in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE) | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | + +NOTE: In the HTTP request, it represents the set of features supported by the NF service consumer. In the HTTP response, it represents the set of features supported by both the NF service consumer and the UDR. + +### 7.3.2.3 Type PduSessionManagementData + +**Table 7.3.2.3-1: Definition of type PduSessionManagementData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------| +| pduSessionStatus | PduSessionStatus | O | 0..1 | Status of the PDU session. | | +| pduSessionStatusTs | DateTime | O | 0..1 | Indicates when the pduSessionStatus was last updated. | | +| dnai | Dnai | O | 0..1 | DNAI | | +| dnaiTs | DateTime | O | 0..1 | Indicates when the dnai was last updated. | | +| n6TrafficRoutingInfo | array(RouteToLocation) | O | 1..N | N6 traffic routing information. | | +| n6TrafficRoutingInfoTs | DateTime | O | 0..1 | Indicates when the n6TrafficRoutingInfo was last updated. | | +| ipv4Addr | Ipv4Addr | O | 0..1 | UE IPv4 address. | | +| ipv6Prefix | array(Ipv6Prefix) | O | 1..N | UE IPv6 prefix. | | +| ipv6Addrs | array(Ipv6Addr) | O | 1..N | IPv6 addresses. | | +| pduSessType | PduSessionType | O | 0..1 | PDU session type. | | +| ipAddrTs | DateTime | O | 0..1 | Indicates when the ipv4Addr and Ipv6Prefix were last updated. | | +| dnn | Dnn | O | 0..1 | DNN | | +| pduSessionId | PduSessionId | O | 0..1 | The identifier of a PduSessionManagement resource. (NOTE 1). | ResourceNotificationExposureDataFix | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 7.5.
Shall be present in the HTTP PUT request/response; or in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE 2) | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | + +NOTE 1: The "pduSessionId" attribute shall be present when the ResourceNotificationExposureDataFix is supported. + +NOTE 2: In the HTTP request, it represents the set of features supported by the NF service consumer. In the HTTP response, it represents the set of features supported by both the NF service consumer and the UDR. + +### 7.3.2.4 Type ExposureDataSubscription + +**Table 7.3.2.4-1: Definition of type ExposureDataSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|---------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| notificationUri | Uri | M | 1 | URI provided by the NF service consumer indicating where to receive to subscribed notifications from the UDR. | | +| monitoredResourceUris | array(Uri) | M | 1..N | A set of URIs that identify the resources for which a modification triggers a notification. | | +| expiry | DateTime | C | 0..1 | This IE shall be included in a subscription response if, based on operator policy and taking into account the expiry time included in the request, the UDR needs to include an expiry time.
This IE may be included in a subscription request. When present, this IE shall represent the time after which the subscription becomes invalid.
The absence of this attribute in the subscription response means the subscription to be valid without an expiry time. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of the optional features.
This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | +| immRep | boolean | O | 0..1 | If provided and set to "true", it indicates that existing entries that match this subscription shall be immediately reported within the "immReports" attribute in the response. The default value is false. | ImmediateReportPcc | +| immReports | array(ExposureDataChangeNotification) | O | 1..N | Contains entries stored in the UDR that match this subscription.
It may be included only in the POST (or PUT) response body of a subscription creation (or modification), and only if the request included the "immRep" attribute set to true. | ImmediateReportPcc | + +### 7.3.2.5 Type ExposureDataChangeNotification + +**Table 7.3.2.5-1: Definition of type ExposureDataChangeNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|---------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueId | VarUeId | O | 0..1 | User identity of modified data. | | +| accessAndMobilityData | AccessAndMobilityData | O | 0..1 | Access and Mobility Data for the UE. | | +| pduSessionManagementData | array(PduSessionManagementData) | O | 1..N | PDU Session Management Data for one or several PDU sessions of the UE. | | +| delResources | array(Uri) | O | 1..N | The resources, as defined in table 7.2.2-1, if removed from UDR and notification on resource data change was requested. It may be present when the ResourceNotificationExposureDataFix is supported (NOTE). | | + +NOTE: When the "delResources" attribute is present, the attributes that correspond with the values included in the "delResources" attribute shall be omitted. I.e., when the "delResources" attribute includes the value "../{ueId}/access-and-mobility-data" the attribute "accessAndMobilityData" shall be omitted, and when the "delResources" attribute includes all the existing "../{ueId}/session-management-data/{pduSessionId}" resource URIs, the attribute "pduSessionManagementData" shall be omitted. + +## 7.3.3 Simple data types and enumerations + +### 7.3.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 7.3.3.2 Simple data types + +The simple data types defined in table 7.3.3.2-1 shall be supported. + +**Table 7.3.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +### 7.3.3.3 Enumeration: PduSessionStatus + +**Table 7.3.3.3-1: Enumeration PduSessionStatus** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------|---------------| +| "ACTIVE" | The PDU session is active. | | +| "RELEASED" | The PDU session is released. | | + +## 7.4 Error handling + +### 7.4.1 General + +For the Nudr\_DataRepository service API for Exposure Data, 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 Nudr\_DataRepository service API for Exposure Data. + +## 7.4.2 Protocol Errors + +No specific procedures for the Nudr\_DataRepository service API for Exposure Data are specified. + +## 7.4.3 Application Errors + +The application errors defined for the Nudr\_DataRepository service API for Exposure Data are listed in table 7.4.3-1. + +**Table 7.4.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +The application error handling shall follow 3GPP TS 29.504 [6] clause 6.1.6 unless explicitly specified in this document. + +## 7.5 Feature negotiation + +The optional features in table 6.1.8-1 of 3GPP TS 29.504 [6] are defined for the Nudr\_DataRepository API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +## 7.6 Notifications + +### 7.6.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +This clause describes the resources to provide Notification to NF service consumers which have subscribed to be notified when exposure data is changed. + +**Table 7.6.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------|-------------------|---------------------------------|-----------------------------------| +| Exposure Data Change Notification | {notificationUri} | POST | Exposure Data Change Notification | + +### 7.6.2 Exposure Data Change Notification + +The POST method shall be used for Data Change Notifications and the URI shall be as provided during the subscription procedure. + +Callback URI: {notificationUri} + +Support of URI query parameters is specified in table 7.6.2-1. + +**Table 7.6.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 7.6.2-2 and of response data structures and response codes is specified in table 7.6.2-3. + +**Table 7.6.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------------------------------|---|-------------|----------------------------------------------------------------------------| +| array(ExposureDataChange Notification) | M | 1..N | Each element in the array provides the changed exposure data for one user. | + +**Table 7.6.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| 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. | | | | | + +## Annex A (normative): OpenAPI specification + +### A.1 General + +The present Annex contains an OpenAPI [3] specification of HTTP messages and content bodies used by the Nudr\_DataRepository service for Policy Data, Application Data and Exposure Data. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [18] and clause 5.3.1 of the 3GPP TS 29.501 [5] for further information). + +### A.2 Nudr\_DataRepository API for Policy Data + +For the purpose of referencing entities in the Open API file defined in this Annex, it shall be assumed that this Open API file is contained in a physical file named "TS29519\_Policy\_Data.yaml". + +``` +openapi: 3.0.0 + +info: + version: '-' + title: Unified Data Repository Service API file for policy data + description: | + The API version is defined in 3GPP TS 29.504 + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.519 V18.4.0; 5G System; Usage of the Unified Data Repository Service for Policy Data, + Application Data and Structured Data for Exposure. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.519/' + +paths: + /policy-data/ues/{ueId}: +``` + +``` + +parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +get: + summary: Retrieve the policy data for a subscriber + operationId: ReadPolicyData + tags: + - PolicyDataForIndividualUe (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: data-subset-names + in: query + style: form + explode: false + description: List of policy data subset names + required: false + schema: + type: array + items: + $ref: '#/components/schemas/PolicyDataSubset' + minItems: 2 + responses: + '200': + description: Upon success, a response body containing policy data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataForIndividualUe' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/ues/{ueId}/am-data: + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + get: + summary: Retrieves the access and mobility policy data for a subscriber + operationId: ReadAccessAndMobilityPolicyData + tags: + - AccessAndMobilityPolicyData (Document) + +``` + +``` + +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:am-data:read +parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: > + Upon success, a response body containing access and mobility policies shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AmPolicyData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/ues/{ueId}/ue-policy-set: + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + get: + summary: Retrieves the UE policy set data for a subscriber + operationId: ReadUEPolicySet + tags: + - UEPolicySet (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:ue-policy-set:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + +``` + +``` + +'200': + description: Upon success, a response body containing UE policies shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Create or modify the UE policy set data for a subscriber + operationId: CreateOrReplaceUEPolicySet + tags: + - UEPolicySet (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:ue-policy-set:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' + responses: + '201': + description: > + Successful case. The resource has been successfully created and a response body + containing a representation of the created UEPolicySet resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '200': + description: > + Successful case. The resource has been successfully created and a response body + containing UE policies shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' + '204': + description: > + Successful case. The resource has been successfully updated and no additional content + is to be sent in the response message. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': +$ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': +$ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': +$ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': +$ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': +$ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': +$ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': +$ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': +$ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': +$ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: +$ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: +summary: Modify the UE policy set data for a subscriber +operationId: UpdateUEPolicySet +tags: +- UEPolicySet (Document) +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- nudr-dr:policy-data:ues:ue-policy-set:modify +requestBody: +required: true +content: +application/merge-patch+json: +schema: +$ref: '#/components/schemas/UePolicySetPatch' +responses: +'204': +description: > +Successful case. The resource has been successfully updated and no additional content is +to be sent in the response message. +'400': +$ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': +$ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': +$ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': +$ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': +$ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': +$ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': +$ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': +$ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': +$ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': +$ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': +$ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: +$ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/ues/{ueId}/sm-data: +get: +summary: Retrieves the session management policy data for a subscriber +operationId: ReadSessionManagementPolicyData +tags: +``` + +``` + + - SessionManagementPolicyData (Document) +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- nudr-dr:policy-data:ues:sm-data:read +parameters: +- name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: snssai + in: query + required: false + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' +- name: dnn + in: query + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +- name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 +- name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: +'200': + description: Upon success, a response body containing SmPolicyData shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyData' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: +summary: Modify the session management policy data for a subscriber +operationId: UpdateSessionManagementPolicyData +tags: + +``` + +``` + + - SessionManagementPolicyData (Document) +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- nudr-dr:policy-data:ues:sm-data:modify +parameters: +- name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SmPolicyDataPatch' +responses: + '204': + description: > + Successful case. The resource has been successfully updated and no + additional content is to be sent in the response message. + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/ues/{ueId}/sm-data/{usageMonId}: + get: + summary: Retrieve a usage monitoring resource + operationId: ReadUsageMonitoringInformation + tags: + - UsageMonitoringInformation (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:sm-data:read + parameters: + +``` + +``` +- name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: usageMonId + in: path + required: true + schema: + type: string +- name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Successful case. The usage monitoring data is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UsageMonData' + '204': + description: The resource was found but no usage monitoring data is available. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Create a usage monitoring resource + operationId: CreateUsageMonitoringResource + tags: + - UsageMonitoringInformation (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:sm-data:create + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: usageMonId + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: +``` + +``` + schema: + $ref: '#/components/schemas/UsageMonData' +responses: + '201': + description: > + Successful case. The resource has been successfully created and a response body is + returned containing a representation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/UsageMonData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete a usage monitoring resource + operationId: DeleteUsageMonitoringInformation + tags: + - UsageMonitoringInformation (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:sm-data:modify + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: usageMonId + in: path + required: true + schema: + type: string + responses: + '204': + description: Successful case. The resource has been successfully deleted. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/sponsor-connectivity-data/{sponsorId}: + parameters: + - name: sponsorId + in: path + required: true + schema: + type: string + get: + summary: Retrieves the sponsored connectivity information for a given sponsorId + operationId: ReadSponsorConnectivityData + tags: + - SponsorConnectivityData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:sponsor-connectivity-data:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + Upon success, a response body containing Sponsor Connectivity Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SponsorConnectivityData' + '204': + description: The resource was found but no Sponsor Connectivity Data is available. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/bdt-data: + get: + summary: Retrieves the BDT data collection +``` + +``` + +operationId: ReadBdtData +tags: + - BdtData (Store) +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdtd-data:read +parameters: + - name: bdt-ref-ids + in: query + description: List of the BDT reference identifiers. + required: false + schema: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + minItems: 1 + style: form + explode: false + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Upon success, a response body containing the BDT data shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BdtData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/bdt-data/{bdtReferenceId}: + parameters: + - name: bdtReferenceId + in: path + required: true + schema: + type: string + get: + summary: Retrieves the BDT data information associated with a BDT reference Id + operationId: ReadIndividualBdtData + tags: + - IndividualBdtData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + +``` + +``` + + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdtd-data:read +parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Upon success, a response body containing the BDT data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Creates an BDT data resource associated with an BDT reference Id + operationId: CreateIndividualBdtData + tags: + - IndividualBdtData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdtd-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BdtData' + responses: + '201': + description: Successful case. The resource has been successfully created. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + +``` + +``` +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Modifies an BDT data resource associated with an BDT reference Id + operationId: UpdateIndividualBdtData + tags: + - IndividualBdtData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdtd-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/BdtDataPatch' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/BdtData' + '204': + description: > + Successful case. The resource has been successfully updated and no additional content + is to be sent in the response message. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + delete: + summary: Deletes an BDT data resource associated with an BDT reference Id + operationId: DeleteIndividualBdtData + tags: + - IndividualBdtData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdtd-data:modify + responses: + '204': + description: Successful case. The resource has been successfully deleted. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/subs-to-notify: + get: + summary: Retrieves the list of Individual Policy Data Subscription resources + operationId: ReadPolicyDataSubscriptions + tags: + - PolicyDataSubscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:subs-to-notify:read + parameters: + - name: mon-resources + in: query + style: form + explode: false + description: List of monitored resources whose subscriptions are requested. + required: false + schema: + type: array + items: + type: string + description: Contains the apiSpecificResourceUriPart of the resource URI. + minItems: 1 + - name: ue-id + in: query + description: Represents the Subscription Identifier SUPI or GPSI. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supp-feat + +``` + +``` + +in: query +description: Supported Features +required: false +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: > + Upon success, a response body containing a list of Individual Policy Data + Subscription resources shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PolicyDataSubscription' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +post: + summary: Create a subscription to receive notification of policy data changes + operationId: CreateIndividualPolicyDataSubscription + tags: + - PolicyDataSubscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data:subs-to-notify + - nudr-dr:policy-data:subs-to-notify:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + responses: + '201': + description: > + Upon success, a response body containing a representation of each Individual + subscription resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + policyDataChangeNotification: + '{ $request.body#/notificationUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PolicyDataChangeNotification' + minItems: 1 + responses: + '204': + description: No Content, Notification was successful + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/subs-to-notify/{subsId}: + parameters: + - name: subsId + in: path + required: true + schema: + type: string + get: + summary: Retrieves Individual Policy Subscription data + operationId: ReadIndividualPolicySubscriptionData + tags: + - IndividualPolicySubscriptionData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + +``` + +``` + + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:subs-to-notify:read +responses: + '200': + description: > + Upon success, a response body containing Policy Data Subscription shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Modify a subscription to receive notification of policy data changes + operationId: ReplaceIndividualPolicyDataSubscription + tags: + - IndividualPolicyDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:subs-to-notify:modify + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + responses: + '200': + description: The individual subscription resource was updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + '204': + description: > + The individual subscription resource was updated successfully and no + additional content is to be sent in the response message. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + +``` + +``` + + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete the individual Policy Data subscription + operationId: DeleteIndividualPolicyDataSubscription + tags: + - IndividualPolicyDataSubscription (Document) + responses: + '204': + description: Upon success, an empty response body shall be returned. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/ues/{ueId}/operator-specific-data: + get: + summary: Retrieve the operator specific policy data of an UE + operationId: ReadOperatorSpecificData + tags: + - OperatorSpecificData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:operator-specific-data:read + parameters: + - name: ueId + in: path + description: UE Id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +``` + +``` +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + additionalProperties: + $ref: + 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify the operator specific policy data of a UE + operationId: UpdateOperatorSpecificData + tags: + - OperatorSpecificData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:operator-specific-data:modify + parameters: + - name: ueId + in: path + description: UE Id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: No content. Response to successful modification. + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Create or modify the operator specific policy data of a UE + operationId: ReplaceOperatorSpecificData + tags: + - OperatorSpecificData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:operator-specific-data:create + parameters: + - name: ueId + in: path + description: UE Id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + '201': + description: > + Successful case. When the feature OSResource_Create_Delete is supported + and the resource has been successfully created, a response body containing a + representation of the created OperatorSpecificData resource shall be returned. + content: + application/json: + schema: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + headers: + - Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + +``` + +``` + + type: string + '204': + description: The resource has been successfully updated. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: When the feature OSResource_Create_Delete is supported, delete OperatorSpecificData +resource + operationId: DeleteOperatorSpecificData + tags: + - OperatorSpecificData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:operator-specific-data:modify + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + responses: + '204': + description: Successful case. The resource has been successfully deleted. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/plmns/{plmnId}/ue-policy-set: + parameters: + - name: plmnId + in: path + required: true + schema: + +``` + +``` + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/VarPlmnId' +get: + summary: Retrieve the UE policy set data for an H-PLMN + operationId: ReadPlmnUePolicySet + tags: + - PlmnUePolicySet (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:plmns:ue-policy-set:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Upon success, a response body containing UE policies shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '412': + $ref: 'TS29571_CommonData.yaml#/components/responses/412' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/slice-control-data/{snssai}: + parameters: + - name: snssai + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + get: + summary: Retrieves a network Slice specific policy control data resource + operationId: ReadSlicePolicyControlData + tags: + - SlicePolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:slice-control-data:read + parameters: +``` + +``` + +- name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: > + Successful case. The network slice specific policy control data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SlicePolicyData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Modify a network Slice specific policy control data resource + operationId: UpdateSlicePolicyControlData + tags: + - SlicePolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:slice-control-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SlicePolicyDataPatch' + responses: + '200': + description: > + The resource has been successfully updated and a response body containing network + slice specific policy control data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SlicePolicyData' + '204': + description: > + The resource has been successfully updated and no additional content is + to be sent in the response message. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/mbs-session-pol-data/{polSessionId}: + parameters: + - name: polSessionId + description: > + Represents the identifier of the MBS Session Policy Control Data. + in: path + required: true + schema: + $ref: '#/components/schemas/MbsSessPolDataId' + + get: + summary: Retrieve MBS Session Policy Control Data for an MBS Session. + operationId: GetMBSSessPolCtrlData + tags: + - MBSSessionPolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:mbs-session-pol-data:read + responses: + '200': + description: > + OK. The requested MBS Session Policy Control Data is successfully returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsSessPolCtrlData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/pdtq-data: + get: + summary: Retrieves the PDTQ data collection + operationId: ReadPdtqData + tags: + +``` + +``` + + - PdtqData (Store) +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- nudr-dr:policy-data:pdtq-data:read +parameters: +- name: pdtq-ref-ids + in: query + description: List of the PDTQ reference identifiers. + required: false + schema: + type: array + items: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqReferenceId' + minItems: 1 + style: form + explode: false +- name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: +'200': + description: Upon success, a response body containing the PDTQ data shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PdtqData' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/pdtq-data/{pdtqReferenceId}: +parameters: +- name: pdtqReferenceId + in: path + required: true + schema: + type: string +get: + summary: Retrieves the PDTQ data information associated with a PDTQ reference Id + operationId: ReadIndividualPdtqData + tags: + - IndividualPdtqData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + +``` + +``` +- nudr-dr:policy-data +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:pdtq-data:read +parameters: +- name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: +'200': + description: Upon success, a response body containing the PDTQ data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqData' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Creates a PDTQ data resource associated with a PDTQ reference Id + operationId: CreateIndividualPdtqData + tags: + - IndividualPdtqData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:pdtq-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqData' + responses: +'201': + description: Successful case. The resource has been successfully created. + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +``` + +``` + + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Modifies a PDTQ data resource associated with a PDTQ reference Id + operationId: UpdateIndividualPdtqData + tags: + - IndividualPdtqData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:pdqt-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PdtqDataPatch' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqData' + '204': + description: > + Successful case. The resource has been successfully updated and no additional content + is to be sent in the response message. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Deletes a PDTQ data resource associated with a PDTQ reference Id + operationId: DeleteIndividualPdtqData + tags: + - IndividualPdtqData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:pdtq-data:modify + responses: + '204': + description: Successful case. The resource has been successfully deleted. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/group-control-data/{intGroupId}: + parameters: + - name: intGroupId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + + get: + summary: Retrieves a group specific policy control subscription data resource + operationId: ReadGroupPolCtrlData + tags: + - GroupPolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:group-control-data:read + parameters: + - name: supp-feat + in: query + description: Represents the supported features. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + Successful case. The requested group specific policy control subscription data shall be + returned. + content: + application/json: + schema: +``` + +``` + + $ref: '#/components/schemas/GroupPolicyData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify an existing group specific policy control subscription data resource. + operationId: ModifyGroupPolCtrlData + tags: + - GroupPolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:group-control-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/GroupPolicyDataPatch' + responses: + '200': + description: > + The resource has been successfully modified and a response body containing the updated + group specific policy control subscription data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/GroupPolicyData' + '204': + description: > + The resource has been successfully modified and no additional content is to be sent in + the response body. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +``` + +components: + +schemas: + +PolicyDataForIndividualUe: + +description: Contains policy data for a given subscriber. + +type: object + +properties: + +uePolicyDataSet: + +\$ref: '#/components/schemas/UePolicySet' + +smPolicyDataSet: + +\$ref: '#/components/schemas/SmPolicyData' + +amPolicyDataSet: + +\$ref: '#/components/schemas/AmPolicyData' + +umData: + +type: object + +additionalProperties: + +\$ref: '#/components/schemas/UsageMonData' + +minProperties: 1 + +description: > + +Contains UM policies. The value of the limit identifier is used as the key of the map. + +operatorSpecificDataSet: + +type: object + +additionalProperties: + +\$ref: 'TS29505\_Subscription\_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + +minProperties: 1 + +description: > + +Contains Operator Specific Data resource data. The key of the map is operator specific data element name and the value is the operator specific data of the UE. + +suppFeat: + +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/SupportedFeatures' + +AmPolicyData: + +description: Contains the AM policy data for a given subscriber. + +type: object + +properties: + +praInfos: + +type: object + +additionalProperties: + +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/PresenceInfo' + +minProperties: 1 + +description: > + +Contains Presence reporting area information. The praId attribute within the PresenceInfo data type is the key of the map. + +subscCats: + +type: array + +items: + +type: string + +minItems: 1 + +chfInfo: + +\$ref: 'TS29512\_Npcf\_SMPolicyControl.yaml#/components/schemas/ChargingInformation' + +subscSpendingLimits: + +type: boolean + +description: > + +Indicates whether the PCF must enforce Access and Mobility management related policies based on subscriber spending limits. + +suppFeat: + +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/SupportedFeatures' + +UePolicySet: + +description: Contains the UE policy data for a given subscriber. + +type: object + +properties: + +praInfos: + +type: object + +additionalProperties: + +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/PresenceInfo' + +minProperties: 1 + +description: > + +Contains Presence reporting area information. The praId attribute within the PresenceInfo data type is the key of the map. + +subscCats: + +type: array + +items: + +type: string + +minItems: 1 + +uePolicySections: + +type: object + +``` + additionalProperties: + $ref: '#/components/schemas/UePolicySection' + minProperties: 1 + description: > + Contains the UE Policy Sections. The UE Policy Section Identifier is used as + the key of the map. + upsis: + type: array + items: + type: string + minItems: 1 + allowedRouteSelDescs: + type: object + additionalProperties: + $ref: '#/components/schemas/PlmnRouteSelectionDescriptor' + minProperties: 1 + description: > + Contains allowed route selection descriptors per serving PLMN for a UE. + The serving PLMN identifier is the key of the map. + andspInd: + type: boolean + epsUrspInd: + type: boolean + description: Indication of UE supporting URSP provisioning in EPS. + vpsUrspInd: + type: boolean + description: Indication of UE supporting VPLMN-specific URSP. + urspEnfind: + type: boolean + description: Indication of UE supporting URSP enforcement report. + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + osIds: + type: array + items: + $ref: '#/components/schemas/OsId' + minItems: 1 + chfInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ChargingInformation' + subscSpendingLimits: + type: boolean + description: > + Indicates whether the PCF must enforce UE policies based on subscriber spending limits. + tracingReq: + type: array + items: + type: string + minItems: 1 + description: > + Tracing requirements as defined in TS 32.421 [26] + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + +UePolicySetPatch: + description: Contains the UE policy set for a given subscriber. + type: object + properties: + uePolicySections: + type: object + additionalProperties: + $ref: '#/components/schemas/UePolicySection' + minProperties: 1 + description: > + Contains the UE Policy Sections. The UE Policy Section Identifier is used + as the key of the map. + upsis: + type: array + items: + type: string + minItems: 1 + andspInd: + type: boolean + epsUrspInd: +``` + +``` + type: boolean + description: Indication of UE supporting URSP provisioning in EPS. + vpsUrspInd: + type: boolean + description: Indication of UE supporting VPLMN-specific URSP. + urspEnfInd: + type: boolean + description: Indication of UE supporting URSP enforcement report. + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + osIds: + type: array + items: + $ref: '#/components/schemas/OsId' + minItems: 1 + + UePolicySection: + description: Contains the UE policy section. + type: object + properties: + uePolicySectionInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + upsi: + type: string + required: + - uePolicySectionInfo + - upsi + + SmPolicyData: + description: Contains the SM policy data for a given subscriber. + type: object + properties: + smPolicySnssaiData: + type: object + additionalProperties: + $ref: '#/components/schemas/SmPolicySnssaiData' + minProperties: 1 + description: > + Contains Session Management Policy data per S-NSSAI for all the SNSSAIs + of the subscriber. The key of the map is the S-NSSAI. + umDataLimits: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonDataLimit' + minProperties: 1 + description: > + Contains a list of usage monitoring profiles associated with the subscriber. + The limit identifier is used as the key of the map. + umData: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonData' + minProperties: 1 + description: > + Contains the remaining allowed usage data associated with the subscriber. + The limit identifier is used as the key of the map. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - smPolicySnssaiData + + SmPolicySnssaiData: + description: Contains the SM policy data for a given subscriber and S-NSSAI. + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + smPolicyDnnData: + type: object + additionalProperties: + $ref: '#/components/schemas/SmPolicyDnnData' + minProperties: 1 + description: > + Session Management Policy data per DNN for all the DNNs of the indicated S-NSSAI. + The key of the map is the DNN. + ueSliceMbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceMbr' + required: +``` + +``` + +- snssai + +SmPolicyDnnData: + description: Contains the SM policy data for a given DNN (and S-NSSAI). + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + allowedServices: + type: array + items: + type: string + minItems: 1 + subscCats: + type: array + items: + type: string + minItems: 1 + gbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + gbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + adcSupport: + type: boolean + subscSpendingLimits: + type: boolean + description: > + Indicates whether the PCF must enforce session management related policies based + on subscriber spending limits. + ipv4Index: + $ref: '#/components/schemas/IpIndex' + ipv6Index: + $ref: '#/components/schemas/IpIndex' + offline: + type: boolean + online: + type: boolean + chfInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ChargingInformation' + refUmDataLimitIds: + type: object + additionalProperties: + $ref: '#/components/schemas/LimitIdToMonitoringKey' + minProperties: 1 + description: > + A reference to the UsageMonDataLimit or UsageMonData instances for this DNN and SNSSAI + that may also include the related monitoring key(s). + The key of the map is the limit identifier. + mpsPriority: + type: boolean + mcsPriority: + type: boolean + imsSignallingPrio: + type: boolean + mpsPriorityLevel: + type: integer + mcsPriorityLevel: + type: integer + praInfos: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Contains Presence reporting area information. The praId attribute within the + PresenceInfo data type is the key of the map. + bdtRefIds: + type: object + additionalProperties: + $ref: '#/components/schemas/BdtReferenceIdRm' + minProperties: 1 + description: > + Identifies transfer policies of background data transfer. Any string value can + be used as a key of the map. + nullable: true + locRoutNotAllowed: + type: boolean + sfcNotAllowed: + +``` + +``` + type: boolean + tnaps: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TnapId' + minItems: 1 + description: Contains the TNAP IDs collocated with the 5G-RG(s) of a specific user. + required: + - dnn + +UsageMonDataLimit: + description: Contains usage monitoring control data for a subscriber. + type: object + properties: + limitId: + type: string + scopes: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonDataScope' + minProperties: 1 + description: > + Identifies the SNSSAI and DNN combinations to which the usage monitoring data + limit applies. The S-NSSAI is the key of the map. + umLevel: + $ref: '#/components/schemas/UsageMonLevel' + startDate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endDate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + usageLimit: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + resetPeriod: + $ref: '#/components/schemas/TimePeriod' + required: + - limitId + +UsageMonData: + description: Contains remain allowed usage data for a subscriber. + type: object + properties: + limitId: + type: string + scopes: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonDataScope' + minProperties: 1 + description: > + Identifies the SNSSAI and DNN combinations for remain allowed usage data + for a subscriber. The S-NSSAI is the key of the map. + umLevel: + $ref: '#/components/schemas/UsageMonLevel' + allowedUsage: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + resetTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + required: + - limitId + +LimitIdToMonitoringKey: + description: > + Contains the limit identifier and the corresponding monitoring key for a given + S-NSSAI and DNN. + type: object + properties: + limitId: + type: string + monkey: + type: array + items: +``` + +``` + type: string + minItems: 1 + required: + - limitId + nullable: true + +UsageMonDataScope: + description: > + Contains a SNSSAI and DNN combinations to which the UsageMonData instance belongs to. + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + dnn: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + required: + - snssai + +TimePeriod: + description: Contains the periodicity for the defined usage monitoring data limits. + type: object + properties: + period: + $ref: '#/components/schemas/Periodicity' + maxNumPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + required: + - period + +SponsorConnectivityData: + description: > + Contains the sponsored data connectivity related information for a sponsor identifier. + type: object + properties: + aspIds: + type: array + items: + type: string + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - aspIds + +BdtData: + description: Contains the background data transfer data. + type: object + properties: + aspId: + type: string + transPolicy: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/TransferPolicy' + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + nwAreaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + numOfUes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + volPerUe: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + trafficDes: + $ref: 'TS29122_ResourceManagementOfBdt.yaml#/components/schemas/TrafficDescriptor' + bdtpStatus: + $ref: '#/components/schemas/BdtPolicyStatus' + warnNotifEnabled: + type: boolean + description: > + Indicates whether the BDT warning notification is enabled (true) or not (false). + Default value is false. + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + suppFeat: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +resetIds: + type: array + items: + type: string + minItems: 1 +required: +- aspId +- transPolicy + +PolicyDataSubscription: + description: Identifies a subscription to policy data change notification. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifId: + type: string + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monResItems: + type: array + items: + $ref: '#/components/schemas/ResourceItem' + minItems: 1 + excludedResItems: + type: array + items: + $ref: '#/components/schemas/ResourceItem' + minItems: 1 + immRep: + type: boolean + description: > + If provided and set to true, it indicates that existing entries that + match this subscription shall be immediately reported in the response. + immReports: + type: array + items: + $ref: '#/components/schemas/PolicyDataChangeNotification' + minItems: 1 + description: Immediate report with existing UDR entries. + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + subsId: + type: string + required: + - notificationUri + - monitoredResourceUris + +PolicyDataChangeNotification: + description: Contains changed policy data for which notification was requested. + type: object + properties: + amPolicyData: + $ref: '#/components/schemas/AmPolicyData' + uePolicySet: + $ref: '#/components/schemas/UePolicySet' + plmnUePolicySet: + $ref: '#/components/schemas/UePolicySet' + smPolicyData: + $ref: '#/components/schemas/SmPolicyData' + usageMonData: + $ref: '#/components/schemas/UsageMonData' + SponsorConnectivityData: + $ref: '#/components/schemas/SponsorConnectivityData' + bdtData: + $ref: '#/components/schemas/BdtData' + opSpecData: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' +``` + +``` + +opSpecDataMap: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + minProperties: 1 + description: > + Operator Specific Data resource data, if changed and notification was requested. + The key of the map is operator specific data element name and the value is the + operator specific data of the UE. + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + sponsorId: + type: string + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + usageMonId: + type: string + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + delResources: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + notifId: + type: string + reportedFragments: + type: array + items: + $ref: '#/components/schemas/NotificationItem' + minItems: 1 + slicePolicyData: + $ref: '#/components/schemas/SlicePolicyData' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + pdtqData: + $ref: '#/components/schemas/PdtqData' + pdtqRefId: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqReferenceId' + groupPolicyData: + $ref: '#/components/schemas/GroupPolicyData' + intGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + +PlmnRouteSelectionDescriptor: + description: > + Contains the route selection descriptors (combinations of SNSSAI, DNNs, PDU session types, + SSC modes and ATSSS information) allowed by subscription to the UE for a serving PLMN + type: object + properties: + servingPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + snssaiRouteSelDescs: + type: array + items: + $ref: '#/components/schemas/SnssaiRouteSelectionDescriptor' + minItems: 1 + required: + - servingPlmn + +SnssaiRouteSelectionDescriptor: + description: > + Contains the route selector parameters (DNNs, PDU session types, SSC modes and ATSSS + information) per SNSSAI + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnnRouteSelDescs: + type: array + items: + $ref: '#/components/schemas/DnnRouteSelectionDescriptor' + minItems: 1 + required: + - snssai + +DnnRouteSelectionDescriptor: + description: > + +``` + +``` +Contains the route selector parameters (PDU session types, SSC modes and ATSSS +information) per DNN +type: object +properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sscModes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScMode' + minItems: 1 + pduSessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + atsssInfo: + description: > + Indicates whether MA PDU session establishment is allowed for this DNN. + When set to value true MA PDU session establishment is allowed for this DNN. + type: boolean + default: false + lboRoamAllowed: + type: boolean + description: > + Indicates whether LBO for the DNN and S-NSSAI is allowed when roaming. +required: +- dnn + +SmPolicyDataPatch: + description: Contains the SM policy data for a given subscriber. + type: object + properties: + umData: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonData' + minProperties: 1 + description: > + Contains the remaining allowed usage data associated with the subscriber. + The value of the limit identifier is used as the key of the map. + nullable: true + smPolicySnssaiData: + type: object + additionalProperties: + $ref: '#/components/schemas/SmPolicySnssaiDataPatch' + minProperties: 1 + description: > + Modifiable Session Management Policy data per S-NSSAI for all the SNSSAIs + of the subscriber. The key of the map is the S-NSSAI. + +SmPolicySnssaiDataPatch: + description: Contains the SM policy data for a given subscriber and S-NSSAI. + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + smPolicyDnnData: + type: object + additionalProperties: + $ref: '#/components/schemas/SmPolicyDnnDataPatch' + minProperties: 1 + description: > + Modifiable Session Management Policy data per DNN for all the DNNs of the + indicated S-NSSAI. The key of the map is the DNN. +required: +- snssai + +SmPolicyDnnDataPatch: + description: Contains the SM policy data for a given DNN (and S-NSSAI). + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + bdtRefIds: + type: object + additionalProperties: + $ref: '#/components/schemas/BdtReferenceIdRm' + minProperties: 1 +``` + +``` + description: > + Contains updated transfer policies of background data transfer. + Any string value can be used as a key of the map. + nullable: true + required: + - dnn + +ResourceItem: + description: > + Identifies a subscription to policy data change notification when the change occurs + in a fragment (subset of resource data) of a given resource. + type: object + properties: + monResourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + items: + type: array + items: + $ref: '#/components/schemas/ItemPath' + minItems: 1 + required: + - monResourceUri + - items + +NotificationItem: + description: > + Identifies a data change notification when the change occurs in a fragment + (subset of resource data) of a given resource. + type: object + properties: + resourceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifItems: + type: array + items: + $ref: '#/components/schemas/UpdatedItem' + minItems: 1 + required: + - resourceId + - notifItems + +UpdatedItem: + description: Identifies a fragment of a resource. + type: object + properties: + item: + $ref: '#/components/schemas/ItemPath' + value: {} + required: + - item + - value + +BdtDataPatch: + description: Contains the modified background data transfer data. + type: object + properties: + transPolicy: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/TransferPolicy' + bdtpStatus: + $ref: '#/components/schemas/BdtPolicyStatus' + warnNotifEnabled: + type: boolean + description: > + Indicates whether the BDT warning notification is enabled (true) or not (false). + +SlicePolicyData: + description: Contains the network slice specific policy control information. + type: object + properties: + mbrUL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mbrDL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainMbrUL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainMbrDL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + suppFeat: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +SlicePolicyDataPatch: + description: Contains the modified network slice specific policy control information. + type: object + properties: + remainMbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainMbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + oneOf: + - required: [remainMbrUl] + - required: [remainMbrDl] + +MbsSessPolCtrlData: + description: Represents MBS Session Policy Control Data. + type: object + properties: + 5qis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + minItems: 1 + maxMbsArpLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ArpPriorityLevel' + maxMbsSessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxGbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +MbsSessPolDataId: + description: Represents the identifier used to access the MBS Session Policy Control Data. + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + afAppId: + type: string + oneOf: + - required: [mbsSessionId] + - required: [afAppId] + +PdtqData: + description: Contains the planned data transfer data with QoS requirements. + type: object + properties: + aspId: + type: string + pdtqPolicy: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqPolicy' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + pdtqRefId: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqReferenceId' + nwAreaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + numOfUes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + desTimeInts: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + minItems: 1 + description: Identifies the time interval(s). + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altQosParamSets: + type: array + items: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/AltQosParamSet' + minItems: 1 + description: > + Contains the alternative QoS requirements as a list of individual QoS parameter + sets in a prioritized order. +``` + +``` + +altQosRefs: + type: array + items: + type: string + minItems: 1 + description: > + Contains the alternative QoS requirements as the list of QoS references in a + prioritized order. +qosParamSet: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/QosParameterSet' +qosReference: + type: string + description: > + Requested QoS requirements expressed as the QoS Reference which represents + a pre-defined QoS information. +notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +warnNotifEnabled: + type: boolean + description: > + Indicates whether the PDTQ warning notification is enabled (true) or not (false). + Default value is false. +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +resetIds: + type: array + items: + type: string + minItems: 1 +required: +- aspId +- pdtqPolicy + +PdtqDataPatch: + description: Contains the modified planned data transfer data with QoS requirements. + type: object + properties: + pdtqPolicy: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqPolicy' + + warnNotifEnabled: + type: boolean + description: > + Indicates whether the PDTQ warning notification is enabled (true) or not (false). +notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + +GroupPolicyData: + description: Contains the group specific policy control subscription information. + type: object + properties: + remainGroupMbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainGroupMbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +GroupPolicyDataPatch: + description: > + Contains the requested modification to the group specific policy control subscription + data. + type: object + properties: + remainGroupMbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainGroupMbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + anyOf: + - required: [remainGroupMbrUl] + - required: [remainGroupMbrDl] + +# SIMPLE TYPES: + +IpIndex: + description: > + Represents information that identifies which IP pool or external server + is used to allocate the IP address. + +``` + +type: integer + +OsId: + +description: Represents the Operating System of the served UE. + +type: string + +format: uuid + +ItemPath: + +description: Identifies a fragment (subset of resource data) of a given resource. + +type: string + +BdtReferenceIdRm: + +type: string + +description: > + +This data type is defined in the same way as the BdtReferenceId data type defined in 3GPP TS 29.122, but with the nullable property set to true. + +nullable: true + +# ENUMS: + +UsageMonLevel: + +description: Represents the usage monitoring level. + +anyOf: + +- type: string + +enum: + +- SESSION\_LEVEL + +- SERVICE\_LEVEL + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +Periodicity: + +description: Represents the time period. + +anyOf: + +- type: string + +enum: + +- YEARLY + +- MONTHLY + +- WEEKLY + +- DAILY + +- HOURLY + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +BdtPolicyStatus: + +description: Indicates the validation status of a negotiated BDT policy. + +anyOf: + +- type: string + +enum: + +- INVALID + +- VALID + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +PolicyDataSubset: + +description: Indicates a policy data subset. + +anyOf: + +- type: string + +enum: + +- AM\_POLICY\_DATA + +- SM\_POLICY\_DATA + +- UE\_POLICY\_DATA + +- UM\_DATA + +- OPERATOR\_SPECIFIC\_DATA + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +## A.3 Nudr\_DataRepository API for Application Data + +For the purpose of referencing entities in the Open API file defined in this Annex, it shall be assumed that this Open API file is contained in a physical file named "TS29519\_Application\_Data.yaml". + +``` + +openapi: 3.0.0 + +info: + version: '-' + title: Unified Data Repository Service API file for Application Data + description: | + The API version is defined in 3GPP TS 29.504 + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.519 V18.4.0; 5G System; Usage of the Unified Data Repository Service for Policy Data, + Application Data and Structured Data for Exposure. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.519/' + +paths: + /application-data/pfds: + get: + summary: Retrieve PFDs for application identifier(s) + operationId: ReadPFDData + tags: + - PFD Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:pfds:read + parameters: + - name: appId + in: query + description: > + Contains the information of the application identifier(s) for the querying PFD + Data resource. If none appId is included in the URI, it applies to all application + identifier(s) for the querying PFD Data resource. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: A representation of PFDs for request applications is returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PfdDataForAppExt' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/pfds/{appId}: + get: + summary: Retrieve the corresponding PFDs of the specified application identifier + operationId: ReadIndividualPFDData + tags: + - Individual PFD Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:pfds:read + parameters: + - name: appId + in: path + description: > + Indicate the application identifier for the request pfd(s). It shall apply the + format of Data type ApplicationId. + required: true + schema: + type: string + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + A representation of PFDs for the request application identified by the application + identifier is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdDataForAppExt' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + delete: + summary: Delete the corresponding PFDs of the specified application identifier + operationId: DeleteIndividualPFDData + +``` + +``` + +tags: + - Individual PFD Data (Document) +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:pfds:modify +parameters: + - name: appId + in: path + description: > + Indicate the application identifier for the request pfd(s). It shall apply the + format of Data type ApplicationId. + required: true + schema: + type: string +responses: + '204': + description: > + Successful case. The Individual PFD Data resource related to the application + identifier was deleted. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Create or update the corresponding PFDs for the specified application identifier + operationId: CreateOrReplaceIndividualPFDData + tags: + - Individual PFD Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:pfds:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PfdDataForAppExt' + parameters: + - name: appId + in: path + description: > + Indicate the application identifier for the request pfd(s). It shall apply the format + of Data type ApplicationId. + required: true + schema: + type: string + responses: + '201': + +``` + +``` + +description: > + The creation of an Individual PFD Data resource related to the application-identifier + is confirmed and a representation of that resource is returned. +content: + application/json: + schema: + $ref: '#/components/schemas/PfdDataForAppExt' +headers: + Location: + description: > + 'Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/pfds/{appId}' + required: true + schema: + type: string +'200': + description: > + Successful case. The upgrade of an Individual PFD Data resource related to the + application identifier is confirmed and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdDataForAppExt' +'204': + description: No content +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/influenceData: + get: + summary: Retrieve Traffic Influence Data + operationId: ReadInfluenceData + tags: + - Influence Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:read + parameters: + - name: influence-Ids + in: query + description: Each element identifies a service. + required: false + schema: + type: array + items: + type: string + +``` + +``` + minItems: 1 +- name: dnns + in: query + description: Each element identifies a DNN. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 +- name: snssais + in: query + description: Each element identifies a slice. + required: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 +- name: internal-Group-Ids + in: query + description: Each element identifies a group of users. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 +- name: internal-group-ids-Add + in: query + description: Each element identifies an internal Group. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 +- name: subscriber-categories + in: query + description: > + Each element identifies a subscriber category. + required: false + schema: + type: array + items: + type: string + minItems: 1 +- name: supis + in: query + description: Each element identifies the user. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 +- name: supp-feat + in: query + required: false + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: The Traffic Influence Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrafficInfluData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/influenceData/{influenceId}: + put: + summary: Create or update an individual Influence Data resource + operationId: CreateOrReplaceIndividualInfluenceData + tags: + - Individual Influence Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluData' + parameters: + - name: influenceId + in: path + description: > + The Identifier of an Individual Influence Data to be created or updated. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual Traffic Influence Data resource is confirmed + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluData' + headers: + Location: + description: > + 'Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/influenceData/{influenceId}' + required: true + schema: + type: string + '200': + description: > + The update of an Individual Traffic Influence Data resource is confirmed and a + response body containing Traffic Influence Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluData' + '204': + description: No content + '400': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Modify part of the properties of an individual Influence Data resource + operationId: UpdateIndividualInfluenceData + tags: + - Individual Influence Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/TrafficInfluDataPatch' + parameters: + - name: influenceId + in: path + description: > + The Identifier of an Individual Influence Data to be updated. It shall apply + the format of Data type string. + required: true + schema: + type: string + responses: + '200': + description: > + The update of an Individual Traffic Influence Data resource is confirmed and + a response body containing Traffic Influence Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluData' + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an individual Influence Data resource + operationId: DeleteIndividualInfluenceData + tags: + - Individual Influence Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:modify + parameters: + - name: influenceId + in: path + description: > + The Identifier of an Individual Influence Data to be deleted. It shall apply + the format of Data type string. + required: true + schema: + type: string + responses: + '204': + description: The Individual Influence Data was deleted successfully. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/influenceData/subs-to-notify: + post: + summary: Create a new Individual Influence Data Subscription resource + operationId: CreateIndividualInfluenceDataSubscription + tags: + - Influence Data Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:subscriptions:create + requestBody: + +``` + +``` + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluSub' +responses: + '201': + description: The subscription was created successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluSub' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + trafficInfluenceDataChangeNotification: + '{ $request.body#/notificationUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + oneOf: + - $ref: '#/components/schemas/TrafficInfluData' + - $ref: '#/components/schemas/TrafficInfluDataNotif' + minItems: 1 +responses: + '204': + description: No Content, Notification was successful + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +``` + +``` + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +get: + summary: Read Influence Data Subscriptions + operationId: ReadInfluenceDataSubscriptions + tags: + - Influence Data Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:subscriptions:read + parameters: + - name: dnn + in: query + description: Identifies a DNN. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: snssai + in: query + description: Identifies a slice. + required: false + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + - name: internal-Group-Id + in: query + description: Identifies a group of users. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + - name: supi + in: query + description: Identifies a user. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: internal-group-ids + in: query + description: > + Each element identifies an internal group. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + - name: subscriber-categories + in: query + description: > + Each element identifies a subscriber category. + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: roam-ue-plmn-ids + in: query + description: > + Each element identifies a PLMN. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + responses: +``` + +``` + +'200': + description: > + The subscription information as request in the request URI query parameter(s) + are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrafficInfluSub' + minItems: 0 +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/influenceData/subs-to-notify/{subscriptionId}: + get: + summary: Get an existing individual Influence Data Subscription resource + operationId: ReadIndividualInfluenceDataSubscription + tags: + - Individual Influence Data Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:subscriptions:read + parameters: + - name: subscriptionId + in: path + description: > + String identifying a subscription to the Individual Influence Data Subscription + required: true + schema: + type: string + responses: + '200': + description: The subscription information is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluSub' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + +``` + +``` + + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Modify an existing individual Influence Data Subscription resource + operationId: ReplaceIndividualInfluenceDataSubscription + tags: + - Individual Influence Data Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:subscriptions:modify + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluSub' + parameters: + - name: subscriptionId + in: path + description: > + String identifying a subscription to the Individual Influence Data Subscription. + required: true + schema: + type: string + responses: + '200': + description: The subscription was updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluSub' + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an individual Influence Data Subscription resource + operationId: DeleteIndividualInfluenceDataSubscription + tags: + - Individual Influence Data Subscription (Document) + +``` + +``` + +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:application-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:application-data +- nudr-dr:application-data:influence-data:subscriptions:modify +parameters: +- name: subscriptionId + in: path + description: > + String identifying a subscription to the Individual Influence Data Subscription. + required: true + schema: + type: string +responses: +'204': + description: The subscription was terminated successfully. +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/bdtPolicyData: +get: + summary: Retrieve applied BDT Policy Data + operationId: ReadBdtPolicyData + tags: + - BdtPolicy Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:bdtpolicy-data:read + parameters: + - name: bdt-policy-ids + in: query + description: Each element identifies a service. + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: internal-group-ids + in: query + description: Each element identifies a group of users. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + - name: supis + +``` + +``` + +in: query +description: Each element identifies the user. +required: false +schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 +responses: + '200': + description: The applied BDT policy Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BdtPolicyData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/bdtPolicyData/{bdtPolicyId}: + put: + summary: Create an individual applied BDT Policy Data resource + operationId: CreateIndividualAppliedBdtPolicyData + tags: + - Individual Applied BDT Policy Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:bdt-policy-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolicyData' + parameters: + - name: bdtPolicyId + in: path + description: > + The Identifier of an Individual Applied BDT Policy Data to be created or updated. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual Applied BDT Policy Data resource is confirmed and a + representation of that resource is returned. + content: + +``` + +``` + + application/json: + schema: + $ref: '#/components/schemas/BdtPolicyData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/bdtPolicyData/{bdtPolicyId} + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Modify part of the properties of an individual Applied BDT Policy Data resource + operationId: UpdateIndividualAppliedBdtPolicyData + tags: + - Individual Applied BDT Policy Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:bdt-policy-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/BdtPolicyDataPatch' + parameters: + - name: bdtPolicyId + in: path + description: > + The Identifier of an Individual Applied BDT Policy Data to be updated. It shall + apply the format of Data type string. + required: true + schema: + type: string + responses: + '200': + description: > + The update of an Individual Applied BDT Policy Data resource is confirmed and + a response body containing Applied BDT Policy Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolicyData' + '204': + +``` + +``` + + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an individual Applied BDT Policy Data resource + operationId: DeleteIndividualAppliedBdtPolicyData + tags: + - Individual Applied BDT Policy Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:bdtpolicy-data:modify + parameters: + - name: bdtPolicyId + in: path + description: > + The Identifier of an Individual Applied BDT Policy Data to be deleted. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '204': + description: The Individual Applied BDT Policy Data was deleted successfully. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/iptvConfigData: + get: + summary: Retrieve IPTV configuration Data + operationId: ReadIPTVConfigurationData + tags: + - IPTV Configuration Data (Store) + +``` + +``` +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:application-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:application-data +- nudr-dr:application-data:iptv-config-data:read +parameters: +- name: config-ids + in: query + description: Each element identifies a configuration. + required: false + schema: + type: array + items: + type: string + minItems: 1 +- name: dnns + in: query + description: Each element identifies a DNN. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 +- name: snssais + in: query + description: Each element identifies a slice. + required: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 +- name: supis + in: query + description: Each element identifies the user. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 +- name: inter-group-ids + in: query + description: Each element identifies a group of users. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 +responses: +'200': + description: The IPTV configuration data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IptvConfigData' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +``` + +``` + +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/iptvConfigData/{configurationId}: + put: + summary: Create or update an individual IPTV configuration resource + operationId: CreateOrReplaceIndividualIPTVConfigurationData + tags: + - Individual IPTV Configuration Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:iptv-config-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/IptvConfigData' + parameters: + - name: configurationId + in: path + description: > + The Identifier of an Individual IPTV Configuration Data to be created or updated. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual IPTV Configuration Data resource is confirmed and a + representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/IptvConfigData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '200': + description: The update of an Individual IPTV configuration resource. + content: + application/json: + schema: + $ref: '#/components/schemas/IptvConfigData' + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + +``` + +``` + + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Partial update an individual IPTV configuration resource + operationId: PartialReplaceIndividualIPTVConfigurationData + tags: + - Individual IPTV Configuration Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:iptv-config-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: 'TS29522_IPTVConfiguration.yaml#/components/schemas/IptvConfigDataPatch' + parameters: + - name: configurationId + in: path + description: > + The Identifier of an Individual IPTV Configuration Data to be updated. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '200': + description: The update of an Individual IPTV configuration resource. + content: + application/json: + schema: + $ref: '#/components/schemas/IptvConfigData' + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + +``` + +``` + + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an individual IPTV configuration resource + operationId: DeleteIndividualIPTVConfigurationData + tags: + - Individual IPTV Configuration Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:iptv-config-data:modify + parameters: + - name: configurationId + in: path + description: > + The Identifier of an Individual IPTV Configuration to be deleted. It shall + apply the format of Data type string. + required: true + schema: + type: string + responses: + '204': + description: The resource was deleted successfully. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/serviceParamData: + get: + summary: Retrieve Service Parameter Data + operationId: ReadServiceParameterData + tags: + - Service Parameter Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:service-param-data:read + parameters: + - name: service-param-ids + in: query + description: Each element identifies a service. + required: false + schema: + type: array + items: + type: string + minItems: 1 + +``` + +- name: dnns +in: query +description: Each element identifies a DNN. +required: false +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Dnn' +minItems: 1 +- name: snssais +in: query +description: Each element identifies a slice. +required: false +content: +application/json: +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Snssai' +minItems: 1 +- name: internal-group-ids +in: query +description: Each element identifies a group of users. +required: false +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/GroupId' +minItems: 1 +- name: supis +in: query +description: Each element identifies the user. +required: false +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Supi' +minItems: 1 +- name: ue-ipv4s +in: query +description: Each element identifies the user. +required: false +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv4Addr' +minItems: 1 +- name: ue-ipv6s +in: query +description: Each element identifies the user. +required: false +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv6Addr' +minItems: 1 +- name: ue-macs +in: query +description: Each element identifies the user. +required: false +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/MacAddr48' +minItems: 1 +- name: any-ue +in: query +description: Indicates whether the request is for any UE. +required: false +schema: +type: boolean +- name: roam-ue-net-descs +in: query +description: > +Each element identifies one or more PLMNs for a roaming UE. +required: false +schema: +type: array + +``` + + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/NetworkDescription' + minItems: 1 + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: The Service Parameter Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceParameterData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/serviceParamData/{serviceParamId}: + put: + summary: Create or update an individual Service Parameter Data resource + operationId: CreateOrReplaceServiceParameterData + tags: + - Individual Service Parameter Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:service-param-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceParameterData' + parameters: + - name: serviceParamId + in: path + description: > + The Identifier of an Individual Service Parameter Data to be created or updated. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual Service Parameter Data resource is confirmed + and a representation of that resource is returned. + +``` + +``` + +content: + application/json: + schema: + $ref: '#/components/schemas/ServiceParameterData' +headers: + Location: + description: > + 'Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/serviceParamData/{serviceParamId}' + required: true + schema: + type: string +'200': + description: > + The update of an Individual Service Parameter Data resource is confirmed and + a response body containing Service Parameter Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceParameterData' +'204': + description: No content +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Modify part of the properties of an individual Service Parameter Data resource + operationId: UpdateIndividualServiceParameterData + tags: + - Individual Service Parameter Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:service-parameter-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/ServiceParameterDataPatch' + parameters: + - name: serviceParamId + in: path + description: > + The Identifier of an Individual Service Parameter Data to be updated. + It shall apply the format of Data type string. + required: true + schema: + +``` + +``` + + type: string +responses: + '200': + description: > + The update of an Individual Service Parameter Data resource is confirmed + and a response body containing Service Parameter Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceParameterData' + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an individual Service Parameter Data resource + operationId: DeleteIndividualServiceParameterData + tags: + - Individual Service Parameter Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:service-parameter-data:modify + parameters: + - name: serviceParamId + in: path + description: > + The Identifier of an Individual Service Parameter Data to be deleted. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '204': + description: The Individual Service Parameter Data was deleted successfully. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + +``` + +``` +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/am-influence-data: + get: + summary: Retrieve AM Influence Data + operationId: ReadAmInfluenceData + tags: + - AM Influence Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:am-influence-data:read + parameters: + - name: am-influence-ids + in: query + description: Each element identifies a service. + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: dnns + in: query + description: Each element identifies a DNN. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + - name: snssais + in: query + description: Each element identifies a slice. + required: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + - name: dnn-snssai-infos + in: query + description: Each element identifies a combination of (DNN, S-NSSAI). + required: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29522_AMInfluence.yaml#/components/schemas/DnnSnssaiInformation' + minItems: 1 + - name: internal-group-ids + in: query + description: Each element identifies a group of users. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + - name: supis + in: query + description: Each element identifies the user. + required: false + schema: + type: array +``` + +``` + + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + - name: any-ue + in: query + description: Indicates whether the request is for any UE. + required: false + schema: + type: boolean + - name: supp-feat + in: query + required: false + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: The AM Influence Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AmInfluData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/am-influence-data/{amInfluenceId}: + put: + summary: Create or update an individual AM Influence Data resource + operationId: CreateOrReplaceIndividualAmInfluenceData + tags: + - Individual AM Influence Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:am-influence-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AmInfluData' + parameters: + - name: amInfluenceId + in: path + description: > + The Identifier of an Individual AM Influence Data to be created or updated. + It shall apply the format of Data type string. + required: true + schema: + +``` + +``` + + type: string +responses: + '201': + description: > + The creation of an Individual AM Influence Data resource is confirmed and + a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AmInfluData' + headers: + Location: + description: > + 'Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/am-influence-data/{amInfluenceId}' + required: true + schema: + type: string + '200': + description: > + The update of an Individual AM Influence Data resource is confirmed and a response + body containing AM Influence Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AmInfluData' + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Modify part of the properties of an individual AM Influence Data resource + operationId: UpdateIndividualAmInfluenceData + tags: + - Individual AM Influence Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:am-influence-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AmInfluDataPatch' + parameters: + - name: amInfluenceId + +``` + +``` + +in: path +description: > + The Identifier of an Individual AM Influence Data to be updated. It shall + apply the format of Data type string. +required: true +schema: + type: string +responses: + '200': + description: > + The update of an Individual AM Influence Data resource is confirmed and a + response body containing AM Influence Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AmInfluData' + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an individual AM Influence Data resource + operationId: DeleteIndividualAmInfluenceData + tags: + - Individual AM Influence Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:am-influence-data:modify + parameters: + - name: amInfluenceId + in: path + description: > + The Identifier of an Individual AM Influence Data to be deleted. It shall + apply the format of Data type string. + required: true + schema: + type: string + responses: + '204': + description: The Individual AM Influence Data was deleted successfully. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + +``` + +``` + + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/subs-to-notify: + post: + summary: Create a subscription to receive notification of application data changes + operationId: CreateIndividualApplicationDataSubscription + tags: + - ApplicationDataSubscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:subs-to-notify:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationDataSubs' + responses: + '201': + description: > + Upon success, a response body containing a representation of each + Individual subscription resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationDataSubs' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + applicationDataChangeNotif: + '{ $request.body#/notificationUri }': + post: + requestBody: + +``` + +``` + + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ApplicationDataChangeNotif' + minItems: 1 + responses: + '204': + description: No Content, Notification was successful + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +get: + summary: Read Application Data change Subscriptions + operationId: ReadApplicationDataChangeSubscriptions + tags: + - ApplicationDataSubscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:subs-to-notify:read + parameters: + - name: data-filter + in: query + description: The data filter for the query. + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/DataFilter' + responses: + '200': + description: > + The subscription information as request in the request URI query parameter(s) + are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ApplicationDataSubs' + minItems: 0 + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + +``` + +``` + + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/af-qos-data-sets: + get: + summary: Retrieve AF Requested QoS Data + operationId: ReadAFReqQoSData + tags: + - AF Requested QoS Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:af-qos-data-sets:read + parameters: + - name: dnns + in: query + description: Each element identifies a DNN + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + - name: snssais + in: query + description: Each element identifies a slice. + required: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + - name: internal-group-ids + in: query + description: Each element identifies a group of users. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + - name: supis + in: query + description: Each element identifies the user. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + - name: data-set-ids + in: query + description: Each element identifies an Individual AF requested QoS resource. + required: false + schema: + +``` + +``` + + type: array + items: + type: string + minItems: 1 +- name: supp-feat + in: query + required: false + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: The AF requested QoS Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AfRequestedQosData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/af-qos-data-sets/{afReqQosId}: + put: + summary: Create or update an Individual AF Requested QoS Data resource. + operationId: CreateIndividualAFReqQoSData + tags: + - Individual AF Requested QoS Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:af-qos-data-sets:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AfRequestedQosData' + parameters: + - name: afReqQosId + in: path + description: > + The Identifier of an Individual AF Requested QoS Data to be created or updated. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual AF Requested QoS Data resource is confirmed and a + representation of that resource is returned. + +``` + +``` + +content: + application/json: + schema: + $ref: '#/components/schemas/AfRequestedQoSData' +headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/af-qos-data-sets/{afReqQoSId} + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Modify part of the properties of an individual AF requested QoS Data resource + operationId: UpdateIndividualAFRequestedQoSData + tags: + - Individual AF requested QoS Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:af-qos-data-sets:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AfRequestedQoSDataPatch' + parameters: + - name: afReqQoSId + in: path + description: > + The Identifier of an Individual AF Requested QoS Data to be updated. + required: true + schema: + type: string + responses: + '200': + description: > + The update of an Individual AF Requested QoS Data resource is confirmed and + a response body containing AF Requested QoS Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AfRequestedQoSData' + '204': + +``` + +``` + + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an individual AF requested QoS Data resource + operationId: DeleteIndividualAFRequestedQosData + tags: + - Individual AF requested QoS Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:af-qos-data-sets:modify + parameters: + - name: afReqQosId + in: path + description: > + The Identifier of an Individual AF Requested QoS Data to be deleted. + required: true + schema: + type: string + responses: + '204': + description: The Individual AF requested QoS Data was deleted successfully. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/subs-to-notify/{subsId}: + parameters: + - name: subsId + in: path + required: true + schema: + type: string + +``` + +``` + +put: + summary: Modify a subscription to receive notification of application data changes + operationId: ReplaceIndividualApplicationDataSubscription + tags: + - IndividualApplicationDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:subs-to-notify:modify + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationDataSubs' + responses: + '200': + description: The individual subscription resource was updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationDataSubs' + '204': + description: > + The individual subscription resource was updated successfully and no + additional content is to be sent in the response message. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete the individual Application Data subscription + operationId: DeleteIndividualApplicationDataSubscription + tags: + - IndividualApplicationDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:subs-to-notify:modify + responses: + '204': + description: Upon success, an empty response body shall be returned. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + +``` + +``` + + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +get: + summary: Get an existing individual Application Data Subscription resource + operationId: ReadIndividualApplicationDataSubscription + tags: + - IndividualApplicationDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:subs-to-notify:read + parameters: + - name: subsId + in: path + description: > + String identifying a subscription to the Individual Application Data Subscription + required: true + schema: + type: string + responses: + '200': + description: The subscription information is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationDataSubs' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/eas-deploy-data: + get: + summary: Retrieve EAS Deployment Information Data + operationId: ReadEasDeployData + tags: + - EAS Deployment Data (Store) + security: + - {} + +``` + +``` +- oAuth2ClientCredentials: + - nudr-dr +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:eas-deploy-data:read +parameters: +- name: dnn + in: query + description: Identifies a DNN. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +- name: snssai + in: query + description: Identifies an S-NSSAI. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' +- name: internal-group-id + in: query + description: Identifies a group of users. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' +- name: appId + in: query + description: Identifies an application. + required: false + schema: + type: string +responses: +'200': + description: The EAS Deployment Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + minItems: 1 +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/application-data/eas-deploy-data/{easDeployInfoId}: +get: + summary: Retrieve an individual EAS Deployment Data resource + operationId: ReadIndividualEasDeployData + tags: + - Individual EAS Deployment Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr +``` + +``` + + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:eas-deploy-data:read +parameters: + - name: easDeployInfoId + description: > + String identifying an Individual EAS Deployment Information Data resource. + in: path + required: true + schema: + type: string +responses: + '200': + description: > + The EAS Deployment Data stored in the UDR for an Individual EAS Deployment + Information Data resource is returned. + content: + application/json: + schema: + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Create or update an individual EAS Deployment Data resource + operationId: CreateOrReplaceIndividualEasDeployData + tags: + - Individual EAS Deployment Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:eas-deploy-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + parameters: + - name: easDeployInfoId + in: path + description: > + The Identifier of an Individual EAS Deployment Data to be created or updated. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual EAS Deployment Data resource is confirmed and a + representation of that resource is returned. + +``` + +``` + +content: + application/json: + schema: + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' +headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/eas-deploy-data/{easDeployInfoId} + required: true + schema: + type: string +'200': + description: > + The update of an Individual EAS Deployment Data resource is confirmed and a response + body containing EAS Deployment Data shall be returned. + content: + application/json: + schema: + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' +'204': + description: No content +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an individual EAS Deployment Data resource + operationId: DeleteIndividualEasDeployData + tags: + - Individual EasDeployment Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:eas-deploy-data:modify +parameters: + - name: easDeployInfoId + in: path + description: > + The Identifier of an Individual EAS Deployment Data to be deleted. + It shall apply the format of Data type string. + required: true + schema: + type: string +responses: +'204': + description: The Individual EAS Deployment Data was deleted successfully. +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + +``` + +``` + + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/dnai-eas-mappings/{dnai}: + parameters: + - name: dnai + in: path + required: true + schema: + type: string + get: + summary: Retrieves the EAS address information for a DNAI. + operationId: ReadDnaiEasMapping + tags: + - DnaiEasMapping (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:dnai-eas:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + Upon success, a response body containing EAS address information for a DNAI + is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/DnaiEasMapping' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/ecs-address-roaming: + +``` + +``` + +get: + summary: Retrieve ECS Address Roaming Data + operationId: ReadEcsRoamingData + tags: + - ECS Address Roaming Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:ecs-address-roaming:read + parameters: + - name: internal-group-id + in: query + description: Identifies a group of users. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + - name: any-ue + in: query + description: > + Indicates that any UE is targetted if included and set to true, otherwise set to false. + Default value is false if omitted. + required: false + schema: + type: boolean + responses: + '200': + description: The ECS Address Roaming Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EcsAddrData' + minItems: 1 + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/ecs-address-roaming/{ecsAddrInfoId}: +get: + summary: Retrieve an individual ECS Address Roaming Data resource + operationId: ReadIndividualEcsAddr + tags: + - Individual ECS Address Roaming Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + +``` + +``` + + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:ecs-address-roaming:read +parameters: + - name: ecsAddrInfoId + description: > + String identifying an Individual ECS Address Roaming Data resource. + in: path + required: true + schema: + type: string +responses: + '200': + description: > + The ECS Address Roaming Data stored in the UDR for an Individual ECS Address Roaming + Data resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Create or update an individual ECS Address Roaming Data resource + operationId: CreateOrReplaceIndividualEcsAddressData + tags: + - Individual ECS Address Roaming Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:ecs-address-roaming:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrData' + parameters: + - name: ecsAddrInfoId + in: path + description: > + The Identifier of an Individual ECS Address Roaming Data to be created or updated. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual EECS Address Roaming Data resource is confirmed + and a representation of that resource is returned. + content: + application/json: + schema: + +``` + +``` + + $ref: '#/components/schemas/EcsAddrData' +headers: + Location: + description: > + Contains the URI of the newly created resource. + required: true + schema: + type: string +'200': + description: > + The update of an Individual ECS Address Roaming Data resource is confirmed + and a response body containing ECS Address Roaming Data is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrData' +'204': + description: No content +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an individual ECS Address Roaming Data resource + operationId: DeleteIndividualEcsAddrData + tags: + - Individual ECS Address Roaming Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:ecs-address-roaming:modify + parameters: + - name: ecsAddrInfoId + in: path + description: > + The Identifier of an Individual ECS Address Roaming Data to be updated. + required: true + schema: + type: string + responses: + '204': + description: The Individual ECS Address Roaming Data was deleted successfully. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': +$ref: 'TS29571_CommonData.yaml#/components/responses/500' +'503': +$ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: +$ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +## components: + +## schemas: + +``` +TrafficInfluData: +description: Represents the Traffic Influence Data. +type: object +properties: + upPathChgNotifCorreId: + type: string + description: > + Contains the Notification Correlation Id allocated by the NEF for the UP + path change notification. + appReloInd: + type: boolean + description: > + Identifies whether an application can be relocated once a location of the + application has been selected. + afAppId: + type: string + description: Identifies an application. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + ethTrafficFilters: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + description: > + Identifies Ethernet packet filters. Either "trafficFilters" or + "ethTrafficFilters" shall be included if applicable. + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + interGroupIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 2 + description: > + Identifies a list of Internal Groups. + subscriberCatList: + type: array + items: + type: string + minItems: 1 + description: > + Identifies a list of Subscriber Category(s). + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + trafficFilters: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + description: > + Identifies IP packet filters. Either "trafficFilters" or "ethTrafficFilters" + shall be included if applicable. + trafficRoutes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + minItems: 1 + description: Identifies the N6 traffic routing requirement. + sfcIdDl: + type: string + description: Reference to a pre-configured service function chain for DL traffic + sfcIdUl: + type: string +``` + +``` + + description: Reference to a pre-configured service function chain for UL traffic + metadata: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Metadata' + traffCorreInd: + type: boolean + tfcCorreInfo: + $ref: '#/components/schemas/TrafficCorrelationInfo' + validStartTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + validEndTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tempValidities: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + minItems: 1 + description: Identifies the temporal validities for the N6 traffic routing requirement. + nwAreaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + upPathChgNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + headers: + description: Contains the headers provisioned by the NEF. + type: array + items: + type: string + minItems: 1 + subscribedEvents: + type: array + items: + $ref: 'TS29522_TrafficInfluence.yaml#/components/schemas/SubscribedEvent' + minItems: 1 + dnaiChgType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType' + afAckInd: + type: boolean + addrPreserInd: + type: boolean + maxAllowedUpLat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + simConnInd: + type: boolean + description: > + Indicates whether simultaneous connectivity should be temporarily + maintained for the source and target PSA. + simConnTerm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + resetIds: + type: array + items: + type: string + minItems: 1 + nscSuppFeats: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + minProperties: 1 + description: > + Identifies a list of Network Function Service Consumer supported per service. The key + used in this map for each entry is the ServiceName value as defined in + 3GPP TS 29.510[24]. + allOf: + - oneOf: + - required: [afAppId] + - required: [trafficFilters] + - required: [ethTrafficFilters] + - oneOf: + - required: [supi] + - required: [interGroupId] + - required: [interGroupIdList] + +TrafficInfluDataPatch: + description: Represents the Traffic Influence Data to be updated in the UDR. + type: object + +``` + +``` +properties: + upPathChgNotifCorreId: + type: string + description: > + Contains the Notification Correlation Id allocated by the NEF for the + UP path change notification. + appReloInd: + type: boolean + description: > + Identifies whether an application can be relocated once a location of the application + has been selected. + ethTrafficFilters: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + description: > + Identifies Ethernet packet filters. Either "trafficFilters" or "ethTrafficFilters" + shall be included if applicable. + trafficFilters: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + description: > + Identifies IP packet filters. Either "trafficFilters" or "ethTrafficFilters" + shall be included if applicable. + trafficRoutes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + minItems: 1 + description: Identifies the N6 traffic routing requirement. + sfcIdDL: + type: string + description: Reference to a pre-configured service function chain for DL traffic + nullable: true + sfcIdUL: + type: string + description: Reference to a pre-configured service function chain for UL traffic + nullable: true + metadata: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Metadata' + traffCorreInd: + type: boolean + tfcCorreInfo: + $ref: '#/components/schemas/TrafficCorrelationInfo' + validStartTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + validEndTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tempValidities: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + minItems: 1 + nullable: true + description: Identifies the temporal validities for the N6 traffic routing requirement. + nwAreaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + upPathChgNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + headers: + description: Contains the headers provisioned by the NEF. + type: array + items: + type: string + minItems: 1 + afAckInd: + type: boolean + addrPreserInd: + type: boolean + maxAllowedUpLat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UIntegerRm' + simConnInd: + type: boolean + description: > + Indicates whether simultaneous connectivity should be temporarily maintained +``` + +``` + for the source and target PSA. + simConnTerm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + +TrafficInfluSub: + description: Represents traffic influence subscription data. + type: object + properties: + dnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + description: Each element identifies a DNN. + snssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + description: Each element identifies a slice. + internalGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + description: Each element identifies a group of users. + internalGroupIdsAdd: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + description: > + Each element identifies an internal group. + subscriberCatList: + type: array + items: + type: string + minItems: 1 + description: > + Each element identifies a subscriber category. + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + description: Each element identifies the user. + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + immRep: + type: boolean + description: > + If provided and set to true, it indicates that existing entries that + match this subscription shall be immediately reported in the response. + immReports: + type: array + items: + $ref: '#/components/schemas/TrafficInfluDataNotif' + minItems: 1 + description: Immediate report with existing UDR entries. + required: + - notificationUri + oneOf: + - required: [dnns] + - required: [snssais] + - required: [internalGroupIds] + - required: [internalGroupIdsAdd] + - required: [supis] + +TrafficInfluDataNotif: +``` + +``` +description: Represents traffic influence data for notification. +type: object +properties: + resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + trafficInfluData: + $ref: '#/components/schemas/TrafficInfluData' +required: +- resUri + +PfdDataForAppExt: +description: Represents the PFDs and related data for the application. +type: object +properties: + applicationId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + pfd: + type: array + items: + $ref: 'TS29551_Nnef_PFDmanagement.yaml#/components/schemas/PfdContent' + minItems: 1 + cachingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + allowedDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +required: +- applicationId +- pfd + +BdtPolicyData: +description: Represents applied BDT policy data. +type: object +properties: + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + resetIds: + type: array + items: + type: string + minItems: 1 +required: +- bdtRefId + +BdtPolicyDataPatch: +description: > + Represents modification instructions to be performed on the applied BDT policy data. +type: object +properties: + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' +required: +- bdtRefId + +IptvConfigData: +description: Represents IPTV configuration data information. +type: object +properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + interGroupId: + description: Identifies a group of users. +``` + +``` + +dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +afAppId: + type: string +multiAccCtrls: + type: object + additionalProperties: + $ref: 'TS29522_IPTVConfiguration.yaml#/components/schemas/MulticastAccessControl' + minProperties: 1 + description: > + Identifies a list of multicast address access control information. Any string + value can be used as a key of the map. +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +resetIds: + type: array + items: + type: string + minItems: 1 +required: +- afAppId +- multiAccCtrls +oneOf: +- required: [interGroupId] +- required: [supi] + +ServiceParameterData: + description: Represents the service parameter data. + type: object + properties: + appId: + type: string + description: Identifies an application. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + ueIpv4: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' + ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + anyUeInd: + type: boolean + description: > + Identifies whether the service parameters applies to any non roaming UE. + roamUeNetDescs: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/NetworkDescription' + minItems: 1 + description: Each element identifies one or more PLMN IDs of inbound roamers. + paramOverPc5: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParameterOverPc5' + paramOverUu: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParameterOverUu' + a2xParamsPc5: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/A2xParamsPc5' + paramForProSeDd: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeDd' + paramForProSeDc: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeDc' + paramForProSeU2NRelUe: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeU2NRelUe' + paramForProSeRemUe: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeRemUe' + paramForProSeU2URelUe: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeU2URelUe' + paramForProSeEndUe: + +``` + +``` +$ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeEndUe' +urspGuidance: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/UrspRuleRequest' + minItems: 1 + description: > + Contains the service parameter used to guide the URSP and/or VPLMN specific URSP. +tnaps: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TnapId' + minItems: 1 + description: Contains the TNAP IDs collocated with the 5G-RG(s) of a specific user. +deliveryEvents: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/Event' + minItems: 1 + description: Contains the outcome of the UE Policy Delivery. +policDelivNotifCorreId: + type: string + description: > + Contains the Notification Correlation Id allocated by the NEF for the notification + of UE Policy delivery outcome. +policDelivNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +headers: + description: Contains the headers provisioned by the NEF. + type: array + items: + type: string + minItems: 1 +resetIds: + type: array + items: + type: string + minItems: 1 +paramForRangingSlPos: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForRangingSlPos' + +ServiceParameterDataPatch: + description: Represents the service parameter data that can be updated. + type: object + properties: + paramOverPc5: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParameterOverPc5Rm' + paramOverUu: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParameterOverUuRm' + a2xParamsPc5: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/A2xParamsPc5Rm' + paramForProSeDd: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeDdRm' + paramForProSeDc: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeDcRm' + paramForProSeU2NRelUe: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeU2NRelUeRm' + paramForProSeRemUe: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeRemUeRm' + paramForProSeU2URelUE: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeU2URelUeRm' + paramForProSeEndUe: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeEndUeRm' + urspInfluence: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/UrspRuleRequest' + minItems: 1 + deprecated: true + description: Contains the service parameter used to influence the URSP. This attribute is + deprecated by the urspGuidance attribute. + urspGuidance: + type: array + items: +``` + +``` +$ref: 'TS29522_ServiceParameter.yaml#/components/schemas/UrspRuleRequest' +minItems: 1 +nullable: true +description: > + Contains the service parameter used to influence the URSP and/or VPLMN specific URSP. +tnaps: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TnapId' + minItems: 1 + description: Contains the TNAP IDs collocated with the 5G-RG(s) of a specific user. + nullable: true +deliveryEvents: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/Event' + minItems: 1 + nullable: true + description: Contains the outcome of the UE Policy Delivery. +policDelivNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +headers: + description: Contains the headers provisioned by the NEF. + type: array + items: + type: string + minItems: 1 +paramForRangingSlPos: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForRangingSlPosRm' + +AmInfluData: + description: Represents the AM Influence Data. + type: object + properties: + appIds: + type: array + items: + type: string + minItems: 1 + description: Identifies one or more applications. + dnnSnssaiInfos: + type: array + items: + $ref: 'TS29522_AMInfluence.yaml#/components/schemas/DnnSnssaiInformation' + minItems: 1 + description: Identifies one or more DNN, S-NSSAI combinations. + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + anyUeInd: + type: boolean + description: > + When set to true, it indicates whether the data is applicable for any UE. Otherwise set + to "false". Default value is "false" if omitted. + roamUePlmnIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + description: > + Indicates a list of PLMNs representing the home PLMN for the inbound roaming + UEs in LBO roaming scenario. + policyDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + evSubs: + type: array + items: + $ref: 'TS29522_AMInfluence.yaml#/components/schemas/AmInfluEvent' + minItems: 1 + description: List of AM related events for which a subscription is required. + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + headers: + type: array +``` + +``` + description: Contains the headers provisioned by the NEF. + items: + type: string + minItems: 1 + thruReq: + type: boolean + description: > + When set to true, it indicates whether high throughput is desired for the + indicated UE traffic. Otherwise set to "false". Default value is "false" if omitted. + covReq: + type: array + items: + $ref: + 'TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/ServiceAreaCoverageInfo' + minItems: 1 + description: Indicates the service area coverage requirement. + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + resetIds: + type: array + items: + type: string + minItems: 1 + allOf: + - anyOf: + - required: [thruReq] + - required: [covReq] + - oneOf: + - required: [supi] + - required: [interGroupId] + - required: [anyUeInd] + - required: [roamUePlmnIds] + +AmInfluDataPatch: + description: Represents the AM Influence Data that can be updated. + type: object + properties: + appIds: + type: array + items: + type: string + minItems: 1 + description: Identifies one or more applications. + nullable: true + dnnSnssaiInfos: + type: array + items: + $ref: 'TS29522_AMInfluence.yaml#/components/schemas/DnnSnssaiInformation' + minItems: 1 + description: Identifies one or more DNN, S-NSSAI combinations. + nullable: true + evSubs: + type: array + items: + $ref: 'TS29522_AMInfluence.yaml#/components/schemas/AmInfluEvent' + minItems: 1 + description: List of AM related events for which a subscription is required. + nullable: true + headers: + type: array + description: Contains the headers provisioned by the NEF. + items: + type: string + minItems: 1 + thruReq: + type: boolean + description: Indicates whether high throughput is desired for the indicated UE traffic. + nullable: true + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UriRm' + notifCorrId: + type: string + description: Notification correlation identifier. + nullable: true + covReq: + type: array +``` + +``` + items: + $ref: + 'TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/ServiceAreaCoverageInfo' + minItems: 1 + description: Indicates the service area coverage requirement. + nullable: true + +ApplicationDataSubs: + description: Identifies a subscription to application data change notification. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + dataFilters: + type: array + items: + $ref: '#/components/schemas/DataFilter' + minItems: 1 + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + immRep: + type: boolean + description: Immediate reporting indication. + amInfluEntries: + type: array + items: + $ref: '#/components/schemas/AmInfluData' + minItems: 1 + description: The AM Influence Data entries stored in the UDR that match a subscription. + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + immReports: + type: array + items: + $ref: '#/components/schemas/ApplicationDataChangeNotif' + minItems: 1 + description: Immediate report with existing UDR entries. + required: + - notificationUri + +ApplicationDataChangeNotif: + description: Contains changed application data for which notification was requested. + type: object + properties: + iptvConfigData: + $ref: '#/components/schemas/IptvConfigData' + pfdData: + $ref: 'TS29551_Nnef_PFDmanagement.yaml#/components/schemas/PfdChangeNotification' + bdtPolicyData: + $ref: '#/components/schemas/BdtPolicyData' + resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + serParamData: + $ref: '#/components/schemas/ServiceParameterData' + amInfluData: + $ref: '#/components/schemas/AmInfluData' + dnaiEasData: + $ref: '#/components/schemas/DnaiEasMapping' + afReqQosData: + $ref: '#/components/schemas/AfRequestedQosData' + ecsAddrData: + $ref: '#/components/schemas/EcsAddrData' + required: + - resUri + +DataFilter: + description: Identifies a data filter. + type: object + properties: + dataInd: + $ref: '#/components/schemas/DataInd' + dnns: + type: array +``` + +``` + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + snssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + internalGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + ueIpv4s: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ueIpv6s: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + ueMacs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + minItems: 1 + anyUeInd: + type: boolean + description: Indicates the request is for any UE. + dnnSnssaiInfos: + description: > + Indicates the request is for any DNN and S-NSSAI combination present in the array. + type: array + items: + $ref: 'TS29522_AMInfluence.yaml#/components/schemas/DnnSnssaiInformation' + minItems: 1 + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + required: + - dataInd + +TrafficCorrelationInfo: + description: > + Contains the information for traffic correlation. + type: object + properties: + corrType: + $ref: '#/components/schemas/CorrelationType' + tfcCorrId: + type: string + description: > + Identification of a set of UEs accessing the application identified by the + Application Identifier or traffic filtering information. + comEasIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrRm' + comEasIpv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6AddrRm' + fqdnRange: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FqdnPatternMatchingRule' + minItems: 1 + nullable: true +``` + +``` + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UriRm' + notifCorrId: + type: string + nullable: true + description: Notification correlation identifier. + nullable: true + +AfRequestedQosData: + description: Represents AF Requested QoS data. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + afAppId: + type: string + description: Identifies an AF application. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sliceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + evSubsc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EventsSubscReqData' + flowInfos: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + qosReference: + type: string + altSerReqs: + type: array + items: + type: string + minItems: 1 + altSerReqsData: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Contains alternative service requirements that include individual QoS parameter sets. + disUeNotif: + type: boolean + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + tempInvalidity: + $ref: 'TS29565_Ntsctsf_QoSAndTSCAssistance.yaml#/components/schemas/TemporalInvalidity' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - suppFeat + oneOf: + - required: [supi] + - required: [interGroupId] + +AfRequestedQosDataPatch: + description: Represents modification of Individual AF Requested QoS data. + type: object + properties: + afAppId: + type: string + description: Identifies an AF application. + nullable: true + evSubsc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EventsSubscReqDataRm' + flowInfos: + type: array + items: +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + nullable: true + qosReference: + type: string + nullable: true + altSerReqs: + type: array + items: + type: string + minItems: 1 + nullable: true + altSerReqsData: + type: array + items: + $ref: + 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Contains removable alternative service requirements that include individual QoS + parameter sets. + nullable: true + disUeNotif: + type: boolean + nullable: true + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + tempInvalidity: + $ref: 'TS29565_Ntsctsf_QoSandTSCAssistance.yaml#/components/schemas/TemporalInvalidity' + +DnaiEasMapping: + description: Contains DNAI to EAS mapping information. + type: object + properties: + dnaiEasInfos: + type: array + items: + $ref: '#/components/schemas/DnaiEasInfo' + minItems: 1 + description: Each element contains EAS address information for a DNAI. + required: + - dnaiEasInfos + +DnaiEasInfo: + description: Contains EAS information for a DNAI. + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + easIpAddrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddress' + minItems: 1 + description: Each element contains EAS addresses, address ranges, and/or prefixes. + fqdns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FqdnPatternMatchingRule' + minItems: 1 + description: Each element contains FQDN matching rules for the EAS(s) of a DNAI. + anyOf: + - required: [dnn] + - required: [snssai] + oneOf: + - required: [easIpAddrs] + - required: [fqdns] + +EcsAddrData: + description: Represents ECS Address Data. + type: object + +``` + +``` + +properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + ecsServerAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EcsServerAddr' + spatialValidityCond: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SpatialValidityCond' + anyUeInd: + type: boolean + description: > + If provided and set to true it indicates that all the UEs are targetted, + otherwise set to false. The default value is false if omitted. + internalGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ecsServerAddr + +DataInd: + anyOf: + - type: string + enum: + - PFD + - IPTV + - BDT + - SVC_PARAM + - AM + - DNAI_EAS + - REQ_QOS + - ECS + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Indicates the type of data. + Possible values are + - PFD: PFD data. + - IPTV: IPTV configuration data. + - BDT: BDT data. + - SVC_PARAM: Service parameter data. + - AM: AM influence data. + - DNAI_EAS: DNAI EAS mapping data. + - REQ_QOS: AF Requested QoS data for a UE or group of UE(s) not identified by UE +address(es). + - ECS: ECS Address data. + +CorrelationType: + description: Indicates that a common DNAI or common EAS should be selected. + anyOf: + - type: string + enum: + - COMMON_DNAI + - COMMON_EAS + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +``` + +## A.4 Nudr\_DataRepository API for Exposure Data + +For the purpose of referencing entities defined in the Open API file defined in this Annex, it shall be assumed that this Open API file is contained in a physical file termed "TS29519\_Exposure\_Data.yaml". + +``` + +openapi: 3.0.0 + +info: + version: '-' + title: Unified Data Repository Service API file for structured data for exposure + description: | + The API version is defined in 3GPP TS 29.504 + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` +externalDocs: + description: > + 3GPP TS 29.519 V18.1.0; 5G System; Usage of the Unified Data Repository Service for Policy Data, + Application Data and Structured Data for Exposure. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.519/' + +paths: + /exposure-data/{ueId}/access-and-mobility-data: + put: + summary: Creates and updates the access and mobility exposure data for a UE + operationId: CreateOrReplaceAccessAndMobilityData + tags: + - AccessAndMobilityData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:access-and-mobility-data:create + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUEId' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AccessAndMobilityData' + responses: + '201': + description: > + Successful case. The resource has been successfully created and a response + body containing a representation of the access and mobility data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AccessAndMobilityData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '200': + description: > + Successful case. The resource has been successfully updated and a response + body containing a representation of the access and mobility data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AccessAndMobilityData' + '204': + description: > + Successful case. The resource has been successfully updated and no additional content + is to be sent in the response message. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +get: + summary: Retrieves the access and mobility exposure data for a UE + operationId: QueryAccessAndMobilityData + tags: + - AccessAndMobilityData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:access-and-mobility-data:read + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: The response body contains the access and mobility data + content: + application/json: + schema: + $ref: '#/components/schemas/AccessAndMobilityData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Deletes the access and mobility exposure data for a UE + operationId: DeleteAccessAndMobilityData + tags: + - AccessAndMobilityData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr +``` + +``` + + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:access-and-mobility-data:modify +parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +responses: + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Updates the access and mobility exposure data for a UE + operationId: UpdateAccessAndMobilityData + tags: + - AccessAndMobilityData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:access-and-mobility-data:modify + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AccessAndMobilityData' + responses: + '204': + description: > + Successful case. The resource has been successfully updated and no additional + content is to be sent in the response message. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/exposure-data/{ueId}/session-management-data/{pduSessionId}: + put: + summary: Creates and updates the session management data for a UE and for an individual PDU +session + operationId: CreateOrReplaceSessionManagementData + tags: + - PduSessionManagementData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:session-management-data:create + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: pduSessionId + in: path + description: PDU session id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionManagementData' + responses: + '201': + description: > + Successful case. The resource has been successfully created and a response + body containing a representation of the session management data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionManagementData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '200': + description: > + Successful case. The resource has been successfully updated and a response body + containing a representation of the session management data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionManagementData' + '204': + description: > + Successful case. The resource has been successfully updated and no additional + +``` + +``` + content is to be sent in the response message. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +get: + summary: Retrieves the session management data for a UE and for an individual PDU session + operationId: QuerySessionManagementData + tags: + - PduSessionManagementData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:session-management-data:read + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: pduSessionId + in: path + description: PDU session id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + - name: ipv4-addr + in: query + description: IPv4 Address of the UE + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + - name: ipv6-prefix + in: query + description: IPv6 Address Prefix of the UE + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + - name: dnn + in: query + description: DNN of the UE + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array +``` + +``` + items: + type: string + minItems: 1 + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: The response body contains the session management data + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionManagementData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Deletes the session management data for a UE and for an individual PDU session + operationId: DeleteSessionManagementData + tags: + - PduSessionManagementData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:session-management-data:modify + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: pduSessionId + in: path + description: PDU session id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + responses: + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +``` + +``` + + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/exposure-data/subs-to-notify: + post: + summary: Create a subscription to receive notification of exposure data changes + operationId: CreateIndividualExposureDataSubscription + tags: + - ExposureDataSubscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:subs-to-notify:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ExposureDataSubscription' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/ExposureDataSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + exposureDataChangeNotification: + '{ $request.body#/notificationUri }': + post: + requestBody: + required: true + content: + +``` + +``` + + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ExposureDataChangeNotification' + minItems: 1 + responses: + '204': + description: No Content, Notification was successful + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/exposure-data/subs-to-notify/{subId}: + put: + summary: updates a subscription to receive notifications of exposure data changes + operationId: ReplaceIndividualExposureDataSubscription + tags: + - IndividualExposureDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:subs-to-notify:modify + parameters: + - name: subId + in: path + description: Subscription id + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ExposureDataSubscription' + responses: + '200': + description: > + Resource was successfully modified and a body with the modified subscription + to notifications about exposure data is returned.. + content: + application/json: + schema: + $ref: '#/components/schemas/ExposureDataSubscription' + '204': + description: The individual subscription resource was successfully modified. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Deletes the individual Exposure Data subscription + operationId: DeleteIndividualExposureDataSubscription + tags: + - IndividualExposureDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:subs-to-notify:modify + parameters: + - name: subId + in: path + description: Subscription id + required: true + schema: + type: string + responses: + '204': + description: Resource was successfully deleted. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + schemas: + AccessAndMobilityData: + description: Represents Access and Mobility data for a UE. + type: object + properties: + location: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + locationTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + +``` + +``` + +timeZoneTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' +regStates: + type: array + items: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/RmInfo' +regStatesTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +connStates: + type: array + items: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmInfo' +connStatesTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +reachabilityStatus: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability' +reachabilityStatusTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +smsOverNasStatus: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/SmsSupport' +smsOverNasStatusTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +roamingStatus: + type: boolean + description: > + True The serving PLMN of the UE is different from the HPLMN of the UE; False + The serving PLMN of the UE is the HPLMN of the UE. +roamingStatusTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +currentPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +currentPlmnTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +ratType: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +ratTypesTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +resetIds: + type: array + items: + type: string + minItems: 1 + +PduSessionManagementData: + description: Represents Session management data for a UE and a PDU session. + type: object + properties: + pduSessionStatus: + $ref: '#/components/schemas/PduSessionStatus' + pduSessionStatusTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + dnaiTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + n6TrafficRoutingInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + n6TrafficRoutingInfoTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Prefix: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + description: UE IPv6 prefix. + ipv6Addrs: + type: array + items: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + pduSessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + ipAddrTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + +ExposureDataSubscription: + description: Represents a Subscription to Notifications about Exposure Data. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + immRep: + type: boolean + description: > + If provided and set to true, it indicates that existing entries that + match this subscription shall be immediately reported in the response. + immReports: + type: array + items: + $ref: '#/components/schemas/ExposureDataChangeNotification' + minItems: 1 + description: Immediate report with existing UDR entries. + required: + - notificationUri + - monitoredResourceUris + +ExposureDataChangeNotification: + description: Represents changed exposure data for one UE for which Notification was requested. + type: object + properties: + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + accessAndMobilityData: + $ref: '#/components/schemas/AccessAndMobilityData' + pduSessionManagementData: + type: array + items: + $ref: '#/components/schemas/PduSessionManagementData' + minItems: 1 + delResources: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + +PduSessionStatus: + anyOf: + - type: string + enum: + - "ACTIVE" + - "RELEASED" + +``` + +``` +- type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Represents the state of the PDU session. + Possible values are + - "ACTIVE": the PDU session is active. + - "RELEASED": the PDU session released. +``` + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-----------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| Date | Meeting # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2018-01 | CT3#94 | | | | | TS skeleton of Usage of the Unified Data Repository service for Policy Data and Structured Data for exposure | 0.0.0 | +| 2018-01 | CT3#94 | | | | | Inclusion of C3-180352, C3-180326, C3-180327 | 0.1.0 | +| 2018-03 | CT3#95 | | | | | Inclusion of C3-181145, C3-181288, C3-181289, C3-181313 | 0.2.0 | +| 2018-04 | CT3#96 | | | | | Inclusion of C3-182402, C3-182476, C3-182456, C3-182404, C3-182457, C3-182458 | 0.3.0 | +| 2018-05 | CT3#97 | | | | | Inclusion of C3-183872, C3-183705, C3-183704, C3-183873, C3-183732, C3-183706 C3-183874, C3-183709, C3-183876, C3-183263, C3-183877, C3-183712, C3-183715 and editorial changes by Rapporteur | 0.4.0 | +| 2018-06 | CT#80 | CP-181033 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181033 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0006 | | F | Scope and Overview | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0007 | | F | Introduction subclauses 5.1, 6.1 and 7.1 | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0008 | | F | Resource overview subclauses 5.2.1, 6.2.1 and 7.2.1 | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0009 | 3 | F | Nudr reused data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0010 | 6 | B | AM policy data resource definition | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0011 | 8 | B | SM policy data resource definition | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0012 | 3 | B | Sponsored data connectivity profiles | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0014 | 5 | B | Background Data Transfer data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0015 | 4 | B | Policy data change subscription | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0016 | 5 | B | Data change notification | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0017 | 2 | F | Error handling subclauses | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0018 | 1 | F | Feature negotiation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0019 | 1 | F | Resource PFD Datas and Data types definition | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0020 | 1 | F | OpenAPI schema for Policy Data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0021 | 3 | F | Stage 2 Alligments for Structured Data for Exposure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0022 | 4 | B | Subscription for Structured Data for Exposure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0023 | 3 | F | Get query parameters for structured data for exposure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0024 | 5 | F | HTTP error responses for structured data for exposure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0025 | 1 | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182032 | 0026 | 3 | B | Resource Structure for policy data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0027 | | F | n6 Traffic Routing Information encoding | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0028 | 1 | F | Removal of ExternalDocs section in OpenApi file for Exposure Data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0029 | 1 | F | VarUeld used in TS 29.519 | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0034 | 1 | F | OpenAPI schema for PolicyData | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0035 | 3 | F | External information stored in UDR for Application Data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0036 | | F | Clean up the Editor Note in applicatoion data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0037 | 4 | F | Correction the data type of application data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0038 | 3 | B | Introduce the operator policy data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0039 | 2 | B | OpenAPI of Application data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0040 | 1 | F | Update of resource structure of application data 29.519 | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0041 | 1 | F | Ethernet packet filter for traffic influence data of applicatoion data 29.519 | 15.1.0 | +| 2018-12 | CP#82 | CP-183205 | 0042 | 1 | F | DNAI reused data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0043 | 1 | F | ExternalDocs field | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0044 | | F | PduSessionStatus | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0045 | 1 | F | Query parameters correction on application data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0046 | 1 | F | PUT operation for Individual Influence Data Subscription | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0047 | 3 | F | Background Data Transfer Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0048 | 1 | F | Cardinality for array and map | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0049 | 1 | F | Resource URI for ExposureData | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0050 | | F | Ueld definition | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0052 | 1 | F | Error status codes for HTTP responses | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0053 | | F | Service name | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0054 | 1 | F | Reference to the yaml file of Npcf_BDTPolicyControl API | 15.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-------------------------------------------------------------------------------------------|--------| +| 2018-12 | CP#82 | CP-183205 | 0055 | | F | Missed GET method on UEPolicySetResource | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0055 | 2 | F | Missed GET method on UEPolicySetResource | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0056 | 4 | F | Corrections on AM Policy and UE Policy data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0057 | 6 | F | Corrections on SM Policy Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0058 | 1 | F | Correct TrafficRoute data type | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0060 | 4 | F | Correct subscription for application data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0062 | 3 | F | Correction to the AF Influence on traffic steering control | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0063 | 3 | F | PLMN ID as key for UE data sets | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0066 | 1 | F | Supported features | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0067 | 1 | F | Add AF application ID for traffic influence | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0068 | | F | Correct referenced file in openAPI for application data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0069 | | F | Correct referenced file in openAPI for exposure data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0070 | 1 | F | Use correct naming convention | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0071 | 1 | F | Correct subscription for Application Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0072 | 1 | F | Status code update for Application Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0073 | 1 | F | Correction on UsageThreshold | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0075 | 2 | F | Status code update for Exposure Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0076 | 2 | F | Status code update for Policy Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0077 | 2 | F | Incorrect response code of PUT method for individual PFD Data creation | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0078 | 1 | F | corrections on individual Influence Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0079 | 2 | F | Adding timestamp for allowed usage storage | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0080 | | F | Missing 201 response body for /policy-data/subs-to-notify | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0081 | 1 | F | Location header | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0083 | 4 | F | Corrections on Usage Monitoring information | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0087 | | F | Correction on PduSessionManagementData | 15.2.0 | +| 2019-03 | CP#83 | CP-190115 | 0090 | 1 | F | Correction on ChargingInformation data type reference in the OpenAPI file | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0091 | 1 | F | Formatting of structured data types in query parameters | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0092 | 1 | F | Correcting resource definitions | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0093 | | F | References to data types | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0095 | 2 | F | Correction on Policy Data change notification | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0096 | 1 | F | Correction on BDT data | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0098 | 1 | F | Support of allowed Route Selection data | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0099 | 1 | F | Support of PEI, OSid and ANDSP support indication in UE Policy Set | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0100 | | F | Support of PRA information | 15.3.0 | +| 2019-06 | CP#84 | CP-191077 | 0101 | | F | Correction of OpenAPI file and main body misalignments for Notification messages | 15.4.0 | +| 2019-06 | CP#84 | CP-191077 | 0102 | 2 | F | Corrections in PolicyDataSubscription and PolicyDataChangeNotification types | 15.4.0 | +| 2019-06 | CP#84 | CP-191077 | 0106 | 1 | F | Precedence of OpenAPI file | 15.4.0 | +| 2019-06 | CP#84 | CP-191077 | 0113 | | F | Correcting the name of URI to receive notifications | 15.4.0 | +| 2019-06 | CP#84 | CP-191077 | 0103 | 4 | F | "201 Created" response without body and other HTTP response errors | 15.4.0 | +| 2019-06 | CP#84 | CP-191077 | 0116 | 1 | F | Expiry time in subscription data types | 15.4.0 | +| 2019-06 | CP#84 | CP-191184 | 0117 | 3 | F | Notification of resource deletion | 15.4.0 | +| 2019-06 | CP#84 | CP-191208 | 0118 | 3 | F | Copyright Note in YAML file | 15.4.0 | +| 2019-06 | CP#84 | CP-191077 | 0119 | 1 | F | Missed Traffic Influence information | 15.4.0 | +| 2019-06 | CP#84 | CP-191183 | 0120 | 4 | F | Notification of resource deletion for Application and Exposure data sets | 15.4.0 | +| 2019-06 | CP#84 | CP-191089 | 0105 | 2 | B | PFD extension for domain name protocol | 16.0.0 | +| 2019-06 | CP#84 | CP-191071 | 0109 | 3 | B | AF acknowledgement to be expected | 16.0.0 | +| 2019-06 | CP#84 | CP-191071 | 0110 | 2 | B | UE IP address preservation indication | 16.0.0 | +| 2019-06 | CP#84 | CP-191100 | 0114 | 1 | B | NEF stored exposure data | 16.0.0 | +| 2019-09 | CT#85 | CP-192169 | 0125 | 2 | F | UDR Application Errors | 16.1.0 | +| 2019-09 | CT#85 | CP-192145 | 0127 | 2 | A | Missed any UE traffic influence data | 16.1.0 | +| 2019-09 | CT#85 | CP-192169 | 0128 | 1 | B | Multiple temporal validity conditions for AF traffic influence | 16.1.0 | +| 2019-09 | CT#85 | CP-192244 | 0130 | 2 | A | Remove PFD change notification | 16.1.0 | +| 2019-09 | CT#85 | CP-192156 | 0131 | 1 | B | Support a set of MAC addresses in traffic filter | 16.1.0 | +| 2019-09 | CT#85 | CP-192196 | 0138 | 4 | B | Application Data update to support xBDT | 16.1.0 | +| 2019-09 | CT#85 | CP-192152 | 0140 | 3 | B | Subscription and Notification of IPTV configuration data change | 16.1.0 | +| 2019-09 | CT#85 | CP-192152 | 0141 | 2 | B | Resource structure of Nudr API for Application Data | 16.1.0 | +| 2019-09 | CT#85 | CP-192152 | 0142 | 2 | B | Storage of IPTV configuration data | 16.1.0 | +| 2019-09 | CT#85 | CP-192156 | 0143 | 2 | F | Subscription/unsubscription for PFDs update notifications and related callback correction | 16.1.0 | +| 2019-10 | CT#85 | - | - | - | - | Addition of missing yaml files | 16.1.1 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------|--------| +| 2019-12 | CT#86 | CP-193223 | 0144 | 2 | B | Retrieval of BDT policy data for a set of BDT reference identifiers | 16.2.0 | +| 2019-12 | CT#86 | CP-193181 | 0145 | 1 | F | Open issue for AddrPreservation feature | 16.2.0 | +| 2019-12 | CT#86 | CP-193223 | 0149 | 3 | B | Support of BDT reference Id within Session Management data | 16.2.0 | +| 2019-12 | CT#86 | CP-193191 | 0151 | 3 | B | Partial update of IPTVConfiguration API | 16.2.0 | +| 2019-12 | CT#86 | CP-193210 | 0152 | 2 | B | Patch Report to Nudr_DataRepository API for Policy data | 16.2.0 | +| 2019-12 | CT#86 | CP-193223 | 0153 | | F | Reference correction to BdtReferenceId | 16.2.0 | +| 2019-12 | CT#86 | CP-193212 | 0155 | 1 | F | Update of TS version Rel-16 | 16.2.0 | +| 2019-12 | CT#86 | CP-193197 | 0156 | 2 | B | MCS Priority Indication | 16.2.0 | +| 2019-12 | CT#86 | CP-193187 | 0158 | - | A | Definition of BdtData in OpenAPI | 16.2.0 | +| 2019-12 | CT#86 | CP-193197 | 0159 | - | F | Usage of BdtReferenceId data type | 16.2.0 | +| 2019-12 | CT#86 | CP-193223 | 0161 | 1 | B | include S-NSSAI and DNN in Application Data for xBDT | 16.2.0 | +| 2019-12 | CT#86 | CP-193223 | 0162 | | F | remove 204 response on PUT request for AppliedBDTPolicyData | 16.2.0 | +| 2019-12 | CT#86 | CP-193210 | 0164 | | B | Feature Negotiation for OperatorSpecificData resource | 16.2.0 | +| 2019-12 | CT#86 | CP-193210 | 0165 | | B | Feature Negotiation for Influence Data resource | 16.2.0 | +| 2019-12 | CT#86 | CP-193126 | 0166 | | B | URI correction on resource Individual Applied BDT Policy Data | 16.2.0 | +| 2020-03 | CT#87e | CP-200141 | 0167 | 2 | B | Application data change notification | 16.3.0 | +| 2020-03 | CT#87e | CP-200203 | 0168 | 1 | B | Complete the IPTV configuration | 16.3.0 | +| 2020-03 | CT#87e | CP-200263 | 0169 | 2 | B | Nudr_DataRepository API update for Service Parameter provisioning | 16.3.0 | +| 2020-03 | CT#87e | CP-200218 | 0170 | 1 | B | Indication of traffic correlation | 16.3.0 | +| 2020-03 | CT#87e | CP-200136 | 0171 | 2 | B | Include influenceId into TrafficInfluData for Notification | 16.3.0 | +| 2020-03 | CT#87e | CP-200219 | 0172 | 2 | B | Correct the mapping of ASPid for xBDT | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0173 | 1 | B | Subscription and notification to data changes related to a subset of resource data, Policy Data set | 16.3.0 | +| 2020-03 | CT#87e | CP-200203 | 0174 | | F | Correct content type in PATCHing IPTV application data | 16.3.0 | +| 2020-03 | CT#87e | CP-200198 | 0175 | | B | Additional PDU session status data | 16.3.0 | +| 2020-03 | CT#87e | CP-200219 | 0176 | | F | Correct content type in PATCHing BDT application data | 16.3.0 | +| 2020-03 | CT#87e | CP-200219 | 0177 | | F | Removal of the BDT policy from the "bdtRefIds" object | 16.3.0 | +| 2020-06 | CT#88e | CP-201220 | 0179 | 2 | A | internalGroupId in Influence Data | 16.4.0 | +| 2020-06 | CT#88e | CP-201238 | 0180 | 2 | F | Definition of ServiceParameterData in openAPI | 16.4.0 | +| 2020-06 | CT#88e | CP-201246 | 0181 | 3 | F | Data Types for Application Data | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0183 | 1 | F | Correction to IPTV Configuration | 16.4.0 | +| 2020-06 | CT#88e | CP-201253 | 0184 | 1 | F | Correction to BDT Policy | 16.4.0 | +| 2020-06 | CT#88e | CP-201220 | 0185 | 1 | A | Correction to notifications of Operator Specific Data changes | 16.4.0 | +| 2020-06 | CT#88e | CP-201220 | 0188 | | A | Correct content type in PATCHing traffic influence application data | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0189 | | F | Correct DataFilter presence condition | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0190 | | F | Correct resourceId in required field | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0191 | 1 | B | Support local traffic routing in session subscription | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0192 | 1 | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201276 | 0194 | 1 | F | Traffic descriptor for xBDT | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0195 | 1 | F | URI of the Nudr_DataRepository service for Policy, Application and Exposure data | 16.4.0 | +| 2020-06 | CT#88e | CP-201313 | 0197 | | F | Data type of internalGroupId attribute | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0199 | | F | Data model correction for IPTV | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0200 | | F | Remove feature for IPTV data configuration | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0201 | | F | Optionality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0202 | 2 | F | Corrections on supported features definition | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0203 | | F | required field in OpenAPI file | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0204 | 1 | F | Supported headers, Resource Data type | 16.4.0 | +| 2020-06 | CT#88e | CP-201255 | 0206 | | F | Update in TS version in externalDocs field | 16.4.0 | +| 2020-09 | CT#89e | CP-202059 | 0207 | | F | Include resouceURI in IptvConfigData for change notification association | 16.5.0 | +| 2020-09 | CT#89e | CP-202069 | 0208 | | F | Include resouceURI in ServiceParameterData for change notification association | 16.5.0 | +| 2020-09 | CT#89e | CP-202209 | 0209 | | F | Include resouceURI in TrafficInfluData for change notification association | 16.5.0 | +| 2020-09 | CT#89e | CP-202082 | 0210 | | F | Include resouceURI in BdtPolicyData for change notification association | 16.5.0 | +| 2020-09 | CT#89e | CP-202073 | 0211 | | F | Removal of sibling elements | 17.0.0 | +| 2020-09 | CT#89e | CP-202073 | 0212 | | B | Resource Level Authorization for Policy Data, Application Data, and Exposure Data | 17.0.0 | +| 2020-09 | CT#89e | CP-202085 | 0214 | | F | Update of TS version in externalDocs field | 17.0.0 | +| 2020-12 | CT#90e | CP-203139 | 0216 | | A | TS 29.519 Essential Corrections and alignments | 17.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------------------------------------|--------| +| 2020-12 | CT#90e | CP-203110 | 0218 | 1 | A | Correction to support NEF binding indication | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0220 | 1 | A | Correction to the BDT policy re-negotiation | 17.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0222 | | A | Storage of YAML files in 3GPP Forge | 17.1.0 | +| 2020-12 | CT#90e | CP-203147 | 0223 | 2 | B | Data retrieval of multiple policy data sets | 17.1.0 | +| 2020-12 | CT#90e | CP-203154 | 0225 | | A | MA Support indication within UE Context policy control subscription information | 17.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0227 | 1 | A | Callback URI correction | 17.1.0 | +| 2020-12 | CT#90e | CP-203153 | 0229 | | F | Update of TS version in externalDocs field | 17.1.0 | +| 2021-03 | CT#91e | CP-210226 | 0230 | 1 | B | Allow the retrieval of a set of policy data subsets for a UE | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0231 | | F | Adding "description" field for map data types | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0232 | | F | OpenAPI reference | 17.2.0 | +| 2021-03 | CT#91e | CP-210226 | 0233 | | F | Encoding of Snssai as key of a map | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0235 | | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.2.0 | +| 2021-03 | CT#91e | CP-210198 | 0238 | 1 | A | UsageMonData: definition of "scopes" attribute | 17.2.0 | +| 2021-03 | CT#91e | CP-210198 | 0242 | 1 | A | PUT method for Exposure Data modification | 17.2.0 | +| 2021-03 | CT#91e | CP-210206 | 0244 | 1 | A | extend bdtpStatus to include VALID | 17.2.0 | +| 2021-03 | CT#91e | CP-210240 | 0248 | | F | Update of TS version in externalDocs field | 17.2.0 | +| 2021-06 | CT#92e | CP-211242 | 0250 | 1 | F | Correction to Charging Information | 17.3.0 | +| 2021-06 | CT#92e | CP-211211 | 0252 | 3 | B | Correction to OSD handling | 17.3.0 | +| 2021-06 | CT#92e | CP-211121 | 0253 | 4 | B | 5G ProSe related updates to Nudr | 17.3.0 | +| 2021-06 | CT#92e | CP-211218 | 0254 | 2 | B | Support of User Plane Latency requirement | 17.3.0 | +| 2021-06 | CT#92e | CP-211218 | 0257 | 1 | B | UDR application data update to support AF influence on URSP | 17.3.0 | +| 2021-06 | CT#92e | CP-211265 | 0259 | | F | Update of TS version in externalDocs field | 17.3.0 | +| 2021-09 | CT#93e | CP-212242 | 0260 | 1 | B | AM Influence UDR models for DCAMP | 17.4.0 | +| 2021-09 | CT#93e | CP-212206 | 0261 | 1 | B | PDU session policy data extension for UE-Slice-MBR | 17.4.0 | +| 2021-09 | CT#93e | CP-212206 | 0263 | 1 | B | Policy Data extension for Slice-MBR | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0264 | 1 | F | Corrections to IPTV configuration data | 17.4.0 | +| 2021-09 | CT#93e | CP-212229 | 0266 | 1 | F | Correction of cardinality for xBDT | 17.4.0 | +| 2021-09 | CT#93e | CP-212190 | 0269 | | F | Correction of data types of resetPeriod and resetTime in openAPI file | 17.4.0 | +| 2021-09 | CT#93e | CP-212188 | 0271 | | B | Removal of some 5G ProSe related Ens | 17.4.0 | +| 2021-09 | CT#93e | CP-211223 | 0272 | | F | Update of externalDocs field | 17.4.0 | +| 2021-12 | CT#94e | CP-213230 | 0275 | 1 | B | Correction on Network Slice Policy Control Subscription information | 17.5.0 | +| 2021-12 | CT#94e | CP-213230 | 0276 | | B | Correction on PolicyDataChangeNotification | 17.5.0 | +| 2021-12 | CT#94e | CP-213222 | 0277 | 1 | B | Nudr impacts for the notification on the outcome of UE Policies delivery due to service specific parameter provisioning | 17.5.0 | +| 2021-12 | CT#94e | CP-213194 | 0278 | | F | AM Influence Data: alignment with naming convention | 17.5.0 | +| 2021-12 | CT#94e | CP-213230 | 0279 | 1 | F | Presence conditions for attributes in SlicePolicyData | 17.5.0 | +| 2021-12 | CT#94e | CP-213234 | 0280 | 1 | B | Time Synch data in UDR | 17.5.0 | +| 2021-12 | CT#94e | CP-213239 | 0281 | 1 | F | Clarification about the data type used for UE policy section information | 17.5.0 | +| 2021-12 | CT#94e | CP-213194 | 0282 | 1 | B | AM Influence data model updates | 17.5.0 | +| 2021-12 | CT#94e | CP-213213 | 0283 | 1 | B | Updates to the 5G ProSe service parameters | 17.5.0 | +| 2021-12 | CT#94e | CP-213223 | 0286 | 1 | B | Clarification of AF preference for the user plane latency | 17.5.0 | +| 2021-12 | CT#94e | CP-213168 | 0288 | 2 | F | Feature negotiation at PFD data retrieval | 17.5.0 | +| 2021-12 | CT#94e | CP-213170 | 0290 | 2 | F | Reference PfdDataForApp data type | 17.5.0 | +| 2021-12 | CT#94e | CP-213223 | 0291 | 1 | B | AF Request for Simultaneous Connectivity over Source and Target PSA at Edge Relocation | 17.5.0 | +| 2021-12 | CT#94e | CP-213239 | 0293 | 1 | F | Naming Convention | 17.5.0 | +| 2021-12 | CT#94e | CP-213246 | 0294 | | F | Update of externalDocs field | 17.5.0 | +| 2022-03 | CT#95e | CP-220198 | 0296 | 2 | B | Resolution of DCAMP open issues such as applicable filters and immediate reporting | 17.6.0 | +| 2022-03 | CT#95e | CP-220201 | 0297 | | B | Support of Operator-Specific Data with no keys | 17.6.0 | +| 2022-03 | CT#95e | CP-220176 | 0298 | 2 | A | Alignment of "Application Errors" clauses with SBI TS template | 17.6.0 | +| 2022-03 | CT#95e | CP-220185 | 0299 | 1 | B | Updates to support AF Guidance on URSP for Application Data | 17.6.0 | +| 2022-03 | CT#95e | CP-220327 | 0300 | 2 | B | resetId assignment to UDR consumers (PCF, NEF) | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0301 | 1 | D | Clause Correction | 17.6.0 | +| 2022-03 | CT#95e | CP-220186 | 0302 | 1 | B | API definition for EAS Deployment Information Data | 17.6.0 | +| 2022-03 | CT#95e | CP-220330 | 0303 | 2 | B | OpenAPI to support EAS Deployment Information Data | 17.6.0 | +| 2022-03 | CT#95e | CP-220183 | 0304 | 1 | B | Time Synch data updates | 17.6.0 | +| 2022-03 | CT#95e | CP-220176 | 0306 | | A | Correction of query parameter content type | 17.6.0 | +| 2022-03 | CT#95e | CP-220215 | 0308 | 2 | F | Introduction of ServiceParameterDataPatch | 17.6.0 | +| 2022-03 | CT#95e | CP-220185 | 0309 | | F | Removal of Editor's Notes for URSP encoding and DeliveryOutcome feature | 17.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------|--------| +| 2022-03 | CT#95e | CP-220186 | 0310 | 1 | B | Support of binding principles for UE Policy Delivery outcome | 17.6.0 | +| 2022-03 | CT#95e | CP-220198 | 0312 | 1 | F | Updates of AM Influence Data resource | 17.6.0 | +| 2022-03 | CT#95e | CP-220198 | 0313 | 1 | F | Query for AM Influence data for Any UE | 17.6.0 | +| 2022-03 | CT#95e | CP-220197 | 0314 | 1 | B | Support of service area coverage notifications | 17.6.0 | +| 2022-03 | CT#95e | CP-220198 | 0315 | 1 | F | Solving Editor's Note on query parameters | 17.6.0 | +| 2022-03 | CT#95e | CP-220201 | 0316 | 1 | F | Formatting of description fields | 17.6.0 | +| 2022-03 | CT#95e | CP-220334 | 0318 | 2 | F | Query for Service Parameter Data for Any UE | 17.6.0 | +| 2022-03 | CT#95e | CP-220196 | 0320 | 1 | F | Subscription to notifications for Any UE | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0321 | 1 | F | Updates of Traffic Influence resource | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0322 | 2 | F | Correction to default values | 17.6.0 | +| 2022-03 | CT#95e | CP-220194 | 0324 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221157 | 0326 | | F | Removal of allowEmptyValue parameter | 17.7.0 | +| 2022-06 | CT#96 | CP-221153 | 0327 | 2 | F | Support of allowedDelay for PFD data | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0328 | | F | Correction of supported features for Edge Computing functionality | 17.7.0 | +| 2022-06 | CT#96 | CP-221159 | 0329 | 2 | F | Handling of query parameters for AM Influence Data resource | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0330 | 1 | B | Policy Data Subscription enhancements | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0331 | 1 | F | Handling of combinations of attributes of DataFilter data type | 17.7.0 | +| 2022-06 | CT#96 | CP-221158 | 0332 | 2 | F | Handling of query parameters in Applied BDT Data | 17.7.0 | +| 2022-06 | CT#96 | CP-221158 | 0333 | 2 | F | Handling of query parameters in IPTV Configuration resource | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0334 | 1 | F | Handling of query parameters for PFD Data | 17.7.0 | +| 2022-06 | CT#96 | CP-221158 | 0335 | 2 | F | Handling of query parameters in Traffic Influence Data | 17.7.0 | +| 2022-06 | CT#96 | CP-221158 | 0336 | 2 | F | Handling of query parameters in Service Parameter Data resource | 17.7.0 | +| 2022-06 | CT#96 | CP-221155 | 0337 | 1 | B | Nudr_DataRepository Application data Access Scope update for API, resource, operation | 17.7.0 | +| 2022-06 | CT#96 | CP-221155 | 0338 | 1 | B | Nudr_DataRepository Exposure Data Access Scope update for API, resource, operation | 17.7.0 | +| 2022-06 | CT#96 | CP-221155 | 0339 | 1 | B | Nudr_DataRepository Policy data Access Scope update for API, resource, operation | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0340 | 1 | F | Update on EAS Deployment Information Data | 17.7.0 | +| 2022-06 | CT#96 | CP-221159 | 0341 | 1 | F | Clarification about subscription to cha | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0342 | 1 | F | Removing the apiVersion placeholder from the Resource URI variables tables | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0343 | | F | Nudr_DataRepository Policy data description field update | 17.7.0 | +| 2022-06 | CT#96 | CP-221158 | 0344 | 1 | F | Dependencies between UM resource(s) and SM resource | 17.7.0 | +| 2022-06 | CT#96 | CP-221151 | 0345 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-09 | CT#97e | CP-222123 | 0346 | 2 | F | Correction in the handling of individual AM Influence Data resource | 17.8.0 | +| 2022-09 | CT#97e | CP-222123 | 0347 | 2 | F | Correction in the handling of individual Applied BDT Policy Data resource | 17.8.0 | +| 2022-09 | CT#97e | CP-222123 | 0348 | 2 | F | Correction in the handling of individual Influence Data resource | 17.8.0 | +| 2022-09 | CT#97e | CP-222123 | 0349 | 2 | F | Correction in the handling of individual IPTV configuration resource | 17.8.0 | +| 2022-09 | CT#97e | CP-222123 | 0350 | 2 | F | Correction in the handling of individual Service Parameter Data resource | 17.8.0 | +| 2022-09 | CT#97e | CP-222123 | 0351 | | F | OpenAPI file for policy data: tabs removal and "description" field adding | 17.8.0 | +| 2022-09 | CT#97e | CP-222123 | 0352 | 1 | F | Application data API: definitions of 403 and 404 responses | 17.8.0 | +| 2022-09 | CT#97e | CP-222099 | 0353 | | F | Support of GET for Individual EAS Deployment Information Data resource | 17.8.0 | +| 2022-09 | CT#97e | CP-222099 | 0354 | | F | Incomplete implementation of CR #0308 | 17.8.0 | +| 2022-09 | CT#97e | CP-222093 | 0357 | | A | Correction to UE Dedicated PRAs | 17.8.0 | +| 2022-09 | CT#97e | CP-222099 | 0358 | | F | Corrections to Group Id | 17.8.0 | +| 2022-09 | CT#97e | CP-222095 | 0359 | 1 | B | Supporting MBS policy control | 17.8.0 | +| 2022-09 | CT#97e | CP-222121 | 0360 | | F | Update of info and externalDocs fields | 17.8.0 | +| 2022-12 | CT#98e | CP-223196 | 0366 | 1 | F | Correction related to applicability of traffic correlation indicator | 17.9.0 | +| 2022-12 | CT#98e | CP-223166 | 0367 | | F | Correction to MbsSessPolCtrlData data type | 17.9.0 | +| 2022-12 | CT#98e | CP-223191 | 0361 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0362 | 1 | B | Immediate reporting for policy data | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0363 | 1 | F | Nudr_DataRepository API for policy data: enumeration definitions | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0365 | 1 | F | Corrections to the resource EAS Deployment Information Data | 18.0.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------|--------| +| 2022-12 | CT#98e | CP-223192 | 0369 | | F | Corrections on Resource URI structures | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0370 | | F | Correction to DNN encoding | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0371 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230170 | 0372 | 1 | B | Service Function Chaining support in Nudr_DataRepository | 18.1.0 | +| 2023-03 | CT#99 | CP-230165 | 0375 | 1 | A | Partial subscriptions corrections | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0377 | 1 | B | Immediate reporting for application data | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0378 | 1 | B | Immediate reporting for exposure data | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0380 | 1 | B | Addressing inconsistencies in the supported features negotiation | 18.1.0 | +| 2023-03 | CT#99 | CP-230137 | 0381 | | | Support External Subscriber Category | 18.1.0 | +| 2023-03 | CT#99 | CP-230163 | 0383 | | A | Correction to allowedDelay for PFD data | 18.1.0 | +| 2023-03 | CT#99 | CP-230164 | 0386 | | A | nternal-Group-Ids attribute correction | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0387 | | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230137 | 0389 | 1 | B | Support for AF traffic influence for common EAS, DNAI selection | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0390 | 1 | F | Support of indirect feature negotiation | 18.1.0 | +| 2023-03 | CT#99 | CP-230152 | 0391 | 1 | B | New Indication of URSP provisioning support in EPS | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0392 | 1 | B | Solving Editor's Notes for Immediate Report of Policy Data | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0393 | 1 | B | Retrieval of Policy Data Subscriptions | 18.1.0 | +| 2023-03 | CT#99 | CP-230129 | 0397 | 1 | A | Correction of a misalignment in an attribute's name | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0398 | | F | Corrections to query parameters not respecting the naming convention | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0399 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231156 | 0400 | 1 | B | Support for A2X service parameters provisioning | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0401 | | B | Introduction of PDTQ impacts in Nudr service | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0402 | | F | Missing implementation for immediate reporting functionality | 18.2.0 | +| 2023-06 | CT#100 | CP-231149 | 0405 | 3 | B | Resource for Group-MBR in Nudr_DataRepository service for Policy Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231149 | 0406 | 3 | B | Data Model for Group-MBR in Nudr_DataRepository service for Policy Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231158 | 0407 | 1 | B | Correction to AF influence on Service Function Chaining | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 0408 | | B | Complete common DNAI and EAS selection | 18.2.0 | +| 2023-06 | CT#100 | CP-231171 | 0410 | 1 | B | Adding list of PLMN ID(s) for inbound roaming UEs in AM Influence Data. | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 0411 | 1 | B | Add applicability information for URSP provisioning in EPS | 18.2.0 | +| 2023-06 | CT#100 | CP-231149 | 0412 | 1 | B | OpenAPI for Group-MBR in Nudr_DataRepository service for Policy Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0414 | | F | Update of externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232090 | 0416 | 1 | F | Corrections to the definition of Group related Policy Control Data | 18.3.0 | +| 2023-09 | CT#101 | CP-232114 | 0417 | 1 | A | Correction in ServiceParameterDataPatch data type | 18.3.0 | +| 2023-09 | CT#101 | CP-232099 | 0418 | 1 | B | CHF address(es) for policy decision | 18.3.0 | +| 2023-09 | CT#101 | CP-232099 | 0419 | 1 | B | Spending limits control for policy decision | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0420 | 1 | B | Support of the tracing requirements for UE policy | 18.3.0 | +| 2023-09 | CT#101 | CP-232119 | 0421 | 1 | B | Service parameter provisioning for 5G ProSe UE-to-UE relay | 18.3.0 | +| 2023-09 | CT#101 | CP-232101 | 0422 | 1 | B | Adding TNAP IDs to Service Parameter data | 18.3.0 | +| 2023-09 | CT#101 | CP-232101 | 0423 | 1 | B | Adding subscribed TNAP IDs to Policy data | 18.3.0 | +| 2023-09 | CT#101 | CP-232090 | 0424 | 1 | B | Resource and data model for the AF Requested QoS for a UE or a group of UEs | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0425 | 1 | B | Support for AM policy data in the operator specific data resource | 18.3.0 | +| 2023-09 | CT#101 | CP-232090 | 0427 | 1 | B | Removal of ENs on Group-MBR | 18.3.0 | +| 2023-09 | CT#101 | CP-232102 | 0429 | 1 | F | Correction on SFC terminology and editorial issues | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0430 | 1 | B | Update the storage of the PDTQ policy data | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0431 | | B | PdtqData: support of Application Identifier parameter | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0432 | | F | Correction of resource URI for resource IndividualPdtqData | 18.3.0 | +| 2023-09 | CT#101 | CP-232106 | 0434 | | A | Correction on headers attribute | 18.3.0 | +| 2023-09 | CT#101 | CP-232183 | 0435 | 2 | B | Common EAS/DNAI determination for a set of UEs | 18.3.0 | +| 2023-09 | CT#101 | CP-232092 | 0436 | 1 | B | Completion of eUEPO impacts | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0438 | 1 | F | Correction to Service Parameter Data query | 18.3.0 | +| 2023-09 | CT#101 | CP-232103 | 0439 | 3 | B | Add ParmForRangingSI | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0442 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0443 | | F | defining BdtReferenceIdRm data type | 18.3.0 | +| 2023-12 | CT#102 | CP-233254 | 0448 | 1 | A | Corrections on attribute names of SM Policy Data | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 0450 | 2 | B | Resolving the remaining EN on group data rate control | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0451 | | F | HTTP RFCs obsoleted by IETF RFC 9110 | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------|--------| +| 2023-12 | CT#102 | CP-233239 | 0452 | 1 | F | Data model corrections for TrafficCorrelationInfo | 18.4.0 | +| 2023-12 | CT#102 | CP-233240 | 0453 | 3 | B | DNAI-EAS Mappings data subset in the UDR | 18.4.0 | +| 2023-12 | CT#102 | CP-233247 | 0454 | 1 | F | Handling of the warning notification enabled flag. | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0456 | | F | Correction in data type for AmInfluData | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0457 | 1 | F | Handling of the warning notification enabled flag. | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 0460 | 3 | B | AF Requested QoS for a UE or Group of UEs | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 0461 | 1 | B | Subscription to notification of changes of AF Requested QoS | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0462 | | F | Correction to presence conditions in the OpenAPI file | 18.4.0 | +| 2023-12 | CT#102 | CP-233247 | 0464 | 1 | F | Correction to subscription to notification of changes of AF influence on AM Policies | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0465 | | F | Removing the unnecessary resetIds attributes | 18.4.0 | +| 2023-12 | CT#102 | CP-233239 | 0466 | 1 | B | ECS Address Information in Roaming | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 0467 | 1 | F | Security scopes are missing in OpenAPI definition for GroupPolicyControlData. | 18.4.0 | +| 2023-12 | CT#102 | CP-233267 | 0468 | | F | Correcting the presence indicator of metadata attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233270 | 0469 | 1 | F | Incorrect feature name | 18.4.0 | +| 2023-12 | CT#102 | CP-233147 | 0470 | 2 | A | Correction of anyUeInd attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233247 | 0472 | 1 | F | EAS Deployment Data corrections | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0474 | 1 | B | Completion of LBO roaming information | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0475 | | F | Update of externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29520/raw.md b/raw/rel-18/29_series/29520/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..a5f0ee8f1e7a3bf001239af06670c8d77854a3d1 --- /dev/null +++ b/raw/rel-18/29_series/29520/raw.md @@ -0,0 +1,20188 @@ + + +# 3GPP TS 29.520 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Network Data Analytics Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a small red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. + +Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices + +# Keywords + +**3GPP** + +Postal address + +3GPP support office address +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + + +**3GPP** + +# Contents + +| | | +|----------------------------------------------------------------------|----| +| Foreword..... | 16 | +| 1 Scope..... | 17 | +| 2 References..... | 17 | +| 3 Definitions and abbreviations..... | 18 | +| 3.1 Definitions..... | 18 | +| 3.2 Abbreviations..... | 18 | +| 4 Services offered by the NWDAF..... | 19 | +| 4.1 Introduction..... | 19 | +| 4.2 Nnwdaf_EventsSubscription Service..... | 22 | +| 4.2.1 Service Description..... | 22 | +| 4.2.1.1 Overview..... | 22 | +| 4.2.1.2 Service Architecture..... | 23 | +| 4.2.1.3 Network Functions..... | 24 | +| 4.2.1.3.1 Network Data Analytics Function (NWDAF)..... | 24 | +| 4.2.1.3.2 NF Service Consumers..... | 24 | +| 4.2.2 Service Operations..... | 26 | +| 4.2.2.1 Introduction..... | 26 | +| 4.2.2.2 Nnwdaf_EventsSubscription_Subscribe service operation..... | 26 | +| 4.2.2.2.1 General..... | 26 | +| 4.2.2.2.2 Subscription for event notifications..... | 27 | +| 4.2.2.2.3 Update subscription for event notifications..... | 36 | +| 4.2.2.3 Nnwdaf_EventsSubscription_Unsubscribe service operation..... | 37 | +| 4.2.2.3.1 General..... | 37 | +| 4.2.2.3.2 Unsubscribe from event notifications..... | 37 | +| 4.2.2.4 Nnwdaf_EventsSubscription_Notify service operation..... | 38 | +| 4.2.2.4.1 General..... | 38 | + +# Copyright Notification + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +| | | | +|-----------|--------------------------------------------------------------|----| +| 4.2.2.4.2 | Notification about subscribed event..... | 38 | +| 4.2.2.5 | Nnwdaf_EventsSubscription_Transfer service operation..... | 40 | +| 4.2.2.5.1 | General..... | 40 | +| 4.2.2.5.2 | Creation of request for analytics subscription transfer..... | 41 | +| 4.2.2.5.3 | Update a request for analytics subscription transfer..... | 42 | +| 4.2.2.5.4 | Cancel a request for analytics subscription transfer..... | 43 | +| 4.3 | Nnwdaf_AnalyticsInfo Service..... | 44 | +| 4.3.1 | Service Description..... | 44 | +| 4.3.1.1 | Overview..... | 44 | +| 4.3.1.2 | Service Architecture..... | 44 | +| 4.3.1.3 | Network Functions..... | 45 | +| 4.3.1.3.1 | Network Data Analytics Function (NWDAF)..... | 45 | +| 4.3.1.3.2 | NF Service Consumers..... | 45 | +| 4.3.2 | Service Operations..... | 47 | +| 4.3.2.1 | Introduction..... | 47 | +| 4.3.2.2 | Nnwdaf_AnalyticsInfo_Request service operation..... | 47 | +| 4.3.2.2.1 | General..... | 47 | +| 4.3.2.2.2 | Request and get from NWDAF Analytics information..... | 47 | +| 4.3.2.3 | Nnwdaf_AnalyticsInfo_ContextTransfer service operation..... | 56 | +| 4.3.2.3.1 | General..... | 56 | +| 4.3.2.3.2 | Request and get from NWDAF context of a subscription..... | 57 | +| 4.4 | Nnwdaf_DataManagement Service..... | 58 | +| 4.4.1 | Service Description..... | 58 | +| 4.4.1.1 | Overview..... | 58 | +| 4.4.1.2 | Service Architecture..... | 58 | +| 4.4.1.3 | Network Functions..... | 59 | +| 4.4.1.3.1 | Network Data Analytics Function (NWDAF)..... | 59 | +| 4.4.1.3.2 | NF Service Consumers..... | 59 | +| 4.4.2 | Service Operations..... | 59 | +| 4.4.2.1 | Introduction..... | 59 | +| 4.4.2.2 | Nnwdaf_DataManagement_Subscribe service operation..... | 59 | +| 4.4.2.2.1 | General..... | 59 | +| 4.4.2.2.2 | Subscription for data notifications..... | 59 | +| 4.4.2.2.3 | Update subscription for data notifications..... | 61 | +| 4.4.2.3 | Nnwdaf_DataManagement_Unsubscribe service operation..... | 63 | + +| | | | +|-----------|------------------------------------------------------------|----| +| 4.4.2.3.1 | General..... | 63 | +| 4.4.2.3.2 | Unsubscribe from data notifications..... | 63 | +| 4.4.2.4 | Nnwdaf_DataManagement_Notify service operation..... | 64 | +| 4.4.2.4.1 | General..... | 64 | +| 4.4.2.4.2 | Notification about subscribed data..... | 64 | +| 4.4.2.5 | Nnwdaf_DataManagement_Fetch service operation..... | 65 | +| 4.4.2.5.1 | General..... | 65 | +| 4.4.2.5.2 | Retrieve data from the NWDAF..... | 65 | +| 4.5 | Nnwdaf_MLModelProvision Service..... | 66 | +| 4.5.1 | Service Description..... | 66 | +| 4.5.1.1 | Overview..... | 66 | +| 4.5.1.2 | Service Architecture..... | 66 | +| 4.5.1.3 | Network Functions..... | 67 | +| 4.5.1.3.1 | Network Data Analytics Function (NWDAF)..... | 67 | +| 4.5.1.3.2 | NF Service Consumers..... | 67 | +| 4.5.2 | Service Operations..... | 67 | +| 4.5.2.1 | Introduction..... | 67 | +| 4.5.2.2 | Nnwdaf_MLModelProvision_Subscribe service operation..... | 68 | +| 4.5.2.2.1 | General..... | 68 | +| 4.5.2.2.2 | Subscription for event notifications..... | 68 | +| 4.5.2.2.3 | Update subscription for event notifications..... | 69 | +| 4.5.2.3 | Nnwdaf_MLModelProvision_Unsubscribe service operation..... | 70 | +| 4.5.2.3.1 | General..... | 70 | +| 4.5.2.3.2 | Unsubscribe from event notifications..... | 70 | +| 4.5.2.4 | Nnwdaf_MLModelProvision_Notify service operation..... | 71 | +| 4.5.2.4.1 | General..... | 71 | +| 4.5.2.4.2 | Notification about subscribed event..... | 71 | +| 4.6 | Nnwdaf_MLModelTraining Service..... | 72 | +| 4.6.1 | Service Description..... | 72 | +| 4.6.1.1 | Overview..... | 72 | +| 4.6.1.2 | Service Architecture..... | 72 | +| 4.6.1.3 | Network Functions..... | 73 | +| 4.6.1.3.1 | Network Data Analytics Function (NWDAF)..... | 73 | +| 4.6.1.3.2 | NF Service Consumers..... | 73 | +| 4.6.2 | Service Operations..... | 73 | + +| | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|----| +| 4.6.2.1 | Introduction..... | 73 | +| 4.6.2.2 | Nnwdaf_MLModelTraining_Subscribe service operation..... | 74 | +| 4.6.2.2.1 | General..... | 74 | +| 4.6.2.2.2 | Subscription for event notifications..... | 74 | +| 4.6.2.2.3 | Update subscription for event notifications..... | 75 | +| 4.6.2.2.4 | Partial update subscription for event notifications..... | 76 | +| 4.6.2.3 | Nnwdaf_MLModelTraining_Unsubscribe service operation..... | 77 | +| 4.6.2.3.1 | General..... | 77 | +| 4.6.2.3.2 | Unsubscribe from event notifications..... | 77 | +| 4.6.2.4 | Nnwdaf_MLModelTraining_Notify service operation..... | 78 | +| 4.6.2.4.1 | General..... | 78 | +| 4.6.2.4.2 | Notification about subscribed event..... | 78 | +| Figure 4.6.2.4.2-1 shows a scenario where the NWDAF sends a request to the NF Service Consumer to notify for event notifications (see also 3GPP TS 23.288 [17])..... | | 78 | +| 4.7 | Nnwdaf_MLModelMonitor Service..... | 79 | +| 4.7.1 | Service Description..... | 79 | +| 4.7.1.1 | Overview..... | 79 | +| 4.7.1.2 | Service Architecture..... | 79 | +| 4.7.1.3 | Network Functions..... | 80 | +| 4.7.1.3.1 | Network Data Analytics Function (NWDAF)..... | 80 | +| 4.7.1.3.2 | NF Service Consumers..... | 80 | +| 4.7.2 | Service Operations..... | 80 | +| 4.7.2.1 | Introduction..... | 80 | +| 4.7.2.2 | Nnwdaf_MLModelMonitor_Register service operation..... | 80 | +| 4.7.2.2.1 | General..... | 80 | +| 4.7.2.2.2 | Registering the monitoring of the analytics accuracy of an ML Model..... | 80 | +| 4.7.2.3 | Nnwdaf_MLModelMonitor_Deregister service operation..... | 81 | +| 4.7.2.3.1 | General..... | 81 | +| 4.7.2.3.2 | Deregistering the monitoring of the analytics accuracy of an ML Model..... | 82 | +| 4.7.2.4 | Nnwdaf_MLModelMonitor_Subscribe service operation..... | 82 | +| 4.7.2.4.1 | General..... | 82 | +| 4.7.2.4.2 | Subscription for monitoring notifications..... | 82 | +| 4.7.2.4.3 | Update of subscription for monitoring notifications..... | 83 | +| 4.7.2.5 | Nnwdaf_MLModelMonitor_Unsubscribe service operation..... | 84 | +| 4.7.2.5.1 | General..... | 84 | + +| | | | +|-----------|----------------------------------------------------------|----| +| 4.7.2.5.2 | Unsubscribe from monitoring notifications..... | 84 | +| 4.7.2.6 | Nnwdaf_MLModelMonitor_Notify service operation..... | 85 | +| 4.7.2.6.1 | General..... | 85 | +| 4.7.2.6.2 | Notification about subscribed event..... | 85 | +| 4.8 | Nnwdaf_RoamingData Service..... | 86 | +| 4.8.1 | Service Description..... | 86 | +| 4.8.1.1 | Overview..... | 86 | +| 4.8.1.2 | Service Architecture..... | 86 | +| 4.8.1.3 | Network Functions..... | 87 | +| 4.8.1.3.1 | Network Data Analytics Function (NWDAF)..... | 87 | +| 4.8.1.3.2 | NF Service Consumers..... | 87 | +| 4.8.2 | Service Operations..... | 87 | +| 4.8.2.1 | Introduction..... | 87 | +| 4.8.2.2 | Nnwdaf_RoamingData_Subscribe service operation..... | 88 | +| 4.8.2.2.1 | General..... | 88 | +| 4.8.2.2.2 | Subscription for event notifications..... | 88 | +| 4.8.2.2.3 | Update of subscription for event notifications..... | 89 | +| 4.8.2.3 | Nnwdaf_RoamingData_Unsubscribe service operation..... | 89 | +| 4.8.2.3.1 | General..... | 89 | +| 4.8.2.3.2 | Unsubscribe from event notifications..... | 90 | +| 4.8.2.4 | Nnwdaf_RoamingData_Notify service operation..... | 90 | +| 4.8.2.4.1 | General..... | 90 | +| 4.8.2.4.2 | Notification about subscribed event..... | 90 | +| 4.9.1.2 | Service Architecture..... | 91 | +| 4.9.1.3 | Network Functions..... | 92 | +| 4.9.1.3.1 | Network Data Analytics Function (NWDAF)..... | 92 | +| 4.9.1.3.2 | NF Service Consumers..... | 92 | +| 4.9.2 | Service Operations..... | 93 | +| 4.9.2.1 | Introduction..... | 93 | +| 4.9.2.2 | Nnwdaf_RoamingAnalytics_Subscribe service operation..... | 93 | +| 4.9.2.2.1 | General..... | 93 | +| 4.9.2.2.2 | Subscription for event notifications..... | 93 | +| 4.9.2.4 | Nnwdaf_RoamingAnalytics_Notify service operation..... | 96 | +| 4.9.2.4.1 | General..... | 96 | +| 4.9.2.4.2 | Notification about subscribed event..... | 97 | + +| | | | +|-------------|-------------------------------------------------------------|-----| +| 5 | API Definitions..... | 98 | +| 5.1 | Nnwdaf_EventsSubscription Service API..... | 98 | +| 5.1.1 | Introduction..... | 98 | +| 5.1.2 | Usage of HTTP..... | 98 | +| 5.1.2.1 | General..... | 98 | +| 5.1.2.2 | HTTP standard headers..... | 98 | +| 5.1.2.2.1 | General..... | 98 | +| 5.1.2.2.2 | Content type..... | 98 | +| 5.1.2.3 | HTTP custom headers..... | 98 | +| 5.1.3 | Resources..... | 99 | +| 5.1.3.1 | Resource Structure..... | 99 | +| 5.1.3.2 | Resource: NWDAF Events Subscriptions..... | 99 | +| 5.1.3.2.1 | Description..... | 99 | +| 5.1.3.2.2 | Resource definition..... | 100 | +| 5.1.3.2.3 | Resource Standard Methods..... | 100 | +| 5.1.3.2.3.1 | POST..... | 100 | +| 5.1.3.2.4 | Resource Custom Operations..... | 101 | +| 5.1.3.3 | Resource: Individual NWDAF Event Subscription..... | 101 | +| 5.1.3.3.1 | Description..... | 101 | +| 5.1.3.3.2 | Resource definition..... | 101 | +| 5.1.3.3.3 | Resource Standard Methods..... | 101 | +| 5.1.3.3.3.1 | DELETE..... | 101 | +| 5.1.3.3.3.2 | PUT..... | 102 | +| 5.1.3.3.4 | Resource Custom Operations..... | 104 | +| 5.1.3.4 | Resource: NWDAF Event Subscription Transfers..... | 104 | +| 5.1.3.4.1 | Description..... | 104 | +| 5.1.3.4.2 | Resource definition..... | 104 | +| 5.1.3.4.3 | Resource Standard Methods..... | 104 | +| 5.1.3.4.3.1 | POST..... | 104 | +| 5.1.3.4.4 | Resource Custom Operations..... | 105 | +| 5.1.3.5 | Resource: Individual NWDAF Event Subscription Transfer..... | 105 | +| 5.1.3.5.1 | Description..... | 105 | +| 5.1.3.5.2 | Resource definition..... | 105 | +| 5.1.3.5.3 | Resource Standard Methods..... | 105 | +| 5.1.3.5.3.1 | DELETE..... | 105 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 5.1.3.5.3.2 | PUT..... | 107 | +| 5.1.3.5.4 | Resource Custom Operations..... | 108 | +| 5.1.4 | Custom Operations without associated resources..... | 108 | +| 5.1.5 | Notifications..... | 108 | +| 5.1.5.1 | General..... | 108 | +| 5.1.5.2 | Event Notification..... | 108 | +| 5.1.5.2.1 | Description..... | 108 | +| 5.1.5.2.2 | Operation Definition..... | 108 | +| 5.1.6 | Data Model..... | 109 | +| 5.1.6.1 | General..... | 109 | +| 5.1.6.2 | Structured data types..... | 119 | +| 5.1.6.2.1 | Introduction..... | 119 | +| 5.1.6.2.2 | Type NnwdafEventsSubscription..... | 120 | +| 5.1.6.2.3 | Type EventSubscription..... | 122 | +| 5.1.6.2.4 | Type NnwdafEventsSubscriptionNotification..... | 129 | +| 5.1.6.2.5 | Type EventNotification..... | 130 | +| 5.1.6.2.6 | Type SliceLoadLevelInformation..... | 133 | +| 5.1.6.2.7 | Type EventReportingRequirement..... | 134 | +| 5.1.6.2.8 | Type TargetUeInformation..... | 136 | +| 5.1.6.2.9 | Void..... | 137 | +| 5.1.6.2.10 | Type UeMobility..... | 137 | +| 5.1.6.2.11 | Type LocationInfo..... | 138 | +| 5.1.6.2.12 | Void..... | 139 | +| 5.1.6.2.13 | Type UeCommunication..... | 139 | +| 5.1.6.2.14 | Type TrafficCharacterization..... | 141 | +| 5.1.6.2.15 | Type AbnormalBehaviour..... | 142 | +| 5.1.6.2.16 | Type Exception..... | 142 | +| 5.1.6.2.17 | Type UserDataCongestionInfo..... | 143 | +| 5.1.6.2.18 | Type CongestionInfo..... | 143 | +| 5.1.6.2.19 | Type QosSustainabilityInfo..... | 144 | +| 5.1.6.2.20 | Type QosRequirement..... | 145 | +| 5.1.6.2.21 | Type RetainabilityThreshold..... | 145 | +| 5.1.6.2.22 | Type NetworkPerfRequirement..... | 146 | +| 5.1.6.2.23 | Type NetworkPerfInfo..... | 147 | +| 5.1.6.2.24 | Type ServiceExperienceInfo..... | 148 | + +| | | | +|------------|------------------------------------------|-----| +| 5.1.6.2.25 | Type BwRequirement..... | 150 | +| 5.1.6.2.26 | Type AdditionalMeasurement..... | 151 | +| 5.1.6.2.27 | Type IpEthFlowDescription..... | 151 | +| 5.1.6.2.28 | Type AddressList..... | 152 | +| 5.1.6.2.29 | Type CircumstanceDescription..... | 152 | +| 5.1.6.2.30 | Type ThresholdLevel..... | 153 | +| 5.1.6.2.31 | Type NfLoadLevelInformation..... | 155 | +| 5.1.6.2.32 | Type NfStatus..... | 155 | +| 5.1.6.2.33 | Type NsiIdInfo..... | 156 | +| 5.1.6.2.34 | Type NsiLoadLevelInfo..... | 157 | +| 5.1.6.2.35 | Type FailureEventInfo..... | 158 | +| 5.1.6.2.36 | Type AnalyticsMetadataIndication..... | 158 | +| 5.1.6.2.37 | Type AnalyticsMetadataInfo..... | 159 | +| 5.1.6.2.38 | Type NumberAverage..... | 159 | +| 5.1.6.2.39 | Type TopApplication..... | 159 | +| 5.1.6.2.40 | Type AnalyticsSubscriptionsTransfer..... | 159 | +| 5.1.6.2.41 | Type SubscriptionTransferInfo..... | 160 | +| 5.1.6.2.42 | Type ModelInfo..... | 160 | +| 5.1.6.2.43 | Type AnalyticsContextIdentifier..... | 160 | +| 5.1.6.2.44 | Type UeAnalyticsContextDescriptor..... | 161 | +| 5.1.6.2.45 | Type DnPerfInfo..... | 161 | +| 5.1.6.2.46 | Type DnPerf..... | 162 | +| 5.1.6.2.47 | Type PerfData..... | 163 | +| 5.1.6.2.48 | Type ResourceUsage..... | 164 | +| 5.1.6.2.49 | Type ConsumerNfInformation..... | 164 | +| 5.1.6.2.50 | Type DispersionRequirement..... | 164 | +| 5.1.6.2.51 | Type ClassCriterion..... | 165 | +| 5.1.6.2.52 | Type RankingCriterion..... | 165 | +| 5.1.6.2.53 | Type DispersionInfo..... | 165 | +| 5.1.6.2.54 | Type DispersionCollection..... | 166 | +| 5.1.6.2.55 | Type ApplicationVolume..... | 167 | +| 5.1.6.2.56 | Type RedundantTransmissionExpReq..... | 167 | +| 5.1.6.2.57 | Type RedundantTransmissionExpInfo..... | 168 | +| 5.1.6.2.58 | Type RedundantTransmissionExpPerTS..... | 168 | +| 5.1.6.2.59 | Type WlanPerformanceReq..... | 169 | + +| | | | +|------------|--------------------------------------|-----| +| 5.1.6.2.60 | Type WlanPerformanceInfo..... | 169 | +| 5.1.6.2.61 | Type WlanPerSsIdPerformanceInfo..... | 169 | +| 5.1.6.2.62 | Type WlanPerTsPerformanceInfo..... | 170 | +| 5.1.6.2.63 | Type TrafficInformation..... | 170 | +| 5.1.6.2.64 | Type AppListForUeComm..... | 171 | +| 5.1.6.2.65 | Type SessInactTimerForUeComm..... | 171 | +| 5.1.6.2.66 | Type DnPerformanceReq..... | 171 | +| 5.1.6.2.67 | Type: RatFreqInformation..... | 172 | +| 5.1.6.2.68 | Type PrevSubInfo..... | 172 | +| 5.1.6.2.69 | Type MLModelInfo..... | 173 | +| 5.1.6.2.70 | Type ObservedRedundantTransExp..... | 174 | +| 5.1.6.2.71 | Type UeMobilityReq..... | 176 | +| 5.1.6.2.72 | Type UeCommReq..... | 176 | +| 5.1.6.2.73 | Type PfdDeterminationInfo..... | 177 | +| 5.1.6.2.74 | Type PduSessionInfo..... | 177 | +| 5.1.6.2.75 | Type DirectionInfo..... | 178 | +| 5.1.6.2.76 | Type GeoDistributionInfo..... | 178 | +| 5.1.6.2.77 | Type PduSesTrafficInfo..... | 179 | +| 5.1.6.2.78 | Type TdTraffic..... | 179 | +| 5.1.6.2.79 | Type PduSesTrafficReq..... | 180 | +| 5.1.6.2.80 | Type WlanPerUeIdPerformanceInfo..... | 180 | +| 5.1.6.2.81 | Type ResourceUsageRequirement..... | 180 | +| 5.1.6.2.82 | Type E2eDataVolTransTimeReq..... | 181 | +| 5.1.6.2.83 | Type E2eDataVolTransTimeInfo..... | 182 | +| 5.1.6.2.84 | Type E2eDataVolTransTimePerTS..... | 182 | +| 5.1.6.2.85 | Type DataVolume..... | 182 | +| 5.1.6.2.86 | Type E2eDataVolTransTimePerUe..... | 183 | +| 5.1.6.2.87 | Type E2eDataVolTransTimeUeList..... | 184 | +| 5.1.6.2.88 | Type AccuracyReq..... | 185 | +| 5.1.6.2.89 | Type AccuracyInfo..... | 185 | +| 5.1.6.2.90 | Type DataVolumeTransferTime..... | 186 | +| 5.1.6.2.91 | Type MovBehavReq..... | 186 | +| 5.1.6.2.92 | Type MovBehavInfo..... | 186 | +| 5.1.6.2.93 | Type MovBehav..... | 187 | +| 5.1.6.2.94 | Type SpeedThresholdInfo..... | 187 | + +| | | | +|-------------|------------------------------------------------|-----| +| 5.1.6.2.95 | Type GeoLocation..... | 188 | +| 5.1.6.2.96 | Type LocAccuracyReq..... | 189 | +| 5.1.6.2.97 | Type LocAccuracyInfo..... | 190 | +| 5.1.6.2.98 | Type LocAccuracyPerMethod..... | 190 | +| 5.1.6.2.99 | Type RelProxReq..... | 191 | +| 5.1.6.2.100 | Type RelProxInfo..... | 191 | +| 5.1.6.2.101 | Type UeProximity..... | 192 | +| 5.1.6.2.102 | Type UeTrajectory..... | 192 | +| 5.1.6.2.103 | Type TimestampedLocation..... | 192 | +| 5.1.6.2.104 | Type TimeToCollisionInfo..... | 193 | +| 5.1.6.2.105 | Type AnalyticsFeedbackInfo..... | 193 | +| 5.1.6.2.106 | Type RoamingInfo..... | 194 | +| 5.1.6.3 | Simple data types and enumerations..... | 194 | +| 5.1.6.3.1 | Introduction..... | 194 | +| 5.1.6.3.2 | Simple data types..... | 194 | +| 5.1.6.3.3 | Enumeration: NotificationMethod..... | 195 | +| 5.1.6.3.4 | Enumeration: Nwdafevent..... | 196 | +| 5.1.6.3.5 | Enumeration: Accuracy..... | 196 | +| 5.1.6.3.6 | Enumeration: ExceptionId..... | 197 | +| 5.1.6.3.7 | Enumeration: ExceptionTrend..... | 197 | +| 5.1.6.3.8 | Enumeration: CongestionType..... | 197 | +| 5.1.6.3.9 | Enumeration: TimeUnit..... | 197 | +| 5.1.6.3.10 | Enumeration: NetworkPerfType..... | 198 | +| 5.1.6.3.11 | Enumeration: ExpectedAnalyticsType..... | 198 | +| 5.1.6.3.12 | Enumeration: MatchingDirection..... | 198 | +| 5.1.6.3.13 | Enumeration: NwdafeventFailureCode..... | 199 | +| 5.1.6.3.14 | Enumeration: AnalyticsMetadata..... | 199 | +| 5.1.6.3.15 | Enumeration: DatasetStatisticalProperty..... | 199 | +| 5.1.6.3.16 | Enumeration: OutputStrategy..... | 199 | +| 5.1.6.3.17 | Enumeration: TransferRequestType..... | 200 | +| 5.1.6.3.18 | Enumeration: AnalyticsSubset..... | 201 | +| 5.1.6.3.19 | Enumeration: DispersionType..... | 203 | +| 5.1.6.3.20 | Enumeration: DispersionClass..... | 203 | +| 5.1.6.3.21 | Enumeration: DispersionOrderingCriterion..... | 204 | +| 5.1.6.3.22 | Enumeration: RedTransExpOrderingCriterion..... | 204 | + +| | | | +|------------|------------------------------------------------|-----| +| 5.1.6.3.23 | Enumeration: WlanOrderingCriterion..... | 204 | +| 5.1.6.3.24 | Enumeration: ServiceExperienceType..... | 204 | +| 5.1.6.3.25 | Enumeration: DnPerfOrderingCriterion..... | 204 | +| 5.1.6.3.26 | Enumeration: TermCause..... | 205 | +| 5.1.6.3.27 | Enumeration: UserDataConOrderCrit..... | 205 | +| 5.1.6.3.28 | Enumeration: UeMobilityOrderCriterion..... | 205 | +| 5.1.6.3.29 | Enumeration: UeCommOrderCriterion..... | 205 | +| 5.1.6.3.30 | Enumeration: NetworkPerfOrderCriterion..... | 205 | +| 5.1.6.3.31 | Enumeration: DeviceType..... | 206 | +| 5.1.6.3.32 | Enumeration: LocInfoGranularity..... | 206 | +| 5.1.6.3.33 | Enumeration: TrafficDirection..... | 206 | +| 5.1.6.3.34 | Enumeration: ValueExpression..... | 206 | +| 5.1.6.3.35 | Enumeration: E2eDataVolTransTimeCriterion..... | 206 | +| 5.1.6.3.36 | Void..... | 207 | +| 5.1.6.3.37 | Enumeration: AnalyticsAccuracyIndication..... | 207 | +| 5.1.6.3.38 | Enumeration: LocationOrientation..... | 207 | +| 5.1.6.3.39 | Enumeration: Direction..... | 207 | +| 5.1.6.3.40 | Enumeration: ProximityCriterion..... | 207 | +| 5.1.7 | Error handling..... | 207 | +| 5.1.7.1 | General..... | 207 | +| 5.1.7.2 | Protocol Errors..... | 208 | +| 5.1.7.3 | Application Errors..... | 208 | +| 5.1.8 | Feature negotiation..... | 208 | +| 5.1.9 | Security..... | 211 | +| 5.2 | Nnwdaf_AnalyticsInfo Service API..... | 212 | +| 5.2.1 | Introduction..... | 212 | +| 5.2.2 | Usage of HTTP..... | 212 | +| 5.2.2.1 | General..... | 212 | +| 5.2.2.2 | HTTP standard headers..... | 212 | +| 5.2.2.2.1 | General..... | 212 | +| 5.2.2.2.2 | Content type..... | 212 | +| 5.2.2.3 | HTTP custom headers..... | 213 | +| 5.2.3 | Resources..... | 213 | +| 5.2.3.1 | Resource Structure..... | 213 | +| 5.2.3.2 | Resource: NWDAF Analytics..... | 213 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 5.2.3.2.1 | Description..... | 213 | +| 5.2.3.2.2 | Resource definition..... | 213 | +| 5.2.3.2.3 | Resource Standard Methods..... | 214 | +| 5.2.3.2.3.1 | GET..... | 214 | +| 5.2.3.2.4 | Resource Custom Operations..... | 214 | +| 5.2.3.3 | Resource: NWDAF Context..... | 215 | +| 5.2.3.3.1 | Description..... | 215 | +| 5.2.3.3.2 | Resource definition..... | 215 | +| 5.2.3.3.3 | Resource Standard Methods..... | 215 | +| 5.2.3.3.3.1 | GET..... | 215 | +| 5.2.4 | Custom Operations without associated resources..... | 215 | +| 5.2.5 | Notifications..... | 216 | +| 5.2.6 | Data Model..... | 216 | +| 5.2.6.1 | General..... | 216 | +| 5.2.6.2 | Structured data types..... | 222 | +| 5.2.6.2.1 | Introduction..... | 222 | +| 5.2.6.2.2 | Type AnalyticsData..... | 223 | +| 5.2.6.2.3 | Type EventFilter..... | 226 | +| 5.2.6.2.4 | Void..... | 231 | +| 5.2.6.2.5 | Type AdditionInfoAnalyticsInfoRequest..... | 231 | +| 5.2.6.2.6 | Type ContextData..... | 232 | +| 5.2.6.2.7 | Type ContextElement..... | 232 | +| 5.2.6.2.8 | Type ContextIdList..... | 233 | +| 5.2.6.2.9 | Type HistoricalData..... | 233 | +| 5.2.6.2.10 | Type SpecificAnalyticsSubscription..... | 234 | +| 5.2.6.2.11 | Type RequestedContext..... | 234 | +| 5.2.6.2.12 | Type SmcceInfo..... | 234 | +| 5.2.6.2.13 | Type SmcceUeList..... | 235 | +| 5.2.6.2.14 | Type SpecificDataSubscription..... | 235 | +| 5.2.6.2.15 | Type UserDataCongestReq..... | 236 | +| 5.2.6.2.16 | Type NetworkPerfReq..... | 236 | +| 5.2.6.2.17 | Type ResourceUsageRequPerNwPerfType..... | 236 | +| 5.2.6.3 | Simple data types and enumerations..... | 236 | +| 5.2.6.3.1 | Introduction..... | 236 | +| 5.2.6.3.2 | Simple data types..... | 236 | + +| | | | +|-------------|---------------------------------------------------------------------------------|-----| +| 5.2.6.3.3 | Enumeration: EventId..... | 237 | +| 5.2.6.3.4 | Enumeration: ContextType..... | 238 | +| 5.2.6.3.5 | Enumeration: AdrfDataType..... | 238 | +| 5.2.6.4 | Data types describing alternative data types or combinations of data types..... | 238 | +| 5.2.6.4.1 | Type ProblemDetailsAnalyticsInfoRequest..... | 238 | +| 5.2.7 | Error handling..... | 238 | +| 5.2.7.1 | General..... | 238 | +| 5.2.7.2 | Protocol Errors..... | 238 | +| 5.2.7.3 | Application Errors..... | 239 | +| 5.2.8 | Feature negotiation..... | 239 | +| 5.2.9 | Security..... | 242 | +| 5.3 | Nnwdaf_DataManagement Service API..... | 242 | +| 5.3.1 | Introduction..... | 242 | +| 5.3.2 | Usage of HTTP..... | 243 | +| 5.3.2.1 | General..... | 243 | +| 5.3.2.2 | HTTP standard headers..... | 243 | +| 5.3.2.2.1 | General..... | 243 | +| 5.3.2.2.2 | Content type..... | 243 | +| 5.3.2.3 | HTTP custom headers..... | 243 | +| 5.3.3 | Resources..... | 243 | +| 5.3.3.1 | Resource Structure..... | 243 | +| 5.3.3.2 | Resource: NWDAF Data Management Subscriptions..... | 244 | +| 5.3.3.2.1 | Description..... | 244 | +| 5.3.3.2.2 | Resource Definition..... | 244 | +| 5.3.3.2.3 | Resource Standard Methods..... | 245 | +| 5.3.3.2.3.1 | POST..... | 245 | +| 5.3.3.2.4 | Resource Custom Operations..... | 245 | +| 5.3.3.3 | Resource: Individual NWDAF Data Management Subscription..... | 245 | +| 5.3.3.3.1 | Description..... | 245 | +| 5.3.3.3.2 | Resource definition..... | 245 | +| 5.3.3.3.3 | Resource Standard Methods..... | 246 | +| 5.3.3.3.3.1 | PUT..... | 246 | +| 5.3.3.3.3.2 | DELETE..... | 247 | +| 5.3.3.3.4 | Resource Custom Operations..... | 248 | +| 5.3.4 | Custom Operations without associated resources..... | 248 | + +| | | | +|-------------|--------------------------------------------|-----| +| 5.3.5 | Notifications..... | 249 | +| 5.3.5.1 | General..... | 249 | +| 5.3.5.2 | Event Notification..... | 249 | +| 5.3.5.2.1 | Description..... | 249 | +| 5.3.5.2.2 | Operation Definition..... | 249 | +| 5.3.5.3 | Fetch Notification..... | 250 | +| 5.3.5.3.1 | Description..... | 250 | +| 5.3.5.3.2 | Target URI..... | 250 | +| 5.3.5.3.3 | Standard Methods..... | 250 | +| 5.3.5.3.3.1 | POST..... | 250 | +| 5.3.6 | Data Model..... | 251 | +| 5.3.6.1 | General..... | 251 | +| 5.3.6.2 | Structured data types..... | 253 | +| 5.3.6.2.1 | Introduction..... | 253 | +| 5.3.6.2.2 | Type NnwdafDataManagementSubsc..... | 254 | +| 5.3.6.2.3 | Type NnwdafDataManagementNotif..... | 257 | +| 5.3.6.3 | Simple data types and enumerations..... | 257 | +| 5.3.6.3.1 | Introduction..... | 257 | +| 5.3.6.3.2 | Simple data types..... | 258 | +| 5.3.6.3.3 | Enumeration: PendingNotificationCause..... | 258 | +| 5.3.7 | Error handling..... | 258 | +| 5.3.7.1 | General..... | 258 | +| 5.3.7.2 | Protocol Errors..... | 258 | +| 5.3.7.3 | Application Errors..... | 258 | +| 5.3.8 | Feature negotiation..... | 259 | +| 5.3.9 | Security..... | 259 | +| 5.4 | Nnwdaf_MLModelProvision Service API..... | 259 | +| 5.4.1 | Introduction..... | 259 | +| 5.4.2 | Usage of HTTP..... | 260 | +| 5.4.2.1 | General..... | 260 | +| 5.4.2.2 | HTTP standard headers..... | 260 | +| 5.4.2.2.1 | General..... | 260 | +| 5.4.2.2.2 | Content type..... | 260 | +| 5.4.2.3 | HTTP custom headers..... | 260 | +| 5.4.3 | Resources..... | 260 | + +| | | | +|-------------|-----------------------------------------------------------------|-----| +| 5.4.3.1 | Resource Structure..... | 260 | +| 5.4.3.2 | Resource: NWDAF ML Model Provision Subscriptions..... | 261 | +| 5.4.3.2.1 | Description..... | 261 | +| 5.4.3.2.2 | Resource definition..... | 261 | +| 5.4.3.2.3 | Resource Standard Methods..... | 261 | +| 5.4.3.2.3.1 | POST..... | 261 | +| 5.4.3.2.4 | Resource Custom Operations..... | 262 | +| 5.4.3.3 | Resource: Individual NWDAF ML Model Provision Subscription..... | 262 | +| 5.4.3.3.1 | Description..... | 262 | +| 5.4.3.3.2 | Resource definition..... | 262 | +| 5.4.3.3.3 | Resource Standard Methods..... | 262 | +| 5.4.3.3.3.1 | PUT..... | 262 | +| 5.4.3.3.3.2 | DELETE..... | 264 | +| 5.4.3.3.4 | Resource Custom Operations..... | 265 | +| 5.4.4 | Custom Operations without associated resources..... | 265 | +| 5.4.5 | Notifications..... | 265 | +| 5.4.5.1 | General..... | 265 | +| 5.4.5.2 | Event Notification..... | 265 | +| 5.4.5.2.1 | Description..... | 265 | +| 5.4.5.2.2 | Operation Definition..... | 266 | +| 5.4.6 | Data Model..... | 267 | +| 5.4.6.1 | General..... | 267 | +| 5.4.6.2 | Structured data types..... | 268 | +| 5.4.6.2.1 | Introduction..... | 268 | +| 5.4.6.2.2 | Type NwdafMLModelProvSubsc..... | 269 | +| 5.4.6.2.3 | Type MLEventSubscription..... | 270 | +| 5.4.6.2.4 | Void..... | 271 | +| 5.4.6.2.5 | Type NwdafMLModelProvNotif..... | 271 | +| 5.4.6.2.6 | Type MLEventNotif..... | 271 | +| 5.4.6.2.7 | Type FailureEventInfoForMLModel..... | 272 | +| 5.4.6.2.8 | Type MLModelAddr..... | 272 | +| 5.4.6.2.9 | Void..... | 272 | +| 5.4.6.2.10 | Void..... | 272 | +| 5.4.6.2.11 | Type MLRepEventCondition..... | 272 | +| 5.4.6.2.12 | Type InputDataInfo..... | 273 | + +| | | | +|-------------|----------------------------------------------------------------|-----| +| 5.4.6.2.13 | Type ModelProvisionParamsExt..... | 274 | +| 5.4.6.2.14 | Type AdditionalMLModelInformation..... | 275 | +| 5.4.6.2.15 | Type MLModelAdrf..... | 275 | +| 5.4.6.2.16 | Type TrainInputDataInfo..... | 276 | +| 5.4.6.2.17 | Type InferenceDataForModelTrain..... | 276 | +| 5.4.6.3 | Simple data types and enumerations..... | 276 | +| 5.4.6.3.1 | Introduction..... | 276 | +| 5.4.6.3.2 | Simple data types..... | 276 | +| 5.4.6.3.3 | Enumeration: FailureCode..... | 277 | +| 5.4.6.3.4 | Enumeration: MLModelMetric..... | 277 | +| 5.4.7 | Error handling..... | 277 | +| 5.4.7.1 | General..... | 277 | +| 5.4.7.2 | Protocol Errors..... | 277 | +| 5.4.7.3 | Application Errors..... | 277 | +| 5.4.8 | Feature negotiation..... | 278 | +| 5.4.9 | Security..... | 278 | +| 5.5 | Nnwdaf_MLModelTraining Service API..... | 278 | +| 5.5.1 | Introduction..... | 278 | +| 5.5.2 | Usage of HTTP..... | 279 | +| 5.5.2.1 | General..... | 279 | +| 5.5.2.2 | HTTP standard headers..... | 279 | +| 5.5.2.2.1 | General..... | 279 | +| 5.5.2.2.2 | Content type..... | 279 | +| 5.5.2.3 | HTTP custom headers..... | 279 | +| 5.5.3 | Resources..... | 279 | +| 5.5.3.1 | Resource Structure..... | 279 | +| 5.5.3.2 | Resource: NWDAF ML Model Training Subscriptions..... | 280 | +| 5.5.3.2.1 | Description..... | 280 | +| 5.5.3.2.2 | Resource definition..... | 280 | +| 5.5.3.2.3 | Resource Standard Methods..... | 280 | +| 5.5.3.2.3.1 | POST..... | 280 | +| 5.5.3.2.4 | Resource Custom Operations..... | 281 | +| 5.5.3.3 | Resource: Individual NWDAF ML Model Training Subscription..... | 281 | +| 5.5.3.3.1 | Description..... | 281 | +| 5.5.3.3.2 | Resource definition..... | 281 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 5.5.3.3.3 | Resource Standard Methods..... | 281 | +| 5.5.3.3.3.1 | PUT..... | 281 | +| 5.5.3.3.3.2 | PATCH..... | 282 | +| 5.5.3.3.3.3 | DELETE..... | 283 | +| 5.5.3.3.4 | Resource Custom Operations..... | 284 | +| 5.5.4 | Custom Operations without associated resources..... | 284 | +| 5.5.5 | Notifications..... | 285 | +| 5.5.5.1 | General..... | 285 | +| 5.5.5.2 | Event Notification..... | 285 | +| 5.5.5.2.1 | Description..... | 285 | +| 5.5.5.2.2 | Operation Definition..... | 285 | +| 5.5.6 | Data Model..... | 286 | +| 5.5.6.1 | General..... | 286 | +| 5.5.6.2 | Structured data types..... | 288 | +| 5.5.6.2.1 | Introduction..... | 288 | +| 5.5.6.2.2 | Type NwdafMLModelTrainSubsc..... | 289 | +| 5.5.6.2.3 | Type NwdafMLModelTrainSubscPatch..... | 291 | +| 5.5.6.2.5 | Type MLModelTrainInfo..... | 292 | +| 5.5.6.2.6 | Type MLTrainReportInfo..... | 292 | +| 5.5.6.2.7 | Type FailureEventInfoForMLModelTrain..... | 292 | +| 5.5.6.2.8 | Type NwdafMLModelTrainNotif..... | 293 | +| 5.5.6.2.9 | Void..... | 294 | +| 5.5.6.2.10 | Type DataAvReq..... | 294 | +| 5.5.6.2.11 | Type DelayEventNotif..... | 294 | +| 5.5.6.2.12 | Type StatusReportInfo..... | 294 | +| 5.5.6.2.13 | Type TrainDataInfo..... | 295 | +| 5.5.6.3 | Simple data types and enumerations..... | 295 | +| 5.5.6.3.1 | Introduction..... | 295 | +| 5.5.6.3.2 | Simple data types..... | 295 | +| 5.5.6.3.3 | Enumeration: FailureCodeTrain..... | 295 | +| 5.5.6.3.4 | Enumeration: TermTrainCause..... | 296 | +| 5.5.6.3.5 | Enumeration: DelayCause..... | 296 | +| 5.5.7 | Error handling..... | 296 | +| 5.5.7.1 | General..... | 296 | +| 5.5.7.2 | Protocol Errors..... | 296 | + +| | | | +|-------------|------------------------------------------------------------------|-----| +| 5.5.7.3 | Application Errors..... | 296 | +| 5.5.8 | Feature negotiation..... | 297 | +| 5.5.9 | Security..... | 297 | +| 5.6 | Nnwdaf_MLModelMonitor Service API..... | 297 | +| 5.6.1 | Introduction..... | 297 | +| 5.6.2 | Usage of HTTP..... | 298 | +| 5.6.2.1 | General..... | 298 | +| 5.6.2.2 | HTTP standard headers..... | 298 | +| 5.6.2.2.1 | General..... | 298 | +| 5.6.2.2.2 | Content type..... | 298 | +| 5.6.2.3 | HTTP custom headers..... | 298 | +| 5.6.3 | Resources..... | 298 | +| 5.6.3.1 | Resource Structure..... | 298 | +| 5.6.3.2 | Resource: NWDAF ML model monitoring registrations..... | 299 | +| 5.6.3.2.1 | Description..... | 299 | +| 5.6.3.2.2 | Resource Definition..... | 299 | +| 5.6.3.2.3 | Resource Standard Methods..... | 300 | +| 5.6.3.2.3.1 | POST..... | 300 | +| 5.6.3.2.4 | Resource Custom Operations..... | 300 | +| 5.6.3.3 | Resource: Individual NWDAF ML model monitoring registration..... | 300 | +| 5.6.3.3.1 | Description..... | 300 | +| 5.6.3.3.2 | Resource definition..... | 301 | +| 5.6.3.3.3 | Resource Standard Methods..... | 301 | +| 5.6.3.3.3.1 | DELETE..... | 301 | +| 5.6.3.3.4 | Resource Custom Operations..... | 302 | +| 5.6.3.4 | Resource: NWDAF ML model monitoring Subscriptions..... | 302 | +| 5.6.3.4.1 | Description..... | 302 | +| 5.6.3.4.2 | Resource Definition..... | 302 | +| 5.6.3.4.3 | Resource Standard Methods..... | 302 | +| 5.6.3.4.3.1 | POST..... | 302 | +| 5.6.3.4.4 | Resource Custom Operations..... | 303 | +| 5.6.3.5 | Resource: Individual NWDAF ML model monitoring Subscription..... | 303 | +| 5.6.3.5.1 | Description..... | 303 | +| 5.6.3.5.2 | Resource definition..... | 303 | +| 5.6.3.5.3 | Resource Standard Methods..... | 304 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 5.6.3.5.3.1 | PUT..... | 304 | +| 5.6.3.5.3.2 | DELETE..... | 305 | +| 5.6.3.5.4 | Resource Custom Operations..... | 306 | +| 5.6.4 | Custom Operations without associated resources..... | 306 | +| 5.6.5 | Notifications..... | 306 | +| 5.6.5.1 | General..... | 306 | +| 5.6.5.2 | Event Notification..... | 306 | +| 5.6.5.2.1 | Description..... | 306 | +| 5.6.5.2.2 | Operation Definition..... | 306 | +| 5.6.6 | Data Model..... | 308 | +| 5.6.6.1 | General..... | 308 | +| 5.6.6.2 | Structured data types..... | 308 | +| 5.6.6.2.1 | Introduction..... | 308 | +| 5.6.6.2.2 | Type MLModelMonitorReg..... | 309 | +| 5.6.6.2.3 | Type MLModelMonitorSub..... | 310 | +| 5.6.6.2.4 | Type MLModelMonitorNotify..... | 311 | +| 5.6.6.2.5 | Type MLModelAccuracyInfo..... | 311 | +| 5.6.6.2.6 | Type AnalyticsFeedback..... | 312 | +| 5.6.7 | Error handling..... | 312 | +| 5.6.7.1 | General..... | 312 | +| 5.6.7.2 | Protocol Errors..... | 312 | +| 5.6.7.3 | Application Errors..... | 312 | +| 5.6.8 | Feature negotiation..... | 312 | +| 5.6.9 | Security..... | 313 | +| 5.7 | Nnwdaf_RoamingData Service API..... | 313 | +| 5.7.1 | Introduction..... | 313 | +| 5.7.2 | Usage of HTTP..... | 313 | +| 5.7.2.1 | General..... | 313 | +| 5.7.2.2 | HTTP standard headers..... | 313 | +| 5.7.2.2.1 | General..... | 313 | +| 5.7.2.2.2 | Content type..... | 313 | +| 5.7.2.3 | HTTP custom headers..... | 314 | +| 5.7.3 | Resources..... | 314 | +| 5.7.3.1 | Resource Structure..... | 314 | +| 5.7.3.2 | Resource: NWDAF Roaming Data Subscriptions..... | 314 | + +| | | | +|-------------|-----------------------------------------------------------|-----| +| 5.7.3.2.1 | Description..... | 314 | +| 5.7.3.2.2 | Resource Definition..... | 315 | +| 5.7.3.2.3 | Resource Standard Methods..... | 315 | +| 5.7.3.2.3.1 | POST..... | 315 | +| 5.7.3.2.4 | Resource Custom Operations..... | 315 | +| 5.7.3.3 | Resource: Individual NWDAF Roaming Data Subscription..... | 316 | +| 5.7.3.3.1 | Description..... | 316 | +| 5.7.3.3.2 | Resource definition..... | 316 | +| 5.7.3.3.3 | Resource Standard Methods..... | 316 | +| 5.7.3.3.3.1 | PUT..... | 316 | +| 5.7.3.3.3.2 | DELETE..... | 317 | +| 5.7.3.3.4 | Resource Custom Operations..... | 318 | +| 5.7.4 | Custom Operations without associated resources..... | 318 | +| 5.7.5 | Notifications..... | 319 | +| 5.7.5.1 | General..... | 319 | +| 5.7.5.2 | Event Notification..... | 319 | +| 5.7.5.2.1 | Description..... | 319 | +| 5.7.5.2.2 | Operation Definition..... | 319 | +| 5.7.6 | Data Model..... | 320 | +| 5.7.6.1 | General..... | 320 | +| 5.7.6.2 | Structured data types..... | 321 | +| 5.7.6.2.1 | Introduction..... | 321 | +| 5.7.6.2.2 | Type RoamingDataSub..... | 322 | +| 5.7.7 | Error handling..... | 323 | +| 5.7.7.1 | General..... | 323 | +| 5.7.7.2 | Protocol Errors..... | 323 | +| 5.7.7.3 | Application Errors..... | 323 | +| 5.7.8 | Feature negotiation..... | 323 | +| 5.7.9 | Security..... | 323 | +| 5.8 | Nnwdaf_RoamingAnalytics Service API..... | 324 | +| 5.8.1 | Introduction..... | 324 | +| 5.8.2 | Usage of HTTP..... | 324 | +| 5.8.2.1 | General..... | 324 | +| 5.8.2.2 | HTTP standard headers..... | 324 | +| 5.8.2.2.1 | General..... | 324 | + +| | | | +|-----------|----------------------------------------------------------------|-----| +| 5.8.2.2.2 | Content type..... | 324 | +| 5.8.2.3 | HTTP custom headers..... | 324 | +| 5.8.3 | Resources..... | 325 | +| 5.8.3.1 | Resource Structure..... | 325 | +| 5.8.3.2 | Resource: NWDAF Roaming Analytics Subscriptions..... | 325 | +| 5.8.3.2.1 | Description..... | 325 | +| 5.8.3.2.2 | Resource Definition..... | 325 | +| 5.8.3.2.3 | Resource Standard Methods..... | 326 | +| 5.8.3.2.4 | Resource Custom Operations..... | 326 | +| 5.8.3.3 | Resource: Individual NWDAF Roaming Analytics Subscription..... | 327 | +| 5.8.3.3.1 | Description..... | 327 | +| 5.8.3.3.2 | Resource definition..... | 327 | +| 5.8.3.3.3 | Resource Standard Methods..... | 327 | +| 5.8.3.3.4 | Resource Custom Operations..... | 330 | +| 5.8.4 | Custom Operations without associated resources..... | 330 | +| 5.8.5 | Notifications..... | 330 | +| 5.8.5.1 | General..... | 330 | +| 5.8.5.2 | Roaming Analytics Notification..... | 330 | +| 5.8.5.2.1 | Description..... | 330 | +| 5.8.5.2.2 | Operation Definition..... | 330 | +| 5.8.6 | Data Model..... | 331 | +| 5.8.6.1 | General..... | 331 | +| 5.8.6.2 | Structured data types..... | 332 | +| 5.8.6.2.1 | Introduction..... | 332 | +| 5.8.6.2.2 | Type RoamingAnalyticsSubscription..... | 333 | +| 5.8.6.2.3 | Type RoamingAnalyticsNotification..... | 334 | +| 5.8.7 | Error handling..... | 334 | +| 5.8.7.1 | General..... | 334 | +| 5.8.7.2 | Protocol Errors..... | 334 | +| 5.8.7.3 | Application Errors..... | 334 | +| 5.8.8 | Feature negotiation..... | 334 | +| 5.8.9 | Security..... | 335 | + +| | | +|--------------------------------------------------------|------------| +| Annex A (normative): OpenAPI specification..... | 336 | +| A.1 General..... | 336 | +| A.2 Nnwdaf_EventsSubscription API..... | 336 | +| A.3 Nnwdaf_AnalyticsInfo API..... | 388 | +| A.4 Nnwdaf_DataManagement API..... | 400 | +| A.5 Nnwdaf_MLModelProvision API..... | 405 | +| A.6 Nnwdaf_MLModelTraining API..... | 412 | +| A.7 Nnwdaf_MLModelMonitor API..... | 420 | +| A.8 Nnwdaf_RoamingData API..... | 426 | +| Annex B (informative): Change history..... | 434 | + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd 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. + +# 1 Scope + +The present specification provides the stage 3 definition of the Network Data Analytics Function Services of the 5G System. + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The stage 2 definition and related procedures for Network Data Analytics Function Services are specified in 3GPP TS 23.288 [17] and 3GPP TS 23.503 [4]. + +The 5G System stage 3 call flows are provided in 3GPP TS 29.552 [25] and 3GPP TS 29.513 [5]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [6] and 3GPP TS 29.501 [7]. + +The Network Data Analytics Function Services are provided by the Network Data Analytics Function (NWDAF). + +# 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.501: "System Architecture for the 5G System; Stage 2". +- [3] Void. +- [4] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [5] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [6] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [7] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [8] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [9] IETF RFC 9113: "HTTP/2". +- [10] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [11] OpenAPI: "OpenAPI Specification Version 3.0.0", +- [12] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [13] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [14] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [15] IETF RFC 9457: "Problem Details for HTTP APIs". +- [16] 3GPP TR 21.900: "Technical Specification Group working methods". +- [17] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". + +- [18] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". +- [19] 3GPP TS 29.122: "T8 reference point for Northbound APIs". +- [20] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [21] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [22] 3GPP TS 29.517: "5G System; Application Function (AF) event exposure service". +- [23] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [24] 3GPP TS 29.531: "5G System; Network Slice Selection Services; Stage 3". +- [25] 3GPP TS 29.552: "5G System; Network Data Analytics signalling flows; Stage 3". +- [26] 3GPP TS 29.574: "5G System; Data Collection Coordination Services; Stage 3". +- [27] 3GPP TS 29.575: "5G System; Analytics Data Repository Services; Stage 3". +- [28] 3GPP TS 29.576: "5G System; Messaging Framework Adaptor Services; Stage 3". +- [29] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [30] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". +- [31] IANA: "SMI Network Management Private Enterprise Codes", . +- [32] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [33] IETF RFC 6733: "Diameter Base Protocol". + +--- + +## 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]. + +| | | +|-------|------------------------------------------| +| 5QI | 5G QoS Identifier | +| ADRF | Analytics Data Repository Function | +| AF | Application Function | +| AI/ML | Artificial Intelligence/Machine Learning | +| AMF | Access and Mobility Management Function | +| AOI | Area of Interest | +| API | Application Programming Interface | +| CEF | Charging Enablement Function | +| DCCF | Data Collection Coordination Function | +| DNN | Data Network Name | +| FL | Federated Learning | +| GFBR | Guaranteed Flow Bit Rate | +| GMLC | Gateway Mobile Location Centre | +| HTTP | Hypertext Transfer Protocol | + +| | | +|---------|-------------------------------------------------------| +| JSON | JavaScript Object Notation | +| LADN | Local Area Data Network | +| LMF | Location Management Function | +| MFAF | Messaging Framework Adaptor Function | +| ML | Machine Learning | +| MTLF | Model Training Logical Function | +| NEF | Network Exposure Function | +| NF | Network Function | +| NLOS | Non Line Of Sight | +| NRF | Network Repository Function | +| NSSF | Network Slice Selection Function | +| NWDAF | Network Data Analytics Function | +| OAM | Operation, Administration, and Maintenance | +| PCF | Policy Control Function | +| PFD | Packet Flow Description | +| PFDf | Packet Flow Description Function | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SMCC | Session Management Congestion Control | +| SMCCE | Session Management Congestion Control Experience | +| SMF | Session Management Function | +| SSC | Session and Service Continuity | +| SUPI | Subscription Permanent Identifier | +| UDM | Unified Data Management | +| UPF | User Plane Function | +| URI | Uniform Resource Identifier | +| URSP | UE Route Selection Policy | +| UTC | Universal Time Coordinated | + +## 4 Services offered by the NWDAF + +### 4.1 Introduction + +The Nnwdaf services are used by the NWDAF to provide specific analytics information and ML models. + +Analytics information is either statistical information of past events, or predictive information. + +The following services are specified for the NWDAF: + +**Table 4.1-1: Services provided by NWDAF** + +| Service Name | Description | Service Operations | Operation Semantics | Example Consumer(s) | +|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|---------------------|----------------------------------------------------------| +| Nnwdaf_EventsSubscription (NOTE 1) | This service enables the NF service consumers to subscribe to/unsubscribe from notifications for different analytics information from the NWDAF. It also enables the transfer of subscriptions between NWDAFs | Subscribe | Subscribe / Notify | PCF, NSSF, AMF, SMF, NEF, AF, LMF, OAM, CEF, NWDAF, DCCF | +| | | Unsubscribe | | | +| | | Notify | | | +| | | Transfer | Request / Response | NWDAF | +| Nnwdaf_AnalyticsInfo | This service enables the NF service consumers to request and get specific analytics or context information related to analytics | Request | Request / Response | PCF, NSSF, AMF, SMF, NEF, AF, LMF, OAM, NWDAF, DCCF | +| | | ContextTransfer | Request / Response | NWDAF | + +| | | | | | | +|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|--------------------|------------------------|--| +| | subscriptions from the | | | | | +| Nnwdaf_DataManagement | This service enables the NF service consumers to subscribe to/unsubscribe from notifications when subscribed event(s) are detected or retrieve the subscribed data from the NWDAF. | Subscribe | Subscribe / Notify | NWDAF, DCCF, MFAF | | +| | | Unsubscribe | | | | +| | | Notify | | | | +| | | Fetch | Request / Response | NWDAF, DCCF, MFAF | | +| Nnwdaf_MLModelProvision (NOTE 2) | This service enables the NF service consumers to subscribe to/unsubscribe from notifications when a ML model matching the subscription parameters becomes available. | Subscribe | Subscribe / Notify | NWDAF | | +| | | Unsubscribe | | | | +| | | Notify | | | | +| Nnwdaf_MLModelTraining (NOTE 3) | This service enables the NF service consumers to subscribe to/unsubscribe/modify from notifications for a ML model training. | Subscribe | Subscribe / Notify | NWDAF | | +| | | Unsubscribe | | | | +| | | Notify | | | | +| Nnwdaf_MLModelMonitor | This service enables the NF service consumer to subscribe/unsubscribe for ML model accuracy, provide Analytics feedback information for the analytics generated by an NWDAF and enable the NWDAF containing AnLF registers the use and monitoring capability for an ML model into the model provider NWDAF | Subscribe | Subscribe / Notify | NWDAF | | +| | | Unsubscribe | | | | +| | | Notify | | | | +| | | Register | Request / Response | | | +| | | Deregister | | | | +| Nnwdaf_RoamingData | This service enables the consumer to subscribe/unsubscribe for input data related to roaming UE(s) for NWDAF analytics. | Subscribe | Subscribe / Notify | H-RE-NWDAF, V-RE-NWDAF | | +| | | Unsubscribe | | | | +| | | Notify | | | | +| Nnwdaf_RoamingAnalytics | This service enables the NF service | Subscribe (NOTE 4) | Subscribe / Notify | H-RE-NWDAF, V-RE-NWDAF | | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|--| +| consumers to subscribe (or modify subscriptions) to and unsubscribe from notifications for network data analytics related to roaming UE(s). | Unsubscribe | | +| | Notify | | +| NOTE 1: This service corresponds to the Nnwdaf_AnalyticsSubscription service defined in 3GPP TS 23.288 [17].
NOTE 2: This service implements also the Nnwdaf_MLModelInfo service as specified in 3GPP TS 23.288 [17] by using immediate and one-time reporting requirement.
NOTE 3: This service implements also the Nnwdaf_MLModelTrainingInfo service as specified in 3GPP TS 23.288 [17] by using immediate and one-time reporting requirement.
NOTE 4: The Nnwdaf_RoamingAnalytics_Subscribe service operation implements also the Nnwdaf_RoamingAnalytics_Request service operation specified in 3GPP TS 23.288 [17] by using immediate and one-time reporting requirement. | | | + +Table 4.1-2 summarizes the corresponding APIs defined in this specification. + +**Table 4.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------------|--------|--------------------------------------|----------------------------------------|---------------------------|-------| +| Nnwdaf_EventsSubscription | 5.1 | Nnwdaf Events Subscription Service. | TS29520_Nnwdaf_EventsSubscription.yaml | nnwdaf-eventssubscription | A.2 | +| Nnwdaf_AnalyticsInfo | 5.2 | Nnwdaf Analytics Information Service | TS29520_Nnwdaf_AnalyticsInfo.yaml | nnwdaf-analyticsinfo | A.3 | +| Nnwdaf_DataManagement | 5.3 | NWDAF Data Management Service | TS29520_Nnwdaf_DataManagement.yaml | nnwdaf-datamanagement | A.4 | +| Nnwdaf_MLModelProvision | 5.4 | NWDAF ML Model Provision Service | TS29520_Nnwdaf_MLModelProvision.yaml | nnwdaf-mlmodelprovision | A.5 | +| Nnwdaf_MLModelTraining | 5.5 | NWDAF ML Model Training Service | TS29520_Nnwdaf_MLModelTraining.yaml | nnwdaf-mlmodeltraining | A.6 | +| Nnwdaf_MLModelMonitor | 5.6 | NWDAF ML model monitoring Service | TS29520_Nnwdaf_MLModelMonitoring.yaml | nnwdaf-mlmodelmonitor | A.7 | +| Nnwdaf_RoamingData | 5.7 | NWDAF Roaming Data Service | TS29520_Nnwdaf_RoamingData.yaml | nnwdaf-roamingdata | A.8 | +| Nnwdaf_RoamingAnalytics | 5.8 | NWDAF Roaming Analytics service | TS29520_Nnwdaf_RoamingAnalytics.yaml | nnwdaf-roaminganalytics | A.9 | + +## 4.2 Nnwdaf\_EventsSubscription Service + +### 4.2.1 Service Description + +#### 4.2.1.1 Overview + +The Nnwdaf\_EventsSubscription service corresponding to Nnwdaf\_AnalyticsSubscription service as defined in 3GPP TS 23.501 [2], 3GPP TS 23.288 [17] and 3GPP TS 23.503 [4], is provided by the Network Data Analytics Function (NWDAF). + +This service: + +- allows NF service consumers to subscribe to and unsubscribe from different analytics events; +- notifies NF service consumers with a corresponding subscription about observed events. and +- allows NF service consumers to request the transfer of subscriptions for analytics events. + +The types of observed events include: + +- Slice load level information; +- Network slice instance load level information; +- Service experience; +- NF load; +- Network performance; +- Abnormal behaviour; +- UE mobility; +- UE communication; +- User data congestion; +- QoS sustainability; +- Dispersion; +- Redundant transmission experience; +- SM congestion control experience; +- WLAN performance; +- DN performance; +- PFD determination; +- PDU Session traffic. +- Movement Behaviour; +- Location Accuracy; +- Relative Proximity. + +#### 4.2.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [17]. The Network Data Analytics signalling flows are defined in 3GPP TS 29.552 [25], the Policy and Charging related 5G architecture is also described in 3GPP TS 23.503 [4] and 3GPP TS 29.513 [5]. + +The Nnwdaf\_EventsSubscription service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF). + +Known consumers of the Nnwdaf\_EventsSubscription service are: + +- Policy Control Function (PCF) +- Network Slice Selection Function (NSSF) +- Access and Mobility Management Function (AMF) +- Session Management Function (SMF) +- Network Exposure Function (NEF) +- Application Function (AF) +- Location Management Function (LMF) +- Operation, Administration, and Maintenance (OAM) +- Charging Enablement Function (CEF) +- Network Data Analytics Function (NWDAF) +- Data Collection Coordination Function (DCCF) + +The PCF accesses the Nnwdaf\_EventsSubscription service at the NWDAF via the N23 Reference point. The NSSF accesses the Nnwdaf\_EventsSubscription service at the NWDAF via the N34 Reference point. + +![Reference Architecture for the Nnwdaf_EventsSubscription Service; SBI representation diagram](ca5dc5fde2061d0ca2051ef7840fc842_img.jpg) + +The diagram illustrates the Service Based Interface (SBI) representation for the Nnwdaf\_EventsSubscription service. At the top, a box labeled 'NWDAF' contains an oval labeled 'Nnwdaf'. A vertical line descends from this oval to a horizontal bus line. Above the bus line, the text 'Nnwdaf\_EventsSubscription' is displayed. Below the bus line, eleven rectangular boxes are arranged horizontally, representing various network functions that consume the service. From left to right, they are: PCF, NSSF, AMF, SMF, NEF, DCCF, AF, OAM, CEF, LMF, and NWDAF. Each of these boxes is connected to the horizontal bus line by a vertical line. + +Reference Architecture for the Nnwdaf\_EventsSubscription Service; SBI representation diagram + +**Figure 4.2.1.2-1: Reference Architecture for the Nnwdaf\_EventsSubscription Service; SBI representation** + +![Figure 4.2.1.2-2: Reference Architecture for the Nnwdaf_EventsSubscription Service: reference point representation. The diagram shows a central NWDAF box at the top connected to eleven boxes below it. The boxes below are PCF, NSSF, AMF, SMF, NEF, DCCF, AF, OAM, CEF, LMF, and NWDAF. Lines connect the top NWDAF to each of these boxes. The first two lines are labeled N23 and N34 respectively.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +``` + +graph TD + NWDAF_top[NWDAF] -- N23 --> PCF[PCF] + NWDAF_top -- N34 --> NSSF[NSSF] + NWDAF_top --> AMF[AMF] + NWDAF_top --> SMF[SMF] + NWDAF_top --> NEF[NEF] + NWDAF_top --> DCCF[DCCF] + NWDAF_top --> AF[AF] + NWDAF_top --> OAM[OAM] + NWDAF_top --> CEF[CEF] + NWDAF_top --> LMF[LMF] + NWDAF_top --> NWDAF_bottom[NWDAF] + +``` + +Figure 4.2.1.2-2: Reference Architecture for the Nnwdaf\_EventsSubscription Service: reference point representation. The diagram shows a central NWDAF box at the top connected to eleven boxes below it. The boxes below are PCF, NSSF, AMF, SMF, NEF, DCCF, AF, OAM, CEF, LMF, and NWDAF. Lines connect the top NWDAF to each of these boxes. The first two lines are labeled N23 and N34 respectively. + +**Figure 4.2.1.2-2: Reference Architecture for the Nnwdaf\_EventsSubscription Service: reference point representation** + +NOTE: When the NEF subscribes the PFD Determination Analytics to the NWDAF, the NEF needs to support PFD function as NEF (PFD). + +#### 4.2.1.3 Network Functions + +##### 4.2.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF) provides analytics information for different analytics events to NF service consumers. + +The Network Data Analytics Function (NWDAF) allows NF service consumers to subscribe to and unsubscribe from one-time, periodic notification or notification when an event is detected. + +The Network Data Analytics Function (NWDAF) allows NF service consumers to request the transfer of subscriptions for analytics events. + +##### 4.2.1.3.2 NF Service Consumers + +The Policy Control Function (PCF): + +- supports (un)subscription to the notification of analytics information for slice load level information from the NWDAF; +- supports (un)subscription to the notification of analytics information for service experience related network data from the NWDAF; +- supports (un)subscription to the notification of analytics information for network performance from the NWDAF; +- supports (un)subscription to the notification of analytics information for abnormal UE behaviour from the NWDAF; +- supports (un)subscription to the notification of analytics information for UE mobility from the NWDAF; +- supports (un)subscription to the notification of analytics information for UE communication from the NWDAF; +- supports (un)subscription to the notification of analytics information for user data congestion from the NWDAF; +- supports (un)subscription to the notification of analytics information for dispersion from the NWDAF; +- supports (un)subscription to the notification of analytics information for session management congestion control experience from the NWDAF; +- supports (un)subscription to the notification of analytics information for redundant transmission experience from the NWDAF; +- supports (un)subscription to the notification of analytics information for DN performance from the NWDAF; +- supports (un)subscription to the notification of analytics information for WLAN performance from the NWDAF; +- supports (un)subscription to the notification of analytics information for PDU Session traffic from the NWDAF; and +- supports taking one or more above input from the NWDAF into consideration for policies on assignment of network resources and/or for traffic steering policies. + +NOTE: How this information is used by the PCF is not standardized in this specification. + +The Network Slice Selection Function (NSSF): + +- supports (un)subscription to the notification of analytics information for slice load level information or network slice instance load level information from the NWDAF to determine slice selection; + +- supports (un)subscription to the notification of analytics information for service experience related network data from the NWDAF; and +- supports (un)subscription to the notification of analytics information for dispersion at the slice from the NWDAF. + +The Access and Mobility Management Function (AMF): + +- supports (un)subscription to the notification of analytics information for slice load level information from the NWDAF; +- supports (un)subscription to the notification of analytics information for service experience related network data from the NWDAF; +- supports (un)subscription to the notification of analytics information for SMF load information from the NWDAF to determine SMF selection;-supports (un)subscription to the notification of analytics information for expected UE behavioural information (UE mobility and/or UE communication) from the NWDAF to monitor UE behaviour; +- supports (un)subscription to the notification of analytics information for abnormal UE behaviour information from the NWDAF to determine adjustment of UE mobility related network parameters to solve the abnormal risk; and +- supports (un)subscription to the notification of analytics information for dispersion at the slice from the NWDAF. + +The Session Management Function (SMF): + +- supports (un)subscription to the notification of analytics information for UPF load information from the NWDAF to determine UPF selection; +- supports (un)subscription to the notification of analytics information for UE mobility information from the NWDAF to determine UPF selection; +- supports (un)subscription to the notification of analytics information for Session Management Congestion Control Experience from the NWDAF;- supports (un)subscription to the notification of analytics information for expected UE behavioural information (UE mobility and/or UE communication) from the NWDAF to monitor UE behaviour; +- supports (un)subscription to the notification of analytics information for abnormal UE behaviour information from the NWDAF to determine adjustment of UE communication related network parameters to solve the abnormal risk; +- supports (un)subscription to the notification of analytics information for slice load level information or network slice instance load level information from the NWDAF to determine slice selection. +- supports (un)subscription to the notification of analytics information for service experience related network data from the NWDAF; +- supports (un)subscription to the notification of analytics information for redundant transmission experience from the NWDAF to consider whether redundant transmission shall be performed, or (if it had been activated) shall be stopped; and +- supports (un)subscription to the notification of analytics information for DN performance from the NWDAF. + +The Network Exposure Function (NEF): + +- supports (un)subscription to the notification of analytics information for UE mobility from the NWDAF; +- supports (un)subscription to the notification of analytics information for UE communication from the NWDAF; +- supports (un)subscription to the notification of analytics information for expected UE behavioural (UE mobility and/or UE communication) from the NWDAF; +- supports (un)subscription to the notification of analytics information for abnormal behaviour from the NWDAF; +- supports (un)subscription to the notification of analytics information for user data congestion from the NWDAF; +- supports (un)subscription to the notification of analytics information for network performance from the NWDAF; +- supports (un)subscription to the notification of analytics information for QoS Sustainability from the NWDAF; +- supports (un)subscription to the notification of analytics information for Dispersion from the NWDAF; +- supports (un)subscription to the notification of analytics information for DN performance from NWDAF; +- supports (un)subscription to the notification of analytics information for Observed Service Experience from NWDAF; +- with PFDF function supports (un)subscription to the notification of analytics information for NWDAF assisted PFD Determination from the NWDAF; +- supports (un)subscription to the notification of analytics information for E2E data volume transfer time from NWDAF; +- supports (un)subscription to the notification of analytics information for Relative Proximity from NWDAF; and + +- supports (un)subscription to the notification of analytics information for movement behaviour from NWDAF. + +The Application Function (AF): + +- supports receiving UE mobility information from NWDAF or via the NEF; +- supports receiving UE communication information from NWDAF or via the NEF; +- supports receiving expected UE behavioural information (UE mobility and/or UE communication) from NWDAF or via the NEF; +- supports receiving abnormal behaviour information from the NWDAF or via the NEF; +- supports receiving user data congestion information from the NWDAF or via the NEF; +- supports receiving network performance information from the NWDAF or via the NEF; +- supports receiving QoS Sustainability information from the NWDAF or via the NEF; +- supports receiving Dispersion information from the NWDAF or via the NEF; +- supports receiving Observed Service Experience information from NWDAF or via the NEF; +- supports receiving E2E data volume transfer time from NWDAF or via the NEF; +- supports receiving Movement Behaviour information from NWDAF or via the NEF; and +- supports receiving Relative Proximity information from NWDAF or via the NEF. + +The Operation, Administration, and Maintenance (OAM): + +- supports receiving slice load level information from the NWDAF; +- supports receiving observed service experience from the NWDAF; +- supports receiving NF load information from the NWDAF; +- supports receiving network performance information from the NWDAF; +- supports receiving UE mobility information from the NWDAF; +- supports receiving UE communication information from the NWDAF; +- supports receiving expected UE behaviour information (UE mobility and/or UE communication) from the NWDAF; and +- supports receiving abnormal UE behaviour information from the NWDAF. + +The Charging Enablement Function (CEF): + +- supports (un)subscription to the notification of analytics information for slice load level information from the NWDAF; and +- supports (un)subscription to the notification of analytics information for service experience statistics information from the NWDAF. + +The Location Management Function (LMF): + +- supports (un)subscription to the notification of analytics information for location accuracy analytics from the NWDAF. + +The Network Data Analytics Function (NWDAF): + +- supports (un)subscription to the notification of analytics information for all types of network analytics from the NWDAF; and +- supports requesting the transfer of subscriptions to another NWDAF. + +The Data Collection Coordination Function (DCCF): + +- supports (un)subscription to the notification of analytics information for all types of network analytics from the NWDAF. + +## 4.2.2 Service Operations + +### 4.2.2.1 Introduction + +**Table 4.2.2.1-1: Operations of the Nnwdaf\_EventsSubscription Service** + +| Service operation name | Description | Initiated by | +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------| +| Nnwdaf_EventsSubscription_Subscribe | This service operation is used by an NF to subscribe or update subscription for event notifications of the analytics information. One-time, periodic notification or notification upon event detected can be subscribed. | NF service consumer (PCF, NSSF, AMF, SMF, NEF, AF, LMF, OAM, CEF, NWDAF, DCCF) | +| Nnwdaf_EventsSubscription_Unsubscribe | This service operation is used by an NF to unsubscribe from event notifications. | NF service consumer (PCF, NSSF, AMF, SMF, NEF, AF, LMF, OAM, CEF, NWDAF, DCCF) | +| Nnwdaf_EventsSubscription_Notify | This service operation is used by an NWDAF to notify NF service consumers about subscribed events. | NWDAF | +| Nnwdaf_EventsSubscription_Transfer | This service operation is used by an NWDAF to request the transfer of subscription(s) for analytics events. | NWDAF | + +### 4.2.2.2 Nnwdaf\_EventsSubscription\_Subscribe service operation + +#### 4.2.2.2.1 General + +The Nnwdaf\_EventsSubscription\_Subscribe service operation is used by an NF service consumer to subscribe or update subscription for event notifications from the NWDAF. + +#### 4.2.2.2.2 Subscription for event notifications + +Figure 4.2.2.2.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to subscribe for event notification(s) (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The consumer sends a POST request to /subscriptions, and the NWDAF responds with a 201 Created status.](4b587081b669e7c6695b0e5db5ea7f6d_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + NF service consumer->>NWDAF: 1. POST « /subscriptions + Note right of NWDAF: + NWDAF-->>NF service consumer: 2. 201 Created + +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The consumer sends a POST request to /subscriptions, and the NWDAF responds with a 201 Created status. + +**Figure 4.2.2.2.2-1: NF service consumer subscribes to notifications** + +The NF service consumer shall invoke the Nnwdaf\_EventsSubscription\_Subscribe service operation to subscribe to event notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwdaf-eventssubscription//subscriptions" as Resource URI representing the "NWDAF Events Subscriptions", as shown in figure 4.2.2.2.2-1, step 1, to create a subscription for an "Individual NWDAF Event Subscription" according to the information in message body. The NnwdafEventsSubscription data structure provided in the request body shall include: + +- an URI where to receive the requested notifications as "notificationURI" attribute; and +- a description of the subscribed events as "eventSubscriptions" attribute that, for each event, the EventSubscription data type shall include: + - 1) an event identifier as "event" attribute; and + +- 2) if the event notification method "PERIODIC" is selected via the "notificationMethod" attribute, repetition period as "repetitionPeriod" attribute; +- and the EventSubscription data type may include the "extraReportReq" attribute with the following attributes: +- 1) maximum number of objects in the "maxObjectNbr" attribute; + - 2) maximum number of SUPIs expected for an analytics report in the "maxSupiNbr" attribute; + - 3) identification of time window to which the subscription applies via identification of date-time(s) in the "startTs" and "endTs" attributes; + - 4) preferred level of accuracy of the analytics in the "accuracy" attribute; + - 5) identification of time when analytics information is needed in the "timeAnaNeeded" attribute if the feature "EneNA" is supported; + - 6) indication of which analytics metadata is requested to be delivered with the notification in the "anaMeta" attribute if the feature "Aggregation" is supported; + - 7) requested values for analytics metadata information to be used for the generation of the analytics in the "anaMetaInd" attribute if the feature "Aggregation" is supported; + - 8) offset period to the periodic reporting in the "offsetPeriod" attribute if the feature "EneNA" is supported. It may be present if the "repPeriod" attribute within the "evtReq" attribute or the "repetitionPeriod" attribute within the EventSubscription data type is included; + - 9) preferred accuracy level per analytics subset in the "accPerSubset" attribute if the "listOfAnaSubsets" attribute is present and the "EneNA" feature is supported; and/or + - 10) the time period of historical analytics in the "histAnaTimePeriod" attribute, if the "EneNA" feature is supported. + +The NnwdafeventsSubscription data structure provided in the request body may include: + +- event reporting information as the "evtReq" attribute, which applies for each event and may contain the following attributes: + - 1) event notification method (periodic, one time, on event detection) in the "notifMethod" attribute; + - 2) maximum Number of Reports in the "maxReportNbr" attribute; + - 3) monitoring duration in the "monDur" attribute; + - 4) repetition period for periodic reporting in the "repPeriod" attribute; + - 5) immediate reporting indication in the "immRep" attribute; + - 6) percentage of sampling among impacted UEs in the "sampRatio" attribute; + - 7) partitioning criteria for partitioning the impacted UEs before performing sampling as "partitionCriteria" attribute if the "EneNA" feature is supported; + - 8) group reporting guard time for aggregating the reports for a group of UEs in the "grpRepTime" attribute; and/or + - 9) a notification flag (used for muting and retrieving notifications) as "notifFlag" attribute if the "EneNA" feature is supported + +NOTE 1: The notification method indicated as the "notifMethod" attribute and the periodic reporting time indicated as the "repPeriod" attributes within the event reporting information as the "evtReq" attribute provided in NnwdafeventsSubscription data type, if present, supersedes the event notification method as the "notificationMethod" attribute and repetition period as the "repetitionPeriod" attribute respectively in the EventSubscription data type. + +EventSubscription data type. + +- information of previous analytics subscription in the "prevSub" attribute if the "AnaCtxTransfer" feature is supported; +- the notification correlation identifier in the "notifCorrId" attribute, if the "EneNA" feature is supported; and/or +- analytics consumer information as "consNfInfo" attribute, if the "AnaSubTransfer" feature is supported; + +NOTE 2: The "consNfInfo" attribute enables the NWDAF to determine whether an analytics subscription transfer procedure is applicable. Otherwise, if the "consNfInfo" attribute is not provided in a subscription and the NWDAF cannot serve anymore or transfer this subscription, the NWDAF can notify the analytics consumer with a Termination Request so that the analytics consumer can select a new target NWDAF. + +For all the event types, the "eventSubscriptions" attribute may include: + +- the analytics accuracy requirement information in "accuReq" attribute as indication to the NWDAF to activate checking the analytics accuracy information of the subscribed event, if the "AnalyticsAccuracy" feature is + +supported and the NF service consumer discovered or local configured the NWDAF containing an AnLF supporting accuracy checking capability. + +- the pause analytics consumption flag in "pauseFlg" attribute if the "AnalyticsAccuracy" feature is supported. +- the resume analytics consumption flag in "resumeFlg" attribute if the "AnalyticsAccuracy" feature is supported. +- use case context as "useCaseCxt" attribute, if the "ENAExt" feature is supported. + +NOTE 3: The NWDAF can use the parameter "Use case context" to select the most relevant ML model, when several ML models are available for the requested Analytics ID(s). The NWDAF containing AnLF can additionally provide the parameter "Use case context" when requesting an ML model from an NWDAF containing MTLF. The values of this parameter are not standardized. + +NOTE 4: The subscription for analytics accuracy information independently from subscription of the analytics event output is not supported in this release. + +- information related to roaming within the "roamingInfo" attribute if the "RoamingAnalytics" feature is supported; + +For different event types, the "eventSubscriptions" attribute: + +- if the event is "SLICE\_LOAD\_LEVEL", shall provide: + - 1) network slice level load level threshold in the "loadLevelThreshold" attribute if the "notifMethod" attribute in "evtReq" attribute is set to "ON\_EVENT\_DETECTION" or the "notificationMethod" attribute in "eventSubscriptions" attribute is set to "THRESHOLD" or omitted; and + - 2) identification of network slice(s) to which the subscription applies via identification of network slice(s) in the "snssais" attribute or any slices indication in the "anySlice" attribute; +- if the feature "NsiLoad" is supported and the event is "NSI\_LOAD\_LEVEL", shall provide: + - 1) identification of network slice and the optionally associated network slice instance(s) if available, via the "nsiIdInfos" attribute or any slices indication in the "anySlice" attribute; and + +NOTE 5: The network slice instance of a PDU session is not available in the PCF. + +- 2) the network slice or network slice instance load level thresholds in the "nsiLevelThrds" attribute if the "notifMethod" attribute in "evtReq" attribute is set to "ON\_EVENT\_DETECTION" or the "notificationMethod" attribute in "eventSubscriptions" attribute is set to "THRESHOLD" or omitted; + +and may include: + +- 1) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "NSI\_LOAD\_LEVEL" event, if the "EneNA" feature is supported; +- 2) identification of network area to which the subscription applies via identification of network area(s) by "networkArea" attribute, if the "NsiLoadExt" feature is supported; +- 3) a matching direction in the "matchingDir" attribute if the "nsiLevelThrds" attribute is provided and the "NsiLoadExt" feature is supported; and/or +- 4) list of NF instance types in the "nfTypes" attribute, if the "NsiLoadExt" feature is supported. + +- if the feature "NfLoad" is supported and the event is "NF\_LOAD", shall provide: + - 1) identification of target UE(s) to which the subscription applies by "supis" or "anyUe" in the "tgtUe" attribute; and + +NOTE 6: Only NF instances of type AMF and SMF which are serving the UE can be determined using a SUPI in "supis" attribute. + +NOTE 7: If a list of the NF Instance IDs (or respectively of NF Set IDs) is provided, the NWDAF needs to provide the analytics for each designated NF instance (or respectively for each NF instance belonging to each designated NF Set). In such case the target UE(s) of the Analytics Reporting need be ignored. + +- 2) NF load level thresholds in the "nfLoadLvlThrds" attribute if the "notifMethod" attribute in "evtReq" attribute is set to "ON\_EVENT\_DETECTION" or the "notificationMethod" attribute in "eventSubscriptions" attribute is set to "THRESHOLD" or omitted; + +and may include: + +- 1) either list of NF instance IDs in the "nfInstanceIds" attribute or list of NF set IDs in the "nfSetIds" attribute if the identification of target UE(s) applies to all UEs; + - 2) list of NF instance types in the "nfTypes" attribute; + - 3) identification of network slice(s) by "snssais" attribute; + - 4) a matching direction in the "matchingDir" attribute if the "nfLoadLvlThds" attribute is provided; + - 5) optional area of interest by "networkArea" attribute, if the "NfLoadExt" feature is supported; and/or + - 6) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to NF\_LOAD event, if the "EneNA" feature is supported; +- if the feature "NetworkPerformance" is supported and the event is "NETWORK\_PERFORMANCE", it shall provide: +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute; and + - 2) the network performance requirements via "nwPerfRequs" attribute; +- and may provide: +- 1) identification of network area to which the subscription applies via identification of network area(s) by "networkArea" attribute (mandatory if "anyUe" attribute is set to true); + - 2) a matching direction in the "matchingDir" attribute if the "nwPerfRequs" attribute is provided; + - 3) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "NetworkPerformanceExt\_eNA" feature is supported; + - 4) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "NetworkPerformanceExt\_eNA" feature is supported; and/or + - 5) the temporal granularity size in the "temporalGranSize" attribute if the "NetworkPerformanceExt\_eNA" feature is supported. +- if the feature "ServiceExperience" is supported and the event is "SERVICE\_EXPERIENCE", shall provide: +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute; and + - 2) any slices indication in the "anySlice" attribute or identification of network slice(s) together with the optionally associated network slice instance(s) if available, via the "nsiIdInfos" attribute; + +NOTE 8: The network slice instance of a PDU session is not available in the PCF. + +and may provide: + +- 1) identification of application to which the subscription applies via identification of application(s) by "appIds" attribute; +- 2) identification of network area to which the subscription applies via identification of network area(s) by "networkArea" attribute (mandatory if "anyUe" attribute is set to true); +- 3) identification of DNN to which the subscription applies via identification of application(s) by "dnns" attribute; +- 4) identification of user plane access to DN(s) which the subscription applies as the "dnais" attribute; +- 5) identification of a user plane access to one or more DN(s) where applications are deployed by "dnais" attribute; +- 6) if "appIds" attribute is provided, the bandwidth requirement of each application by "bwRequs" attribute; +- 7) indication of all the RAT types and/or all the frequencies that the NWDAF received for the application or specific RAT type(s) and/or frequency(ies) and the service experience threshold value(s) for the RAT Type(s) and/or Frequency value(s) where the UE camps on by "ratFreqs" attribute if the feature "ServiceExperienceExt" is also supported; +- 8) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "SERVICE\_EXPERIENCE" event, if the "EneNA" feature is supported; +- 9) the identification of the UPF as the "upfInfo" attribute if the feature "ServiceExperienceExt" is also supported; +- 10) IP address(s)/FQDN(s) of the Application Server(s) as the "appServerAddrs" attribute if the feature "ServiceExperienceExt" is also supported; +- 11) combination of PDU Session parameters as the "pduSesInfos" attribute if the feature "ServiceExperienceExt2\_eNA" is also supported; and/or +- 12) preferred granularity of location information as the "locGranularity" attribute if the feature "ServiceExperienceExt2\_eNA" is supported; and/or + +- 13) the fine granularity areas as the "fineGranAreas" attribute if the feature "ServiceExperienceExt2\_eNA" is supported. +- if the feature "UeMobility" is supported and the event is "UE\_MOBILITY", shall provide: + - 1) identification of target UE(s) to which the subscription applies by "supis" or "intGroupIds" attribute in the "tgtUe" attribute; + +NOTE 9: For LADN service, the consumer (e.g. SMF) provides the LADN DNN to refer the LADN service area as the AOI. + +and may provide: + +- 1) identification of network area to which the subscription applies via identification of network area(s) by "networkArea" attribute; + - 2) preferred granularity of location information as the "locGranularity" attribute if the feature "UeMobilityExt2\_eNA" is supported. + - 3) identification of the preferred orientation of location information by "locOrientation" attribute if the feature "UeMobilityExt2\_eNA" is supported. + - 4) if the feature "UeMobilityExt" is supported, + - i) identification of LADN DNN in the "ladnDnns" attribute; + - ii) Visited Area(s) of Interest as the "visitedAreas" attribute; + - 5) other UE mobility analytics requirements in "ueMobilityReqs" attribute, which may include ordering criterion and ordering direction, if the "UeMobilityExt2\_eNA" feature is supported; + - 6) an optional list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "UE\_MOBILITY" event, if the "UeMobilityExt2\_eNA" and "EneNA" features are supported; + - 7) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "UeMobilityExt2\_eNA" feature is supported; + - 8) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "UeMobilityExt2\_eNA" feature is supported; + - 9) the fine granularity areas as the "fineGranAreas" attribute if the feature "UeMobilityExt2\_eNA" is supported. +- if the feature "UeCommunication" is supported and the event is "UE\_COMM", shall provide: + - 1) identification of target UE(s) to which the subscription applies by "supis" or "intGroupIds" attribute in the "tgtUe" attribute; + +and may include: + +- 1) identification of the application in the "appIds" attribute; + - 2) identification of network area to which the subscription applies via identification of network area(s) by "networkArea" attribute; + - 3) an identification of DNN in the "dnns" attribute; + - 4) identification of network slice in the "snsaas" attribute; + - 5) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "UE\_COMM" event, if the "EneNA" feature is supported; + - 6) other UE communication analytics requirements in "ueCommReqs" attribute, which may include ordering criterion and ordering direction, if the "EnUeCommunication" feature is supported; + - 7) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "UeCommunicationExt\_eNA" feature is supported; + - 8) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "UeCommunicationExt\_eNA" feature is supported. +- if the feature "QoSustainability" is supported and the event is "QOS\_SUSTAINABILITY", shall provide: + - 1) identification of network area to which the subscription applies via identification of network area by "networkArea" attribute; + - 2) the QoS requirements via "qosRequ" attribute; + - 3) QoS flow retainability threshold(s) by the "qosFlowRetThds" attribute for the 5QI of GBR resource type or RAN UE throughout threshold(s) by the "ranUeThrouThds" attribute for the 5QI of non-GBR resource type, if the "notifMethod" attribute in "evtReq" attribute is set to "ON\_EVENT\_DETECTION" or the "notificationMethod" attribute in "eventSubscriptions" attribute is set to "THRESHOLD" or omitted; and + - 4) identification of target UE(s) to which the subscription applies by "anyUe" in the "tgtUe" attribute; + +and may include: + +- 1) identification of network slice(s) by "snssais" attribute; +- 2) a matching direction in the "matchingDir" attribute if the "qosFlowRetThds" attribute or the "ranUeThrouThds" attribute is provided; +- 3) acceptable deviations from the threshold levels in the "deviations" attribute, if the "EnQoSustainability" feature is supported; +- 4) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "QoSustainabilityExt\_eNA" feature is supported; +- 5) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "QoSustainabilityExt\_eNA" feature is supported; +- 6) the temporal granularity size in the "temporalGranSize" attribute if the "QoSustainabilityExt\_eNA" feature is supported; and/or +- 7) the fine granularity areas as the "fineGranAreas" attribute if the feature "QoSustainabilityExt\_eNA" is supported. + +- if the feature "AbnormalBehaviour" is supported and the event is "ABNORMAL\_BEHAVIOUR", shall provide: + +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute; and +- 2) either the expected analytics type via "exptAnaType" attribute or a list of exception Ids with the associated thresholds via "excepRequs" attribute. If the expected analytics type via "exptAnaType" attribute is provided, the NWDAF shall derive the corresponding Exception Ids from the received expected analytics type as follows: + - a) if "exptAnaType" attribute sets to "MOBILITY", the corresponding list of Exception Ids are "UNEXPECTED\_UE\_LOCATION", "PING\_PONG\_ACROSS\_CELLS", "UNEXPECTED\_WAKEUP" and "UNEXPECTED\_RADIO\_LINK\_FAILURES"; + - b) if "exptAnaType" attribute sets to "COMMUN", the corresponding list of Exception Ids are "UNEXPECTED\_LONG\_LIVE\_FLOW", "UNEXPECTED\_LARGE\_RATE\_FLOW", "SUSPICION\_OF\_DDOS\_ATTACK", "WRONG\_DESTINATION\_ADDRESS" and "TOO\_FREQUENT\_SERVICE\_ACCESS"; and + - c) if "exptAnaType" attribute sets to "MOBILITY\_AND\_COMMUN", the corresponding list of Exception Ids includes all above derived exception Ids. + +The derived list of Exception Ids is used by the NWDAF to notify the NF service consumer when UE's behaviour is exceptional based on one or more Exception Ids within the list. + +If the "anyUe" attribute in the "tgtUe" attribute sets to "true": + +- a) the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepRequs" attribute shall not be requested for both mobility and communication related analytics at the same time; +- b) if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepRequs" attribute is mobility related, at least one of identification of network area(s) by "networkArea" attribute and identification of network slice(s) by "snssais" attribute should be provided; and +- c) if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepRequs" attribute is communication related, at least one of identification of network area(s) by "networkArea" attribute, identification of application(s) by "appIds" attribute, identification of DNN(s) in the "dnns" attribute and identification of network slice(s) by "snssais" attribute should be provided; + +and may provide: + +- 1) expected UE behaviour via "exptUeBehav" attribute. + +- if the feature "UserDataCongestion" is supported and the event is "USER\_DATA\_CONGESTION", shall provide: + +- 1) identification of target UE(s) to which the subscription applies by "supis", "gpsis" (if feature "UserDataCongestionExt" is supported) or "anyUe" attribute; + +and may include: + +- 1) congestion threshold by the "congThresholds" attribute if the "notifMethod" attribute in "evtReq" attribute is set to "ON\_EVENT\_DETECTION" or the "notificationMethod" attribute in "eventSubscriptions" attribute is set to "THRESHOLD" or omitted; + +- 2) identification of network area to which the subscription applies via identification of network area(s) by "networkArea" attribute (mandatory if "anyUe" attribute is set to true); + - 3) identification of network slice(s) by "snssais" attribute; + - 4) a matching direction in the "matchingDir" attribute if the "congThresholds" attribute is provided; + - 5) if the feature "UserDataCongestionExt" is also supported, request a list of top applications with maximum number that contribute the most to the traffic in uplink and/or downlink directions by the "maxTopAppUINbr" attribute and/or the "maxTopAppDINbr" attribute; + - 6) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "USER\_DATA\_CONGESTION" event, if the "EneNA" feature is supported; and/or + - 7) the ordering criterion for the list of User Data Congestion analytics in "userDataConOrderCri" attribute, if the "UserDataCongestionExt2\_eNA" feature is supported; + - 8) the temporal granularity size in the "temporalGranSize" attribute if the "UserDataCongestionExt2\_eNA" feature is supported. +- if the feature "Dispersion" is supported and the event is "DISPERSION", shall provide: +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute, "anyUe" attribute is only supported in combination with "snssais" attribute, "networkArea" attribute and/or "disperClass" attribute; + +and may include: + +- 1) identification of network area to which the subscription applies via identification of network area by "networkArea" attribute, if the "supis" attribute or "intGroupIds" attribute is included in the "tgtUe" attribute; + - 2) identification of network slice(s) by "snssais" attribute; + - 3) application identifier(s) in "appIds" attribute; + - 4) dispersion analytics requirements in "disperReqs" attribute, which for the requested dispersion type may include dispersion class, preferred ordering requirements; + - 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to DISPERSION event, if the "EneNA" feature is supported; and/or + - 6) preferred granularity of location information as the "locGranularity" attribute if the feature "DispersionExt\_eNA" is supported; + - 7) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "DispersionExt\_eNA" feature is supported; + - 8) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "DispersionExt\_eNA" feature is supported; and/or + - 9) the temporal granularity size in the "temporalGranSize" attribute if the "DispersionExt\_eNA" feature is supported. +- if the feature "RedundantTransmissionExp" is supported and the event is "RED\_TRANS\_EXP", shall provide: +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute; +- and may include: +- 1) identification of network area to which the subscription applies via identification of network area by "networkArea" attribute; + - 2) identification of network slice(s) by "snssais" attribute; + - 3) identification of DNN in the "dnns" attribute; + - 4) other redundant transmission experience analysis requirements in "redTransReqs" attribute, which may include preferred order of results for the list of Redundant Transmission Experience; and/or + - 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to RED\_TRANS\_EXP event, if the "EneNA" feature is supported; + - 6) the temporal granularity size in the "temporalGranSize" attribute if the "RedundantTransExpExt\_eNA" feature is supported. +- if the feature "WlanPerformance" is supported and the event is "WLAN\_PERFORMANCE", shall provide: +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute. If "anyUe" attribute is included in the "tgtUe" attribute, then any of "networkArea" attribute, "ssIds" or "bssIds" attribute within "wlanReqs" attribute shall be present; + +and may include: + +- 1) identification of network area to which the subscription applies via identification of network area by "networkArea" attribute; + - 2) other WLAN performance analytics requirements in "wlanReqs" attribute, which may include SSID(s), BSSID(s), preferred order of results for the list of WLAN performance information and/or accuracy per analytics subset; and/or + - 3) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to WLAN\_PERFORMANCE event, if the "EneNA" feature is supported; + - 4) the temporal granularity size in the "temporalGranSize" attribute if the "WlanPerfExt\_eNA" feature is supported. +- if the feature "DnPerformance" is supported and the event is "DN\_PERFORMANCE", shall provide: +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute; + +and may include: + +- 1) identification of network area to which the subscription applies via identification of network area by "networkArea" attribute; + - 2) identification of network slice(s) in the "snssais" attribute; + - 3) identification of network slice and the optionally associated network slice instance(s) if available, via the "nsiIdInfos" attribute or any slices indication in the "anySlice" attribute; + - 4) application identifier(s) in "appIds" attribute; + - 5) an identification of DNN in the "dnns" attribute; + - 6) identification of a user plane access to one or more DN(s) where applications are deployed by "dnais" attribute; + - 7) the identification of the UPF as the "upfInfo" attribute; + - 8) IP address(s)/FQDN(s) of the Application Server(s) as the "appServerAddrs" attribute; + - 9) other DN performance analytics requirements in "dnPerfReqs" attribute, which may include the preferred order of results for the list of DN performance information and/or the reporting threshold of each applicable analytics subset; and/or + - 10) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "DN\_PERFORMANCE" event, if the "EneNA" feature is supported and may include the attribute with value(s) only applicable to "DN\_PERFORMANCE" event and the "DnPerformanceExt\_AIML" feature if supported; + - 11) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "DnPerformanceExt\_eNA" feature is supported; + - 12) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "DnPerformanceExt\_eNA" feature is supported; and/or + - 13) the temporal granularity size in the "temporalGranSize" attribute if the "DnPerformanceExt\_eNA" feature is supported. +- if the feature "SMCCE" is supported and the event is "SM\_CONGESTION", shall provide: +- 1) an identification of DNN in the "dnns" attribute; + - 2) identification of network slice in the "snssais" attribute; and/or + - 3) identification of target UE(s) via "supis" attribute in the "tgtUe" attribute where the target UE(s) are one have the PDU Session for the DNN and/or S-NSSAI; + +and may include: + +- 1) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "SM\_CONGESTION" event, if the "EneNA" feature is supported. + +NOTE 10: The predictions are not applicable for Session Management Congestion Control Experience analytics. + +- if the feature "PfdDetermination" is supported and the event is "PFD\_DETERMINATION", it shall provide: + +- 1) a list of application identifier(s) in the "appIds" attribute. + +and may provide: + +- 1) identification of DNN in the "dnns" attribute; and/or +- 2) identification of network slice in the "snssais" attribute. + +NOTE 11: PFD Determination analytics do not have a target UE, they are always for any UE. The predictions are not applicable for PFD Determination analytics. + +- if the feature "E2eDataVolTransTime" is supported and the event is "E2E\_DATA\_VOL\_TRANS\_TIME", shall provide: + +- 1) identification of target UE(s) to which the subscription applies by "supis" or "gpsi" attribute in the "tgtUe" attribute. + +and may include: + +- 1) an identification of DNN in the "dnns" attribute; +- 2) identification of network slice in the "snssais" attribute; +- 3) application identifier(s) in "appIds" attribute; +- 4) area of interest of the UEs by "networkArea" attribute; restricts the scope of the E2E data volume transfer time analytics to the provided area; +- 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "E2E\_DATA\_VOL\_TRANS\_TIME" event, if the "EneNA" feature is supported; +- 6) the QoS requirements via "qosRequ" attribute; and/or +- 7) E2E data volume transfer time requirements in the "dataVITrnsTmRqs" attribute; + +- if the feature "PduSesTraffic" is supported and the event is "PDU\_SESSION\_TRAFFIC", shall provide: + +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute; +- 2) PDU Session traffic analytics requirements in "pduSesTrafReqs" attribute, which includes the known Application Identifier, IP Descriptions or Domain Descriptors; and +- 3) DNN and/or S-NSSAI for the PDU Session(s) in the "dnns" and/or "snssais" attributes. + +and may include: + +- 1) identification of network area to which the subscription applies by "networkArea" attribute and/or +- 2) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "PDU\_SESSION\_TRAFFIC" event, if the "EneNA" features is supported. + +NOTE 12: The predictions are not applicable for PDU Session traffic analytics. + +- if the feature "MovementBehaviour" is supported and the event is "MOVEMENT\_BEHAVIOUR", shall provide: + +- 1) identification of network area to which the subscription applies by "networkArea" attribute; + +- and may include: + +- 1) identification of the preferred orientation of location information by "locOrientation" attribute; +- 2) Movement Behaviour analytics requirements in "movBehavReqs" attribute, which includes preferred granularity of location information or preferred orientation of location information; and/or +- 3) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "MOVEMENT\_BEHAVIOUR" event, if the "EneNA" features is supported. + +- if the feature "LocAccuracy" is supported and the event is "LOC\_ACCURACY", it shall provide: + +- 1) either a network area to which the subscription applies within the "networkArea" attribute or an exact location to which the subscription applies within the "location" attribute; + +- and may include: + +- 1) Location accuracy analytics requirements within the "locAccReqs" attribute; and/or +- 2) an optional list of analytics subsets within the "listOfAnaSubsets" attribute with value(s) only applicable to the "LOC\_ACCURACY" event, if the "EneNA" features is supported. + +NOTE 13: Location accuracy analytics do not have a target UE, they are always for any UE. + +- if the feature "RelativeProximity" is supported and the event is "RELATIVE\_PROXIMITY", shall provide: + +- 1) identification of target UE(s) to which the subscription applies by "supis" or "intGroupIds" attribute in the "tgtUe" attribute; +- and may include: + - 1) identification of DNN in the "dnns" attribute; + - 2) identification of network slice in the "snssais" attribute; + - 3) identification of network area to which the subscription applies by "networkArea" attribute; + - 4) Relative Proximity analytics requirements in "relProxReqs" attribute; and/or + - 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "RELATIVE\_PROXIMITY" event prediction, if the "EneNA" features is supported. + +Upon the reception of an HTTP POST request with: + +"{apiRoot}/nnwdafeventssubscription/{apiVersion}/subscriptions" as Resource URI and NnwdafeventsSubscription data structure as request body, if no errors occur, the NWDAF shall: + +- create a new subscription; +- assign an event subscriptionId; and +- store the subscription. + +If the NWDAF created an "Individual NWDAF Event Subscription" resource, the NWDAF shall respond with "201 Created" status code with the message body containing a representation of the created subscription, as shown in figure 4.2.2.2.2-1, step 2. If not all the requested analytics events in the subscription are accepted, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. "{apiRoot}/nnwdafeventssubscription/{apiVersion}/subscriptions/{subscriptionId}". If the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute sets to true in the event subscription, the NWDAF shall include the reports of the events subscribed, if available, in the HTTP POST response. + +**When the "notifFlag" attribute is included and set to "DEACTIVATE" in the request, the NWDAF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). Editor's Note: It is FFS to determine whether any further provisions or limitations with regard to the usage of the "notifFlag" attribute are needed.** + +If the analytics target period provided in the body of the HTTP POST request includes the start time in the past and the end time in the future, the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "BOTH\_STAT\_PRED\_NOT\_ALLOWED". + +When the "PredictionError" feature is supported, if the analytics target period provided in the body of the HTTP POST request includes the prediction time period in the future and the event is "SM\_CONGESTION", "PFD\_DETERMINATION" and/or "PDU\_SESSION\_TRAFFIC", the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "PREDICTION\_NOT\_ALLOWED". + +If the statistics in the past are requested but the necessary data to perform the service is unavailable, the NWDAF shall reject the request with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "UNAVAILABLE\_DATA". + +If the user consent has not been checked by the NF service consumer and is required for the requested analytics collection depending on local policy and regulations, then the NWDAF shall check user consent for the targeted UE(s) by retrieving the user consent subscription data via the Nudm\_SDM service API of the UDM as described in clause 5.2.2 of 3GPP TS 29.503 [23]. If the NWDAF receive the response from the UDM that it is not granted for the impacted user(s), then the NWDAF shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "USER\_CONSENT\_NOT\_GRANTED". + +**NOTE 14: When the target of reporting is a SUPI or a GPSI then the subscription can be rejected, e.g. because user consent is not granted, and the error is sent to the consumer. When the target of reporting is an Internal Group Id, or a list of SUPIs/GPSI(s) or any UE, and the user consent is not granted for a subset of the impacted users, then no error is sent, but a subset of the SUPIs/GPSIs is skipped if user consent is not granted.** + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.1.7. + +#### 4.2.2.2.3 Update subscription for event notifications + +Figure 4.2.2.2.3-1 shows a scenario where the NF service consumer sends a request to the NWDAF to update the subscription for event notifications (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF to update a subscription. Step 1: The consumer sends a PUT request to the NWDAF. Step 2a: The NWDAF responds with '200 OK' or '204 No Content'.](67d03c9e89620d73e3786c869e559752_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. PUT « subscriptions/{subscriptionId} » + NF service consumer->>NWDAF: Request + Note left of NWDAF: 2a. "200 OK" or + Note left of NWDAF: 2b. "204 No Content" + NWDAF-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF to update a subscription. Step 1: The consumer sends a PUT request to the NWDAF. Step 2a: The NWDAF responds with '200 OK' or '204 No Content'. + +**Figure 4.2.2.2.3-1: NF service consumer updates subscription to notifications** + +The NF service consumer shall invoke the Nnwdaf\_EventsSubscription\_Subscribe service operation to update subscription to event notifications. The NF service consumer shall send an HTTP PUT request with "{apiRoot}/nnwdaf-eventssubscription//subscriptions/{subscriptionId}" as Resource URI representing the "Individual NWDAF Event Subscription", as shown in figure 4.2.2.2.3-1, step 1, to update the subscription for an "Individual NWDAF Event Subscription" resource identified by the {subscriptionId}. The NnwdafEventsSubscription data structure provided in the request body shall include the same contents as described in clause 4.2.2.2.2. In addition, each element of the "eventSubscriptions" may contain the following: + +- Analytics feedback information within the "feedback" attribute, if the "AnalyticsAccuracy" feature is supported and the subscription is for a prediction. + +Upon the reception of an HTTP PUT request with: + +"{apiRoot}/nnwdaf-eventssubscription//subscriptions/{subscriptionId}" as Resource URI and NnwdafEventsSubscription data structure as request body, the NWDAF shall: + +- update the subscription of corresponding subscriptionId; and +- store the subscription. + +NOTE: The "notificationURI" attribute within the NnwdafEventsSubscription data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +If the NWDAF successfully processed and accepted the received HTTP PUT request, the NWDAF shall update an "Individual NWDAF Event Subscription" resource, and shall respond with: + +- a) HTTP "200 OK" status code with the message body containing a representation of the updated subscription, as shown in figure 4.2.2.2.3-1, step 2a. If not all the requested analytics events in the subscription are modified successfully, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the modification failed and the associated reason(s); or +- b) HTTP "204 No Content" status code, as shown in figure 4.2.2.2.3-1, step 2b. + +If errors occur when processing the HTTP PUT request, the NWDAF shall send an HTTP error response as specified in clause 5.1.7. + +If the analytics target period provided in the body of the HTTP PUT request includes the start time in the past and the end time in the future, the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "BOTH\_STAT\_PRED\_NOT\_ALLOWED". + +When the "PredictionError" feature is supported, if the analytics target period provided in the body of the HTTP PUT request includes the prediction time period in the future and the event is "SM\_CONGESTION", "PFD\_DETERMINATION" and/or "PDU\_SESSION\_TRAFFIC", the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "PREDICTION\_NOT\_ALLOWED". + +If the statistics in the past are requested but the necessary data to perform the service is unavailable, the NWDAF shall reject the request with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "UNAVAILABLE\_DATA". + +If the feature "ES3XX" is supported, and the NWDAF determines the received HTTP PUT request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +When the "notifFlag" attribute is included in the request with the value "DEACTIVATE", the NWDAF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer); if the "notifFlag" attribute is set to the value "RETRIEVAL", the NWDAF shall send the stored events to the NF service consumer, mute the event notification again and store available events; if the "notifFlag" attribute is set to the value "ACTIVATE" and the event notifications are muted (due to a previously received "DEACTIVATE" value), the NWDAF shall unmute the event notification, i.e. start sending again notifications for available events. + +**Editor's Note:** It is FFS to determine whether any further provisions or limitations with regard to the usage of the "notifFlag" attribute are needed. + +#### 4.2.2.3 Nnwdaf\_EventsSubscription\_Unsubscribe service operation + +##### 4.2.2.3.1 General + +The Nnwdaf\_EventsSubscription\_Unsubscribe service operation is used by an NF service consumer to unsubscribe from event notifications. + +##### 4.2.2.3.2 Unsubscribe from event notifications + +Figure 4.2.2.3.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to unsubscribe from event notifications (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the unsubscribe process between an NF service consumer and the NWDAF.](4767b6e106f34fe8b63a6838810bf913_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + Note right of NWDAF: + NF service consumer->>NWDAF: 1. DELETE« /subscriptions/{subscriptionId} + NWDAF-->>NF service consumer: 2. 204 No Content +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and the NWDAF. The NF service consumer sends a DELETE request to the NWDAF, and the NWDAF responds with a 204 No Content status code. + +Sequence diagram showing the unsubscribe process between an NF service consumer and the NWDAF. + +**Figure 4.2.2.3.2-1: NF service consumer unsubscribes from notifications** + +The NF service consumer shall invoke the Nnwdaf\_EventsSubscription\_Unsubscribe service operation to unsubscribe to event notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nnwdaf-eventssubscription//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request with: + +"{apiRoot}/nnwdaf-eventssubscription//subscriptions/{subscriptionId}" as Resource URI, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- remove the corresponding subscription; and +- respond with HTTP "204 No Content" status code. + +If errors occur when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.1.7. + +If the feature "ES3XX" is supported, and the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.2.2.4 Nnwdaf\_EventsSubscription\_Notify service operation + +##### 4.2.2.4.1 General + +The Nnwdaf\_EventsSubscription\_Notify service operation is used by an NWDAF to notify NF consumers about subscribed events or by the target NWDAF to notify the consumer of the successful analytics subscription transfer. + +##### 4.2.2.4.2 Notification about subscribed event + +Figure 4.2.2.4.2-1 shows a scenario where the NWDAF sends a request to the NF service consumer to notify for event notifications or notify for the successful analytics subscription transfer (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The NWDAF sends a POST request to the NF service consumer, and the NF service consumer responds with a 204 No Content.](a3083eec2a883ee8327b3c24174df6a9_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NWDAF: 1. POST {notificationURI} + NWDAF->>NF service consumer: 1. POST {notificationURI} + Note left of NF service consumer: 2. 204 No Content + NF service consumer-->>NWDAF: 2. 204 No Content + +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The NWDAF sends a POST request to the NF service consumer, and the NF service consumer responds with a 204 No Content. + +**Figure 4.2.2.4.2-1: NWDAF notifies the subscribed event** + +The NWDAF shall invoke the Nnwdaf\_EventsSubscription\_Notify service operation to notify the subscribed event or the successful analytics subscription transfer. The NWDAF shall send an HTTP POST request with "{notificationURI}" received in the Nnwdaf\_EventsSubscription\_Subscribe service operation as Resource URI, as shown in figure 4.2.2.4.2-1, step 1. + +If both the repetition period ("repPeriod" or "repetitionPeriod") attribute and the "offsetPeriod" attribute are present in the subscription request for periodical notification, the NWDAF shall produce a notification in every repetition period seconds, including the statistics in the past offset period if the "offsetPeriod" attribute value is negative, or including the prediction for the future offset period if the "offsetPeriod" attribute value is positive. + +The NnwdafEventsSubscriptionNotification data structure provided in the request body shall include: + +- If the notification is for notifying about subscribed events, a description of the notified event as "eventNotifications" attribute that for each event shall include: + - a) an event identifier as "event" attribute; + - b) network slice load level information in the "sliceLoadLevelInfo" attribute when subscribed event is "SLICE\_LOAD\_LEVEL"; + - c) service experience information as "svcExps" attribute when subscribed event is "SERVICE\_EXPERIENCE"; + - d) UE mobility information in the "ueMobs" attribute when subscribed event is "UE\_MOBILITY"; + - e) UE communication information in the "ueComms" attribute when subscribed event is "UE\_COMM"; + - f) abnormal behaviour information in the "abnorBehavrs" attribute when subscribed event is "ABNORMAL\_BEHAVIOUR"; + - g) user data congestion information in the "userDataCongInfos" attribute when subscribed event is "USER\_DATA\_CONGESTION"; + - h) QoS sustainability information in the "qosSustainInfos" attribute when subscribed event is "QOS\_SUSTAINABILITY"; + - i) NF load information in "nfLoadLevelInfos" attribute when subscribed event is "NF\_LOAD"; + - j) network performance information in the "nwPerfs" attribute when subscribed event is "NETWORK\_PERFORMANCE"; + - k) Load level information for the network slice(s) and the optionally associated network slice instance(s) in "nsiLoadLevelInfos" attribute when subscribed event is "NSI\_LOAD\_LEVEL"; + - l) Dispersion information in the "disperInfos" attribute when subscribed event is "DISPERSION"; + - m) Redundant transmission experience information in the "redTransInfos" attribute when subscribed event is "RED\_TRANS\_EXP"; + +- n) WLAN performance information in the "wlanInfos" attribute when subscribed event is "WLAN\_PERFORMANCE"; + - o) DN performance information in the "dnPerfInfos" attribute when subscribed event is "DN\_PERFORMANCE"; + - p) SMCC performance information in the "smccExps" attribute when subscribed event is "SM\_CONGESTION"; + - q) PFD Determination information for known application identifier(s) in the "pfdDetermInfos" attribute when subscribed event is "PFD\_DETERMINATION"; + - r) PDU Session traffic information in the "pduSesTrafInfos" attribute when subscribed event is "PDU\_SESSION\_TRAFFIC"; + - s) E2E data volume transfer time in the "dataVITrnsTmInfos" attribute when subscribed event is "E2E\_DATA\_VOL\_TRANS\_TIME"; + - t) Movement Behaviour information in the "movBehavInfos" attribute when subscribed event is "MOVEMENT\_BEHAVIOUR"; + - u) Location Accuracy information in the "locAccInfos" attribute when the subscribed event is "LOC\_ACCURACY"; and + - v) Relative Proximity information in the "relProxInfos" attribute when subscribed event is "RELATIVE\_PROXIMITY"; +- and may include: +- a) information about analytics metadata required for aggregation of the analytics in the "anaMetaInfo" attribute if the feature "Aggregation" is supported; + - b) the start time of which the analytics information will become valid in the "start" attribute, if the "EneNA" feature is supported; + - c) the expiration time after which the analytics information will become invalid in the "expiry" attribute. + - d) the analytics accuracy information in "accuInfo" attribute, if the feature "AnalyticsAccuracy" is supported and the analytics accuracy requirement was subscribed in the "accuReq" attribute. + - e) the pause analytics consumption indication in "pauseInd" attribute, if the feature "AnalyticsAccuracy" is supported. + - f) the resume analytics consumption indication in "resumeInd" attribute, if the feature "AnalyticsAccuracy" is supported. + +NOTE 1: In this version of the specification, the NWDAF containing AnLF can provide the accuracy information to an NF consumer that subscribes to the analytics. + +NOTE 2: When receiving a subscription from an NF service consumer that includes the request for accuracy information, the analytics and/or the accuracy information can be provided by NWDAF containing AnLF in one notification or via different notifications. + +NOTE 3: In this version of the specification, only subscribing or requesting accuracy information without requesting analytics is not supported. + +- If the "EneNA" feature is supported and the target NWDAF notifies a successful analytics subscription transfer, the old subscription ID which had been allocated by the source NWDAF within the "oldSubscriptionId" attribute and the resource URI of the Individual NWDAF Event Subscription resource created by the target NWDAF within "resourceUri" attribute, and if the "PartialAnalyticsSubTransfer" feature is supported and not all the analytics events in the subscription transfer are accepted, the successful transferred subscription event(s) within the "transEvents" attribute; and + - an event subscription Id as "subscriptionId" attribute; +- and may include: +- a) the notification correlation identifier in the "notifCorrId" attribute, if the "EneNA" feature is supported. + - b) a cause for termination in the "termCause" attribute, if the "TermRequest" feature is supported and the NWDAF wants to request the termination of this subscription, i.e. to indicate that it will send no further notifications for it. + +If the feature "EneNA" is supported and the time when analytics information is needed has been provided (via the "timeAnaNeeded" attribute within the "extraReportReq" attribute) during the subscription for an event (via the "event" attribute within the EventSubscription data type), if the time when analytics information is needed is reached but the subscribed analytics information is not ready, the consumer does not need to wait for the analytics information any longer. In this case, the NWDAF may send an HTTP POST request as shown in step 1 of figure 4.2.2.4.2-1, which shall only provide (within the EventNotification data type in the NnwdafeventsSubscriptionNotification data type) an indication of the failure event via the "event" attribute and the corresponding failure reason via a "failNotifyCode" attribute, and may also provide a minimum time interval recommended by the NWDAF for the event via a + +"rvWaitTime" attribute which will be used by the NF service consumer to determine the time when analytics information is needed in similar future analytics subscriptions. + +Upon the reception of an HTTP POST request with: "{notificationURI}" as Resource URI and NnwdafEventsSubscriptionNotification data structure as request body, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF service consumer shall: + +- store the notification; and +- respond with HTTP "204 No Content" status code. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.1.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.2.2.5 Nnwdaf\_EventsSubscription\_Transfer service operation + +##### 4.2.2.5.1 General + +The Nnwdaf\_EventsSubscription\_Transfer service operation is used by an NWDAF instance to request the transfer of analytics subscription(s) to another NWDAF instance. If the source NWDAF discovers that the analytics consumer may change concurrently to this procedure, the source NWDAF should not perform the procedure. In such a case, the source NWDAF may send a message to indicate to the analytics consumer that it will not serve this subscription anymore. + +NOTE 1: To discover the possible change of analytics consumer, if the Analytics ID is UE related, the source NWDAF takes actions responding to external trigger (such as UE mobility), for example, checking if the Target of Analytics Reporting is still within the serving area of the analytics consumer, if the serving area information of the consumer is available. + +NOTE 2: Handling of overload situation or preparation for a graceful shutdown are preferably executed inside an NWDAF Set, when available, therefore, not requiring an analytics subscription transfer as described in this clause. + +##### 4.2.2.5.2 Creation of request for analytics subscription transfer + +Figure 4.2.2.5.2-1 shows a scenario where the NF Service Consumer (e.g. NWDAF) sends a request to the NWDAF to request the transfer of analytics subscription(s) from the NF Service Consumer to the NF Service Producer (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the NF service consumer sending a POST request to the NWDAF for analytics subscription transfer.](1878426572e3fcbc4483578a685d7c7d_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant NWDAF as NWDAF + Note right of NF: 1. POST « transfers + NF->>NWDAF: Request + Note left of NWDAF: 2a. "201 Created" OR +2b. "204 No Content" + NWDAF-->>NF: Response +``` + +The diagram illustrates a sequence of interactions between an 'NF service consumer' and an 'NWDAF'. The 'NF service consumer' sends a message labeled '1. POST « transfers' to the 'NWDAF'. The 'NWDAF' responds with two possible options: '2a. "201 Created" OR' and '2b. "204 No Content"'. The arrows indicate the direction of the messages: a solid arrow from the consumer to the NWDAF, and a dashed arrow from the NWDAF back to the consumer. + +Sequence diagram showing the NF service consumer sending a POST request to the NWDAF for analytics subscription transfer. + +**Figure 4.2.2.5.2-1: NF service consumer requests an analytics subscription transfer** + +The NF service consumer shall invoke the Nnwdaf\_EventsSubscription\_Transfer service operation to request the transfer of analytics subscription(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwdaf-eventssubscription//transfers" as Resource URI representing the "NWDAF Event Subscription Transfers", as shown in figure 4.2.2.5.2-1, step 1, to create a request for an "Individual NWDAF Event + +Subscription Transfer" according to the information in the message body. The AnalyticsSubscriptionsTransfer data structure provided in the request body shall include: + +- information about the subscription(s) transfer request as "subsTransInfos" attribute, which, for each subscription that is requested to be transferred, shall include: + - a) the type of the transfer request (i.e. if it is a request for transfer preparation or transfer execution) in the "transReqType" attribute; + - b) information about the analytics subscription in the "nwdaEvSub" attribute, its contents being as defined for the NnwdaEventsSubscription data structure in clause 4.2.2.2.2; and + - c) the NF instance identifier of the consumer of the analytics subscription in the "consumerId" attribute; and may include: + - a) analytics context identifier information about the context that is available at the NF service consumer in the "contextId" attribute; + - b) NF instance identifier(s) of active data source(s) the NF service consumer is currently using for the analytics of this analytics subscription in the "sourceNfIds" attribute; + - c) NF set identifier(s) of active data source(s) the NF service consumer is currently using for the analytics of this analytics subscription in the "sourceSetIds" attribute; + - d) information identifying the ML model(s) that the NF service consumer is currently using for the analytics in the "modelInfos" attribute. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nnwdaf-eventssubscription//transfers" as Resource URI and AnalyticsSubscriptionsTransfer data structure as request body, in the successful case the NWDAF shall: + +- if the "transReqType" attribute has the value PREPARE, perform the steps required for the preparation of an analytics subscription transfer as described in clause 5.4.3 of TS 29.552 [25], create a new Individual NWDAF Event Subscription Transfer resource and send an HTTP "201 Created" response with the URI for the created resource in the "Location" header field, as shown in figure 4.2.2.5.2-1, step 2a; If the "PartialAnalyticsSubTransfer" feature is supported and not all the analytics events in the subscription transfer are accepted, then the NWDAF includes the "failTransEventReports" attribute indicating the failure event(s). +- if the "transReqType" attribute has the value TRANSFER, perform the steps required for the execution of an analytics subscription transfer as described in clause 5.4.2 of TS 29.552 [25], + - a) if the "PartialAnalyticsSubTransfer" feature is not supported, or if the "PartialAnalyticsSubTransfer" feature is supported and all the analytics events in the subscription transfer are accepted, send an HTTP "204 No Content" response, as shown in figure 4.2.2.5.2-1, step 2b; + - b) if the "PartialAnalyticsSubTransfer" feature is supported and not all the analytics events in the subscription transfer are accepted, the NWDAF creates a new Individual NWDAF Event Subscription Transfer resource and sends an HTTP "201 Created" response with the URI for the created resource in the "Location" header field, as shown in figure 4.2.2.5.2-1, step 2a. The NWDAF includes the "failTransEventReports" attribute indicating the failure event(s), and then removes the Individual NWDAF Event Subscription Transfer resource. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.1.7. + +#### 4.2.2.5.3 Update a request for analytics subscription transfer + +Figure 4.2.2.5.3-1 shows a scenario where the NF Service Consumer (e.g. NWDAF) sends a request to the NWDAF to update a request for the transfer of analytics subscription(s) from the NF Service Consumer to the NF Service Producer (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The consumer sends a PUT request to /transfers/{transferId} (step 1). The NWDAF responds with either a 204 No Content (step 2a) or a 200 OK (step 2b).](187d05bf7ead21e1394b61320d8b3632_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. PUT « /transfers/{transferId} » + NF service consumer->>NWDAF: Request + Note left of NWDAF: 2a. "204 No Content" or +2b. "200 OK" + NWDAF-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The consumer sends a PUT request to /transfers/{transferId} (step 1). The NWDAF responds with either a 204 No Content (step 2a) or a 200 OK (step 2b). + +**Figure 4.2.2.5.3-1: NF service consumer updates a request for an analytics subscription transfer** + +The NF service consumer shall invoke the Nnwdaf\_EventsSubscription\_Transfer service operation to update a request for the transfer of analytics subscription(s). The NF service consumer shall send an HTTP PUT request with "{apiRoot}/nnwdaf-eventssubscription//transfers/{transferId}" as Resource URI representing the "Individual NWDAF Event Subscription Transfer", as shown in figure 4.2.2.5.3-1, step 1, to update the "Individual NWDAF Event Subscription Transfer" resource identified by the {transferId}. The AnalyticsSubscriptionsTransfer data structure provided in the request body shall include the same contents as described in clause 4.2.2.5.2. + +Upon the reception of an HTTP PUT request with: + +"{apiRoot}/nnwdaf-eventssubscription//transfers/{transferId}" as Resource URI and AnalyticsSubscriptionsTransfer data structure as request body, the NWDAF shall: + +- if the "transReqType" attribute has the value PREPARE, perform the steps required for the preparation of an analytics subscription transfer as described in clause 5.4.3 of TS 29.552 [25], update the Individual NWDAF Event Subscription Transfer resource identified by "transferId", + - a) if the "PartialAnalyticsSubTransfer" feature is not supported, or if the "PartialAnalyticsSubTransfer" feature is supported and all the analytics events in the subscription transfer are accepted, send an HTTP "204 No Content" response, as shown in figure 4.2.2.5.3-1, step 2a; + - b) if the "PartialAnalyticsSubTransfer" feature is supported and and not all the analytics events in the subscription transfer are accepted, send an HTTP "200 OK" response with the message body containing a representation of the updated subscription transfer, as shown in figure 4.2.2.5.3-1, step 2b, and the NWDAF includes the "failTransEventReports" attribute indicating the failure event(s). +- if the "transReqType" attribute has the value TRANSFER, perform the steps required for the execution of an analytics subscription transfer as described in clause 5.4.3 of TS 29.552 [25], + - a) if the "PartialAnalyticsSubTransfer" feature is not supported, or if the "PartialAnalyticsSubTransfer" feature is supported and all the analytics events in the subscription transfer are accepted, remove the Individual NWDAF Event Subscription Transfer resource identified by "transferId", and send an HTTP "204 No Content" response, as shown in figure 4.2.2.5.3-1, step 2a; + - b) if the "PartialAnalyticsSubTransfer" feature is supported and and not all the analytics events in the subscription transfer are accepted, update the Individual NWDAF Event Subscription Transfer resource identified by "transferId", and send an HTTP "200 OK" response with the message body containing a representation of the updated subscription transfer, as shown in figure 4.2.2.5.3-1, step 2b. The NWDAF includes the "failTransEventReports" attribute indicating the failure event(s), and then removes the Individual NWDAF Event Subscription Transfer resource. + +If errors occur when processing the HTTP PUT request, the NWDAF shall send an HTTP error response as specified in clause 5.1.7. + +If the NWDAF determines the received HTTP PUT request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.2.2.5.4 Cancel a request for analytics subscription transfer + +Figure 4.2.2.5.4-1 shows a scenario where the NF service consumer (e.g. NWDAF) sends a request to the NWDAF to cancel a request for the transfer of analytics subscription(s) from the NF service consumer to the NF Service Producer (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the cancellation of an analytics subscription transfer. The NF service consumer sends a DELETE request for transfers/{transferId} to the NWDAF, which responds with 204 No Content.](aeb2a26a07219661191294dba528067a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. DELETE « transfers/{transferId} » + NF service consumer->>NWDAF: 1. DELETE « transfers/{transferId} » + Note left of NWDAF: 2. "204 No Content" + NWDAF-->>NF service consumer: 2. "204 No Content" +``` + +Sequence diagram showing the cancellation of an analytics subscription transfer. The NF service consumer sends a DELETE request for transfers/{transferId} to the NWDAF, which responds with 204 No Content. + +**Figure 4.2.2.5.4-1: NF service consumer cancels a request for an analytics subscription transfer** + +The NF service consumer shall invoke the Nnwdaf\_EventsSubscription\_Transfer service operation to cancel a request for the transfer of analytics subscription(s). The NF service consumer shall send an HTTP DELETE request with "{apiRoot}/nnwdaf-eventssubscription//transfers/{transferId}" as Resource URI representing the "Individual NWDAF Event Subscription Transfer", as shown in figure 4.2.2.5.4-1, step 1, to cancel the "Individual NWDAF Event Subscription Transfer" resource identified by the {transferId}. + +Upon the reception of an HTTP DELETE request with: + +"{apiRoot}/nnwdaf-eventssubscription//transfers/{transferId}" as Resource URI, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- if applicable, delete any analytics data that is no longer needed and unsubscribe to entities for data collection or ML model acquisition, if the subscriptions are not needed for other active analytics subscriptions; +- remove the corresponding Individual NWDAF Event Subscription Transfer resource; and +- respond with HTTP "204 No Content" status code, as shown in figure 4.2.2.5.4-1, step 2. + +If errors occur when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.1.7. + +If the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +### 4.3 Nnwdaf\_AnalyticsInfo Service + +#### 4.3.1 Service Description + +##### 4.3.1.1 Overview + +The Nnwdaf\_AnalyticsInfo service as defined in 3GPP TS 23.501 [2], 3GPP TS 23.288 [17] and 3GPP TS 23.503 [4], is provided by the Network Data Analytics Function (NWDAF). + +This service: + +- allows NF service consumers to request and get different type of analytic event information; and +- allows NF service consumers to request and get context information related to analytics subscriptions. + +The types of observed events include: + +- Slice load level information; + +- Network slice instance load level information; +- Service experience; +- NF load; +- Network performance; +- Abnormal behaviour; +- UE mobility; +- UE communication; +- User data congestion; +- QoS sustainability; +- SM congestion control experience; +- Dispersion; +- Redundant transmission experience; +- WLAN performance; +- DN performance; +- PFD determination; +- PDU Session traffic; +- Movement Behaviour; +- Location Accuracy; and +- Relative Proximity. + +#### 4.3.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [17]. The Network Data Analytics signalling flows are defined in 3GPP TS 29.552 [25], the Policy and Charging related 5G architecture is also described in 3GPP TS 23.503 [4] and 3GPP TS 29.513 [5]. + +The Nnwdaf\_AnalyticsInfo service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF). + +Known consumers of the Nnwdaf\_AnalyticsInfo service are: + +- Policy Control Function (PCF) +- Network Slice Selection Function (NSSF) +- Access and Mobility Management Function (AMF) +- Session Management Function (SMF) +- Network Exposure Function (NEF) or Network Exposure Function (Packet Flow Description Function) (NEF (PFDF)) +- Application Function (AF) +- Location Management Function (LMF) +- Operation, Administration, and Maintenance (OAM) +- Network Data Analytics Function (NWDAF) +- Data Collection Coordination Function (DCCF) + +The PCF accesses the Nnwdaf\_AnalyticsInfo service at the NWDAF via the N23 Reference point. The NSSF accesses the Nnwdaf\_AnalyticsInfo service at the NWDAF via the N34 Reference point. + +![Reference Architecture for the Nnwdaf_AnalyticsInfo Service; SBI representation diagram](c3e8a7fe2e4f51806e05b9b1aae20d57_img.jpg) + +The diagram illustrates the Service Based Interface (SBI) representation for the Nnwdaf\_AnalyticsInfo service. At the top, a box labeled 'NWDAF' contains an oval labeled 'Nnwdaf'. Below this, a horizontal line represents the service interface, with the label 'Nnwdaf\_AnalyticsInfo' positioned above it. Below the interface line, ten boxes are arranged horizontally, representing the network functions that consume the service: PCF, NSSF, AMF, SMF, NEF, DCCF, AF, OAM, LMF, and NWDAF. Each of these boxes is connected to the horizontal interface line by a vertical line. + +Reference Architecture for the Nnwdaf\_AnalyticsInfo Service; SBI representation diagram + +**Figure 4.3.1.2-1: Reference Architecture for the Nnwdaf\_AnalyticsInfo Service; SBI representation** + +![Figure 4.3.1.2-2: Reference Architecture for the Nnwdaf_AnalyticsInfo Service: reference point representation. The diagram shows a central NWDAF box at the top connected to ten boxes below it. The connections are labeled N23 (to PCF) and N34 (to NSSF). The other connections are to AMF, SMF, NEF, DCCF, AF, OAM, LMF, and NWDAF.](0a73b03fba21af142d619a9a662e6490_img.jpg) + +``` + +graph TD + NWDAF_top[NWDAF] -- N23 --> PCF[PCF] + NWDAF_top -- N34 --> NSSF[NSSF] + NWDAF_top --> AMF[AMF] + NWDAF_top --> SMF[SMF] + NWDAF_top --> NEF[NEF] + NWDAF_top --> DCCF[DCCF] + NWDAF_top --> AF[AF] + NWDAF_top --> OAM[OAM] + NWDAF_top --> LMF[LMF] + NWDAF_top --> NWDAF_bottom[NWDAF] + +``` + +Figure 4.3.1.2-2: Reference Architecture for the Nnwdaf\_AnalyticsInfo Service: reference point representation. The diagram shows a central NWDAF box at the top connected to ten boxes below it. The connections are labeled N23 (to PCF) and N34 (to NSSF). The other connections are to AMF, SMF, NEF, DCCF, AF, OAM, LMF, and NWDAF. + +**Figure 4.3.1.2-2: Reference Architecture for the Nnwdaf\_AnalyticsInfo Service: reference point representation** + +NOTE: When the NEF subscribes the PFD Determination Analytics to the NWDAF, the NEF needs to support PFDF function as NEF (PFDF). + +### 4.3.1.3 Network Functions + +#### 4.3.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF) provides specific analytics information for different analytic events and, if the "AnaCtxTransfer" feature is supported, context information related to analytics subscriptions to NF service consumers. + +#### 4.3.1.3.2 NF Service Consumers + +The Policy Control Function (PCF): + +- supports taking analytics information for slice load level information from the NWDAF; +- supports taking analytics information for service experience related network data from the NWDAF; +- supports taking analytics information for network performance from the NWDAF; +- supports taking analytics information for abnormal UE behaviour from the NWDAF; +- supports taking analytics information for UE mobility from the NWDAF; +- supports taking analytics information for UE communication from the NWDAF; +- supports taking analytics information for user data congestion from the NWDAF. +- supports taking analytics information for dispersion from the NWDAF; +- supports taking analytics information for session management congestion control experience from the NWDAF; +- supports taking analytics information for redundant transmission experience from the NWDAF; +- supports taking analytics information for DN performance from the NWDAF; +- supports taking analytics information for WLAN performance from the NWDAF; +- supports taking one or more above input from NWDAF into consideration for policies on assignment of network resources and/or for traffic steering policies; and +- supports taking analytics information for PDU Session traffic from the NWDAF. + +NOTE: How this information is used by the PCF is not standardized in this specification. + +The Network Slice Selection Function (NSSF): + +- supports taking slice load level information or network slice instance load level information from the NWDAF into consideration for slice selection; +- supports taking analytics information for service experience related network data from the NWDAF; and +- supports taking analytics information for dispersion at the slice from the NWDAF. + +The Access and Mobility Management Function (AMF): + +- supports taking SMF load information from the NWDAF into consideration for SMF selection; +- supports taking expected UE behaviour information (UE mobility and/or UE communication) from the NWDAF into consideration for monitoring UE behaviour; +- supports taking abnormal UE behaviour information from the NWDAF into consideration for adjustment of UE mobility related network parameters to solve the abnormal risk; +- supports taking slice load level information or network slice instance load level information from NWDAF into consideration for slice selection; +- supports taking analytics information for service experience related network data from the NWDAF; and + +- supports taking analytics information for dispersion at the slice from the NWDAF. + +The Session Management Function (SMF): + +- supports taking UPF load information from the NWDAF into consideration for UPF selection; +- supports taking expected UE behaviour information (UE mobility and/or UE communication) from the NWDAF into consideration for monitoring UE behaviour; +- supports taking UE mobility information from the NWDAF into consideration for UPF selection; +- supports taking abnormal UE behaviour information from the NWDAF into consideration for adjustment of UE mobility related network parameters to solve the abnormal risk; +- supports taking analytics information for SM congestion control experience from the NWDAF into consideration for determining back-off timer provided to UE; +- supports taking analytics information for slice load level or network slice instance load level from the NWDAF into consideration to determine slice selection; +- supports taking analytics information for service experience from the NWDAF into consideration to (re)select UP paths; +- supports taking analytics information for redundant transmission experience from the NWDAF to consider whether redundant transmission shall be performed, or (if it had been activated) shall be stopped; and +- supports taking analytics information for DN performance from the NWDAF into consideration for user plane performance. + +The Network Exposure Function (NEF): + +- supports taking analytics information for UE mobility from the NWDAF; +- supports taking analytics information for UE communication from the NWDAF; +- supports taking analytics information for expected UE behavioural (UE mobility and/or UE communication) from the NWDAF; +- supports taking analytics information for abnormal behaviour from the NWDAF; +- supports taking analytics information for user data congestion from the NWDAF; +- supports taking analytics information for network performance from the NWDAF; +- supports taking analytics information for QoS Sustainability from the NWDAF; +- supports taking analytics information for Dispersion from the NWDAF; +- supports taking analytics information for DN performance from the NWDAF; +- supports taking analytics information for Observed Service Experience from NWDAF; +- supports taking the analytics information for NWDAF assisted PFD Determination from the NWDAF when support PFDF function as the Network Exposure Function (Packet Flow Description Function) (NEF (PFDF)); +- supports taking analytics information for E2E data volume transfer time from NWDAF; +- supports taking analytics information for Relative Proximity from NWDAF; and +- supports taking analytics information for movement behaviour from NWDAF. + +The Application Function (AF): + +- supports receiving UE mobility information from the NWDAF or via the NEF; +- supports receiving UE communication information from the NWDAF or via the NEF; +- supports receiving expected UE behavioural information (UE mobility and/or UE communication) from the NWDAF or via the NEF; +- supports receiving abnormal behaviour information from the NWDAF or via the NEF; +- supports receiving user data congestion information from the NWDAF or via the NEF; +- supports receiving network performance information from the NWDAF or via the NEF; +- supports receiving QoS Sustainability information from the NWDAF or via the NEF; +- supports receiving Dispersion information from the NWDAF or via the NEF; +- supports receiving DN performance information from NWDAF or via the NEF; +- supports receiving Observed Service Experience information from NWDAF or via the NEF; +- supports receiving E2E data volume transfer time from NWDAF or via the NEF. +- supports receiving Movement Behaviour information from NWDAF or via the NEF. and +- supports receiving Relative Proximity information from NWDAF or via the NEF. + +The Location Management Function (LMF): + +- supports taking Location Accuracy analytics from the NWDAF into consideration as assistance for location services. + +The Operation, Administration, and Maintenance (OAM): + +- supports receiving slice load level information from the NWDAF; +- supports receiving observed service experience from the NWDAF; +- supports receiving NF load information from the NWDAF; +- supports receiving network performance information from the NWDAF; +- supports receiving UE mobility information from the NWDAF; +- supports receiving UE communication information from the NWDAF; +- supports receiving expected UE behaviour information (UE mobility and/or UE communication) from the NWDAF; and +- supports receiving abnormal UE behaviour information from the NWDAF. + +The Network Data Analytics Function (NWDAF): + +- supports receiving information for all types of network data analytics from the NWDAF; and +- supports receiving context information related to analytics subscriptions from the NWDAF. + +The Data Collection Coordination Function (DCCF): + +- supports receiving information for all types of network data analytics from the NWDAF. + +## 4.3.2 Service Operations + +### 4.3.2.1 Introduction + +**Table 4.3.2.1-1: Operations of the Nnwdaf\_AnalyticsInfo Service** + +| Service operation name | Description | Initiated by | +|--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| +| Nnwdaf_AnalyticsInfo_Request | This service operation is used by an NF to request and get specific analytics from NWDAF. | NF consumer (PCF, NSSF, AMF, SMF, NEF or NEF (PFDF), AF, LMF, OAM, NWDAF, DCCF) | +| Nnwdaf_AnalyticsInfo_ContextTransfer | This service operation is used by an NF to request and get context information related to analytics subscriptions from NWDAF. | NF consumer (NWDAF) | + +### 4.3.2.2 Nnwdaf\_AnalyticsInfo\_Request service operation + +#### 4.3.2.2.1 General + +The Nnwdaf\_AnalyticsInfo\_Request service operation is used by an NF service consumer to request and get specific analytics information from the NWDAF. + +#### 4.3.2.2.2 Request and get from NWDAF Analytics information + +Figure 4.3.2.2.2-1 shows a scenario where the NF service consumer (e.g. PCF) sends a request to the NWDAF to request and get from the NWDAF analytics information (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and the NWDAF. The consumer sends a GET request with analytics query parameters. The NWDAF responds with either a 200 OK or No Content.](b816e7bb064d3bfa02761aa679eb3726_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: Request analytics information + NF service consumer->>NWDAF: 1. GET « analytics?query_parameters » + Note right of NWDAF: Processing request + NWDAF-->>NF service consumer: 2a. 200 OK or 2b. No Content + +``` + +Sequence diagram showing the interaction between an NF service consumer and the NWDAF. The consumer sends a GET request with analytics query parameters. The NWDAF responds with either a 200 OK or No Content. + +**Figure 4.3.2.2.2-1: Requesting a NWDAF Analytics information** + +The NF service consumer (e.g. PCF) shall invoke the Nnwdaf\_AnalyticsInfo\_Request service operation when requesting the NWDAF analytics information. The NF service consumer shall send an HTTP GET request on the resource URI "{apiRoot}/nnwdaf-analyticsinfo//analytics" representing the "NWDAF Analytics" (as shown in figure 4.3.2.2.2-1, step 1), to request analytics data according to the query parameter value of the "event-id" attribute. In addition, the following information may be provided: + +- common reporting requirement in the "ana-req" attribute as follows: + - 1) identification of time window for the requested analytics data applies via identification of date-time(s) in the "startTs" and "endTs" attributes; + - 2) preferred level of accuracy of the analytics in "accuracy" attribute; + - 3) percentage of sampling among impacted UEs in the "sampRatio" attribute; + - 4) maximum number of objects in the "maxObjectNbr" attribute; + - 5) maximum number of SUPIs expected for an analytics report in the "maxSupiNbr" attribute; + - 6) identification of time when analytics information is needed in the "timeAnaNeeded" attribute if the feature "EneNA" is supported; + - 7) indication of which analytics metadata is requested to be delivered with the response in the "anaMeta" attribute if the feature "Aggregation" is supported; + - 8) requested values for the analytics metadata information to be used for the generation of the analytics in the "anaMetaInd" attribute if the feature "Aggregation" is supported; + - 9) preferred accuracy level per analytics subset in the "accPerSubset" attribute if the "listOfAnaSubsets" attribute is present and the EneNA feature is supported; and/or + - 10) the time period of historical analytics in the "histAnaTimePeriod" attribute if the "EneNA" feature is supported; + +NOTE 1: The NWDAF can use the use case context to select the most relevant ML model, when several ML models are available for the requested Analytics ID(s). The NWDAF containing AnLF can additionally provide the use case context when requesting an ML model from an NWDAF containing MTLF. The values of this parameter are not standardized. + +For all the event types, the "event-filter" attribute may include: + +- the analytics accuracy requirement information in "accuReq" attribute as indication to the NWDAF to activate checking the analytics accuracy information of the requested event, if the "AnalyticsAccuracy" feature is supported and the NF service consumer discovered or local configured the NWDAF containing an AnLF supporting the accuracy checking capability. +- use case context as "useCaseCxt" attribute, if the "ENAEExt" feature is supported. +- information related to roaming within the "roamingInfo" attribute if the "RoamingAnalytics" feature is supported; + +NOTE 2: The request for analytics accuracy information independently from request of the analytics event output is not supported in this release. + +For different event types: + +- if the event is "LOAD\_LEVEL\_INFORMATION", it shall provide the event specific filter information within "event-filter" attribute including identification(s) of the network slice via: + - 1) identification of network slice(s) in the "snssais" attribute; or + - 2) any slices indication in the "anySlice" attribute; +- if the feature "NsiLoad" is supported and the event is "NSI\_LOAD\_LEVEL", it shall provide the event specific filter information within "event-filter" attribute including identification(s) of the network slice via: + - 1) identification of network slice(s) and the optionally associated instance(s) if available, in the "nsiIdInfos" attribute; or + +NOTE 3: The network slice instance of a PDU session is not available in the PCF. + +- 2) any slices indication in the "anySlice" attribute; + +and may include: + +- 1) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "NSI\_LOAD\_LEVEL" event, if the "EneNA" feature is supported; + - 2) event specific filter information in the "event-filter" attribute: + - a) list of NF instance types in the "nfTypes" attribute, if the "NsiLoadExt" feature is supported; and/or + - b) identification of network area to which the request applies via identification of network area by "networkArea" attribute, if the "NsiLoadExt" feature is supported. +- if the feature "NfLoad" is supported and the event is "NF\_LOAD", it shall provide: +- 1) identification of target UE(s) to which the request applies by "supis" or "anyUe" in the "tgt-ue" attribute; and +- NOTE 4: Only NF instances of type AMF and SMF which are serving the UE can be determined using a SUPI in "supis" attribute. +- NOTE 5: If a list of the NF Instance IDs (or respectively of NF Set IDs) is provided, the NWDAF needs to provide the analytics for each designated NF instance (or respectively for each NF instance belonging to each designated NF Set). In such case the target UE(s) of the Analytics Reporting need be ignored. +- the "event-filter" attribute may provide: +- a) either list of NF instance IDs in the "nfInstanceIds" attribute or list of NF set IDs in the "nfSetIds" attribute if the identification of target UE(s) applies to all UEs; + - b) list of NF instance types in the "nfTypes" attribute; + - c) identification of network slice(s) in the "snssais" attribute; + - d) optional area of interest by "networkArea" attribute; and/or + - e) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to NF\_LOAD event, if the "EneNA" feature is supported; +- if the feature "UeMobility" is supported and the event is "UE\_MOBILITY", it shall provide: +- 1) identification of target UE(s) to which the request applies by "supis" or "intGroupIds" attribute in the "tgt-ue" attribute; +- and may include: +- a) identification of network area to which the request applies via identification of network area by "networkArea" attribute; + - b) if the feature "UeMobilityExt" is supported, + - i) identification of LADN DNN in the "ladnDnns" attribute; + - ii) visited Area(s) of Interest as the "visitedAreas" attribute; + - c) other UE mobility requirements in "ueMobilityReqs" attribute, if the "UeMobilityExt2\_eNA" feature is supported; + - d) preferred granularity of location information as the "locGranularity" attribute if the feature "UeMobilityExt2\_eNA" is also supported; + - e) identification of the preferred orientation of location information by "locOrientation" attribute if the feature "UeMobilityExt2\_eNA" is supported + - f) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "UE\_MOBILITY" event, if the "UeMobilityExt2\_eNA" and "EneNA" features are supported; + - g) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "UeMobilityExt2\_eNA" feature is supported; + - h) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "UeMobilityExt2\_eNA" feature is supported; + - i) the temporal granularity size in the "temporalGranSize" attribute if the "UeMobilityExt2\_eNA" feature is supported; and/or + - j) the fine granularity areas as the "fineGranAreas" attribute if the feature "UeMobilityExt2\_eNA" is supported. +- NOTE 6: For LADN service, the consumer (e.g. SMF) provides the LADN DNN to refer the LADN service area as the AOI. +- if the feature "UeCommunication" is supported and the event is "UE\_COMM", it shall provide: + +- 1) identification of target UE(s) to which the request applies by "supis" or "intGroupIds" attribute in the "tgt-ue" attribute; + +and may include: + +- 1) event specific filter information in the "event-filter" attribute: + - a) identification of the application as "appIds" attribute; + - b) identification of network area to which the request applies via identification of network area by "networkArea" attribute; + - c) identification of DNN in the "dnns" attribute; + - d) identification of network slice(s) in the "snssais" attribute; + - e) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "UE\_COMM" event, if the "EneNA" feature is supported; + - f) other UE communication requirements in "ueCommReqs" attribute, if the "UeCommunicationExt\_eNA" feature is supported; and/or + - g) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "UeCommunicationExt\_eNA" feature is supported. + - h) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "UeCommunicationExt\_eNA" feature is supported. +- if the feature "NetworkPerformance" is supported and the event is "NETWORK\_PERFORMANCE", it shall provide: + - 1) identification of target UE(s) to which the request applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgt-ue" attribute; + - 2) event specific filter information in the "event-filter" attribute which shall provide: + - a) the network performance types via "nwPerfTypes" attribute; + - b) the network performance requirements via "nwPerfReqs" attribute, if the feature "NetworkPerformanceExt\_eNA" is supported; + +the "event-filter" attribute may provide: + +- a) identification of network area to which the request applies via identification of network area(s) by "networkArea" attribute (mandatory if "anyUe" attribute is set to true); + - b) for each network performance type identified by "nwPerfTypes" attribute, the additional requirement by "addNwPerfReqs" attribute if the "NetworkPerformanceExt\_AIML" feature is supported; and/or + - c) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "DnPerfExt\_eNA" feature is supported; + - d) the spatial granularity size of TA in the "spatialGranSizeCell" attribute if the "DnPerfExt\_eNA" feature is supported; and/or +- e) the temporal granularity size of cell in the "temporalGranSize" attribute if the "DnPerfExt\_eNA" feature is supported.- if the feature "ServiceExperience" is supported and the event is "SERVICE\_EXPERIENCE", it shall provide: + - 1) identification of target UE(s) to which the request applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgt-ue" attribute; + - 2) event specific filter information in the "event-filter" attribute which shall provide: + - a) any slices indication in the "anySlice" attribute or identification of network slice(s) together with the optionally associated network slice instance(s) if available, via the "nsiIdInfos" attribute; and + +NOTE 7: The network slice instance of a PDU session is not available in the PCF. + +the "event-filter" attribute may provide: + +- a) identification of application(s) to which the request applies via "appIds" attribute; +- b) identification of DNN via identification of Dnn(s) by "dnns" attribute; +- c) identification of user plane accesses to one or more DN(s) where applications are deployed via "dnais" attribute; +- d) identification of network area to which the request applies via identification of network area(s) by "networkArea" attribute (mandatory if "anyUe" attribute is set to true); + +- e) if "appIds" attribute is provided, the bandwidth requirement of each application by "bwRequs" attribute; + - f) identification of all the RAT types and/or all the frequencies that the NWDAF received for the application or specific RAT type(s) and/or frequency(ies) by "ratFreqs" attribute if the feature "ServiceExperienceExt" is also supported; + - g) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "SERVICE\_EXPERIENCE" event, if the "EneNA" feature is supported; + - h) the identification of the UPF as the "upfInfo" attribute if the feature "ServiceExperienceExt" is also supported; + - i) IP address(s)/FQDN(s) of the Application Server(s) as the "appServerAddrs" attribute if the feature "ServiceExperienceExt" is also supported; + - j) combination of PDU Session parameters as the "pduSesInfos" attribute if the feature "ServiceExperienceExt2\_eNA" is also supported; + - k) preferred granularity of location information as the "locGranularity" attribute if the feature "ServiceExperienceExt2\_eNA" is supported; and/or + - l) the fine granularity areas as the "fineGranAreas" attribute if the feature "ServiceExperienceExt2\_eNA" is supported. +- if the feature "QoSustainability" is supported and the event is "QOS\_SUSTAINABILITY", it shall provide: +- 1) event specific filter information in the "event-filter" attribute which shall provide: + - a) identification of network area to which the request applies via identification of network area by "networkArea" attribute; and + - b) QoS requirements via "qosRequ" attribute; + - 2) identification of target UE(s) to which the request applies by "anyUe" in the "tgt-ue" attribute; +- the "event-filter" attribute may provide: +- a) identification of network slice(s) by "snssais" attribute; + - b) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "QoSustainExt\_eNA" feature is supported; + - c) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "QoSustainExt\_eNA" feature is supported; + - d) the temporal granularity size in the "temporalGranSize" attribute if the "QoSustainExt\_eNA" feature is supported; + - e) the fine granularity areas as the "fineGranAreas" attribute if the feature "QoSustainExt\_eNA" is supported. +- if the feature "AbnormalBehaviour" is supported and the event is "ABNORMAL\_BEHAVIOUR", it shall provide: +- 1) identification of target UE(s) to which the request applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgt-ue" attribute; and + - 2) event specific filter information in the "event-filter" attribute which shall provide + - a) either the expected analytics type via "exptAnaType" attribute or a list of exception Ids via "excepIds" attribute. If the expected analytics type via "exptAnaType" attribute is provided, the NWDAF shall derive the corresponding Exception Ids from the received expected analytics type as follows: + - if "exptAnaType" attribute sets to "MOBILITY", the corresponding list of Exception Ids are "UNEXPECTED\_UE\_LOCATION", "PING\_PONG\_ACROSS\_CELLS", "UNEXPECTED\_WAKEUP" and "UNEXPECTED\_RADIO\_LINK\_FAILURES"; + - if "exptAnaType" attribute sets to "COMMUN", the corresponding list of Exception Ids are "UNEXPECTED\_LONG\_LIVE\_FLOW", "UNEXPECTED\_LARGE\_RATE\_FLOW", "SUSPICION\_OF\_DDOS\_ATTACK", "WRONG\_DESTINATION\_ADDRESS" and "TOO\_FREQUENT\_SERVICE\_ACCESS"; + - if "exptAnaType" attribute sets to "MOBILITY\_AND\_COMMUN", the corresponding list of Exception Ids includes all above derived exception Ids. + +The derived list of Exception Ids are used by the NWDAF to notify the NF service consumer when UE's behaviour is exceptional based on one or more Exception Ids within the list. + +If the "anyUe" attribute in the "tgt-ue" attribute sets to "true": + +- a) the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepIds" attribute shall not be requested for both mobility and communication related analytics at the same time; +- b) if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepIds" attribute is mobility related, at least one of identification of network area by "networkArea" attribute and identification of network slice(s) by "snssais" attribute should be provided; and +- c) if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepIds" attribute is communication related, at least one of identification of network area by "networkArea" attribute, identification of application(s) by "appIds" attribute, identification of DNN(s) in the "dnns" attribute and identification of network slice(s) by "snssais" attribute should be provided; + +the "event-filter" attribute may provide: + +- a) expected UE behaviour via "exptUeBehav" attribute; +- if the feature "UserDataCongestion" is supported and the event is "USER\_DATA\_CONGESTION", it shall provide one of the following attributes: +- 1) identification of target UE(s) via "supis" "gpsi" (if feature "UserDataCongestionExt" is supported) or "anyUe" attribute within "tgt-ue" attribute; + - 2) event specific filter information in the "event-filter" attribute which shall provide: + - a) the user data congestion requirements via "userDataConReqs" attribute, if the feature "UserDataCongestionExt2\_eNA" is supported; + +and may provide: + +- 1) event specific filter information in the "event-filter" attribute which may provide: + - a) identification of network slice(s) by "snssais" attribute; + - b) identification of network area to which the request applies via identification of network area by "networkArea" attribute (mandatory if "anyUe" attribute is set to true); + - c) if the feature "UserDataCongestionExt" is also supported, request a list of top applications with maximum number that contribute the most to the traffic in uplink and/or downlink directions by the "maxTopAppUINbr" attribute and/or the "maxTopAppDINbr" attribute; and/or + - d) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "USER\_DATA\_CONGESTION" event, if the "EneNA" feature is supported; + - e) the temporal granularity size in the "temporalGranSize" attribute if the "UserDataCongestionExt2\_eNA" feature is supported. +- if the feature "SMCCE" is supported and the event is "SM\_CONGESTION", it shall provide: +- 1) event specific filter information in the "event-filter" attribute which shall provide: + - a) identification of DNN in the "dnns" attribute; and/or + - b) identification of network slice(s) in the "snssais" attribute; and + - 2) identification of target UE(s) via "supis" attribute in the "tgt-ue" attribute where the target UE(s) are one have the PDU Session for the DNN and/or S-NSSAI indicated by the event specific filter information; + +and may include: + +- 1) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "SM\_CONGESTION" event, if the "EneNA" feature is supported; + +NOTE 8: The predictions are not applicable for Session Management Congestion Control Experience analytics. + +- if the feature "Dispersion" is supported and the event is "DISPERSION", shall provide: + +- 1) identification of target UE(s) applies by "supis", "intGroupIds" or "anyUe" attribute within "tgt-ue" attribute, "anyUe" attribute is only supported in combination with "snssais" attribute, "networkArea" attribute and/or "disperClass" attribute; + +and may include: + +- 1) identification of network area applies via identification of network area by "networkArea" attribute; +- 2) identification of network slice(s) by "snssais" attribute; +- 3) application identifier(s) in "appIds" attribute; +- 4) dispersion analytics requirements in "disperReqs" attribute, which for the requested dispersion type may include dispersion class, ranking, ordering and/or accuracy requirements; +- 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "DISPERSION" event; +- 6) preferred granularity of location information as the "locGranularity" attribute if the feature "DispersionExt\_eNA" is supported; +- 7) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "DispersionExt\_eNA" feature is supported; +- 7) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "DispersionExt\_eNA" feature is supported; and/or +- 8) the temporal granularity size in the "temporalGranSize" attribute if the "DispersionExt\_eNA" feature is supported. + +- if the feature "RedundantTransmissionExp" is supported and the event is "RED\_TRANS\_EXP", shall provide: + +- 1) identification of target UE(s) applies by "supis", "intGroupIds" or "anyUe" attribute within "tgt-ue" attribute; + +and may include: + +- 1) identification of network area applies via identification of network area by "networkArea" attribute, if the "supis" attribute or "intGroupIds" attribute is included in the "tgt-ue" attribute; +- 2) identification of network slice(s) by "snssais" attribute; +- 3) identification of DNN in the "dnns" attribute; +- 4) other redundant transmission experience analysis requirements in "redTransReqs" attribute, which may include preferred order of results for the list of Redundant Transmission Experience; +- 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to RED\_TRANS\_EXP event, if the "EneNA" feature is supported; and/or +- 6) the temporal granularity size in the "temporalGranSize" attribute if the "RedundantTransExpExt\_eNA" feature is supported. + +- if the feature "WlanPerformance" is supported and the event is "WLAN\_PERFORMANCE", shall provide: + +- 1) identification of target UE(s) by "supis", "intGroupIds" or "anyUe" attribute in the "tgt-ue" attribute. If "anyUe" attribute is included in the "tgt-ue" attribute, then any of "networkArea" attribute, "ssIds" or "bssIds" attribute shall be present in the "wlanReqs" attribute; + +and may include: + +- 1) identification of network area to which the request applies via identification of network area by "networkArea" attribute; +- 2) other WLAN performance analytics requirements in "wlanReqs" attribute, which may include SSID(s), BSSID(s), preferred order of results for the list of WLAN performance information and/or accuracy per analytics subset; +- 3) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to WLAN\_PERFORMANCE event, if the "EneNA" feature is supported; and/or +- 4) the temporal granularity size in the "temporalGranSize" attribute if the "WlanPerfExt\_eNA" feature is supported. + +- if the feature "DnPerformance" is supported and the event is "DN\_PERFORMANCE", shall provide: + +- 1) identification of target UE(s) to which the request applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgt-ue" attribute; + +and may include: + +- 1) identification of network area to which the request applies via identification of network area by "networkArea" attribute; + +- 2) identification of network slice(s) in the "snssais" attribute; + - 3) identification of network slice and the optionally associated network slice instance(s) if available, via the "nsiIdInfos" attribute or any slices indication in the "anySlice" attribute; + - 4) application identifier(s) in "appIds" attribute; + - 5) an identification of DNN in the "dnns" attribute; + - 6) identification of a user plane access to one or more DN(s) where applications are deployed by "dnais" attribute; + - 7) the identification of the UPF as the "upfInfo" attribute; + - 8) IP address(s)/FQDN(s) of the Application Server(s) as the "appServerAddrs" attribute; + - 9) DN performance analytics requirements in "dnPerfReqs" attribute, which may include the preferred order of results for the list of DN performance information and/or the reporting threshold of each applicable analytics subset; and/or + - 10) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "DN\_PERFORMANCE" event, if the "EneNA" feature is supported and may include the attribute with value(s) only applicable to "DN\_PERFORMANCE" event and "DnPerformanceExt\_AIML" feature if supported. + - 11) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "DnPerfExt\_eNA" feature is supported. + - 11) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "DnPerfExt\_eNA" feature is supported. + - 12) the temporal granularity size in the "temporalGranSize" attribute if the "DnPerfExt\_eNA" feature is supported. +- if the feature "PfdDetermination" is supported and the event is "PFD\_DETERMINATION", shall provide: + - 1) a list of application identifier(s) in the "appIds" attribute. + +and may include: + + - 1) an identification of DNN in the "dnns" attribute; + - 2) identification of network slice(s) in the "snssais" attribute; + +NOTE 9: PFD Determination analytics do not have a target UE, they are always for any UE. The predictions are not applicable for PFD Determination analytics. + +- if the feature "E2eDataVolTransTime" is supported and the event is "E2E\_DATA\_VOL\_TRANS\_TIME", shall provide: + - 1) identification of target UE(s) to which the subscription applies by "supis" or "gpsi" attribute in the "tgt-ue" attribute. + +and may include: + + - 1) an identification of DNN in the "dnns" attribute; + - 2) identification of network slice in the "snssais" attribute; + - 3) application identifier(s) in "appIds" attribute; + - 4) area of interest of the UEs by "networkArea" attribute; restricts the scope of the E2E data volume transfer time analytics to the provided area; + - 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "E2E\_DATA\_VOL\_TRANS\_TIME" event, if the "EneNA" feature is supported; + - 6) the QoS requirements via "qosRequ" attribute; + - 7) E2E data volume transfer time requirements in the "dataVITrmsTmRqs" attribute; and + - 8) either a target number of repeating data transmissions by "repeatDataTrans" attribute or a target time interval between data transmissions within by "tsIntervalDataTrans" attribute the Analytics target period; +- if the feature "PduSesTraffic" is supported and the event is "PDU\_SESSION\_TRAFFIC", shall provide: + - 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgt-ue" attribute; + - 2) PDU Session traffic analytics requirements in "pduSesTrafReqs" attribute, which includes the known Application Identifier, IP Descriptions or Domain Descriptors. + - 3) DNN and/or S-NSSAI for the PDU Session(s) in the "dnns" and/or "snssais" attributes. + +and may include: + +- 1) identification of network area to which the request applies via identification of network area by "networkArea" attribute; and/or +- 2) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "PDU\_SESSION\_TRAFFIC" event, if the "EneNA" feature is supported. + +NOTE 10: The predictions are not applicable for PDU Session traffic analytics. + +- if the feature "MovementBehaviour" is supported and the event is "MOVEMENT\_BEHAVIOUR", shall provide: + - 1) identification of network area to which the request applies via identification of network area by "networkArea" attribute; +- and may include: + - 1) identification of the preferred orientation of location information by "locOrientation" attribute; + - 2) Movement Behaviour analytics requirements in "movBehavReqs" attribute, which includes preferred granularity of location information or preferred orientation of location information; and/or + - 3) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "MOVEMENT\_BEHAVIOUR" event, if the "EneNA" features is supported. +- if the feature "LocAccuracy" is supported and the event is "LOC\_ACCURACY", the "event-filter" attribute shall include: + - 1) either a network area to which the request applies within the "networkArea" attribute or an exact location to which the request applies within the "location" attribute; +- and the "event-filter" attribute may include: + - 1) Location accuracy analytics requirements within the "locAccReqs" attribute; and/or + - 2) an optional list of analytics subsets within the "listOfAnaSubsets" attribute with value(s) only applicable to the "LOC\_ACCURACY" event, if the "EneNA" features is supported. + +NOTE 11: Location accuracy analytics do not have a target UE, they are always for any UE. + +- if the feature "RelativeProximity" is supported and the event is "RELATIVE\_PROXIMITY", shall provide: + - 1) identification of target UE(s) to which the request applies by "supis" or "intGroupIds" attribute in the "tgt-ue" attribute; +- and may include in the "event-filter" attribute: + - 1) identification of DNN in the "dnns" attribute; + - 2) identification of network slice in the "snssais" attribute; + - 3) identification of network area to which the request applies via identification of network area by "networkArea" attribute; + - 4) Relative Proximity analytics requirements in "relProxReqs" attribute; and/or + - 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "RELATIVE\_PROXIMITY" event prediction, if the "EneNA" features is supported. + +Upon the reception of the HTTP GET request, the NWDAF shall: + +- analyse the requested analytic data according to the requested event. + +If the HTTP request message from the NF service consumer is accepted, the NWDAF shall respond with "200 OK" status code with the message body containing the analytics with parameters as relevant for the requesting NF service consumer. The AnalyticsData data structure in the response body shall include: + +- analytics with the corresponding information as described in clause 4.2.2.4.2. +- the analytics accuracy information in the "accuInfo" attribute, if the feature "AnalyticsAccuracy" is supported and the analytics accuracy requirement was requested in the "accuReq" attribute. + +NOTE 12: In this version of the specification, NWDAF containing AnLF can provide accuracy information to an NF consumer that requests both the analytics and the accuracy information. + +NOTE 13: When receiving a request from an NF consumer that includes a request for accuracy information, the analytics and the accuracy information can be provided by NWDAF containing AnLF within the single response. + +If the requested NWDAF Analytics data does not exist, the NWDAF shall respond with "204 No Content" status code. + +If the "timeAnaNeeded" attribute within EventReportingRequirement is provided during the request, if the time is reached but the requested analytics information is not ready, the consumer does not need to wait for the analytics information any longer, the NWDAF may send a "500 Internal Server Error" status code to the NF service consumer. In addition, if the EneNA feature is supported, the NWDAF may provide, within the ProblemDetailsAnalyticsInfoRequestdata in the response, the corresponding failure reason via a "problemDetails" attribute with the "cause" attribute set to "UNSATISFIED\_REQUESTED\_ANALYTICS\_TIME" and a minimum time interval recommended by the NWDAF via a "rvWaitTime" attribute which is used by the NF service consumer to determine the time when analytics information is needed in similar future analytics requests. + +If the analytics target period provided in the body of the HTTP GET request includes the start time in the past and the end time in the future, the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "BOTH\_STAT\_PRED\_NOT\_ALLOWED". + +When the "PredictionError" feature is supported, if the analytics target period provided in the body of the HTTP GET request includes the prediction time period in the future and the event is "SM\_CONGESTION", "PFD\_DETERMINATION" and/or "PDU\_SESSION\_TRAFFIC", the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "PREDICTION\_NOT\_ALLOWED". + +If the statistics in the past are requested but the necessary data to perform the service is unavailable, the NWDAF shall reject the request with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "UNAVAILABLE\_DATA". + +If the user consent has not been checked by the NF service consumer and is required for the requested analytics collection depending on local policy and regulations, then the NWDAF shall check user consent for the targeted UE(s) by retrieving the user consent subscription data via the Nudm\_SDM service API of the UDM as described in clause 5.2.2 of 3GPP TS 29.503 [23]. If the NWDAF receive the response from the UDM that it is not granted for the impacted user(s), then the NWDAF shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "USER\_CONSENT\_NOT\_GRANTED". + +NOTE 13: When the target of reporting is a SUPI or a GPSI then the subscription can be rejected, e.g. because user consent is not granted, and the error is sent to the consumer. When the target of reporting is an Internal Group Id, or a list of SUPIs/GPSI(s) or any UE, and the user consent is not granted for a subset of the impacted users, then no error is sent, but a subset of the SUPIs/GPSIs is skipped if user consent is not granted. + +If an error occurs when processing the HTTP GET request, the NWDAF shall send an HTTP error response as specified in clause 5.2.7. + +### 4.3.2.3 Nnwdaf\_AnalyticsInfo\_ContextTransfer service operation + +#### 4.3.2.3.1 General + +The Nnwdaf\_AnalyticsInfo\_ContextTransfer service operation is used by an NF service consumer to request and get context information related to analytics subscriptions from the NWDAF. + +#### 4.3.2.3.2 Request and get from NWDAF context of a subscription + +Figure 4.3.2.3.2-1 shows a scenario where the NF service consumer (e.g. NWDAF) sends a request to the NWDAF to request and get from NWDAF context information related to analytics subscriptions (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the request and response for NWDAF context information. The NF service consumer sends a GET request to the NWDAF, and the NWDAF responds with either a 200 OK or No Content.](fcc757566216206ceddbd6c775e8db02_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + Note right of NWDAF: + NF service consumer->>NWDAF: 1. GET « context?query_parameters + NWDAF-->>NF service consumer: 2a. 200 OK or 2b. No Content + +``` + +Sequence diagram showing the request and response for NWDAF context information. The NF service consumer sends a GET request to the NWDAF, and the NWDAF responds with either a 200 OK or No Content. + +**Figure 4.3.2.3.2-1: Requesting NWDAF context information related to analytics subscriptions** + +The NF service consumer (e.g. NWDAF) shall invoke the Nnwdaf\_AnalyticsInfo\_ContextTransfer service operation when requesting context information related to analytics subscriptions. The NF service consumer shall send an HTTP GET request on the resource URI "{apiRoot}/nnwdaf-analyticsinfo//context" representing the "NWDAF Context" (as shown in figure 4.3.2.3.2-1, step 1), to request context information related to analytics subscriptions according to the query parameter values of the attributes "context-ids" and "req-context". + +Upon the reception of the HTTP GET request, the NWDAF shall retrieve the context information for the requested context identifiers. + +If the HTTP request message from the NF service consumer is accepted, the NWDAF shall respond with "200 OK" status code with the message body containing the retrieved context information. The ContextData data structure in the response body shall include for each of the context elements contained in the "contextElem" attribute: + +- the context identifier that this context element refers to in the "contextId" attribute, which indicates among others the analytics subscription that this context element is associated with. +- the pending output analytics for the indicated analytics subscription in the "pendAnalytics" attribute if such analytics are available and the NF service consumer has indicated the "PENDING\_ANALYTICS" context type in the "req-context" attribute of the request. +- the historical output analytics for the indicated analytics subscription in the "histAnalytics" attribute if such analytics are available and the NF service consumer has indicated the "HISTORICAL\_ANALYTICS" context type in the "req-context" attribute of the request. +- a timestamp of the last provided output analytics in the "lastOutputTime" if the NF service consumer has indicated the "PENDING\_ANALYTICS" and/or "HISTORICAL\_ANALYTICS" context type in the "req-context" attribute of the request and output analytics had been provided to the analytics consumer. +- information about aggregation related analytics subscriptions that the NWDAF has with other NWDAFs in the "aggrSubs" attribute if such subscriptions exist and the NF service consumer has indicated the "AGGR\_SUBS" context type in the "req-context" attribute of the request. +- historical data related to the indicated analytics subscription in the "histData" attribute if such data exists and the NF service consumer has indicated the "DATA" context type in the "req-context" attribute of the request. +- identifier of ADRF instance in the "adrId" attribute if the NWDAF stores data in the ADRF. +- the types of data stored in the ADRF in the "adrDataTypes" attribute if the "adrId" attribute is provided. +- identifiers of NWDAF instances used when aggregating multiple analytics subscriptions in the "aggrNwdaIds" if such information is available and the NF service consumer has indicated the "AGGR\_INFO" context type in the "req-context" attribute of the request. +- information about used ML models in the "modelInfos" attribute if such information is available and the NF service consumer has indicated the "ML\_MODELS" context type in the "req-context" attribute of the request. + +If the requested context information does not exist, the NWDAF shall respond with "204 No Content" status code. + +## 4.4 Nnwdaf\_DataManagement Service + +### 4.4.1 Service Description + +#### 4.4.1.1 Overview + +The Nnwdaf\_DataManagement Service as defined in 3GPP TS 23.288 [17] is provided by the Network Data Analytics Function (NWDAF). + +This service: + +- allows the NF service consumers to subscribe to and unsubscribe from data management related events; +- notifies the NF service consumers with the subscribed events which are detected by the NWDAF; and +- allows the NF service consumers to retrieve the subscribed data from the NWDAF. + +#### 4.4.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [17]. The Network Data Analytics signalling flows are defined in 3GPP TS 29.552 [25]. + +The Nnwdaf\_DataManagement service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF). + +Known consumers of the Nnwdaf\_DataManagement service are: + +- Network Data Analytics Function (NWDAF) +- Data Collection Coordination Function (DCCF) +- Messaging Framework Adaptor Function (MFAF) +- Analytics Data Repository Function (ADRF) + +![Reference Architecture for the Nnwdaf_DataManagement Service; SBI representation](a3c1310e720178d2450a3748c7c75422_img.jpg) + +This diagram illustrates the Service Based Interface (SBI) representation of the Nnwdaf\_DataManagement service. At the top, a rectangular box labeled 'NWDAF' contains an oval labeled 'Nnwdaf'. A vertical line descends from this oval to a horizontal bus line. To the right of the bus line is the label 'Nnwdaf\_DataManagement'. Below the bus line, four rectangular boxes are connected in parallel, labeled from left to right: 'NWDAF', 'DCCF', 'MFAF', and 'ADRF'. + +Reference Architecture for the Nnwdaf\_DataManagement Service; SBI representation + +**Figure 4.4.1.2-1: Reference Architecture for the Nnwdaf\_DataManagement Service; SBI representation** + +![Reference Architecture for the Nnwdaf_DataManagement Service: reference point representation](bdb44cc8120caccddc2adf0c3db54261_img.jpg) + +This diagram illustrates the reference point representation of the Nnwdaf\_DataManagement service. At the top, a rectangular box labeled 'NWDAF' has four lines radiating downwards to four separate rectangular boxes at the bottom. These boxes are labeled from left to right: 'NWDAF', 'DCCF', 'MFAF', and 'ADRF'. + +Reference Architecture for the Nnwdaf\_DataManagement Service: reference point representation + +**Figure 4.4.1.2-2: Reference Architecture for the Nnwdaf\_DataManagement Service: reference point representation** + +#### 4.4.1.3 Network Functions + +##### 4.4.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF) provides requested data to NF consumers. + +The Network Data Analytics Function (NWDAF) allows NF consumers to subscribe to and unsubscribe from the notification of detected event(s). + +The Network Data Analytics Function (NWDAF) allows NF consumers to retrieve data that was collected based on their subscriptions. + +##### 4.4.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF): + +- supports (un)subscription to the notification of data exposed by the NWDAF; +- supports retrieving data from the NWDAF. + +The Data Collection Coordination Function (DCCF): + +- supports (un)subscription to the notification of data exposed by the NWDAF; +- supports retrieving data from the NWDAF. + +The Messaging Framework Adaptor Function (MFAF): + +- supports receiving notifications of data provided by the NWDAF; +- supports retrieving data from the NWDAF. + +The Analytics Data Repository Function (ADRF): + +- supports receiving notifications of data provided by the NWDAF. +- supports retrieving data from the NWDAF. + +#### 4.4.2 Service Operations + +##### 4.4.2.1 Introduction + +**Table 4.4.2.1-1: Operations of the Nnwdaf\_DataManagement Service** + +| Service operation name | Description | Initiated by | +|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| +| Nnwdaf_DataManagement_Subscribe | This service operation is used by an NF service consumer to subscribe to data management related event(s) from NWDAF. | NF service consumer (NWDAF, DCCF, MFAF, ADRF) | +| Nnwdaf_DataManagement_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe to data management related event(s). | NF service consumer (NWDAF, DCCF, MFAF, ADRF) | +| Nnwdaf_DataManagement_Notify | This service operation is used by the NWDAF to notify the detected event(s) to the NF service consumer instance which has subscribed to. | NWDAF | +| Nnwdaf_DataManagement_Fetch | This service operation is used by an NF service consumer to retrieve the subscribed data. | NF service consumer (NWDAF, DCCF, MFAF) | + +##### 4.4.2.2 Nnwdaf\_DataManagement\_Subscribe service operation + +###### 4.4.2.2.1 General + +The Nnwdaf\_DataManagement\_Subscribe service operation is used by an NF service consumer to create or update a subscription for data notifications from the NWDAF. + +###### 4.4.2.2.2 Subscription for data notifications + +Figure 4.4.2.2.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to subscribe for data notification(s). + +![Sequence diagram showing the NF service consumer subscribing to data notifications from the NWDAF. Step 1: POST.../subscriptions from NF service consumer to NWDAF. Step 2: 201 Created response from NWDAF to NF service consumer.](e2c120be98ede6deb60dd341f5a9803b_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. POST.../subscriptions + NF service consumer->>NWDAF: Request + Note left of NWDAF: 2. "201 Created" + NWDAF-->>NF service consumer: Response + +``` + +Sequence diagram showing the NF service consumer subscribing to data notifications from the NWDAF. Step 1: POST.../subscriptions from NF service consumer to NWDAF. Step 2: 201 Created response from NWDAF to NF service consumer. + +**Figure 4.4.2.2.2-1: NF service consumer subscribes to data notifications** + +The NF service consumer shall invoke the Nnwdaf\_DataManagement\_Subscribe service operation to subscribe to data notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwdaf-datamanagement//subscriptions" as Resource URI representing the "NWDAF Data Management Subscriptions", as shown in figure 4.4.2.2.2-1, step 1, to create a subscription for an "Individual NWDAF Data Management Subscription" according to the information in message body. + +The NnwdafDataManagementSubsc data structure provided in the request body shall include: + +- an URI where to receive the requested notifications as "notificURI" attribute; +- notification correlation identifier within the "notifCorrId" attribute; and +- one of the following: + - analytics subscription information to be used to determine which data shall be collected and reported within the "anaSub" attribute; + - data subscription information within the "dataSub" attribute; + +The NnwdafDataManagementSubsc data structure provided in the request body may include: + +- the notification endpoints within the "notifEndpoints" attribute if the "DataAnaCollect" feature is supported; +- formatting instructions within the "formatInstruct" attribute; +- processing instructions within the "procInstruct" attribute or the "multiProcInstructs" attribute if the "MultiProcessingInstruction" feature is supported; +- one of the following identifiers related to the ADRF: + - ADRF instance identifier within the "adrflId" attribute; + - ADRF set identifier within the "adrSetId" attribute; +- one of the following target identifiers: + - NF instance identifier within the "targetNfId" attribute; + - NF set identifier within the "targetNfSetId" attribute; +- time window of the occurrence of the requested data collection within the "timePeriod" attribute; +- the purpose of data collection within the "dataCollectPurposes" attribute. +- the indication that the NF service consumer has already checked the user consent within the "checkedConsentInd" attribute. +- storage handling information within the "storeHandl" attribute, if the "EnhDataMgmt" feature is supported. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nnwdaf-datamanagement//subscriptions" as Resource URI and NnwdafDataManagementSubsc data structure as request body, the NWDAF shall use the contents of the request to determine whether the subscription can already be served or interactions with the ADRF and/or data sources are required. If the NWDAF cannot use the contents of the request to determine this, the NWDAF shall send an HTTP "400 Bad Request" error response including the "cause" attribute set to "SUBSCRIPTION\_CANNOT\_BE\_SERVED". + +NOTE 1: The "SUBSCRIPTION\_CANNOT\_BE\_SERVED" error can occur, for example, in the case where the "dataSub" or "anaSub" attributes are provided, when the request is syntactically valid and there is no NWDAF internal error, but the NWDAF can neither find an existing subscription to a data source nor construct one based on the received subscription contents. + +If the user consent has not been checked by the NF service consumer and is required for the requested data collection depending on local policy and regulations, then the NWDAF shall check user consent for the targeted UE(s) by retrieving the user consent subscription data via the Nudm\_SDM service API of the UDM as described in clause 5.2.2 + +of 3GPP TS 29.503 [23]. If the NWDAF receives the response from the UDM that it is not granted for the impacted user(s), then the NWDAF shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "USER\_CONSENT\_NOT\_GRANTED". + +NOTE 2: When the target of reporting is a SUPI or a GPSI then the subscription can be rejected, e.g. because user consent is not granted, and the error is sent to the consumer. When the target of reporting is an Internal Group Id, or a list of SUPIs/GPSI(s) or any UE, and the user consent is not granted for a subset of the impacted users, then no error is sent, but a subset of the SUPIs/GPSIs is skipped if user consent is not granted. + +If the NWDAF determines that the subscription can already be served (without requiring further interactions with ADRF and/or data sources) or a successful response from the ADRF and/or data sources is received for the creation or modification of subscription(s) to serve this subscription, the NWDAF shall: + +- create a new subscription; +- assign a subscriptionId; +- store the subscription. + +If the NWDAF created an "Individual NWDAF Data Management Subscription" resource, the NWDAF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.4.2.2.2-1, step 2. The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. + +"{apiRoot}/nnwdaf-datamanagement/{apiVersion}/subscriptions/{subscriptionId}". If an immediate reporting indication is provided in the subscription, the NWDAF shall include the reports of the events subscribed, if available, in the HTTP POST response within the "dataSub" attribute, or, if the DataAnaCollect feature is supported, potentially within the "immReport" attribute. + +If the NWDAF receives storage handling information in the request but determines (e.g. based on local policy) that a different storage approach shall be followed, it indicates the determined storage approach to the consumer by setting accordingly the "storeHandl" attribute (e.g. providing a different lifetime, or setting the indication about deletion alerts to "false") in the message body of the response. When more than one consumer has requested storage lifetime for the same analytics, the storage approach should be based on the longest requested storage lifetime. + +NOTE 3: The default operator policy for how long analytics is to be stored can be longer or shorter than the lifetime requested by the consumer. A default operator policy can for example accept only consumer requested lifetimes that are shorter or longer than the default policy. + +When the notification flag of the "dataSub" attribute (e.g. the "notifFlag" attribute within the "eventsRepInfo" attribute in the case of AF events) is included and set to "DEACTIVATE" in the request, the NWDAF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the notification flag to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). When a muting exception occurs, if the EnhDataMgmt feature is supported, the NWDAF may consider the contents of the muting instructions of the "dataSub" attribute (if provided; e.g. the "notifFlagInstruct" attribute within the "eventsRepInfo" attribute in the case of AF events) and/or local configuration to determine its actions. + +If the EnhDataMgmt feature is supported and the NWDAF accepts the provided notification flag and muting instructions, it may indicate the applied muting notification settings in the response (e.g. within the "mutingSetting" attribute in the case of AF events). If the NWDAF does not accept the provided notification flag and muting instructions, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.3.7. + +#### 4.4.2.2.3 Update subscription for data notifications + +Figure 4.4.2.2.3-1 shows a scenario where the NF service consumer sends a request to the NWDAF to update the subscription for data notifications. + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF to update a subscription. The consumer sends a PUT request to /subscriptions/{subscriptionId} and the NWDAF responds with either 200 OK or 204 No Content.](5e9af8986a5845504f251d3079da8078_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NWDAF: 1. PUT.../subscriptions/{subscriptionId} + NWDAF-->>NF service consumer: 2a. "200 OK" or +2b. "204 No Content" + +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF to update a subscription. The consumer sends a PUT request to /subscriptions/{subscriptionId} and the NWDAF responds with either 200 OK or 204 No Content. + +**Figure 4.4.2.2.3-1: NF service consumer updates subscription to data notifications** + +The NF service consumer shall invoke the Nnwdaf\_DataManagement\_Subscribe service operation to update subscription to data notifications. The NF service consumer shall send an HTTP PUT request with "{apiRoot}/nnwdaf-datamanagement//subscriptions/{subscriptionId}" as Resource URI representing the "Individual NWDAF Data Management Subscription", as shown in figure 4.4.2.2.3-1, step 1, to update the subscription for an "Individual NWDAF Data Management Subscription" resource identified by the {subscriptionId}. The NnwdafDataManagementSubsc data structure provided in the request body shall include the same contents as described in clause 4.4.2.2.2. + +Upon the reception of an HTTP PUT request with: + +"{apiRoot}/nnwdaf-datamanagement//subscriptions/{subscriptionId}" as Resource URI and NnwdafDataManagementSubsc data structure as request body, the NWDAF shall use the contents of the request to determine whether the updated subscription can already be served or interactions with the ADRF and/or data sources are required. If the NWDAF cannot use the contents of the request to determine this, the NWDAF shall send an HTTP "400 Bad Request" error response including the "cause" attribute set to "SUBSCRIPTION\_CANNOT\_BE\_SERVED". + +NOTE 1: The "SUBSCRIPTION\_CANNOT\_BE\_SERVED" error can occur, for example, in the case when the "dataSub" or "anaSub" attributes are provided, when the request is syntactically valid and there is no NWDAF internal error, but the NWDAF can neither find an existing subscription to a data source nor construct one based on the received subscription contents. + +If the NWDAF determines that the updated subscription can already be served (without requiring further interactions with the ADRF and/or data sources) or a successful response from the ADRF and/or data sources is received for the creation or modification of subscription(s) to serve this subscription, the NWDAF shall: + +- update the subscription of corresponding subscriptionId; and +- store the subscription. + +If the NWDAF successfully processed and accepted the received HTTP PUT request, the NWDAF shall update an "Individual NWDAF Data Management Subscription" resource, and shall respond with: + +- a) HTTP "200 OK" status code with the message body containing a representation of the updated subscription, as shown in figure 4.4.2.2.3-1, step 2a; If an immediate reporting indication is provided in the request, the NWDAF shall include the reports of the events subscribed, if available, in the HTTP PUT response within the "dataSub" attribute, or, if the DataAnaCollect feature is supported, potentially within the "immReport" attribute; or +- b) HTTP "204 No Content" status code, as shown in figure 4.4.2.2.3-1, step 2b. + +If the NWDAF receives storage handling information in the request but determines (e.g. based on local policy) that a different storage approach shall be followed, it indicates the determined storage approach to the consumer by setting accordingly the "storeHandl" attribute (e.g. providing a different lifetime, or setting the indication about deletion alerts to "false") in the message body of the response. When more than one consumer has requested storage lifetime for the same analytics, the storage approach should be based on the longest requested storage lifetime. + +NOTE 2: The default operator policy for how long analytics is to be stored can be longer or shorter than the lifetime requested by the consumer. A default operator policy can for example accept only consumer requested lifetimes that are shorter or longer than the default policy. + +When the notification flag of the "dataSub" attribute (e.g. the "notifFlag" attribute within the "eventsRepInfo" attribute in the case of AF events) is included in the request with the value "DEACTIVATE", the NWDAF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the + +notification flag attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). When a muting exception occurs, if the EnhDataMgmt feature is supported, the NWDAF may consider the contents of the muting instructions of the "dataSub" attribute (if provided; e.g. the "notifFlagInstruct" attribute within the "eventsRepInfo" attribute in the case of AF events) and/or local configuration to determine its actions; if the notification flag is set to the value "RETRIEVAL", the NWDAF shall send the stored events to the NF service consumer, mute the event notification again and store available events; if the notification flag is set to the value "ACTIVATE" and the event notifications are muted (due to a previously received "DEACTIVATE" value), the NWDAF shall unmute the event notification, i.e. start sending again notifications for available events. + +If the EnhDataMgmt feature is supported and the NWDAF accepts the provided notification flag and muting instructions, it may indicate the applied muting notification settings in the response (e.g. within the "mutingSetting" attribute in the case of AF events). If the NWDAF does not accept the provided notification flag and muting instructions, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". If errors occur when processing the HTTP PUT request, the NWDAF shall send an HTTP error response as specified in clause 5.3.7. + +If the NWDAF determines the received HTTP PUT request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.4.2.3 Nnwdaf\_DataManagement\_Unsubscribe service operation + +##### 4.4.2.3.1 General + +The Nnwdaf\_DataManagement\_Unsubscribe service operation is used by an NF service consumer to remove a subscription for data notifications from the NWDAF. + +##### 4.4.2.3.2 Unsubscribe from data notifications + +Figure 4.4.2.3.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to unsubscribe from data notifications. + +![Sequence diagram showing the unsubscribe process between an NF service consumer and the NWDAF.](cc468dcda006ef315536400517a09ad3_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. DELETE.../subscriptions/{subscriptionId} + NF service consumer->>NWDAF: 1. DELETE.../subscriptions/{subscriptionId} + Note left of NWDAF: 2. "204 No Content" + NWDAF-->>NF service consumer: 2. "204 No Content" +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and the NWDAF. The first message, labeled '1. DELETE.../subscriptions/{subscriptionId}', is sent from the NF service consumer to the NWDAF. The second message, labeled '2. "204 No Content"', is sent from the NWDAF back to the NF service consumer. + +Sequence diagram showing the unsubscribe process between an NF service consumer and the NWDAF. + +**Figure 4.4.2.3.2-1: NF service consumer unsubscribes from data notifications** + +The NF service consumer shall invoke the Nnwdaf\_DataManagement\_Unsubscribe service operation to unsubscribe from data notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nnwdaf-datamanagement//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the identifier of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- remove the corresponding subscription; +- respond to the NF service consumer: + - respond with HTTP "204 No Content" status code if the "EnhDataMgmt" feature is not supported or no stored unsent events to be included in the response; or + +- respond with HTTP "200 OK" status code if the "EnhDataMgmt" feature is supported and including the stored unsent events in the NnwdafDataManagementNotif data type in the response. + +If errors occur when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.3.7. + +If the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.4.2.4 Nnwdaf\_DataManagement\_Notify service operation + +##### 4.4.2.4.1 General + +The Nnwdaf\_DataManagement\_Notify service operation is used by the NWDAF to notify NF service consumers about subscribed events related to data. + +##### 4.4.2.4.2 Notification about subscribed data + +Figure 4.4.2.4.2-1 shows a scenario where the NWDAF sends a request to the NF service consumer to notify for event notifications (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and the NWDAF. The NF service consumer sends a POST request with {notificURI} to the NWDAF. The NWDAF responds with a 204 No Content or 200 OK status code.](1ae16a393229b439c7b3f8b2e63d8d6c_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. POST {notificURI} + NF service consumer->>NWDAF: 1. POST {notificURI} + Note left of NWDAF: 2. 204 No Content or 200 OK + NWDAF-->>NF service consumer: 2. 204 No Content or 200 OK +``` + +Sequence diagram showing the interaction between an NF service consumer and the NWDAF. The NF service consumer sends a POST request with {notificURI} to the NWDAF. The NWDAF responds with a 204 No Content or 200 OK status code. + +**Figure 4.4.2.4.2-1: NWDAF notifies the subscribed event** + +The NWDAF shall invoke the Nnwdaf\_DataManagement\_Notify service operation to notify the subscribed event. The NWDAF shall send an HTTP POST request with "{notificURI}" received in the Nnwdaf\_DataManagement\_Subscribe service operation as Resource URI, as shown in figure 4.4.2.4.2-1, step 1. + +The NnwdafDataManagementNotif data structure provided in the request body that shall include: + +- the notification correlation identifier within the "notifCorrId" attribute; +- the timestamp of the notification within the "notifTimestamp" attribute; +- one of the following: + - data collected from data sources (e.g. SMF, NEF) in the "dataNotification" attribute; + - summarized data derived from events that occurred based on processing and formatting instructions in the "dataReports" attribute; + - information for fetching the contents of the notification in the "fetchInstruct" attribute. + - a deletion alert in the "delAlert" attribute, if the "EnhDataMgmt" feature is supported. + +The NnwdafDataManagementNotif data structure provided in the request body may include: + +- an indication that the NWDAF has requested a termination of the subscription within the "terminationReq" attribute; and/or +- a pending notification cause for the stored unsent data in the "pendNotifCause" attribute if the "EnhDataMgmt" feature is supported. + +Upon the reception of an HTTP POST request, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall store the notification and respond with HTTP "204 No + +Content" status code, or with HTTP "200 OK" status code and the NotifResponse data structure in the response body if the "EnhDataMgmt" feature is supported. + +After the successful processing of the HTTP POST request: + +- if the NWDAF requests the NF service consumer with the "fetchInstruct" attribute to retrieve the data, the NF service consumer may invoke the Nnwdaf\_DataManagement\_Fetch service operation to retrieve the notified data as defined in clause 4.4.2.5. +- if the NWDAF provided a deletion alert to the NF service consumer, the NF service consumer may invoke the Nadrf\_DataManagement\_RetrievalRequest service operation as defined in 3GPP TS 29.575 [27] clause 4.2.2.5, using the storage transaction identifier received within the "alertStorTransId" attribute of the "delAlert" attribute, in order to retrieve the data that are about to be deleted. + +NOTE: The "alertStorTransId" attribute, which is used for retrieving data prior to deletion, does not have to be the same with or related to the storage transaction identifier that is assigned and returned during the storage of the data in the ADRF. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.3.7. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.4.2.5 Nnwdaf\_DataManagement\_Fetch service operation + +##### 4.4.2.5.1 General + +The Nnwdaf\_DataManagement\_Fetch service operation is used by an NF service consumer to retrieve data notifications indicated by fetch instructions from the NWDAF. + +##### 4.4.2.5.2 Retrieve data from the NWDAF + +Figure 4.4.2.5.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to retrieve notified data. + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF to retrieve notified data. The NF service consumer sends a POST {fetchUri} request to the NWDAF, and the NWDAF responds with a 200 OK.](b97737027bd1b2effd7ca4dba8914877_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: Requesting to retrieve notified data + NF service consumer->>NWDAF: 1. POST {fetchUri} + NWDAF-->>NF service consumer: 2. 200 OK +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF to retrieve notified data. The NF service consumer sends a POST {fetchUri} request to the NWDAF, and the NWDAF responds with a 200 OK. + +**Figure 4.4.2.5.2-1: Requesting to retrieve notified data** + +The NF service consumer shall invoke the Nnwdaf\_DataManagement\_Fetch service operation to retrieve notified data. The NF service consumer shall send an HTTP POST request with "{fetchUri}" URI previously provided by the NWDAF in "fetchInstruct" attribute within NnwdafDataManagementNotif data type, as shown in figure 4.4.2.5.2-1, step 1, to fetch NWDAF data. The request body shall include fetch correlation identifiers, which was previously provided by the NWDAF in the "fetchCorrIds" attribute within fetchInstruction in the NWDAF notification. + +Upon the reception of the HTTP POST request, the NWDAF shall: + +- find the data according to the requested parameters. + +If the requested data is found, the NWDAF shall respond with "200 OK" status code with the message body containing the NnwdafDataManagementNotif data structure. The NnwdafDataManagementNotif data structure in the response body shall include the data collected from data sources (e.g. SMF, NEF) in the "dataNotification" attribute. + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.3.7. + +If the NWDAF determines that the received HTTP POST request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +## 4.5 Nnwdaf\_ MLModelProvision Service + +### 4.5.1 Service Description + +#### 4.5.1.1 Overview + +The Nnwdaf\_ MLModelProvision service as defined in 3GPP TS 23.501 [2] and 3GPP TS 23.288 [17], is provided by the Network Data Analytics Function (NWDAF) containing Model Training Logical Function (MTLF). + +This service: + +- allows the NF service consumers to subscribe to and unsubscribe from different ML model analytics events; +- allows MTLF-based ML Model Accuracy monitoring procedure between the AnLF and MTLF. and +- notifies the NF service consumers with a corresponding subscription about ML model information. + +The types of analytics events include: + +- Slice load level information; +- Network slice instance load level information; +- Service experience; +- NF load; +- Network performance; +- Abnormal behaviour; +- UE mobility; +- UE communication; +- Abnormal behaviour; +- User data congestion; +- QoS sustainability; +- Dispersion; +- SM congestion control experience; +- Redundant transmission experience; +- WLAN performance; +- DN performance; and +- E2E data volume transfer time. + +NOTE: ML model provisioning is limited to a single vendor environment in this release of current specification. + +#### 4.5.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [17]. The ML Model provisioning signalling flows are defined in 3GPP TS 29.552 [25]. + +The Nnwdaf\_ MLModelProvision service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF) containing Model Training Logical Function (MTLF). + +Known consumers of the Nnwdaf\_ MLModelProvision service are: + +- Network Data Analytics Function (NWDAF) containing Analytics logical function (AnLF) + +![Figure 4.5.1.2-1: Reference Architecture for the Nnwdaf_MLModelProvision Service; SBI representation. The diagram shows a top box labeled 'NWDAF (MTLF)' containing a circle labeled 'Nnwdaf'. A vertical line labeled 'Nnwdaf_MLModelProvision' connects this to a bottom box labeled 'NWDAF (AnLF)'.](0931f3e098bd4539041de11c50cec2d2_img.jpg) + +Figure 4.5.1.2-1: Reference Architecture for the Nnwdaf\_MLModelProvision Service; SBI representation. The diagram shows a top box labeled 'NWDAF (MTLF)' containing a circle labeled 'Nnwdaf'. A vertical line labeled 'Nnwdaf\_MLModelProvision' connects this to a bottom box labeled 'NWDAF (AnLF)'. + +**Figure 4.5.1.2-1: Reference Architecture for the Nnwdaf\_MLModelProvision Service; SBI representation** + +![Figure 4.5.1.2-2: Reference Architecture for the Nnwdaf_MLModelProvision Service: reference point representation. The diagram shows a top box labeled 'NWDAF (MTLF)' connected by a vertical line to a bottom box labeled 'NWDAF (AnLF)'. There is a small horizontal tick mark on the vertical line between the two boxes.](57939c16065211317c5442cf2a4009e0_img.jpg) + +Figure 4.5.1.2-2: Reference Architecture for the Nnwdaf\_MLModelProvision Service: reference point representation. The diagram shows a top box labeled 'NWDAF (MTLF)' connected by a vertical line to a bottom box labeled 'NWDAF (AnLF)'. There is a small horizontal tick mark on the vertical line between the two boxes. + +**Figure 4.5.1.2-2: Reference Architecture for the Nnwdaf\_MLModelProvision Service: reference point representation** + +#### 4.5.1.3 Network Functions + +##### 4.5.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF), containing Model Training Logical Function (MTLF), provides ML model information for different analytic events to NF service consumers. + +The Network Data Analytics Function (NWDAF) allows NF service consumers to subscribe to and unsubscribe from one-time, periodic notification or notification when an event is detected. + +##### 4.5.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF) supports (un)subscription to the notification of different ML model information from the NWDAF which contains Model Training Logical Function (MTLF). + +#### 4.5.2 Service Operations + +##### 4.5.2.1 Introduction + +**Table 4.5.2.1-1: Operations of the Nnwdaf\_MLModelProvision Service** + +| Service operation name | Description | Initiated by | +|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| Nnwdaf_MLModelProvision_Subscribe | This service operation is used by an NF service consumer to subscribe to ML model provision from NWDAF. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelProvision_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe to ML model provision. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelProvision_Notify | This service operation is used by the NWDAF to notify the ML model information to the NF service consumer instance which has subscribed to. | NWDAF | + +## 4.5.2.2 Nnwdaf\_MLModelProvision\_Subscribe service operation + +### 4.5.2.2.1 General + +The Nnwdaf\_MLModelProvision\_Subscribe service operation is used by an NF service consumer to subscribe or update subscription for event notifications from the NWDAF which contains Model Training Logical Function (MTLF). + +### 4.5.2.2.2 Subscription for event notifications + +Figure 4.5.2.2.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to subscribe for event notification(s) (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the NF service consumer sending a POST request to the NWDAF to subscribe for event notifications. Step 1: POST /subscriptions from NF service consumer to NWDAF. Step 2: 201 Created response from NWDAF to NF service consumer.](7f663b2f8632236c6e40ca16272d62df_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: NF service consumer + Note right of NWDAF: NWDAF + NF service consumer->>NWDAF: 1. POST « /subscriptions + NWDAF-->>NF service consumer: 2. 201 Created + +``` + +Sequence diagram showing the NF service consumer sending a POST request to the NWDAF to subscribe for event notifications. Step 1: POST /subscriptions from NF service consumer to NWDAF. Step 2: 201 Created response from NWDAF to NF service consumer. + +**Figure 4.5.2.2.2-1: NF service consumer subscribes to notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelProvision\_Subscribe service operation to subscribe to event notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwdaf-mlmodelprovision//subscriptions" as Resource URI representing the "NWDAF ML Model Provision Subscriptions", as shown in figure 4.5.2.2.2-1, step 1, to create a subscription for an "Individual NWDAF ML Model Provision Subscription" according to the information in message body. + +The NnwdafMLModelProvSubsc data structure provided in the request body shall include: + +- an URI where to receive the requested notifications as the "notifiUri" attribute; and +- a description of the subscribed events as the "mLEventSubscs" attribute that, for each event, the MLEventSubscription data type shall include: + - 1) an event identifier as the "mLEvent" attribute; and + - 2) event filter information as the "mLEventFilter" attribute; + +and may include: + +- 1) an identification of target UE information as the "tgtUe" attribute; +- 2) a time interval for which the ML model for the analytics is requested as the "mLTargetPeriod" attribute; +- 3) the time when the subscription expired as the "expiryTime" attribute; +- 4) the ML model metric as the "modelMetric" attribute if the "FederatedLearning" feature or the "ModelProvisionExt" feature is supported; +- 5) a pre-determined status for the ML model or training as the "preDetStatus" attribute if the "FederatedLearning" feature is supported; and +- 6) the ML event reporting condition as the "mLEvRepCon" if the "FederatedLearning" feature or the "ModelProvisionExt" feature is supported. +- 7) the ML Model Interoperability Information as the "modelInterInfo" attribute if the "ModelSharing" feature is supported; and +- 8) NF consumer information as the "nfConsumerInfo" attributed if the "ModelSharing" feature is supported. +- 9) use case context as "useCaseCxt" attribute, if the "ENAExt" feature is supported. + +NOTE 1: The NWDAF containing MTLF can use the "useCaseCxt" attribute to select the most relevant ML model, when several ML models are available for the requested Analytics ID(s). The values of this parameter are not standardized. + +- 10) extended parameters for ML model provisioning as the "modelProvExt" attribute, if the feature "ModelProvisionExt" is supported; +- 11) UTC time indicating the time when the ML model is needed as the "timeModelNeeded" attribute. +- 12) the inference data stored in ADRF which can be used by MTLF as the "inferDataForModel" attribute, if the feature "ModelProvisionExt" is supported. + +The NwdafMLModelProvSubsc data structure provided in the request body may include: + +- a notification correlation identifier assigned by the NF service consumer for the requested notifications as "notifCorreId" attribute; and +- the reporting requirement information of the subscription as the "eventReq" attribute. + +For different event types, the filter information in "mLEventFilter" attribute within the MLEventSubscription data type is the same as described in clause 4.3.2.2.2 for the filter information contained in "event-filter" attribute. + +NOTE 2: The features described in clause 4.3.2.2.2 has no impact on this service. + +**Editor's Note:** The type EventFilter includes attributes (and/or attributes within attributes) that have been introduced in Rel-18. For these attributes, the present API shall either define new features to indicate that the attributes are supported based on these features or it shall indicate that they are not applicable. This feature handling is FFS. + +Upon the reception of an HTTP POST request with: + +"{apiRoot}/nnwdaf-mlmodelprovision//subscriptions" as Resource URI and NwdafMLModelProvSubsc data structure as request body, the NWDAF shall create a new subscription and store the subscription. + +If the NWDAF created an "Individual NWDAF ML Model Provision Subscription" resource, the NWDAF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.5.2.2.2-1, step 2. The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. + +"{apiRoot}/nnwdaf-mlmodelprovision//subscriptions/{subscriptionId}". + +If the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute sets to true during the event subscription, the NWDAF shall include the reports of the subscribed events, if available, as the "mLEventNotifs" attribute in the HTTP POST response. + +If not all the requested events in the subscription are accepted, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). + +If there is no associated ML model available for all the listed "mLEvent" attribute, the NWDAF which contains MTLF shall send a "500 Internal Server Error" status code to the NF service consumer. Also, the corresponding failure reason via a "problemDetails" attribute with the "cause" attribute set to "UNAVAILABLE\_ML\_MODEL\_FOR\_ALLEVENTS". + +If other errors occur when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.4.7. + +#### 4.5.2.2.3 Update subscription for event notifications + +Figure 4.5.2.2.3-1 shows a scenario that the NF service consumer sends an HTTP PUT request to the NWDAF to modify an existing subscription (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the NWDAF. The NWDAF responds with either a 204 No Content or a 200 OK status.](3198cdf0dbe501c46fe0e4073c7d8451_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NWDAF: 1. PUT.../subscriptions/{subscriptionId} + NWDAF-->>NF service consumer: 2a. "204 No Content" +2b. "200 OK" + +``` + +Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the NWDAF. The NWDAF responds with either a 204 No Content or a 200 OK status. + +**Figure 4.5.2.2.3-1: Modification of events subscription information using HTTP PUT** + +The NF service consumer shall invoke the Nnwdaf\_MLModelProvision\_Subscribe service operation to modify an existing ML Model subscription. The NF service consumer shall send an HTTP PUT request with: "{apiRoot}/nnwda-mlmodelprovision//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription to be modified, to update an "Individual NWDAF ML Model Provision Subscription" according to the information in the message body. The NwdafMLModelProvSubsc data structure provided in the request body shall include the same contents as described in clause 4.5.2.2.2. + +Upon receipt of an HTTP PUT request with: "{apiRoot}/nnwda-mlmodelprovision//subscriptions/{subscriptionId}" as Resource URI and NwdafMLModelProvSubsc data type as request body, if the request is successfully processed and accepted, the NWDAF shall: + +- modify the concerned subscription; and +- store the subscription. + +NOTE: The "notifUri" attribute within the NwdafMLModelProvSubsc data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +If the NWDAF successfully processed and accepted the received HTTP PUT request, the NWDAF shall update an "Individual NWDAF ML Model Provision Subscription" resource, and shall respond with: + +- HTTP "204 No Content" response (as shown in figure 4.5.2.2.3-1, step 2a); or +- HTTP "200 OK" response (as shown in figure 4.5.2.2.3-1, step 2b) with a response body containing a representation of the updated subscription in the NwdafMLModelProvSubsc data type. + +If not all the requested events in the subscription are modified successfully, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). + +If other errors occur when processing the HTTP PUT request, the NWDAF shall send an HTTP error response as specified in clause 5.4.7. + +If the NWDAF determines that the received HTTP PUT request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +## 4.5.2.3 Nnwdaf\_MLModelProvision\_Unsubscribe service operation + +### 4.5.2.3.1 General + +The Nnwdaf\_MLModelProvision\_Unsubscribe service operation is used by an NF service consumer to unsubscribe from event notifications. + +### 4.5.2.3.2 Unsubscribe from event notifications + +Figure 4.5.2.3.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to unsubscribe from event notifications (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the NF service consumer unsubscribing from notifications. The NF service consumer sends a DELETE request to the NWDAF, and the NWDAF responds with a 204 No Content.](18bb06865e2dada3656ea3d57f290f7f_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + Note right of NWDAF: + NF service consumer->>NWDAF: 1. DELETE« /subscriptions/{subscriptionId} + NWDAF-->>NF service consumer: 2. 204 No Content + +``` + +Sequence diagram showing the NF service consumer unsubscribing from notifications. The NF service consumer sends a DELETE request to the NWDAF, and the NWDAF responds with a 204 No Content. + +**Figure 4.5.2.3.2-1: NF service consumer unsubscribes from notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelProvision\_Unsubscribe service operation to unsubscribe to event notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nnwdaf-mlmodelprovision//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- remove the corresponding subscription; and +- respond with HTTP "204 No Content" status code. + +If the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If errors occur when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.4.7. + +#### 4.5.2.4 Nnwdaf\_MLModelProvision\_Notify service operation + +##### 4.5.2.4.1 General + +The Nnwdaf\_MLModelProvision\_Notify service operation is used by an NWDAF to notify NF consumers about subscribed events. + +##### 4.5.2.4.2 Notification about subscribed event + +Figure 4.5.2.4.2-1 shows a scenario where the NWDAF sends a request to the NF Service Consumer to notify for event notifications (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the NWDAF notifying the subscribed event. The NWDAF sends a request to the NF Service Consumer, and the NF Service Consumer responds with a response.](bbe5fb08522c43eab0afefcac30e719b_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + Note right of NWDAF: + NWDAF->>NF service consumer: 1. POST /subscriptions/{subscriptionId} + NF service consumer-->>NWDAF: 2. Response + +``` + +Sequence diagram showing the NWDAF notifying the subscribed event. The NWDAF sends a request to the NF Service Consumer, and the NF Service Consumer responds with a response. + +**Figure 4.5.2.4.2-1: NWDAF notifies the subscribed event** + +The NWDAF shall invoke the Nnwdaf\_MLModelProvision\_Notify service operation to notify the subscribed event. The NWDAF shall send an HTTP POST request with "{notifUri}" received in the Nnwdaf\_MLModelProvision\_Subscribe service operation as Resource URI, as shown in figure 4.2.2.4.2-1, step 1. The NnwdafMLModelProvNotif data structure provided in the request body that shall include: + +- an event subscriptionId as "subscriptionId" attribute; and + +- description of the notified event as "eventNotifs" attribute, that for each event, the MLEventNotif data type shall include an event identifier as the "event" attribute, an address (e.g. a URL or an FQDN) of the ML model file as the "mlFileAddr" attribute or (if the "ModelProvisionExt" feature is supported) ADRF ID as the "adrId" attribute or ADRF Set ID as the "adrSetId" attribute, and may include a notification correlation identifier as "notifCorrId" attribute and a time period when the provided ML model applies as the "validityPeriod" attribute and an area where the provided ML model applies as the "spatialValidity" attribute and (if the "ModelProvisionExt" feature is supported) Storage Transaction ID when the ADRF (Set) ID (i.e. "adrId" or "adrSetId" attribute) is provided as the "storTransId" attribute. If the feature "ModelProvisionExt" is supported, may also include additional ML model information as "addModelInfo" attribute. + +Upon the reception of an HTTP POST request, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall store the notification and respond with HTTP "204 No Content" status code. + +If the NF service consumer receives the ADRF ID as the "adrId" attribute or the ADRF Set ID as the "adrSetId" attribute in the NwdafMLModelProvNotif data structure of the HTTP POST request, it may invoke Nadrf\_MLModelManagement\_RetrievalRequest service operation to retrieve ML Model from the ADRF (Set) as specified in 3GPP TS 29.575 [27]. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If errors occur when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.4.7. + +## 4.6 Nnwdaf\_MLModelTraining Service + +### 4.6.1 Service Description + +#### 4.6.1.1 Overview + +The Nnwdaf\_MLModelTraining service as defined in 3GPP TS 23.288 [17], is provided by the Network Data Analytics Function (NWDAF) containing Model Training Logical Function (MTLF). + +This service: + +- allows the NF service consumers to subscribe to and unsubscribe from different ML model training events; +- allows the NF service consumers to modify different ML model training events; and +- notifies the NF service consumers with a corresponding subscription about ML model information. + +#### 4.6.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [17]. The ML Model training signalling flows are defined in 3GPP TS 29.552 [25]. + +The Nnwdaf\_MLModelTraining service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF) containing Model Training Logical Function (MTLF). + +Known consumers of the Nnwdaf\_MLModelTraining service are: + +- Network Data Analytics Function (NWDAF) containing Model Training Logical Function (MTLF) + +![Figure 4.6.1.2-1: Reference Architecture for the Nnwdaf_MLModelTraining Service; SBI representation. The diagram shows two rectangular boxes labeled 'NWDAF (MTLF)'. Between them is an oval labeled 'Nnwdaf'. An arrow points from the bottom box to the oval, and another arrow points from the oval to the top box. The label 'Nnwdaf_MLModelTraining' is placed next to the top arrow.](e7010c66da16316c2935dfbbef5056b3_img.jpg) + +Figure 4.6.1.2-1: Reference Architecture for the Nnwdaf\_MLModelTraining Service; SBI representation. The diagram shows two rectangular boxes labeled 'NWDAF (MTLF)'. Between them is an oval labeled 'Nnwdaf'. An arrow points from the bottom box to the oval, and another arrow points from the oval to the top box. The label 'Nnwdaf\_MLModelTraining' is placed next to the top arrow. + +**Figure 4.6.1.2-1: Reference Architecture for the Nnwdaf\_MLModelTraining Service; SBI representation** + +![Figure 4.6.1.2-2: Reference Architecture for the Nnwdaf_MLModelTraining Service: reference point representation. The diagram shows two rectangular boxes labeled 'NWDAF (MTLF)'. A vertical line connects the top box to the bottom box, with a horizontal crossbar in the middle, representing a reference point.](20cb2d2cc18d663dc1b82453c67250bb_img.jpg) + +Figure 4.6.1.2-2: Reference Architecture for the Nnwdaf\_MLModelTraining Service: reference point representation. The diagram shows two rectangular boxes labeled 'NWDAF (MTLF)'. A vertical line connects the top box to the bottom box, with a horizontal crossbar in the middle, representing a reference point. + +**Figure 4.6.1.2-2: Reference Architecture for the Nnwdaf\_MLModelTraining Service: reference point representation** + +#### 4.6.1.3 Network Functions + +##### 4.6.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF), containing Model Training Logical Function (MTLF), provides ML model information for different analytic events to NF service consumers. + +The Network Data Analytics Function (NWDAF) allows NF service consumers to subscribe to and unsubscribe from one-time, periodic notification or notification when an event is detected. + +##### 4.6.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF) supports (un)subscription to the notification of different ML model information from the NWDAF which contains Model Training Logical Function (MTLF). + +#### 4.6.2 Service Operations + +##### 4.6.2.1 Introduction + +**Table 4.6.2.1-1: Operations of the Nnwdaf\_MLModelTraining Service** + +| Service operation name | Description | Initiated by | +|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| Nnwdaf_MLModelTraining_Subscribe | This service operation is used by an NF service consumer to subscribe to ML model training from NWDAF. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelTraining_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe to ML model training. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelTraining_Notify | This service operation is used by the NWDAF to notify the ML model information to the NF service consumer instance which has subscribed to. | NWDAF | + +## 4.6.2.2 Nnwdaf\_MLModelTraining\_Subscribe service operation + +### 4.6.2.2.1 General + +The Nnwdaf\_MLModelTraining\_Subscribe service operation is used by an NF service consumer to subscribe or update subscription for event notifications from the NWDAF which contains Model Training Logical Function (MTLF). + +### 4.6.2.2.2 Subscription for event notifications + +Figure 4.6.2.2.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to subscribe for event notification(s) (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The consumer sends a POST request to /subscriptions, and the NWDAF responds with a 201 Created status.](8a94796989f4fcba2688c4faa7991538_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + NF service consumer->>NWDAF: 1. POST « /subscriptions + Note right of NWDAF: + NWDAF-->>NF service consumer: 2. 201 Created + +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The consumer sends a POST request to /subscriptions, and the NWDAF responds with a 201 Created status. + +**Figure 4.6.2.2.2-1: NF service consumer subscribes to notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelTraining\_Subscribe service operation to subscribe to event notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwdaf-mlmodeltraining//subscriptions" as Resource URI representing the "NWDAF ML Model Training Subscriptions", as shown in figure 4.6.2.2.2-1, step 1, to create a subscription for an "Individual NWDAF ML Model Training Subscription" according to the information in message body. + +The NwdafMLModelTrainSubsc data structure provided in the request body shall include: + +- an URI where to receive the requested notifications as the "notifUri" attribute; + - a description of the subscribed events as the "mLEventSubscs" attribute that, for each event, the MLEventSubscription data type shall include: + - 1) an event identifier as the "mLEvent" attribute; + - 2) event filter information as the "mLEventFilter" attribute; and + - 3) the ML Model Interoperability Information as the "modelInterInfo" attribute; + - a notification correlation identifier assigned by the NF service consumer for the requested notifications as "notifCorreId" attribute; +- and may include: +- an identification of UE information for which data for ML model training is requested as the "tgtRepUe" attribute; + - the ML model information as the "mLModelInfos" attribute; + - the ML model training information as the "mLModelTrainInfos" attribute; + - identification of the ML procedure for training the ML model as the "mlCorreId" attribute; + - an indication of preparation request for ML model training as the "mLPreFlag" attribute; + - an indication of request using the local training data as the testing dataset to calculate the Model Accuracy of the global ML model provided by the consumer as the "mLAccChkFlg" attribute; + - the ML model training reporting information as the "mLTrainRepInfo" attribute; + - the round number of the training in a multi-round training process as the "roundInd" attribute; + - the use case context of the ML model as the "uCaseCont" attribute; and + - the reporting requirement information of the subscription as the "eventReq" attribute. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nnwdaf-mlmodeltraining//subscriptions" as Resource URI and NwdafMLModelTrainSubsc data structure as request body, the NWDAF shall create a new subscription and store the subscription. + +If the NWDAF created an "Individual NWDAF ML Model Training Subscription" resource, the NWDAF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.6.2.2.2-1, step 2. The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. "{apiRoot}/nnwdaf-mlmodeltraining//subscriptions/{subscriptionId}". + +If the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute sets to "true" during the event subscription, the NWDAF shall include the reports of the subscribed events, if available, as the "immReports" attribute in the HTTP POST response. + +NOTE: Immediate and one-time reporting can be used in order to implement the Nnwdaf\_MLModelTrainingInfo service, which is defined in 3GPP TS 23.288 [17]. + +If not all the requested events in the subscription are accepted, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). + +If there is no associated ML model training available for all provided "mLEvent" attributes, the NWDAF shall send a "500 Internal Server Error" status code to the NF service consumer, including the "cause" attribute set to "UNAVAILABLE\_ML\_MODEL\_TRAINING\_FOR\_ALLEVENTS". + +If there is no ML model training satisfying the requirements listed in "mLModelTrainInfos" attribute or the ML model cannot be downloaded successfully, the NWDAF which contains MTTF shall send a "403 Forbidden" status code to the NF service consumer, and it may send together with the corresponding failure reason via a "problemDetails" attribute with the "cause" attribute set to "ML\_MODEL\_TRAINING\_REQS\_NOT\_MET", "ML\_TRAINING\_NOT\_COMPLETE", "OVERLOAD", or "NOT\_AVAILABLE\_FOR\_FL\_PROCESS\_ANYMORE". + +If other errors occur when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.5.7. + +#### 4.6.2.2.3 Update subscription for event notifications + +Figure 4.6.2.2.3-1 shows a scenario that the NF service consumer sends an HTTP PUT request to the NWDAF to modify an existing subscription (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the NWDAF, and the NWDAF responds with either a 204 No Content or a 200 OK status code.](f40480872b021d2ac7c29202c199b695_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. PUT.../subscriptions/{subscriptionId} + NF service consumer->>NWDAF: 1. PUT.../subscriptions/{subscriptionId} + Note right of NWDAF: 2a. "204 No Content" +2b. "200 OK" + NWDAF-->>NF service consumer: 2a. "204 No Content" +2b. "200 OK" + +``` + +Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the NWDAF, and the NWDAF responds with either a 204 No Content or a 200 OK status code. + +**Figure 4.6.2.2.3-1: Modification of events subscription information using HTTP PUT** + +The NF service consumer shall invoke the Nnwdaf\_MLModelTraining\_Subscribe service operation to modify an existing ML Model Training subscription. The NF service consumer shall send an HTTP PUT request with: "{apiRoot}/nnwdaf-mlmodeltraining//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription to be modified, to update an "Individual NWDAF ML Model Training Subscription" according to the information in the message body. The NwdafMLModelTrainSubsc data structure provided in the request body shall include the same contents as described in clause 4.6.2.2.2. + +Upon receipt of an HTTP PUT request with: "{apiRoot}/nnwdaf-mlmodeltraining//subscriptions/{subscriptionId}" as Resource URI and NwdafMLModelTrainSubsc data type as request body, if the request is successfully processed and accepted, the NWDAF shall: + +- modify the concerned subscription; and + +- store the subscription. + +If the NWDAF successfully processed and accepted the received HTTP PUT request, the NWDAF shall update an "Individual NWDAF ML Model Training Subscription" resource, and shall respond with: + +- HTTP "204 No Content" response (as shown in figure 4.6.2.2.3-1, step 2a); or +- HTTP "200 OK" response (as shown in figure 4.6.2.2.3-1, step 2b) with a response body containing a representation of the updated subscription in the NwdafMLModelTrainSubsc data type. + +If not all the requested events in the subscription are modified successfully, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). + +If the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute sets to "true" during the event subscription update, the NWDAF shall include the reports of the subscribed events, if available, as the "immReports" attribute in the HTTP PUT response. + +NOTE: Immediate and one-time reporting can be used in order to implement the Nnwdaf\_MLModelTrainingInfo service, which is defined in 3GPP TS 23.288 [17]. + +If there is no associated ML model training available for all provided "mLEvent" attributes, the NWDAF shall send a "500 Internal Server Error" status code to the NF service consumer, including the "cause" attribute set to "UNAVAILABLE\_ML\_MODEL\_TRAINING\_FOR\_ALLEVENTS". + +If other errors occur when processing the HTTP PUT request, the NWDAF shall send an HTTP error response as specified in clause 5.5.7. + +If the NWDAF determines that the received HTTP PUT request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.6.2.2.4 Partial update subscription for event notifications + +Figure 4.6.2.2.4-1 shows a scenario that the NF service consumer sends an HTTP PATCH request to the NWDAF to partial modify an existing subscription (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and the NWDAF for partial modification of an event subscription. The consumer sends a PATCH request to a subscription ID, and the NWDAF responds with either a 204 No Content or a 200 OK status.](05da2a3257316bbf6f448a830dc0380a_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant NWDAF as NWDAF + Note right of NWDAF: 1. PATCH.../subscriptions/{subscriptionId} + NWDAF->>NF: 2a. "204 No Content" +2b. "200 OK" + +``` + +Sequence diagram showing the interaction between an NF service consumer and the NWDAF for partial modification of an event subscription. The consumer sends a PATCH request to a subscription ID, and the NWDAF responds with either a 204 No Content or a 200 OK status. + +**Figure 4.6.2.2.4-1: Partial modification of events subscription information using HTTP PATCH** + +The NF service consumer shall invoke the Nnwdaf\_MLModelTraining\_Subscribe service operation to partial modify an existing ML Model Training subscription. The NF service consumer shall send an HTTP PATCH request with: "{apiRoot}/nnwda-mlmodeltraining//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription to be modified, to update an "Individual NWDAF ML Model Training Subscription" according to the information in the message body. + +Upon receipt of an HTTP PATCH request with: "{apiRoot}/nnwda-mlmodeltraining//subscriptions/{subscriptionId}" as Resource URI and NwdafMLModelTrainSubscPatch data type as request body, if the request is successfully processed and accepted, the NWDAF shall: + +- partial modify the concerned subscription; and +- store the subscription. + +If the NWDAF successfully processed and accepted the received HTTP PATCH request, the NWDAF shall partial update an "Individual NWDAF ML Model Training Subscription" resource, and shall respond with: + +- HTTP "204 No Content" response (as shown in figure 4.6.2.2.4-1, step 2a); or +- HTTP "200 OK" response (as shown in figure 4.6.2.2.4-1, step 2b) with a response body containing a representation of the updated subscription in the NwdafMLModelTrainSubsc data type. + +If not all the requested events in the subscription are modified successfully, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). + +If the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute sets to "true" during the event subscription update, the NWDAF shall include the reports of the subscribed events, if available, as the "immReports" attribute in the HTTP PUT response. + +NOTE: Immediate and one-time reporting can be used in order to implement the Nnwdaf\_MLModelTrainingInfo service, which is defined in 3GPP TS 23.288 [17]. + +If there is no associated ML model training available for all provided "mLEvent" attributes, the NWDAF shall send a "500 Internal Server Error" status code to the NF service consumer, including the "cause" attribute set to "UNAVAILABLE\_ML\_MODEL\_TRAINING\_FOR\_ALLEVENTS". + +If other errors occur when processing the HTTP PATCH request, the NWDAF shall send an HTTP error response as specified in clause 5.5.7. + +If the NWDAF determines that the received HTTP PATCH request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.6.2.3 Nnwdaf\_MLModelTraining\_Unsubscribe service operation + +##### 4.6.2.3.1 General + +The Nnwdaf\_MLModelTraining\_Unsubscribe service operation is used by an NF service consumer to unsubscribe from event notifications. + +##### 4.6.2.3.2 Unsubscribe from event notifications + +Figure 4.6.2.3.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to unsubscribe from event notifications (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and the NWDAF for unsubscribing from notifications. The consumer sends a DELETE request to the NWDAF, and the NWDAF responds with a 204 No Content status.](f59ced6eaab3181501fc23fdfb52297e_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + Note right of NWDAF: + NF service consumer->>NWDAF: 1. DELETE« /subscriptions/{subscriptionId} + NWDAF-->>NF service consumer: 2. 204 No Content +``` + +Sequence diagram showing the interaction between an NF service consumer and the NWDAF for unsubscribing from notifications. The consumer sends a DELETE request to the NWDAF, and the NWDAF responds with a 204 No Content status. + +**Figure 4.6.2.3.2-1: NF service consumer unsubscribes from notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelTraining\_Unsubscribe service operation to unsubscribe to event notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nnwdaf-mlmodeltraining//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- remove the corresponding subscription; and +- respond with HTTP "204 No Content" status code. + +If the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If errors occur when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.5.7. + +#### 4.6.2.4 Nnwdaf\_MLModelTraining\_Notify service operation + +##### 4.6.2.4.1 General + +The Nnwdaf\_MLModelTraining\_Notify service operation is used by an NWDAF to notify NF consumers about subscribed events. + +##### 4.6.2.4.2 Notification about subscribed event + +Figure 4.6.2.4.2-1 shows a scenario where the NWDAF sends a request to the NF Service Consumer to notify for event notifications (see also 3GPP TS 23.288 [17]). + +![Diagram showing a box labeled 'Nnwdaf_MLModelTraining_Notify' with a redacted area.](f92e919c70b7adda2d0e778889f44fae_img.jpg) + +The diagram shows a rectangular box with a black border. Inside the box, the text "Nnwdaf\_MLModelTraining\_Notify" is partially visible, with a black rectangle obscuring the beginning of the text. To the right of the box, there is a small vertical line and a square box, likely representing a sequence diagram element or a placeholder for a figure. + +Diagram showing a box labeled 'Nnwdaf\_MLModelTraining\_Notify' with a redacted area. + +**Figure 4.6.2.4.2-1: NWDAF notifies the subscribed event** + +The NWDAF shall invoke the Nnwdaf\_MLModelTraining\_Notify service operation to notify the subscribed event. The NWDAF shall send an HTTP POST request with "{notifUri}" received in the Nnwdaf\_MLModelTraining\_Subscribe service operation as Resource URI, as shown in figure 4.6.2.4.2-1, step 1. The NwdafMLModelTrainNotif data structure provided in the request body that shall include: + +- a notification correlation identifier as "notifCorreId" attribute; +- at least one of the notification detailed information: + - description of the notified event as "mLModelInfos" attribute; + - a delay event notification for training the ML model as "delayEventNotif" attribute when the service is for Federated Learning; + - an indication that the subscription is requested to be terminated, i.e. no further notifications related to this subscription will be provided, as "termTrainReq"; + +and may include: + +- an identification of the Machine Learning procedure for training the ML model as "mlCorreId" attribute when the service is for Federated Learning; +- an identification of the round number of the training in a multi-round training process as "roundInd" attribute; +- the status report for the ML model training as "statusReport" attribute when the service is for Federated Learning; and/or +- an indication of the use case context of the ML model as "uCaseCont". + +Upon the reception of an HTTP POST request, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall store the notification and respond with HTTP "204 No Content" status code. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If errors occur when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.5.7. + +## 4.7 Nnwdaf\_ MLModelMonitor Service + +### 4.7.1 Service Description + +#### 4.7.1.1 Overview + +The Nnwdaf\_ MLModelMonitor service as defined in 3GPP TS 23.288 [17], is provided by the Network Data Analytics Function (NWDAF). + +This service: + +- allows the NWDAF containing AnLF to register the use and monitoring capability of the analytics accuracy of an ML Model at the NWDAF containing MTLF; +- allows the NWDAF containing AnLF to deregister a previous registration of the monitoring capability of the analytics accuracy of an ML Model at the NWDAF containing MTLF; +- allows the NF service consumer (i.e. NWDAF containing MTLF) to subscribe to and unsubscribe from the analytics accuracy monitoring event of an ML Model and analytics feedback information from the NWDAF containing AnLF; +- allows the NF service consumer (i.e. NWDAF containing MTLF) to modify an analytics accuracy monitoring event of an ML Model and analytics feedback information from the NWDAF containing AnLF; and +- allow the NWDAF containing AnLF notifies the NF service consumer (i.e. NWDAF containing MTLF) about the monitored analytics accuracy information of an ML Model and/or analytics feedback information. + +#### 4.7.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [17]. + +The Nnwdaf\_ MLModelMonitor service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF). + +Known consumers of the Nnwdaf\_ MLModelMonitor service are: + +- Network Data Analytics Function (NWDAF) + +![Reference Architecture for the Nnwdaf_ MLModelMonitor Service; SBI representation](b327d9f0565f7e032fc82b4322c844dc_img.jpg) + +The diagram illustrates the Service Based Interface (SBI) representation of the service architecture. At the top is a rectangular box labeled 'NWDAF(AnLF)'. Below it is an oval labeled 'Nnwdaf', which represents the service interface. A vertical line connects the 'Nnwdaf' oval to a rectangular box at the bottom labeled 'NWDAF(MTLF)'. This vertical line is labeled 'Nnwdaf\_ MLModelMonitor', indicating the specific service provided. + +Reference Architecture for the Nnwdaf\_ MLModelMonitor Service; SBI representation + +**Figure 4.7.1.2-1: Reference Architecture for the Nnwdaf\_ MLModelMonitor Service; SBI representation** + +![Reference Architecture for the Nnwdaf_ MLModelMonitor Service: reference point representation](5ba26df60eea8e9b4688559e47cd9c0f_img.jpg) + +The diagram illustrates the reference point representation of the service architecture. It consists of two rectangular boxes. The top box is labeled 'NWDAF(AnLF)' and the bottom box is labeled 'NWDAF(MTLF)'. A vertical line connects the two boxes, with a small horizontal tick mark in the middle, representing a reference point between the two network functions. + +Reference Architecture for the Nnwdaf\_ MLModelMonitor Service: reference point representation + +**Figure 4.7.1.2-2: Reference Architecture for the Nnwdaf\_ MLModelMonitor Service: reference point representation** + +### 4.7.1.3 Network Functions + +#### 4.7.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF) containing MTLF allows NWDAF containing AnLF to register the use and monitoring capability of the analytics accuracy of an ML Model. + +The Network Data Analytics Function (NWDAF) containing AnLF allows NF service consumer (i.e. NWDAF containing MTLF) to subscribe to and unsubscribe from notification of monitored analytics accuracy information of an ML Model and analytics feedback information. + +#### 4.7.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF) containing MTLF supports (un)subscription to the notification of analytics accuracy monitoring of an ML Model and analytics feedback information. + +### 4.7.2 Service Operations + +#### 4.7.2.1 Introduction + +**Table 4.7.2.1-1: Operations of the Nnwdaf\_MLModelMonitor Service** + +| Service operation name | Description | Initiated by | +|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| Nnwdaf_MLModelMonitor_Register | This service operation is used by an NF service consumer to register the monitoring capability of the analytics accuracy of an ML Model at an NWDAF containing MTLF. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelMonitor_Deregister | This service operation is used by an NF service consumer to deregister a previous registration from an NWDAF containing MTLF. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelMonitor_Subscribe | This service operation is used by an NF service consumer to subscribe to the analytics accuracy monitoring event of an ML Model. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelMonitor_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe from the analytics accuracy monitoring event of an ML Model. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelMonitor_Notify | This service operation is used by the NWDAF to notify the monitored analytics accuracy information of an ML Model. | NWDAF | + +#### 4.7.2.2 Nnwdaf\_MLModelMonitor\_Register service operation + +##### 4.7.2.2.1 General + +The Nnwdaf\_MLModelMonitor\_Register service operation is used by an NF service consumer (i.e. NWDAF containing AnLF) to register the monitoring capability of the analytics accuracy of an ML Model and analytics feedback information. + +##### 4.7.2.2.2 Registering the monitoring of the analytics accuracy of an ML Model + +Figure 4.7.2.2.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF containing MTLF to register the use and monitoring capability of the analytics accuracy of an ML Model. + +![Sequence diagram showing the registration of an ML model. The NF Service Consumer sends a POST request to the NWDAF, and the NWDAF responds with a 201 Created status.](f61d0925551545b5938b3a4d1bbf63c3_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NWDAF + Note right of NF Service Consumer: 1. POST « registrations » + NF Service Consumer->>NWDAF: 1. POST « registrations » + Note left of NWDAF: 2. "201 Created" + NWDAF-->>NF Service Consumer: 2. "201 Created" + +``` + +Sequence diagram showing the registration of an ML model. The NF Service Consumer sends a POST request to the NWDAF, and the NWDAF responds with a 201 Created status. + +**Figure 4.7.2.2.2-1: NF service consumer registers the use and monitoring capability of the analytics accuracy of an ML Model** + +The NF service consumer shall invoke the Nnwdaf\_MLModelMonitor\_Register service operation to register the use and indicate the monitoring capability of the analytics accuracy of an ML Model and analytics feedback information. The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwda-mlmodelmonitor//registrations" as Resource URI representing the "NWDAF ML model monitoring registrations", as shown in figure 4.7.2.2.2-1, step 1, to create an "Individual NWDAF ML model monitoring registration" according to the information in the message body. The MLModelMonitorReg data structure provided in the request body shall include: + +- the ML model ID within the "modelId" attribute; and +- one of the following identifiers related to the NF service consumer: + - the NF instance ID of the consumer within the "consumerId" attribute; + - NF set ID of the consumer within the "consumerSetId" attribute. + +and may include: + +- ML Model accuracy transfer indication within the "modelAccuInd" attribute. + +Upon the reception of an HTTP POST request with "{apiRoot}/nnwda-mlmodelmonitor//registrations" as Resource URI and MLModelMonitorReg data structure as request body, the NWDAF shall: + +- create a new registration; +- assign a registrationId; +- store the registration information. + +If the NWDAF created an "Individual NWDAF ML model monitoring registration" resource, the NWDAF shall respond with "201 Created" with the message body containing a representation of the created registration, as shown in figure 4.7.2.2.2-1, step 2. The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created profile, i.e. "{apiRoot}/nnwda-mlmodelmonitor//registrations/{registrationId}". + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +#### 4.7.2.3 Nnwdaf\_MLModelMonitor\_Deregister service operation + +##### 4.7.2.3.1 General + +The Nnwdaf\_MLModelMonitor\_Deregister service operation is used by an NF service consumer (i.e. NWDAF containing AnLF) to deregister a previous registration from an NWDAF containing MTLF. + +##### 4.7.2.3.2 Deregistering the monitoring of the analytics accuracy of an ML Model + +Figure 4.7.2.3.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF containing MTLF to deregister the use or monitoring capability of the analytics accuracy of an ML Model. + +![Sequence diagram showing the deregistration of an ML model monitoring capability. The NF Service Consumer sends a DELETE request for a specific registration ID to the NWDAF, which responds with a 204 No Content status.](3750b0149a6380885998ab3ca6a8787c_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant NWDAF + Note right of NF Service Consumer: 1. DELETE « registrations/registrationId » + NF Service Consumer->>NWDAF: 1. DELETE « registrations/registrationId » + Note left of NWDAF: 2. "204 No Content" + NWDAF-->>NF Service Consumer: 2. "204 No Content" +``` + +Sequence diagram showing the deregistration of an ML model monitoring capability. The NF Service Consumer sends a DELETE request for a specific registration ID to the NWDAF, which responds with a 204 No Content status. + +**Figure 4.7.2.3.2-1: NF service consumer deregisters the use or monitoring capability of the analytics accuracy of an ML Model** + +The NF service consumer shall invoke the Nnwdaf\_MLModelMonitor\_Deregister service operation to delete a registration of the use or monitoring capability of the analytics accuracy of an ML Model. The NF service consumer shall send an HTTP DELETE request with + +"`{apiRoot}/nnwda-mlmodelmonitor//registrations/{registrationId}`" as Resource URI representing an "Individual NWDAF ML model monitoring registration" resource, as shown in figure 4.7.2.3.2-1, step 1, where "`{registrationId}`" is the identifier of the existing registration that is to be deleted. + +Upon the reception of an HTTP DELETE request with + +"`{apiRoot}/nnwda-mlmodelmonitor//registrations/{registrationId}`" as Resource URI, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- remove the corresponding registration; +- respond with HTTP "204 No Content" status. + +If the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +If errors occur when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +#### 4.7.2.4 Nnwdaf\_MLModelMonitor\_Subscribe service operation + +##### 4.7.2.4.1 General + +The Nnwdaf\_MLModelMonitor\_Subscribe service operation is used by an NF service consumer (i.e NWDAF containing MTLF) to subscribe or update subscription for analytics accuracy monitoring event of an ML Model and analytics feedback information. + +##### 4.7.2.4.2 Subscription for monitoring notifications + +Figure 4.7.2.4.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF containing AnLF to subscribe for event notification(s) and analytics feedback information. + +![Sequence diagram showing the NF service consumer subscribing to notifications from the NWDAF. Step 1: POST « subscriptions » from NF Service Consumer to NWDAF. Step 2: 201 Created response from NWDAF to NF Service Consumer.](38d82ffe820e339811b396206f40a201_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NWDAF + Note right of NF Service Consumer: 1. POST « subscriptions » + NF Service Consumer->>NWDAF: 1. POST « subscriptions » + Note left of NWDAF: 2. "201 Created" + NWDAF-->>NF Service Consumer: 2. "201 Created" + +``` + +Sequence diagram showing the NF service consumer subscribing to notifications from the NWDAF. Step 1: POST « subscriptions » from NF Service Consumer to NWDAF. Step 2: 201 Created response from NWDAF to NF Service Consumer. + +**Figure 4.7.2.4.2-1: NF service consumer subscribes to notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelMonitor\_Subscribe service operation to subscribe to event notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwda-mlmodelmonitor//subscriptions" as Resource URI representing the "NWDAF ML model monitoring Subscriptions", as shown in figure 4.7.2.4.2-1, step 1, to create a subscription for an "Individual NWDAF ML model monitoring Subscription" according to the information in message body. The MLModelMonitorSub data structure provided in the request body shall include: + +- the ML model IDs within "modelIds" attribute; +- the notification URI within "notificationUri" attribute; +- the notification correlation identifier within "notifCorrId" attribute; + +and may include: + +- the ML model metrics within "modelMetric" attribute; +- the accuracy reporting threshold within "accuThreshold" attribute; +- the reporting requirements of the event subscription within "eventReportReq" attribute +- the ML model metrics within "modelMetric" attribute; + +Upon the reception of an HTTP POST request with "{apiRoot}/nnwda-mlmodelmonitor//subscriptions" as Resource URI and MLModelMonitorSub data structure as request body, the NWDAF containing AnLF shall: + +- create a new new subscription; +- assign a subscriptionId; +- store the subscription. + +If the NWDAF created an "Individual NWDAF ML model monitoring Subscription" resource, the NWDAF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.7.2.4.2-1, step 2. The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created profile, i.e. + +"{apiRoot}/nnwda-mlmodelmonitor//subscriptions/{subscriptionId}" + +If the immediate reporting indication in the "immRep" attribute within the "eventReportReq" attribute sets to true in the event subscription, the NWDAF shall include the reports of the events subscribed within "immReports" attribute, if available, in the HTTP POST response. + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +#### 4.7.2.4.3 Update of subscription for monitoring notifications + +Figure 4.7.2.4.3-1 shows a scenario where the NF service consumer (i.e. NWDAF containing MTLF) sends a request to the NWDAF containing AnLF to update a subscription for event notification(s). + +![Sequence diagram showing the NF service consumer sending a PUT request to the NWDAF to update a subscription. Step 1: PUT « subscriptions/{subscriptionId} from NF service consumer to NWDAF. Step 2a: 200 OK or Step 2b: 204 No Content from NWDAF back to NF service consumer.](11f18bf0233d812ad2604f88f3385d60_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. PUT « subscriptions/{subscriptionId} + NF service consumer->>NWDAF: Request + Note left of NWDAF: 2a. "200 OK" or +2b. "204 No Content" + NWDAF-->>NF service consumer: Response + +``` + +Sequence diagram showing the NF service consumer sending a PUT request to the NWDAF to update a subscription. Step 1: PUT « subscriptions/{subscriptionId} from NF service consumer to NWDAF. Step 2a: 200 OK or Step 2b: 204 No Content from NWDAF back to NF service consumer. + +**Figure 4.7.2.4.3-1: NF service consumer updates subscription to notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelMonitor\_Subscribe service operation to update a subscription to event notification(s) by sending an HTTP PUT request with "{apiRoot}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId}" as Resource URI representing the "Individual NWDAF ML model monitoring subscription", as shown in figure 4.7.2.4.3-1, step 1, to update this "Individual NWDAF ML model monitoring subscription" according to the information in message body. The MLModelMonitorSub data structure provided in the request body shall include the same contents as in clause 4.7.2.4.2. + +Upon the reception of an HTTP PUT request with "{apiRoot}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId}" as Resource URI and MLModelMonitorSub data structure as request body, the NWDAF shall: + +- update the subscription of corresponding subscriptionId; and +- store the subscription. + +If the NWDAF successfully update the "Individual NWDAF ML model monitoring Subscription" resource, the NWDAF shall respond with "200 OK" with the message body containing a representation of the created subscription, as shown in figure 4.7.2.4.3-1, step 2a, or with "204 No Content" as shown in figure 4.7.2.4.3-1, step 2b. + +If the immediate reporting indication in the "immRep" attribute within the "eventReportReq" attribute sets to true in the request, the NWDAF shall include the reports of the events subscribed within "immReports" attribute, if available, in the HTTP PUT response. + +If an error occurs when processing the HTTP PUT request, the NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +## 4.7.2.5 Nnwdaf\_MLModelMonitor\_Unsubscribe service operation + +### 4.7.2.5.1 General + +The Nnwdaf\_MLModelMonitor\_Unsubscribe service operation is used by an NF service consumer (i.e. NWDAF containing MTTF) to unsubscribe from analytics accuracy monitoring event of an ML Model. + +### 4.7.2.5.2 Unsubscribe from monitoring notifications + +Figure 4.7.2.5.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF containing AnLF to unsubscribe from notifications. + +![Sequence diagram showing the NF service consumer unsubscribing from notifications. The NF Service Consumer sends a DELETE request for subscriptions/subscriptionId to the NWDAF, which responds with 204 No Content.](1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NWDAF + Note right of NF Service Consumer: 1. DELETE « subscriptions/subscriptionId » + NF Service Consumer->>NWDAF: 1. DELETE « subscriptions/subscriptionId » + Note left of NWDAF: 2. "204 No Content" + NWDAF-->>NF Service Consumer: 2. "204 No Content" + +``` + +Sequence diagram showing the NF service consumer unsubscribing from notifications. The NF Service Consumer sends a DELETE request for subscriptions/subscriptionId to the NWDAF, which responds with 204 No Content. + +**Figure 4.7.2.5.2-1: NF service consumer unsubscribes from notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelMonitor\_Unsubscribe service operation to unsubscribe to event notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscription ID of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request with: + +"{apiRoot}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId}" as Resource URI, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- remove the corresponding subscription; and +- respond with HTTP "204 No Content" status code. + +If the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If an error occurs when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +#### 4.7.2.6 Nnwdaf\_MLModelMonitor\_Notify service operation + +##### 4.7.2.6.1 General + +The Nnwdaf\_MLModelMonitor\_Notify service operation is used by an NWDAF containing AnLF to notify NF service consumer (i.e. NWDAF containing MTLF) about the subscribed analytics accuracy monitoring event of an ML Model. + +##### 4.7.2.6.2 Notification about subscribed event + +Figure 4.7.2.6.2-1 shows a scenario where the NWDAF containing AnLF sends a request to notify for event notifications. + +![Sequence diagram showing the NWDAF notifying the subscribed event. The NWDAF sends a POST request with notificationUri to the NF service consumer, which responds with 204 No Content.](688031e51a9a74ed869aa8405aab4e74_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NWDAF: 1. POST{notificationUri} + NWDAF->>NF service consumer: 1. POST{notificationUri} + Note left of NF service consumer: 2. "204 No Content" + NF service consumer-->>NWDAF: 2. "204 No Content" + +``` + +Sequence diagram showing the NWDAF notifying the subscribed event. The NWDAF sends a POST request with notificationUri to the NF service consumer, which responds with 204 No Content. + +**Figure 4.7.2.6.2-1: NWDAF notifies the subscribed event** + +The NWDAF shall invoke the Nnwdaf\_MLModelMonitor\_Notify service operation to notify the subscribed event. The NWDAF shall send an HTTP POST request with "{notificationUri}" received in the + +Nnwdaf\_MLModelMonitor\_Notify service operation as Resource URI, as shown in figure 4.7.2.6.2-1, step 1. The MLModelMonitorNotify data structure provided in the request body that shall include: + +- a notification correlation identifier as "notifCorrId" attribute; +- at least one of: + - the accuracy related information of the ML model within "modelAccuInfos" attribute; + - the analytics feedback information within "anaFeedbacks" attribute; + +and may include: + +- the valid period within "validPeriod" attribute; + +Upon the reception of an HTTP POST request, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall store the notification and respond with HTTP "204 No Content" status code. + +If the NWDAF determines the received HTTP POST request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +## 4.8 Nnwdaf\_RoamingData Service + +### 4.8.1 Service Description + +#### 4.8.1.1 Overview + +The Nnwdaf\_RoamingData service as defined in 3GPP TS 23.288 [17], is provided by the Network Data Analytics Function (NWDAF) with roaming exchange capability, which is called Roaming Exchange NWDAF (RE-NWDAF). + +This service: + +- allows the NF service consumers to subscribe to and unsubscribe from the data of roaming UEs exposed by an RE-NWDAF; +- allows the NF service consumers to modify the subscription to the data of roaming UEs exposed by an RE-NWDAF; and +- notifies the NF service consumers about the data of roaming UEs exposed by an RE-NWDAF. + +#### 4.8.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [17]. + +The Nnwdaf\_RoamingData service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF). + +Known consumers of the Nnwdaf\_RoamingData service are: + +- Network Data Analytics Function with Roaming Exchange capability in HPLMN(H-RE-NWDAF), collecting data from V-RE-NWDAF for outbound roaming user(s); +- Network Data Analytics Function with Roaming Exchange capability in VPLMN(V-RE-NWDAF), collecting data from H-RE-NWDAF for inbound roaming user(s); + +![Figure 4.8.1.2-1: Reference Architecture for the Nnwdaf_RoamingData Service; SBI representation. The diagram shows two vertical stacks. The left stack has a box 'V-RE-NWDAF' at the top, an oval 'Nnwdaf' inside it, and a box 'H-RE-NWDAF' at the bottom, connected by a line labeled 'Nnwdaf_RoamingData'. The right stack has a box 'H-RE-NWDAF' at the top, an oval 'Nnwdaf' inside it, and a box 'V-RE-NWDAF' at the bottom, also connected by a line labeled 'Nnwdaf_RoamingData'.](18003425d0e8638dde4acc9c5c468c5c_img.jpg) + +Figure 4.8.1.2-1: Reference Architecture for the Nnwdaf\_RoamingData Service; SBI representation. The diagram shows two vertical stacks. The left stack has a box 'V-RE-NWDAF' at the top, an oval 'Nnwdaf' inside it, and a box 'H-RE-NWDAF' at the bottom, connected by a line labeled 'Nnwdaf\_RoamingData'. The right stack has a box 'H-RE-NWDAF' at the top, an oval 'Nnwdaf' inside it, and a box 'V-RE-NWDAF' at the bottom, also connected by a line labeled 'Nnwdaf\_RoamingData'. + +**Figure 4.8.1.2-1: Reference Architecture for the Nnwdaf\_RoamingData Service; SBI representation** + +![Figure 4.8.1.2-2: Reference Architecture for the Nnwdaf_RoamingData Service: reference point representation. The diagram shows a box 'H-RE-NWDAF' at the top and a box 'V-RE-NWDAF' at the bottom, connected by a vertical line with a small horizontal tick mark in the middle.](a4eb9fe011f0e6dc8405f777c5f3f766_img.jpg) + +Figure 4.8.1.2-2: Reference Architecture for the Nnwdaf\_RoamingData Service: reference point representation. The diagram shows a box 'H-RE-NWDAF' at the top and a box 'V-RE-NWDAF' at the bottom, connected by a vertical line with a small horizontal tick mark in the middle. + +**Figure 4.8.1.2-2: Reference Architecture for the Nnwdaf\_RoamingData Service: reference point representation** + +#### 4.8.1.3 Network Functions + +##### 4.8.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF) with roaming exchange capability, i.e. the V-RE-NWDAF or H-RE-NWDAF, provides data information related to roaming UE(s) to NF service consumers. + +The Network Data Analytics Function (NWDAF) allows NF service consumers to subscribe to and unsubscribe from one-time, periodic notification or notification when an event is detected. + +##### 4.8.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF) with roaming exchange capability, i.e. the H-RE-NWDAF or V-RE-NWDAF, supports (un)subscription to the notification of the data of roaming UEs exposed by an NWDAF. + +### 4.8.2 Service Operations + +#### 4.8.2.1 Introduction + +**Table 4.8.2.1-1: Operations of the Nnwdaf\_RoamingData Service** + +| Service operation name | Description | Initiated by | +|--------------------------------|------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| Nnwdaf_RoamingData_Subscribe | This service operation is used by an NF service consumer to subscribe to the data of roaming UEs exposed by an RE-NWDAF. | NF service consumer (RE-NWDAF) | +| Nnwdaf_RoamingData_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe from the data of roaming UEs exposed by an RE-NWDAF. | NF service consumer (RE-NWDAF) | +| Nnwdaf_RoamingData_Notify | This service operation is used by the NWDAF to notify the data of roaming UEs exposed by an RE-NWDAF. | RE-NWDAF | + +## 4.8.2.2 Nnwdaf\_RoamingData\_Subscribe service operation + +### 4.8.2.2.1 General + +The Nnwdaf\_RoamingData\_Subscribe service operation is used by an NF service consumer to subscribe or update subscription for the data of roaming UEs exposed by an RE-NWDAF. + +### 4.8.2.2.2 Subscription for event notifications + +Figure 4.8.2.2.2-1 shows a scenario where the NF service consumer sends a request to the RE-NWDAF to subscribe for event notification(s). + +![Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF. The consumer sends a POST request to the subscriptions resource, and the RE-NWDAF responds with a 201 Created status.](02dfdcd208dbdc8fa4f645885e59dd17_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant RE-NWDAF + Note right of NF Service Consumer: 1. POST « subscriptions » + NF Service Consumer->>RE-NWDAF: 1. POST « subscriptions » + Note left of RE-NWDAF: 2. "201 Created" + RE-NWDAF-->>NF Service Consumer: 2. "201 Created" + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF. The consumer sends a POST request to the subscriptions resource, and the RE-NWDAF responds with a 201 Created status. + +**Figure 4.8.2.2.2-1: NF service consumer subscribes to notifications** + +The NF service consumer shall invoke the Nnwdaf\_RoamingData\_Subscribe service operation to subscribe to event notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwda-roamingdata//subscriptions" as Resource URI representing the "NWDAF Roaming Data Subscriptions", as shown in figure 4.8.2.2.2-1, step 1, to create a subscription for an "Individual NWDAF Roaming Data Subscription" according to the information in message body. The RoamingDataSub data structure provided in the request body shall include: + +- the notification URI within "notificationUri" attribute; +- the notification correlation identifier within "notifCorrId" attribute; +- the PLMN ID of the consumer within "plmnId" attribute; +- either the analytics subscription information to be used by the NWDAF to determine the data that can be used to generate these analytics within the "anaSub" attribute or subscribed data events within the "dataSub" attribute; + +and may include: + +- formatting instructions within the "formatInstruct" attribute; +- processing instructions within the "procInstructs" attribute; +- time window of the occurrence of the requested data collection within the "timePeriod" attribute; and +- either a target NF identifier within the "targetNfId" attribute" or a target NF set identifier within the "targetNfSetId" attribute". + +Upon the reception of an HTTP POST request with "{apiRoot}/nnwda-roamingdata//subscriptions" as Resource URI and RoamingDataSub data structure as request body, the RE-NWDAF shall: + +- create a new new subscription; +- assign a subscriptionId; +- store the subscription. + +If the RE-NWDAF created an "Individual NWDAF Roaming Data Subscription" resource, the RE-NWDAF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.8.2.2.2-1, step 2. The RE-NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created profile, i.e. + +"{apiRoot}/nnwda-roamingdata//subscriptions/{subscriptionId}" + +If the immediate reporting indication in the "immRep" attribute within the "eventReportReq" attribute sets to true in the event subscription, the NWDAF shall include the reports of the events subscribed within "immReport" attribute, if available, in the HTTP POST response. + +If an error occurs when processing the HTTP POST request, the RE-NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +#### 4.8.2.2.3 Update of subscription for event notifications + +Figure 4.8.2.2.3-1 shows a scenario where the NF service consumer sends a request to the RE-NWDAF to update a subscription for event notification(s). + +![Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF to update a subscription. The consumer sends a PUT request to 'subscriptions/{subscriptionId}' and the RE-NWDAF responds with either a 200 OK or a 204 No Content.](4390b89fdb95cba102ee1f88e218b07b_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant RE-NWDAF + Note right of RE-NWDAF: 2a."200 OK" or +2b."204 No Content" + NF Service Consumer->>RE-NWDAF: 1. PUT « subscriptions/{subscriptionId} » + RE-NWDAF-->>NF Service Consumer: 2a."200 OK" or +2b."204 No Content" + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF to update a subscription. The consumer sends a PUT request to 'subscriptions/{subscriptionId}' and the RE-NWDAF responds with either a 200 OK or a 204 No Content. + +**Figure 4.8.2.2.3-1: NF service consumer updates subscription to notifications** + +The NF service consumer shall invoke the Nnwdaf\_RoamingData\_Subscribe service operation to update a subscription to event notification(s) by sending an HTTP PUT request with "{apiRoot}/nnwdaf-roamingdata//subscriptions/{subscriptionId}" as Resource URI representing the "Individual NWDAF Roaming Data Subscription", as shown in figure 4.8.2.2.3-1, step 1, to update this "Individual NWDAF Roaming Data Subscription" according to the information in message body. The RoamingDataSub data structure provided in the request body shall include the same contents as in clause 4.8.2.2.2. + +Upon the reception of an HTTP PUT request with "{apiRoot}/nnwdaf-roamingdata//subscriptions/{subscriptionId}" as Resource URI and RoamingDataSub data structure as request body, the RE-NWDAF shall: + +- update the subscription of corresponding subscriptionId; and +- store the subscription. + +If the RE-NWDAF successfully update the "Individual NWDAF Roaming Data Subscription" resource, the RE-NWDAF shall respond with "200 OK" with the message body containing a representation of the created subscription, as shown in figure 4.8.2.2.3-1-1, step 2a, or with "204 No Content" as shown in figure 4.8.2.2.3-1-1, step 2b. + +If the immediate reporting indication in the "immRep" attribute within the "eventReportReq" attribute sets to "true" in the request, the RE-NWDAF shall include the reports of the events subscribed within "immReport" attribute, if available, in the HTTP PUT response. + +If an error occurs when processing the HTTP PUT request, the RE-NWDAF shall send an HTTP error response as specified in clause 5.7.7. + +#### 4.8.2.3 Nnwdaf\_RoamingData\_Unsubscribe service operation + +##### 4.8.2.3.1 General + +The Nnwdaf\_RoamingData\_Unsubscribe service operation is used by an NF service consumer to unsubscribe from the data of roaming UEs exposed by an RE-NWDAF. + +#### 4.8.2.3.2 Unsubscribe from event notifications + +Figure 4.8.2.3.2-1 shows a scenario where the NF service consumer sends a request to the RE-NWDAF to unsubscribe from notifications. + +![Sequence diagram showing the unsubscribe process between an NF Service Consumer and an RE-NWDAF.](67c5b121b58d497a6de5addf4e7bd555_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant RE-NWDAF + Note left of NF Service Consumer: + Note right of RE-NWDAF: + NF Service Consumer->>RE-NWDAF: 1. DELETE « subscriptions/{subscriptionId} + RE-NWDAF-->>NF Service Consumer: 2. "204 No Content" +``` + +The diagram illustrates a sequence of interactions between an NF Service Consumer and an RE-NWDAF. The NF Service Consumer sends a DELETE request for a specific subscription (step 1), and the RE-NWDAF responds with a 204 No Content status code (step 2). + +Sequence diagram showing the unsubscribe process between an NF Service Consumer and an RE-NWDAF. + +**Figure 4.8.2.3.2-1: NF service consumer unsubscribes from notifications** + +The NF service consumer shall invoke the Nnwdaf\_RoamingData\_Unsubscribe service operation to unsubscribe to event notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nnwdaf-roamingdata//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscription ID of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request with: + +"{apiRoot}/nnwdaf-roamingdata//subscriptions/{subscriptionId}" as Resource URI, if the RE-NWDAF successfully processed and accepted the received HTTP DELETE request, the RE-NWDAF shall: + +- remove the corresponding subscription; and +- respond with HTTP "204 No Content" status code. + +If the RE-NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If an error occurs when processing the HTTP DELETE request, the RE-NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +#### 4.8.2.4 Nnwdaf\_RoamingData\_Notify service operation + +##### 4.8.2.4.1 General + +The Nnwdaf\_RoamingData\_Notify service operation is used by an RE-NWDAF to notify NF service consumer about the subscribed data of roaming UEs exposed by an RE-NWDAF. + +##### 4.8.2.4.2 Notification about subscribed event + +Figure 4.8.2.4.2-1 shows a scenario where the NF service consumer sends a request to notify for event notifications. + +![Sequence diagram showing RE-NWDAF notifying the subscribed event. The diagram consists of two lifelines: 'NF service consumer' on the left and 'RE-NWDAF' on the right. Step 1: A solid arrow points from RE-NWDAF to NF service consumer with the label '1. POST{notificationUri}'. Step 2: A solid arrow points from NF service consumer to RE-NWDAF with the label '2. "204 No Content"'.](de63e4b6d8b0aa76b85e1fe3236eac27_img.jpg) + +``` +sequenceDiagram + participant RE-NWDAF + participant NF_service_consumer as NF service consumer + Note right of RE-NWDAF: 1. POST{notificationUri} + RE-NWDAF->>NF_service_consumer: 1. POST{notificationUri} + Note left of NF_service_consumer: 2. "204 No Content" + NF_service_consumer-->>RE-NWDAF: 2. "204 No Content" +``` + +Sequence diagram showing RE-NWDAF notifying the subscribed event. The diagram consists of two lifelines: 'NF service consumer' on the left and 'RE-NWDAF' on the right. Step 1: A solid arrow points from RE-NWDAF to NF service consumer with the label '1. POST{notificationUri}'. Step 2: A solid arrow points from NF service consumer to RE-NWDAF with the label '2. "204 No Content"'. + +**Figure 4.8.2.4.2-1: RE-NWDAF notifies the subscribed event** + +The RE-NWDAF shall invoke the Nnwdaf\_RoamingData\_Notify service operation to notify the subscribed event. The RE-NWDAF shall send an HTTP POST request with "{notificationUri}" received in the Nnwdaf\_RoamingData\_Notify service operation as Resource URI, as shown in figure 4.8.2.4.2-1, step 1. The HTTP POST message shall include NnwdafDataManagementNotif data structure as described in clause 5.3.6.2.2. + +Upon the reception of an HTTP POST request, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall store the notification and respond with HTTP "204 No Content" status code. + +If the RE-NWDAF determines the received HTTP POST request needs to be redirected, the RE-NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If an error occurs when processing the HTTP POST request, the RE-NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +## 4.9 Nnwdaf\_RoamingAnalytics Service + +### 4.9.1 Service Description + +#### 4.9.1.1 Overview + +The Nnwdaf\_RoamingAnalytics service is provided by the Network Data Analytics Function (NWDAF) with roaming exchange capability, which is called Roaming Exchange NWDAF (RE-NWDAF). + +This service: + +- allows NF service consumers to subscribe to and unsubscribe from different analytics events related to roaming UE(s); and +- notifies NF service consumers with a corresponding subscription about observed events related to roaming UE(s). + +#### 4.9.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture, including the case of roaming, is defined in 3GPP TS 23.288 [17]. The Network Data Analytics signalling flows are defined in 3GPP TS 29.552 [25], the Policy and Charging related 5G architecture is also described in 3GPP TS 23.503 [4] and 3GPP TS 29.513 [5]. + +The Nnwdaf\_RoamingAnalytics service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF), but it can be provided only by an NWDAF with the roaming exchange capability, which is called Roaming Exchange NWDAF (RE-NWDAF). + +The only known consumer of the Nnwdaf\_RoamingAnalytics service is the Roaming Exchange NWDAF (RE-NWDAF). + +Both the RE-NWDAF that provides the Nnwdaf\_RoamingAnalytics service and the RE-NWDAF that consumes the Nnwdaf\_RoamingAnalytics service may be in the HPLMN (in which case it is denoted as H-RE-NWDAF) or in the + +VPLMN (in which case it is denoted as H-RE-NWDAF). If the NF service producer is the H-RE-NWDAF then the NF service consumer is the V-RE-NWDAF and vice versa. + +![Two diagrams showing the SBI representation of the Nnwdaf_RoamingAnalytics service. The left diagram shows H-RE-NWDAF (Nnwdaf) as the producer and V-RE-NWDAF as the consumer. The right diagram shows V-RE-NWDAF (Nnwdaf) as the producer and H-RE-NWDAF as the consumer.](c063ca3181a644e8ae4aebfd4cb1a2c3_img.jpg) + +The diagram consists of two separate vertical connections. The left connection shows a box labeled 'H-RE-NWDAF' containing an oval labeled 'Nnwdaf' connected by a vertical line to a box labeled 'V-RE-NWDAF'. The line is labeled 'Nnwdaf\_RoamingAnalytics'. The right connection shows a box labeled 'V-RE-NWDAF' containing an oval labeled 'Nnwdaf' connected by a vertical line to a box labeled 'H-RE-NWDAF'. This line is also labeled 'Nnwdaf\_RoamingAnalytics'. + +Two diagrams showing the SBI representation of the Nnwdaf\_RoamingAnalytics service. The left diagram shows H-RE-NWDAF (Nnwdaf) as the producer and V-RE-NWDAF as the consumer. The right diagram shows V-RE-NWDAF (Nnwdaf) as the producer and H-RE-NWDAF as the consumer. + +**Figure 4.9.1.2-1: Reference Architecture for the Nnwdaf\_RoamingAnalytics Service; SBI representation** + +![Diagram showing the reference point representation of the Nnwdaf_RoamingAnalytics service. It shows H-RE-NWDAF connected to V-RE-NWDAF via a reference point symbol (a vertical line with a horizontal crossbar).](691626a7032a642bb74793336c37e274_img.jpg) + +The diagram shows a box labeled 'H-RE-NWDAF' at the top connected by a vertical line to a box labeled 'V-RE-NWDAF' at the bottom. In the middle of the vertical line is a reference point symbol, which is a horizontal line with a vertical crossbar. + +Diagram showing the reference point representation of the Nnwdaf\_RoamingAnalytics service. It shows H-RE-NWDAF connected to V-RE-NWDAF via a reference point symbol (a vertical line with a horizontal crossbar). + +**Figure 4.9.1.2-2: Reference Architecture for the Nnwdaf\_RoamingAnalytics Service: reference point representation** + +#### 4.9.1.3 Network Functions + +##### 4.9.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF) with roaming exchange capability, i.e. the RE-NWDAF, provides analytics information for different analytics events related to roaming UE(s) to NF service consumers. + +The Network Data Analytics Function (NWDAF) allows NF service consumers to subscribe to and unsubscribe from one-time, periodic notification or notification when an event is detected. + +##### 4.9.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF) with roaming exchange capability, i.e. the RE-NWDAF, supports (un)subscription to the notification of analytics information for all types of network analytics related to roaming UE(s) from the NWDAF. + +## 4.9.2 Service Operations + +### 4.9.2.1 Introduction + +**Table 4.9.2.1-1: Operations of the Nnwdaf\_RoamingAnalytics Service** + +| Service operation name | Description | Initiated by | +|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| Nnwdaf_RoamingAnalytics_Subscribe | This service operation is used by an NF to subscribe or update subscription for event notifications of the analytics information related to roaming UE(s).
One-time, periodic notification or notification upon event detection can be subscribed. | NF service consumer (RE-NWDAF) | +| Nnwdaf_RoamingAnalytics_Unsubscribe | This service operation is used by an NF to unsubscribe from event notifications. | NF service consumer (RE-NWDAF) | +| Nnwdaf_RoamingAnalytics_Notify | This service operation is used by an RE-NWDAF to notify NF service consumers about subscribed events. | RE-NWDAF | + +### 4.9.2.2 Nnwdaf\_RoamingAnalytics\_Subscribe service operation + +#### 4.9.2.2.1 General + +The Nnwdaf\_RoamingAnalytics\_Subscribe service operation is used by an NF service consumer to subscribe or update subscription for event notifications related to roaming UE(s) from the NWDAF. + +#### 4.9.2.2.2 Subscription for event notifications + +Figure 4.9.2.2.2-1 shows a scenario where the NF service consumer sends a request to the RE-NWDAF to subscribe for event notification(s). + +![Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF. The NF Service Consumer sends a POST request for subscriptions to the RE-NWDAF, and the RE-NWDAF responds with a 201 Created status.](d3f0eb93239fde2cb96b2baf46d62d6c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant RE-NWDAF + Note left of NF Service Consumer: NF Service Consumer + Note right of RE-NWDAF: RE-NWDAF + NF Service Consumer->>RE-NWDAF: 1. POST « subscriptions + RE-NWDAF-->>NF Service Consumer: 2. "201 Created" + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF. The NF Service Consumer sends a POST request for subscriptions to the RE-NWDAF, and the RE-NWDAF responds with a 201 Created status. + +**Figure 4.9.2.2.2-1: NF service consumer subscribes to notifications** + +The NF service consumer shall invoke the Nnwdaf\_RoamingAnalytics\_Subscribe service operation to subscribe to event notification(s) related to roaming UE(s) by sending an HTTP POST request with "{apiRoot}/nnwdaf-roaminganalytics//subscriptions" as Resource URI representing the "NWDAF Roaming Analytics Subscriptions" resource, as shown in figure 4.9.2.2.2-1, step 1, to create an "Individual NWDAF Roaming Analytics Subscription" resource according to the information in message body. The RoamingAnalyticsSubscription data structure provided in the request body shall include: + +- a URI where to receive the requested notifications as "notifUri" attribute; +- a notification correlation identifier as "notifCorrId" attribute; +- the PLMN ID of the NF service consumer as "consPlmnId" attribute; + +- a description of the subscribed events as "roamEventSubs" attribute with the same contents as specified for the "eventSubscriptions" attribute in clause 4.2.2.2.2 but excluding the attributes that are indicated as non applicable in Table 5.7.6.2.2-1. + +NOTE: The features mentioned in clause 4.2.2.2.2 are not relevant here. + +and may include: + +- event reporting information as the "evtReq" attribute with the same contents as specified for the "evtReq" attribute in clause 4.2.2.2.2. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nnwda-roaminganalytics//subscriptions" as Resource URI and RoamingAnalyticsSubscription data structure as request body, if no errors occur, the RE-NWDAF shall: + +- create a new subscription; +- assign an event subscriptionId; and +- store the subscription. + +If the RE-NWDAF created an "Individual NWDAF Roaming Analytics Subscription" resource, the RE-NWDAF shall respond with "201 Created" status code with the message body containing a representation of the created subscription, as shown in figure 4.9.2.2.2-1, step 2. If not all the requested analytics events in the subscription are accepted, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. + +"{apiRoot}/nnwda-roaminganalytics//subscriptions/{subscriptionId}". If the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute was set to true in the event subscription, the RE-NWDAF shall include the reports of the events subscribed, if available, in the HTTP POST response within the "roamEventNotifs" attribute. + +When the "notifFlag" attribute is included and set to "DEACTIVATE" in the request, the RE-NWDAF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). + +If the analytics target period provided in the body of the HTTP POST request includes the start time in the past and the end time in the future, the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "BOTH\_STAT\_PRED\_NOT\_ALLOWED". + +If the statistics in the past are requested but the necessary data to perform the service is unavailable, the RE-NWDAF shall reject the request with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "UNAVAILABLE\_DATA". + +**Editor's Note: The applicability and the handling of user consent is FFS and depends on stage 2 updates.** + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.7.7. + +#### 4.9.2.2.3 Update subscription for event notifications + +Figure 4.9.2.2.3-1 shows a scenario where the NF service consumer sends a request to the RE-NWDAF to update the subscription for event notifications. + +![Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF. The consumer sends a PUT request to subscriptions/{subscriptionId} (step 1). The RE-NWDAF responds with either a 200 OK (step 2a) or a 204 No Content (step 2b).](6a993bfdf2e00cfad01c4d2188a75d86_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant RE-NWDAF + Note left of RE-NWDAF: 1. PUT « subscriptions/{subscriptionId} » + RE-NWDAF->>NF Service Consumer: 2a. "200 OK" or 2b. "204 No Content" + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF. The consumer sends a PUT request to subscriptions/{subscriptionId} (step 1). The RE-NWDAF responds with either a 200 OK (step 2a) or a 204 No Content (step 2b). + +**Figure 4.9.2.2.3-1: NF service consumer updates subscription to notifications** + +The NF service consumer shall invoke the Nnwdaf\_RoamingAnalytics\_Subscribe service operation to update subscription to event notifications related to roaming UE(s) by sending an HTTP PUT request with "{apiRoot}/nnwdaf-roaminganalytics//subscriptions/{subscriptionId}" as Resource URI representing the "Individual NWDAF Roaming Analytics Subscription", as shown in figure 4.9.2.2.3-1, step 1, to update the subscription for an "Individual NWDAF Roaming Analytics Subscription" resource identified by the {subscriptionId}. The RoamingAnalyticsSubscription data structure provided in the request body shall include the same contents as described in clause 4.9.2.2.2. + +Upon the reception of an HTTP PUT request with: "{apiRoot}/nnwdaf-roaminganalytics//subscriptions/{subscriptionId}" as Resource URI and RoamingAnalyticsSubscription data structure as request body, the NWDAF shall: + +- update the subscription of corresponding subscriptionId; and +- store the subscription. + +If the RE-NWDAF successfully processed and accepted the received HTTP PUT request, the RE-NWDAF shall update an "Individual NWDAF Roaming Analytics Subscription" resource, and shall respond with: + +- a) HTTP "200 OK" status code with the message body containing a representation of the updated subscription, as shown in figure 4.9.2.2.3-1, step 2a. If not all the requested analytics events in the subscription are modified successfully, then the RE-NWDAF may include the "failEventReports" attribute indicating the event(s) for which the modification failed and the associated reason(s). If the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute was set to true in the request, the RE-NWDAF shall include the reports of the events subscribed, if available, in the HTTP PUT response within the "roamEventNotifs" attribute; or +- b) HTTP "204 No Content" status code, as shown in figure 4.9.2.2.3-1, step 2b. + +If errors occur when processing the HTTP PUT request, the RE-NWDAF shall send an HTTP error response as specified in clause 5.7.7. + +If the analytics target period provided in the body of the HTTP PUT request includes the start time in the past and the end time in the future, the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "BOTH\_STAT\_PRED\_NOT\_ALLOWED". + +If the statistics in the past are requested but the necessary data to perform the service is unavailable, the RE-NWDAF shall reject the request with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "UNAVAILABLE\_DATA". + +If the RE-NWDAF determines that the received HTTP PUT request needs to be redirected, the RE-NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +When the "notifFlag" attribute is included in the request with the value "DEACTIVATE", the RE-NWDAF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer); if the "notifFlag" attribute is set to the value "RETRIEVAL", the NWDAF shall send the stored events to the NF service consumer, mute the event notification again and store available events; if the "notifFlag" attribute is set to the value "ACTIVATE" and + +the event notifications are muted (due to a previously received "DEACTIVATE" value), the NWDAF shall unmute the event notification, i.e. start sending again notifications for available events. + +#### 4.9.2.3 Nnwdaf\_RoamingAnalytics\_Unsubscribe service operation + +##### 4.9.2.3.1 General + +The Nnwdaf\_RoamingAnalytics\_Unsubscribe service operation is used by an NF service consumer to unsubscribe from event notifications related to roaming UE(s). + +##### 4.9.2.3.2 Unsubscribe from event notifications + +Figure 4.9.2.3.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to unsubscribe from event notifications related to roaming UE(s). + +![Sequence diagram showing the unsubscribe process between an NF Service Consumer and RE-NWDAF.](2a52834ffb60a618738d21bcc3ace1e3_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant RE-NWDAF + Note left of NF Service Consumer: 1. DELETE « subscriptions/{subscriptionId} » + NF Service Consumer->>RE-NWDAF: Request + Note right of RE-NWDAF: 2. "204 No Content" + RE-NWDAF-->>NF Service Consumer: Response +``` + +The diagram illustrates a sequence of interactions between an NF Service Consumer and an RE-NWDAF. The NF Service Consumer sends a DELETE request to the RE-NWDAF, specifically to the resource 'subscriptions/{subscriptionId}'. The RE-NWDAF responds with a '204 No Content' status code. The sequence is numbered 1 and 2, with arrows indicating the direction of the messages. + +Sequence diagram showing the unsubscribe process between an NF Service Consumer and RE-NWDAF. + +**Figure 4.9.2.3.2-1: NF service consumer unsubscribes from notifications** + +The NF service consumer shall invoke the Nnwdaf\_RoamingAnalytics\_Unsubscribe service operation to unsubscribe to event notifications related to roaming UE(s) by sending an HTTP DELETE request with: "{apiRoot}/nnwdaf-roaminganalytics//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request with: + +"{apiRoot}/nnwdaf-roaminganalytics//subscriptions/{subscriptionId}" as Resource URI, if the RE-NWDAF successfully processed and accepted the received HTTP DELETE request, the RE-NWDAF shall: + +- remove the corresponding subscription; and +- respond with HTTP "204 No Content" status code. + +If errors occur when processing the HTTP DELETE request, the RE-NWDAF shall send an HTTP error response as specified in clause 5.7.7. + +If the RE-NWDAF determines that the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.9.2.4 Nnwdaf\_RoamingAnalytics\_Notify service operation + +##### 4.9.2.4.1 General + +The Nnwdaf\_RoamingAnalytics\_Notify service operation is used by an RE-NWDAF to notify NF consumers about subscribed events related to roaming UE(s). + +##### 4.9.2.4.2 Notification about subscribed event + +Figure 4.9.2.4.2-1 shows a scenario where the RE-NWDAF sends a request to the NF service consumer to notify for event notifications related to roaming UE(s). + +![Sequence diagram showing RE-NWDAF notifying the subscribed event. The diagram consists of two lifelines: 'NF service consumer' on the left and 'RE-NWDAF' on the right. Step 1: A solid arrow points from the NF service consumer to the RE-NWDAF with the label '1. POST{notificationUri}'. Step 2: A solid arrow points from the RE-NWDAF back to the NF service consumer with the label '2. "204 No Content"'.](e18841eb4a995df8354a793459e12fd0_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant RE-NWDAF + Note left of NF service consumer: 1. POST{notificationUri} + NF service consumer->>RE-NWDAF: 1. POST{notificationUri} + Note right of RE-NWDAF: 2. "204 No Content" + RE-NWDAF-->>NF service consumer: 2. "204 No Content" + +``` + +Sequence diagram showing RE-NWDAF notifying the subscribed event. The diagram consists of two lifelines: 'NF service consumer' on the left and 'RE-NWDAF' on the right. Step 1: A solid arrow points from the NF service consumer to the RE-NWDAF with the label '1. POST{notificationUri}'. Step 2: A solid arrow points from the RE-NWDAF back to the NF service consumer with the label '2. "204 No Content"'. + +**Figure 4.9.2.4.2-1: RE-NWDAF notifies the subscribed event** + +The NWDAF shall invoke the Nnwdaf\_RoamingAnalytics\_Notify service operation to notify the subscribed event related to roaming UE(s) by sending an HTTP POST request with the "{notifUri}" that was received in the Nnwdaf\_RoamingAnalytics\_Subscribe service operation as Resource URI, as shown in figure 4.9.2.4.2-1, step 1. + +If both the repetition period ("repPeriod" or "repetitionPeriod") attribute and the "offsetPeriod" attribute were present in the subscription request for periodical notification, the NWDAF shall produce a notification in every repetition period seconds, including the statistics in the past offset period if the "offsetPeriod" attribute value is negative, or including the prediction for the future offset period if the "offsetPeriod" attribute value is positive. + +The RoamingAnalyticsNotification data structure provided in the request body shall include: + +- the notification correlation identifier as "notifCorrId" attribute; +- a description of the notified event(s) as "roamEventNotifs" attribute with the same contents as specified for the "eventNotifications" attribute in clause 4.2.2.4.2 but excluding the attributes that are indicated as non applicable in Table 5.7.6.2.3-1. + +NOTE: The features mentioned in clause 4.2.2.4.2 are not relevant here. + +and may include: + +- a cause for termination in the "termCause" attribute if the NWDAF wants to request the termination of this subscription, i.e. to indicate that it will send no further notifications for it. + +If the time when analytics information is needed has been provided (via the "timeAnaNeeded" attribute within the "extraReportReq" attribute) during the subscription for an event (via the "event" attribute within the EventSubscription data type), if the time when analytics information is needed is reached but the subscribed analytics information is not ready, the consumer does not need to wait for the analytics information any longer. In this case, the RE-NWDAF may send an HTTP POST request as shown in step 1 of figure 4.9.2.4.2-1, which shall only provide (within the EventNotification data type in the RoamingAnalyticsNotification data type) an indication of the failure event via the "event" attribute and the corresponding failure reason via a "failNotifyCode" attribute, and may also provide a minimum time interval recommended by the NWDAF for the event via a "rvWaitTime" attribute which will be used by the NF service consumer to determine the time when analytics information is needed in similar future analytics subscriptions. + +Upon the reception of an HTTP POST request with: "{notifUri}" as Resource URI and RoamingAnalyticsNotification data structure as request body, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF service consumer shall: + +- store the notification; and +- respond with HTTP "204 No Content" status code. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.7.7. + +If the NF service consumer determines that the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +## 5 API Definitions + +### 5.1 Nnwdaf\_EventsSubscription Service API + +#### 5.1.1 Introduction + +The Nnwdaf\_EventsSubscription service shall use the Nnwdaf\_EventsSubscription API. + +The API URI of the Nnwdaf\_EventsSubscription API shall be: + +{apiRoot}/ + +The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-eventssubscription". +- The shall be "v1". +- The 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 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_EventsSubscription 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 [6] for the usage of HTTP standard headers. + +###### 5.1.2.2.2 Content type + +JSON, IETF RFC 8259 [10], 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 [6]. 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 9457 [15]. + +##### 5.1.2.3 HTTP custom headers + +The Nnwdaf\_EventsSubscription service API shall support the mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_EventsSubscription service API. + +## 5.1.3 Resources + +### 5.1.3.1 Resource Structure + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.1.3.1-1 depicts the resource URIs structure for the Nnwdaf\_EventsSubscription API. + +![Diagram showing the resource URI structure for the Nnwdaf_EventsSubscription API. The root is {apiRoot}/nnwdafeventssubscription/. It branches into /subscriptions and /transfers. /subscriptions further branches into /{subscriptionId}. /transfers further branches into /{transferId}.](b49477e8f148b5ef044a2fd5a43528f6_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnwdafeventssubscription/"] --> Subscriptions["/subscriptions"] + Root --> Transfers["/transfers"] + Subscriptions --> SubId["/{subscriptionId}"] + Transfers --> TransferId["/{transferId}"] + +``` + +Diagram showing the resource URI structure for the Nnwdaf\_EventsSubscription API. The root is {apiRoot}/nnwdafeventssubscription/. It branches into /subscriptions and /transfers. /subscriptions further branches into /{subscriptionId}. /transfers further branches into /{transferId}. + +**Figure 5.1.3.1-1: Resource URI structure of the Nnwdaf\_EventsSubscription 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 | +|----------------------------------------------|---------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NWDAF Events Subscriptions | /subscriptions | POST | Creates a new Individual NWDAF Event Subscription resource. | +| Individual NWDAF Event Subscription | /subscriptions/{subscriptionId} | DELETE | Deletes an Individual NWDAF Event Subscription identified by subresource {subscriptionId}. | +| | | PUT | Modifies an existing Individual Event Subscription subresource. | +| NWDAF Event Subscription Transfers | /transfers | POST | Provides information about the requested analytics subscription transfer(s), potentially creating a new Individual NWDAF Event Subscription Transfer resource. | +| Individual NWDAF Event Subscription Transfer | /transfers/{transferId} | DELETE | Deletes an Individual NWDAF Event Subscription Transfer resource identified by subresource {transferId}. | +| | | PUT | Modifies an existing Individual NWDAF Event Subscription Transfer resource. | + +### 5.1.3.2 Resource: NWDAF Events Subscriptions + +#### 5.1.3.2.1 Description + +The NWDAF Events Subscriptions resource represents all subscriptions to the Nnwdaf\_EventsSubscription service at a given NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF Event Subscription resource. + +### 5.1.3.2.2 Resource definition + +Resource URI: {apiRoot}/nnwdafeventssubscription//subscriptions + +The shall be set as described in clause 5.1.1. + +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 POST 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.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 | +|--------------------------|---|-------------|-------------------------------------------------------------| +| NnwdafeventsSubscription | M | 1 | Creates a new Individual NWDAF 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 | +|--------------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| NnwdafeventsSubscription | M | 1 | 201 Created | The creation of an Individual NWDAF Event Subscription resource is confirmed and a representation of that resource is returned. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure cases are described in clause 5.1.7. + +**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}/nnwdafeventssubscription//subscriptions/{subscriptionId}. | + +#### 5.1.3.2.4 Resource Custom Operations + +None in this release of the specification. + +#### 5.1.3.3 Resource: Individual NWDAF Event Subscription + +##### 5.1.3.3.1 Description + +The Individual NWDAF Event Subscription resource represents a single subscription to the Nnwdaf\_EventsSubscription service at a given NWDAF. + +##### 5.1.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-eventssubscription//subscriptions/{subscriptionId} + +The shall be set as described in clause 5.1.1. + +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 Nnwdaf_EventsSubscription service. | + +##### 5.1.3.3.3 Resource Standard Methods + +###### 5.1.3.3.3.1 DELETE + +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 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.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 DELETE 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 DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case: The Individual NWDAF Event Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Event Subscription deletion.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Event Subscription deletion.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (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 | +|--------------------------|---|-------------|----------------------------------------------------------------------------| +| NnwdafEventsSubscription | M | 1 | Parameters to replace a subscription to NWDAF 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 | +|--------------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| NnwdafEventsSubscription | M | 1 | 200 OK | The Individual NWDAF Event Subscription resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF Event Subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Event Subscription modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Event Subscription modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure cases are described in clause 5.1.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.1.3.3.4 Resource Custom Operations + +None in this release of the specification. + +#### 5.1.3.4 Resource: NWDAF Event Subscription Transfers + +##### 5.1.3.4.1 Description + +The NWDAF Event Subscription Transfers resource represents all requests to transfer subscription(s) of the Nnwdaf\_EventsSubscription service at a given NWDAF. The resource allows an NF service consumer to provide information about analytics subscriptions that are requested to be: + +- prepared for transfer, leading to the creation of a new Individual NWDAF Event Subscription Transfer resource, which can be later modified, removed, or requested to be transferred; and +- transferred, leading to the execution of the necessary steps for transferring the analytics subscription. + +##### 5.1.3.4.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-eventssubscription//transfers + +The shall be set as described in clause 5.1.1. + +This resource shall support the resource URI variables defined in table 5.1.3.4.2-1. + +**Table 5.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.1.1 | + +##### 5.1.3.4.3 Resource Standard Methods + +###### 5.1.3.4.3.1 POST + +This method shall support the URI query parameters specified in table 5.1.3.4.3.1-1. + +**Table 5.1.3.4.3.1-1: URI query parameters supported by the POST 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.4.3.1-2 and the response data structures and response codes specified in table 5.1.3.4.3.1-3. + +**Table 5.1.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| AnalyticsSubscriptionsTransfer | M | 1 | Information about analytics subscription(s) that are requested to be transferred or prepared for transfer. | + +**Table 5.1.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AnalyticsSubscriptionsTransfer | M | 1 | 201 Created | The creation of an Individual NWDAF Event Subscription Transfer resource is confirmed and a representation of that resource is returned. | +| n/a | | | 204 No Content | The receipt of the information about analytics subscription(s) that are requested to be transferred and the ability to handle this information (e.g. execute the steps required to transfer an analytics subscription directly) is confirmed. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +**Table 5.1.3.4.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}/nnwdafeventssubscription//transfers/{transferId}. | + +#### 5.1.3.4.4 Resource Custom Operations + +None in this release of the specification. + +#### 5.1.3.5 Resource: Individual NWDAF Event Subscription Transfer + +##### 5.1.3.5.1 Description + +The Individual NWDAF Event Subscription Transfer resource represents a single request to transfer subscription(s) of the Nnwdafeventssubscription service at a given NWDAF. + +##### 5.1.3.5.2 Resource definition + +Resource URI: {apiRoot}/nnwdafeventssubscription//transfers/{transferId} + +The shall be set as described in clause 5.1.1. + +This resource shall support the resource URI variables defined in table 5.1.3.5.2-1. + +**Table 5.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.1.1. | +| transferId | string | Identifies a request to transfer subscription(s) of the Nnwdafeventssubscription service. | + +##### 5.1.3.5.3 Resource Standard Methods + +###### 5.1.3.5.3.1 DELETE + +This method shall support the URI query parameters specified in table 5.1.3.5.3.1-1. + +**Table 5.1.3.5.3.1-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.5.3.1-2 and the response data structures and response codes specified in table 5.1.3.5.3.1-3. + +**Table 5.1.3.5.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.1.3.5.3.1-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 NWDAF Event Subscription Transfer resource matching the transferId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Event Subscription Transfer deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Event Subscription Transfer deletion.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.1.3.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.1.3.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.1.3.5.3.2 PUT + +This method shall support the URI query parameters specified in table 5.1.3.5.3.2-1. + +**Table 5.1.3.5.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.5.3.2-2 and the response data structures and response codes specified in table 5.1.3.5.3.2-3. + +**Table 5.1.3.5.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|------------------------------------------------------------------------------------| +| AnalyticsSubscriptionsTransfer | M | 1 | Parameters to replace in an Individual NWDAF Event Subscription Transfer resource. | + +**Table 5.1.3.5.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| AnalyticsSubscriptionsTransfer | M | 1 | 200 OK | The Individual NWDAF Event Subscription Transfer resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF Event Subscription Transfer resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Event Subscription Transfer modification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Event Subscription Transfer modification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.1.3.5.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.1.3.5.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.1.3.5.4 Resource Custom Operations + +None in this release of the specification. + +### 5.1.4 Custom Operations without associated resources + +None in this release of the specification. + +### 5.1.5 Notifications + +#### 5.1.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.3.3.4.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|-------------------|---------------------------------|-----------------------------------------| +| Event Notification | {notificationURI} | POST | Reports one or several observed Events. | + +#### 5.1.5.2 Event Notification + +##### 5.1.5.2.1 Description + +The Event Notification is used by the NWDAF to report one or several observed Events to an NF service consumer that has subscribed to such Notifications or used by the target NWDAF to report the successful analytics subscription transfer via the Individual NWDAF Event Subscription Resource. + +##### 5.1.5.2.2 Operation Definition + +Callback URI: {notificationURI} + +The operation shall support the callback URI variables defined in table 5.1.5.2.2-1, the request data structures specified in table 5.1.5.2.2-2 and the response data structure and response codes specified in table 5.1.5.2.2-3. + +**Table 5.1.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationURI | Uri | The Notification Uri as assigned within the Individual NWDAF Event Subscription and described within the NnwdafEventsSubscription type (see table 5.1.6.2.2-1). | + +**Table 5.1.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------| +| array(NnwdafEventsSubscriptionNotification) | M | 1..N | Provides Information about observed Events or the successful analytics subscription transfer. | + +**Table 5.1.5.2.2-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 the 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 the 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 [6] also apply. + +**Table 5.1.5.2.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 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.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 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 Nnwdaf\_EventsSubscription service based interface protocol. + +**Table 5.1.6.1-1: Nnwdaf\_EventsSubscription specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------------------------|-----------------|--------------------------------------------------------------------------------------|--------------------| +| AbnormalBehaviour | 5.1.6.2.15 | Represents the abnormal behaviour information. | AbnormalBehaviour | +| Accuracy | 5.1.6.3.5 | Represents the preferred level of accuracy of the analytics. | | +| AccuracyInfo | 5.1.6.2.89 | The analytics accuracy information. | AnalyticsAccuracy | +| AccuracyReq | 5.1.6.3.88 | Represents the analytics accuracy requirement information. | AnalyticsAccuracy | +| AdditionalMeasurement | 5.1.6.2.26 | Represents additional measurement information. | AbnormalBehaviour | +| AddressList | 5.1.6.2.28 | Represents a list of IPv4 and/or IPv6 addresses. | AbnormalBehaviour | +| AnalyticsContextIdentifier | 5.1.6.2.43 | Contains information about available analytics contexts. | AnaSubTransfer | +| AnalyticsAccuracyIndication | 5.1.6.3.37 | Represents the analytics accuracy indication. | AnalyticsAccuracy | +| AnalyticsFeedbackInfo | 5.1.6.2.105 | Contains analytics feedback information. | AnalyticsAccuracy | +| AnalyticsMetadata | 5.1.6.3.14 | Represents the types of analytics metadata information that can be requested. | Aggregation | +| AnalyticsMetadataIndication | 5.1.6.2.36 | Contains analytics metadata values indicated to be used during analytics generation. | Aggregation | +| AnalyticsMetadataInfo | 5.1.6.2.37 | Contains analytics metadata information required for analytics aggregation. | Aggregation | +| AnalyticsSubscriptionsTransfer | 5.1.6.2.40 | Contains information about a request to transfer analytics subscriptions. | AnaSubTransfer | +| AnalyticsSubset | 5.1.6.3.18 | Analytics subset used to indicate the content of the analytics. | EneNA | +| AnySlice | 5.1.6.3.2 | Represents the any slices. | | +| ApplicationVolume | 5.1.6.2.55 | Application data volume per application Id. | Dispersion | +| AppListForUeComm | 5.1.6.2.64 | Represents the analytics of the application list used by UE. | UeCommunicationExt | +| BwRequirement | 5.1.6.2.25 | Represents bandwidth requirement. | ServiceExperience | +| ClassCriterion | 5.1.6.2.51 | Disperion class criterion. | Dispersion | +| CircumstanceDescription | 5.1.6.2.29 | Contains the description of a circumstance. | AbnormalBehaviour | +| CongestionInfo | 5.1.6.2.18 | Represents the congestion information | UserDataCongestion | +| CongestionType | 5.1.6.3.8 | Identification congestion analytics type. | UserDataCongestion | +| ConsumerNfInformation | 5.1.6.2.49 | Represents the analytics consumer NF Information. | AnaSubTransfer | +| DatasetStatisticalProperty | 5.1.6.3.15 | Dataset statistical properties of the data | Aggregation | + +| | | | | +|--|--|---------------------------------|--| +| | | used to generate the analytics. | | +|--|--|---------------------------------|--| + +| | | | | +|------------------------------|------------|---------------------------------------------------------------------------------------------------|-----------------------------------------| +| DataVolume | 5.1.6.2.85 | Indicates a specific data volume transmitted once from UE to AF and/or from AF to UE | E2eDataVolTransTime | +| DataVolumeTransferTime | 5.1.6.2.90 | Indicates the E2E data volume transfer time and the data volume used to derive the transfer time. | E2eDataVolTransTime | +| DeviceType | 5.1.6.3.31 | The type of device. | QoSustainabilityExt_eNA | +| Direction | 5.1.6.3.39 | Heading directions of the UE flow in the target area. | MovementBehaviour | +| DirectionInfo | 5.1.6.2.75 | Represents the UE direction information. | UeMobilityExt2_eNA
MovementBehaviour | +| DispersionClass | 5.1.6.3.20 | Dispersion class. | Dispersion | +| DispersionCollection | 5.1.6.2.54 | Dispersion collections per UE location or per slice. | Dispersion | +| DispersionCollection | 5.1.6.2.54 | Dispersion collections per UE location or or per slice. | Dispersion | +| DispersionInfo | 5.1.6.2.53 | Dispersion analytics information. | Dispersion | +| DispersionRequirement | 5.1.6.2.50 | Dispersion analytics requirement. | Dispersion | +| DispersionType | 5.1.6.3.19 | Dispersion type. | Dispersion | +| DispersionOrderingCriterion | 5.1.6.3.21 | Ordering criterion for the list of Dispersion. | Dispersion | +| DnPerf | 5.1.6.2.46 | Represents DN performance information. | DnPerformance | +| DnPerfInfo | 5.1.6.2.45 | Represents DN performances for the application. | DnPerformance | +| DnPerfOrderingCriterion | 5.1.6.3.25 | Ordering criterion for the list of DN performance analytics. | DnPerformance | +| DnPerformanceReq | 5.1.6.2.66 | Represents DN performance analytics requirement. | DnPerformance | +| E2eDataVolTransTimeCriterion | 5.1.6.3.35 | Ordering criterion for the list of E2E data volume transfer time. | E2eDataVolTransTime | +| E2eDataVolTransTimeInfo | 5.1.6.2.83 | Represents the E2E data volume transfer time Information. | E2eDataVolTransTime | +| E2eDataVolTransTimeReq | 5.1.6.2.82 | Represents the E2E data volume transfer time requirement. | E2eDataVolTransTime | +| E2eDataVolTransTimePerTS | 5.1.6.2.84 | Represents the E2E data volume transfer time requirement per Time slot. | E2eDataVolTransTime | +| E2eDataVolTransTimePerUe | 5.1.6.2.86 | Represents the E2E data volume transfer time per UE. | E2eDataVolTransTime | +| E2eDataVolTransTimeUeList | 5.1.6.2.87 | Represents the E2E data volume transfer time per UE list. | E2eDataVolTransTime | +| EventNotification | 5.1.6.2.5 | Describes Notifications about events that occurred. | | +| EventReportingRequirement | 5.1.6.2.7 | Represents the type of reporting the subscription requires. | | +| EventSubscription | 5.1.6.2.3 | Represents the subscription to a single event. | | + +| | | | | +|-----------------------|------------|---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Exception | 5.1.6.2.16 | Describes the Exception information. | AbnormalBehaviour | +| ExceptionId | 5.1.6.3.6 | Describes the Exception Id. | AbnormalBehaviour | +| ExceptionTrend | 5.1.6.3.7 | Describes the Exception Trend. | AbnormalBehaviour | +| ExpectedAnalyticsType | 5.1.6.3.11 | Represents expected UE analytics type. | AbnormalBehaviour | +| FailureEventInfo | 5.1.6.2.35 | Contains information on the event for which the subscription is not successful. | | +| GeoDistributionInfo | 5.1.6.2.76 | Represents the geographical distribution of the UEs. | UeMobilityExt_AIML | +| GeoLocation | 5.1.6.2.95 | Represents a geographic location, using either standard or local coordinates and optionally including the altitude. | LocAccuracy | +| IpEthFlowDescription | 5.1.6.2.27 | Contains the description of an Uplink and/or Downlink Ethernet flow. | AbnormalBehaviour | +| LoadLevelInformation | 5.1.6.3.2 | Represents load level information of the network slice and the optionally associated network slice instance. | | +| LocAccuracyInfo | 5.1.6.2.97 | Contains Location Accuracy information. | LocAccuracy | +| LocAccuracyPerMethod | 5.1.6.2.98 | Contains Location Accuracy information per Positioning Method. | LocAccuracy | +| LocAccuracyReq | 5.1.6.2.96 | Contains Location Accuracy analytics requirements. | LocAccuracy | +| LocationInfo | 5.1.6.2.11 | Represents UE location information. | UeMobility | +| LocInfoGranularity | 5.1.6.3.32 | Represents the preferred granularity of location information. | ServiceExperienceExt2_eNA
UeMobilityExt2_eNA
DispersionExt_eNA
MovementBehaviour | +| LocationOrientation | 5.1.6.3.38 | Represents preferred orientation of location information. | MovementBehaviour | +| MatchingDirection | 5.1.6.3.12 | Defines the matching direction when crossing a threshold. | NfLoad, QoSustainability,
UserDataCongestion,
NetworkPerformance
Dispersion
RedundantTransmissionExp
WlanPerformance
ServiceExperienceExt
NsiLoadExt
LocAccuracy | +| MLModelInfo | 5.1.6.2.69 | The information of the ML model. | AnaSubTransfer | +| ModelInfo | 5.1.6.2.42 | Contains information about an ML model. | AnaSubTransfer | +| MovBehav | 5.1.6.2.93 | Represents the Movement Behaviour information per time slot. | MovementBehaviour | +| MovBehavInfo | 5.1.6.2.92 | Represents the Movement Behaviour information. | MovementBehaviour | +| MovBehavReq | 5.1.6.2.91 | Represents the Movement Behaviour | MovementBehaviour | + +| | | | | +|--|--|-------------------------|--| +| | | analytics requirements. | | +|--|--|-------------------------|--| + +| | | | | +|--------------------------------------|------------|------------------------------------------------------------------------------------------------------------|-----------------------------------------------| +| NetworkPerfInfo | 5.1.6.2.23 | Represents the network performance information. | NetworkPerformance | +| NetworkPerfOrderCriterion | 5.1.6.3.30 | The ordering criterion for the list of network performance analytics. | NetworkPerformanceExt_eNA | +| NetworkPerfRequirement | 5.1.6.2.22 | Represents a network performance requirement. | NetworkPerformance | +| NetworkPerfType | 5.1.6.3.10 | Represents the network performance types. | NetworkPerformance | +| NfLoadLevelInformation | 5.1.6.2.31 | Represents load level information of a given NF instance. | NfLoad | +| NfStatus | 5.1.6.2.32 | Provides the percentage of time spent on various NF states. | NfLoad | +| NnwdafEventsSubscription | 5.1.6.2.2 | Represents an Individual NWDAF Event Subscription resource. | | +| NnwdafEventsSubscriptionNotification | 5.1.6.2.4 | Represents an Individual NWDAF Event Subscription Notification resource. | | +| NumberAverage | 5.1.6.2.38 | Represents average and variance information. | NsiLoadExt | +| NwdafEvent | 5.1.6.3.4 | Describes the NWDAF Events. | | +| NwdafFailureCode | 5.1.6.3.13 | Identifies the failure reason. | | +| NotificationMethod | 5.1.6.3.3 | Represents the notification methods that can be subscribed. | | +| NsiIdInfo | 5.1.6.2.33 | Represents the S-NSSAI and the optionally associated Network Slice Instance Identifier(s). | ServiceExperience
NsiLoad
DnPerformance | +| NsiLoadLevelInfo | 5.1.6.2.34 | Represents the load level information for an S-NSSAI and the optionally associated network slice instance. | NsiLoad | +| ObservedRedundantTransExp | 5.1.6.2.70 | Represents the observed Redundant Transmission Experience. | RedundantTransmissionExp | +| OutputStrategy | 5.1.6.3.16 | Represents the output strategy used for the reporting of the analytics. | Aggregation | +| PerfData | 5.1.6.2.47 | Represents DN performance information. | DnPerformance | +| PfdDeterminationInfo | 5.1.6.2.73 | Represents the PFD Determination information. | PfdDetermination | +| PrevSubInfo | 5.1.6.2.68 | Information of the previous subscription. | AnaCtxTransfer | +| QosRequirement | 5.1.6.2.20 | Represents the QoS requirements. | QoSSustainability | +| QosSustainabilityInfo | 5.1.6.2.19 | Represents the QoS Sustainability information. | QoSSustainability | +| RankingCriterion | 5.1.6.2.52 | Ranking criterion. | Dispersion | +| RatFreqInformation | 5.1.6.2.67 | Represents the RAT type and/or Frequency information. | ServiceExperienceExt | +| RedTransExpOrderingCriterion | 5.1.6.3.22 | Ordering criterion for the | RedundantTransmissionExp | + +| | | | | +|--|--|--------------------------------------------------|--| +| | | list of Redundant
Transmission
Experience. | | +|--|--|--------------------------------------------------|--| + +| | | | | +|-------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RedundantTransmissionExpInfo | 5.1.6.2.57 | Redundant transmission experience analytics information. | RedundantTransmissionExp | +| RedundantTransmissionExpPerTS | 5.1.6.2.58 | Redundant Transmission Experience per Time Slot. | RedundantTransmissionExp | +| RedundantTransmissionExpReq | 5.1.6.2.56 | Redundant transmission experience analytics requirement. | RedundantTransmissionExp | +| RelProxInfo | 5.1.6.2.100 | Relative Proximity analytics information. | RelativeProximity | +| RelProxReq | 5.1.6.2.99 | Relative Proximity analytics requirements. | RelativeProximity | +| ResourceUsage | 5.1.6.2.48 | The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance. | NsiLoadExt | +| ResourceUsageRequirement | 5.1.6.2.81 | Indicates more requirements when providing resource usage information for network performance. | NetworkPerformanceExt_AIML | +| RetainabilityThreshold | 5.1.6.2.21 | Represents a QoS flow retainability threshold. | QoSSustainability | +| RoamingInfo | 5.1.6.2.106 | Contains information related to roaming analytics. | RoamingAnalytics | +| PduSessionInfo | 5.1.6.2.74 | Represents combination of PDU Session parameters. | ServiceExperienceExt2_eNA | +| ServiceExperienceInfo | 5.1.6.2.24 | Represents the service experience information. | ServiceExperience | +| ServiceExperienceType | 5.1.6.3.24 | Represents the type of Service Experience Analytics. | ServiceExperienceExt | +| SessInactTimerForUeComm | 5.1.6.2.65 | Represents the N4 Session inactivity timer. | UeCommunicationExt | +| SliceLoadLevelInformation | 5.1.6.2.6 | Represents the slices and their load level information. | | +| SpeedThresholdInfo | 5.1.6.2.94 | UEs information whose speed is faster than the speed threshold. | MovementBehaviour | +| SubscriptionTransferInfo | 5.1.6.2.41 | Contains information about subscriptions that are requested to be transferred. | AnaSubTransfer | +| TargetUeInformation | 5.1.6.2.8 | Identifies the target UE information. | ServiceExperience
NfLoad
NetworkPerformance
UserDataCongestion
UeMobility
UeCommunication
AbnormalBehaviour
QoSSustainability
Dispersion
RedundantTransmissionExp
WlanPerformance
DnPerformance
PduSesTraffic
E2eDataVolTransTime | +| TdTraffic | 5.1.6.2.78 | Represents traffic that matches or unmatches Traffic Descriptor over | PduSesTraffic | + +| | | | | +|--|--|---------------------------------|--| +| | | the established PDU Session(s). | | +|--|--|---------------------------------|--| + +| | | | | +|------------------------------|-------------|---------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| +| TermCause | 5.1.6.3.26 | Represents a cause for requesting to terminate an analytics subscription. | TermRequest | +| ThresholdLevel | 5.1.6.2.30 | Describes a threshold level. | UserDataCongestion
NfLoad
DnPerformance
ServiceExperienceExt
MovementBehaviour | +| TimestampedLocation | 5.1.6.2.103 | The timestamped locations of the trajectory of the UE. | RelativeProximity | +| TimeToCollisionInfo | 5.1.6.2.104 | Time To Collision (TTC) information. | RelativeProximity | +| TimeUnit | 5.1.6.3.9 | Represents the unit for the session active time. | QoSSustainability | +| TopApplication | 5.1.6.2.39 | Top application that contributes the most to the traffic. | UserDataCongestionExt | +| TrafficCharacterization | 5.1.6.2.14 | Identifies the detailed traffic characterization. | UeCommunication | +| TrafficDirection | 5.1.6.3.33 | The traffic direction for the resource usage information. | NetworkPerformanceExt_AIML | +| TrafficInformation | 5.1.6.2.63 | Traffic information including UL/DL data rate and/or Traffic volume. | WlanPerformance | +| TransferRequestType | 5.1.6.3.17 | Represents the type of a request for analytics subscription transfer. | AnaSubTransfer | +| UeAnalyticsContextDescriptor | 5.1.6.2.44 | Contains information about available UE related analytics contexts. | AnaSubTransfer | +| UeCommunication | 5.1.6.2.13 | Represents UE communication information. | UeCommunication | +| UeCommOrderCriterion | 5.1.6.3.29 | The ordering criterion for the list of UE communication analytics. | UeCommunicationExt_eNA | +| UeCommReq | 5.1.6.2.72 | UE communication analytics requirement. | UeCommunicationExt_eNA | +| UeMobilityOrderCriterion | 5.1.6.3.28 | The ordering criterion for the list of UE mobility analytics. | UeMobilityExt2_eNA | +| UeMobilityReq | 5.1.6.2.71 | UE mobility analytics requirement. | UeMobilityExt2_eNA | +| UeMobility | 5.1.6.2.10 | Represents UE mobility information. | UeMobility | +| UeProximity | 5.1.6.2.101 | Observed or Predicted proximity information. | RelativeProximity | +| UeTrajectory | 5.1.6.2.102 | Relative timestamped UE positions. | RelativeProximity | +| PduSesTrafficInfo | 5.1.6.2.77 | Represents PDU Session traffic analytics information. | PduSesTraffic | +| PduSesTrafficReq | 5.1.6.2.79 | Represents PDU Session traffic analytics requirement. | PduSesTraffic | +| UserDataConOrderCrit | 5.1.6.3.27 | The ordering criterion for the list of User Data Congestion analytics. | UserDataCongestionExt2_eNA | +| UserDataCongestionInfo | 5.1.6.2.17 | Represents the user data congestion information. | UserDataCongestion | + +| | | | | +|----------------------------|------------|------------------------------------------------------------------------------------------------|----------------------------| +| ValueExpression | 5.1.6.3.34 | Indicates average or peak value of the resource usage for the network performance type | NetworkPerformanceExt_AIML | +| WlanOrderingCriterion | 5.1.6.3.23 | Ordering criterion for the list of WLAN performance information. | WlanPerformance | +| WlanPerformanceReq | 5.1.6.2.59 | WLAN performance analytics requirement. | WlanPerformance | +| WlanPerformanceInfo | 5.1.6.2.60 | WLAN performance analytics information. | WlanPerformance | +| WlanPerSsIdPerformanceInfo | 5.1.6.2.61 | WLAN performance information per SSID of WLAN access points deployed in the Area of Interest. | WlanPerformance | +| WlanPerTsPerformanceInfo | 5.1.6.2.62 | WLAN performance information per Time Slot during the analytics target period. | WlanPerformance | +| WlanPerUeIdPerformanceInfo | 5.1.6.2.80 | WLAN performance information per UE ID of WLAN access points deployed in the Area of Interest. | WlanPerformanceExt_AIML | + +Table 5.1.6.1-2 specifies data types re-used by the Nnwdaf\_EventsSubscription 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 Nnwdaf service based interface. + +**Table 5.1.6.1-2: Nnwdaf\_EventsSubscription re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5Qi | 3GPP TS 29.571 [8] | Identifies the 5G QoS identifier | QoSSustainability
E2eDataVolTransTime | +| AccessType | 3GPP TS 29.571 [8] | Identifies the access type. | ServiceExperienceExt2_eNA | +| AddrFqdn | 3GPP TS 29.517 [22] | Represents the IP address or FQDN of the Application Server. | DnPerformance
ServiceExperienceExt | +| ApplicationId | 3GPP TS 29.571 [8] | Identifies the application identifier. | ServiceExperience
UeCommunication
AbnormalBehaviour
Dispersion
DnPerformance
PduSesTraffic | +| ArfcnValueNR | 3GPP TS 29.571 [8] | Integer value indicating the ARFCN applicable for a downlink, uplink or bi-directional (TDD) NR global frequency raster.

Minimum = 0. Maximum = 3279165. | ServiceExperienceExt | +| BitRate | 3GPP TS 29.571 [8] | String representing a bit rate that shall be formatted as follows:

pattern: "^\\d+(\\.\\d+)? (bps Kbps Mbps Gbps Tbps)\$"
Examples:
"125 Mbps", "0.125 Gbps", "125000 Kbps". | ServiceExperience
QoSSustainability
WlanPerformance
DnPerformance
E2eDataVolTransTime | +| DateTime | 3GPP TS 29.571 [8] | Identifies the time. | | +| Dnai | 3GPP TS 29.571 [8] | Identifies a user plane access to one or more DN(s). | ServiceExperience
DnPerformance | +| Dnn | 3GPP TS 29.571 [8] | Identifies the DNN. | ServiceExperience
AbnormalBehaviour
UeCommunication
DnPerformance
SMCCE
PduSesTraffic
E2eDataVolTransTime | +| DomainNameProtocol | 3GPP TS 29.122 [19] | Indicates the additional protocol and protocol field for domain names to be matched. | PfdDetermination | +| DurationSec | 3GPP TS 29.571 [8] | | | +| EthFlowDescription | 3GPP TS 29.514 [21] | | UeCommunication
AbnormalBehaviour | +| ExpectedUeBehaviourData | 3GPP TS 29.503 [23] | | AbnormalBehaviour | +| Float | 3GPP TS 29.571 [8] | | | +| FlowDescription | 3GPP TS 29.514 [21] | | UeCommunication
AbnormalBehaviour
PduSesTraffic | +| FlowInfo | 3GPP TS 29.122 [19] | | UserDataCongestionExt | +| GeographicalArea | 3GPP TS 29.522 [32] | Identifies the geographical location (longitude and latitude level). | UeMobilityExt2_eNA
ServiceExperienceExt2_eNA
QoSSustainabilityExt_eNA
MovementBehaviour | +| Gpsi | 3GPP TS 29.571 [8] | The GPSI for an UE. | UserDataCongestionExt
UeMobilityExt_AIML | +| GroupId | 3GPP TS 29.571 [8] | Identifies a group of UEs. | UeMobility
UeCommunication
NetworkPerformance
AbnormalBehaviour
ServiceExperience
Dispersion
RedundantTransmissionExp
WlanPerformance
PduSesTraffic | + +| | | | | +|----------------------------|---------------------|-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Ipv4Addr | 3GPP TS 29.571 [8] | | | +| Ipv6Addr | 3GPP TS 29.571 [8] | | | +| LocalOrigin | 3GPP TS 29.572 [30] | Represents a reference point for modelling locations in relation to it. | LocAccuracy | +| NetworkAreaInfo | 3GPP TS 29.554 [18] | Identifies the network area. | ServiceExperience
QoSSustainability
AbnormalBehaviour
UeMobility
UserDataCongestion
NetworkPerformance
NsiLoadExt
NfLoadExt
Dispersion
RedundantTransmissionExp
WlanPerformance
UeCommunication
DnPerformance
PduSesTraffic
E2eDataVolTransTime
MovementBehaviour | +| NfInstanceId | 3GPP TS 29.571 [8] | Identifies an NF instance. | NfLoad | +| NfSetId | 3GPP TS 29.571 [8] | Identifies an NF Set instance. | NfLoad | +| NFType | 3GPP TS 29.510 [12] | Identifies a type of NF. | NfLoad | +| NsiId | 3GPP TS 29.531 [24] | Identifies a Network Slice Instance. | ServiceExperience
NsiLoad
DnPerformance | +| PacketDelBudget | 3GPP TS 29.571 [8] | | QoSSustainability
DnPerformance
RedundantTransExpExt_eNA | +| PacketErrRate | 3GPP TS 29.571 [8] | | QoSSustainability | +| PacketLossRate | 3GPP TS 29.517 [22] | Indicates Packet Loss Rate. | DnPerformance
RedundantTransExpExt_eNA | +| PduSessionId | 3GPP TS 29.571 [8] | Identifies PDU Session | | +| PduSessionType | 3GPP TS 29.571 [8] | Identifies the PDU Session Type. | ServiceExperienceExt2_eNA | +| PlmnIdNid | 3GPP TS 29.571 [8] | PLMN identifier. | RoamingAnalytics | +| Point | 3GPP TS 29.572 [30] | Represents a location in geographical co-ordinates. | LocAccuracy | +| PointAltitude | 3GPP TS 29.572 [30] | Represents a location including an altitude in geographical co-ordinates. | LocAccuracy | +| PositioningMethod | 3GPP TS 29.572 [30] | Represents a positioning method. | LocAccuracy | +| ProblemDetails | 3GPP TS 29.571 [8] | Used in error responses to provide more detailed information about an error. | | +| QosResourceType | 3GPP TS 29.571 [8] | Identifies the resource type in QoS characteristics. | QoSSustainability | +| RatType | 3GPP TS 29.571 [8] | Identifies the RAT type. | ServiceExperienceExt | +| RedirectResponse | 3GPP TS 29.571 [8] | Contains redirection related information. | ES3XX | +| RelativeCartesianLocation | 3GPP TS 29.572 [30] | Represents distances from a reference point. | LocAccuracy | +| ReportingInformation | 3GPP TS 29.523 [20] | Represents the type of reporting the subscription requires. | | +| SamplingRatio | 3GPP TS 29.571 [8] | | | +| ScheduledCommunicationTime | 3GPP TS 29.122 [19] | | UeMobility
UeCommunication | +| SmcceInfo | 5.2.6.2.12 | Represents the analytics of Session Management Congestion Control Experience information. | SMCCE | +| Snssai | 3GPP TS 29.571 [8] | Identifies the S-NSSAI (Single Network Slice Selection | | + +| | | | | +|-------------------|---------------------|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Assistance Information). | | +| SscMode | 3GPP TS 29.571 [8] | Identifies the SSC Mode of the PDU Session. | ServiceExperienceExt2_eNA | +| Supi | 3GPP TS 29.571 [8] | The SUPI for an UE. | ServiceExperience,
NflLoad
NetworkPerformance,
UserDataCongestion
UeMobility
UeCommunication
AbnormalBehaviour
Dispersion
RedundantTransmissionExp
WlanPerformance
PduSesTraffic | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of the optional features defined in table 5.1.8-1. | | +| SvcExperience | 3GPP TS 29.517 [22] | | ServiceExperience | +| Tai | 3GPP TS 29.571 [8] | Tracking Area Information. | AnaSubTransfer | +| TimeWindow | 3GPP TS 29.122 [19] | | | +| Uinteger | 3GPP TS 29.571 [8] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. | | +| UpfInformation | 3GPP TS 29.508 [29] | The information of the UPF serving the UE. | ServiceExperienceExt
DnPerformance | +| Uri | 3GPP TS 29.571 [8] | | | +| UserLocation | 3GPP TS 29.571 [8] | | UeMobility
Dispersion | +| VelocityEstimate | 3GPP TS 29.572 [30] | Velocity estimate | QoSSustainabilityExt_eNA | +| Volume | 3GPP TS 29.122 [19] | | UeCommunication
AbnormalBehaviour
Dispersion
WlanPerformance
PduSesTraffic | + +## 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 NnwdafEventsSubscription + +**Table 5.1.6.2.2-1: Definition of type NnwdafEventsSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| eventSubscriptions | array(EventSubscription) | M | 1..N | Subscribed events. | | +| evtReq | ReportingInformation | O | 0..1 | Represents the reporting requirements of the event subscription. (NOTE 1, NOTE 2, NOTE 4)
If omitted, the default values within the ReportingInformation data type apply. | | +| notificationURI | Uri | C | 0..1 | Identifies the recipient of Notifications sent by the NWDAF.
This parameter shall be supplied by the NF service consumer in the HTTP POST requests that create the subscriptions for event notifications and in the HTTP PUT requests that update the subscriptions for event notifications. | | +| notifCorrId | string | O | 0..1 | Notification correlation identifier. | EneNA | +| eventNotifications | array(EventNotification) | C | 1..N | Notifications about Individual Events.
Shall only be present if the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute sets to true in the event subscription, and the reports are available. | | +| failEventReports | array(FailureEventInfo) | O | 1..N | Supplied by the NWDAF. When available, shall contain the event(s) for which the subscription is not successful including the failure reason(s). | | +| consNfInfo | ConsumerNfInformation | O | 0..1 | Represents the analytics consumer NF Information. | AnaSubTransfer | +| prevSub | PrevSubInfo | O | 0..1 | Contains information about the previous analytics subscription that the NF service consumer had with the source NWDAF. (NOTE 3) | AnaCtxTransfer | +| supportedFeatures | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.1.8.
This parameter shall be supplied by NF service consumer in the POST request that request the creation of an NWDAF Event Subscriptions resource, and shall be supplied | | + +| | | | | | | +|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|-----------------------------------------------------|--| +| | | | | by the NWDAF in the reply of corresponding request. | | +| NOTE 1: | If the "evtReq" attribute (of data type ReportingInformation) is provided and contains the "notifMethod" attribute, the notification method indicated by the "notifMethod" attribute within the ReportingInformation data type takes preference over the notification method indicated by the "notificationMethod" attribute within the EventSubscription data type.
NOTE 2: If the "evtReq" attribute (of data type ReportingInformation) is provided and contains the "repPeriod" attribute, the periodic reporting time indicated by the "repPeriod" attribute in the ReportingInformation data type takes preference over the periodic reporting time indicated by the "repetitionPeriod" attribute in the EventSubscription data type.
NOTE 3: The "prevSub" attribute may be used by the NWDAF to derive analytics context identifier(s), which may be used in the Nnwdaf_AnalyticsInfo_ContextTransfer service operation invoked by the NWDAF.
NOTE 4: Void. | | | | | + +### 5.1.6.2.3 Type EventSubscription + +**Table 5.1.6.2.3-1: Definition of type EventSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| anySlice | AnySlice | C | 0..1 | Default is "false". (NOTE 1) | | +| appIds | array(ApplicationId) | C | 1..N | Represents the Application Identifier(s) to which the subscription applies.
The absence of appIds means subscription to all applications. (NOTE 8) (NOTE 15) (NOTE 16) | ServiceExperience
UeCommunication
AbnormalBehaviour
Dispersion
DnPerformance
PfdDetermination
E2eDataVolTransTime | +| deviations | array(Uinteger) | O | 1..N | Each element indicates an acceptable deviation from the threshold level included in "ranUeThrouThds" attribute or "qosFlowRetThds" attribute.
This attribute may only be present if either the "ranUeThrouThds" attribute or "qosFlowRetThds" attribute is provided. | EnQoSustainability | +| dnns | array(Dnn) | C | 1..N | Represents the DNN(s) to which the subscription applies. Each DNN is a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.
The absence of dnns means subscription to all DNNs. (NOTE 8) (NOTE 17) | ServiceExperience,
AbnormalBehaviour
UeCommunication
RedundantTransmissionExp
DnPerformance
SMCCE
PfdDetermination
PduSesTraffic
E2eDataVolTransTime
RelativeProximity | +| dnais | array(Dnai) | O | 1..N | Represents the Data Network Access Identifier(s) of user plane access to DN(s) which the subscription applies. | ServiceExperience
DnPerformance
E2eDataVolTransTime | +| dataVITrnsTmRqs | array(E2eDataVolTransTimeReq) | O | 1..N | Represents the E2E data volume transfer time requirements | E2eDataVolTransTime | +| event | Nwdafevent | M | 1 | Event that is subscribed. | | +| extraReportReq | EventReportingRequirement | O | 0..1 | The extra event reporting requirement information. | | +| ladnDnns | array(Dnn) | O | 1..N | LADN DNN(s) to indicate the LADN service area(s) as the AoI(s). | UeMobilityExt | +| loadLevelThreshold | integer | C | 0..1 | Indicates that the NWDAF shall report the corresponding network slice load level to the NF service consumer where the load level of the network slice identified by snssais is reached. (NOTE 4)

May be included when subscribed event is "SLICE_LOAD_LEVEL".
Minimum = 0. Maximum = 100. | | + +| | | | | | | +|-----------------------|-----------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| matchingDir | MatchingDirection | O | 0..1 | A matching direction may be provided alongside a threshold. If omitted, the default value is CROSSED. | NfLoad,
QoSustainability,
UserDataCongestion,
NetworkPerformance,
NsiLoadExt | +| nfLoadLvlThds | array(ThresholdLevel) | C | 1..N | Shall be supplied in order to start reporting when an average load level is reached. (NOTE 4) | NfLoad | +| networkArea | NetworkAreaInfo | C | 0..1 | Identification of network area to which the subscription applies. The absence of "networkArea" and "fineGranAreas" means subscription to all network areas. (NOTE 7, NOTE 8, NOTE 20 , NOTE 22) | ServiceExperience
UeMobility
UeCommunication
QoSustainability
AbnormalBehaviour
UserDataCongestion
NetworkPerformance
NsiLoadExt
NfLoadExt
Dispersion
RedundantTransmissionExp
WlanPerformance
DnPerformance
PduSesTraffic
E2eDataVolTransTime
MovementBehaviour
LocAccuracy
RelativeProximity | +| location | GeoLocation | C | 0..1 | A location (i.e. geographical location or location in local coordinates) to which the subscription applies. (NOTE 22) | LocAccuracy | +| temporalGranSize | DurationSec | O | 0..1 | Indicates the minimum duration of each time slot for which the analytics are provided. (NOTE 18) | NetworkPerformanceExt_eNA
UeMobilityExt2_eNA
UserDataCongestionExt2_eNA
QoSustainabilityExt_eNA
DispersionExt_eNA
WlanPerfExt_eNA
RedundantTransExpExt_eNA
DnPerformanceExt_eNA | +| spatialGranSizeT
a | Uinteger | O | 0..1 | Indicates the maximum number of TAs used to define an area for which the analytics are provided. May be included when the "networkArea" attribute in the EventSubscription data type is provided. | NetworkPerformanceExt_eNA
UeMobilityExt2_eNA
UeCommunicationExt_eNA
QoSustainabilityExt_eNA | + +| | | | | | | +|--|--|--|--|-----------|---------------------------------------------------| +| | | | | (NOTE 19) | DispersionExt_e
NA
DnPerformance
Ext_eNA | +|--|--|--|--|-----------|---------------------------------------------------| + +| | | | | | | +|---------------------|-------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| spatialGranSizeCell | UInteger | O | 0..1 | Indicates the maximum number of cells used to define an area for which the analytics are provided.
May be included when the "networkArea" attribute in the EventSubscription data type is provided.
(NOTE 19) | NetworkPerformanceExt_eNA
UeMobilityExt2_eNA
UeCommunicationExt_eNA
QoSustainabilityExt_eNA
DispersionExt_eNA
DnPerformanceExt_eNA | +| fineGranAreas | array(GeographicalArea) | O | 1..N | Indicates the fine granularity areas to which the subscription applies. (i.e. with a finer granularity than cell).
(NOTE 7, NOTE 20) | ServiceExperienceExt2_eNA
UeMobilityExt2_eNA
QoSustainabilityExt_eNA | +| visitedAreas | array(NetworkAreaInfo) | O | 1..N | Indicates the visited network area(s) which the UEs had previously been in at least one of the Visited Area(s) of Interest.
(NOTE 10) | UeMobilityExt | +| maxTopAppUINbr | UInteger | O | 0..1 | Indicates the requested maximum number of top applications that contribute the most to the traffic in Uplink direction. Minimum = 1.
May be included when one of the elements in the "listOfAnaSubsets" attribute is set to LIST_OF_TOP_APP_UL. | UserDataCongestionExt | +| maxTopAppDINbr | UInteger | O | 0..1 | Indicates the requested maximum number of top applications that contribute the most to the traffic in Downlink direction. Minimum = 1.
May be included when one of the elements in the "listOfAnaSubsets" attribute is set to LIST_OF_TOP_APP_DL. | UserDataCongestionExt | +| nfInstanceIds | array(NfInstanceId) | O | 1..N | Identification(s) of NF instance(s). | NfLoad | +| nfSetIds | array(NfSetId) | O | 1..N | Identification(s) of NF instance set(s). | NfLoad | +| nfTypes | array(NFType) | O | 1..N | Identification(s) of NF type(s).
(NOTE 13) | NfLoad
NsiLoadExt | +| notificationMethod | NotificationMethod | O | 0..1 | Indicate the notification method.
(NOTE 2) | | +| nsiIdInfos | array(NsiIdInfo) | O | 1..N | Each element identifies the S-NSSAI and the optionally associated network slice instance(s).
May be included when subscribed event is "NSI_LOAD_LEVEL", "SERVICE_EXPERIENCE" or "DN_PERFORMANCE".
(NOTE 1) | ServiceExperience
NsiLoad
DnPerformance | +| nsiLevelThrds | array(UInteger) | O | 1..N | Identifies the load threshold for each S-NSSAI or S-NSSAI and the optionally associated network slice instance identified by the "nsiIds" attribute within the "nsiIdInfos" attribute.
(NOTE 4)
Minimum = 0. Maximum = 100. | NsiLoad | +| qosRequ | QosRequirement | C | 0..1 | Indicates the QoS requirements. | QoSustainability | + +| | | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------------------|---------------------------| +| | | | | It shall be included when subscribed event is "QOS_SUSTAINABILITY" or "E2E_DATA_VOL_TRANS_TIME". | ty
E2eDataVolTransTime | +|--|--|--|--|--------------------------------------------------------------------------------------------------|---------------------------| + +| | | | | | | +|------------------|------------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| qosFlowRetThds | array(RetainabilityThreshold) | C | 1..N | Represents the QoS flow retainability thresholds. Shall be supplied for the 5QI ("5qi" in "qosRequ") or resource type ("resType" in "qosRequ") of GBR resource type. (NOTE 4) | QoSSustainability
E2eDataVolTransTime | +| ranUeThrouThds | array(BitRate) | C | 1..N | Represents the RAN UE throughput thresholds. Shall be supplied for the 5QI ("5qi" in "qosRequ") or resource type ("resType" in "qosRequ") of non-GBR resource type. (NOTE 4) | QoSSustainability | +| repetitionPeriod | DurationSec | C | 0..1 | Shall be supplied for notification method "PERIODIC" by the "notificationMethod" attribute. | | +| snssais | array(Snssai) | C | 1..N | Identification(s) of network slice(s) to which the subscription applies. (NOTE 1, NOTE 8) (NOTE 17) | | +| tgtUe | TargetUeInformation | O | 0..1 | Identifies target UE information. (NOTE 3) | | +| roamingInfo | RoamingInfo | O | 0..1 | Information about roaming analytics. When this attribute is provided, the request should contain only attributes that are applicable also in the Nnwdaf_RoamingAnalytics service. | RoamingAnalytics | +| congThresholds | array(ThresholdLevel) | C | 1..N | Represents the congestion threshold levels. (NOTE 4) | UserDataCongestion | +| nwPerfReqs | array(NetworkPerfRequirement) | C | 1..N | Represents the network performance requirements. This attribute shall be included when subscribed event is "NETWORK_PERFORMANCE". | NetworkPerformance | +| bwReqs | array(BwRequirement) | O | 1..N | Represents the bandwidth requirement for each application. It may only be present if "appIds" attribute is provided. | ServiceExperience | +| excepReqs | array(Exception) | C | 1..N | Represents a list of ExceptionIds with associated thresholds. May only be present when subscribed event is "ABNORMAL_BEHAVIOUR". (NOTE 5, NOTE 6, NOTE 8) | AbnormalBehaviour | +| exptAnaType | ExpectedAnalyticsType | C | 0..1 | Represents expected UE analytics type. It shall not be present if the "excepReqs" attribute is provided. (NOTE 6, NOTE 8) | AbnormalBehaviour | +| exptUeBehav | ExpectedUeBehaviourData | O | 0..1 | Represents expected UE behaviour. | AbnormalBehaviour | +| ratFreqs | array(RatFreqInformation) | O | 1..N | Identification(s) of the RAT type(s) and/or frequency(ies) of UE's serving cell(s) which the subscription applies. (NOTE 9) | ServiceExperienceExt | +| listOfAnaSubsets | array(AnalyticsSubset) | O | 1..N | The list of analytics subsets can be used to indicate the content of the analytics. | EneNA | +| disperReqs | array(DispersionRequirement) | O | 1..N | Represents the dispersion analytics requirements. | Dispersion | +| redTransReqs | array(RedundantTransmissionExpReq) | O | 1..N | Represents the redundant transmission experience | RedundantTransmissionExp | + +| | | | | | | +|--|--|--|--|-------------------------|--| +| | | | | analytics requirements. | | +|--|--|--|--|-------------------------|--| + +| | | | | | | +|---------------------|---------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| +| wlanReqs | array(WlanPerformanceReq) | O | 1..N | Represents other WLAN performance analytics requirements. If the attribute contains no content, may take default handling action. | WlanPerformance | +| ueCommReqs | array(UeCommReq) | O | 1..N | Represents the UE communication requirements. This attribute may be included when the subscribed event is "UE_COMM". | UeCommunicationExt_eNA | +| ueMobilityReqs | array(UeMobilityReq) | O | 1..N | Represents the UE mobility requirements. This attribute may be included when the subscribed event is "UE_MOBILITY". | UeMobilityExt2_eNA | +| upfInfo | UpfInformation | O | 0..1 | Identifies the UPF. (NOTE 12) | ServiceExperienceExtDnPerformance | +| userDataConOrderCri | UserDataConOrderCrit | O | 0..1 | The ordering criterion for the list of User Data Congestion analytics. (NOTE 14) | userDataConOrderCri | +| appServerAddrs | array(AddrFqdn) | C | 1..N | Each element represents the Application Server Instance (IP address/FQDN of the Application Server). (NOTE 11) | ServiceExperienceExtDnPerformance | +| dnPerfReqs | array(DnPerformanceReq) | O | 1..N | Represents the DN performance analytics requirements. | DnPerformance | +| pduSesInfos | array(PduSessionInfo) | C | 1..N | Represents combination of PDU Session parameter(s). (NOTE 15) | ServiceExperienceExt2_eNA | +| useCaseCxt | string | O | 0..1 | Indicates the context of usage of the analytics. The value and format of this parameter are not standardized. | ENAExt | +| pduSesTrafReqs | array(PduSesTrafficReq) | C | 1..N | Represents the PDU Session traffic analytics requirements. This attribute shall be included when subscribed event is "PDU_SESSION_TRAFFIC". | PduSesTraffic | +| locAccReqs | array(LocAccuracyReq) | O | 1..N | Represents the Location Accuracy analytics requirements. This attribute may only be included when the subscribed event is "LOC_ACCURACY". | LocAccuracy | +| locGranularity | LocInfoGranularity | O | 0..1 | The preferred granularity of UE location information. (NOTE 21) | ServiceExperienceExt2_eNA
UeMobilityExt2_eNA
DispersionExt_eNA
MovementBehaviour | +| locOrientation | LocationOrientation | O | 0..1 | Indicates the preferred orientation of location information. | MovementBehaviour
UeMobilityExt2_eNA | +| accuReq | AccuracyReq | O | 0..1 | Represents the analytics accuracy requirement information. May be included as indication to the NWDAF (containing an AnLF supporting Accuracy checking capability) to activate checking the analytics accuracy information of the event. | AnalyticsAccuracy | + +| | | | | | | +|--------------|-----------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| movBehavReqs | array(MovBehavReq) | O | 1..N | Represents the Movement Behaviour analytics requirements. | MovementBehaviour | +| relProxReqs | array(RelProxReq) | O | 1..N | Represents the Relative Proximity analytics requirements. | RelativeProximity | +| pauseFlg | boolean | O | 0..1 | Pause analytics consumption flag applicable on analytics ID level. Set to "true" to indicate the NWDAF to stop including analytics of this event type in its notifications (without cancelling the subscription), because the accuracy level needs to be increased.
Default value is "false" if omitted.

This attribute may be present in a update request message if the "pauseInd" attribute was provided in the notification. | AnalyticsAccuracy | +| resumeFlg | boolean | O | 0..1 | Resume analytics consumption flag applicable on analytics ID level. Set to "true" to indicate the NWDAF to resume sending the notifications of analytics because the accuracy has been improved.
Default value is "false" if omitted.

This attribute may be present in a update request message if the "resumeInd" attribute was provided in the notification. | AnalyticsAccuracy | +| feedback | AnalyticsFeedbackInfo | O | 0..1 | Analytics feedback information. It may only be provided in requests to update an existing analytics subscription for predictions. | AnalyticsAccuracy | + +NOTE 1: The "anySlice" attribute is not applicable to features "UeMobility" and "NetworkPerformance". The "snssais" attribute is not applicable to features "ServiceExperience", "NsiLoad", "UeMobility" and "NetworkPerformance". When subscribed event is "SLICE\_LOAD\_LEVEL", the identifications of network slices, either information about slice(s) identified by "snssais", or "anySlice" set to "true" shall be included. When subscribed event is "QOS\_SUSTAINABILITY", "NF\_LOAD", "UE\_COMM", "ABNORMAL\_BEHAVIOUR", "USER\_DATA\_CONGESTION", "DISPERSION", "RED\_TRANS\_EXP", "PDU\_SESSION\_TRAFFIC", "PFD\_DETERMINATION" or "RELATIVE\_PROXIMITY", the identifications of network slices identified by "snssais" is optional. When subscribed event is "NSI\_LOAD\_LEVEL", "SERVICE\_EXPERIENCE" or "DN\_PERFORMANCE", either the "nsidInfos" attribute or "anySlice" set to "true" shall be included. + +NOTE 2: When notificationMethod is not supplied, the default value is "THRESHOLD". + +NOTE 3: Applicability is further described in the corresponding data type. All target UE(s) indicated by this attribute shall belong to the same PLMN. When the RoamingAnalytics feature is supported and the target UE(s) indicated by this attribute belong to a PLMN different than the PLMN of the NF service consumer, the request should contain only attributes that are applicable also in the Nnwdaf\_RoamingAnalytics service. + +NOTE 4: This property shall be provided if the "notifMethod" in "evtReq" is set to "ON\_EVENT\_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted. + +NOTE 5: Only "excepId" and "excepLevel" within the Exception data type apply to the "excepReqs" attribute within EventSubscription data type. + +NOTE 6: Either "excepReqs" or "exptAnaType" shall be provided if subscribed event is "ABNORMAL\_BEHAVIOUR". + +NOTE 7: For different events, the following rules apply: + +- For "NETWORK\_PERFORMANCE", "USER\_DATA\_CONGESTION" or "DN\_PERFORMANCE" event, the "networkArea" attribute shall be provided if the event applied for all UEs (i.e. "anyUe" attribute set to true within the "tgtUe" attribute). +- For "QOS\_SUSTAINABILITY", at least one of "networkArea" and "fineGranAreas" attributes shall + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|

be provided.

  • - For "E2E_DATA_VOL_TRANS_TIME" event, this attribute shall be provided if the event applied for single UE or group of UEs.
  • - For "SERVICE_EXPERIENCE" event, if the event applied for all UEs (i.e. "anyUe" attribute set to true within the "tgtUe" attribute): at least one of "networkArea" or "fineGranAreas" attributes shall be provided.
  • - For "MOVEMENT_BEHAVIOUR" event, at least one of "networkArea" or "fineGranAreas" attributes shall be provided.

NOTE 8: For "ABNORMAL_BEHAVIOUR" event with "anyUe" attribute in "tgtUe" attribute sets to true,

  • - at least one of the "networkArea" and the "snssais" attribute should be included, if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via the "excepRequs" attribute is mobility related;
  • - at least one of the "networkArea", "applds", "dnns" and "snssais" attribute should be included, if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via the "excepRequs" attribute is communication related;
  • - the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepRequs" attribute shall not be requested for both mobility and communication related analytics at the same time.

NOTE 9: If both the "allFreq" attribute and the "allRat" attribute are present within the RatFreqInformation data type, then only one instance of the RatFreqInformation data type shall be present to indicate for all the RAT type and all the Frequency values the NWDAF has received for the application.

NOTE 10: If this attribute is provided, the analytics target period shall be a past time period (i.e. only statistics is supported).

NOTE 11: For service experience analytics, this parameter shall be provided when a consumer requires analytics for an edge application over a UP path.

NOTE 12: For service experience analytics, this parameter may be provided when a consumer requires analytics for an edge application over a UP path, and it is only needed when the target of the service experience analytics is a specific UPF included in this UP path.

NOTE 13: When subscribed event is "NSI_LOAD_LEVEL" and the NsiLoadExt feature is supported, and the NF service consumer provides the "nftypes" attribute, then the NWDAF accounts only for the resource usage of the NF types included in "nftypes" to derive the output analytics. If the "nftypes" attribute is not provided, then NWDAF accounts for the resource usage of all NF types.

NOTE 14: If the value of "userDataConOrderCri" attribute is "APPLICABLE_TIME_WINDOW", the "ASCENDING" direction indicates that the list of User Data Congestion analytics are in chronological order and the "DESCENDING" direction indicates that the list of User Data Congestion analytics are in reverse chronological order.

NOTE 15: When the "pduSesInfos" attribute is provided, the associated "applds" attribute shall also be provided for the NWDAF to be able to compute the service experience per application.

NOTE 16: When subscribed event is "PFD_DETERMINATION" and the PfdDetermination feature is supported, the "applds" attribute shall be included.

NOTE 17: When the subscribed event is "PDU_SESSION_TRAFFIC" and the PduSesTraffic feature is supported, at least one of the "dnns" and/or "snssais" attributes as the route selection descriptor(s) for the URSP rule shall be included.

NOTE 18: When this attribute is provided, the NWDAF shall provide the analytics per elementary time slot accordingly.

NOTE 19: When this attribute is provided, the NWDAF shall provide the analytics per group of TAs or cells accordingly.

NOTE 20: If both "networkArea" and "fineGranAreas" attributes are provided, the Area of Interest is interpreted as the intersection area indicated by these two attributes.

NOTE 21: The "LON_AND_LAT_LEVEL" value of "locGranularity" attribute is not applicable to features "DispersionExt_eNA". The "TA_LEVEL" or "CELL_LEVEL" value of "locGranularity" attribute is not applicable to features "MovementBehaviour".

NOTE 22: When the subscribed event is "LOC_ACCURACY", only one of the "networkArea" attribute or "location" attribute shall be included.

| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +NOTE: Care needs to be taken to avoid excessive signalling. + +## 5.1.6.2.4 Type NnwdafEventsSubscriptionNotification + +Table 5.1.6.2.4-1: Definition of type NnwdafEventsSubscriptionNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| eventNotifications | array(EventNotification) | C | 1..N | Notifications about Individual Events. (NOTE 1) | | +| subscriptionId | string | M | 1 | String identifying a subscription to the Nnwdaf_EventsSubscription service. (NOTE 2) | | +| notifCorrId | string | O | 0..1 | Notification correlation identifier. | EneNA | +| oldSubscriptionId | string | C | 0..1 | Subscription ID which was allocated by the source NWDAF. This parameter shall be present if the notification is for informing the assignment of a new Subscription Id by the target NWDAF in the analytics transfer procedure. (NOTE 1) | EneNA | +| resourceUri | Uri | C | 0..1 | The resource URI of the Individual NWDAF Event Subscription resource created by the target NWDAF. Shall be present when the target NWDAF notifies a successful analytics subscription transfer. (NOTE 1) (NOTE 2) | EneNA | +| termCause | TermCause | O | 0..1 | A cause for which the NWDAF will send no further notifications for this subscription. Its presence indicates that the NWDAF requests the termination of the subscription. | TermRequest | +| transEvents | array(NnwdafEvent) | C | 1..N | Indicates the successful transferred subscription event(s) for a partial successful analytics subscription transfer. It shall be supplied by the Target NWDAF if not all the analytics events in the subscription transfer are accepted. | PartialAnalyticsSubTransfer | + +NOTE 1: Either "eventNotifications" attribute, or "resourceUri" and "oldSubscriptionId" attributes shall be provided. +NOTE 2: It shall be the same as the last segment of the "resourceUri" attribute when the target NWDAF notifies the consumer of the successful analytics subscription transfer. + +### 5.1.6.2.5 Type EventNotification + +**Table 5.1.6.2.5-1: Definition of type EventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| event | Nwdafevent | M | 1 | Event that is notified. | | +| start | DateTime | O | 0..1 | It defines the start time of which the statistics analytics information is applicable or predictions analytics information is valid. (NOTE 1) (NOTE 4) | | +| dataVITrnsTmInfos | array(E2eDataVolTransTimeInfo) | C | 1..N | E2E data volume transfer time information. Shall be present if the subscribed event is "E2E_DATA_VOL_TRANS_TIME". | E2eDataVolTransTime | +| expiry | DateTime | O | 0..1 | It defines the expiration time after which the statistics analytics information is not applicable or predictions analytics information is invalid. (NOTE 1) (NOTE 4) | | +| timeStampGen | DateTime | C | 0..1 | It defines the timestamp of analytics generation. (NOTE 3) | | +| failNotifyCode | NwdaFailureCode | C | 0..1 | Identifies the failure reason for the event notification. It shall only be included if the event notification is failed or the analytics information is not ready. (NOTE 2) | EneNA | +| rvWaitTime | DurationSec | O | 0..1 | Indicate a recommended time interval (in seconds) which is used to determine the time when analytics information is needed in similar future event subscriptions. It may only be included if the "failNotifyCode" attribute sets to "UNSATISFIED_REQUESTED_ANALYTICS_TIME". | EneNA | +| anaMetaInfo | AnalyticsMetadataInfo | C | 0..1 | Contains information about analytics metadata required to aggregate the analytics. It shall be present if the "anaMeta" attribute was included in the subscription, containing the information indicated by the "anaMeta" attribute. | Aggregation | +| nwPerfs | array(NetworkPerfInfo) | C | 1..N | The network performance information. Shall be present when subscribed even is "NETWORK_PERFORMANCE". | NetworkPerformance | +| nflLoadLevelInfos | array(NfLoadLevelInformation) | C | 1..N | The NF load level information. When subscribed event is "NF_LOAD", the nflLoadLevelInfos shall be included. | NfLoad | +| nsiLoadLevelInfos | array(NsiLoadLevelInfo) | C | 1..N | Each element identifies the load level information for each S-NSSAI and the optionally associated network slice instance. Shall be included when subscribed event is "NSI_LOAD_LEVEL". | NsiLoad | +| pfdDetermInfos | array(PfdDeterminationInfo) | C | 1..N | Represents the PFD Determination information for a known application identifier. Shall be included when subscribed event is "PFD_DETERMINATION". | PfdDetermination | + +| | | | | | | +|--------------------|-------------------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| qoSustainInfos | array(QoSustainabilityInfo) | C | 1..N | The QoS sustainability information.
When subscribed event is "QOS_SUSTAINABILITY", the qoSustainInfos shall be included. | QoSSustainability | +| sliceLoadLevelInfo | SliceLoadLevelInformation | C | 0..1 | The slices and the load level information.
When subscribed event is "SLICE_LOAD_LEVEL", the sliceLoadLevelInfo shall be included. | | +| svcExps | array(ServiceExperienceInfo) | C | 1..N | The service experience information.
When subscribed event is "SERVICE_EXPERIENCE", the svcExps shall be included. | ServiceExperience | +| ueComms | array(UeCommunication) | C | 1..N | The UE communication information.
When subscribed event is "UE_COMM", the ueComms shall be included. | UeCommunication | +| ueMobs | array(UeMobility) | C | 1..N | The UE mobility information.
When subscribed event is "UE_MOBILITY", the ueMobs shall be included. | UeMobility | +| abnorBehavrs | array(AbnormalBehaviour) | C | 1..N | The Abnormal Behaviour information.
When subscribed event is "ABNORMAL_BEHAVIOUR", the abnorBehavrs shall be included. | AbnormalBehaviour | +| userDataCongInfos | array(UserDataCongestionInfo) | C | 1..N | The location and user data congestion information.
Shall be present if the subscribed event is "USER_DATA_CONGESTION". | UserDataCongestion | +| dnPerfInfos | array(DnPerfInfo) | C | 1..N | The DN performance information.
Shall be present if the subscribed event is "DN_PERFORMANCE". | DnPerformance | +| dispersInfos | array(DispersionInfo) | C | 1..N | The Dispersion information.
When subscribed event is "DISPERSION", the "dispersInfos" attribute shall be included. | Dispersion | +| redTransInfos | array(RedundantTransmissionExpInfo) | C | 1..N | The redundant transmission experience related information.
When subscribed event is "RED_TRANS_EXP", the "redTransInfos" attribute shall be included. | RedundantTransmissionExp | +| wlanInfos | array(WlanPerformanceInfo) | C | 1..N | The WLAN performance related information.
When subscribed event is "WLAN_PERFORMANCE", the "wlanInfos" attribute shall be included. | WlanPerformance | +| smccExps | array(SmccInfo) | C | 1..N | The Session Management Congestion Control Experience information.
Shall be present when the requested event is "SM_CONGESTION". | SMCCE | +| pduSesTrafInfos | array(PduSesTrafficInfo) | C | 1..N | The PDU Session traffic related information.
When subscribed event is "PDU_SESSION_TRAFFIC", the "pduSesTrafInfos" attribute shall be included. | PduSesTraffic | + +| | | | | | | +|---------------|-------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| accuInfo | AccuracyInfo | C | 0..1 | The analytics accuracy information.
Shall be provided if the analytics accuracy requirement was subscribed in the "accuReq" attribute and the "cancelAccuInd" attribute is set to "false" or omitted. | AnalyticsAccuracy | +| cancelAccuInd | boolean | O | 0..1 | Indicates cancelled subscription of the analytics accuracy information.
Set to "true" indicates the NWDAF cancelled subscription of analytics accuracy information as the NWDAF does not support the accuracy checking capability.
Otherwise set to "false". Default value is "false" if omitted. | AnalyticsAccuracy | +| pauseInd | boolean | O | 0..1 | Pause analytics consumption indication applicable on analytics ID level. Set to "true" to indicate the consumer to stop the consumption of the analytics because the accuracy level needs to be increased.

Default value is "false" if omitted. | AnalyticsAccuracy | +| resumeInd | boolean | O | 0..1 | Resume analytics consumption indication applicable on analytics ID level. Set to "true" to indicate the consumer to resume the consumption of the analytics because the accuracy has been improved.

Default value is "false" if omitted. | AnalyticsAccuracy | +| movBehavInfos | array(MovBehavInfo) | C | 1..N | The Movement Behaviour information.
When subscribed event is "MOVEMENT_BEHAVIOUR", the "movBehavInfo" attribute shall be included. | MovementBehaviour | +| relProxInfos | array(RelProximityInfo) | C | 1..N | The Relative Proximity information.
When subscribed event is "RELATIVE_PROXIMITY", the "relProxInfos" attribute shall be included. | RelativeProximity | + +NOTE 1: If the "start" attribute and the "expiry" attribute are both provided, the DateTime of the "expiry" attribute shall not be earlier than the DateTime of the "start" attribute. + +NOTE 2: The value of "PREDICTION\_NOT\_ALLOWED" and "BOTH\_STAT\_PRED\_NOT\_ALLOWED" of the NwdaFailureCode data type is not applicable for the "failNotifyCode" attribute. The value of "UNAVAILABLE\_DATA" of the NwdaFailureCode data type is applicable for the the "failNotifyCode" attribute only when the "StatisticsFailure" feature is supported. + +NOTE 3: This attribute shall be included when ADRF is deployed. + +NOTE 4: The validity period specified by "start" and "expiry" attributes is determined by NWDAF internal logic, and is a subset of the analytics target period indicated by "startTs" and "endTs", or "offsetPeriod" attributes contained in "extraReportReq" attribute of the subscription. If the analytics target period refers to the past, the period specified by these two attributes indicate the time period over which the statistics are applicable. If the analytics target period refers to the future, the period specified by these two attributes indicate the time period over which the predictions are valid. + +## 5.1.6.2.6 Type SliceLoadLevelInformation + +**Table 5.1.6.2.6-1: Definition of type SliceLoadLevelInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|----------------------|---|-------------|------------------------------------------------------------------------------------|---------------| +| loadLevelInformation | LoadLevelInformation | M | 1 | Load level information which applies for each network slice identified by snssais. | | +| snssais | array(SNSSAI) | M | 1..N | Identification(s) of network slice to which the subscription applies. | | + +NOTE: The functionality of the Slice Load Level Information is a subset of the functionality of the NSI Load Level Information, does not need to be used if the NsiLoadExt feature is supported, and is maintained only for backwards compatibility purposes. + +### 5.1.6.2.7 Type EventReportingRequirement + +**Table 5.1.6.2.7-1: Definition of type EventReportingRequirement** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| accuracy | Accuracy | O | 0..1 | Preferred level of accuracy of the analytics. (NOTE 5) | | +| accPerSubset | array(Accuracy) | O | 1..N | Each element indicates the preferred accuracy level per analytics subset. It may be present if the "listOfAnaSubsets" attribute is present in the subscription request (NOTE 4, NOTE 5) | EneNA | +| startTs | DateTime | O | 0..1 | UTC time indicating the start time of the observation period. The absence of this attribute means subscription at the present time unless the "offsetPeriod" attribute is included. (NOTE 3) | | +| endTs | DateTime | O | 0..1 | UTC time indicating the end time of the observation period. If the start time is in the past, then the absence of this attribute means that the end time of the subscription is at the present time, unless the "offsetPeriod" attribute is included. If provided, it shall not be less than the start time. (NOTE 3) | | +| offsetPeriod | integer | O | 0..1 | Offset period in units of seconds to the reporting time, if the value is negative means statistics in the past offset period, otherwise a positive value means prediction in the future offset period. May be present if the "repPeriod" attribute is included within the "evtReq" attribute or the "repetitionPeriod" attribute is included within the EventSubscription type. (NOTE 3) | EneNA | +| sampRatio | SamplingRatio | O | 0..1 | Percentage of sampling (1%...100%) among impacted UEs. Applicable to event targeting a group of UEs or any UE. (NOTE 1) | | +| maxSupiNbr | UInteger | O | 0..1 | Represents the maximum number of SUPIs expected in an object. Applicable for the event(s) providing a list of SUPIs during the analytics response. | | +| maxObjectNbr | UInteger | O | 0..1 | Maximum number of objects expected for an analytics report. It's only applicable for the event(s) which may provide more than one entries or objects during event notification. | | +| timeAnaNeeded | DateTime | O | 0..1 | UTC time indicating the time when analytics information is needed. | EneNA | +| anaMeta | array(AnalyticsMetadata) | O | 1..N | List of analytics metadata that are requested to be included. | Aggregation | +| anaMetaInd | AnalyticsMetadataIndication | O | 0..1 | Contains values for the analytics metadata that the NF service consumer wants to be used for generating the analytics. | Aggregation | +| histAnaTimePeriod | TimeWindow | O | 0..1 | The time period of historical analytics indicates the start time and end time during which the historical analytics was generated. If this attribute is | EneNA | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|----------------------------------------------------------------------------------------------------------------|--| +| | | | | included, the NWDAF only needs to provide the existing analytics, and does not need to generate new analytics. | | +|

NOTE 1: The "sampRatio" attribute within EventReportingRequirement data type is not applicable for the Nnwdaf_EventsSubscription API.

NOTE 2: Void.

NOTE 3: When the "offsetPeriod" attribute is included, the "startTs" and "endTs" attributes shall not be included. If the analytics target period is indicated either by providing a "startTs" attribute and an "endTs" attribute that are equal, or by providing an "offsetPeriod" attribute equal to zero (which means there is no offset to the periodic reporting time indicated by the "repPeriod" attribute or "repetitionPeriod" attribute), then this is a request for analytics for a specific time of the same "startTs" attribute and "endTs" attribute or each specific time periodically indicated by the "repPeriod" attribute , rather than for a time interval. If none of the attributes "startTs", "endTs" and "offsetPeriod" is provided, the analytics target period starts at the present time and there is no specified end time.

NOTE 4: If multiple accuracy entries are included, the order of the entries of the "accPerSubset" attribute corresponds with the order of the entries of the "listOfAnaSubsets" attribute, i.e. the first entry of the "accPerSubset" attribute holds the requested accuracy for the analytics subset that is indicated by the first entry of the "listOfAnaSubsets" attribute, and so on.

NOTE 5: If both the "accuracy" attribute and "accPerSubset" attribute were provided in the request, the "accPerSubset" attribute takes precedence over the "accuracy" attribute.

| | | | | | + +## 5.1.6.2.8 Type TargetUeInformation + +Table 5.1.6.2.8-1: Definition of type TargetUeInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| anyUe | boolean | O | 0..1 | Identifies any UE when setting to "true".
Default value is "false" if omitted.
(NOTE 3) | ServiceExperience
NetworkPerformance
NfLoad
UserDataCongestion
AbnormalBehaviour
QoSustainability
Dispersion
RedundantTransmissionExp
WlanPerformance
DnPerformance
PduSesTraffic | +| supis | array(Supi) | O | 1..N | Each element represents a SUPI for a UE.
(NOTE 2) | UeMobility
UeCommunication
NetworkPerformance
AbnormalBehaviour
UserDataCongestion
NfLoad
ServiceExperience
Dispersion
RedundantTransmissionExp
WlanPerformance
SMCCE
DnPerformance
PduSesTraffic
RelativeProximity | +| gpsi | array(Gpsi) | O | 1..N | Each element represents a GPSI for a UE.
(NOTE 2) | UserDataCongestion
Ext
DnPerformance | +| intGroupIds | array(GroupId) | O | 1..N | Each element represents an internal group identifier and identifies a group of UEs.
(NOTE 2) | UeMobility
UeCommunication
NetworkPerformance
AbnormalBehaviour
ServiceExperience
Dispersion
RedundantTransmissionExp
WlanPerformance
DnPerformance
PduSesTraffic
RelativeProximity | + +NOTE 1: For an applicable feature or UserDataCongestion and UserDataCongestionExt features are both applicable, only one attribute identifying the target UE shall be provided. + +NOTE 2: Only one element in the attribute shall be provided for the applicable events except the "SERVICE\_EXPERIENCE" event, the "DISPERSION" event and/or the "SMCCE" event. + +NOTE 3: For feature "Dispersion", any UE is only supported in combination with S-NSSAI, Area of Interest and/or Dispersion Class. + +## 5.1.6.2.9 Void + +## 5.1.6.2.10 Type UeMobility + +Table 5.1.6.2.10-1: Definition of type UeMobility + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| ts | DateTime | C | 0..1 | This attribute identifies the timestamp when the UE arrives the location. (NOTE 1) | | +| recurringTime | ScheduledCommunicationTime | C | 0..1 | Identifies time of the day and day of the week which are valid within the observation period when the UE moves. (NOTE 1, NOTE 2) | | +| duration | DurationSec | M | 1 | This attribute identifies the time duration the UE stays in the location.
If the analytics result applies for a group of UEs, it indicates the average duration for the group of UEs.
(NOTE 3) | | +| durationVariance | Float | C | 0..1 | This attribute indicates the variance of the analysed durations for the group of UEs. It shall be provided if the analytics result applies for a group of UEs. | | +| locInfos | array(LocationInfo) | M | 1..N | This attribute includes a list of UE location information during the time duration.
(NOTE 4) | | +| directionInfos | array(DirectionInfo) | C | 1..N | This attribute includes a list of UE direction information. Shall be present if one of the elements in the "listOfAnaSubsets" attribute in the request was set to "UE_DIRECTION". | UeMobilityExt_AIML | + +NOTE 1: Either "ts" or "recurringTime" shall be provided. +NOTE 2: If this attribute is present, it indicates the UE movement is periodic. This attribute is suitable to be present for a recurring mobility in a long observation time. +NOTE 3: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "duration" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. +NOTE 4: If the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes are provided in the request, the number of TAs or cells contained in "areaInfo" attribute shall be smaller than or equal to the values of the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes. + +## 5.1.6.2.11 Type LocationInfo + +Table 5.1.6.2.11-1: Definition of type LocationInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------| +| loc | UserLocation | M | 1 | This attribute contains the detailed location, the ueLocationTimestamp attribute in the 3GPP access type of UserLocation data type shall not be provided.
(NOTE 3) | | +| geoLoc | GeographicalArea | C | 0..1 | This attribute contains the geographical location in a fine granularity (e.g. smaller than a cell).
Shall be present if one of the elements in the "listOfAnaSubsets" attribute in the request was set to "USER_LOCATION".
(NOTE 2) (NOTE 3) | UeMobilityExt2_eNA
ServiceExperienceExt2_eNA
DispersionExt_eNA | +| ratio | SamplingRatio | C | 0..1 | This attribute contains the percentage of UEs with same analytics result in the group.
Shall be present if the analytics result applies for a group of UEs. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 1)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +| geoDistrInfos | array(GeoDistributionInfo) | C | 1..N | Indicates the geographical distribution of the UEs that may be selected by the AF for application service. Shall be present if one of the elements in the "listOfAnaSubsets" attribute in the request was set to "UE_GEO_DIST". | UeMobilityExt_AIML | +| distThreshold | UInteger | O | 0..1 | Indicates the linear distance threshold which has been reached. This attribute will be provided only if more than one thresholds were provided in "distThresholds" attribute contained in UeMobilityReq data type and the target is a single UE. | UeMobilityExt2_eNA | + +NOTE 1: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +NOTE 2: When possible and applicable to the access type, the UE location is provided according to the preferred granularity subscribed or requested in the "locGranularity" attribute. + +NOTE 3: When the "geoLoc" attribute is present, the "loc" attribute shall be ignored. + +5.1.6.2.12 Void + +5.1.6.2.13 Type UeCommunication + +**Table 5.1.6.2.13-1: Definition of type UeCommunication** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| commDur | DurationSec | M | 1 | Identifies the duration of the communication.
If the analytics result applies for a group of UEs, it indicates the average duration for the subset of UEs indicated by a given ratio in the group. | | +| commDurVariance | Float | C | 0..1 | This attribute indicates the variance of the analysed durations for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs. | | +| periodTime | DurationSec | O | 0..1 | Identifies interval time of periodic communication, e.g. every 10 minutes or 1 hour. (NOTE 2)
If the analytics result applies for a group of UEs, it indicates the average interval time of periodic communication for the subset of UEs indicated by a given ratio in the group. | | +| periodTimeVariance | Float | C | 0..1 | This attribute indicates the variance of the analysed intervals of periodic communication for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs. | | +| ts | DateTime | C | 0..1 | Identifies the start time of the communication. (NOTE 1) | | +| tsVariance | Float | O | 0..1 | This attribute indicates the variance of the analysed start time for the subset of UEs indicated by a given ratio in the group. It may only be provided if the ts attribute is provided. | | +| recurringTime | ScheduledCommunicationTime | C | 0..1 | Identifies time of the day and day of the week which are valid within the observation period when the UE has communication.
Providing the end time in ScheduledCommunicationTime data type is not required. (NOTE 1, NOTE 3) | | +| trafChar | TrafficCharacterization | M | 1 | Identifies the detailed traffic characterization. | | +| ratio | SamplingRatio | C | 0..1 | This attribute contains the percentage of UEs with same analytics result in the group. Shall be present if the analytics result applies for a group of UEs. | | +| periodCommInd | boolean | O | 0..1 | This attribute indicates whether the UE communicates periodically or not.
Set to "true" to indicate the UE communicates periodically, set to "false" to indicate the UE does not communicate periodically.
Default value is "false" if omitted. | UeCommunicationExt | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 4)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +| anaOfAppList | AppListForUeCo | C | 0..1 | Represents the analytics of the | UeCommunicationE | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | mm | | | application list used by UE.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to APP_LIST_FOR_UE_COMM. | xt | +| sessInactTimer | SessInactTimerForUeComm | C | 0..1 | Represents the N4 Session inactivity timer.
Shall be present only if one of the elements in the "listOfAnaSubsets" attribute was set to N4_SESS_INACT_TIMER_FOR_UE_COMM and the identified NF service consumer is an SMF.
(NOTE 5) | UeCommunicationExt | +| NOTE 1: Either "ts" or "recurringTime" shall be provided.
NOTE 2: If this attribute is present, it indicates the communication is periodic and its value shall be larger than the commDur value. If this attribute is present with the ts attribute, it indicates the periodic communication time valid within the observation period; if it is present with the recurringTime attribute, it indicates the periodic communication time valid within the day(s).
NOTE 3: If this attribute is present, it indicates the communication is periodic. This attribute is suitable to be present for a recurring communication in a long observation time.
NOTE 4: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.
NOTE 5: This attribute shall not be provided if the NWDAF does not know the NF service consumer type or if the NWDAF knows that the NF service consumer is not an SMF. | | | | | | + +## 5.1.6.2.14 Type TrafficCharacterization + +Table 5.1.6.2.14-1: Definition of type TrafficCharacterization + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | O | 0..1 | Contains the application identifier. | | +| dnn | Dnn | O | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. Shall be present if the "dnns" was provided within EventSubscription during the subscription for event notification procedure. | | +| snssai | Snssai | C | 0..1 | Identifies the network slice. Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure. | | +| fDescs | array(IpEthFlowDescription) | O | 1..2 | Contains the flow description for the Uplink and/or Downlink flows. | | +| ulVol | Volume | C | 0..1 | Identifies the uplink traffic volume. (NOTE)
If the analytics result applies for a group of UEs, it indicates the average uplink traffic volume for the subset of UEs indicated by a given ratio in the group. | | +| ulVolVariance | Float | C | 0..1 | This attribute indicates the variance of the uplink traffic volumes for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs. | | +| dlVol | Volume | C | 0..1 | Identifies the downlink traffic volume. (NOTE)
If the analytics result applies for a group of UEs, it indicates the average downlink traffic volume for the subset of UEs indicated by a given ratio in the group. | | +| dlVolVariance | Float | C | 0..1 | This attribute indicates the variance of the downlink traffic volumes for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs. | | + +NOTE: At least one of "ulVol" or "dlVol" shall be provided. + +## 5.1.6.2.15 Type AbnormalBehaviour + +Table 5.1.6.2.15-1: Definition of type AbnormalBehaviour + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supis | array(Supi) | C | 1..N | Each element identifies a UE which is affected with the Exception.
Shall be present if the subscription request applies to more than one UE. | | +| dnn | Dnn | C | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.
Shall be present if the "dnns" was provided within EventSubscription during the subscription for event notification procedure. | | +| excep | Exception | M | 1 | Contains the exception information. | | +| snssai | Snssai | C | 0..1 | Identifies the network slice information.
Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure. | | +| ratio | SamplingRatio | C | 0..1 | Contains the percentage of UEs with same analytics result in the group or among all UEs.
Shall be present if the analytics result applies for a group of UEs or any UE. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +| addtMeasInfo | AdditionalMeasurement | O | 0..1 | Additional measurement. | | + +NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +## 5.1.6.2.16 Type Exception + +Table 5.1.6.2.16-1: Definition of type Exception + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-------------------------------------------|---------------| +| exceptionId | ExceptionId | M | 1 | Indicating the Exception ID. | | +| exceptionLevel | integer | O | 0..1 | Measured level, compared to the threshold | | +| exceptionTrend | ExceptionTrend | O | 0..1 | Measured trend | | + +## 5.1.6.2.17 Type UserDataCongestionInfo + +Table 5.1.6.2.17-1: Definition of type UserDataCongestionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| networkArea | NetworkAreaInfo | M | 1 | Identification of network area to which the subscription applies. | | +| congestionInfo | CongestionInfo | M | 1 | The congestion information of the specific location. | | +| snssai | Snssai | C | 0..1 | Identifies an S-NSSAI. Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure. | | + +## 5.1.6.2.18 Type CongestionInfo + +Table 5.1.6.2.18-1: Definition of type CongestionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| congType | CongestionType | M | 1 | Identification congestion analytics type. | | +| timeIntev | TimeWindow | M | 1 | Represents the start time and the stop time to which requested for the congestion information applies. (NOTE 2) | | +| nsi | ThresholdLevel | M | 1 | Network Status Indication. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 1)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +| topAppListUl | array(TopApplication) | C | 1..N | List of top applications in Uplink. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to LIST_OF_TOP_APP_UL. | UserDataCongestion Ext | +| topAppListDl | array(TopApplication) | C | 1..N | List of top applications in Downlink. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to LIST_OF_TOP_APP_DL. | UserDataCongestion Ext | + +NOTE 1: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +NOTE 2: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "timeIntev" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +## 5.1.6.2.19 Type QoSustainabilityInfo + +Table 5.1.6.2.19-1: Definition of type QoSustainabilityInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| areaInfo | NetworkAreaInfo | M | 1 | Identification(s) of applicable location areas to which the subscription.
(NOTE 4) | | +| fineAreaInfos | array(GeographicArea) | O | 1..N | This attribute contains the geographical locations in a fine granularity (e.g. smaller than a cell). May be provided when the "fineGranAreas" attribute is provided in the request. | QoSustainabilityExt_eNA | +| startTs | DateTime | M | 1 | Represents the start time of the applicable observing period.
(NOTE 3) | | +| endTs | DateTime | M | 1 | Represents the end time of the applicable observing period.
(NOTE 3) | | +| qosFlowRetThd | RetainabilityThreshold | C | 0..1 | The reporting QoS Flow Retainability Threshold that are met or crossed for 5QI of GBR resource type.
(NOTE 1) | | +| ranUeThrouThd | BitRate | C | 0..1 | The reporting RAN UE Throughput Threshold that are met or crossed for 5QI of non-GBR resource type.
(NOTE 1) | | +| snssai | Snssai | C | 0..1 | Identifies an S-NSSAI. Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 2)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE 1: Either "qosFlowRetThd" or "ranUeThrouThd" attribute shall be provided. +NOTE 2: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. +NOTE 3: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "startTs" and "endTs" attributes shall be greater than or equal to the value of the "temporalGranSize" attribute. +NOTE 4: If the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes are provided in the request, the number of TAs or cells contained in "areaInfo" attribute shall be smaller than or equal to the values of the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes. + +## 5.1.6.2.20 Type QosRequirement + +Table 5.1.6.2.20-1: Definition of type QosRequirement + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------------|------------------|---|-------------|-------------------------------------------------------------------------------------------------------------|------------------------------| +| 5qi | 5Qi | C | 0..1 | Represents a 5G QoS Identifier. It shall be included for standardized or preconfigured 5QIs. (NOTE) | | +| gfbrUl | BitRate | C | 0..1 | Indicates GFBR in the uplink. It shall be included for GBR 5QIs. | | +| gfbrDl | BitRate | C | 0..1 | Indicates GFBR in the downlink. It shall be included for GBR 5QIs. | | +| resType | QosResourceType | C | 0..1 | Resource type. Shall be provided for the non-standardized and non-preconfigured QoS characteristics. (NOTE) | | +| pdb | PacketDelBudget | O | 0..1 | Packet Delay Budget. May be supplied for the non-standardized and non-pre-configured QoS characteristics. | | +| per | PacketErrRate | O | 0..1 | Packet Error Rate. May be supplied for the non-standardized and non-pre-configured QoS characteristics. | | +| deviceSpeed | VelocityEstimate | O | 0..1 | Velocity Estimate. | QoSSustainabilityExt_eN
A | +| deviceType | DeviceType | O | 0..1 | The device type. | QoSSustainabilityExt_eN
A | +| NOTE: Either 5QI within "5qi" attribute or the resource type within "resType" attribute shall be provided. | | | | | | + +## 5.1.6.2.21 Type RetainabilityThreshold + +Table 5.1.6.2.21-1: Definition of type RetainabilityThreshold + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| relFlowNum | UInteger | C | 0..1 | Represents the number of abnormally released QoS flows. (NOTE) | | +| relTimeUnit | TimeUnit | C | 0..1 | Represents the unit for the session active time, shall be present if relFlowNum is present. (NOTE) | | +| relFlowRatio | SamplingRatio | C | 0..1 | Represents the ratio of abnormally released QoS flows to the total released QoS flows, expressed in percentage. (NOTE) | | +| NOTE: Either "relFlowNum" and its associated "relTimeUnit" attributes or "relFlowRatio" attributes shall be provided. The "relFlowNum" and "relTimeUnit" attributes together represents the number of abnormally released QoS flows (i.e. relFlowNum) within the time unit (i.e. relTimeUnit). | | | | | | + +## 5.1.6.2.22 Type NetworkPerfRequirement + +Table 5.1.6.2.22-1: Definition of type NetworkPerfRequirement + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| nwPerfType | NetworkPerfType | M | 1 | The type of the network performance. | | +| relativeRatio | SamplingRatio | C | 0..1 | The relative ratio expressed in percentage. (NOTE 1) | | +| absoluteNum | UInteger | C | 0..1 | The absolute number (NOTE 1) | | +| orderCriterion | NetworkPerfOrderCriterion | O | 0..1 | The ordering criterion for the list of network performance analytics. (NOTE 2) | NetworkPerformanceExt_eNA | +| rscUsgReq | ResourceUsageRequirement | O | 0..1 | Indicates more requirements when providing resource usage information for the network performance type indicated by the "nwPerfType" attribute. (NOTE 3) | NetworkPerformanceExt_AIML | + +NOTE 1: Either "relativeRatio" or "absoluteNum" shall be provided if the "notifMethod" in "evtReq" is set to "ON\_EVENT\_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted. + +NOTE 2: The "CROSSED" value in "MatchingDirection" data type is not applicable for this attribute. + +NOTE 3: The "rscUsgReq" value is only applicable when the "nwPerfType" attribute is set to "GNB\_RSC\_USAGE\_OVERALL\_TRAFFIC", "GNB\_RSC\_USAGE\_GBR\_TRAFFIC" or "GNB\_RSC\_USAGE\_DELAY\_CRIT\_GBR\_TRAFFIC". + +## 5.1.6.2.23 Type NetworkPerfInfo + +Table 5.1.6.2.23-1: Definition of type NetworkPerfInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| networkArea | NetworkAreaInfo | M | 1 | Identification of network area to which the subscription applies. (NOTE 5) | | +| nwPerfType | NetworkPerfType | M | 1 | The type of the network performance | | +| anaPeriod | TimeWindow | O | 0..1 | Indicates the analytics target period subset within the requested analytics target period. (NOTE 4) | NetworkPerformanceExt_eNA | +| relativeRatio | SamplingRatio | C | 0..1 | The reported relative ratio expressed in percentage. (NOTE 1) | | +| absoluteNum | UInteger | C | 0..1 | The reported absolute number (NOTE 1) | | +| rscUsgReq | ResourceUsageRequirement | O | 0..1 | Indicates more information when providing resource usage information for the network performance type indicated by the "nwPerfType" attribute. (NOTE 3) | NetworkPerformanceExt_AIML | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 2)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE 1: Either "relativeRatio" or "absoluteNum" shall be provided. + +NOTE 2: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +NOTE 3: The "rscUsgReq" value is only applicable when the "nwPerfType" attribute is set to "GNB\_RSC\_USAGE\_OVERALL\_TRAFFIC", "GNB\_RSC\_USAGE\_GBR\_TRAFFIC" or "GNB\_RSC\_USAGE\_DELAY\_CRIT\_GBR\_TRAFFIC". + +NOTE 4: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "anaPeriod" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +NOTE 5: If the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes are provided in the request, the number of TAs or cells contained in "networkArea" attribute shall be smaller than or equal to the values of the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes. + +## 5.1.6.2.24 Type ServiceExperienceInfo + +**Table 5.1.6.2.24-1: Definition of type ServiceExperienceInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| svcExprc | SvcExperience | M | 1 | Service experience | | +| svcExprcVariance | Float | O | 0..1 | This attribute indicates the variance . | | +| supis | array(Supi) | O | 1..N | Each element identifies a UE.
May only be present if the subscription request applies to more than one UE. (NOTE 3) | | +| snssai | Snssai | C | 0..1 | Identifies an S-NSSAI. Shall be presented if the "snssais" was provided within EventSubscription during the subscription for event notification procedure. | | +| appId | ApplicationId | C | 0..1 | Identifies an application. Shall be present if the "appIds" was provided within EventSubscription during the subscription for event notification procedure. | | +| srvExprcType | ServiceExperienceType | O | 0..1 | Indicates the type of Service Experience analytics. | ServiceExperienceExt | +| ueLocs | array(LocationInfo) | C | 1..N | This attribute includes a list of UE location information during the time duration.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to UE_LOCATION. (NOTE 2) | ServiceExperienceExt | +| upflInfo | UpflInformation | C | 0..1 | Represents the information of the UPF serving the UE.
Shall be present only if the "upflInfo" attribute was provided in the request or subscription and the NF service consumer is identified as not an AF or a NEF. (NOTE 4) | ServiceExperienceExt | +| dnai | Dnai | C | 0..1 | Indicates the DN Access Identifier representing location of the service flow. Shall be present if the "dnais" attribute was provided in the request or subscription. | ServiceExperienceExt | +| appServerInst | AddrFqdn | C | 0..1 | Represents the Application Server Instance (IP address or FQDN of the Application Server).
Shall be present if the "appServerAddrs" attribute was provided in the request or subscription. | ServiceExperienceExt | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 1)
Shall be present if the | | + +| | | | | | +|--|--|--|------------------------------------------------------------------|--| +| | | | analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +|--|--|--|------------------------------------------------------------------|--| + +| | | | | | | +|-------------|--------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| dnn | Dnn | C | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. Shall be present if the "dnns" was provided within EventSubscription during the subscription for event notification procedure. | | +| networkArea | NetworkAreaInfo | C | 0..1 | Identifies the network area where the service experience applies. Shall be presented if the "networkArea" was provided within EventSubscription during the subscription for event notification procedure. | | +| nsild | Nsild | C | 0..1 | Identifies a network slice instance which is associated with the S-NSSAI identified by the "snssai" attribute. Shall be presented if the "nsilds" was provided within the NsildInfo data in the EventSubscription data during the subscription. | | +| ratio | SamplingRatio | C | 0..1 | Contains the percentage of UEs with same analytics result in the group or among all UEs. Shall be present if the analytics result applies for a group of UEs or any UE. (NOTE 3) | | +| ratFreq | RatFreqInformation | C | 0..1 | Identification of the RAT type(s) and/or frequency(ies) of UE's serving cell(s) which the service experience applies. Shall be present if the "ratFreqs" was provided in the EventSubscription data during the subscription.

When "allRat" and/or "allFreq" are included in the subscription, the NWDAF provides an instance of the Application service experience per combination of RAT Type(s) and/or Frequency value(s) having the same Service Experience. | ServiceExperienceExt | +| pduSesInfo | PduSessionInfo | C | 0..1 | Represents the PDU Session parameters. Shall be present if the "pduSesInfos" attribute was provided in the EventSubscription data type during the subscription. | ServiceExperienceExt2_eN
A | + +| | | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: | If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. | +| NOTE 2: | The "ueLocs" attribute shall only be included if the consumer analytics request is for a single UE or a list of UEs. Inclusion of such UE location requires user consent during the UE location data collection. | +| NOTE 3: | The SUPI list and Ratio in the service experience information for an application may be omitted if the reported service experience information is provided and is assigned with the same value(s) for the slice instance which the application belongs to. Otherwise, the SUPI list and Ratio shall be provided for an application service experience. | +| NOTE 4: | This attribute shall not be provided if the NWDAF does not know the NF service consumer type or if the NWDAF knows that the NF service consumer is an AF or a NEF. | + +#### 5.1.6.2.25 Type BwRequirement + +**Table 5.1.6.2.25-1: Definition of type BwRequirement** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------------------------------------------------------------------------------------------------------------|---|-------------|-----------------------------------------------|---------------| +| appId | ApplicationId | M | 1 | Represents an application.
(NOTE) | | +| marBwUI | BitRate | O | 0..1 | Maximum requested bandwidth for the Uplink. | | +| marBwDI | BitRate | O | 0..1 | Maximum requested bandwidth for the Downlink. | | +| mirBwUI | BitRate | O | 0..1 | Minimum requested bandwidth for the Uplink. | | +| mirBwDI | BitRate | O | 0..1 | Minimum requested bandwidth for the Downlink. | | +| NOTE: | If the "appId" attribute is provided within EventSubscription data, this attribute shall be indicated by the "appId" attribute. | | | | | + +## 5.1.6.2.26 Type AdditionalMeasurement + +Table 5.1.6.2.26-1: Definition of type AdditionalMeasurement + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| unexpLoc | NetworkAreaInfo | C | 0..1 | The unexpected locations which the UE stays.
It may only be present when the "exceptionId" within the Exception data sets to "UNEXPECTED_UE_LOCATION" | | +| unexpFlowTeps | array(IpEthFlowDescription) | C | 1..N | Unexpected IP or Ethernet flow templates.
It may only be present when the "exceptionId" within the Exception data sets to "UNEXPECTED_LONG_LIVE_FLOW" or "UNEXPECTED_LARGE_RATE_FLOW". | | +| unexpWakes | array(DateTime) | C | 1..N | Unexpected wake up times.
It may only be present when the "exceptionId" within the Exception data sets to "UNEXPECTED_WAKEUP". | | +| ddosAttack | AddressList | C | 0..1 | Victim's address list.
It may only be present when the "exceptionId" within the Exception data sets to "SUSPICION_OF_DDOS_ATTACK". | | +| wrgDest | AddressList | C | 0..1 | Wrong destination address list.
It may only be present when the "exceptionId" within the Exception data sets to "WRONG_DESTINATION_ADDRESSES". | | +| circums | array(CircumstanceDescription) | C | 1..N | The description of circumstances.
It may only be present when the "exceptionId" within the Exception data sets to "TOO_FREQUENT_SERVICE_ACCESS", "UNEXPECTED_RADIO_LINK_FAILURES" or "PING_PONG_ACROSS_CELLS". | | + +## 5.1.6.2.27 Type IpEthFlowDescription + +Table 5.1.6.2.27-1: Definition of type FlowDescription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------|--------------------|---|-------------|------------------------------------------|---------------| +| ipTrafficFilter | FlowDescription | C | 0..1 | Identifies IP packet filter.(NOTE) | | +| ethTrafficFilter | EthFlowDescription | C | 0..1 | Identifies Ethernet packet filter.(NOTE) | | +| NOTE: Either "ipTrafficFilter" or "ethTrafficFilter" shall be provided. | | | | | | + +## 5.1.6.2.28 Type AddressList + +Table 5.1.6.2.28-1: Definition of type AddressList + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------------------|-----------------|---|-------------|------------------------------------------|---------------| +| ipv4Addrs | array(Ipv4Addr) | O | 1..N | Each element identifies an IPv4 address. | | +| ipv6Addrs | array(Ipv6Addr) | O | 1..N | Each element identifies an IPv6 address. | | +| NOTE: At least one of "ipv4Addrs" or "ipv6Addrs" shall be provided. | | | | | | + +## 5.1.6.2.29 Type CircumstanceDescription + +Table 5.1.6.2.29-1: Definition of type CircumstanceDescription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| freq | Float | O | 0..1 | Communication frequency of the UE in units of MHz. | | +| tm | DateTime | O | 0..1 | Time when UE enters the location. | | +| locArea | NetworkAreaInfo | C | 0..1 | The location of the UE.
It shall be present when the "exceptId" within the Exception data sets to "UNEXPECTED_RADIO_LINK_FAILURES" or "PING_PONG_ACROSS_CELLS". | | +| vol | Volume | C | 0..1 | The traffic volume.
It shall be present when the "exceptId" within the Exception data sets to "TOO_FREQUENT_SERVICE_ACCESS" or "UNEXPECTED_LARGE_RATE_FLOW". | | + +### 5.1.6.2.30 Type ThresholdLevel + +**Table 5.1.6.2.30 -1: Definition of type ThresholdLevel** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| congLevel | integer | C | 0..1 | Value of Congestion that triggers notification. (NOTE 1) | UserDataCongestion | +| nfLoadLevel | integer | C | 0..1 | Value of NF Load that triggers notification. (NOTE 2)
Minimum = 0. Maximum = 100. | NfLoad | +| nfCpuUsage | integer | C | 0..1 | Value of NF CPU Usage that triggers notification. (NOTE 2)
Minimum = 0. Maximum = 100. | NfLoad | +| nfMemoryUsage | integer | C | 0..1 | Average usage of memory (NOTE 2)
Minimum = 0. Maximum = 100. | NfLoad | +| nfStorageUsage | integer | C | 0..1 | Average usage of storage. (NOTE 2)
Minimum = 0. Maximum = 100. | NfLoad | +| avgTrafficRate | BitRate | C | 0..1 | Threshold level of average traffic rate.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to AVG_TRAFFIC_RATE. (NOTE 3) | DnPerformance | +| maxTrafficRate | BitRate | C | 0..1 | Threshold level of maximum traffic rate.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to MAX_TRAFFIC_RATE. (NOTE 3) | DnPerformance | +| minTrafficRate | BitRate | C | 0..1 | Threshold level of minimum traffic rate.

The minimum traffic rate measurements are only derived from active traffic. (NOTE 4) | DnPerformanceExt_AIML | +| aggTrafficRate | BitRate | C | 0..1 | Threshold level of aggregated traffic rate.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to AGG_TRAFFIC_RATE. (NOTE 4) | DnPerformanceExt_AIML | +| varTrafficRate | Float | C | 0..1 | Threshold level of variance of traffic rate.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to VAR_TRAFFIC_RATE. (NOTE 4) | DnPerformanceExt_AIML | +| avgPacketDelay | PacketDelBudget | C | 0..1 | Threshold level of average Packet Delay.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to AVG_PACKET_DELAY. (NOTE 3) | DnPerformance | +| maxPacketDelay | PacketDelBudget | C | 0..1 | Threshold level of maximum Packet Delay.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute | DnPerformance | + +| | | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------|----------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| | | | | was set to MAX_PACKET_DELAY. (NOTE 3) | | +| varPacketDelay | Float | C | 0..1 | Threshold level of variance of Packet Delay. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to VAR_PACKET_DELAY. (NOTE 4) | DnPerformanceExt_AIML | +| avgPacketLossRate | PacketLossRate | C | 0..1 | Threshold level of average Loss Rate. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to AVG_PACKET_LOSS_RATE. (NOTE 3) | DnPerformance | +| maxPacketLossRate | PacketLossRate | C | 0..1 | Threshold level of maximum Loss Rate. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to MAX_PACKET_LOSS_RATE. (NOTE 4) | DnPerformanceExt_AIML | +| varPacketLossRate | Float | C | 0..1 | Threshold level of variance of Loss Rate. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to VAR_PACKET_LOSS_RATE. (NOTE 4) | DnPerformanceExt_AIML | +| svcExpLevel | Float | C | 0..1 | Service Experience MOS value. Shall be present when subscribed event is "SERVICE_EXPERIENCE". | ServiceExperienceExt | +| speed | Float | C | 0..1 | Speed threshold utilized to filter the UEs, expressed in kilometres per hour. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to "SPEED_THRESHOLD". | MovementBehaviour | +| NOTE 1: This attribute shall be provided when subscribed event is "USER_DATA_CONGESTION". | | | | | | +| NOTE 2: At least one attribute should be provided when subscribed event is "NF_LOAD". | | | | | | +| NOTE 3: At least one attribute should be provided when subscribed event is "DN_PERFORMANCE". | | | | | | +| NOTE 4: This attribute may only be provided if the "DnPerformanceExt_AIML" feature is supported and the subscribed event is "DN_PERFORMANCE". | | | | | | + +## 5.1.6.2.31 Type NfLoadLevelInformation + +Table 5.1.6.2.31-1: Definition of type NfLoadLevelInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| nfType | NFType | M | 1 | Type of the NF instance | | +| nfInstanceId | NfInstanceId | M | 1 | Identification of the NF instance | | +| nfSetId | NfSetId | O | 0..1 | Identification of the NF instance set | | +| nfStatus | NfStatus | C | 0..1 | Availability status of the NF (NOTE 1) | | +| nfCpuUsage | integer | C | 0..1 | Average usage CPU (NOTE 1, NOTE 2)
Minimum = 0. Maximum = 100. | | +| nfMemoryUsage | integer | C | 0..1 | Average usage of memory (NOTE 1, NOTE 2)
Minimum = 0. Maximum = 100. | | +| nfStorageUsage | integer | C | 0..1 | Average usage of storage (NOTE 1, NOTE 2)
Minimum = 0. Maximum = 100. | | +| nfLoadLevelAverage | integer | C | 0..1 | Average load information (NOTE 1, NOTE 2)
Minimum = 0. Maximum = 100. | | +| nfLoadLevelPeak | integer | C | 0..1 | Peak load information (NOTE 1, NOTE 2)
Minimum = 0. Maximum = 100. | | +| nfLoadAvgInAoi | integer | C | 0..1 | The average load of the NF instances over the area of interest. (NOTE 1, NOTE 2, NOTE 4)
Minimum = 0. Maximum = 100. | NfLoadExt | +| snssai | Snssai | C | 0..1 | Identifies an S-NSSAI.
Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 3)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +| NOTE 1: At least one value shall be provided. If the "listOfAnaSubsets" attribute with value only applicable to NF_LOAD event is present in the subscription request, then only the corresponding attribute(s) shall be present. | | | | | | +| NOTE 2: The values are percentages which are provided as estimated over a given period. | | | | | | +| NOTE 3: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. | | | | | | +| NOTE 4: Applicable only to AMF load If the "networkArea" attribute is present in the subscription request. | | | | | | + +## 5.1.6.2.32 Type NfStatus + +Table 5.1.6.2.32-1: Definition of type NfStatus + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---|-------------|--------------------------------------------------------|---------------| +| statusRegistered | SamplingRatio | C | 0..1 | Percentage of time with status "registered" (NOTE) | | +| statusUnregistered | SamplingRatio | C | 0..1 | Percentage of time with status "unregistered" (NOTE) | | +| statusUndiscoverable | SamplingRatio | C | 0..1 | Percentage of time with status "undiscoverable" (NOTE) | | +| NOTE: The availability statuses of the NF on the Analytics target period are expressed as a percentage of time. The total of status values should be equal or lower than 100%. At least one value shall be provided. | | | | | | + +## 5.1.6.2.33 Type NsildInfo + +**Table 5.1.6.2.33-1: Definition of type NsildInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Identification of network slice to which the subscription for event notification procedure applies. | | +| nsilds | array(Nsild) | O | 1..N | Identification of network slice instance(s) associated with the subscribed S-NSSAI identified by the "snssai" attribute.
May be included when subscribed event is "NSI_LOAD_LEVEL" or "SERVICE_EXPERIENCE".
(NOTE) | | + +NOTE: This attribute is not applicable when the NF service consumer is CEF or PCF. + +## 5.1.6.2.34 Type NsiLoadLevelInfo + +**Table 5.1.6.2.34-1: Definition of type NsiLoadLevelInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| loadLevelInformation | LoadLevelInformation | M | 1 | Load level information of the network slice identified by the "snssai" attribute and if provided, the associated NSI ID identified by the "nsild" attribute. | | +| snssai | Snssai | M | 1 | Identification of network slice to which the subscription applies. | | +| nsild | Nsild | C | 0..1 | Identification of network slice instance associated with the S-NSSAI identified by the "snssai" attribute.
Shall be presented if the "nsilds" attribute was provided within the NsildInfo data in the EventSubscription data during the subscription. | | +| resUsage | ResourceUsage | C | 0..1 | The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance.
Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to RES_USAGE. | NsiLoadExt | +| numOfExceedLoadLevelThr | integer | C | 0..1 | Indicates the number of times the resource usage threshold of the network slice instance is reached or exceeded if a threshold value is provided by the consumer.
Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to NUM_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR. | NsiLoadExt | +| exceedLoadLevelThrInd | boolean | C | 0..1 | Indicates whether the Load Level Threshold is met or exceeded by the statistics value. Set to "true" if the Load Level Threshold is met or exceeded, set to "false" to indicate the Load Level Threshold is not met by the statistics value. Default value is "false" if omitted.
Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to EXCEED_LOAD_LEVEL_THR_IN D. | NsiLoadExt | +| networkArea | NetworkAreaInfo | O | 0..1 | Identification of network area to which the subscription or analytics request applies. | NsiLoadExt | +| timePeriod | TimeWindow | O | 0..1 | Indicates a start time and a stop time of the load level information identified by the "loadLevelInformation" attribute. | NsiLoadExt | +| resUsgThrCrossTimePeriod | array(TimeWindow) | O | 1..N | Each element indicates the time elapsed between times each threshold is met or exceeded or crossed. The start time and end time are the exact time stamps of the resource usage threshold is reached or exceeded. May be present if the "listOfAnaSubsets" attribute is provided and the maximum number of instances shall not exceed the value provided in the "numOfExceedLoadLevelThr" attribute. | NsiLoadExt | + +| | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| numOfUes | NumberAverage | C | 0..1 | Indicates the average and variance number of UE registered at the S-NSSAI and the optionally associated network slice instance. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to NUM_OF_UE_REG. | NsiLoadExt | +| numOfPduSess | NumberAverage | C | 0..1 | Indicates the average and variance number of PDU session established at the S-NSSAI and the optionally associated network slice instance. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to NUM_OF_PDU_SESS_ESTBL. | NsiLoadExt | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | NsiLoadExt | +| NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. | | | | | | + +#### 5.1.6.2.35 Type FailureEventInfo + +**Table 5.1.6.2.35-1: Definition of type FailureEventInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|-------------------------------|---------------| +| event | NwdafEvent | M | 1 | Event that is subscribed. | | +| failureCode | NwdafFailureCode | M | 1 | Identifies the failure reason | | + +#### 5.1.6.2.36 Type AnalyticsMetadataIndication + +**Table 5.1.6.2.36-1: Definition of type AnalyticsMetadataIndication** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------|---------------| +| dataWindow | TimeWindow | O | 0..1 | Data time window of the data samples. | | +| dataStatProps | array(DatasetStatisticalProperty) | O | 1..N | List of dataset statistical properties of the data to be used to generate the analytics. | | +| strategy | OutputStrategy | O | 0..1 | Output strategy to be used for the reporting of the analytics. | | +| aggrNwdafls | array(NfInstanceId) | O | 1..N | NWDAF identifiers of NWDAF instances used by the NWDAF service consumer when aggregating multiple analytics subscriptions. | | + +## 5.1.6.2.37 Type AnalyticsMetadataInfo + +Table 5.1.6.2.37-1: Definition of type AnalyticsMetadataInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------------|---|-------------|------------------------------------------------------------------------------------|---------------| +| numSamples | UInteger | O | 0..1 | Number of data samples used for the generation of the output analytics. | | +| dataWindow | TimeWindow | O | 0..1 | Data time window of the data samples. | | +| dataStatProps | array(DatasetStatisticalProperty) | O | 1..N | List of dataset statistical properties of the data used to generate the analytics. | | +| strategy | OutputStrategy | O | 0..1 | Output strategy used for the reporting of the analytics. | | +| accuracy | Accuracy | O | 0..1 | Level of accuracy reached for the analytics. | | + +## 5.1.6.2.38 Type NumberAverage + +Table 5.1.6.2.38-1: Definition of type NumberAverage + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------|---------------| +| number | Float | M | 1 | The average number. | | +| variance | Float | M | 1 | Identifies the variance. | | +| skewness | Float | O | 0..1 | Contains the skewness. | | + +## 5.1.6.2.39 Type TopApplication + +Table 5.1.6.2.39-1: Definition of type TopApplication + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | C | 0..1 | Indicates an application identifier. (NOTE) | | +| ipTrafficFilter | FlowInfo | C | 0..1 | Identifies IP packet filter. (NOTE) | | +| ratio | SamplingRatio | O | 0..1 | The application's throughput as a percentage of the total throughput in the Area of Interest. | | + +NOTE: Either "appId" or "ipTrafficFilter" shall be provided. + +## 5.1.6.2.40 Type AnalyticsSubscriptionsTransfer + +Table 5.1.6.2.40-1: Definition of type AnalyticsSubscriptionsTransfer + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|---------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| subsTransInfos | array(SubscriptionTransferInfo) | M | 1..N | Contains information about the subscription(s) that are requested to be transferred. | | +| failTransEventReports | array(NwdaEvent) | C | 1..N | It contains the event(s) for which the subscription transfer is not successful.
It shall be supplied by the Target NWDAF if not all the analytics events in the subscription transfer are accepted. | PartialAnalyticsSubTransfer | + +## 5.1.6.2.4.1 Type SubscriptionTransferInfo + +Table 5.1.6.2.4.1-1: Definition of type SubscriptionTransferInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| transReqType | TransferRequestType | M | 1 | Indicates the type of the transfer request (i.e. if it is a request for transfer preparation or transfer execution) | | +| nwdafEvSub | NnwdafEventsSubscription | M | 1 | Contains information about the analytics subscription that is to be transferred. (NOTE) | | +| consumerId | NfInstanceId | M | 1 | NF instance identifier of the consumer of the analytics subscription that is to be transferred. | | +| contextId | AnalyticsContextIdentifier | O | 0..1 | Identifier of analytics context information available at the NF service consumer. | | +| sourceNfIds | array(NfInstanceId) | O | 1..N | NF instance identifier(s) of active data source(s) the NF service consumer is currently using for the analytics of the subscription that is to be transferred. | | +| sourceSetIds | array(NfSetId) | O | 1..N | NF set identifier(s) of active data source(s) the NF service consumer is currently using for the analytics of the subscription that is to be transferred. | | +| modelInfos | array(ModellInfo) | O | 1..N | Contains information identifying the ML model(s) that the NF service consumer is currently using for the analytics. | | + +NOTE: The "nwdafEvSub" attribute shall contain the "notificationURI" attribute. + +## 5.1.6.2.4.2 Type ModellInfo + +Table 5.1.6.2.4.2-1: Definition of type ModellInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------|---------------| +| analyticsId | NwdafEvent | M | 1 | Type of analytics for which this ML model is used. | | +| mlModellInfos | array(MLModellInfo) | M | 1..N | The information of the ML models which are applicable to the event indicated by "analyticsId" attribute. | | + +## 5.1.6.2.4.3 Type AnalyticsContextIdentifier + +Table 5.1.6.2.4.3-1: Definition of type AnalyticsContextIdentifier + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------|---------------| +| subscriptionId | string | M | 1 | Identifies a subscription to the Nnwdaf_EventsSubscription Service. | | +| nfAnaCtxts | array(NwdafEvent) | O | 1..N | List of analytics types for which NF related analytics contexts can be retrieved. (NOTE) | | +| ueAnaCtxts | array(UeAnalyticsContextDescriptor) | O | 1..N | List of objects that indicate for which SUPI and analytics types combinations analytics context can be retrieved. (NOTE) | | + +NOTE: At least one of "nfAnaCtxts" and "ueAnaCtxts" shall be provided. + +## 5.1.6.2.44 Type UeAnalyticsContextDescriptor + +Table 5.1.6.2.44-1: Definition of type UeAnalyticsContextDescriptor + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | SUPI of the UE for which analytics context can be retrieved. | | +| anaTypes | array(NwdaEvent) | M | 1..N | List of analytics types for which UE related analytics contexts can be retrieved. | | + +## 5.1.6.2.45 Type DnPerfInfo + +Table 5.1.6.2.45-1: Definition of type DnPerfInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | C | 0..1 | Indicates an application identifier. Shall be present if the "appIds" attribute was provided in the request or subscription. | | +| dnn | Dnn | C | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. Shall be present if the "dnns" was provided in the request or subscription. | | +| snssai | Snssai | C | 0..1 | Identifies the network slice information. Shall be present if the "snssais" was provided in the request or subscription. | | +| dnPerf | array(DnPerf) | M | 1..N | List of DN performances for the application. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 1)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE 1: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +## 5.1.6.2.46 Type DnPerf + +Table 5.1.6.2.46-1: Definition of type DnPerf + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appServerInsAddr | AddrFqdn | C | 0..1 | Represents the Application Server Instance (IP address/FQDN of the Application Server). Shall be present if the "appServerAddrs" attribute was provided in the request or subscription. | | +| upfInfo | UpfInformation | C | 0..1 | Identifies the UPF. Shall be present only if the "upfInfo" attribute was provided in the request or subscription and the identified NF service consumer is not an AF or a NEF. (NOTE 1) | | +| dnai | Dnai | C | 0..1 | Indicates the DN Access Identifier representing location of the service flow. Shall be present if the "dnais" attribute was provided in the request or subscription. | | +| perfData | PerfData | M | 1 | Represents the performance data. | | +| spatialValidCon | NetworkAreaInfo | C | 0..1 | Represents the area where the DN performance analytics applies. Shall be present if "networkArea" attribute was provided in the request or subscription. (NOTE 3) | | +| temporalValidCon | TimeWindow | O | 0..1 | Represents the valid period for the DN performance analytics. (NOTE2) | | + +NOTE 1: This attribute shall not be provided if the NWDAF does not know the NF service consumer type or if the NWDAF knows that the NF service consumer is an AF or a NEF. + +NOTE 2: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "temporalValidCon" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +NOTE 3: If the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes are provided in the request, the number of TAs or cells contained in "spatialValidCon" attribute shall be smaller than or equal to the values of the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes. + +## 5.1.6.2.47 Type PerfData + +Table 5.1.6.2.47-1: Definition of type PerfData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| avgTrafficRate | BitRate | O | 0..1 | Indicates average traffic rate observed for UEs communicating with the application. | | +| maxTrafficRate | BitRate | O | 0..1 | Indicates maximum traffic rate observed for UEs communicating with the application. | | +| minTrafficRate | BitRate | O | 0..1 | Indicates minimum traffic rate observed for UEs communicating with the application.
The minimum traffic rate measurements are only derived from active traffic. | DnPerformanceEx
t_AIML | +| aggTrafficRate | BitRate | O | 0..1 | Indicates aggregated traffic rate. (NOTE) | DnPerformanceEx
t_AIML | +| varTrafficRate | Float | O | 0..1 | Indicates variance of traffic rate. (NOTE) | DnPerformanceEx
t_AIML | +| trafRateUelds | array(Supi) | O | 1..N | Identifies a UE or a list of UEs whose traffic rate is higher or lower than the threshold. Each element identifies a SUPI of an UE. The maximum number of SUPI(s) shall not exceed the subscribed "maxSupiNbr" attribute value if provided. (NOTE) | DnPerformanceEx
t_AIML | +| avePacketDelay | PacketDelBudget | O | 0..1 | Indicates average Packet Delay. | | +| maxPacketDelay | PacketDelBudget | O | 0..1 | Indicates maximum Packet Delay. | | +| varPacketDelay | Float | O | 0..1 | Indicates variance of Packet Delay. (NOTE) | DnPerformanceEx
t_AIML | +| packDelayUelds | array(Supi) | O | 1..N | Identifies a UE or a list of UEs whose packet delay is higher or lower than the threshold. Each element identifies a SUPI of an UE. The maximum number of SUPI(s) shall not exceed the subscribed "maxSupiNbr" attribute value if provided. (NOTE) | DnPerformanceEx
t_AIML | +| avgPacketLossRate | PacketLossRate | O | 0..1 | Indicates average Packet Loss Rate. | | +| maxPacketLossRate | PacketLossRate | O | 0..1 | Indicates maximum Packet Loss Rate. | DnPerformanceEx
t_AIML | +| varPacketLossRate | Float | O | 0..1 | Indicates variance of Packet Loss Rate. (NOTE) | DnPerformanceEx
t_AIML | +| packLossUelds | array(Supi) | O | 1..N | Identifies a UE or a list of UEs whose packet loss rate is higher than the threshold. Each element identifies a SUPI of an UE. The maximum number of SUPI(s) shall not exceed the subscribed "maxSupiNbr" attribute value if provided. (NOTE) | DnPerformanceEx
t_AIML | +| numOfUe | UInteger | O | 0..1 | The number of UEs for the UE group or all UEs (i.e. any UE) communicating with the application in the DNAI. | DnPerformanceEx
t_eNA | + +NOTE: If these attribute(s) is provided, the analytics target period shall be a past time period (i.e. only statistics is applicable). + +Editor's note: It is FFS whether the prediction is applicable to all the performance defined in above table. + +## 5.1.6.2.48 Type ResourceUsage + +Table 5.1.6.2.48-1: Definition of type ResourceUsage + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------------|---------------| +| cpuUsage | UInteger | O | 0..1 | Average usage of virtual CPU. (NOTE)
Minimum=0. Maximum=100. | | +| memoryUsage | UInteger | O | 0..1 | Average usage of memory. (NOTE)
Minimum=0. Maximum=100. | | +| storageUsage | UInteger | O | 0..1 | Average usage of storage. (NOTE)
Minimum=0. Maximum=100. | | + +NOTE: The values are percentages which are provided as estimated over a given period. + +## 5.1.6.2.49 Type ConsumerNfInformation + +Table 5.1.6.2.49-1: Definition of type ConsumerNfInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|--------------------------------------------------------------|---------------| +| nfId | NfInstanceId | C | 0..1 | Identifies the analytics consumer NF instance. (NOTE) | | +| nfSetId | NfSetId | C | 0..1 | Identifies the analytics consumer NF set. (NOTE) | | +| tailList | array(Tai) | C | 1..N | The list of TAls the analytics consumer NF can serve. (NOTE) | | + +NOTE: Either "tailList" or one of "nfId", "nfSetId" shall be provided. + +## 5.1.6.2.50 Type DispersionRequirement + +Table 5.1.6.2.50-1: Definition of type DispersionRequirement + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| disperType | DispersionType | M | 1 | Indicates the required dispersion analytics type. | | +| classCrits | array(ClassCriterion) | O | 1..N | Indicates the dispersion mobility class criterion for fixed, camper and/or traveller UE, and/or the top-heavy UE dispersion class criterion. | | +| rankCrits | array(RankingCriterion) | O | 1..N | Indicates the usage ranking criterion between the high, medium and low usage UE. | | +| dispOrderCriter | DispersionOrderingCriterion | O | 0..1 | Indicates the ordering criterion for the list of UE Dispersion Analytics information. | | +| order | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "dispOrderCriter" attribute is included. (NOTE) | | + +NOTE: "CROSSED" value in data type "MatchingDirection" is not applicable for the "order" attribute. + +## 5.1.6.2.51 Type ClassCriterion + +**Table 5.1.6.2.51-1: Definition of type ClassCriterion** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------|---------------| +| disperClass | DispersionClass | M | 1 | Indicates the dispersion class. | | +| classThreshold | SamplingRatio | M | 1 | Indicates the dispersion class threshold. | | +| thresMatch | MatchingDirection | M | 1 | Indicates the dispersion class threshold matching direction.
(NOTE) | | + +NOTE: "CROSSED" value in data type "MatchingDirection" is not applicable for the "thresMatch" attribute. + +## 5.1.6.2.52 Type RankingCriterion + +**Table 5.1.6.2.52-1: Definition of type RankingCriterion** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|----------------------------------------------------------|---------------| +| highBase | SamplingRatio | M | 1 | Indicates the "high" ranking bottom baseline percentage. | | +| lowBase | SamplingRatio | M | 1 | Indicates the "low" ranking top baseline percentage. | | + +NOTE: UE is ranked high (i.e. value 1), medium (2) or low (3) when its data/transactions dispersed during the period of observation at the location/slice, is higher than "highBase" attribute value, within the range between the "highBase" attribute to "lowBase" attribute value or less than "lowBase" value, respectively. + +## 5.1.6.2.53 Type DispersionInfo + +**Table 5.1.6.2.53-1: Definition of type DispersionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------|---------------| +| tsStart | DateTime | M | 1 | Indicates the timestamp when the time slot starts during the Analytics target period. | | +| tsDuration | DurationSec | M | 1 | Indicates the time slot duration.
(NOTE) | | +| disperCollects | array(DispersionCollection) | M | 1..N | Dispersion collections on UE location(s) and/or slice(s). | | +| disperType | DispersionType | M | 1 | Indicates the dispersion type.
Only applicable to DVDA or TDA value. | | + +NOTE: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "tsDuration" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +5.1.6.2.54 Type DispersionCollection + +**Table 5.1.6.2.54-1: Definition of type DispersionCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueLoc | UserLocation | C | 0..1 | TA or cells where the UE or group of UEs dispersed its transactions and/or data. Shall be present if "networkArea" attribute is included in the event subscription or analytics request. (NOTE 1) | | +| snssai | Snssai | C | 0..1 | Slice where the UE or group of UEs disperse its transactions and/or data. Shall be present if "snssais" attribute is included in the event subscription or analytics request. (NOTE 1) | | +| supis | array(Supi) | C | 1..N | Each element identifies a SUPI of an UE. May only be present if reporting inside 5GC and the event subscription or analytics request applies to more than one UE. (NOTE 2) | | +| gpsi | array(Gpsi) | C | 1..N | Each element identifies a GPSI of an UE. May only be present if reused by the Nnef_AnalyticsExposure service reporting to external AF and the event subscription or analytics request applies to more than one UE. (NOTE 2) | | +| appVolumes | array(Application Volume) | O | 1..N | Application data volumes. May be present if "appls" attribute is included in the event subscription or analytics request (NOTE 6). | | +| disperAmount | UInteger | C | 0..1 | Indicates the dispersion amount of the reported data volume or transaction dispersion type. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to DISPER_AMOUNT. (NOTE 3) | | +| disperClass | DispersionClass | C | 0..1 | Indicates the UE dispersion mobility class: fixed, camper, traveller, and/or the top-heavy dispersion class. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to DISPER_CLASS. (NOTE 3, NOTE 5). | | +| usageRank | integer | C | 0..1 | Usage ranked high (i.e. value 1), medium (2) or low (3). Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to RANKING. (NOTE 3, NOTE 6). | | +| percentileRank | SamplingRatio | C | 0..1 | Percentile ranking of the target UE in the Cumulative Distribution Function of data usage for the population of all UEs. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to PERCENTILE_RANKING. (NOTE 3, NOTE 6). | | +| ueRatio | SamplingRatio | C | 0..1 | Contains the percentage of UEs with same analytics result in the group or among all UEs. Shall be present if the analytics | | + +| | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | result applies for a group of UEs or any UE. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 4)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +| NOTE 1: One of "ueLoc" attribute or "snssai" attribute shall be provided. | | | | | | +| NOTE 2: When Target of Analytics Reporting is a UE group ID, or "Any UE" and a filter for Top-Heavy UEs, fixed, camper or traveller is included in the subscription, the NWDAF shall include the list of UEs matching the filter. This information element shall not be present when Target of Analytic Reporting is "Any UE" and no filter for Top-Heavy UEs, fixed, camper or traveller is included. | | | | | | +| NOTE 3: At least one value shall be provided. If the "listOfAnaSubsets" attribute with value only applicable to "DISPERSION" event is present in the subscription request, then only the corresponding attribute(s) shall be present. | | | | | | +| NOTE 4: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. | | | | | | +| NOTE 5: This parameter may only be provided when the Target of Analytics Reporting contains the "supis" attribute or the "gpsi" attribute in the "tgtUe" attribute. | | | | | | +| NOTE 6: This parameter shall not be provided when the "anyUe" attribute in the "tgtUe" attribute for the Target of Analytics Reporting was set to true. | | | | | | +| NOTE 7: If the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes are provided in the request, the number of TAs or cells contained in "ueLoc" attribute shall be smaller than or equal to the values of the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes. | | | | | | + +#### 5.1.6.2.55 Type ApplicationVolume + +**Table 5.1.6.2.55-1: Definition of type ApplicationVolume** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | M | 1 | Application where the UE or group of UEs disperse its transactions and/or data. May be present if "appId" attribute is included in the event subscription or analytics request. | | +| appVolume | Volume | M | 1 | Indicates the dispersion data volume per application in units of bytes. | | + +#### 5.1.6.2.56 Type RedundantTransmissionExpReq + +**Table 5.1.6.2.56-1: Definition of type RedundantTransmissionExpReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------|------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------|---------------| +| redTOrderCriter | RedTransExpOrderingCriterion | O | 0..1 | Indicates the ordering criterion for the list of UE Redundant Transmission Experience Analytics information. (NOTE 1) | | +| order | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "redTOrderCriter" attribute is included. (NOTE 1)
(NOTE 2) | | +| NOTE 1: If no attribute or no value is provided, default ordering may be applied. | | | | | | +| NOTE 2: "CROSSED" value in data type "MatchingDirection" is not applicable for the "order" attribute. | | | | | | + +## 5.1.6.2.57 Type RedundantTransmissionExpInfo + +Table 5.1.6.2.57-1: Definition of type RedundantTransmissionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| spatialValidCon | NetworkAreaInfo | C | 0..1 | Area where the Redundant Transmission Experience applies. If "networkArea" attribute was provided in the request or subscription, shall be the requested network area. | | +| dnn | Dnn | C | 0..1 | Data Network Name associated for URLLC service. Shall be present if the "dnns" attribute was provided in the request or subscription. | | +| redTransExps | array(Redundant TransmissionExp PerTS) | M | 1..N | Redundant Transmission Experiences. | | + +## 5.1.6.2.58 Type RedundantTransmissionExpPerTS + +Table 5.1.6.2.58-1: Definition of type RedundantTransmissionExpPerTS + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tsStart | DateTime | M | 1 | Indicates the timestamp when the time slot starts during the Analytics target period. | | +| tsDuration | DurationSec | M | 1 | Indicates the time slot duration. (NOTE 2) | | +| obsvRedTransExp | ObservedRedundantTransExp | M | 1 | Represents the observed Redundant Transmission Experience. | | +| redTransStatus | boolean | O | 0..1 | Redundant Transmission Status. Set to "true" if redundant transmission was activated, otherwise set to "false". Default value is "false" if omitted. | | +| ueRatio | SamplingRatio | O | 0..1 | Percentage on which UE, any UE, or UE group efficiently use the PDU session with redundant transmission. | | +| confidence | Uinteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 1)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE 1: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +NOTE 2: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "tsDuration" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +## 5.1.6.2.59 Type WlanPerformanceReq + +Table 5.1.6.2.59-1: Definition of type WlanPerformanceReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| ssids | array(string) | O | 1..N | SSIDs of WLAN access points. | | +| bssids | array(string) | O | 1..N | BSSIDs of WLAN access points. | | +| wlanOrderCriter | WlanOrderingCriterion | O | 0..1 | Indicates the ordering criterion for the list of WLAN performance information. | | +| order | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "wlanOrderCriter" attribute is included. (NOTE 1) | | + +NOTE 1: "CROSSED" value in data type "MatchingDirection" is not applicable for the "order" attribute. + +## 5.1.6.2.60 Type WlanPerformanceInfo + +Table 5.1.6.2.60-1: Definition of type WlanPerformanceInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| networkArea | NetworkAreaInfo | C | 0..1 | A list of TAIIs or Cell Ids as the Area of Interest where the WLAN performance analytics applies. Shall be present if the "networkArea" attribute is included in the event subscription or analytics request. | | +| wlanPerSsidInfos | array(WlanPerSsidPerformanceInfo) | M | 1..N | WLAN performance information for SSID(s) of WLAN access points deployed in the Area of Interest. | | +| wlanPerUeIdInfos | array(WlanPerUeIdPerformanceInfo) | O | 1..N | WLAN performance information for UE Id(s) of WLAN access points deployed in the Area of Interest. | WlanPerformanceExt_AIML | + +## 5.1.6.2.61 Type WlanPerSsidPerformanceInfo + +Table 5.1.6.2.61-1: Definition of type WlanPerSsidPerformanceInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------------|---|-------------|--------------------------------------------------------------------------------|---------------| +| ssid | string | M | 1 | SSID of WLAN access point. | | +| wlanPerTsInfos | array(WlanPerTsPerformanceInfo) | M | 1..N | WLAN performance information per Time Slot during the analytics target period. | | + +## 5.1.6.2.6.2 Type WlanPerTsPerformanceInfo + +Table 5.1.6.2.6.2-1: Definition of type WlanPerTsPerformanceInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tsStart | DateTime | M | 1 | Indicates the timestamp when the time slot starts during the Analytics target period. | | +| tsDuration | DurationSec | M | 1 | Indicates the time slot duration. (NOTE 3) | | +| rssi | integer | C | 0..1 | Indicated the RSSI in the unit of dBm.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to RSSI. (NOTE 1) | | +| rtt | UInteger | C | 0..1 | Indicates the RTT in the unit of millisecond.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to RTT. (NOTE 1) | | +| trafficInfo | TrafficInformation | C | 0..1 | Traffic information including UL/DL data rate and/or Traffic volume.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to TRAFFIC_INFO. (NOTE 1) | | +| numberOfUes | UInteger | C | 0..1 | Number of UEs observed for the SSID.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to NUMBER_OF_UES. (NOTE 1) | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 2)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE 1: At least one value shall be provided. If the "listOfAnaSubsets" attribute with value only applicable to WLAN event is present in the subscription request, then only the corresponding attribute(s) shall be present. + +NOTE 2: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +NOTE 3: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "tsDuration" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +## 5.1.6.2.6.3 Type TrafficInformation + +Table 5.1.6.2.6.3-1: Definition of type TrafficInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|----------------------------------------------------------------|---------------| +| uplinkRate | BitRate | C | 0..1 | Uplink data rate. | | +| downlinkRate | BitRate | C | 0..1 | Downlink data rate. | | +| uplinkVolume | Volume | C | 0..1 | Uplink traffic volume in unit of octet. | | +| downlinkVolume | Volume | C | 0..1 | Downlink traffic volume in unit of octet. | | +| totalVolume | Volume | C | 0..1 | Total data octets for both uplink and downlink traffic volume. | | + +NOTE: At least one of above attributes shall be present. + +## 5.1.6.2.64 Type AppListForUeComm + +Table 5.1.6.2.64-1: Definition of type AppListForUeComm + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | M | 1 | Identification of the application. | | +| startTime | DateTime | O | 0..1 | The time when the UE start to use the application. | | +| appDur | DurationSec | O | 0..1 | The length of time that the UE uses the application. | | +| occurRatio | SamplingRatio | O | 0..1 | In UE Communication Statistics, it represents the proportion of UE using the application in the requested time period.
In UE Communication Predictions, it represents the probability that the UE uses the application. | | +| spatialValidity | NetworkAreaInfo | O | 0..1 | The area where the service behavior applies.
(NOTE) | | + +NOTE: If the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes are provided in the request, the number of TAs or cells contained in "spatialValidity" attribute shall be smaller than or equal to the values of the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes. + +## 5.1.6.2.65 Type SessInactTimerForUeComm + +Table 5.1.6.2.65-1: Definition of type SessInactTimerForUeComm + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------|---|-------------|-----------------------------------------------|---------------| +| n4SessionId | PduSessionId | M | 1 | The identification of the N4 Session. | | +| sessInactiveTimer | DurationSec | M | 1 | The value of the N4 Session inactivity timer. | | + +## 5.1.6.2.66 Type DnPerformanceReq + +Table 5.1.6.2.66-1: Definition of type DnPerformanceReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------|---------------| +| dnPerfOrderCriter | DnPerfOrderingCriterion | O | 0..1 | Indicates the preferred order criterion of a list of Network Performance analytics results. | | +| order | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "dnPerfOrderCriter" attribute is included. (NOTE 1) | | +| reportThresholds | array(ThresholdLevel) | C | 1..N | Each of the element represents the reporting threshold of an analytics subset. (NOTE 2) | | + +NOTE 1: "CROSSED" value in data type "MatchingDirection" is not applicable for the "order" attribute. +NOTE 2: The value of "reportThresholds" attribute match in sequence with the properties in the "listOfAnaSubsets" attribute. This property shall only be provided if the "notifMethod" in "evtReq" is set to "ON\_EVENT\_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted. + +## 5.1.6.2.6.7 Type: RatFreqInformation + +Table 5.1.6.2.6.7-1: Definition of type RatFreqInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| allFreq | boolean | C | 0..1 | Set to "true" to indicate to handle all the frequencies the NWDAF received, set to "false" to indicate not to handle all the frequencies the NWDAF received. Default value is "false" if omitted. (NOTE 1) | | +| allRat | boolean | C | 0..1 | Set to "true" to indicate to handle all the RAT types the NWDAF received, set to "false" to indicate not to handle all the RAT types the NWDAF received. Default value is "false" if omitted. (NOTE 1) | | +| freq | ArfcnValueNR | C | 0..1 | Identification of the frequency of UE's serving cell(s) where the subscription/request applies. (NOTE 1) | | +| ratType | RatType | C | 0..1 | Identification of the RAT type where the subscription/request applies. (NOTE 1) | | +| svcExpThreshold | ThresholdLevel | C | 0..1 | Service Experience Threshold value. (NOTE 2). | | +| matchingDir | MatchingDirection | O | 0..1 | The matching direction may be provided alongside the service experience threshold. If omitted, the default value is CROSSED. | | + +NOTE 1: The "allFreq" attribute and the "freq" attribute are mutually exclusive. The "allRat" attribute and the "ratType" attribute are mutually exclusive. If both the "allFreq" attribute and the "allRat" attribute are present, then indicate all the RAT type(s) and Frequency(ies) values the NWDAF received. + +NOTE 2: Shall only be present in the subscription request as the service experience threshold value(s) for the RAT Type(s) and/or Frequency value(s) if the "notifMethod" in "evtReq" is set to "ON\_EVENT\_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted. + +## 5.1.6.2.6.8 Type PrevSubInfo + +Table 5.1.6.2.6.8-1: Definition of type PrevSubInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| producerId | NfInstanceId | C | 0..1 | NWDAF instance identifier to which the NF service consumer has established this subscription. (NOTE) | | +| producerSetId | NfSetId | C | 0..1 | NWDAF set identifier to which the NF service consumer has established this subscription. (NOTE) | | +| subscriptionId | string | M | 1 | The identifier of the specific analytics subscription. | | +| nfAnaEvents | array(NwdafEvent) | O | 1..N | List of analytics types for which NF related analytics contexts can be retrieved. | | +| ueAnaEvents | array(UeAnalyticsContextDescriptor) | O | 1..N | List of objects that indicate for which SUPI and analytics types combinations analytics context can be retrieved. | | + +NOTE: One of "producerId" or "producerSetId" attributes shall be provided. + +## 5.1.6.2.69 Type MLModelInfo + +Table 5.1.6.2.69-1: Definition of type MLModelInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mlFileAddrs | array(MLModelAddr) | O | 1..N | Addresses of ML model files. May be included only when the source NWDAF itself provides the trained ML model(s) for the analytics subscription(s) being transferred | | +| modelProvId | NfInstanceId | C | 0..1 | NF instance identifier of the ML model provider NWDAF from which the NF service consumer currently subscribes to the ML model information.
(NOTE) | | +| modelProvSetId | NfSetId | C | 0..1 | The Set ID of NWDAF(s) to which the current NWDAF subscribe the ML model.
(NOTE) | | + +NOTE: One of the "modelProvId" and "modelProvSetId" attributes shall be provided. + +### 5.1.6.2.70 Type ObservedRedundantTransExp + +#### **Table 5.1.6.2.70-1: Definition of type ObservedRedundantTransExp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| avgPktDropRateUI | PacketLossRate | C | 0..1 | Average uplink packet drop rate on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to AVG_UL_PKT_DROP_RATE. | | +| varPktDropRateUI | Float | C | 0..1 | Variance of uplink packet drop rate on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to VAR_UL_PKT_DROP_RATE. | | +| avgPktDropRateDI | PacketLossRate | C | 0..1 | Average downlink packet drop rate on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to AVG_DL_PKT_DROP_RATE. | | +| varPktDropRateDI | Float | C | 0..1 | Variance of downlink packet drop rate on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to VAR_DL_PKT_DROP_RATE. | | +| avgPktDelayUI | PacketDelBudget | C | 0..1 | Average uplink packet delay round trip on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to AVG_UL_PKT_DELAY. | | +| varPktDelayUI | Float | C | 0..1 | Variance uplink packet delay round trip on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to VAR_UL_PKT_DELAY. | | +| avgPktDelayDI | PacketDelBudget | C | 0..1 | Average downlink packet delay round trip on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to AVG_DL_PKT_DELAY. | | +| varPktDelayDI | Float | C | 0..1 | Variance downlink packet delay round trip on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to VAR_DL_PKT_DELAY. | | +| avgE2ePktDelayUI | PacketDelBudget | C | 0..1 | Indicates average End-to-End (between UE and UPF) uplink packet delay. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to AVG_E2E_UL_PKT_DELAY. | RedundantTransExp Ext_eNA | +| varE2ePktDelayUI | Float | C | 0..1 | Indicates the variance of End-to-End (between UE and UPF) uplink packet delay. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to VAR_E2E_UL_PKT_DELAY. | RedundantTransExp Ext_eNA | +| avgE2ePktDelayDI | PacketDelBudget | C | 0..1 | Indicates average End-to-End (between UE and UPF) downlink packet delay. Shall be present if one of the element in the "listOfAnaSubsets" attribute was | RedundantTransExp Ext_eNA | + +| | | | | | | +|--------------------------|----------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| | | | | set to
AVG_E2E_DL_PKT_DELAY. | | +| varE2ePktDelayDI | Float | C | 0..1 | Indicates the variance of End-to-End (between UE and UPF) downlink packet delay. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to
VAR_E2E_DL_PKT_DELAY. | RedundantTransExp
Ext_eNA | +| avgE2ePktLossRate
eUI | PacketLossRate | C | 0..1 | Indicates average End-to-End (between UE and UPF) uplink packet loss rate. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to
AVG_E2E_UL_PKT_LOSS_RATE. | RedundantTransExp
Ext_eNA | +| varE2ePktLossRate
UI | Float | C | 0..1 | Indicates the variance of End-to-End (between UE and UPF) uplink packet loss rate. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to
VAR_E2E_UL_PKT_LOSS_RATE. | RedundantTransExp
Ext_eNA | +| avgE2ePktLossRate
eDI | PacketLossRate | C | 0..1 | Indicates average End-to-End (between UE and UPF) downlink packet loss rate. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to
AVG_E2E_DL_PKT_LOSS_RATE. | RedundantTransExp
Ext_eNA | +| varE2ePktLossRate
DI | Float | C | 0..1 | Indicates the variance of End-to-End (between UE and UPF) downlink packet loss rate. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to
VAR_E2E_DL_PKT_LOSS_RATE. | RedundantTransExp
Ext_eNA | + +## 5.1.6.2.71 Type UeMobilityReq + +Table 5.1.6.2.71-1: Definition of type UeMobilityReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| orderCriterion | UeMobilityOrder Criterion | O | 0..1 | The ordering criterion for the list of UE mobility analytics. | | +| orderDirection | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending time slot start. May be present when the "orderCriterion" attribute is included. (NOTE 1) | | +| ueLocOrderInd | boolean | O | 0..1 | UE Location order indication. Set to "true" to indicate the NWDAF to provide UE locations in the UE Mobility analytics in time order, otherwise set to "false" or omitted. (NOTE 2) | | +| distThresholds | array(uinteger) | O | 1..N | Indicates the linear distance threshold, i.e. if the straight line distance that the UE moves from the previous location to the current location exceeds the threshold, the analytics needs to be reported. | UeMobilityExt2_eNA | + +NOTE 1: The "CROSSED" value in "MatchingDirection" data type is not applicable for this attribute. +NOTE 2: If this attribute was set to "true", the NWDAF does not aggregate the UE locations in a long duration but provides the UE locations one by one in their own time period, i.e. the "locInfos" contained in UeMobility data type has only one UE location which indicates the UE is located in this location in the duration from the time slot start and the location information in adjacent durations is different from each other. Otherwise, if this attribute is included and set to "false" or omitted, the multiple UE locations will be aggregated. + +Editor's Note: whether the "distThresholds" attribute is single or plural is FFS. + +## 5.1.6.2.72 Type UeCommReq + +Table 5.1.6.2.72-1: Definition of type UeCommReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------------------------------------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------|---------------| +| orderCriterion | UeCommOrder Criterion | O | 0..1 | The ordering criterion for the list of UE communication analytics. | | +| orderDirection | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "orderCriterion" attribute is included. (NOTE) | | +| NOTE: The "CROSSED" value in "MatchingDirection" data type is not applicable for this attribute. | | | | | | + +## 5.1.6.2.73 Type PfdDeterminationInfo + +Table 5.1.6.2.73-1: Definition of type PfdDeterminationInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | M | 1 | Represents a known application identifier that refers to the application detection filter. | | +| snssai | Snssai | C | 0..1 | Represents an S-NSSAI. Shall be presented if the "snssais" attribute was provided within EventSubscription in the subscription request. | | +| dnn | Dnn | C | 0..1 | Represents a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. Shall be present if the "dnns" attribute was provided within EventSubscription in the subscription request. | | +| flowDescriptions | array(string) | O | 1..N | Represents a 3-tuple with protocol, server ip and server port for UL/DL application traffic. The content of the string has the same encoding as the IPFilterRule AVP value as defined in IETF RFC 6733 [33]. (NOTE) | | +| urls | array(string) | O | 1..N | Represents a URL or a regular expression which is used to match the significant parts of the URL. (NOTE) | | +| domainNames | array(string) | O | 1..N | Represents an FQDN or a regular expression as a domain name matching criteria. (NOTE) | | +| dnProtocol | DomainNameProtocol | C | 0..1 | Represents the additional protocol and protocol field for domain names to be matched, it may only be provided when domainNames attribute is present. | | +| pfdConfidence | UInteger | O | 0..1 | Indicates the confidence on the provided PFD Determination analytics for the known Application identified by the included "appId" attribute. Minimum = 0. Maximum = 100. | | +| NOTE: At least one of the "flowDescriptions", "urls", and "domainNames" attributes shall be included. If multiple attributes are included, the PFD is only matched when every attribute contained in the PFD has a matching value. | | | | | | + +## 5.1.6.2.74 Type PduSessionInfo + +Table 5.1.6.2.74-1: Definition of type PduSessionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|---------------------------------------------|---------------| +| pduSessType | PduSessionType | O | 0..1 | Represents the PDU Session Type. | | +| sscMode | ScsMode | O | 0..1 | Represents the SSC mode of the PDU Session. | | +| accessTypes | array(AccessType) | O | 1..N | Represents the access types. | | +| NOTE: The consumer may provide one of "dnns", "snssais" (contained in EventSubscription data type), "pduSessType", "accessTypes" and "sscMode" attributes or provide a combination of these attributes. | | | | | | + +## 5.1.6.2.75 Type DirectionInfo + +Table 5.1.6.2.75-1: Definition of type DirectionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies a SUPI of a UE. (NOTE 1) | | +| gpsi | Gpsi | C | 0..1 | Identifies a GPSI of a UE. (NOTE 1) | | +| direction | Direction | M | 1 | Indicates the moving direction of the UE in the coverage area. | | +| numOfUe | UInteger | O | 0..1 | Indicate the total number of UEs in the specific direction. (NOTE 2) | | +| avrSpeed | Float | O | 0..1 | Indicate the average speed of users in the specific direction. (NOTE 2) | | +| ratio | SamplingRatio | O | 0..1 | Indicate the ratio of UEs in the specific direction. (NOTE 2) | | + +NOTE 1: The "supi" attribute and the "gpsi" attribute are mutually exclusive and one of them shall be provided by the NWDAF in the case of UE Mobility analytics. +NOTE 2: This attribute may be provided in the case of Movement Behaviour analytics. + +## 5.1.6.2.76 Type GeoDistributionInfo + +Table 5.1.6.2.76-1: Definition of type GeoDistributionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| loc | UserLocation | M | 1 | This attribute contains the detailed location, the ueLocationTimestamp attribute in the 3GPP access type of UserLocation data type shall not be provided. | | +| supis | array(Supi) | C | 1..N | Indicate SUPIs of a list of UE. Each element identifies a UE which is in the location. Shall only be included when used in the Nnwdaf service. (NOTE) | | +| gpsi | array(Gpsi) | C | 1..N | Indicate GPSIs of a list of UE. Each element identifies a UE which is in the location. Shall only be included when used in the Nnef service. (NOTE) | | + +NOTE: The "supis" attribute and the "gpsi" attribute are mutually exclusive. + +## 5.1.6.2.77 Type PduSesTrafficInfo + +Table 5.1.6.2.77-1: Definition of type PduSesTrafficInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supis | array(Supi) | C | 1..N | Each element identifies an UE.
May only be present if the subscription request applies to one or more UE(s).
(NOTE 3) | | +| dnn | Dnn | C | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only, for which analytics information is provided.
Shall be present if the DNN was provided in the request or subscription.
(NOTE 1) | | +| snssai | Snssai | C | 0..1 | Identifies the network slice information for which analytics information is provided.
Shall be present if the S-NSSAI was provided in the request or subscription.
(NOTE 1) | | +| tdMatchTraf | array(TdTraffic) | C | 1..N | Identifies traffic that matches Traffic Descriptor provided by the consumer in those PDU Sessions identified by the S-NSSAI and DNN above and the volume.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to "TRAFFIC_MATCH_TD".
(NOTE 2) | | +| tdUnmatchTraf | array(TdTraffic) | C | 1..N | Identifies traffic that does not match Traffic Descriptor provided by the consumer in those PDU Sessions identified by the S-NSSAI and DNN above and the volume.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to "TRAFFIC_UNMATCH_TD".
(NOTE 2) | | + +NOTE 1: At least one of the "dnn" and "snssai" attributes shall be provided for the PDU Session traffic statistics of the specific DNN and/or S-NSSAI. + +NOTE 2: At least one of the "tdMatchTraf" and "tdUnmatchTraf" attributes shall be provided. + +NOTE 3: When Target of Analytics Reporting is a UE group ID, or "Any UE" in the subscription, the NWDAF shall include the list of UEs matching the filter. + +## 5.1.6.2.78 Type TdTraffic + +Table 5.1.6.2.78-1: Definition of type TdTraffic + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduSesTrafReqs | array(PduSesTrafficReq) | C | 1..N | Indicates the PDU Session traffic analytics requirements. Shall be present if the "pduSesTrafReqs" attribute was provided in the request or subscription. | | +| ulVol | Volume | O | 0..1 | Indicates the UL data volume exchanged. | | +| dlVol | Volume | O | 0..1 | Indicates the DL data volume exchanged. | | +| allVol | Volume | O | 0..1 | Indicates the overall data volume exchanged. | | +| ulNumOfPkt | UInteger | O | 0..1 | Indicates the number of UL packets exchanged. | | +| dlNumOfPkt | UInteger | O | 0..1 | Indicates the number of DL packets exchanged. | | +| allNumOfPkt | UInteger | O | 0..1 | Indicates the number of overall packets exchanged. | | + +## 5.1.6.2.79 Type PduSesTrafficReq + +**Table 5.1.6.2.79-1: Definition of type PduSesTrafficReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|------------------------------------------------------------------------------------|---------------| +| flowDescs | array(FlowDescription) | C | 1..N | Indicates traffic flow filtering description(s) for IP flow(s). | | +| appId | ApplicationId | C | 0..1 | Indicates an application identifier. | | +| domainDescs | array(string) | C | 1..N | FQDN(s) or a regular expression which are used as a domain name matching criteria. | | + +NOTE: One of "flowDescs" attribute, "appId" attribute or "domainDescs" attribute shall be provided. + +## 5.1.6.2.80 Type WlanPerUedPerformanceInfo + +**Table 5.1.6.2.80-1: Definition of type WlanPerUedPerformanceInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------------|---|-------------|---------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | SUPI for a UE. | | +| wlanPerTsInfos | array(WlanPerTsPerformanceInfo) | M | 1..N | WLAN performance information per Time Slot during the analytics target period. (NOTE) | | + +NOTE: The "numberOfUes" attribute is not applicable for the WlanPerUedPerformanceInfo data type. + +## 5.1.6.2.81 Type ResourceUsageRequirement + +**Table 5.1.6.2.81-1: Definition of type ResourceUsageRequirement** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tfcDir | TrafficDirection | O | 0..1 | The traffic direction for the resource usage information.
If omitted, the value "UL_AND_DL" applies. | | +| valExp | ValueExpression | O | 0..1 | Indicates average or peak value of the resource usage for the network performance type (NOTE)
If omitted, the value "AVERAGE" applies. | | + +## 5.1.6.2.82 Type E2eDataVolTransTimeReq + +Table 5.1.6.2.82-1: Definition of type E2eDataVolTransTimeReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| criterion | E2eDataVolTransTimeCriterion | O | 0..1 | Indicates the ordering criterion for the list of E2E data volume transfer time. | | +| order | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "criterion" attribute is included.
(NOTE 1) | | +| highTransTmThr | Uinteger | O | 0..1 | Indicates the threshold of high-transfer time in unit of millisecond. If the transfer time is reached or greater than this threshold, the UEs are classified to high-transfer time.
(NOTE 2) | | +| lowTransTmThr | Uinteger | O | 0..1 | Indicates the threshold of low-transfer time in unit of millisecond. If the transfer time is reached or greater than this threshold, the UEs are classified to low-transfer time.
(NOTE 2) | | +| repeatDataTrans | Uinteger | C | 0..1 | Target number of repeating data transmissions within the Analytics target period.
(NOTE 3) | | +| tsIntervalDataTrans | DurationSec | C | 0..1 | Target time interval between data transmissions within the Analytics target period.
(NOTE 3) | | +| dataVolume | DataVolume | O | 0..1 | Data Volume UL/DL: indicates a specific data volume transmitted once from UE to AF and/or from AF to UE when subscribed event is "E2E_DATA_VOL_TRANS_TIME". | | +| maxNumberUes | Uinteger | O | 0..1 | The maximum number of UEs. | | + +NOTE 1: "CROSSED" value in data type "MatchingDirection" is not applicable for the "order" attribute. + +NOTE 2: The value of "highTransTmThr" shall not be less than the value of "lowTransTmThr". If the value of "highTransTmThr" is greater than the value of "lowTransTmThr", then the UEs between "highTransTmThr" and "lowTransTmThr" are ranking as medium-transfer time. If the value of "highTransTmThr" is equal to the value of "lowTransTmThr", then no medium-transfer time class. This property shall only be provided if the "notifMethod" in "evtReq" is set to "ON\_EVENT\_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted. + +NOTE 3: Only one of "repeatDataTrans" or "tsIntervalDataTrans" attribute may be present. + +## 5.1.6.2.83 Type E2eDataVolTransTimeInfo + +Table 5.1.6.2.83-1: Definition of type E2eDataVolTransTimeInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------|----------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| e2eDataVolTransTimes | array(E2eDataVolTransTimePerTS) | M | 1..N | List of E2E Data Volume Trans Time for the application per time slot. | | +| e2eDataVolTransTimeUeLists | array(E2eDataVolTransTimeUeList) | C | 1..N | Contains the list of UEs classified based on experience level of E2E Data Volume Transfer Time. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to "E2E_DATA_VOL_TRANS_TIME_FOR_UE_LIST". | | +| geoDistrInfos | array(GeoDistributionInfo) | O | 1..N | Indicates the geographical distribution of the UEs per location information | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE: If the requested period identified by the "tsStart" and "tsDuration" attributes in the "e2eDataVolTransTimes" type leads to future time period, then the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +## 5.1.6.2.84 Type E2eDataVolTransTimePerTS + +Table 5.1.6.2.84-1: Definition of type E2eDataVolTransTimePerTS + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|---------------------------------|---|-------------|---------------------------------------------------------------------------------------|---------------| +| tsStart | DateTime | M | 1 | Indicates the timestamp when the time slot starts during the Analytics target period. | | +| tsDuration | DurationSec | M | 1 | Indicates the time slot duration of Analytics target period. | | +| e2eDataVolTransTimePerUe | array(E2eDataVolTransTimePerUe) | M | 1..N | Represents the E2E data volume transfer time per UE. | | + +## 5.1.6.2.85 Type DataVolume + +Table 5.1.6.2.85-1: Definition of type DataVolume + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------|---------------| +| uplinkVolume | Volume | C | 0..1 | Uplink traffic volume in unit of octet. | | +| downlinkVolume | Volume | C | 0..1 | Downlink traffic volume in unit of octet. | | + +NOTE: At least one of above attributes shall be present. + +## 5.1.6.2.86 Type E2eDataVolTransTimePerUe + +Table 5.1.6.2.86-1: Definition of type E2eDataVolTransTimePerUe + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | C | 0..1 | Indicates an application identifier. Shall be present if the "appId" attribute was provided in the request or subscription. | | +| ueLoc | UserLocation | C | 0..1 | TA or cells where the UE dispersed its transactions and/or data. Shall be present if "networkArea" attribute is included in the event subscription or analytics request. | | +| snssai | Snssai | C | 0..1 | Slice where the UE disperse its transactions and/or data. Shall be present if "snssais" attribute is included in the event subscription or analytics request. | | +| supi | Supi | C | 0..1 | Identifies the SUPI of an UE. May only be present if reporting inside 5GC. | | +| gpsi | Gpsi | C | 0..1 | Identifies the GPSI of an UE. May only be present if reused by the Nnef_AnalyticsExposure service reporting to external AF. | | +| dnn | Dnn | C | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. Shall be present if the "dnn" was provided in the request or subscription. | | +| dnai | Dnai | C | 0..1 | Indicates the DN Access Identifier representing location of the service flow. Shall be present if the "dnais" attribute was provided in the request or subscription. | | +| spatialValid | NetworkAreaInfo | C | 0..1 | Represents the area where the End to End data transfer volume transfer time analytics applies. Shall be present if "networkArea" attribute was provided in the request or subscription. | | +| temporalValidC
on | TimeWindow | O | 0..1 | Represents the valid period for the End to End data transfer volume transfer time analytics. | | +| dataVolTransTi
me | DataVolumeTransferTime | O | 0..1 | Indicates the E2E data volume transfer time and the data volume used to derive the transfer time. | | + +## 5.1.6.2.87 Type E2eDataVolTransTimeUeList + +Table 5.2.6.2.87-1: Definition of type E2eDataVolTransTimeUeList + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| highLevel | array(Supi) | C | 1..N | A list of UEs whose transfer time has reached or greater than the threshold of high level. This attribute may be present if the event subscription includes threshold for high level.
(NOTE) | | +| mediumLevel | array(Supi) | C | 1..N | A list of UEs whose transfer time is within the threshold range of medium level. This attribute may be present if the value of "highTransTmThr" is greater than the value of "lowTransTmThr".
(NOTE) | | +| lowLevel | array(Supi) | C | 1..N | A list of UEs whose transfer time has reached or lower than the threshold of low level. This attribute may be present if the event subscription includes threshold for low level.
(NOTE) | | +| highRatio | SamplingRatio | C | 0..1 | This attribute contains ratio of UEs per E2E data volume transfer time for high level class. Shall be present if the analytics result applies for a group of UEs. | | +| mediumRatio | SamplingRatio | C | 0..1 | This attribute contains ratio of UEs per E2E data volume transfer time for medium level class. Shall be present if the analytics result applies for a group of UEs. | | +| lowRatio | SamplingRatio | C | 0..1 | This attribute contains ratio of UEs per E2E data volume transfer for low level time class. Shall be present if the analytics result applies for a group of UEs. | | +| spatialValidity | NetworkAreaInfo | C | 0..1 | Represents the area where the Classified E2E data volume transfer times for a list of UEs analytics applies. Shall be present if "networkArea" attribute was provided in the request or subscription. | | +| validityPeriod | TimeWindow | O | 0..1 | Represents the validity period for the Classified E2E data volume transfer times for a list of UEs statistics. | | + +NOTE: At least one of "highLevel", "mediumLevel" or "lowLevel" shall be provided. + +## 5.1.6.2.88 Type AccuracyReq + +Table 5.1.6.2.88-1: Definition of type AccuracyReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| accuTimeWin | TimeWindow | O | 0..1 | Indicates the time interval. Only the accuracy information which is generated within this time interval will be considered by the consumer. | | +| accuPeriod | DurationSec | O | 0..1 | The time period for reporting the accuracy information. | | +| accuDevThr | UInteger | O | 0..1 | The reporting threshold of deviation value.
Minimum = 0. Maximum = 100. | | +| minNum | UInteger | O | 0..1 | The minimal number of analytics output provided by NWDAF that have to be considered in the determination of the accuracy information. | | +| updatedAnaFlg | boolean | O | 0..1 | Indicates the updated Analytics flag.
Set to "true" indicates that the NWDAF can provide the updated analytics if the analytics can be generated within the analytics accuracy information time window, which is specified by "accuTimeWin" attribute. Otherwise set to "false". Default value is "false" if omitted. | | +| correctionInterval | DurationSec | O | 0..1 | The relative time interval with respect to the time when the analytics is provided. It indicates the time interval during which the updated analytics can be accepted by the analytics consumer. | | + +## 5.1.6.2.89 Type AccuracyInfo + +Table 5.1.6.2.89-1: Definition of type AccuracyInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| accuracyVal | UInteger | C | 0..1 | The accuracy value.
Indicates percentage number of correct predictions out of all predictions. Minimum = 0. Maximum = 100.
Shall be present if the "accuracyReq" attribute is included in the request.
(NOTE) | | +| accuSampleNbr | UInteger | C | 0..1 | Indicates the analytics accuracy checking sampling number. | | +| anaAccuInd | AnalyticsAccuracyIndication | C | 0..1 | Indicates whether the accuracy value meet the analytics accuracy requirement or not, if not meet may also indicate the related action. Shall be present if the "accuracyReq" attribute is included in the request. | | + +NOTE: The NWDAF containing AnLF determines whether the prediction is correct one is up to implementation. + +## 5.1.6.2.90 Type DataVolumeTransferTime + +Table 5.1.6.2.90-1: Definition of type DataVolumeTransferTime + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------|---------------| +| uplinkVolume | Volume | O | 0..1 | Uplink traffic volume in unit of octet. | | +| avgTransTimeUI | Uinteger | O | 0..1 | The average time of E2E uplink data volume transfer in unit of millisecond. | | +| varTransTimeUI | Float | O | 0..1 | The E2E uplink data volume transfer time variance. | | +| downlinkVolume | Volume | O | 0..1 | Downlink traffic volume in unit of octet. | | +| avgTransTimeDI | Uinteger | O | 0..1 | The average time of E2E downlink data volume transfer in unit of millisecond. | | +| varTransTimeDI | Float | O | 0..1 | The E2E downlink data volume transfer time variance. | | + +## 5.1.6.2.91 Type MovBehavReq + +Table 5.1.6.2.91-1: Definition of type MovBehavReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------------|---|-------------|---------------------------------------------------------------------------------|---------------| +| locationGranReq | LocInfoGranularity | O | 0..1 | Indicates the preferred granularity of location information requirement. (NOTE) | | +| reportThresholds | ThresholdLevel | O | 0..1 | Threshold level of speed. | | + +NOTE: Only applicable to the "LON\_AND\_LAT\_LEVEL" value within the "locationGranReq" attribute. + +## 5.1.6.2.92 Type MovBehavInfo + +Table 5.1.6.2.92-1: Definition of type MovBehavInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| geoLoc | GeographicalCoordinates | C | 0..1 | This attribute contains the geographical location (longitude and latitude level). Shall be provided when the "locationGranReq" attribute value "LON_AND_LAT_LEVEL" is subscribed or requested. | | +| movBehavs | array(MovBehav) | O | 1..N | The Movement Behaviour information per time slot. | | +| confidence | Uinteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, then the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWD AF shall return a zero confidence. + +## 5.1.6.2.93 Type MovBehav + +Table 5.1.6.2.93-1: Definition of type MovBehav + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tsStart | DateTime | M | 1 | Indicates the timestamp when the time slot starts during the Analytics target period. | | +| tsDuration | DurationSec | M | 1 | Indicates the time slot duration. | | +| numOfUe | Uinteger | C | 0..1 | Indicate the total number of users in the area of interest.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "NUM_OF_UE". | | +| ratio | SamplingRatio | C | 0..1 | Ratio of moving users in the area of interest.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "MOV_UE_RATIO". | | +| avrSpeed | Float | C | 0..1 | Average speed of all users in the area of interest, expressed in kilometres per hour.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "AVR_SPEED". | | +| speedThresInfos | array(SpeedThresholdInfo) | C | 1..N | UEs information in the area of interest whose speed is faster than the speed threshold.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "SPEED_THRESHOLD". | | +| directionUeInfos | array(DirectionInfo) | C | 1..N | Heading directions information of the UE flow in the area of interest.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "MOV_UE_DIRECTION". | | + +## 5.1.6.2.94 Type SpeedThresholdInfo + +Table 5.1.6.2.94-1: Definition of type SpeedThresholdInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------|---------------| +| numOfUe | Uinteger | O | 0..1 | Indicate the number of UEs whose speed is faster than the speed threshold. | | +| ratio | SamplingRatio | O | 0..1 | Indicate the percentage of UEs whose speed is faster than the speed threshold. | | + +## 5.1.6.2.95 Type GeoLocation + +Table 5.1.6.2.95-1: Definition of type GeoLocation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------------------------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------|---------------| +| point | Point | C | 0..1 | Horizontal location using geographical coordinates. (NOTE) | | +| pointAlt | PointAltitude | C | 0..1 | Horizontal and vertical location using geographical coordinates. (NOTE) | | +| refPoint | LocalOrigin | C | 0..1 | Reference point for the case of local co-ordinates. (NOTE) | | +| localCoords | RelativeCartesianLocation | C | 0..1 | Local co-ordinates representing horizontal and optionally also vertical distances from a reference point. (NOTE) | | +| NOTE: One of "point", "pointAlt" attribute, or the combination of "refPoint" and "localCoords" attributes shall be provided. | | | | | | + +## 5.1.6.2.96 Type LocAccuracyReq + +Table 5.1.6.2.96-1: Definition of type LocAccuracyReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| accThres | UInteger | O | 0..1 | The accuracy (percentage) threshold. The NWDAF is requested to report the location accuracy analytics when this threshold is crossed in the direction(s) indicated by the "accThresMatchDir" attribute.
Minimum = 1
Maximum = 100 | | +| accThresMatchDir | MatchingDirection | O | 0..1 | Matching direction for the accuracy threshold. It may only be provided if the "accThres" attribute is provided. | | +| inOutThres | UInteger | O | 0..1 | Contains the threshold for the percentage of UEs that are indoors. It may only be provided in the subscription for a network area. The NWDAF is requested to report the location accuracy analytics when this threshold is crossed in the direction(s) indicated by the "inOutThresMatchDir" attribute.
Minimum = 1
Maximum = 100
(NOTE) | | +| inOutThresMatchDir | MatchingDirection | O | 0..1 | Matching direction for the indoor/outdoor UEs percentage threshold. It may only be provided if the "inOutThres" attribute is provided.
(NOTE) | | +| posMethod | PositioningMethod | O | 1..N | List of used positioning methods for which the NF service consumer wants to receive analytics. | | + +NOTE: The attributes "inOutThres" and "inOutThresMatchDir" can be used to express the threshold and matching direction for the percentage of UEs that are outdoors since the percentage of outdoor UEs is equal to 100 minus the percentage of indoor UEs. + +## 5.1.6.2.97 Type LocAccuracyInfo + +Table 5.1.6.2.97-1: Definition of type LocAccuracyInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| locAccPerMeths | array(LocAccuracyPerMethod) | M | 1..N | Location accuracy information per positioning method. | | +| inOutUePct | UInteger | C | 0..1 | Contains the percentage of UEs that are indoors in the applicable area.
It shall be provided if the subscription was targeting a network area and the "IN_OUT_PERCENT" analytics subset was requested.
Minimum value = 0
Maximum value = 100
(NOTE 1)(NOTE 2) | | +| inOutInd | boolean | C | 0..1 | Indicates if the target location is indoors or outdoors. "true" means that the target location is indoors, while "false" means that the target location is outdoors. The default value is "false".
It shall be provided if the subscription was targeting a specific location and the "IN_OUT_PERCENT" analytics subset was requested.
(NOTE 1) | | + +NOTE: 1 The attributes "inOutUePct" and "inOutInd" are mutually exclusive. +NOTE: 2 The percentage of UEs that are outdoors in the applicable area is equal to 100 minus the value of the "inOutUePct" attribute. + +## 5.1.6.2.98 Type LocAccuracyPerMethod + +Table 5.1.6.2.98-1: Definition of type LocAccuracyPerMethod + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| posMethod | PositioningMethod | M | 1 | The used positioning method. | | +| locAcc | UInteger | M | 1 | Location accuracy (percentage) for the given positioning method in the applicable area or location.
Minimum value = 0
Maximum value = 100 | | +| losNlosPct | UInteger | O | 0..1 | Percentage of the LOS measurements among the measurements performed using this positioning method.
Minimum value = 0
Maximum value = 100
(NOTE) | | + +NOTE: The percentage of the NLOS measurements is equal to 100 minus the value of the "losNlosPct" attribute. + +## 5.1.6.2.99 Type RelProxReq + +Table 5.1.6.2.99-1: Definition of type RelProxReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|---------------------------------------------------------------------------------|---------------| +| direction | array(Direction) | O | 1..N | Indicates individual or set of direction(s) of interest. | | +| numOfUe | UInteger | O | 0..1 | Indicates the number of UEs for which one UE may report proximity information. | | +| proximityCrits | array(ProximityCriterion) | O | 1..N | One or several criteria to be considered when computing the relative proximity. | | + +## 5.1.6.2.100 Type RelProxInfo + +Table 5.1.6.2.100-1: Definition of type RelProxInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tsStart | DateTime | M | 1 | Indicates the timestamp when the time slot starts during the Analytics target period. | | +| tsDuration | DurationSec | M | 1 | Indicates the time slot duration. | | +| supis | array(Supi) | C | 1..N | Identifies the UE(s) to which the proximity information applies. If omitted, the information applies to all the target UE(s) that were indicated in the subscription/request. If provided, it shall be a subset of the target UE(s) that were indicated in the subscription/request. | | +| gpsis | array(Gpsi) | C | 1..N | Identifies the UE(s) to which the proximity information applies. If omitted, the information applies to all the target UE(s) that were indicated in the subscription/request. If provided, it shall be a subset of the target UE(s) that were indicated in the subscription/request. Not applicable for this API. | | +| ueProximities | array(UeProximity) | M | 1..N | Observed or Predicted proximity information. | | +| ttlInfo | TimeToCollisionInfo | C | 0..1 | Time To Collision (TTC) information. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "TIME_TO_COLLISION" and the analytics result is a prediction. | | + +## 5.1.6.2.101 Type UeProximity + +Table 5.1.6.2.101-1: Definition of type UeProximity + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueDistance | integer | O | 0..1 | Distance between two UEs, in centimeters. | | +| ueVelocity | VelocityEstimate | O | 0..1 | UE velocity.
May be present if one of the elements in the "proximityCrits" attribute was set to VELOCITY. | | +| avrSpeed | Float | O | 0..1 | Average speed of the users which this proximity information applies to, expressed in kilometres per hour.
May be present if one of the elements in the "proximityCrits" attribute was set to AVG_SPD. | | +| locOrientation | LocationOrientation | O | 0..1 | Indicates the preferred orientation of location information.
May be present if one of the elements in the "proximityCrits" attribute was set to ORIENTATION. | | +| ueTrajectories | array(UeTrajectory) | O | 1..N | Indicates timestamped UE positions.
May be present if one of the elements in the "proximityCrits" attribute was set to TRAJECTORY. | | +| ratio | SamplingRatio | O | 0..1 | Indicate ratio of UEs accounted based on proximity criteria. | | + +## 5.1.6.2.102 Type UeTrajectory + +Table 5.1.6.2.102-1: Definition of type UeTrajectory + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies a SUPI of a UE for which this trajectory applies.
(NOTE) | | +| gpsi | Gpsi | C | 0..1 | Identifies a GPSI of a UE for which this trajectory applies.
Not applicable for this API.
(NOTE) | | +| timestampedLocs | array(TimestampedLoc) | M | 1..N | The timestamped locations of the trajectory of the UE. | | +| NOTE: One of "supi" or "gpsi" attributes shall be provided. | | | | | | + +## 5.1.6.2.103 Type TimestampedLocation + +Table 5.1.6.2.103-1: Definition of type TimestampedLocation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------|---------------| +| ts | DateTime | M | 1 | Time stamp for the UE location. | | +| locInfo | LocationInfo | M | 1 | This attribute includes the UE location information at the time indicated by "ts" attribute. | | + +## 5.1.6.2.104 Type TimeToCollisionInfo + +Table 5.1.6.2.104-1: Definition of type TimeToCollisionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| +| ttc | DateTime | O | 0..1 | Time until the predicted collision between UEs to which the proximity information applies. | | +| accuracy | UInteger | O | 0..1 | Accuracy of TTC (dependent on both the UE location accuracy and confidence of the prediction).
Minimum = 0. Maximum = 100. | | +| confidence | UInteger | O | 0..1 | Indicates the confidence of the prediction. (NOTE)
Minimum = 0. Maximum = 100. | | + +NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, then the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +## 5.1.6.2.105 Type AnalyticsFeedbackInfo + +Table 5.1.6.2.105-1: Definition of type AnalyticsFeedbackInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| actionTimes | array(DateTime) | M | 1..N | The time(s) at which the NF service consumer took an action(s) influenced by the previously provided analytics, which may or may not affect the ground truth data corresponding to the subscribed analytics event at the time which the prediction refers to, and consequently affect the ML Model accuracy monitoring. | | +| usedAnaTypes | array(NwdaEvent) | O | 1..N | List of analytics types that were used for taking the action(s). | | +| impactInd | boolean | O | 0..1 | If provided and set to "true", it indicates that the action taken by the NF service consumer impacts the ground truth data.
If provided and set to "false", it indicates that the action taken by the NF service consumer does not impact the ground truth data.
If omitted, there is no information about the action having an impact on the ground truth data or not. | | + +## 5.1.6.2.106 Type RoamingInfo + +**Table 5.1.6.2.106-1: Definition of type RoamingInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| plmnId | PlmnIdNid | O | 0..1 | Identifier of the HPLMN (if the analytics are requested by an NF service consumer in the VPLMN) or the VPLMN (if the analytics are requested by an NF service consumer in the HPLMN). | | +| aois | array(GeographicalArea) | O | 1..N | Area of Interest for the analytics in the HPLMN (if the analytics are requested by an NF service consumer in the VPLMN) or the VPLMN (if the analytics are requested by an NF service consumer in the HPLMN). | | +| servingNfIds | array(NfInstanceId) | O | 1..N | NF ID(s) of the NF(s) serving the roaming UE(s) in the VPLMN. | | +| servingNfSetIds | array(NfSetId) | O | 1..N | NF Set ID(s) of the NF Set(s) serving the roaming UE(s) in the VPLMN. | | + +## 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 | +|----------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------|---------------| +| AnySlice | boolean | "false" represents not applicable for all slices.
"true" represents applicable for all slices. | | +| LoadLevelInformation | integer | Load level information of the network slice and the optionally associated network slice instance.
Minimum = 0. Maximum = 100. | | + +## 5.1.6.3.3 Enumeration: NotificationMethod + +**Table 5.1.6.3.3-1: Enumeration NotificationMethod** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| PERIODIC | The subscription of NWDAF Event is periodically. The periodic of the notification is identified by repetitionPeriod defined in clause 5.1.6.2.3. | | +| THRESHOLD | The subscription of NWDAF Event is upon threshold exceeded. | | + +## 5.1.6.3.4 Enumeration: NwdafEvent + +**Table 5.1.6.3.4-1: Enumeration NwdafEvent** + +| Enumeration value | Description | Applicability | +|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| NF_LOAD | Indicates that the event subscribed is NF Load. | NfLoad | +| QOS_SUSTAINABILITY | Indicates that the event subscribed is QoS sustainability. | QoSustainability | +| SLICE_LOAD_LEVEL | Indicates that the event subscribed is load level information of Network Slice | | +| SERVICE_EXPERIENCE | Indicates that the event subscribed is service experience. | ServiceExperience | +| UE_MOBILITY | Indicates that the event subscribed is UE mobility information. | UeMobility | +| UE_COMM | Indicates that the event subscribed is UE communication information. | UeCommunication | +| ABNORMAL_BEHAVIOUR | Indicates that the event subscribed is abnormal behaviour information. | AbnormalBehaviour | +| USER_DATA_CONGESTION | Indicates that the event subscribed is user data congestion information | UserDataCongestion | +| NETWORK_PERFORMANCE | Indicates that the event subscribed is network performance information | NetworkPerformance | +| NSI_LOAD_LEVEL | Indicates that the event subscribed is load level information of Network Slice and the optionally associated Network Slice Instance | NsiLoad | +| DISPERSION | Indicates that the event subscribed is dispersion information. | Dispersion | +| RED_TRANS_EXP | Indicates that the event subscribed is redundant transmission experience. | RedundantTransmissionExp | +| WLAN_PERFORMANCE | Indicates that the event subscribed is WLAN performance. | WlanPerformance | +| DN_PERFORMANCE | Indicates that the event subscribed is DN performance information. | DnPerformance | +| E2E_DATA_VOL_TRANS_TIME | Indicates that the event subscribed is E2E data volume transfer time | E2eDataVolTransTime | +| SM_CONGESTION | Indicates that the event subscribed is the Session Management Congestion Control Experience information for specific DNN and/or S-NSSAI. | SMCCE | +| PFD_DETERMINATION | Indicates that the event subscribed is the PFD Determination information for known application identifier(s). | PfdDetermination | +| PDU_SESSION_TRAFFIC | Indicates that the event subscribed is the PDU Session traffic information. | PduSesTraffic | +| MOVEMENT_BEHAVIOUR | Indicates that the event subscribed is the Movement Behaviour information. | MovementBehaviour | +| LOC_ACCURACY | Indicates that the event subscribed is the Location Accuracy information. | LocAccuracy | +| RELATIVE_PROXIMITY | Indicates that the event subscribed is the Relative Proximity information. | RelativeProximity | + +## 5.1.6.3.5 Enumeration: Accuracy + +**Table 5.1.6.3.5-1: Enumeration Accuracy** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------|---------------| +| LOW | Low accuracy. | | +| MEDIUM | Medium accuracy. | ENAEExt | +| HIGH | High accuracy. | | +| HIGHEST | Highest accuracy. | ENAEExt | + +## 5.1.6.3.6 Enumeration: ExceptionId + +**Table 5.1.6.3.6-1: Enumeration ExceptionId** + +| Enumeration value | Description | Applicability | +|--------------------------------|----------------------------------------|---------------| +| UNEXPECTED_UE_LOCATION | Unexpected UE location | | +| UNEXPECTED_LONG_LIVE_FLOW | Unexpected long-live rate flows | | +| UNEXPECTED_LARGE_RATE_FLOW | Unexpected large rate flows | | +| UNEXPECTED_WAKEUP | Unexpected wakeup | | +| SUSPICION_OF_DDOS_ATTACK | Suspicion of DDoS attack | | +| WRONG_DESTINATION_ADDRESS | Wrong destination address | | +| TOO_FREQUENT_SERVICE_ACCESS | Too frequent Service Access | | +| UNEXPECTED_RADIO_LINK_FAILURES | Unexpected radio link failures | | +| PING_PONG_ACROSS_CELLS | Ping-ponging across neighbouring cells | | + +## 5.1.6.3.7 Enumeration: ExceptionTrend + +**Table 5.1.6.3.7-1: Enumeration ExceptionTrend** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------|---------------| +| UP | Up trend of the exception level. | | +| DOWN | Down trend of the exception level. | | +| UNKNOWN | Unknown trend of the exception level. | | +| STABLE | Stable trend of the exception level. | | + +## 5.1.6.3.8 Enumeration: CongestionType + +**Table 5.1.6.3.8-1: Enumeration CongestionType** + +| Enumeration value | Description | Applicability | +|------------------------|----------------------------------------------------------------|---------------| +| USER_PLANE | The congestion analytics type is User Plane. | | +| CONTROL_PLANE | The congestion analytics type is Control Plane. | | +| USER_AND_CONTROL_PLANE | The congestion analytics type is User Plane and Control Plane. | | + +## 5.1.6.3.9 Enumeration: TimeUnit + +**Table 5.1.6.3.9-1: Enumeration TimeUnit** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------|---------------| +| MINUTE | Time unit is per minute. | | +| HOUR | Time unit is per hour. | | +| DAY | Time unit is per day. | | + +## 5.1.6.3.10 Enumeration: NetworkPerfType + +Table 5.1.6.3.10-1: Enumeration NetworkPerfType + +| Enumeration value | Description | Applicability | +|--------------------------------------|--------------------------------------------------------------------------------------------|-----------------------------| +| GNB_ACTIVE_RATIO | Indicates the ratio of gNB active (i.e. up and running) number to the total number of gNB. | | +| GNB_COMPUTING_USAGE | Indicates gNodeB computing resource usage. | | +| GNB_MEMORY_USAGE | Indicates gNodeB memory usage. | | +| GNB_DISK_USAGE | Indicates gNodeB disk usage. | | +| GNB_RSC_USAGE_OVERALL_TRAFFIC | The gNB resource usage. | NetworkPerformanceExt_AIM L | +| GNB_RSC_USAGE_GBR_TRAFFIC | The gNB resource usage for GBR traffic. | NetworkPerformanceExt_AIM L | +| GNB_RSC_USAGE_DELAY_CRIT_GBR_TRAFFIC | The gNB resource usage for Delay-critical GBR traffic. | NetworkPerformanceExt_AIM L | +| NUM_OF_UE | Indicates number of UEs. | | +| SESS_SUCC_RATIO | Indicates ratio of successful setup of PDU sessions to total PDU session setup attempts. | | +| HO_SUCC_RATIO | Indicates Ratio of successful handovers to the total handover attempts. | | + +## 5.1.6.3.11 Enumeration: ExpectedAnalyticsType + +Table 5.1.6.3.11-1: Enumeration ExpectedAnalyticsType + +| Enumeration value | Description | Applicability | +|---------------------|--------------------------------------------------------------------------------------------------|---------------| +| MOBILITY | Mobility related abnormal behaviour analytics is expected by the consumer | | +| COMMUN | Communication related abnormal behaviour analytics is expected by the consumer | | +| MOBILITY_AND_COMMUN | Both mobility and communication related abnormal behaviour analytics is expected by the consumer | | + +## 5.1.6.3.12 Enumeration: MatchingDirection + +Table 5.1.6.3.12-1: Enumeration MatchingDirection + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------|---------------| +| ASCENDING | Threshold is crossed in ascending direction. | | +| DESCENDING | Threshold is crossed in descending direction. | | +| CROSSED | Threshold is crossed either in ascending or descending direction. | | + +## 5.1.6.3.13 Enumeration: NwdaFailureCode + +**Table 5.1.6.3.13-1: Enumeration NwdaFailureCode** + +| Enumeration value | Description | Applicability | +|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| UNAVAILABLE_DATA | Indicates the requested statistics information for the event is rejected since necessary data to perform the service is unavailable. | | +| BOTH_STAT_PRED_NOT_ALLOWED | Indicates the requested analysis information for the event is rejected since the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics. | | +| PREDICTION_NOT_ALLOWED | Indicates that the request for the prediction of the analytics event is not allowed. | PredictionError | +| UNSATISFIED_REQUESTED_ANALYTICS_TIME | Indicates that the requested event is rejected since the analytics information is not ready when the time indicated by the "timeAnaNeeded" attribute (as provided during the creation or modification of subscription) is reached. | EneNA | +| OTHER | Indicates the requested analysis information for the event is rejected due to other reasons. | | + +## 5.1.6.3.14 Enumeration: AnalyticsMetadata + +**Table 5.1.6.3.14-1: Enumeration AnalyticsMetadata** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------------------|---------------| +| NUM_OF_SAMPLES | Number of data samples used for the generation of the output analytics. | | +| DATA_WINDOW | Data time window of the data samples. | | +| DATA_STAT_PROPS | Dataset statistical properties of the data used to generate the analytics. | | +| STRATEGY | Output strategy used for the reporting of the analytics. | | +| ACCURACY | Level of accuracy reached for the analytics. | | + +## 5.1.6.3.15 Enumeration: DatasetStatisticalProperty + +**Table 5.1.6.3.15-1: Enumeration DatasetStatisticalProperty** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------|---------------| +| UNIFORM_DIST_DATA | Indicates the use of data samples that are uniformly distributed according to the different aspects of the requested analytics. | | +| NO_OUTLIERS | Indicates that the data samples shall disregard data samples that are at the extreme boundaries of the value range. | | + +## 5.1.6.3.16 Enumeration: OutputStrategy + +**Table 5.1.6.3.16-1: Enumeration OutputStrategy** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| BINARY | Indicates that the analytics shall only be reported when the requested level of accuracy is reached within a cycle of periodic notification as defined in the analytics reporting information (i.e. in the ReportingInformation data type or the EventSubscription data type). | | +| GRADIENT | Indicates that the analytics shall be reported according with the periodicity defined in the analytics reporting information (i.e. in the ReportingInformation data type or the EventSubscription data type) irrespective of whether the requested level of accuracy has been reached or not. | | + +## 5.1.6.3.17 Enumeration: TransferRequestType + +**Table 5.1.6.3.17-1: Enumeration TransferRequestType** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------------------|---------------| +| PREPARE | Indicates that the request is for analytics subscription transfer preparation. | | +| TRANSFER | Indicates that the request is for analytics subscription transfer execution. | | + +5.1.6.3.18 Enumeration: AnalyticsSubset + +**Table 5.1.6.3.18-1: AnalyticsSubset** + +| Enumeration value | Description | Applicability | +|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| NUM_OF_UE_REG | The number of UE registered. This value is only applicable to NSI_LOAD_LEVEL event. | | +| NUM_OF_PDU_SESS_ESTBL | The number of PDU sessions established. This value is only applicable to NSI_LOAD_LEVEL event. | | +| RES_USAGE | The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance. This value is only applicable to NSI_LOAD_LEVEL event. | | +| NUM_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR | The number of times the resource usage threshold of the network slice instance is reached or exceeded if a threshold value is provided by the consumer. This value is only applicable to NSI_LOAD_LEVEL event. | | +| PERIOD_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR | The time interval between each time the threshold being met or exceeded on the network slice (instance). This value is only applicable to NSI_LOAD_LEVEL event. | | +| EXCEED_LOAD_LEVEL_THR_IND | Whether the Load Level Threshold is met or exceeded by the statistics value. This value is only applicable to NSI_LOAD_LEVEL event. | | +| LIST_OF_TOP_APP_UL | The list of applications that contribute the most to the traffic in the UL direction. This value is only applicable to USER_DATA_CONGESTION event. | | +| LIST_OF_TOP_APP_DL | The list of applications that contribute the most to the traffic in the DL direction. This value is only applicable to USER_DATA_CONGESTION event. | | +| NF_STATUS | The availability status of the NF on the Analytics target period, expressed as a percentage of time per status value (registered, suspended, undiscoverable). This value is only applicable to NF_LOAD event. | | +| NF_RESOURCE_USAGE | The average usage of assigned resources (CPU, memory, storage). This value is only applicable to NF_LOAD event. | | +| NF_LOAD | The average load of the NF instance over the Analytics target period. This value is only applicable to NF_LOAD event. | | +| NF_PEAK_LOAD | The maximum load of the NF instance over the Analytics target period. This value is only applicable to NF_LOAD event. | | +| NF_LOAD_AVG_IN_AOI | The average load of the NF instances over the area of interest. This value is only applicable to NF_LOAD event. | | +| DISPER_AMOUNT | Indicates the dispersion amount of the reported data volume or transaction dispersion type. This value is only applicable to DISPERSION event. | | +| DISPER_CLASS | Indicates the dispersion mobility class (fixed, camper or traveller) upon set its usage threshold, and/or the top-heavy class upon set its percentile rating threshold. This value is only applicable to DISPERSION event. | | +| RANKING | Data/transaction usage ranked high (i.e. value 1), medium (2) or low (3). This value is only applicable to DISPERSION event. | | +| PERCENTILE_RANKING | Percentile ranking of the target UE in the Cumulative Distribution Function of data usage for the population of all UEs. This value is only applicable to DISPERSION event. | | +| RSSI | Indicated the RSSI in the unit of dBm. This value is only applicable to WLAN_PERFORMANCE event. | | +| RTT | Indicates the RTT in the unit of millisecond. This value is only applicable to WLAN_PERFORMANCE event. | | +| TRAFFIC_INFO | Traffic information including UL/DL data rate and/or Traffic volume. This value is only applicable to WLAN_PERFORMANCE event. | | +| NUMBER_OF_UES | Number of UEs observed for the SSID. This value is only applicable to WLAN_PERFORMANCE event. | | +| APP_LIST_FOR_UE_COMM | The analytics of the application list used by UE. This value is only applicable to UE_COMM event. | | +| N4_SESS_INACT_TIMER_FOR_UE_COMM | The N4 Session inactivity timer. This value is only applicable to UE_COMM event. | | +| AVG_TRAFFIC_RATE | Indicates average traffic rate. This value is only applicable to DN_PERFORMANCE event. | | +| MAX_TRAFFIC_RATE | Indicates maximum traffic rate. This value is only applicable to DN_PERFORMANCE event. | | +| AGG_TRAFFIC_RATE | Indicates aggregated traffic rate. This value is only applicable to DN_PERFORMANCE event. | DnPerformanceExt_AIML | + +| | | | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| VAR_TRAFFIC_RATE | Indicates variance of traffic rate. This value is only applicable to DN_PERFORMANCE event. | DnPerformanceExt_AIML | +| AVG_PACKET_DELAY | Indicates average Packet Delay. This value is only applicable to DN_PERFORMANCE event. | | +| MAX_PACKET_DELAY | Indicates maximum Packet Delay. This value is only applicable to DN_PERFORMANCE event. | | +| VAR_PACKET_DELAY | Indicates variance of Packet Delay. This value is only applicable to DN_PERFORMANCE event. | DnPerformanceExt_AIML | +| AVG_PACKET_LOSS_RATE | Indicates average Packet Loss Rate. This value is only applicable to DN_PERFORMANCE event. | | +| MAX_PACKET_LOSS_RATE | Indicates maximum Packet Loss Rate. This value is only applicable to DN_PERFORMANCE event. | DnPerformanceExt_AIML | +| VAR_PACKET_LOSS_RATE | Indicates variance of Packet Loss Rate. This value is only applicable to DN_PERFORMANCE event. | DnPerformanceExt_AIML | +| UE_LOCATION | Indicates UE location information. This value is only applicable to SERVICE_EXPERIENCE event. | | +| LIST_OF_HIGH_EXP_UE | Indicates list of high experienced UE. This value is only applicable to SM_CONGESTION event. | | +| LIST_OF_MEDIUM_EXP_UE | Indicates list of medium experienced UE. This value is only applicable to SM_CONGESTION event. | | +| LIST_OF_LOW_EXP_UE | Indicates list of low experienced UE. This value is only applicable to SM_CONGESTION event. | | +| AVG_UL_PKT_DROP_RATE | Indicates average uplink packet drop rate on GTP-U path on N3. This value is only applicable to RED_TRANS_EXP event. | | +| VAR_UL_PKT_DROP_RATE | Indicates variance of uplink packet drop rate on GTP-U path on N3. This value is only applicable to RED_TRANS_EXP event. | | +| AVG_DL_PKT_DROP_RATE | Indicates average downlink packet drop rate on GTP-U path on N3. This value is only applicable to RED_TRANS_EXP event. | | +| VAR_DL_PKT_DROP_RATE | Indicates variance of downlink packet drop rate on GTP-U path on N3. This value is only applicable to RED_TRANS_EXP event. | | +| TRAFFIC_MATCH_TD | Identifies traffic that matches Traffic Descriptor provided by the consumer. This value is only applicable to PDU_SESSION_TRAFFIC event. | PduSesTraffic | +| TRAFFIC_UNMATCH_TD | Identifies traffic that does not match Traffic Descriptor provided by the consumer. This value is only applicable to PDU_SESSION_TRAFFIC event. | PduSesTraffic | +| NUMBER_OF_UE | Indicates the number of UEs. This value is only applicable to DN_PERFORMANCE event. | DnPerformanceExt_eNA | +| UE_GEOG_DIST | Indicates the geographical distribution of the UEs that can be selected by the AF for application service. This value is only applicable to UE_MOBILITY event. | UeMobilityExt2_eNA | +| UE_DIRECTION | Indicates the direction of the UEs. This value is only applicable to UE_MOBILITY event. | UeMobilityExt2_eNA | +| AVG_E2E_UL_PKT_DELAY | Indicates average End-to-End (between UE and UPF) uplink packet delay. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| VAR_E2E_UL_PKT_DELAY | Indicates the variance of End-to-End (between UE and UPF) uplink packet delay. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| AVG_E2E_DL_PKT_DELAY | Indicates average End-to-End (between UE and UPF) downlink packet delay. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| VAR_E2E_DL_PKT_DELAY | Indicates the variance of End-to-End (between UE and UPF) downlink packet delay. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| AVG_E2E_UL_PKT_LOSS_RATE | Indicates average End-to-End (between UE and UPF) uplink packet loss rate. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| VAR_E2E_UL_PKT_LOSS_RATE | Indicates the variance of End-to-End (between UE and UPF) uplink packet loss rate. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| AVG_E2E_DL_PKT_LOSS_RATE | Indicates average End-to-End (between UE and UPF) downlink packet loss rate. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| VAR_E2E_DL_PKT_LOSS_RATE | Indicates the variance of End-to-End (between UE and UPF) downlink packet loss rate. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | + +| | | | +|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| | RED_TRANS_EXP event. | | +| E2E_DATA_VOL_TRANS_TIME_FOR_UE_LIST | Indicates the classified E2E data volume transfer time statistics or predictions for multiple UEs with respect to one or more reporting thresholds. | E2eDataVolTransTime | +| NUM_OF_UE | Indicates the total number of UEs in the area of interest. This value is only applicable to MOVEMENT_BEHAVIOUR event. | MovementBehaviour | +| MOV_UE_RATIO | Indicates the Ratio of moving UEs in the area of interest. This value is only applicable to MOVEMENT_BEHAVIOUR event. | MovementBehaviour | +| AVR_SPEED | Indicates the average speed of all UEs in the area of interest. This value is only applicable to MOVEMENT_BEHAVIOUR event. | MovementBehaviour | +| SPEED_THRESHOLD | Indicates the information on UEs in the area of interest whose speed is faster than the speed threshold. This value is only applicable to MOVEMENT_BEHAVIOUR event. | MovementBehaviour | +| MOV_UE_DIRECTION | Indicates the heading directions of the UE flow in the target area. This value is only applicable to MOVEMENT_BEHAVIOUR event. | MovementBehaviour | +| IN_OUT_PERCENT | Indicates the percentage of UEs that are indoors/outdoors. This value is only applicable to LOC_ACCURACY event. | LocAccuracy | +| TIME_TO_COLLISION | Indicates the time until for a collision with another UE happens. This value is only applicable to RELATIVE_PROXIMITY event prediction. | RelativeProximity | + +#### 5.1.6.3.19 Enumeration: DispersionType + +**Table 5.1.6.3.19-1: Enumeration DispersionType** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------|---------------| +| DVDA | Data Volume Dispersion Analytics. | | +| TDA | Transactions Dispersion Analytics. | | +| DVDA_AND_TDA | Data Volume Dispersion Analytics and Transactions Dispersion Analytics. | | + +#### 5.1.6.3.20 Enumeration: DispersionClass + +**Table 5.1.6.3.20-1: Enumeration DispersionClass** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| FIXED | Dispersion class as fixed UE, its data or transaction usage at a location or a slice, is higher than its class threshold set for its all data or transaction usage. | | +| CAMPER | Dispersion class as camper UE, its data or transaction usage at a location or a slice, is higher than its class threshold and lower than the fixed class threshold set for its all data or transaction usage. | | +| TRAVELLER | Dispersion class as traveller UE, its data or transaction usage at a location or a slice, is lower than the camper class threshold set for its all data or transaction usage. | | +| TOP_HEAVY | Dispersion class as Top_Heavy UE, who's dispersion percentile rating at a location or a slice, is higher than its class threshold. | | + +## 5.1.6.3.21 Enumeration: DispersionOrderingCriterion + +**Table 5.1.6.3.21-1: Enumeration DispersionOrderingCriterion** + +| Enumeration value | Description | Applicability | +|--------------------|-------------------------------------------------------------|---------------| +| TIME_SLOT_START | Indicates the order of time slot start. | | +| DISPERSION | Indicates the order of data/transaction dispersion. | | +| CLASSIFICATION | Indicates the order of data/transaction classification. | | +| RANKING | Indicates the order of data/transaction ranking. | | +| PERCENTILE_RANKING | Indicates the order of data/transaction percentile ranking. | | + +## 5.1.6.3.22 Enumeration: RedTransExpOrderingCriterion + +**Table 5.1.6.3.22-1: Enumeration RedTransExpOrderingCriterion** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------|---------------| +| TIME_SLOT_START | Indicates the order of time slot start. | | +| RED_TRANS_EXP | Indicates the order of Redundant Transmission Experience. | | + +## 5.1.6.3.23 Enumeration: WlanOrderingCriterion + +**Table 5.1.6.3.23-1: Enumeration WlanOrderingCriterion** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------|---------------| +| TIME_SLOT_START | Indicates the order of time slot start. | | +| NUMBER_OF_UES | Indicates the order of number of UEs. | | +| RSSI | Indicates the order of RSSI. | | +| RTT | Indicates the order of RTT. | | +| TRAFFIC_INFO | Indicates the order of Traffic Information | | + +## 5.1.6.3.24 Enumeration: ServiceExperienceType + +**Table 5.1.6.3.24-1: Definition of type ServiceExperienceType** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------|---------------| +| VOICE | Indicates that the service experience analytics is for voice service. | | +| VIDEO | Indicates that the service experience analytics is for video service. | | +| OTHER | Indicates that the service experience analytics is for other service. | | + +## 5.1.6.3.25 Enumeration: DnPerfOrderingCriterion + +**Table 5.1.6.3.25-1: Enumeration DnPerfOrderingCriterion** + +| Enumeration value | Description | Applicability | +|--------------------------|-----------------------------------------|---------------| +| AVERAGE_TRAFFIC_RATE | Indicates the average traffic rate. | | +| MAXIMUM_TRAFFIC_RATE | Indicates the maximum traffic rate. | | +| AVERAGE_PACKET_DELAY | Indicates the average packet delay. | | +| MAXIMUM_PACKET_DELAY | Indicates the maximum packet delay. | | +| AVERAGE_PACKET_LOSS_RATE | Indicates the average packet loss rate. | | + +## 5.1.6.3.26 Enumeration: TermCause + +**Table 5.1.6.3.26-1: Enumeration TermCause** + +| Enumeration value | Description | Applicability | +|----------------------|-------------------------------------------------|---------------| +| USER_CONSENT_REVOKED | The user consent has been revoked. | | +| NWDAF_OVERLOAD | The NWDAF is overloaded. | | +| UE_LEFT_AREA | The UE has moved out of the NWDAF serving area. | | + +## 5.1.6.3.27 Enumeration: UserDataConOrderCrit + +**Table 5.1.6.3.27-1: Enumeration UserDataConOrderCrit** + +| Enumeration value | Description | Applicability | +|---------------------------|----------------------------------------------------------|---------------| +| APPLICABLE_TIME_WINDOW | The ordering criterion is the Applicable Time Window. | | +| NETWORK_STATUS_INDICATION | The ordering criterion is the network status indication. | | + +## 5.1.6.3.28 Enumeration: UeMobilityOrderCriterion + +**Table 5.1.6.3.28-1: Enumeration UeMobilityOrderCriterion** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------|---------------| +| TIME_SLOT | The ordering criterion is the time slot. | | + +## 5.1.6.3.29 Enumeration: UeCommOrderCriterion + +**Table 5.1.6.3.29-1: Enumeration UeCommOrderCriterion** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------------|---------------| +| START_TIME | The ordering criterion of the analytics is the start time. | | +| DURATION | The ordering criterion of the analytics is the duration of the communication. | | + +## 5.1.6.3.30 Enumeration: NetworkPerfOrderCriterion + +**Table 5.1.6.3.30-1: Enumeration NetworkPerfOrderCriterion** + +| Enumeration value | Description | Applicability | +|--------------------|---------------------------------------------------------------------------|---------------| +| NUMBER_OF_UES | The ordering criterion of the analytics is the number of UEs. | | +| COMMUNICATION_PERF | The ordering criterion of the analytics is the communication performance. | | +| MOBILITY_PERF | The ordering criterion of the analytics is the mobility performance. | | + +## 5.1.6.3.31 Enumeration: DeviceType + +Table 5.1.6.3.31-1: Enumeration DeviceType + +| Enumeration value | Description | Applicability | +|----------------------|----------------------|---------------| +| MOBILE_PHONE | Mobile Phone | | +| SMART_PHONE | Smartphone | | +| TABLET | Tablet | | +| DONGLE | Dongle | | +| MODEM | Modem | | +| WLAN_ROUTER | WLAN Router | | +| IOT_DEVICE | IoT Device | | +| WEARABLE | Wearable | | +| MOBILE_TEST_PLATFORM | Mobile Test Platform | | +| UNDEFINED | Undefined | | + +## 5.1.6.3.32 Enumeration: LocInfoGranularity + +Table 5.1.6.3.32-1: Enumeration LocInfoGranularity + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------|---------------| +| TA_LEVEL | Indicates location granularity of TA level. | | +| CELL_LEVEL | Indicates location granularity of Cell level. | | +| LON_AND_LAT_LEVEL | Indicates location granularity of longitude and latitude level. | | + +## 5.1.6.3.33 Enumeration: TrafficDirection + +Table 5.1.6.3.33-1: Enumeration TrafficDirection + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------|---------------| +| UL_AND_DL | Uplink and downlink traffic. | | +| UL | Uplink traffic. | | +| DL | Downlink traffic. | | + +## 5.1.6.3.34 Enumeration: ValueExpression + +Table 5.1.6.3.34-1: Enumeration ValueExpression + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------|---------------| +| AVERAGE | Resource usage information in average value. | | +| PEAK | Resource usage information in peak value. | | + +## 5.1.6.3.35 Enumeration: E2eDataVolTransTimeCriterion + +Table 5.1.6.3.35-1: Enumeration E2eDataVolTransTimeCriterion + +| Enumeration value | Description | Applicability | +|-------------------------|--------------------------------------------------------------|---------------| +| E2E_DATA_VOL_TRANS_TIME | The ordering criterion is the E2E data volume transfer time. | | + +5.1.6.3.36 Void + +5.1.6.3.37 Enumeration: AnalyticsAccuracyIndication + +**Table 5.1.6.3.37-1: Enumeration AnalyticsAccuracyIndication** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------|---------------| +| MEET | Indicates meet the analytics accuracy requirement. | | +| NOT_MEET | Indicates not meet the analytics accuracy requirement. | | + +5.1.6.3.38 Enumeration: LocationOrientation + +**Table 5.1.6.3.38-1: Enumeration LocationOrientation** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------|---------------| +| HORIZONTAL | Indicates horizontal orientation. | | +| VERTICAL | Indicates vertical orientation. | | +| BOTH | Indicates both horizontal and vertical orientation. | | + +5.1.6.3.39 Enumeration: Direction + +**Table 5.1.6.3.39-1: Enumeration Direction** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------|---------------| +| NORTH | North direction. | | +| SOUTH | South direction. | | +| EAST | East direction. | | +| WEST | West direction. | | +| NORTHWEST | Northwest direction. | | +| NORTHEAST | Northeast direction. | | +| SOUTHWEST | Southwest direction. | | +| SOUTHEAST | Southeast direction. | | + +5.1.6.3.40 Enumeration: ProximityCriterion + +**Table 5.1.6.3.40-1: Enumeration ProximityCriterion** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------|---------------| +| VELOCITY | Velocity. | | +| AVG_SPD | Average speed. | | +| ORIENTATION | Orientation. | | +| TRAJECTORY | Mobility trajectory. | | + +## 5.1.7 Error handling + +5.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [6]. + +For the Nnwdaf\_EventsSubscription API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [7]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] 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 [6]. + +In addition, the requirements in the following clauses shall apply. + +### 5.1.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_EventsSubscription API. + +### 5.1.7.3 Application Errors + +The application errors defined for the Nnwdaf\_EventsSubscription API are listed in table 5.1.7.3-1. + +**Table 5.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| BOTH_STAT_PRED_NO_T_ALLOWED | 400 Bad Request | Indicates that the request shall be rejected, because for the requested observation period, the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics is not allowed. | | +| UE_AGGREGATION_NO_T_ALLOWED | 400 Bad Request | For the requested UE location aggregation in UE Mobility analytics is not allowed. | | +| PREDICTION_NOT_ALLOWED | 400 Bad Request | Indicates that the request shall be rejected because the prediction for the analytics event is not allowed. | PredictionError | +| USER_CONSENT_NOT_GRANTED | 403 Forbidden | Indicates that the request shall be rejected because an impacted user has not provided the required user consent. | | +| UNAVAILABLE_DATA | 500 Internal Server Error | Indicates the requested statistics in the past is rejected since necessary data to perform the service is unavailable. | | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | | + +### 5.1.8 Feature negotiation + +The optional features in table 5.1.8-1 are defined for the Nnwdaf\_EventsSubscription API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ServiceExperience | This feature indicates support for the event related to service experience. | +| 2 | UeMobility | This feature indicates the support of analytics based on UE mobility information. | +| 3 | UeCommunication | This feature indicates the support of analytics based on UE communication information. | +| 4 | QoSustainability | This feature indicates support for the event related to QoS sustainability. | +| 5 | AbnormalBehaviour | This feature indicates support for the event related to abnormal behaviour information. | +| 6 | UserDataCongestion | This feature indicates support for the event related to user data congestion. | +| 7 | NfLoad | This feature indicates the support of the analytics related to the load of NF instances. | +| 8 | NetworkPerformance | This feature indicates the support of analytics based on network performance. | +| 9 | NsiLoad | This feature indicates the support of the event related to the load level of Network Slice and the optionally associated Network Slice Instance. | +| 10 | 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 [6] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. | +| 11 | EneNA | This feature indicates support for the enhancements of network data analytics requirements. | +| 12 | UserDataCongestionExt | This feature indicates support for the extensions to the event related to user data congestion, including support of GPSI and/or list of Top applications. Supporting this feature also requires the support of feature UserDataCongestion. | +| 13 | Aggregation | This feature indicates support for analytics aggregation. | +| 14 | NsiLoadExt | This feature indicates support for the extensions to the event related to the load level of Network Slice and the optionally associated Network Slice Instance, including support of area of interest, NF load information and number of UE or number of PDU Session. Supporting this feature also requires the support of feature NsiLoad. | +| 15 | ServiceExperienceExt | This feature indicates support for the extensions to the event related to service experience, including support of RAT type and/or Frequency. Supporting this feature also requires the support of feature ServiceExperience. | +| 16 | DnPerformance | This feature indicates the support of the analytics related to DN performance. | +| 17 | NfLoadExt | This feature indicates support for the extensions to the event related to the load of NF instances, including NF load over area of interest. Supporting this feature also requires the support of feature NfLoad. | +| 18 | Dispersion | This feature indicates support of the analytics related to dispersion analytics information. | +| 19 | RedundantTransmissionExp | This feature indicates support of the analytics related to redundant transmission experience analytics information. | +| 20 | WlanPerformance | This feature indicates support of the analytics related to WLAN performance information. | +| 21 | UeCommunicationExt | This feature indicates the support for the extensions to the event related to UE communication, including support of reporting the analytics of the application list used by UE, N4 Session inactivity timer, and whether the UE communicates periodically or not. Supporting this feature also requires the support of UeCommunication feature. | +| 22 | UeMobilityExt | This feature indicates support for extensions to the event related to UE mobility, including support of LADN DNN to refer the LADN service area as the AOI. Supporting this feature also requires the support of feature UeMobility. | + +| | | | +|----|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 23 | AnaCtxTransfer | This feature indicates support for functionality related to Analytics Context Transfer. | +| 24 | AnaSubTransfer | This feature indicates support for Analytics Subscription Transfer initiated by the source NWDAF. | +| 25 | UserConsent | Indicates the support of detailed handling of user consent, e.g. error responses related to the lack of user consent. | +| 26 | TermRequest | This feature indicates support for Analytics Subscription termination requests sent by the NWDAF to the NF service consumer. | +| 27 | ENAExt | This feature indicates support for the general enhancements of network data analytics requirements, including support more level of accuracy and support for use case context sent by the NF service consumer to the NWDAF. | +| 28 | EnAbnormalBehaviour | This feature indicates support for the enhancements of UE Abnormal Behaviour.
Supporting this feature also requires the support of AbnormalBehaviour feature. | +| 29 | EnQoSustainability | This feature indicates support for the enhancements of QoS Sustainability.
Supporting this feature also requires the support of QoSustainability feature. | +| 30 | UserDataCongestionExt2_eNA | This feature indicates support for the enhancements of user data congestion, including support of ordering criterion.
Supporting this feature also requires the support of UserDataCongestion and UserDataCongestionExt features. | +| 31 | UeMobilityExt2_eNA | This feature indicates support for the enhancements of UE mobility, including support of ordering criterion and linear distance threshold. Supporting this feature also requires the support of UeMobility and UeMobilityExt features. | +| 32 | UeCommunicationExt_eNA | This feature indicates support for the enhancements of UE Communication, including to indicate the ordering criterion for the list of analytics. Supporting this feature also requires the support of UeCommunication feature. | +| 33 | NetworkPerformanceExt_eNA | This feature indicates support for the enhancements of Network Performance, including support of ordering criterion for the list of analytics and analytics target period subset. Supporting this feature also requires the support of NetworkPerformance feature. | +| 34 | QoSustainabilityExt_eNA | This feature indicates support for the enhancements of QoS Sustainability, including enhancements of filter information. Supporting this feature also requires the support of QoSustainability feature. | +| 35 | PartialAnalyticsSubTransfer | This feature indicates support for partial successful analytics subscription transfer. | +| 36 | Void | Void | +| 37 | PfdDetermination | This feature indicates support for functionality related to NWDAF assisted PFD Determination information for known application identifier(s). | +| 38 | ServiceExperienceExt2_eNA | This feature indicates support for the extensions to the event related to service experience supporting eNA, including support for PDU Session parameters information for service experience analytics. Supporting this feature also requires the support of feature ServiceExperience. | +| 39 | DnPerformanceExt_AIML | This feature indicates support for extensions to the event related to DN Performance supporting AIML, including support of extended DN Performance Analytics for group of UEs. Supporting this feature also requires the support of feature DnPerformance. | +| 40 | UeMobilityExt_AIML | This feature indicates support for further extensions to the event related to UE mobility supporting AIML, including UE's geographical distribution and direction analytics. Supporting this feature also requires the support of feature UeMobility. | +| 41 | PduSesTraffic | This feature indicates support of the analytics related to PDU Session traffic information. | +| 42 | E2eDataVolTransTi
me | This feature indicates support for E2E data volume transfer time analytics | +| 43 | DispersionExt_eNA | This feature indicates support for the enhancements of | + +| | | | +|----|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Dispersion, including the support of preferred granularity of UE location. Supporting this feature also requires the support of Dispersion feature. | +| 44 | WlanPerformanceExt_AIML | This feature indicates support for the enhancements of WLAN performance supporting AIML, including support of analytics per UE granularity. Supporting this feature also requires the support of feature WlanPerformance. | +| 45 | NetworkPerformanceExt_AIML | This feature indicates support of the network performance enhancements for AI/ML-based Services. Within this feature the following enhancements are covered:
- support of providing gNB resource usage for GBR traffic and Delay-critical GBR traffic.

Supporting this feature also requires the support of NetworkPerformance feature. | +| 46 | DnPerformanceExt_eNA | This feature indicates support for extensions to the event related to DN Performance, including support of number of UEs. Supporting this feature also requires the support of feature DnPerformance. | +| 47 | AnalyticsAccuracy | This feature indicates support for the Analytics Accuracy information. | +| 48 | RedundantTransExpExt_eNA | This feature indicates support extensions to the event related to redundant transmission experience analytics information including:
- support of providing the E2E UL/DL packet loss rate (average, variance), E2E UL/DL packet delay (average, variance) in the analytics.
- support of spatial and temporal granularity size.

Supporting this feature also requires the support of feature RedundantTransmissionExp. | +| 49 | WlanPerfExt_eNA | This feature indicates support for the enhancements of WLAN performance supporting AIML, including support of temporal granularity size. Supporting this feature also requires the support of feature WlanPerformance. | +| 50 | MovementBehaviour | This feature indicates support for the Movement Behaviour information. | +| 51 | LocAccuracy | This feature indicates support for the Location Accuracy analytics. | +| 52 | RelativeProximity | This feature indicates support for the Relative Proximity analytics. | +| 53 | StatisticsFailure | This feature indicates support for partial failure report for statistics during event notification.

Supporting this feature also requires the support of EneNA feature. | +| 54 | RoamingAnalytics | This feature indicates support for the Roaming analytics. | +| 55 | PredictionError | This feature indicates support for Prediction Error handling. | + +### 5.1.9 Security + +As indicated in 3GPP TS 33.501 [13] and 3GPP TS 29.500 [6], the access to the Nnwdaf\_EventsSubscription API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [14]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnwdaf\_EventsSubscription API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], 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 Nnwdaf\_EventsSubscription service. + +The Nnwdaf\_EventsSubscription API defines the following scopes for OAuth2 authorization as described in 3GPP TS 29.501 [7], clause 4.x. + +**Table 5.1.9-1: OAuth2 scopes defined in Nnwdaf\_EventsSubscription API** + +| Scope | Description | +|--------------------------------------|----------------------------------------------------------------------------| +| "nnwdaf-eventssubscription" | Access to the Nnwdaf_EventsSubscription API | +| "nnwdaf-eventssubscription:transfer" | Access to service operations applying to NWDAF event subscription transfer | + +## 5.2 Nnwdaf\_AnalyticsInfo Service API + +### 5.2.1 Introduction + +The Nnwdaf\_AnalyticsInfo service shall use the Nnwdaf\_AnalyticsInfo API. + +The API URI of the Nnwdaf\_AnalyticsInfo API shall be: + +{apiRoot}/ + +The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-analyticsinfo". +- The shall be "v1". +- The 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 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_AnalyticsInfo is contained in Annex A. + +#### 5.2.2.2 HTTP standard headers + +##### 5.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +##### 5.2.2.2.2 Content type + +JSON, IETF RFC 8259 [10], 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 [6]. 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 9457 [15]. + +### 5.2.2.3 HTTP custom headers + +The Nnwdaf\_AnalyticsInfo Service API shall support the mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_AnalyticsInfo Service API. + +## 5.2.3 Resources + +### 5.2.3.1 Resource Structure + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.2.3.1-1 depicts the resource URIs structure for the Nnwdaf\_AnalyticsInfo API. + +![Diagram showing the resource URI structure for the Nnwdaf_AnalyticsInfo API. The root URI is {apiRoot}/nnwdaf-analyticsinfo/. It branches into two resources: /analytics and /context.](c8eb5f8c1faa149b1aaa0d5e4a5c0e66_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnwdaf-analyticsinfo/"] --> Analytics["/analytics"] + Root --> Context["/context"] + +``` + +Diagram showing the resource URI structure for the Nnwdaf\_AnalyticsInfo API. The root URI is {apiRoot}/nnwdaf-analyticsinfo/. It branches into two resources: /analytics and /context. + +**Figure 5.2.3.1-1: Resource URI structure of the Nnwdaf\_AnalyticsInfo 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 | +|-----------------|--------------|---------------------------------|-----------------------------------------------------------------------------| +| NWDAF Analytics | /analytics | GET | Retrieves the NWDAF analytics. | +| NWDAF Context | /context | GET | Retrieves the NWDAF context information related to analytics subscriptions. | + +### 5.2.3.2 Resource: NWDAF Analytics + +#### 5.2.3.2.1 Description + +The NWDAF Analytics resource represents the analytics to the Nnwdaf\_AnalyticsInfo service at a given NWDAF. + +#### 5.2.3.2.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-analyticsinfo//analytics + +The shall be set as described in clause 5.2.1. + +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 GET + +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 GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------| +| ana-req | EventReportingRequirement | O | 0..1 | Identifies the analytics reporting requirement information. | +| event-id | EventId | M | 1 | Shall be included to identify the analytics. | +| event-filter | EventFilter | C | 0..1 | Shall be included to identify the analytics when filter information is needed for the related event. | +| supported-features | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. | +| tgt-ue | TargetUeInformation | O | 0..1 | Identifies the target UE information. (NOTE) | +| NOTE: All target UE(s) indicated by this attribute shall belong to the same PLMN. When the RoamingAnalytics feature is supported and the target UE(s) indicated by this attribute belong to a PLMN different than the PLMN of the NF service consumer, the request should contain only attributes that are applicable also in the Nnwdaf_RoamingAnalytics service. | | | | | + +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 GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------| +| AnalyticsData | M | 1 | 200 OK | Containing the analytics with parameters as relevant for the requesting NF service consumer. | +| n/a | | | 204 No Content | If the request NWDAF Analytics data does not exist, the NWDAF shall respond with "204 No Content" | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetailsAnalyticsInfoRequest | O | 0..1 | 500 Internal Server Error | The request is rejected by the NWDAF and more details (not only the ProblemDetails) are returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | +| NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. | | | | | +| NOTE 2: Failure cases are described in clause 5.2.7. | | | | | + +#### 5.2.3.2.4 Resource Custom Operations + +None in this release of the specification. + +### 5.2.3.3 Resource: NWDAF Context + +#### 5.2.3.3.1 Description + +The NWDAF Context resource represents the context information related to analytics subscriptions at the Nnwdaf\_AnalyticsInfo service at a given NWDAF. + +#### 5.2.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-analyticsinfo//context + +The shall be set as described in clause 5.2.1. + +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 | + +#### 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 | +|-------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| context-ids | ContextIdList | M | 1 | Identifies specific context information related to analytics subscriptions. | +| req-context | RequestedContext | O | 0..1 | Identifies the types of the analytics context information the consumer wishes to receive. Absence of this attribute means that the consumer wishes to receive available context information of all types. | + +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 | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------| +| ContextData | M | 1 | 200 OK | Contains the context information corresponding with the context identifiers provided in the request. | +| n/a | | | 204 No Content | If the requested context information does not exist, the NWDAF shall respond with "204 No Content". | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. | | | | | + +### 5.2.4 Custom Operations without associated resources + +None in this release of the specification. + +## 5.2.5 Notifications + +None in this release of the specification. + +## 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 Nnwdaf\_AnalyticsInfo service based interface protocol. + +**Table 5.2.6.1-1: Nnwdaf\_AnalyticsInfo specific Data Types** + +| Data type | Section defined | Description | Applicability | +|------------------------------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------|----------------------------| +| AdditionInfoAnalyticsInfoRequest | 5.2.6.2.5 | Contains more details (not only the ProblemDetails) in case an Nnwdaf_AnalyticsInfo request is rejected. | EneNA | +| AdrfDataType | 5.2.6.3.5 | Represents a type of data that is stored in the ADRF. | AnaCtxTransfer | +| AnalyticsData | 5.2.6.2.2 | Describes analytics with parameters indicated in the request. | | +| ContextData | 5.2.6.2.6 | Contains context information related to analytics subscriptions corresponding with one or more context identifiers. | AnaCtxTransfer | +| ContextElement | 5.2.6.2.7 | Contains context information corresponding with a specific context identifier. | AnaCtxTransfer | +| ContextIdList | 5.2.6.2.8 | Contains list of context identifiers of context information of analytics subscriptions. | AnaCtxTransfer | +| ContextType | 5.2.6.3.4 | Identifies the type of analytics context information. | AnaCtxTransfer | +| EventFilter | 5.2.6.2.3 | Represents the event filters used to identify the requested analytics. | | +| EventId | 5.2.6.3.3 | Describes the type of analytics. | | +| HistoricalData | 5.2.6.2.9 | Contains historical data related to an analytics subscription. | AnaCtxTransfer | +| NetworkPerfReq | 5.2.6.2.16 | Represents a network performance requirement. | NetworkPerformanceExt_eNA | +| ProblemDetailsAnalyticsInfoRequest | 5.2.6.4.1 | Data type that extends ProblemDetails. | EneNA | +| RequestedContext | 5.2.6.2.11 | Contains types of analytics context information. | AnaCtxTransfer | +| ResourceUsageRequPerNwPerfType | 5.2.6.2.17 | Indicates more requirements per network performance type when providing resource usage information for network performance. | NetworkPerformanceExt_AIML | +| SmcceInfo | 5.2.6.2.12 | Represents the analytics of Session Management congestion control experience | SMCCE | + +| | | | | +|-------------------------------|------------|-----------------------------------------------------------------------------------------------------------|----------------------------| +| | | information. | | +| SmcceUeList | 5.2.6.2.13 | Represents the List of UEs classified based on experience level of Session Management congestion control. | SMCCE | +| SpecificAnalyticsSubscription | 5.2.6.2.10 | Represents an existing subscription for a specific type of analytics to a specific NWDAF. | AnaCtxTransfer | +| SpecificDataSubscription | 5.2.6.2.14 | Represents an existing data collection subscription to a specific data source NF. | AnaCtxTransfer | +| UserDataCongestReq | 5.2.6.2.15 | Represents the user data congestion requirements. | UserDataCongestionExt2_eNA | + +Table 5.2.6.1-2 specifies data types re-used by the Nnwdaf\_AnalyticsInfo 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 Nnwdaf service based interface. + +Re-used data types of clause 5.1.6 refer here to requests instead of subscriptions. + +**Table 5.2.6.1-2: Nnwdaf\_AnalyticsInfo re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|---------------------|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| AbnormalBehaviour | 5.1.6.2.15 | Represents the abnormal behaviour information. | AbnormalBehaviour | +| AccuracyInfo | 5.2.6.2.83 | The analytics accuracy information. | AnalyticsAccuracy | +| AccuracyReq | 5.1.6.3.82 | Represents the analytics accuracy requirement information. | AnalyticsAccuracy | +| AnalyticsContextIdentifier | 5.1.6.2.43 | Contains information about the available analytics contexts. | AnaCtxTransfer | +| AnalyticsMetadataInfo | 5.1.6.2.37 | Contains analytics metadata information required for analytics aggregation. | Aggregation | +| AnalyticsSubset | 5.1.6.3.18 | Contains information about the analytics subsets provided in the subscription request. | EneNA | +| AnySlice | 5.1.6.3.2 | | | +| ApplicationId | 3GPP TS 29.571 [8] | Identifies the application. | ServiceExperience
UeCommunication
AbnormalBehaviour
DnPerformance
PfdDetermination
E2eDataVolTransTime | +| BwRequirement | 5.1.6.2.25 | | ServiceExperience | +| DataNotification | 3GPP TS 29.575 [27] | Describes Notifications about data collection events that occurred. | EneNA | +| DataSubscription | 3GPP TS 29.575 [27] | Represents data subscription from data source (e.g. AMF, SMF, UDM, NEF, AF). | EneNA | +| DateTime | 3GPP TS 29.571 [8] | Identifies the time. | | +| DispersionRequirement | 5.1.6.2.50 | Dispersion analytics requirement. | Dispersion | +| DispersionInfo | 5.1.6.2.53 | Dispersion analytics information. | Dispersion | +| Dnai | 3GPP TS 29.571 [8] | Identifies a user plane access to one or more DN(s). | ServiceExperience
DnPerformance
E2eDataVolTransTime | +| Dnn | 3GPP TS 29.571 [8] | Identifies the DNN. | ServiceExperience
AbnormalBehaviour
UeCommunication
SMCCE
DnPerformance
PfdDetermination
PduSesTraffic
E2eDataVolTransTime | +| DnPerfInfo | 5.1.6.2.45 | Represents DN performance information | DnPerformance | +| DnPerformanceReq | 5.1.6.2.66 | Represents the DN performance requirements. | DnPerformance | +| DurationSec | 3GPP TS 29.571 [8] | | | +| EventNotification | 5.1.6.2.5 | Describes Notifications about analytics events that occurred. | AnaCtxTransfer | +| EventReportingRequirement | 5.1.6.2.7 | | | +| ExceptionId | 5.1.6.3.6 | | AbnormalBehaviour | +| ExpectedUeBehaviourData | 3GPP TS 29.503 [23] | | AbnormalBehaviour | +| ExpectedAnalyticsType | 5.1.6.3.11 | | AbnormalBehaviour | +| GeographicalArea | 3GPP TS 29.522 [32] | Identifies the geographical location (longitude and latitude | UeMobilityExt2_eNA
ServiceExperienceExt2_eNA
QoSSustainExt_eNA | + +| | | | | +|--|--|---------|--| +| | | level). | | +|--|--|---------|--| + +| | | | | +|---------------------------|---------------------|--------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| GeoLocation | 5.1.6.2.95 | Represents a geographic location, potentially using local coordinates and optionally including the altitude. | LocAccuracy | +| LocAccuracyInfo | 5.1.6.2.97 | Contains Location Accuracy information. | LocAccuracy | +| LocAccuracyReq | 5.1.6.2.96 | Contains Location Accuracy analytics requirements. | LocAccuracy | +| LocInfoGranularity | 5.1.6.3.32 | Represents the preferred granularity of location information. | ServiceExperienceExt2_eNA
UeMobilityExt2_eNA
DispersionExt_eNA | +| LocationOrientation | 5.1.6.3.38 | Represent preferred orientation of location information | MovementBehaviour | +| MatchingDirection | 5.1.6.3.12 | The matching direction. | UserDataCongestionExt2_eNA
NetworkPerformanceExt | +| ModelInfo | 5.1.6.2.42 | The information of the ML models. | AnaCtxTransfer | +| MovBehavInfo | 5.1.6.2.91 | Represents the Movement Behaviour information. | MovementBehaviour | +| MovBehavReq | 5.1.6.2.90 | Represents the Movement Behaviour analytics requirements | MovementBehaviour | +| NetworkAreaInfo | 3GPP TS 29.554 [18] | The network area information. | UeMobility
UeCommunication
NetworkPerformance
QoSustainability
ServiceExperience
UserDataCongestion
AbnormalBehaviour
NsiLoadExt
Dispersion
RedundantTransmissionExp
WlanPerformance
DnPerformance
NflLoadExt
E2eDataVolTransTime
MovementBehaviour | +| NetworkPerfInfo | 5.1.6.2.23 | Represents network performance information. | NetworkPerformance | +| NetworkPerfOrderCriterion | 5.1.6.3.30 | Represents a network performance requirement. | NetworkPerformanceExt_eNA | +| NetworkPerfType | 5.1.6.3.10 | Represents the network performance types. | NetworkPerformance | +| NflLoadLevelInformation | 5.1.6.2.31 | Represents load level information of a given NF instance. | NflLoad | +| NfInstanceId | 3GPP TS 29.571 [8] | Identifies an NF instance | NflLoad | +| NfSetId | 3GPP TS 29.571 [8] | Identifies an NF Set instance. | NflLoad | +| NFType | 3GPP TS 29.510 [12] | Identifies a type of NF. | NflLoad | +| NsiIdInfo | 5.1.6.2.33 | Identify the S-NSSAI and the associated Network Slice Instance(s). | ServiceExperience
NsiLoad
DnPerformance | +| NsiLoadLevelInfo | 5.1.6.2.34 | Represents the load level information for an S-NSSAI and the associated network slice instance. | NsiLoad | + +| | | | | +|------------------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NnwdafEventsSubscription | 5.1.6.2.2 | Represents an Individual NWDAF Event Subscription resource. | AnaCtxTransfer | +| PfdDeterminationInfo | 5.1.6.2.71 | Represents PFD Determination information. | PfdDetermination | +| ProblemDetails | 3GPP TS 29.571 [8] | Used in error responses to provide more detailed information about an error. | | +| QosRequirement | 5.1.6.2.20 | | QoSSustainability
E2eDataVolTransTime | +| QosSustainabilityInfo | 5.1.6.2.19 | | QoSSustainability | +| RatFreqInformation | 5.1.6.2.67 | Represents the RAT type and/or Frequency information | ServiceExperienceExt | +| RedundantTransmissionExpInfo | 5.1.6.2.57 | Redundant transmission experience analytics information. | RedundantTransmissionExp | +| RedundantTransmissionExpReq | 5.1.6.2.56 | Redundant transmission experience analytics requirement. | RedundantTransmissionExp | +| PduSessionInfo | 5.1.6.2.74 | Represents combination of PDU Session parameters. | ServiceExperienceExt2_eNA | +| RelProxInfo | 5.1.6.2.100 | Relative Proximity analytics information. | RelativeProximity | +| RelProxReq | 5.1.6.2.99 | Relative Proximity analytics requirements. | RelativeProximity | +| ResourceUsageRequirement | 5.1.6.2.81 | Indicates more requirements per network performance type when providing resource usage information for network performance. | NetworkPerformanceExt_AIML | +| RoamingInfo | 5.1.6.2.106 | Contains information related to roaming analytics. | RoamingAnalytics | +| ServiceExperienceInfo | 5.1.6.2.24 | | ServiceExperience | +| Supi | 3GPP TS 29.571 [8] | Identifies the UE. | ServiceExperience,
NfLoad
NetworkPerformance
UserDataCongestion
UeMobility
UeCommunication
AbnormalBehaviour
SMCCE
Dispersion
RedundantTransmissionExp
WlanPerformance
E2eDataVolTransTime | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of the optional features defined in table 5.2.8-1. | | +| Snssai | 3GPP TS 29.571 [8] | | | +| SliceLoadLevelInformation | 5.1.6.2.6 | | | +| TargetUeInformation | 5.1.6.2.8 | Identifies the target UE information. | ServiceExperience
NfLoad
NetworkPerformance
UserDataCongestion
UeMobility
UeCommunication
AbnormalBehaviour
QoSSustainability | + +| | | | | +|-------------------------|---------------------|---------------------------------------------------------------------------|-------------------------------------------------------------------------------------| +| | | | Dispersion
RedundantTransmissionExp
WlanPerformance
SMCCE
DnPerformance | +| UeCommunication | 5.1.6.2.13 | | UeCommunication | +| UeCommReq | 5.1.6.2.72 | UE communication analytics requirement. | UeCommunicationExt_eNA | +| UeMobility | 5.1.6.2.10 | | UeMobility | +| UeMobilityReq | 5.1.6.2.71 | UE mobility analytics requirement. | UeMobilityExt2_eNA | +| UInteger | 3GPP TS 29.571 [8] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. | | +| UpfInformation | 3GPP TS 29.508 [29] | The information of the UPF serving the UE. | ServiceExperienceExt
DnPerformance | +| PduSesTrafficInfo | 5.1.6.2.77 | Represents PDU Session traffic analytics information. | PduSesTraffic | +| PduSesTrafficReq | 5.1.6.2.79 | Represents PDU Session traffic analytics requirement. | PduSesTraffic | +| UserDataCongestionInfo | 5.1.6.2.17 | | UserDataCongestion | +| UserDataConOrderCrit | 5.1.6.2.15 | The ordering criterion for the list of User Data Congestion analytics. | UserDataCongestionExt2_eNA | +| WlanPerformanceInfo | 5.1.6.2.60 | WLAN performance analytics information. | WlanPerformance | +| WlanPerformanceReq | 5.1.6.2.59 | WLAN performance analytics requirement. | WlanPerformance | +| E2eDataVolTransTimeInfo | 5.1.6.2.82 | E2E data volume transfer time | E2eDataVolTransTime | +| E2eDataVolTransTimeReq | 5.1.6.2.83 | E2E data volume transfer time requirement | E2eDataVolTransTime | + +## 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 AnalyticsData + +**Table 5.2.6.2.2-1: Definition of type AnalyticsData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|----------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| start | DateTime | O | 0..1 | It defines the start time of which the statistics analytics information is applicable or predictions analytics information is valid. (NOTE 1) (NOTE 7) | | +| expiry | DateTime | O | 0..1 | It defines the expiration time after which the statistics analytics information is applicable or predictions analytics information is invalid. (NOTE 1) (NOTE 7) | | +| timeStampGen | DateTime | C | 0..1 | It defines the timestamp of analytics generation. (NOTE 3) | | +| anaMetaInfo | AnalyticsMetadataInfo | C | 0..1 | Contains information about analytics metadata required to aggregate the analytics. It shall be present if the "anaMeta" attribute was included in the request, containing the information indicated by the "anaMeta" attribute. | Aggregation | +| sliceLoadLevelInfos | array(SliceLoadLevelInformation) | C | 1..N | The slices and the load level information. Shall be present when the requested event is "LOAD_LEVEL_INFORMATION". | | +| nsiLoadLevelInfos | array(NsiLoadLevelInfo) | C | 1..N | Each element identifies the load level information for an S-NSSAI and the optionally associated network slice instance. Shall be presented when the requested event is "NSI_LOAD_LEVEL" | NsiLoad | +| nwPerfs | array(NetworkPerfInfo) | C | 1..N | The network performance information. Shall be present when the requested event is "NETWORK_PERFORMANCE". | NetworkPerformance | +| nflLoadLevelInfos | array(NfLoadLevelInformation) | C | 1..N | The NF load information. When the requested event is "NF_LOAD", the nflLoadLevelInfos shall be included. | NfLoad | +| qosSustainInfos | array(QoSustainabilityInfo) | C | 1..N | The QoS sustainability informations in the certain geographic areas. It shall be present if the requested event is "QOS_SUSTAINABILITY". (NOTE 2) | QoSSustainability | +| ueMobs | array(UeMobility) | C | 1..N | The UE mobility information. When the requested event is "UE_MOBILITY", the "ueMobs" attribute shall be included. (NOTE 5) (NOTE 8) | UeMobility | +| ueComms | array(UeCommunication) | C | 1..N | The UE communication information. When the requested event is "UE_COMM", the "ueComms" attribute shall be included. (NOTE 9) | UeCommunication | +| userDataCongInfos | array(UserDataCongestionInfo) | C | 1..N | The user data congestion information. Shall be present when the requested event is "USER_DATA_CONGESTION". | UserDataCongestion | +| suppFeat | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.2.8. | | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | This parameter shall be supplied by NWDAF in the reply of GET request that request the analytics resource, if the consumer includes "supported-features" in the GET request. | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------|-------------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| svcExps | array(ServiceExperienceInfo) | C | 1..N | The service experience information.
Shall be present when the requested event is "SERVICE_EXPERIENCE". | ServiceExperience | +| abnorBehavrs | array(AbnormalBehaviour) | C | 1..N | The abnormal behaviour information.
Shall be present when the requested event is "ABNORMAL_BEHAVIOUR". | AbnormalBehaviour | +| smccExps | array(SmccInfo) | C | 1..N | The Session Management congestion control experience information.
Shall be present when the requested event is "SM_CONGESTION". | SMCCE | +| dispersInfos | array(DispersionInfo) | C | 1..N | The Dispersion information.
Shall be present when the requested event is "DISPERSION". | Dispersion | +| redTransInfos | array(RedundantTransmissionExpInfo) | C | 1..N | The Redundant Transmission Experience analytics information.
Shall be present when the requested event is "RED_TRANS_EXP". | RedundantTransmissionExp | +| wlanInfos | array(WlanPerformanceInfo) | C | 1..N | The WLAN performance related information.
When requested event is "WLAN_PERFORMANCE", the "wlanInfos" attribute shall be included. (NOTE 6) | WlanPerformance | +| dnPerfInfos | array(DnPerfInfo) | C | 1..N | The DN performance information.
Shall be present when the requested event is "DN_PERFORMANCE". (NOTE 4) | DnPerformance | +| pfdDeterminInfos | array(PfdDeterminationInfo) | C | 1..N | Represents the PFD Determination information for a known application identifier.
Shall be present when the requested event is "PFD_DETERMINATION". | PfdDetermination | +| pduSesTrafInfos | array(PduSesTrafficInfo) | C | 1..N | The PDU Session traffic related information.
Shall be present when the requested event is "PDU_SESSION_TRAFFIC". | PduSesTraffic | +| dataViTrnsTmInfos | array(E2eDataVolTransTimeInfo) | C | 1..N | E2E data volume transfer time information.
Shall be present when the requested event is "E2E_DATA_VOL_TRANS_TIME". | E2eDataVolTransTime | +| locAccInfos | array(LocAccuracyInfo) | C | 1..N | The Location Accuracy related information.
It shall be present when the requested event is "LOC_ACCURACY". | LocAccuracy | +| accuInfo | AccuracyInfo | C | 0..1 | The analytics accuracy information.
Shall be provided if the analytics accuracy requirement was requested in the "accuReq" attribute and the "cancelAccuInd" attribute is set to "false" or omitted. | AnalyticsAccuracy | +| cancelAccuInd | boolean | O | 0..1 | Indicates cancelled request of the analytics accuracy information. | AnalyticsAccuracy | + +| | | | | | | +|---------------|---------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| | | | | Set to "true" indicates the NWDAF cancelled request of analytics accuracy information as the NWDAF does not support the accuracy checking capability. Otherwise set to "false". Default value is "false" if omitted. | | +| movBehavInfos | array(MovBehavInfo) | C | 1..N | The Movement Behaviour information. Shall be present when the requested event is "MOVEMENT_BEHAVIOUR". | MovementBehaviour | +| relProxInfos | array(RelProxInfo) | C | 1..N | The Relative Proximity information. Shall be present when the requested event is "RELATIVE_PROXIMITY", | RelativeProximity | + +NOTE 1: If the "start" attribute and the "expiry" attribute are both provided, the DateTime of the "expiry" attribute shall not be earlier than the DateTime of the "start" attribute. + +NOTE 2: The "qosFlowRetThd" and "ranUeThrouThd" attributes in QosSustainabilityInfo data type are not applicable. + +NOTE 3: This attribute shall be included when ADRF is deployed. + +NOTE 4: The "minTrafficRate", "aggTrafficRate", "varTrafficRate", "trafRateUelds", "avePacketDelay", "maxPacketDelay", "varPacketDelay", "packDelayUelds", "maxPacketLossRate", "varPacketLossRate" and "packetLossUelds" attribute(s) within the DnPerfInfo data type is applicable only if the "DnPerformanceExt\_AIML" feature is supported. + +NOTE 5: The "directionInfos" attribute and the "geoDistInfos" attribute in the "locInfos" attribute within the UeMobility data type are applicable only if the "UeMobilityExt\_AIML" feature is supported. + +NOTE 6: The "wlanPerUeldInfos" attribute may be included within the "wlanInfos" attribute only if the "WlanPerformanceExt\_AIML" feature is supported. + +NOTE 7: The validity period specified by "start" and "expiry" attributes is determined by NWDAF internal logic, and is a subset of the analytics target period indicated by "startTs" and "endTs", or "offsetPeriod" attributes contained in "ana-req" attribute. If the analytics target period refers to the past, the period specified by these two attributes indicate the time period over which the statistics are applicable. If the analytics target period refers to the future, the period specified by these two attributes indicate the time period over which the predictions are valid. + +NOTE 8: If the "UeMobilityExt2\_eNA" feature is supported and the "locationGranReq" attribute value "LON\_AND\_LAT\_LEVEL" is requested, the "geoLoc" attribute within the "locInfos" attribute in the "UeMobility" type shall be provided to report the geographical location (longitude and latitude level). + +NOTE 9: The "perioCommInd", "anaOfAppList" and "sessInactTimer" attributes within the UeCommunication data type are applicable only if the "UeCommunicationExt" feature is supported. + +### 5.2.6.2.3 Type EventFilter + +**Table 5.2.6.2.3-1: Definition of type EventFilter** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| anySlice | AnySlice | C | 0..1 | Default is "false". (NOTE 1) | | +| appIds | array(ApplicationId) | C | 1..N | Represents the Application Identifier(s). The absence of appIds means applicable to all applications. (NOTE 4) (NOTE 10) (NOTE 12) | ServiceExperience
UeCommunication
AbnormalBehaviour
Dispersion
DnPerformance
PfdDetermination
E2eDataVolTransTime | +| dnns | array(Dnn) | C | 1..N | Represents the DNN(s). Each DNN is a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. The absence of dnns means applicable to all DNNs. (NOTE 4) (NOTE 13) | ServiceExperience
UeCommunication
AbnormalBehaviour
SMCCE
DnPerformance
RedundantTransmissionExp
PfdDetermination
PduSesTraffic
E2eDataVolTransTime
RelativeProximity | +| dnais | array(Dnai) | O | 1..N | Represents the Data Network Access Identifier(s) of user plane accesses to DN(s) where applications are deployed. | ServiceExperience
DnPerformance
E2eDataVolTransTime | +| ladnDnns | array(Dnn) | O | 1..N | Represents the LADN DNN(s) to indicate the LADN service area(s) as the AoI(s). | UeMobilityExt | +| snssais | array(Snssai) | C | 1..N | Identification(s) of network slice(s). (NOTE 1), (NOTE 4) (NOTE 13) (NOTE 20) | | +| roamingInfo | RoamingInfo | O | 0..1 | Information about roaming analytics. When this attribute is provided, the request should contain only attributes that are applicable also in the Nnwdaf_RoamingAnalytics service. | RoamingAnalytics | +| nfInstanceIds | array(NfInstanceId) | O | 1..N | Identification(s) of NF instance(s). | NfLoad | +| nfSetIds | array(NfSetId) | O | 1..N | Identification(s) of NF instance set(s). | NfLoad | +| nfTypes | array(NFType) | O | 1..N | Identification(s) of NF type(s). (NOTE 8) | NfLoad
NsiLoadExt | +| networkArea | NetworkAreaInfo | C | 0..1 | This IE represents the network area where the NF service consumer wants to know the analytics result. (NOTE 2), (NOTE 4) (NOTE 17) | UeMobility
UeCommunication
NetworkPerformance
QoSustainability
ServiceExperience
UserDataCongestion
AbnormalBehaviour
NsiLoadExt
NfLoadExt
Dispersion | + +| | | | | | | +|--|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | | RedundantTransmissionExp
WlanPerformance
DnPerformance
PduSesTraffic
E2eDataVolTransTime
MovementBehaviour
LocAccuracy
RelativeProximity | +|--|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | | +|---------------------|-------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| location | GeoLocation | C | 0..1 | A location (i.e. geographical location or location in local coordinates) to which the request applies. (NOTE 18) | LocAccuracy | +| locAccInfos | array(LocAccuracyInfo) | C | 1..N | The Location Accuracy related information.
It shall be present when the requested event is "LOC_ACCURACY". | LocAccuracy | +| temporalGranSize | DurationSec | O | 0..1 | Indicates the minimum duration of each time slot for which the analytics are provided.
(NOTE 15) | NetworkPerformanceExt_eNA
UeMobilityExt2_eNA
UserDataCongestionExt2_eNA
QoSSustainExt_eNA
DispersionExt_eNA
WlanPerfExt_eNA
RedundantTransExpExt_eNA
DnPerfExt_eNA | +| spatialGranSizeTA | Uinteger | O | 0..1 | Indicates the maximum number of TAs used to define an area for which the analytics are provided.
May be included when the "networkArea" attribute in the EventSubscription data type is provided.
(NOTE 16) | NetworkPerformanceExt_eNA
UeMobilityExt2_eNA
UeCommunicationExt_eNA
QoSSustainExt_eNA
DispersionExt_eNA
DnPerfExt_eNA | +| spatialGranSizeCell | Uinteger | O | 0..1 | Indicates the maximum number of cells used to define an area for which the analytics are provided.
May be included when the "networkArea" attribute in the EventSubscription data type is provided.
(NOTE 16) | NetworkPerformanceExt_eNA
UeMobilityExt2_eNA
UeCommunicationExt_eNA
QoSSustainExt_eNA
DispersionExt_eNA
DnPerfExt_eNA | +| fineGranAreas | array(GeographicalArea) | O | 1..N | Indicates the fine granularity areas to which the request applies. (i.e. with a finer granularity than cell).
(NOTE 2) (NOTE 17) | ServiceExperienceExt2_eNA
UeMobilityExt2_eNA
QoSSustainExt_eNA | +| visitedAreas | array(NetworkAreaInfo) | O | 1..N | Identification(s) of network area(s) which the UEs had previously been in at least one of the Visited Area(s) of Interest. (NOTE 9) | UeMobilityExt | +| maxTopAppUINb | Uinteger | O | 0..1 | Indicates the requested maximum number of top applications that contribute the most to the traffic in Uplink direction.
Minimum = 1.
May be included when one of the elements in the "listOfAnaSubsets" attribute is set to LIST_OF_TOP_APP_UL. | UserDataCongestionExt | +| maxTopAppDINb | Uinteger | O | 0..1 | Indicates the requested maximum number of top applications that contribute the most to the traffic in Downlink direction.
Minimum = 1. | UserDataCongestionExt | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------|--| +| | | | | May be included when one of the elements in the "listOfAnaSubsets" attribute is set to LIST_OF_TOP_APP_DL. | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|------------------|---------------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| +| nsiIdInfos | array(NsiIdInfo) | O | 1..N | Each element identifies the S-NSSAI and the optionally associated network slice instance(s). May be included when the event-id is "NSI_LOAD_LEVEL", "SERVICE_EXPERIENCE" or "DN_PERFORMANCE". (NOTE 1) | ServiceExperience
NsiLoad
DnPerformance | +| nwPerfReqs | array(NetworkPerfReq) | O | 1..N | Represents the network performance requirements. This attribute may be included when the event-id is "NETWORK_PERFORMANCE". | NetworkPerformanceExt_eNA | +| nwPerfTypes | array(NetworkPerfType) | C | 1..N | Represents the network performance types. This attribute shall be included when event-id is "NETWORK_PERFORMANCE". | NetworkPerformance | +| addNwPerfReqs | array(ResourceUsageRequPerNwPerfType) | O | 1..N | Each element indicates more requirement for each network performance type (by each element in the "nwPerfTypes" attribute) when providing resource usage information for the network performance type. | NetworkPerformanceExt_AIML | +| userDataConReqs | array(UserDataCongestReq) | O | 1..N | Represents the network performance requirements. This attribute may be included when the event-id is "NETWORK_PERFORMANCE". | UserDataCongestionExt2_eNA | +| qosRequ | QoSRequirement | C | 0..1 | Represents the QoS requirements. This attribute shall be included when event-id is "QOS_SUSTAINABILITY" or E2E_DATA_VOL_TRANS_TIME. | QoSSustainability
E2eDataVolTransTime | +| bwReqs | array(BwRequirement) | O | 1..N | Represents the media/application bandwidth requirement for each application. It may only be present if "appls" attribute is provided. | ServiceExperience | +| excepIds | array(ExceptionId) | C | 1..N | Represents a list of Exception Ids. (NOTE 3), (NOTE 4) | AbnormalBehaviour | +| exptAnaType | ExpectedAnalyticsType | C | 0..1 | Represents expected UE analytics type. (NOTE 3), (NOTE 4) | AbnormalBehaviour | +| exptUeBehav | ExpectedUeBehaviourData | O | 0..1 | Represents expected UE behaviour. | AbnormalBehaviour | +| ratFreqs | array(RatFreqInformation) | O | 1..N | Identification(s) of the RAT type(s) and/or frequency(ies) of UE's serving cell(s) which the request applies. (NOTE 5) | ServiceExperienceExt | +| disperReqs | array(DispersionRequirement) | O | 1..N | Represents the dispersion analytics requirements. | Dispersion | +| redTransReqs | array(RedundantTransmissionExpReq) | O | 1..N | Represents the redundant transmission experience analytics requirements. | RedundantTransmissionExp | +| wlanReqs | array(WlanPerformanceReq) | O | 1..N | Represents other WLAN performance analytics requirements. If the attribute contains no content, may take default handling action. | WlanPerformance | +| listOfAnaSubsets | array(AnalyticsSubset) | O | 1..N | The list of analytics subsets used to indicate the content of the analytics. | EneNA | +| upfInfo | UpfInformation | O | 0..1 | Identifies the UPF. (NOTE 7) | ServiceExperienceExt
DnPerformance | +| appServerAddrs | array(AddrFqdn) | C | 1..N | Each element represents the Application Server Instance (IP address/FQDN of the Application Server). (NOTE 6) | ServiceExperienceExt
DnPerformance | +| dnPerfReqs | array(DnPerformanceReq) | O | 1..N | Represents the DN performance requirements. This attribute shall be included when event-id is | DnPerformance | + +| | | | | | | +|--|--|--|--|-------------------|--| +| | | | | "DN_PERFORMANCE". | | +|--|--|--|--|-------------------|--| + +| | | | | | | +|-----------------|-------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| +| dataViTrnsTmRqs | array(E2eDataVolTransTimeReq) | O | 1..N | Represents the list of E2E data volume transfer time requirement. This attribute may be included when event-id is "E2E_DATA_VOL_TRANS_TIME". | E2eDataVolTransTime | +| ueMobilityReqs | array(UeMobilityReq) | O | 1..N | Represents the UE mobility requirements. This attribute may be included when the event-id is "UE_MOBILITY". | UeMobilityExt2_eNA | +| ueCommReqs | array(UeCommReq) | O | 1..N | Represents the UE communication requirements. This attribute may be included when the event-id is "UE_MOBILITY". | UeCommunicationExt_eNA | +| pduSesInfos | array(PduSessionInfo) | O | 1..N | Represents combination of PDU Session parameters. (NOTE 12) | ServiceExperienceExt2_eNA | +| pduSesTrafReqs | array(PduSesTrafficReq) | C | 1..N | Represents the PDU Session traffic analytics requirements. This attribute shall be included when subscribed event is "PDU_SESSION_TRAFFIC". (NOTE 13) | PduSesTraffic | +| locAccReqs | array(LocAccuracyReq) | O | 1..N | Represents the Location Accuracy analytics requirements. This attribute may only be included when the subscribed event is "LOC_ACCURACY" and the attributes "accThres", "accThresMatchDir", "inOutThres", and "inOutThresMatchDir" inside it are not applicable for analytics requests. | LocAccuracy | +| locGranularity | LocInfoGranularity | O | 0..1 | The preferred granularity of UE location information.(NOTE 19) | ServiceExperienceExt2_eNA
UeMobilityExt2_eNA
DispersionExt_eNA
MovementBehaviour | +| locOrientation | LocationOrientation | O | 0..1 | Indicates the preferred orientation of location information. | MovementBehaviour
UeMobilityExt2_eNA | +| useCaseCxt | string | O | 0..1 | Indicates the context of usage of the analytics. The value and format of this parameter are not standardized. | ENAExt | +| accuReq | AccuracyReq | O | 0..1 | Represents the analytics accuracy requirement information. May be included as indication to the NWDAF (containing an AnLF supporting Accuracy checking capability) to activate checking the analytics accuracy information of the event. | AnalyticsAccuracy | +| movBehavReqs | array(MovBehavReq) | O | 1..N | Represents the Movement Behaviour analytics requirements. | MovementBehaviour | +| relProxReqs | array(RelProxReq) | O | 1..N | Represents the Relative Proximity analytics requirements. | RelativeProximity | + +NOTE 1: The "anySlice" attribute is not applicable to features "UeMobility" and "NetworkPerformance". The "snssais" attribute is not applicable to features "ServiceExperience", "NsiLoad", "UeMobility" and "NetworkPerformance". When event-id in the request is "LOAD\_LEVEL\_INFORMATION", the identifications of network slices, either information about slice(s) identified by the "snssais" attribute, or "anySlice" set to "true", shall be included. When the requested event-id is "NSI\_LOAD\_LEVEL" or "SERVICE\_EXPERIENCE", either the "nsiInfos" attribute or anySlice set to "true" shall be included. When the requested event-id is "QOS\_SUSTAINABILITY", "NF\_LOAD", "UE\_COMM", "ABNORMAL\_BEHAVIOUR", "USER\_DATA\_CONGESTION", "DISPERSION" "RED\_TRANS\_EXP", "PFD\_DETERMINATION", "PDU\_SESSION\_TRAFFIC" or "RELATIVE\_PROXIMITY", the identifications of network slices identified by the "snssais" attribute is optional. + +NOTE 2: For different events, the following rules apply: + +- For "NETWORK\_PERFORMANCE" or "USER\_DATA\_CONGESTION" event, the + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|

"networkArea" attribute shall be provided if the event applied for all UEs (i.e. "anyUe" attribute set to true).

  • - For "QOS_SUSTAINABILITY", at least one of "networkArea" and "fineGranAreas" attributes shall be provided.
  • - For "E2E_DATA_VOL_TRANS_TIME", the "networkArea" attribute shall be provided.
  • - For "MOVEMENT_BEHAVIOUR", the "networkArea" attribute shall be provided.
  • - For "SERVICE_EXPERIENCE" event, if the event applied for all UEs (i.e. "anyUe" attribute set to "true"): at least one of the "networkArea" and "fineGranAreas" attributes shall be provided.
| +| NOTE 3: Either "excepIds" or "exptAnaType" shall be provided if event-id in the request is "ABNORMAL_BEHAVIOUR". | +| NOTE 4: For "ABNORMAL_BEHAVIOUR" event with "anyUe" attribute in "tgt-ue" attribute sets to true,
  • - at least one of the "networkArea" and the "snssais" attribute should be included, if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via the "excepIds" attribute is mobility related;
  • - at least one of the "networkArea", "applIds", "dnns" and "snssais" attribute should be included, if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via the "excepIds" attribute is communication related;
  • - the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepIds" attribute shall not be requested for both mobility and communication related analytics at the same time.
| +| NOTE 5: If both the "allFreq" attribute and the "allRat" attributes in RatFreqInformation data type are present, then the only one instance of the RatFreqInformation data type shall be present to indicate for all the RAT type and Frequency value the NWDAF has received for the application. | +| NOTE 6: For service experience analytics, this parameter shall be provided when a consumer requires analytics for an edge application over a UP path. | +| NOTE 7: For service experience analytics, this parameter may be provided when a consumer requires analytics for an edge application over a UP path, and it is only needed when the target of the service experience analytics is a specific UPF included in this UP path. | +| NOTE 8: When event-id in the request is "NSI_LOAD_LEVEL" and the NsiLoadExt feature is supported, and the NF service consumer provides the "nftypes" attribute, then the NWDAF accounts only for the resource usage of the NF types included in "nftypes" to derive the output analytics. | +| NOTE 9: If this attribute is provided, the analytics target period shall be a past time period (i.e. only statistics is supported). | +| NOTE 10: When event-id in the request is "PFD_DETERMINATION" and the PfdDetermination feature is supported, the "applIds" attribute shall be included. | +| NOTE 11: Void. | +| NOTE 12: When the "pduSesInfos" attribute is provided, the associated "applIds" attribute shall be provided for the NWDAF to be able to compute the service experience per application. | +| NOTE 13: When the subscribed event is "PDU_SESSION_TRAFFIC" and the PduSesTraffic feature is supported, at least one of the "dnns" and/or "snssais" attributes as the route selection descriptor(s) for the URSP rule shall be included. | +| NOTE 14: Void. | +| NOTE 15: When this attribute is provided, the NWDAF shall provide the analytics per elementary time slot accordingly. | +| NOTE 16: When this attribute is provided, the NWDAF shall provide the analytics per group of TAs or cells accordingly. | +| NOTE 17: If both "networkArea" and "fineGranAreas" attributes are provided, the Area of Interest is interpreted as the intersection area indicated by these two attributes. | +| NOTE 18: When the subscribed event is "LOC_ACCURACY", only one of the "networkArea" or "location" attribute shall be included. | +| NOTE 19: The "LON_AND_LAT_LEVEL" value of "locGranularity" attribute is not applicable to features "DispersionExt_eNA". The "TA_LEVEL" or "CELL_LEVEL" value of "locGranularity" attribute is not applicable to features "MovementBehaviour". | +| NOTE 20: When the RoamingAnalytics feature is supported, the NF service consumer is in the VPLMN, and the NWDAF determines that the request is for roaming analytics in the HPLMN, this attribute may contain the mapped S-NSSAI(s) of the HPLMN. | + +NOTE: Care needs to be taken to avoid excessive signalling. + +Editor's Note: Which attributes of the accuReq attribute are applicable here is FFS. + +5.2.6.2.4 Void + +5.2.6.2.5 Type AdditionInfoAnalyticsInfoRequest + +**Table 5.2.6.2.5-1: Definition of type AdditionInfoAnalyticsInfoRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| rvWaitTime | DurationSec | O | 0..1 | Recommended minimum time interval (in seconds) to be used to determine the time when analytics information is needed in similar future requests.
It may only be included if the "cause" attribute within the ProblemDetails data type is set to "UNSATISFIED_REQUESTED_ANALYTICS_TIME". | | + +5.2.6.2.6 Type ContextData + +**Table 5.2.6.2.6-1: Definition of type ContextData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------|---------------| +| contextElem | array(ContextElement) | M | 1..N | List of items that contain context information corresponding with a context identifier. | | + +### 5.2.6.2.7 Type ContextElement + +**Table 5.2.6.2.7-1: Definition of type ContextElement** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| contextId | AnalyticsContextId
entifier | M | 1 | Context identifier of the context information contained in the rest of the attributes. | | +| pendAnalytics | array(EventNotification) | C | 1..N | Contains output analytics for the analytics subscription this context element is associated with, which have not yet been sent to the analytics consumer. It shall be provided if such analytics are available and the NF service consumer has requested the "PENDING_ANALYTICS" context type. | | +| histAnalytics | array(EventNotification) | C | 1..N | Contains historical output analytics for the analytics subscription this context element is associated with. It shall be provided if such analytics are available and the NF service consumer has requested the "HISTORICAL_ANALYTICS" context type. | | +| lastOutputTime | DateTime | C | 0..1 | Timestamp of the last output analytics provided to the analytics consumer. It shall be provided if output analytics had been provided and the NF service consumer has requested the "PENDING_ANALYTICS" and/or "HISTORICAL_ANALYTICS" context type. Absence of this attribute means that no output analytics had been sent. | | +| aggrSubs | array(SpecificAnalyticsSubscription) | C | 1..N | Contains analytics subscription aggregation information, i.e. information about analytics subscriptions that the NWDAF has with other NWDAFs that collectively serve an analytics subscription. It shall be provided if such subscriptions exist and the NF service consumer has requested the "AGGR_SUBS" context type. | | +| histData | array(HistoricalData) | C | 1..N | Contains historical data related to the analytics subscription this context element is associated with. It shall be provided if such data exists and the NF service consumer has requested the "DATA" context type. | | +| adrflId | NfInstanceId | O | 0..1 | Identifier of the ADRF in which the NWDAF stores analytics context information. | | +| adrfDataTypes | array(AdrfDataType) | C | 1..N | Type(s) of data stored in the ADRF by the NWDAF. It shall be provided if the attribute "adrflId" is provided. | | +| aggrNwdaflDs | array(NfInstanceId) | C | 1..N | NWDAF identifiers of NWDAF instances used by the NWDAF service consumer when aggregating multiple analytics subscriptions. It shall be provided if such information is available and the NF service consumer has requested the "AGGR_INFO" context type. | | +| modellInfos | array(ModellInfo) | C | 1..N | Contains information identifying the ML model(s) that the consumer | | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | NWDAF is currently subscribing for the analytics. It shall be provided if such information is available and the NF service consumer has requested the "ML_MODELS" context type. | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +#### 5.2.6.2.8 Type ContextIdList + +**Table 5.2.6.2.8-1: Definition of type ContextIdList** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------------|---|-------------|--------------------------------------------------------------------------------|---------------| +| contextIds | array(AnalyticsContextIdentifier) | M | 1..N | List of context identifiers of context information of analytics subscriptions. | | + +#### 5.2.6.2.9 Type HistoricalData + +**Table 5.2.6.2.9-1: Definition of type HistoricalData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------------------|---|-------------|---------------------------------------------------------------|---------------| +| startTime | DateTime | O | 0..1 | Start of the time period during which the data was collected. | | +| endTime | DateTime | O | 0..1 | End of the time period during which the data was collected. | | +| subsWithSources | array(SpecificDataSubscription) | O | 1..N | Information about subscriptions with the data sources. | | +| data | array(DataNotification) | M | 1..N | Historical data related to the analytics. | | + +#### 5.2.6.2.10 Type SpecificAnalyticsSubscription + +**Table 5.2.6.2.10-1: Definition of type SpecificAnalyticsSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------|---------------| +| subscriptionId | string | M | 1 | The identifier of the specific analytics subscription. | | +| producerId | NfInstanceId | C | 0..1 | NWDAF instance identifier to which the NF service consumer has established this subscription.
(NOTE) | | +| producerSetId | NfSetId | C | 0..1 | NWDAF set identifier to which the NF service consumer has established this subscription.
(NOTE) | | +| nwdafEvSub | NnwdafEventsSubscription | M | 1 | Contains information about the analytics subscription. | | + +NOTE: Exactly One of "producerId" and "producerSetId" shall be included. + +#### 5.2.6.2.11 Type RequestedContext + +**Table 5.2.6.2.11-1: Definition of type RequestedContext** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------|---------------| +| contexts | array(ContextType) | M | 1..N | Contains the types of the analytics context information the consumer wishes to receive. | | + +## 5.2.6.2.12 Type SmcceInfo + +Table 5.2.6.2.12-1: Definition of type SmcceInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dnn | Dnn | C | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.
Shall be present if the "dnns" was provided in the event subscription or analytics request. | | +| snssai | Snssai | C | 0..1 | Identifies the network slice information.
Shall be present if the "snssais" was provided in the event subscription or analytics request. | | +| smcceUeList | SmcceUeList | M | 1 | Contains the list of UEs classified based on experience level of SM congestion control. | | + +## 5.2.6.2.13 Type SmcceUeList + +Table 5.2.6.2.13-1: Definition of type SmcceUeList + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| highLevel | array(Supi) | C | 1..N | A list of UEs whose experience level of SMCC for specific DNN and/or S-NSSAI is high.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "LIST_OF_HIGH_EXP_UE".
(NOTE 1) (NOTE 2) | | +| mediumLevel | array(Supi) | C | 1..N | A list of UEs whose experience level of SMCC for specific DNN and/or S-NSSAI is medium.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "LIST_OF_MEDIUM_EXP_UE".
(NOTE 1) (NOTE 2) | | +| lowLevel | array(Supi) | C | 1..N | A list of UEs whose experience level of SMCC for specific DNN and/or S-NSSAI is low.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "LIST_OF_LOW_EXP_UE".
(NOTE 1) (NOTE 2) | | + +NOTE 1: At least one of "highLevel", "mediumLevel" or "lowLevel" shall be provided. + +NOTE 2: If the "listOfAnaSubsets" attribute with value only applicable to SMCC event is present in the request, then only the corresponding attribute(s) shall be present. + +## 5.2.6.2.14 Type SpecificDataSubscription + +Table 5.2.6.2.14-1: Definition of type SpecificDataSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------|---------------| +| subscriptionId | string | M | 1 | The identifier of the specific data subscription. | | +| producerId | NfInstanceId | C | 0..1 | NF instance identifier to which the NF service consumer has established this subscription. (NOTE) | | +| producerSetId | NfSetId | C | 0..1 | NF set identifier to which the NF service consumer has established this subscription. (NOTE) | | +| dataSub | DataSubscription | M | 1 | Contains information about the subscription with the data source. | | + +NOTE: One of "producerId" and "producerSetId" shall be included. + +## 5.2.6.2.15 Type UserDataCongestReq + +Table 5.2.6.2.15-1: Definition of type UserDataCongestReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------|---------------| +| orderCriterion | UserDataConOrderCrit | O | 0..1 | The ordering criterion for the list of User Data Congestion analytics. (NOTE 2) | | +| orderDirection | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "orderCriterion" attribute is included. (NOTE 1) | | + +NOTE 1: The "CROSSED" value in "MatchingDirection" data type is not applicable for this attribute. +NOTE 2: If the the value of "orderCriterion" attribute is "APPLICABLE\_TIME\_WINDOW", the "ASCENDING" direction indicates that the list of User Data Congestion analytics are in chronological order and the "DESCENDING" direction indicates that the list of User Data Congestion analytics are in reverse chronological order. + +## 5.2.6.2.16 Type NetworkPerfReq + +Table 5.2.6.2.16-1: Definition of type NetworkPerfReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------|---------------| +| orderCriterion | NetworkPerfOrderCriterion | O | 0..1 | The ordering criterion for the list of network performance analytics. | | +| orderDirection | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "orderCriterion" attribute is included. (NOTE) | | + +NOTE: The "CROSSED" value in "MatchingDirection" data type is not applicable for this attribute. + +### 5.2.6.2.17 Type ResourceUsageRequPerNwPerfType + +**Table 5.2.6.2.17-1: Definition of type ResourceUsageRequPerNwPerfType** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| nwPerfType | NetworkPerfType | M | 1 | Indicates network performance type. | | +| rscUsgReq | ResourceUsageRequirement | O | 0..1 | Indicates more requirements when providing resource usage information for the network performance type indicated by the "nwPerfType" attribute.
(NOTE) | | + +NOTE: The "rscUsgReq" value is only applicable when the "nwPerfType" attribute is set to "GNB\_RSC\_USAGE\_OVERALL\_TRAFFIC", "GNB\_RSC\_USAGE\_GBR\_TRAFFIC" or "GNB\_RSC\_USAGE\_DELAY\_CRIT\_GBR\_TRAFFIC". + +### 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 | +|-----------|-----------------|-------------|---------------| +| n/a | | | | + +## 5.2.6.3.3 Enumeration: EventId + +Table 5.2.6.3.3-1: Enumeration EventId + +| Enumeration value | Description | Applicability | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------|--------------------------| +| E2E_DATA_VOL_TRANS_TIME | Represents the analytics of E2E data volume transfer time. | E2eDataVolTransTime | +| LOAD_LEVEL_INFORMATION | Represents the analytics of load level information of corresponding network slice. | | +| NETWORK_PERFORMANCE | Represents the analytics of network performance information | NetworkPerformance | +| NF_LOAD | Represents the analytics of NF Load information. | NfLoad | +| QOS_SUSTAINABILITY | Represents the analytics of QoS sustainability in the certain area. | QoSustainability | +| SERVICE_EXPERIENCE | Represents the analytics of service experience of corresponding application and/or network slice. | ServiceExperience | +| UE_MOBILITY | Represents the analytics of UE mobility. | UeMobility | +| UE_COMM | Represents the analytics of UE communication. | UeCommunication | +| USER_DATA_CONGESTION | Represents the analytics of the user data congestion in the certain area. | UserDataCongestion | +| ABNORMAL_BEHAVIOUR | Represents the analytics of abnormal behaviour information. | AbnormalBehaviour | +| NSI_LOAD_LEVEL | Represents the analytics of load level information of Network Slice and the optionally associated Network Slice Instance. | NsiLoad | +| SM_CONGESTION | Represents the analytics of Session Management congestion control experience information for specific DNN and/or S-NSSAI. | SMCCE | +| DN_PERFORMANCE | Represents the analytics of DN performance. | DnPerformance | +| DISPERSION | Represents the analytics of dispersion. | Dispersion | +| RED_TRANS_EXP | Represents the analytics of Redundant Transmission Experience. | RedundantTransmissionExp | +| WLAN_PERFORMANCE | Represents the analytics of WLAN performance. | WlanPerformance | +| PFD_DETERMINATION | Represents the analytics of PFD Determination information for known application identifier(s). | PfdDetermination | +| PDU_SESSION_TRAFFIC | Represents the analytics of PDU Session traffic information. | PduSesTraffic | +| MOVEMENT_BEHAVIOUR | Represents the analytics of Movement Behaviour information. | MovementBehaviour | +| LOC_ACCURACY | Represents the analytics of Location Accuracy. | LocAccuracy | +| RELATIVE_PROXIMITY | Represents the analytics of Relative Proximity information. | RelativeProximity | + +#### 5.2.6.3.4 Enumeration: ContextType + +**Table 5.2.6.3.4-1: Enumeration ContextType** + +| Enumeration value | Description | Applicability | +|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| PENDING_ANALYTICS | Represents context information that relates to pending output analytics. | | +| HISTORICAL_ANALYTICS | Represents context information that relates to historical output analytics. | | +| AGGR_SUBS | Represents context information about the analytics subscriptions that an NWDAF has with other NWDAFs that collectively serve an analytics subscription. | | +| DATA | Represents context information about historical data that is available. | | +| AGGR_INFO | Represents context information that is related to aggregation of analytics from multiple NWDAF subscriptions. | | +| ML_MODELS | Represents context information about used ML models. | | + +#### 5.2.6.3.5 Enumeration: AdrfDataType + +**Table 5.2.6.3.5-1: Enumeration AdrfDataType** + +| Enumeration value | Description | Applicability | +|----------------------|-------------------------------------------------------------|---------------| +| HISTORICAL_ANALYTICS | Indicates that historical analytics are stored in the ADRF. | | +| HISTORICAL_DATA | Indicates that historical data are stored in the ADRF. | | + +#### 5.2.6.4 Data types describing alternative data types or combinations of data types + +##### 5.2.6.4.1 Type ProblemDetailsAnalyticsInfoRequest + +**Table 5.2.6.4.1-1: Definition of type ProblemDetailsAnalyticsInfoRequest as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|----------------------------------|-------------|------------------------------------------------------------------------|---------------| +| ProblemDetails | 1 | Details of the problem as defined in TS 29.571 [8]. | | +| AdditionInfoAnalyticsInfoRequest | 1 | Contains additional information why the analytics request is rejected. | | + +### 5.2.7 Error handling + +#### 5.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [6]. + +For the Nnwdaf\_AnalyticsInfo API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] 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 [6]. In addition, the requirements in the following clauses shall apply. + +#### 5.2.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_AnalyticsInfo API. + +### 5.2.7.3 Application Errors + +The application errors defined for the Nnwdaf\_AnalyticsInfo API are listed in table 5.2.7.3-1. + +**Table 5.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| BOTH_STAT_PRED_NOT_ALLOWED | 400 Bad Request | Indicates that the request shall be rejected, because for the requested observation period, the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics is not allowed. | | +| PREDICTION_NOT_ALLOWED | 400 Bad Request | Indicates that the request shall be rejected because the prediction for the analytics event is not allowed. | PredictionError | +| USER_CONSENT_NOT_GRANTED | 403 Forbidden | Indicates that the request shall be rejected because an impacted user has not provided the required user consent. | | +| UNAVAILABLE_DATA | 500 Internal Server Error | Indicates the requested statistics in the past is rejected since necessary data to perform the service is unavailable. | | +| UNSATISFIED_REQUESTED_ANALYTICS_TIME | 500 Internal Server Error | Indicates that the requested event is rejected since the analytics information is not ready when the time indicated by the "timeAnaNeeded" attribute (as provided during the request) is reached. | | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | | + +### 5.2.8 Feature negotiation + +The optional features in table 5.2.8-1 are defined for the Nnwdaf\_AnalyticsInfo API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | UeMobility | This feature indicates the support of analytics based on UE mobility information. | +| 2 | UeCommunication | This feature indicates the support of analytics based on UE communication information. | +| 3 | NetworkPerformance | This feature indicates the support of analytics based on network performance. | +| 4 | ServiceExperience | This feature indicates support for the event related to service experience. | +| 5 | QoSustainability | This feature indicates support for the event related to QoS sustainability. | +| 6 | AbnormalBehaviour | This feature indicates support for the event related to abnormal behaviour information. | +| 7 | UserDataCongestion | This feature indicates the support of the analytics related on user data congestion. | +| 8 | NfLoad | This feature indicates the support of the analytics related to the load of NF instances. | +| 9 | NsiLoad | This feature indicates the support of the analytics related to the load level of Network Slice and the optionally associated Network Slice Instance. | +| 10 | EneNA | This feature indicates support for the enhancements of network data analytics requirements. | +| 11 | UserDataCongestionExt | This feature indicates support for the extensions to the event related to user data congestion, including support of GPSI and/or list of Top applications. Supporting this feature also requires the support of feature UserDataCongestion. | +| 12 | Aggregation | This feature indicates support for analytics aggregation. | +| 13 | NsiLoadExt | This feature indicates support for the extensions to the event related to the load level of Network Slice and the optionally associated Network Slice Instance, including support of area of interest, NF load information and number of UE or number of PDU Session. Supporting this feature also requires the support of feature NsiLoad. | +| 14 | ServiceExperienceExt | This feature indicates support for the extensions to the event related to service experience, including support of RAT type and/or Frequency. Supporting this feature also requires the support of feature ServiceExperience. | +| 15 | SMCCE | This feature indicates support for the event related to SM congestion control experience. | +| 16 | NfLoadExt | This feature indicates support for the extensions to the event related to the load of NF instances, including NF load over area of interest. Supporting this feature also required the support of feature NfLoad. | +| 17 | Dispersion | This feature indicates support for the event related to dispersion analytics information. | +| 18 | RedundantTransmissionExp | This feature indicates support for the event related to redundant transmission experience analytics information. | +| 19 | WlanPerformance | This feature indicates support of the event related to WLAN performance analytics information. | +| 20 | UeMobilityExt | This feature indicates support for extensions to the event related to UE mobility, including support of LADN DNN to refer the LADN service area as the AOI. Supporting this feature also requires the support of feature UeMobility. | +| 21 | DnPerformance | This feature indicates the support of the analytics related to DN performance. | +| 22 | AnaCtxTransfer | This feature indicates the support of analytics context transfer. | +| 23 | UserConsent | Indicates the support of detailed handling of user consent, e.g. error responses related to the lack of user consent. | +| 24 | UserDataCongestionExt2_eNA | This feature indicates support for the enhancements of user data congestion, including support of ordering criterion. Supporting this feature also requires the support of UserDataCongestion and UserDataCongestionExt features. | +| 25 | UeMobilityExt2_eNA | This feature indicates support for the enhancements of UE mobility, including support of ordering criterion. Supporting this feature also requires the support of UeMobility and UeMobilityExt features. | + +| | | | +|----|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 26 | UeCommunicationExt_eNA | This feature indicates support for the enhancements of UE Communication, including support of ordering criterion. Supporting this feature also requires the support of UeCommunication feature. | +| 33 | NetworkPerformanceExt_eNA | This feature indicates support for the enhancements of Network Performance, including support of ordering criterion for the list of analytics and analytics target period subset. Supporting this feature also requires the support of NetworkPerformance feature. | +| 28 | PfdDetermination | This feature indicates the support of the analytics related to PFD Determination information of known application identifier(s). | +| 29 | ServiceExperienceExt2_eNA | This feature indicates extensions to the event related to service experience supporting eNA, including support for PDU Session parameters information for service experience analytics. Supporting this feature also requires the support of feature ServiceExperience. | +| 31 | DnPerformanceExt_AIML | This feature indicates support for extensions to the event related to DN Performance supporting AIML, including support of extended DN Performance Analytics for group of UEs. Supporting this feature also requires the support of feature DnPerformance. | +| 32 | UeMobilityExt_AIML | This feature indicates support for further extensions to the event related to UE mobility supporting AIML, including support of UE's geographical distribution and direction analytics. Supporting this feature also requires the support of feature UeMobility. | +| 33 | PduSesTraffic | This feature indicates support of the analytics related to PDU Session traffic information. | +| 34 | DispersionExt_eNA | This feature indicates support for the enhancements of Dispersion, including the support of preferred granularity of UE location. Supporting this feature also requires the support of Dispersion feature. | +| 35 | WlanPerformanceExt_AIML | This feature indicates support for the enhancements of WLAN performance supporting AIML, including support of analytics per UE granularity. Supporting this feature also requires the support of feature WlanPerformance. | +| 36 | NetworkPerformanceExt_AIML | This feature indicates support of the network performance enhancements for AI/ML-based Services. Within this feature the following enhancements are covered:
- support of providing gNB resource usage for GBR traffic and Delay-critical GBR traffic.

Supporting this feature also requires the support of NetworkPerformance feature. | +| 37 | E2eDataVolTransTime | This feature indicates support for E2E data volume transfer time analytics | +| 38 | AnalyticsAccuracy | This feature indicates support for the Analytics Accuracy information. | +| 39 | EnAbnormalBehaviour | This feature indicates support for the enhancements of UE Abnormal Behaviour. Supporting this feature also requires the support of AbnormalBehaviour feature. | +| 40 | UeCommunicationExt | This feature indicates the support for the extensions to the event related to UE communication, including support of reporting the analytics of the application list used by UE, N4 Session inactivity timer, and whether the UE communicates periodically or not. Supporting this feature also requires the support of UeCommunication feature. | +| 41 | QoSSustainExt_eNA | This feature indicates support for the enhancements of QoS Sustainability, including:
- support of temporal and spatial granularity size.

Supporting this feature also requires the support of QoSSustainability feature. | +| 42 | WlanPerfExt_eNA | This feature indicates support for the enhancements of WLAN performance, including:
- support of temporal granularity size.

Supporting this feature also requires the support of feature WlanPerformance. | + +| | | | +|----|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 43 | DnPerfExt_eNA | This feature indicates support for extensions to the event related to DN Performance, including support of number of UEs. Supporting this feature also requires the support of feature DnPerformance. | +| 44 | QoSustainExt_eNA | This feature indicates support for the enhancements of QoS Sustainability, including enhancements of filter information. Supporting this feature also requires the support of QoSustainability feature. | +| 45 | MovementBehaviour | This feature indicates support for the Movement Behaviour information. | +| 46 | LocAccuracy | This feature indicates support for the Location Accuracy analytics. | +| 47 | RelativeProximity | This feature indicates support for the Relative Proximity analytics. | +| 48 | ENAExt | This feature indicates support for the general enhancements of network data analytics requirements, including support more level of accuracy and support for use case context sent by the NF service consumer to the NWDAF. | +| 49 | RoamingAnalytics | This feature indicates support for the Roaming analytics. | +| 50 | PredictionError | This feature indicates support for Prediction Error handling. | + +## 5.2.9 Security + +As indicated in 3GPP TS 33.501 [13] and 3GPP TS 29.500 [6], the access to the Nnwdaf\_AnalyticsInfo API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [14]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnwdaf\_AnalyticsInfo API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], 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 Nnwdaf\_AnalyticsInfo service. + +The Nnwdaf\_AnalyticsInfo API defines the following scopes for OAuth2 authorization as described in 3GPP TS 29.501 [7], clause 4.x. + +**Table 5.2.9-1: OAuth2 scopes defined in Nnwdaf\_AnalyticsInfo API** + +| Scope | Description | +|----------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| "nnwdaf-analyticsinfo" | Access to the Nnwdaf_AnalyticsInfo API | +| "nnwdaf-analyticsinfo:contexttransfer" | Access to service operations applying to NWDAF context transfer related service operations, i.e. ContextTransfer. | + +## 5.3 Nnwdaf\_DataManagement Service API + +### 5.3.1 Introduction + +The Nnwdaf\_DataManagement service shall use the Nnwdaf\_DataManagement API. + +The API URI of the Nnwdaf\_DataManagement API shall be: + +{apiRoot}// + +The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}/// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-datamanagement". + +- The shall be "v1". +- The shall be set as described in clause 5.3.3. + +## 5.3.2 Usage of HTTP + +### 5.3.2.1 General + +HTTP/2, IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_DataManagement is contained in Annex A. + +### 5.3.2.2 HTTP standard headers + +#### 5.3.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +#### 5.3.2.2.2 Content type + +JSON, IETF RFC 8259 [10], 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 [6]. 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 9457 [15]. + +### 5.3.2.3 HTTP custom headers + +The Nnwdaf\_DataManagement service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_DataManagement service API. + +## 5.3.3 Resources + +### 5.3.3.1 Resource Structure + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.3.3.1-1 depicts the resource URIs structure for the Nnwdaf\_DataManagement API. + +![Diagram showing the resource URI structure for the Nnwdaf_DataManagement API. The root URI is {apiRoot}/nnwdaf-datamanagement/. A line branches from this root to a box containing /subscriptions. From this box, another line branches to a box containing /{subscriptionId}.](00bb8c9fd2ec7fa7da34a98f824468b6_img.jpg) + +{apiRoot}/nnwdaf-datamanagement/ + +``` + +graph TD + Root["{apiRoot}/nnwdaf-datamanagement/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the resource URI structure for the Nnwdaf\_DataManagement API. The root URI is {apiRoot}/nnwdaf-datamanagement/. A line branches from this root to a box containing /subscriptions. From this box, another line branches to a box containing /{subscriptionId}. + +**Figure 5.3.3.1-1: Resource URI structure of the Nnwdaf\_DataManagement API** + +Table 5.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------------------------------|---------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------| +| NWDAF Data Management Subscriptions | /subscriptions | POST | Creates a new Individual NWDAF Data Management Subscription resource. | +| Individual NWDAF Data Management Subscription | /subscriptions/{subscriptionId} | DELETE | Deletes an Individual NWDAF Data Management Subscription identified by subresource {subscriptionId}. | +| | | PUT | Modifies an existing Individual NWDAF Data Management Subscription identified by subresource {subscriptionId}. | + +## 5.3.3.2 Resource: NWDAF Data Management Subscriptions + +### 5.3.3.2.1 Description + +The NWDAF Data Management Subscriptions resource represents all subscriptions to the Nnwdaf\_DataManagement Service at a given NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF Data Management Subscription resource. + +### 5.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnwdaf-datamanagement//subscriptions + +The shall be set as described in clause 5.3.1. + +This resource shall support the resource URI variables defined in table 5.3.3.2.2-1. + +**Table 5.3.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.3.1 | + +### 5.3.3.2.3 Resource Standard Methods + +#### 5.3.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.3.2.3.1-1. + +**Table 5.3.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.3.2.3.1-3. + +**Table 5.3.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|----------------------------------------------------------------------| +| NnwdafDataManagementSubsc | M | 1 | Create a new Individual NWDAF Data Management Subscription resource. | + +**Table 5.3.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| NnwdafDataManagementSubsc | M | 1 | 201 Created | The creation of an Individual NWDAF Data Management Subscription resource is confirmed and a representation of that resource is returned. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure cases are described in clause 5.3.7. + +**Table 5.3.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}/nnwdaf-datamanagement//subscriptions/{subscriptionId} | + +### 5.3.3.2.4 Resource Custom Operations + +None in this release of the specification. + +## 5.3.3.3 Resource: Individual NWDAF Data Management Subscription + +### 5.3.3.3.1 Description + +The Individual NWDAF Data Management Subscription resource represents a single subscription to the Nnwdaf\_DataManagement Service at a given NWDAF. + +### 5.3.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-datamanagement//subscriptions/{subscriptionId} + +The shall be set as described in clause 5.3.1. + +This resource shall support the resource URI variables defined in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|----------------------------------------------------------------| +| apiRoot | string | See clause 5.3.1 | +| subscriptionId | string | Identifies a subscription to the Nnwdaf_DataManagement Service | + +### 5.3.3.3.3 Resource Standard Methods + +#### 5.3.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 5.3.3.3.3.1-1. + +**Table 5.3.3.3.3.1-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.3.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.3.1-3. + +**Table 5.3.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|--------------------------------------------------------------------------------------| +| NnwdafDataManagementSubsc | M | 1 | Parameters to replace a subscription to NWDAF Data Management Subscription resource. | + +**Table 5.3.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| NnwdafDataManagementSubsc | M | 1 | 200 OK | The Individual NWDAF Data Management Subscription resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF Data Management Subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Data Management Subscription modification.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Data Management Subscription modification.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +NOTE 2: Failure cases are described in clause 5.3.7. + +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.3.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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.3.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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.3.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.3.2-1. + +**Table 5.3.3.3.3.2-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.3.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.3.2-3. + +**Table 5.3.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.2-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 NWDAF Data Management Subscription resource matching the subscriptionId was deleted. | +| NnwdafDataManagementNotification | C | 0..1 | 200 OK | Successful case: The Individual NWDAF Data Management Subscription resource matching the subscriptionId was deleted and including the stored unsent events in the response. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Data Management Subscription deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Data Management Subscription deletion.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +### 5.3.3.3.4 Resource Custom Operations + +None in this release of the specification. + +## 5.3.4 Custom Operations without associated resources + +## 5.3.5 Notifications + +### 5.3.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.3.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|--------------|---------------------------------|--------------------------------------| +| Event Notification | {notificURI} | POST | Report one or several observed data. | +| Fetch Notification | {fetchUri} | POST | Fetch one or several notified data. | + +### 5.3.5.2 Event Notification + +#### 5.3.5.2.1 Description + +The Event Notification is used by the NWDAF to report one or several observed data to an NF service consumer that has subscribed to such Notifications. + +#### 5.3.5.2.2 Operation Definition + +Callback URI: **{notificURI}** + +The operation shall support the callback URI variables defined in Table 5.3.5.2.2-1, the request data structures specified in table 5.3.5.2.2-2 and the response data structure and response codes specified in Table 5.3.5.2.2-3. + +**Table 5.3.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificURI | Uri | The Notification Uri is assigned within the Individual NWDAF Data Management Subscription Resource and described within the NnwdafDataManagementSubsc type (see table 5.3.6.2.2-1). | + +**Table 5.3.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|-------------------------------------------| +| NnwdafDataManagementNotif | M | 1 | Provides Information about observed data. | + +**Table 5.3.5.2.2-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 the event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.3.5.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 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.3.5.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +### 5.3.5.3 Fetch Notification + +#### 5.3.5.3.1 Description + +The Fetch Notification is used by the NF service consumer to retrieve data from the NWDAF. + +#### 5.3.5.3.2 Target URI + +The Callback URI "{fetchUri}" shall be used with the callback URI variables defined in table 5.3.5.3.2-1. + +**Table 5.3.5.3.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|-----------------------------------------------------------------------------------------------------------------------------| +| fetchUri | Uri | Fetch Uri as assigned during the procedure of notification about the subscribed data within the FetchInstruction data type. | + +#### 5.3.5.3.3 Standard Methods + +##### 5.3.5.3.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.5.3.3.1-1. + +**Table 5.3.5.3.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.3.5.3.3.1-2 and the response data structures and response codes specified in table 5.3.5.3.3.1-3. + +**Table 5.3.5.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-----------------------------------------------| +| array(string) | M | 1..N | Indicate the fetch correlation identifier(s). | + +**Table 5.3.5.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------|---|-------------|------------------------|-------------------------------------------------------------------| +| NnwdafDataManagementNotification | M | 1 | 200 OK | The stored data related to the fetch correlation identifier(s). | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.3.5.3.3.1-4: Headers supported by the by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NWDAF towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +**Table 5.3.5.3.3.1-5: Headers supported by the 308 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NWDAF towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +## 5.3.6 Data Model + +### 5.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.3.6.1-1 specifies the data types defined for the Nnwdaf\_DataManagement service based interface protocol. + +**Table 5.3.6.1-1: Nnwdaf\_DataManagement specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------------------|----------------|------------------------------------------------------------------------------------------------------------|---------------| +| NnwdafDataManagementSubsc | 5.3.6.2.2 | Represents an Individual NWDAF Data Management Subscription resource. | | +| NnwdafDataManagementNotif | 5.3.6.2.3 | Represents a notification that corresponds with an Individual NWDAF Data Management Subscription resource. | | +| PendingNotificationCause | 5.3.6.3.3 | Represents the Pending Notification Cause for the stored unsent events. | EnhDataMgmt | + +Table 5.3.6.1-2 specifies data types re-used by the Nnwdaf\_DataManagement 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 Nnwdaf\_DataManagement service based interface. + +**Table 5.3.6.1-2: Nnwdaf\_DataManagement re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|---------------------|-------------------------------------------------------------------------------------------|----------------| +| DataCollectionPurpose | 3GPP TS 29.574 [26] | Represents the purpose for data collection, e.g. analytics or model training. | | +| DataNotification | 3GPP TS 29.575 [27] | Represents data subscription notification from data source (e.g. AMF, SMF, UDM, NEF, AF). | | +| DataSubscription | 3GPP TS 29.575 [27] | Represents data subscription from data source (e.g. AMF, SMF, UDM, NEF, AF). | | +| DateTime | 3GPP TS 29.571 [8] | Identifies the time. | | +| DeletionAlert | 3GPP TS 29.574 [26] | Contains information about data that are about to be deleted. | EnhDataMgmt | +| FormattingInstruction | 3GPP TS 29.574 [26] | DCCF formatting Instructions. | | +| FetchInstruction | 3GPP TS 29.576 [28] | The fetch instruction indicates whether the data can be fetched by the consumer. | | +| NfInstanceId | 3GPP TS 29.571 [8] | NF instance identifier. | | +| NfSetId | 3GPP TS 29.571 [8] | NF set identifier. | | +| NnwdafEventsSubscription | 5.1.6.2.2 | Represents an NWDAF analytics subscription. | | +| NotifSummaryReport | 3GPP TS 29.574 [26] | Contains a summary report of processed notifications. | | +| NotifyEndpoint | 3GPP TS 29.574 [26] | The information of notification endpoint. | DataAnaCollect | +| NotifResponse | 3GPP TS 29.574 [26] | Contains information about the planned action upon receiving a notification. | EnhDataMgmt | +| ProcessingInstruction | 3GPP TS 29.574 [26] | DCCF processing Instructions. | | +| StorageHandlingInformation | 3GPP TS 29.574 [26] | Contains storage handling information for data or analytics. | EnhDataMgmt | +| SupportedFeatures | 3GPP TS 29.571 [8] | | | +| TimeWindow | 3GPP TS 29.122 [19] | Represents a time window. | | +| Uri | 3GPP TS 29.571 [8] | URI. | | + +## 5.3.6.2 Structured data types + +### 5.3.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 5.3.6.2.2 Type NnwdafDataManagementSubsc + +**Table 5.3.6.2.2-1: Definition of type NnwdafDataManagementSubsc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| adrflId | NfInstanceId | O | 0..1 | Identifier of the ADRF to be used by the NWDAF.
If the subscription is for runtime analytics (i.e. the "timePeriod" attribute is either absent or contains a time window in the future) then the NWDAF shall store the notifications in this ADRF.
If the subscription is for historical analytics (i.e. the "timePeriod" attribute contains a time window in the past) then the NWDAF shall retrieve the data from this ADRF. (NOTE 2) | | +| adrSetId | NfSetId | O | 0..1 | Identifier of the ADRF Set to be used by the NWDAF.
If the subscription is for runtime analytics (i.e. the "timePeriod" attribute is either absent or contains a time window in the future) then the NWDAF shall store the notifications in this ADRF Set.
If the subscription is for historical analytics (i.e. the "timePeriod" attribute contains a time window in the past) then the NWDAF shall retrieve the data from this ADRF Set. (NOTE 2) | | +| anaSub | NnwdafEventsSubscription | C | 0..1 | Analytics subscription information to be used by the NWDAF to determine the data that is relevant to these analytics and shall thus be collected and reported, i.e. the "anaSub" attribute may be provided when the consumer requests from the NWDAF data that it needs in order to compute the analytics that is specified by the "anaSub" attribute. (NOTE 1) | | +| checkedConsentInd | boolean | O | 0..1 | If set to "true", it indicates that the NF service consumer has already checked the user consent. The default value is "false". | UserConsent | +| dataCollectPurposes | array(DataCollectionPurpose) | O | 1..N | The purpose of data collection. This attribute may only be provided if user consent is required depending on local policy and regulations, and the consumer has not checked user consent. | | +| dataSub | DataSubscription | C | 0..1 | Subscribed data events. (NOTE 1) (NOTE 6) (NOTE 7) | | +| formatInstruct | FormattingInstruction | O | 0..1 | Formatting instructions to be used for sending event | | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | notifications. If provided, they take precedence over any potentially conflicting event reporting requirements provided within the "dataSub" attribute. | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-----------------|------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| notifURI | Uri | M | 1 | Notification target address. | | +| notifEndpoints | array(NotifyEndpoint) | O | 1..N | The additional information of notification target address and correlation identifier. | DataAnaCollect | +| procInstr | ProcessingInstruction | O | 0..1 | Processing instructions to be used for sending event notifications.
This attribute may only be provided if the "dataSub" attribute is provided.
(NOTE 4) | | +| multiProcInstrs | array(ProcessingInstruction) | O | 1..N | Processing instructions to be used for sending event notifications.
This attribute may only be provided if the "dataSub" attribute is provided.
(NOTE 4) | MultiProcessingInstruction | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features as described in clause 5.3.8.
(NOTE 5) | | +| targetNfId | NfInstanceId | O | 0..1 | NF instance identifier to which the NWDAF shall create the requested subscription. (NOTE 2) | | +| targetNfSetId | NfSetId | O | 0..1 | NF set identifier to which the NWDAF shall create the requested subscription. (NOTE 2) | | +| timePeriod | TimeWindow | O | 0..1 | Represents a start time and a stop time during which data was collected or is requested to be collected. If this attribute is included, then the internal attributes of the data subscription that indicate a subscription duration (e.g. the "targetPeriod" attribute of an "eventSubs" attribute of an "smfDataSub" attribute, or the "monDur" attribute of the ReportingInformation data type) shall not be provided.
(NOTE 3) | | +| immReport | NnwdafDataManagementNotif | O | 0..1 | Immediate report including available NWDAF data management notification. May only be present in the response to a subscription request and only if the immediate reporting indication and formatting or processing instructions were included in the subscription request. | DataAnaCollect | +| storeHandl | StorageHandlingInformation | O | 0..1 | Contains storage handling information for the data that will be collected and stored in an ADRF based on the requested subscription. | EnhDataMgmt | + +NOTE 1: Exactly one of these attributes shall be provided. +NOTE 2: "targetNfId" and "targetNfSetId" are mutually exclusive. "adrId" and "adrSetId" are also mutually exclusive. +NOTE 3: It includes the time period either in the past or in the future (i.e., start time as past time and stop time as future time is not allowed). + +- NOTE 4: The "multiProcInstrs" attribute shall be used instead of the "procInstr" attribute when the "MultiProcessingInstruction" feature is supported. +- NOTE 5: It shall be present in the POST request if at least one feature defined in clause 5.3.8 is supported, and it shall be present in the POST response if the NF service consumer includes the "suppFeat" attribute in the POST request. +- NOTE 6: The event reporting information within the "dataSub" attribute (e.g. "eventsReplInfo" attribute in the case of AF events) may include muting instructions (e.g. within the "notifFlagInstr" attribute in the case of AF events) and/or muting notifications settings (e.g. within the "mutingSetting" attribute in the case of AF events) only if the EnhDataMgmt feature is supported. +- NOTE 7: The "upfDataSub" attribute within the "dataSub" attribute is applicable only if the "UpEvents" feature is supported. The "gmlcDataSub" attribute within the "dataSub" attribute is applicable only if the "LocEvents" feature is supported. + +## 5.3.6.2.3 Type NnwdafDataManagementNotif + +Table 5.3.6.2.3-1: Definition of type NnwdafDataManagementNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dataNotification | DataNotification | C | 0..1 | List of data subscription notifications.
(NOTE 1, NOTE 3, NOTE 4) | | +| dataReports | array(NotifSummaryReport) | C | 1..N | List of reports with summarized data from multiple notifications received from data producer. (NOTE 1)
(NOTE 2) | | +| delAlert | DeletionAlert | C | 0..1 | Information about analytics that is about to be deleted. This attribute may not be present in the response of a Fetch request. (NOTE 1) | EnhDataMgmt | +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| terminationReq | string | O | 0..1 | If set to "true", it indicates that the termination of the data management subscription is requested by the NWDAF, i.e. NWDAF will not provide further notifications related to this subscription. If absent, no termination is requested. | | +| fetchInstr | FetchInstruction | C | 0..1 | The fetch instruction indicates whether the data are to be fetched by the Consumer. This attribute may not be present in the response of a Fetch request.
(NOTE 1) | | +| notifTimestamp | DateTime | M | 1 | It represents time when NWDAF completes preparation of the requested data. | | +| pendNotifCause | PendingNotificationCause | O | 0..1 | Represents the Pending Notification Cause for the stored unsent data. | EnhDataMgmt | + +NOTE 1: One of these attributes shall be provided. +NOTE 2: For every entry of the array, the "eventId" attribute shall not contain the "nwdafEvent" attribute. +NOTE 3: If the NWDAF has received the notifications from another source without a timestamp, then the NWDAF adds itself a timestamp based on the time it received the notification in timeStamp attribute contained in dataNotification attribute. +NOTE 4: The "upfEventNotifs" attribute within the "dataNotification" attribute is applicable only if the "UpEvents" feature is supported. The "gmlcEventNotifs" attribute within the "dataNotification" attribute is applicable only if the "LocEvents" feature is supported. + +## 5.3.6.3 Simple data types and enumerations + +## 5.3.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.3.6.3.2 Simple data types + +The simple data types defined in table 5.3.6.3.2-1 shall be supported. + +**Table 5.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| n/a | | | | + +### 5.3.6.3.3 Enumeration: PendingNotificationCause + +**Table 5.3.6.3.3-1: Enumeration PendingNotificationCause** + +| Enumeration value | Description | Applicability | +|---------------------------|-----------------------------------------------------|---------------| +| UE_OUT_OF_NF_SERVING_AREA | Represents the UE moved out of the NF serving area. | | +| OTHER | Represents the other cause. | | + +## 5.3.7 Error handling + +### 5.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of TS 29.500 [6]. + +For the Nnwdaf\_DataManagement API, HTTP error responses shall be supported as specified in clause 4.8 of TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of TS 29.500 [6] 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 TS 29.500 [6]. In addition, the requirements in the following clauses shall apply. + +### 5.3.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_DataManagement API. + +### 5.3.7.3 Application Errors + +The application errors defined for the Nnwdaf\_DataManagement API are listed in table 5.3.7.3-1. + +**Table 5.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SUBSCRIPTION_CANNOT_BE_SERVED | 400 Bad Request | Indicates that the NWDAF cannot use the contents of the request to either a) determine whether the subscription can already be served or interactions with the ADRF and/or data sources are required or b) determine what interactions with the ADRF and/or data sources are required (if it has determined that they are required). | +| USER_CONSENT_NOT_GRANTED | 403 Forbidden | Indicates that the request shall be rejected because an impacted user has not provided the required user consent. | +| MUTING_INSTR_NOT_ACCEPTED | 403 Forbidden | Indicates that the muting instructions received by the NF service consumer cannot be accepted. | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +## 5.3.8 Feature negotiation + +The optional features in table 5.3.8-1 are defined for the Nnwdaf\_DataManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.3.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | MultiProcessingInstruction | Indicates the support of multiple processing instructions. | +| 2 | UserConsent | Indicates the support of detailed handling of user consent, e.g. indications that user consent has been checked and error responses related to the lack of user consent. | +| 3 | DataAnaCollect | This feature indicates support for the enhancement of data and analytics collection. | +| 4 | EnhDataMgmt | Indicates the support of enhanced data management mechanisms, including supporting of pending notification, muting and storage handling. | +| 5 | UpEvents | Indicates the support of UPF events. | +| 6 | LocEvents | Indicates the support of location events. | + +## 5.3.9 Security + +As indicated in TS 33.501 [13] and TS 29.500 [6], the access to the Nnwdaf\_DataManagement API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [14]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnwdaf\_DataManagement API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in TS 29.510 [12], 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 Nnwdaf\_DataManagement service. + +The Nnwdaf\_DataManagement API defines a single scope "nnwdaf-datamanagement" for the entire service, and it does not define any additional scopes at resource or operation level. + +# 5.4 Nnwdaf\_MLModelProvision Service API + +## 5.4.1 Introduction + +The Nnwdaf\_MLModelProvision service shall use the Nnwdaf\_MLModelProvision API. + +The API URI of the Nnwdaf\_MLModelProvision API shall be: + +{apiRoot}/apiVersion> + +The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}/apiVersion>/apiSpecificResourceUriPart> + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-mlmodelprovision". +- The shall be "v1". +- The shall be set as described in clause 5.4.3. + +## 5.4.2 Usage of HTTP + +### 5.4.2.1 General + +HTTP/2, IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_MLModelProvision is contained in Annex A. + +### 5.4.2.2 HTTP standard headers + +#### 5.4.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +#### 5.4.2.2.2 Content type + +JSON, IETF RFC 8259 [10], 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 [6]. 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 9457 [15]. + +### 5.4.2.3 HTTP custom headers + +The Nnwdaf\_MLModelProvision service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_MLModelProvision service API. + +## 5.4.3 Resources + +### 5.4.3.1 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.4.3.1-1 depicts the resource URIs structure for the Nnwdaf\_MLModelProvision API. + +![Diagram showing the resource URI structure for the Nnwdaf_MLModelProvision API. The root URI is {apiRoot}/nnwdaf-mlmodelprovision/. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subscriptionId}.](7afb1fd052c6df368128542f16088890_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnwdaf-mlmodelprovision/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the resource URI structure for the Nnwdaf\_MLModelProvision API. The root URI is {apiRoot}/nnwdaf-mlmodelprovision/. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subscriptionId}. + +**Figure 5.4.3.1-1: Resource URI structure of the Nnwdaf\_MLModelProvision API** + +Table 5.4.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.4.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------------|---------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------| +| NWDAF ML Model Provision Subscriptions | /subscriptions | POST | Creates a new Individual NWDAF ML Model Provision Subscription resource. | +| Individual NWDAF ML Model Provision Subscription | /subscriptions/{subscriptionId} | DELETE | Deletes an Individual NWDAF ML Model Provision Subscription identified by subresource {subscriptionId}. | +| | | PUT | Modifies an existing Individual NWDAF ML Model Provision Subscription identified by subresource {subscriptionId}. | + +## 5.4.3.2 Resource: NWDAF ML Model Provision Subscriptions + +### 5.4.3.2.1 Description + +The NWDAF ML Model Provision Subscriptions resource represents all subscriptions to the Nnwdaf\_MLModelProvision service at a given NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF ML Model Provision Subscription resource. + +### 5.4.3.2.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-mlmodelprovision//subscriptions + +This resource shall support the resource URI variables defined in table 5.4.3.2.2-1. + +**Table 5.4.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.4.1 | + +### 5.4.3.2.3 Resource Standard Methods + +#### 5.4.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.4.3.2.3.1-1. + +**Table 5.4.3.2.3.1-1: URI query parameters supported by the POST 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.3.2.3.1-2 and the response data structures and response codes specified in table 5.4.3.2.3.1-3. + +**Table 5.4.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|--------------------------------------------------------------------------| +| NwdafMLModelProvSubsc | M | 1 | Creates a new Individual NWDAF ML Model Provision Subscription resource. | + +**Table 5.4.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| NwdaifMLModelProvSubsc | M | 1 | 201 Created | The creation of an Individual NWDAF ML Model Provision Subscription resource is confirmed and a representation of that resource is returned. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure causes are described in subclause 5.4.7.3. + +**Table 5.4.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}/nnwdaif-mlmodelprovision//subscriptions/{subscriptionId} | + +#### 5.4.3.2.4 Resource Custom Operations + +None in this release of the specification. + +### 5.4.3.3 Resource: Individual NWDAF ML Model Provision Subscription + +#### 5.4.3.3.1 Description + +The Individual NWDAF ML Model Provision Subscription resource represents a single subscription to the Nnwdaif\_MLModelProvision service at a given NWDAF. + +#### 5.4.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaif-mlmodelprovision//subscriptions/{subscriptionId} + +The shall be set as described in clause 5.4.1. + +This resource shall support the resource URI variables defined in table 5.4.3.3.2-1. + +**Table 5.4.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------------| +| apiRoot | string | See clause 5.4.1. | +| subscriptionId | string | Identifies a subscription to the Nnwdaif_MLModelProvision service. | + +#### 5.4.3.3.3 Resource Standard Methods + +##### 5.4.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 5.4.3.3.3.1-1. + +**Table 5.4.3.3.3.1-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.4.3.3.3.1-2 and the response data structures and response codes specified in table 5.4.3.3.3.1-3. + +**Table 5.4.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-----------------------------------------------------------------------------------------| +| NwdafMLModelProvSubsc | M | 1 | Parameters to replace a subscription to NWDAF ML Model Provision Subscription resource. | + +**Table 5.4.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| NwdafMLModelProvSubsc | M | 1 | 200 OK | The Individual NWDAF ML Model Provision Subscription resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF ML Model Provision Subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF ML Model Provision Subscription modification.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF ML Model Provision Subscription modification.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +NOTE 2: Failure causes are described in subclause 5.4.7.3. + +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.4.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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.4.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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +## 5.4.3.3.3.2 + +## DELETE + +This method shall support the URI query parameters specified in table 5.4.3.3.3.2-1. + +**Table 5.4.3.3.3.2-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.4.3.3.3.2-2 and the response data structures and response codes specified in table 5.4.3.3.3.2-3. + +**Table 5.4.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.4.3.3.3.2-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 NWDAF ML Model Provision Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF ML Model Provision Subscription deletion.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF ML Model Provision Subscription deletion.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.4.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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.4.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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.4.3.3.4 Resource Custom Operations + +None in this release of the specification. + +### 5.4.4 Custom Operations without associated resources + +None in this release of the specification. + +### 5.4.5 Notifications + +#### 5.4.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.4.3.4.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|--------------|---------------------------------|----------------------------------------| +| Event Notification | {notifUri} | POST | Report one or several observed Events. | + +#### 5.4.5.2 Event Notification + +##### 5.4.5.2.1 Description + +The Event Notification is used by the NWDAF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications via the Individual NWDAF ML Model Provision Subscription Resource. + +#### 5.4.5.2.2 Operation Definition + +Callback URI: {notifUri} + +The operation shall support the callback URI variables defined in table 5.4.5.2.2-1, the request data structures specified in table 5.4.5.2.2-2 and the response data structure and response codes specified in table 5.4.5.2.2-3. + +**Table 5.4.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned within the Individual NWDAF ML Model Provision Subscription and described within the NwdafMLModelProvSubsc type (see table 5.4.6.2.2-1). | + +**Table 5.4.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|---------------------------------------------| +| array(NwdafMLModelProvNotif) | M | 1..N | Provides Information about observed events. | + +**Table 5.4.5.2.2-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 the event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.4.5.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 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.4.5.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 5.4.6 Data Model + +### 5.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.4.6.1-1 specifies the data types defined for the Nnwdaf\_MLModelProvision service based interface protocol. + +**Table 5.4.6.1-1: Nnwdaf\_MLModelProvision specific Data Types** + +| Data type | Section defined | Description | Applicability | +|------------------------------|-----------------|------------------------------------------------------------------|----------------------------------------| +| AdditionalMLModelInformation | 5.4.6.2.14 | Represents the additional ML Model Information | ModelProvisionExt | +| FailureEventInfoForMLModel | 5.4.6.2.7 | | | +| InputDataInfo | 5.4.6.2.12 | Represents the metrics of the input data. | ModelProvisionExt | +| InferenceDataForModelTrain | 5.4.6.2.17 | Indicates the inference data stored in ADRF. | ModelProvisionExt | +| MLEventNotif | 5.4.6.2.6 | | | +| MLEventSubscription | 5.4.6.2.3 | | | +| MLModelAddr | 5.4.6.2.8 | | | +| MLModelAdrf | 5.4.6.2.15 | Represents the ADRF (Set) information of ML Model. | ModelProvisionExt | +| MLModelMetric | 5.4.6.2.9 | Indicates the ML model metric. | FederatedLearning
ModelProvisionExt | +| MLModelStatus | 5.4.6.2.10 | Indicates the pre-determined status of the ML model or training. | FederatedLearning | +| MLRepEventCondition | 5.4.6.2.11 | Indicates the ML event reporting condition. | FederatedLearning
ModelProvisionExt | +| ModelProvisionParamsExt | 5.4.6.2.13 | Represents extended model provision parameters. | ModelProvisionExt | +| NnwdafMLModelProvNotif | 5.4.6.2.5 | | | +| NnwdafMLModelProvSubsc | 5.4.6.2.2 | | | +| TrainInputDataInfo | 5.4.6.2.16 | Represents training input data information. | ModelProvisionExt | + +Table 5.4.6.1-2 specifies data types re-used by the Nnwdaf\_MLModelProvision 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 Nnwdaf\_MLModelProvision service based interface. + +**Table 5.4.6.1-2: Nnwdaf\_MLModelProvision re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|---------------------------------------------------------------------------|----------------------| +| Accuracy | 5.1.6.3.5 | Represents accuracy levels of interest for ML models | ModelProvisionExt | +| DateTime | 3GPP TS 29.571 [8] | Identifies the time. | | +| DccfEvent | 3GPP TS 29.574 [26] | Identifies the input data event. | ModelProvisionExt | +| EventFilter | 5.2.6.2.3 | Identifies the filter for the subscribed event. | | +| NetworkAreaInfo | 3GPP TS 29.554 [18] | Identifies the network area. | | +| NwdafEvent | 5.1.6.3.4 | | | +| NfInstanceId | 3GPP TS 29.571 [8] | Identifies an NF instance. | ModelProvisionExt | +| NfSetId | 3GPP TS 29.571 [8] | Identifies an NF Set. | ModelProvisionExt | +| RedirectResponse | 3GPP TS 29.571 [8] | | | +| ReportingInformation | 3GPP TS 29.523 [20] | Represents the requirements of reporting the subscription. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | | | +| TargetUeInformation | 5.1.6.2.8 | | | +| TimeWindow | 3GPP TS 29.122 [19] | | | +| Uinteger | 3GPP TS 29.571 [8] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. | ModelProvisionExt | +| Uri | 3GPP TS 29.571 [8] | | | +| VendorId | 3GPP TS 29.510 [12] | Represents the Vendor ID. | ModelSharing | + +## 5.4.6.2 Structured data types + +### 5.4.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.4.6.2.2 Type NwdafMLModelProvSubsc + +Table 5.4.6.2.2-1: Definition of type NwdafMLModelProvSubsc + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mLEventSubscs | array(MLEventSubscription) | M | 1..N | Each element identifies the subscription for each event. | | +| notifUri | Uri | M | 1 | Identifies the recipient of Notifications sent by the NWDAF. | | +| mLEventNotifs | array(MLEventNotif) | C | 1..N | Notifications about Individual Events.
Shall only be present if the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute sets to true in the event subscription, and the reports are available. | | +| suppFeats | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.4.8.
It shall be supplied by NF service consumer in the POST requests that request the creation of an NWDAF ML Model Provision Subscriptions resource, and shall be supplied by the NWDAF in the reply of corresponding request. | | +| notifCorrId | string | O | 0..1 | The value of Notification Correlation ID in the corresponding notification. | | +| eventReq | ReportingInformation | O | 0..1 | Reporting requirement information of the subscription.
If omitted, the default values within the ReportingInformation data type apply. | | +| failEventReports | array(FailureEventInfoForMLModel) | O | 1..N | Supplied by the NWDAF containing MTLF when available, shall contain the event(s) that the subscription is not successful including the failure reason(s). | | + +## 5.4.6.2.3 Type MLEventSubscription + +Table 5.4.6.2.3-1: Definition of type MLEventSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------| +| mLEvent | NwdafEvent | M | 1 | Identifies the subscribed event. | | +| mLEventFilter | EventFilter | M | 1 | Identifies the analytics filter for the subscribed event. | | +| tgtUe | TargetUeInformation | O | 0..1 | Identifies target UE information | | +| mLTargetPeriod | TimeWindow | O | 0..1 | Indicates the time interval for which the ML model for the analytics is requested. | | +| timeModelNeeded | DateTime | O | 0..1 | UTC time indicating the time when the ML model is needed. | ModelProvisionExt
FederatedLearning | +| expiryTime | DateTime | O | 0..1 | Indicates the time when the subscription expired. | | +| mlEvRepCon | MLRepEventCondition | O | 0..1 | Indicates the ML event reporting condition. This attribute can be provided when the "notifMethod" attribute within the ReportingInformation structure is set to "ON_EVENT_DETECTION" in the "eventReq" attribute within the NwdafMLModelProvSubsc data type. | FederatedLearning
ModelProvisionExt | +| modelInterInfo | string | O | 0..1 | Represents the ML Model Interoperability Information. This is vendor-specific information and is agreed between vendors, if necessary for sharing purposes.
The format of value is out of 3GPP. | ModelSharing | +| nfConsumerInfo | VendorId | O | 0..1 | Identifies a vendor. Vendor ID of the NF Service Consumer instance, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [30]. | ModelSharing | +| modelProvExt | ModelProvisionParamsExt | O | 0..1 | Extended ML model provisioning parameters. | ModelProvisionExt | +| useCaseCxt | string | O | 0..1 | Indicates the context of usage of the analytics. The value and format of this parameter are not standardized. | ENAExt | +| inferDataForModel | InferenceDataForModelTrain | O | 0..1 | Indicates the inference data stored in ADRF which can be used by MTLF to retrain or reprovision of the ML model. | ModelProvisionExt | + +## 5.4.6.2.4 Void + +## 5.4.6.2.5 Type NwdafMLModelProvNotif + +**Table 5.4.6.2.5-1: Definition of type NwdafMLModelProvNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|--------------------------------------------------------------------------|---------------| +| eventNotifs | array(MLEventNotif) | M | 1..N | Notifications about Individual Events | | +| subscriptionId | string | M | 1 | String identifying a subscription to the Nnwdaf_MLModelProvision Service | | + +## 5.4.6.2.6 Type MLEventNotif + +**Table 5.4.6.2.6-1: Definition of type MLEventNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| event | NwdafEvent | M | 1 | Identifies the subscribed event. | | +| notifCorrelId | string | O | 0..1 | Notification correlation ID used to identify the subscription to which the notification relates. It shall be set to the same value as the "notifCorrelId" attribute of NwdafMLModelProvSubsc data type. | | +| mlFile | string | O | 0..1 | Indicates the ML model file. The format of value is out of 3GPP. This attribute is not applicable in the Nnwdaf_MLModelProvision API. | | +| mlFileAddr | MLModelAddr | C | 0..1 | Indicates the address (e.g. a URL or an FQDN) of the ML model file. (NOTE 1, NOTE 2) | | +| mlModelAdrf | MLModelAdrf | C | 0..1 | Indicates the ADRF (Set) information of the ML Model. (NOTE 2) | ModelProvisionExt | +| validityPeriod | TimeWindow | O | 0..1 | Indicates the time period when the provided ML model applies. (NOTE 1) | | +| spatialValidity | NetworkAreaInfo | O | 0..1 | Indicates the area where the provided ML model applies. (NOTE 1) | | +| addModelInfo | array(AdditionalMLModelInformation) | O | 1..N | Indicates the additional ML Model Information. (NOTE 1) | ModelProvisionExt | + +NOTE 1: If the "addModelInfo" attribute is provided, then the attributes "validityPeriod" and "spatialValidity" shall not be provided and the value of the "mlFileAddr" attribute of the MLEventNotif data type shall be ignored. + +NOTE 2: If the "ModelProvisionExt" feature is supported, one of the "mlFileAddr" or "mlModelAdrf" attribute shall be provided. + +## 5.4.6.2.7 Type FailureEventInfoForMLModel + +Table 5.1.6.2.7-1: Definition of type FailureEventInfoForMLModel + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|--------------------------------|---------------| +| event | NwdafEvent | M | 1 | Event that is subscribed. | | +| failureCode | FailureCode | M | 1 | Identifies the failure reason. | | + +## 5.4.6.2.8 Type MLModelAddr + +Table 5.4.6.2.8-1: Definition of type MLModelAddr + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------|---------------| +| mlModelUrl | Uri | C | 0..1 | The URL of the ML Model file.
(NOTE) | | +| mlFileFqdn | string | C | 0..1 | The FQDN of the ML Model file.
(NOTE) | | + +NOTE: One of the "mlModelUrl" and "mlFileFqdn" attributes shall be provided. + +## 5.4.6.2.9 Void + +## 5.4.6.2.10 Void + +## 5.4.6.2.11 Type MLRepEventCondition + +Table 5.4.6.2.11-1: Definition of type MLRepEventCondition + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mlTrainRound | UInteger | O | 0..1 | Indicates the report shall occur when the number of training round is a multiple of the value set for the attribute. | | +| mlTrainRepTime | TimeWindow | O | 0..1 | Indicates the report shall occur when every training time interval is achieved. | | +| mlAccuracyThreshold | UInteger | O | 0..1 | Indicates the report shall occur when the ML model accuracy is crossing the ML Model Accuracy threshold of the value set for the attribute, i.e., the accuracy either becomes higher or lower than the value set for the attribute. | | +| modelMetric | MLModelMetric | O | 0..1 | Indicates the ML model metric. | | + +## 5.4.6.2.12 Type InputDataInfo + +**Table 5.4.6.2.12-1: Definition of type TrainInputInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| inpEvent | DccfEvent | M | 1 | Identifies the input data event to which the information applies. | | +| maxNumSamples | UInteger | O | 0..1 | Maximum number of samples that have been taken to train an ML model. | | +| maxTimeInterval | UInteger | O | 0..1 | Maximum time interval between samples that are used to train an ML model. | | +| nfInstanceIds | array(NfInstanceId) | O | 1..N | NF instance identifiers of the used data sources. | | +| nfSetIds | array(NfSetId) | O | 1..N | NF set identifiers of the used data sources. | | +| ratio | UInteger | O | 0..1 | Sampling ratio, indicates the percentage of the available data values that are used by this ML model (for training or inference).
Minimum = 0. Maximum = 100. | | + +## 5.4.6.2.13 Type ModelProvisionParamsExt + +Table 5.4.6.2.13-1: Definition of type ModelProvisionParamsExt + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| modelInterInfo | string | O | 0..1 | Represents the ML Model Interoperability Information. This is vendor-specific information and is agreed between vendors, if necessary for sharing purposes. The format of value is out of 3GPP. | | +| reqRepRatio | UInteger | O | 0..1 | Minimum percentage of UEs whose data is used for training an ML model when the target of ML model reporting is a group of UEs. Minimum = 0. Maximum = 100. | | +| inferInpDataInfos | array(InputDataInfo) | O | 1..N | The metrics of input data that are expected to be used by NWDAF containing AnLF during inference. | | +| multModelsInd | boolean | O | 0..1 | If provided and set to "true", it indicates that the NF service consumer supports receiving multiple ML models. If omitted or set to "false" the NF service consumer does not support multiple ML models. The default value is false. | | +| numModels | UInteger | O | 0..1 | Maximum number of ML models that the consumer supports to receive for a specific analytics ID. It may only be provided if the "multModelInd" attribute is provided and set to "true". | | +| accuLevels | array(Accuracy) | O | 1..N | Provided accuracy levels of interest for ML models. | | + +## 5.4.6.2.14 Type AdditionalMLModelInformation + +Table 5.4.6.2.14-1: Definition of type AdditionalMLModelInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mLFileAddr | MLModelAddr | M | 1 | Indicates the address (e.g. a URL or an FQDN) of the ML model file. | | +| mLModelAdrf | MLModelAdrf | O | 0..1 | Indicates the ADRF (Set) information of the ML Model. | | +| validityPeriod | TimeWindow | O | 0..1 | Indicates the time period when the provided ML model applies. | | +| spatialValidity | NetworkAreaInfo | O | 0..1 | Indicates the area where the provided ML model applies. | | +| modelUniqueId | UInteger | O | 0..1 | Unique identifier for an ML model. The identifier shall be unique within 5GC scope. | | +| modelRepRatio | UInteger | O | 0..1 | Indicating the percentage of UEs in the group that is used to train an ML model when target of ML model reporting is a group of UEs. | | +| mlDegradInd | boolean | O | 0..1 | Set to "true" to indicate that the ML model is degraded.

Set to "false" to indicate that the ML model is not degraded.

Default value is "false" if omitted. | | +| trainInpInfos | array(TrainInputInfo) | O | 1..N | Training input data information that is used by NWDAF containing MTLF during training. | | +| modelMetric | MLModelMetric | O | 0..1 | Indicates the ML model metric. | | +| accMLModel | UInteger | O | 0..1 | Indicates the accuracy value of the ML model.
Minimum = 0. Maximum = 100. | | + +## 5.4.6.2.15 Type MLModelAdrf + +Table 5.4.6.2.15-1: Definition of type MLModelAdrf + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------|---------------| +| adrfId | NfInstanceId | C | 0..1 | Identifier of the ADRF.
(NOTE) | | +| adrfSetId | NfSetId | C | 0..1 | Identifier of the ADRF Set.
(NOTE) | | +| storTransId | string | O | 0..1 | Indicates Storage Transaction ID, may be provided when "adrfId" or "adrfSetId" attribute is provisioned. | | + +NOTE: One of "adrfId" and "adrfSetId" attributes shall be provided. + +## 5.4.6.2.16 Type TrainInputDataInfo + +**Table 5.4.6.2.16-1: Definition of type TrainInputDataInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dataInfo | InputDataInfo | O | 0..1 | The metrics of input data that has been used by NWDAF containing MTLF during training. | | +| time | TimeWindow | O | 0..1 | Indicates the time interval during which the data was obtained from the data source NFs. | | +| dataStatisticsInfos | string | O | 0..1 | Indicates the statistics information of the data identified by "dataInfo" attribute, e.g. data range including maximum and minimum values, mean and standard deviation and data distribution when applicable. | | + +Editor's note: The data type of "dataStatisticsInfos" attribute is FFS. + +## 5.4.6.2.17 Type InferenceDataForModelTrain + +**Table 5.4.6.2.17-1: Definition of type InferenceDataForModelTrain** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| adrflId | NfInstanceId | C | 0..1 | Identifier of the ADRF. (NOTE) | | +| adrSetId | NfSetId | C | 0..1 | Identifier of the ADRF Set. (NOTE) | | +| dataSetTag | DataSetTag | O | 0..1 | Data set tag of the data stored in ADRF which can be used by MTLF. | | +| modelId | UInteger | O | 0..1 | ML model Identifier. Indicates the model that the data corresponding to the DataSetTag is related to. This attribute may be present only in a subscription modification request. | | + +NOTE: One of "adrflId" and "adrSetId" attributes shall be provided. + +## 5.4.6.3 Simple data types and enumerations + +## 5.4.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.4.6.3.2 Simple data types + +The simple data types defined in table 5.1.6.3.2-1 shall be supported. + +**Table 5.4.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | +| | | | | + +#### 5.4.6.3.3 Enumeration: FailureCode + +**Table 5.4.6.3.3-1: Enumeration FailureCode** + +| Enumeration value | Description | Applicability | +|--------------------------|----------------------------------------------------------------|---------------| +| UNAVAILABLE_ML_MODEL_DEL | Indicates the requested ML model for the event is unavailable. | | + +#### 5.4.6.3.4 Enumeration: MLModelMetric + +**Table 5.4.6.3.4-1: Enumeration MLModelMetric** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------|---------------| +| ACCURACY | ML Model Accuracy metric. | | + +### 5.4.7 Error handling + +#### 5.4.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [6]. + +For the Nnwdaf\_MLModelProvision API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [7]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] 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 [6]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] for HTTP redirections shall be supported. + +In addition, the requirements in the following clauses shall apply. + +#### 5.4.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_MLModelProvision API. + +#### 5.4.7.3 Application Errors + +The application errors defined for the Nnwdaf\_MLModelProvision API are listed in table 5.4.7.3-1. + +**Table 5.4.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-------------------------------------------------------------| +| UNAVAILABLE_ML_MODEL_FOR_ALLEVEMENTS | 500 Internal Server Error | Indicates the requested all events ML model is unavailable. | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +### 5.4.8 Feature negotiation + +The optional features in table 5.4.8-1 are defined for the Nnwdaf\_MLModelProvision API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.4.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | FederatedLearning | Indicates the support of Federated Learning. | +| 2 | ModelSharing | This feature indicates the support of ML model sharing. | +| 3 | ENAExt | This feature indicates support for the general enhancements of network data analytics requirements, including support for use case context sent by the NF service consumer to the NWDAF. | +| 4 | ModelProvisionExt | This feature indicates support for the Model Provision Extension, including support for provisioning the ML model file address (e.g. URL or FQDN) or ADRF (Set) ID and additional ML Model Information to the NF service consumer. | + +## 5.4.9 Security + +As indicated in 3GPP TS 33.501 [13] and 3GPP TS 29.500 [6], the access to the Nnwdaf\_MLModelProvision API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [14]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, a n NF Service Consumer, prior to consuming services offered by the Nnwdaf\_MLModelProvision API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], 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 Nnwdaf\_MLModelProvision service. + +The Nnwdaf\_MLModelProvision API defines a single scope "nnwdaf-mlmodelprovision" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 5.5 Nnwdaf\_MLModelTraining Service API + +### 5.5.1 Introduction + +The Nnwdaf\_MLModelTraining service shall use the Nnwdaf\_MLModelTraining API. + +The API URI of the Nnwdaf\_MLModelTraining API shall be: + +**{apiRoot}** + +The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-mlmodeltraining". +- The shall be "v1". +- The shall be set as described in clause 5.5.3. + +### 5.5.2 Usage of HTTP + +#### 5.5.2.1 General + +HTTP/2, IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_ MLModelTraining is contained in Annex A. + +## 5.5.2.2 HTTP standard headers + +### 5.5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +### 5.5.2.2.2 Content type + +JSON, IETF RFC 8259 [10], 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 [6]. 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 9457 [15]. + +## 5.5.2.3 HTTP custom headers + +The Nnwdaf\_ MLModelTraining service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_ MLModelTraining service API. + +## 5.5.3 Resources + +### 5.5.3.1 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.5.3.1-1 depicts the resource URIs structure for the Nnwdaf\_ MLModelTraining API. + +![Diagram showing the resource URI structure for the Nnwdaf_ MLModelTraining API. The root URI is {apiRoot}/nnwdaf-mlmodeltraining/. It branches to /subscriptions, which further branches to /{subscriptionId}.](c54223b4f1a31104507af83ef6ee5392_img.jpg) + +``` +graph TD; Root["{apiRoot}/nnwdaf-mlmodeltraining/"] --- Subscriptions["/subscriptions"]; Subscriptions --- SubscriptionId["/{subscriptionId}"]; +``` + +Diagram showing the resource URI structure for the Nnwdaf\_ MLModelTraining API. The root URI is {apiRoot}/nnwdaf-mlmodeltraining/. It branches to /subscriptions, which further branches to /{subscriptionId}. + +**Figure 5.5.3.1-1: Resource URI structure of the Nnwdaf\_ MLModelTraining API** + +Table 5.5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------------------------|---------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| NWDAF ML Model Training Subscriptions | /subscriptions | POST | Creates a new Individual NWDAF ML Model Training Subscription resource. | +| Individual NWDAF ML Model Training Subscription | /subscriptions/{subscriptionId} | DELETE | Deletes an Individual NWDAF ML Model Training Subscription identified by subresource {subscriptionId}. | +| | | PUT | Modifies an existing Individual NWDAF ML Model Training Subscription identified by subresource {subscriptionId}. | +| | | PATCH | Partial update of an existing Individual NWDAF ML Model Training Subscription identified by subresource {subscriptionId}. | + +### 5.5.3.2 Resource: NWDAF ML Model Training Subscriptions + +#### 5.5.3.2.1 Description + +The NWDAF ML Model Training Subscriptions resource represents all subscriptions to the Nnwdaf\_MLModelTraining service at a given NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF ML Model Training Subscription resource. + +#### 5.5.3.2.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-mlmodeltraining//subscriptions + +This resource shall support the resource URI variables defined in table 5.5.3.2.2-1. + +**Table 5.5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.5.1 | + +#### 5.5.3.2.3 Resource Standard Methods + +##### 5.5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.3.2.3.1-1. + +**Table 5.5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.3.2.3.1-2 and the response data structures and response codes specified in table 5.5.3.2.3.1-3. + +**Table 5.5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-------------------------------------------------------------------------| +| NwdafMLModelTrainSubsc | M | 1 | Creates a new Individual NWDAF ML Model Training Subscription resource. | + +**Table 5.5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| NwdafMLModelTrainSubsc | M | 1 | 201 Created | The creation of an Individual NWDAF ML Model Training Subscription resource is confirmed and a representation of that resource is returned. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure causes are described in subclause 5.5.7.3. + +**Table 5.5.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}/nnwdaf-mlmodeltraining//subscriptions/{subscriptionId} | + +## 5.5.3.2.4 Resource Custom Operations + +None in this release of the specification. + +## 5.5.3.3 Resource: Individual NWDAF ML Model Training Subscription + +### 5.5.3.3.1 Description + +The Individual NWDAF ML Model Training Subscription resource represents a single subscription to the Nnwdaf\_MLModelTraining service at a given NWDAF. + +### 5.5.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-mlmodeltraining//subscriptions/{subscriptionId} + +The shall be set as described in clause 5.5.1. + +This resource shall support the resource URI variables defined in table 5.5.3.3.2-1. + +**Table 5.5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------------------------------------| +| apiRoot | string | See clause 5.5.1. | +| subscriptionId | string | Identifies a subscription to the Nnwdaf_MLModelTraining service. | + +### 5.5.3.3.3 Resource Standard Methods + +#### 5.5.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 5.5.3.3.3.1-1. + +**Table 5.5.3.3.3.1-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.5.3.3.3.1-2 and the response data structures and response codes specified in table 5.5.3.3.3.1-3. + +**Table 5.5.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|----------------------------------------------------------------------------------------| +| NwdafMLModelTrainSubsc | M | 1 | Parameters to replace a subscription to NWDAF ML Model Training Subscription resource. | + +**Table 5.5.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NwdafMLModelTrainSubsc | M | 1 | 200 OK | The Individual NWDAF ML Model Training Subscription resource was modified successfully, and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF ML Model Training Subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF ML Model Training Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF ML Model Trainin Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +NOTE 2: Failure causes are described in subclause 5.5.7.3. + +**Table 5.5.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 NWDAF (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.5.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 NWDAF (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.5.3.3.3.2 PATCH + +#### PATCH + +This method shall support the URI query parameters specified in table 5.5.3.3.3.2-1. + +**Table 5.5.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.3.3.3.2-2 and the response data structures and response codes specified in table 5.5.3.3.3.2-3. + +**Table 5.5.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|--------------------------------------------------------------------------------------------------| +| NwdafMLModelTrainSubscPatch | M | 1 | Partial update of parameters to a subscription to NWDAF ML Model Training Subscription resource. | + +**Table 5.5.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NwdafMLModelTrainSubsc | M | 1 | 200 OK | The Individual NWDAF ML Model Training Subscription resource was partial modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF ML Model Training Subscription resource was partial modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF ML Model Training Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF ML Model Trainin Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +NOTE 2: Failure causes are described in subclause 5.5.7.3. + +**Table 5.5.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 NWDAF (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.5.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 NWDAF (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.5.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.5.3.3.3.3-1. + +**Table 5.5.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.5.3.3.3.3-2 and the response data structures and response codes specified in table 5.5.3.3.3.3-3. + +**Table 5.5.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| | | | | + +**Table 5.5.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 NWDAF ML Model Training Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF ML Model Training Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF ML Model Training Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +**Table 5.5.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 NWDAF (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.5.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 NWDAF (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.5.3.3.4 Resource Custom Operations + +None in this release of the specification. + +## 5.5.4 Custom Operations without associated resources + +None in this release of the specification. + +## 5.5.5 Notifications + +### 5.5.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.5.3.4.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|--------------|---------------------------------|----------------------------------------| +| Event Notification | {notifUri} | POST | Report one or several observed Events. | + +### 5.5.5.2 Event Notification + +#### 5.5.5.2.1 Description + +The Event Notification is used by the NWDAF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications via the Individual NWDAF ML Model Training Subscription Resource. + +#### 5.5.5.2.2 Operation Definition + +Callback URI: {notifUri} + +The operation shall support the callback URI variables defined in table 5.5.5.2.2-1, the request data structures specified in table 5.5.5.2.2-2 and the response data structure and response codes specified in table 5.5.5.2.2-3. + +**Table 5.5.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned within the Individual NWDAF ML Model Training Subscription and described within the NwdafMLModelTrainSubsc type (see table 5.5.6.2.2-1). | + +**Table 5.5.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------------|---|-------------|---------------------------------------------| +| array(NwdafMLModelTrainNotif) | M | 1..N | Provides Information about observed events. | + +**Table 5.5.5.2.2-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 the 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 the 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. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure cases are described in subclause 5.5.7.3. + +**Table 5.5.5.2.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 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.5.5.2.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 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.5.6 Data Model + +### 5.5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.5.6.1-1 specifies the data types defined for the Nnwdaf\_MLModelTraining service-based interface protocol. + +**Table 5.5.6.1-1: Nnwdaf\_MLModelTraining specific Data Types** + +| Data type | Section defined | Description | Applicability | +|---------------------------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| DataAvReq | 5.5.6.2.10 | Represents the requirement on available data for the ML model training. | | +| DelayEventNotif | 5.5.6.2.11 | Indicates that the NWDAF containing MTLF is not able to complete the training of ML model within the maximum response time, the cause code, and the expected time complete the training. | | +| FailureCodeTrain | 5.5.6.3.3 | Identifies the failure reason. | | +| FailureEventInfoForMLModelTrain | 5.5.6.2.7 | Represents the failure event information for a ML Model Training subscription. | | +| NnwdafMLModelTrainSubsc | 5.5.6.2.2 | Represents a ML Model Training subscription. | | +| NnwdafMLModelTrainSubscPatch | 5.5.6.2.3 | Represents parameters to request the modification of a ML Model Training subscription. | | +| MLModelInfo | 5.5.6.2.4 | Represents the ML Model information. | | +| MLModelTrainInfo | 5.5.6.2.5 | Represents the ML Model training information, include requirement on data availability and time availability, training filter information. | | +| NnwdafMLModelTrainNotif | 5.5.6.2.8 | Represents notification of a ML Model Training subscription. | | +| MLTrainReportInfo | 5.5.6.2.6 | Indicates the training reporting information. | | +| StatusReportInfo | 5.5.6.2.12 | Indicates status information generated by the NWDAF containing MTLF during ML model training. | | +| TermMLModelTrainInfo | 5.5.6.2.9 | Indicates that the subscription is requested to be terminated, contain the reasons. | | +| TermTrainCause | 5.5.6.3.4 | Represents the reasons that the ML Model Training to be terminated. | | +| TrainDataInfo | 5.5.6.2.13 | Represents the training input data information. | | + +Table 5.5.6.1-2 specifies data types re-used by the Nnwdaf\_MLModelTraining 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 Nnwdaf\_MLModelTraining service-based interface. + +**Table 5.5.6.1-2: Nnwdaf\_MLModelTraining re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|---------------------|---------------------------------------------------------------------------------|----------------------| +| Accuracy | 5.1.6.3.5 | Represents the accuracy level of the ML model. | | +| DatasetStatisticalProperty | 5.1.6.3.15 | Dataset statistical properties of the data used for ML model training. | | +| DccfEvent | 3GPP TS 29.574 [26] | Identifies the input data event. | | +| Dnn | 3GPP TS 29.571 [8] | Identifies the DNN. | | +| DurationSec | 3GPP TS 29.571 [8] | Represents the duration time in second(s). | | +| Float | 3GPP TS 29.571 [8] | | | +| MLEventSubscription | 5.4.6.2.3 | Represents an Individual NWDAF Event Subscription resource. | | +| MLEventNotif | 5.4.6.2.6 | Represents notifications about Individual Events. | | +| NwdafEvent | 5.1.6.3.4 | Describes the NWDAF Events. | | +| RedirectResponse | 3GPP TS 29.571 [8] | | | +| ReportingInformation | 3GPP TS 29.523 [20] | Represents the requirements of reporting the subscription. | | +| Sns sai | 3GPP TS 29.571 [8] | Identifies the S-NSSAI (Single Network Slice Selection Assistance Information). | | +| SupportedFeatures | 3GPP TS 29.571 [8] | | | +| TargetUeInformation | 5.1.6.2.8 | Identifies the target UE information. | | +| TimeWindow | 3GPP TS 29.122 [19] | | | +| Uri | 3GPP TS 29.571 [8] | | | + +## 5.5.6.2 Structured data types + +### 5.5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.5.6.2.2 Type NwdafMLModelTrainSubsc + +**Table 5.5.6.2.2-1: Definition of type NwdafMLModelTrainSubsc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventReq | ReportingInformation | O | 0..1 | Reporting requirement information of the subscription. If omitted, the default values within the ReportingInformation data type apply. | | +| failEventReports | array(FailureEventInfoForMLModelTrain) | O | 1..N | Supplied by the NWDAF containing MTLF when available, shall contain the event(s) that the subscription is not successful including the failure reason(s). | | +| mlCorreId | string | C | 0..1 | Identifies the Machine Learning procedure for training the ML model. It shall be present when the service is for Federated Learning. | | +| mlCorreId | string | C | 0..1 | Identifies the Machine Learning procedure for training the ML model. It shall be present when the service is for Federated Learning. | | +| mlEventSubscs | array(MLEventSubscription) | M | 1..N | Each element identifies the subscription for each event. The "modelInterInfo" attribute within the MLEventSubscription data type shall be provided. | | +| mlModelInfos | array(MLEventNotif) | O | 1..N | Each element contains ML Model information for a specific analytics type. (NOTE) | | +| immReports | array(NwdafMLModelTrainNotif) | O | 1..N | Immediately reported ML Model Training notifications. It may only be provided in the HTTP POST response of a subscription creation/update and only if the immediate reporting flag was set to "true" in the HTTP POST request. | | +| mlModelTrainInfos | array(MLModelTrainInfo) | O | 1..N | Each element represents the ML Model training information for each event, include requirement on data availability and time availability. | | +| mlPreFlag | boolean | C | 0..1 | Indicates whether the subscription is for preparation of ML Model training. Set to "true" if it is for ML training preparation, otherwise set to "false". Default value is "false" if omitted. It shall be present when the service is for preparation of Federated Learning. | | +| mlAccChkFlg | boolean | O | 0..1 | Indicates whether request using the local training data as the testing dataset to calculate the Model Accuracy of the global ML model | | + +| | | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | provided by the consumer. Set to "true" if it is requested, otherwise set to "false". Default value is "false" if omitted. | | +| mLTrainRepInfo | MLTrainReportInfo | O | 0..1 | Indicates the training reporting information. This attribute can be provided when the "notifMethod" attribute within the ReportingInformation structure is set to "ON_EVENT_DETECTION" in the "eventReq" attribute. | | +| notifCorreId | string | M | 1 | The value of Notification Correlation ID in the corresponding notification. | | +| notifUri | Uri | M | 1 | URI at which the NF service consumer requests to receive notifications. | | +| roundInd | UInteger | O | 0..1 | Indicates the round number of the training in a multi-round training process. | | +| suppFeats | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.5.8. It shall be supplied by NF service consumer in the POST requests that request the creation of an NWDAF ML Model Training Subscriptions resource and shall be supplied by the NWDAF in the reply of corresponding request. | | +| tgtRepUe | TargetUeInformation | O | 0..1 | Indicates the UE(s) information for which data for ML model training is requested. | | +| uCaseCont | string | O | 0..1 | Indicates the use case context of the ML model. The value and format of this parameter are not standardized. | | +| NOTE: It is up to implementation to determine whether to include the "mlFile" attribute in the "NwdafMLModelTrainSubsc" data structure considering ML Model file size, etc. | | | | | | + +## 5.5.6.2.3 Type NwdafMLModelTrainSubscPatch + +Table 5.5.6.2.3-1: Definition of type NwdafMLModelTrainSubscPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventReq | ReportingInformation | O | 0..1 | Reporting requirement information of the subscription.
If omitted, the default values within the ReportingInformation data type apply. | | +| mlModelInfos | array(MLEventNotif) | O | 1..N | Each element contains ML Model information for a specific analytics type. | | +| mlModelTrainInfos | array(MLModelTrainInfo) | O | 1..N | Each element represents the ML Model training information, include requirement on data availability and time availability, training filter information. | | +| mlPreFlag | boolean | O | 0..1 | Indicates whether the subscription is for preparation of ML Model training. Set to "true" if it is for ML training preparation, otherwise set to "false". | | +| mlAccChkFlg | boolean | O | 0..1 | Indicates whether request using the local training data as the testing dataset to calculate the Model Accuracy of the global ML model provided by the consumer. Set to "true" if it is requested, otherwise set to "false". | | +| mlTrainRepInfo | MLTrainReportInfo | O | 0..1 | Indicates the training reporting information. This attribute can be provided when the "notifMethod" attribute within the ReportingInformation structure is set to "ON_EVENT_DETECTION" in the "eventReq" attribute. | | +| notifUri | Uri | O | 1 | URI at which the NF service consumer requests to receive notifications. | | +| roundInd | UInteger | O | 0..1 | Indicates the round number of the training in a multi-round training process. | | +| tgtRepUe | TargetUeInformation | O | 0..1 | Indicates the UE(s) information for which data for ML model training is requested. | | +| uCaseCont | string | O | 0..1 | Indicates the use case context of the ML model. The value and format of this parameter are not standardized. | | + +5.5.6.2.4 Void + +5.5.6.2.5 Type MLModelTrainInfo + +**Table 5.5.6.2.5-1: Definition of type MLModelTrainInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dataAvReq | DataAvReq | C | 0..1 | Represents the requirement on available data for the ML model training.
Shall be provided when the "mlPreFlag" attribute in data type "NwdafMLModelTrainSubsc" is set to "true". | | +| timeAvReq | string | C | 0..1 | Represents the requirement on available time for the ML model training.
Shall be provided when the "mlPreFlag" attribute in data type "NwdafMLModelTrainSubsc" is set to "true". | | + +5.5.6.2.6 Type MLTrainReportInfo + +**Table 5.5.6.2.6-1: Definition of type MLTrainReportInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-------------------------------------------------------|---------------| +| maxResTime | DurationSec | O | 0..1 | Indicates the maximum time for waiting notifications. | | + +5.5.6.2.7 Type FailureEventInfoForMLModelTrain + +**Table 5.5.6.2.7-1: Definition of type FailureEventInfoForMLModelTrain** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|--------------------------------|---------------| +| mLTrainEvent | NwdafEvent | M | 1 | Event that is subscribed. | | +| failureCodeTrain | FailureCodeTrain | M | 1 | Identifies the failure reason. | | + +## 5.5.6.2.8 Type NwdafMLModelTrainNotif + +Table 5.5.6.2.8-1: Definition of type NwdafMLModelTrainNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| delayEventNotif | DelayEventNotif | C | 0..1 | Indicates that the NWDAF containing MTLF is not able to complete the training of ML model within the maximum response time, the cause code, and the expected time complete the training. May be provided for Federated Learning training. (NOTE) | | +| mlCorreId | string | C | 0..1 | Identifies the Machine Learning procedure for training the ML model. It shall be present when the service is for Federated Learning. | | +| mlModelInfos | array(MLEventNotif) | C | 1..N | Identifies the Machine Learning procedure information for training the ML model. It shall be present when the service is for Federated Learning. (NOTE) | | +| notifCorreId | string | M | 1 | Notification correlation ID used to identify the subscription to which the notification relates. It shall be set to the same value as the "notifCorreId" attribute of NwdafMLModelTrainSubsc data type. | | +| roundInd | UInteger | O | 0..1 | Indicates the round number of the training in a multi-round training process. | | +| statusReport | StatusReportInfo | O | 0..1 | Indicates status information generated by the NWDAF containing MTLF during ML model training. May be provided for Federated Learning training. | | +| termTrainReq | TermTrainCause | C | 0..1 | If provided, it indicates that the subscription is requested to be terminated (i.e. no further notifications related to this subscription will be provided) and it contains the reason why the subscription is requested to be terminated. (NOTE) | | +| uCaseCont | string | O | 0..1 | Indicates the use case context of the ML model. The value and format of this parameter are not standardized. | | + +NOTE: At least one of the "delayEventNotif", "mlModelInfos" or "termTrainReq" attribute shall be provided. The "delayEventNotif" attribute and "mlModelInfos" attribute are mutually exclusive. The "delayEventNotif" attribute and "termTrainReq" attribute are mutually exclusive. + +## 5.5.6.2.9 Void + +## 5.5.6.2.10 Type DataAvReq + +**Table 5.5.6.2.10-1: Definition of type DataAvReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------------|---|-------------|--------------------------------------------------------------------------------------|---------------| +| dataStatProps | array(DatasetStatisticalProperty) | O | 1..N | List of dataset statistical properties of the data to be used for ML model training. | | +| inpEvents | array(DccfEvent) | M | 1..N | Event ID list of the data to be collected for ML model training. | | +| minNumSamples | UInteger | O | 0..1 | Minimum number of samples that be taken to train an ML model. | | +| timeWindows | array(TimeWindow) | O | 1..N | The time periods of the data samples. | | + +## 5.5.6.2.11 Type DelayEventNotif + +**Table 5.5.6.2.11-1: Definition of type DelayEventNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| delayEventInd | boolean | M | 1 | Indicates the NWDAF containing MTLF is not able to complete the training of the ML model within the maximum response time provided by the "maxResTime" attribute in the "MLTrainReportInfo" data type.
Set to "true" if not able to complete the ML model training on time, otherwise set to "false". | | +| delayCause | DelayCause | O | 0..1 | Represents the reasons for the ML Model training delay. | | +| expCompTime | DurationSec | O | 0..1 | Indicates the expected remaining training time. | | + +## 5.5.6.2.12 Type StatusReportInfo + +**Table 5.5.6.2.12-1: Definition of type StatusReportInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| mlModelAcc | UInteger | O | 0..1 | Indicates the accuracy of the ML model in percent.
Minimum = 0. Maximum = 100. | | +| trainInDataInfo | TrainDataInfo | O | 0..1 | Represents the training input data information. | | + +### 5.5.6.2.13 Type TrainDataInfo + +**Table 5.5.6.2.13-1: Definition of type TrainDataInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------|---------------| +| areaDataSet | string | O | 0..1 | Indicates the areas covered by the data set. | | +| maxValues | array(string) | O | 1..N | Each element represents the maximum value of one dimension of data. | | +| minValues | array(string) | O | 1..N | Each element represents the minimum value of one dimension of data. | | +| samplRatio | UInteger | O | 0..1 | Sampling ratio, indicates the percentage of the available data that are taken to train an ML model.
Minimum = 0. Maximum = 100. | | + +Editor's Note: The data type for the "areaDataSet" attribute is FFS and will align with stage 2 requirement. + +Editor's Note: Whether need the "maxValues" and "minValues" attributes and their data type are FFS and will align with stage 2 requirements. + +### 5.5.6.3 Simple data types and enumerations + +#### 5.5.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.5.6.3.2 Simple data types + +The simple data types defined in table 5.1.6.3.2-1 shall be supported. + +**Table 5.5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 5.5.6.3.3 Enumeration: FailureCodeTrain + +**Table 5.5.6.3.3-1: Enumeration FailureCodeTrain** + +| Enumeration value | Description | Applicability | +|----------------------------|-----------------------------------------------------------|---------------| +| UNAVAILABLE_ML_MODEL_TRAIN | Indicates the requested ML model training is unavailable. | | + +#### 5.5.6.3.4 Enumeration: TermTrainCause + +**Table 5.5.6.3.4-1: Enumeration TermTrainCause** + +| Enumeration value | Description | Applicability | +|------------------------|------------------------------------------------------------------------------------------------------------------|---------------| +| NWDAF_OVERLOAD | Indicates the NWDAF is overload, e.g. in computation and/or communication capability, for the ML model training. | | +| NOT_AVAILABLE_ML_TRAIN | Indicates the ML model training process is not available anymore. | | +| OTHERS | Indicates other cause. | | + +#### 5.5.6.3.5 Enumeration: DelayCause + +**Table 5.5.6.3.5-1: Enumeration DelayCause** + +| Enumeration value | Description | Applicability | +|------------------------|---------------------------------------------------------------|---------------| +| ML_MODEL_TRAIN_FAILURE | Indicates the ML model training is failed. | | +| NEED_MORE_TIME | Indicates that more time is needed for the ML model training. | | +| OTHERS | Indicates other cause. | | + +### 5.5.7 Error handling + +#### 5.5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [6]. + +For the Nnwdaf\_MLModelTraining API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [7]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] 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 [6]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] for HTTP redirections shall be supported. + +In addition, the requirements in the following clauses shall apply. + +#### 5.5.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_MLModelTraining API. + +#### 5.5.7.3 Application Errors + +The application errors defined for the Nnwdaf\_MLModelTraining API are listed in table 5.5.7.3-1. + +**Table 5.5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UNAVAILABLE_ML_MODEL_TRAINING_F
OR_ALLEVENTS | 500 Internal Server
Error | Indicates the requested all events ML model training is unavailable. | +| ML_MODEL_TRAINING_REQS_NOT_MET | 403 Forbidden | Indicates the ML model training requirements are not met. The "ProblemDetails" data structure shall contain the attribute(s) that do not meet the ML model training requirements within the "invalidParams" attribute. | +| ML_TRAINING_NOT_COMPLETE | 403 Forbidden | Indicates the ML training is not complete. | +| OVERLOAD | 403 Forbidden | Indicates the NWDAF is overload. | +| NOT_AVAILABLE_FOR_FL_PROCESS_AN
YMORE | 403 Forbidden | Indicates the NWDAF is not available for the FL process anymore. | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +## 5.5.8 Feature negotiation + +The optional features in table 5.5.8-1 are defined for the Nnwdaf\_MLModelTraining API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|-----------------------|---------------------|--------------------| +| | | | + +## 5.5.9 Security + +As indicated in 3GPP TS 33.501 [13] and 3GPP TS 29.500 [6], the access to the Nnwdaf\_MLModelTraining API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [14]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, a n NF Service Consumer, prior to consuming services offered by the Nnwdaf\_MLModelTraining API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], 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 Nnwdaf\_MLModelTraining service. + +The Nnwdaf\_MLModelTraining API defines a single scope "nnwda-mlmodeltraining" for the entire service, and it does not define any additional scopes at resource or operation level. + +# 5.6 Nnwdaf\_MLModelMonitor Service API + +## 5.6.1 Introduction + +The Nnwdaf\_MLModelMonitor service shall use the Nnwdaf\_MLModelMonitor API. + +The API URI of the Nnwdaf\_MLModelMonitor API shall be: + +{apiRoot}// + +The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}/// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwda-mlmodelmonitor". +- The shall be "v1". +- The shall be set as described in clause 5.6.3. + +## 5.6.2 Usage of HTTP + +### 5.6.2.1 General + +HTTP/2, IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_MLModelMonitor is contained in Annex A. + +### 5.6.2.2 HTTP standard headers + +#### 5.6.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +#### 5.6.2.2.2 Content type + +JSON, IETF RFC 8259 [10], 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 [6]. 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 [15]. + +### 5.6.2.3 HTTP custom headers + +The Nnwdaf\_MLModelMonitor service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_MLModelMonitor service API. + +## 5.6.3 Resources + +### 5.6.3.1 Resource Structure + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.6.3.1-1 depicts the resource URIs structure for the Nnwdaf\_MLModelMonitor API. + +![Figure 5.6.3.1-1: Resource URI structure of the Nnwdaf_MLModelMonitor API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nnwda-mlmodelmonitor/. It branches into /registrations and /subscriptions. /registrations further branches into /{registrationId}. /subscriptions further branches into /{subscriptionId}.](1ba9045eb6dc22039a16b92b1427e696_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnwda-mlmodelmonitor/"] --> Registrations["/registrations"] + Root --> Subscriptions["/subscriptions"] + Registrations --> RegistrationId["/{registrationId}"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Figure 5.6.3.1-1: Resource URI structure of the Nnwdaf\_MLModelMonitor API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nnwda-mlmodelmonitor/. It branches into /registrations and /subscriptions. /registrations further branches into /{registrationId}. /subscriptions further branches into /{subscriptionId}. + +**Figure 5.6.3.1-1: Resource URI structure of the Nnwdaf\_MLModelMonitor API** + +Table 5.6.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.6.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------------------------------------------|----------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------| +| NWDAF ML model monitoring registrations | /registrations | POST | Create a new Individual ML model monitoring registration resource on the NWDAF containing MTLF. | +| Individual NWDAF ML model monitoring registration | /registrations/{registrationsId} | DELETE | Delete an Individual ML model monitoring registration resource by {registrationsId} on the NWDAF containing MTLF. | +| NWDAF ML model monitoring Subscriptions | /subscriptions | POST | Create a new Individual ML model monitoring Subscription resource on the NWDAF containing AnLF. | +| Individual NWDAF ML model monitoring Subscription | /subscriptions/{subscriptionId} | PUT | Modifies an existing ML model monitoring Subscription resource on the NWDAF containing AnLF. | +| | | DELETE | Delete an individual ML model monitoring Subscription identified by {subscriptionId} on the NWDAF containing AnLF. | + +## 5.6.3.2 Resource: NWDAF ML model monitoring registrations + +### 5.6.3.2.1 Description + +The NWDAF ML model monitoring registrations resource represents all registrations to the Nnwdaf\_MLModelMonitor Service at a given NWDAF containing MTLF. The resource allows an NF service consumer to create a new Individual NWDAF ML model monitoring registration resource. + +### 5.6.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnwda-mlmodelmonitor//registrations + +The shall be set as described in clause 5.6.1. + +This resource shall support the resource URI variables defined in table 5.6.3.2.2-1. + +**Table 5.6.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.6.1 | + +### 5.6.3.2.3 Resource Standard Methods + +#### 5.6.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.6.3.2.3.1-1. + +**Table 5.6.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.6.3.2.3.1-2 and the response data structures and response codes specified in table 5.6.3.2.3.1-3. + +**Table 5.6.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------------------------------------| +| MLModelMonitorReg | M | 1 | Create a new Individual NWDAF ML model monitoring registration resource. | + +**Table 5.6.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| MLModelMonitorReg | M | 1 | 201
Created | The creation of an Individual NWDAF ML model monitoring registration resource is confirmed and a representation of that resource is returned. | +| NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. | | | | | +| NOTE 2: Failure cases are described in clause 5.6.7. | | | | | + +**Table 5.6.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}/nnwdaf-mlmodelmonitor//registrations/{registrationId} | + +### 5.6.3.2.4 Resource Custom Operations + +None in this release of the specification. + +## 5.6.3.3 Resource: Individual NWDAF ML model monitoring registration + +### 5.6.3.3.1 Description + +The Individual NWDAF ML model monitoring registration resource represents a single registration to the Nnwdaf\_MLModelMonitor Service at a given NWDAF containing MTLF. + +### 5.6.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwda-mlmodelmonitor//registrations/{registrationId} + +The shall be set as described in clause 5.6.1. + +This resource shall support the resource URI variables defined in table 5.6.3.3.2-1. + +**Table 5.6.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|-----------------------------------------------------------------| +| apiRoot | string | See clause 5.6.1. | +| registrationId | string | Identifies a registration to the Nnwdaf_MLModelMonitor Service. | + +### 5.6.3.3.3 Resource Standard Methods + +#### 5.6.3.3.3.1 DELETE + +This method shall support the URI query parameters specified in table 5.6.3.3.3.1-1. + +**Table 5.6.3.3.3.1-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.6.3.3.3.1-2 and the response data structures and response codes specified in table 5.6.3.3.3.1-3. + +**Table 5.6.3.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.6.3.3.3.1-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 NWDAF ML model monitoring registration resource matching the registrationId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual ML model monitoring registration deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual ML model monitoring registration deletion.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.6.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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.6.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 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +### 5.6.3.3.4 Resource Custom Operations + +None in this release of the specification. + +### 5.6.3.4 Resource: NWDAF ML model monitoring Subscriptions + +#### 5.6.3.4.1 Description + +The NWDAF ML model monitoring Subscriptions resource represents all subscriptions to the Nnwdaf\_MLModelMonitor Service at a given NWDAF containing AnLF. The resource allows an NF service consumer to create a new Individual NWDAF ML model monitoring subscription resource. + +#### 5.6.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nnwdaf-mlmodelmonitor//subscriptions + +The shall be set as described in clause 5.6.1. + +This resource shall support the resource URI variables defined in table 5.6.3.4.2-1. + +**Table 5.6.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.6.1 | + +### 5.6.3.4.3 Resource Standard Methods + +#### 5.6.3.4.3.1 POST + +This method shall support the URI query parameters specified in table 5.6.3.4.3.1-1. + +**Table 5.6.3.4.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.6.3.4.3.1-2 and the response data structures and response codes specified in table 5.6.3.4.3.1-3. + +**Table 5.6.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------------------------------------| +| MLModelMonitorSub | M | 1 | Create a new Individual NWDAF ML model monitoring subscription resource. | + +**Table 5.6.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| MLModelMonitorSub | M | 1 | 201
Created | The creation of an Individual NWDAF ML model monitoring subscription resource is confirmed and a representation of that resource is returned. | +| NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. | | | | | +| NOTE 2: Failure cases are described in clause 5.6.7. | | | | | + +**Table 5.6.3.4.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}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId} | + +#### 5.6.3.4.4 Resource Custom Operations + +None in this release of the specification. + +### 5.6.3.5 Resource: Individual NWDAF ML model monitoring Subscription + +#### 5.6.3.5.1 Description + +The Individual NWDAF ML model monitoring Subscription resource represents a single subscription to the Nnwdaf\_MLModelMonitor Service at a given NWDAF containing AnLF. + +#### 5.6.3.5.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId} + +The shall be set as described in clause 5.6.1. + +This resource shall support the resource URI variables defined in table 5.6.3.5.2-1. + +**Table 5.6.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|-----------------------------------------------------------------| +| apiRoot | string | See clause 5.6.1. | +| subscriptionId | string | Identifies a subscription to the Nnwdaf_MLModelMonitor Service. | + +### 5.6.3.5.3 Resource Standard Methods + +#### 5.6.3.5.3.1 PUT + +This method shall support the URI query parameters specified in table 5.6.3.5.3.1-1. + +**Table 5.6.3.5.3.1-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.6.3.5.3.1-2 and the response data structures and response codes specified in table 5.6.3.5.3.1-3. + +**Table 5.6.3.5.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|------------------------------------------------------------------------------------------| +| MLModelMonitorSub | M | 1 | Parameters to replace a subscription to NWDAF ML model monitoring subscription resource. | + +**Table 5.6.3.5.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| MLModelMonitorSub | M | 1 | 200 OK | The Individual NWDAF ML model monitoring subscription resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF ML model monitoring subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF ML model monitoring subscription modification.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF ML model monitoring subscription modification.
(NOTE 3) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +NOTE 2: Failure cases are described in clause 5.6.7. + +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.6.3.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.6.3.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.6.3.5.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.6.3.5.3.2-1. + +**Table 5.6.3.5.3.2-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.6.3.5.3.2-2 and the response data structures and response codes specified in table 5.6.3.5.3.2-3. + +**Table 5.6.3.5.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.6.3.5.3.2-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 NWDAF ML model monitoring subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual ML model monitoring subscription deletion.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual ML model monitoring subscription deletion.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.6.3.5.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.6.3.5.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NWDAF (service) instance towards which the request is redirected

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.6.3.5.4 Resource Custom Operations + +None in this release of the specification. + +### 5.6.4 Custom Operations without associated resources + +None in this release of the specification. + +### 5.6.5 Notifications + +#### 5.6.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.6.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|-------------------|---------------------------------|----------------------------------------| +| Event Notification | {notificationUri} | POST | Report analytics feedback information. | + +#### 5.6.5.2 Event Notification + +##### 5.6.5.2.1 Description + +The Event Notification is used by the NWDAF containing AnLF to report analytics feedback information to the NF service consumer that has subscribed to such Notifications. + +##### 5.6.5.2.2 Operation Definition + +Callback URI: {notificationUri} + +The operation shall support the callback URI variables defined in Table 5.6.5.2.2-1, the request data structures specified in table 5.6.5.2.2-2 and the response data structure and response codes specified in Table 5.6.5.2.2-3. + +**Table 5.6.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationUri | Uri | The Notification Uri is assigned within the Individual NWDAF ML model monitoring Subscription Resource and described within the MLModelMonitorSub data type (see table 5.6.6.2.3-1). | + +**Table 5.6.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|------------------------------------------| +| MLModelMonitorNotify | M | 1 | Provides analytics feedback information. | + +**Table 5.6.5.2.2-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 the event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.6.5.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 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.6.5.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.6.6 Data Model + +### 5.6.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.6.1-1 specifies the data types defined for the Nnwdaf\_MLModelMonitor service based interface protocol. + +**Table 5.6.6.1-1: Nnwdaf\_MLModelMonitor specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------------|----------------|-------------|---------------| +| AnalyticsFeedback | 5.6.6.2.6 | | | +| MLModelAccuracyInfo | 5.6.6.2.5 | | | +| MLModelMonitorNotify | 5.6.6.2.4 | | | +| MLModelMonitorReg | 5.6.6.2.2 | | | +| MLModelMonitorSub | 5.6.6.2.3 | | | + +Table 5.6.6.1-2 specifies data types re-used by the Nnwdaf\_MLModelMonitor 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 Nnwdaf\_MLModelMonitor service based interface. + +**Table 5.6.6.1-2: Nnwdaf\_MLModelMonitor re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|----------------------------------------------------------------------------------------|---------------| +| DataSetTag | 3GPP TS 29.575 [27] | Contains an identifier and a description of associated data or analytics records. | | +| DateTime | 3GPP TS 29.571 [8] | Identifies the time. | | +| Float | 3GPP TS 29.571 [8] | Number with format "float" as defined in OpenAPI Specification [11]. | | +| MLModelMetric | 5.4.6.3.4 | Indicates the ML Model Metric. | | +| NfInstanceId | 3GPP TS 29.571 [8] | Identifies an NF instance | | +| NfSetId | 3GPP TS 29.571 [8] | Identifies an NF Set instance. | | +| Nwdafevent | 5.1.6.3.4 | Indicates the NWDAF events. | | +| ReportingInformation | 3GPP TS 29.523 [20] | Represents the type of reporting the subscription requires. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of the optional features defined in table 5.1.8-1. | | +| UInteger | 3GPP TS 29.571 [8] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. | | +| Uri | 3GPP TS 29.571 [8] | Indicates the URI. | | + +## 5.6.6.2 Structured data types + +### 5.6.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.6.6.2.2 Type MLModelMonitorReg + +Table 5.6.6.2.2-1: Definition of type MLModelMonitorReg + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| consumerId | NfInstanceId | C | 0..1 | Indicates the NF instance ID of the consumer.
(NOTE) | | +| consumerSetId | NfSetId | C | 0..1 | Indicates the NF set ID of the consumer.
(NOTE) | | +| modelId | UInteger | M | 1 | The ML model ID. | | +| modelAccuInd | boolean | O | 0..1 | Indicates the ML Model accuracy transfer indication. Set to "true" to indicate that the monitoring of the accuracy of the ML model is supported. Default value is "false" if omitted. | | + +NOTE: One of "consumerId" and "consumerSetId" attributes shall be provided. + +## 5.6.6.2.3 Type MLModelMonitorSub + +Table 5.6.6.2.3-1: Definition of type MLModelMonitorSub + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| modelIds | array(Uinteger) | M | 1..N | The ML model IDs. | | +| notificationUri | Uri | M | 1 | Notification target address. | | +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| modelMetric | MLModelMetric | O | 0..1 | The ML model metrics to calculate the accuracy information. | | +| accuThreshold | Uinteger | O | 0..1 | Accuracy reporting threshold. Indicates the threshold upon the crossing of which (in either ascending or descending direction) the accuracy information needs to be reported. | | +| eventReportReq | ReportingInformation | O | 0..1 | Represents the reporting requirements of the event subscription.
If omitted, the default values within the ReportingInformation data type apply. | | +| immReports | array(MLModelMonitorNotify) | O | 1..N | Immediately reported ML model Monitoring notifications. It may only be provided in the HTTP POST response of a subscription creation/update and only if the immediate reporting flag was set to "true" in the HTTP POST request. | | +| suppFeat | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.1.8.
It shall be present in the POST request if at least one feature defined in clause 5.1.8 is supported, and it shall be present in the POST response if the NF service consumer included the "suppFeat" attribute in the POST request. | | + +## 5.6.6.2.4 Type MLModelMonitorNotify + +Table 5.6.6.2.4-1: Definition of type MLModelMonitorNotify + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|-------------------------------------------------------------------------------------|---------------| +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| modelAccuInfos | array(MLModelAccuracyInfo) | C | 1..N | The accuracy related information of the ML model.
(NOTE 1) | | +| anaFeedbacks | array(AnalyticsFeedback) | C | 1..N | The analytics feedback information.
(NOTE 1) | | +| validPeriod | TimeWindow | O | 0..1 | Represents the period during which the monitoring information is valid.
(NOTE 2) | | + +NOTE 1: At least one of "modelAccuInfos" and "anaFeedbacks" attributes shall be provided. +NOTE 2: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "validPeriod" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +## 5.6.6.2.5 Type MLModelAccuracyInfo + +Table 5.6.6.2.5-1: Definition of type MLModelAccuracyInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| modelId | UInteger | M | 1 | The ML model ID. | | +| deviation | Float | O | 0..1 | Indicates the deviation value of the predictions generated using the ML model from the ground truth data. | | +| inferenceNum | UInteger | O | 0..1 | The number of inferences that were performed during the time interval between Nnwdf MLModelMonitor_Register request and the Notify request or between the time of last Notification message and the time of the current Notification message. | | +| adrflId | NfInstanceId | O | 0..1 | Identifier of the ADRF.
(NOTE) | | +| adrSetId | NfSetId | O | 0..1 | Identifier of the ADRF Set.
(NOTE) | | +| dataSetTag | DataSetTag | O | 0..1 | Data set tag of the data stored in ADRF which can be used by MTLF. This attribute may be present if the "adrflId" or "adrSetId" attribute is present. | | +| modelMetric | MLModelMetric | O | 0..1 | The ML model metrics to calculate the accuracy information. | | + +NOTE: "adrflId" and "adrSetId" are mutually exclusive. + +### 5.6.6.2.6 Type AnalyticsFeedback + +**Table 5.6.6.2.6-1: Definition of type AnalyticsFeedback** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| events | array(Nwdafevent) | M | 1..N | Each element indicates the Analytics ID that was used to take this action. | | +| modelIds | array(uinteger) | M | 1..N | Each element indicate the ML Model identifier that was used to take this action. | | +| groundDataImpactInd | boolean | O | 0..1 | Indication whether the action will affect on ground truth data.
Set to "true" to indicate that the action will affect on ground truth data. Otherwise, default value is "false" if omitted. | | +| timeStamp | DateTime | O | 0..1 | Time stamp when the action was taken. | | + +## 5.6.7 Error handling + +### 5.6.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of TS 29.500 [6]. + +For the Nnwdafevent\_MLModelMonitor API, HTTP error responses shall be supported as specified in clause 4.8 of TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of TS 29.500 [6] 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 TS 29.500 [6]. In addition, the requirements in the following clauses shall apply. + +### 5.6.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdafevent\_MLModelMonitor API. + +### 5.6.7.3 Application Errors + +The application errors defined for the Nnwdafevent\_MLModelMonitor API are listed in table 5.6.7.3-1. + +**Table 5.6.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 5.6.8 Feature negotiation + +The optional features in table 5.6.8-1 are defined for the Nnwdafevent\_MLModelMonitor API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.6.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 5.6.9 Security + +As indicated in TS 33.501 [13] and TS 29.500 [6], the access to the Nnwdaf\_MLModelMonitor API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [14]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnwdaf\_MLModelMonitor API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in TS 29.510 [12], 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 Nnwdaf\_MLModelMonitor service. + +The Nnwdaf\_MLModelMonitor API defines a single scope "nnwdaf-mlmodelmonitor" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 5.7 Nnwdaf\_RoamingData Service API + +### 5.7.1 Introduction + +The Nnwdaf\_RoamingData service shall use the Nnwdaf\_RoamingData API. + +The API URI of the Nnwdaf\_RoamingData API shall be: + +{apiRoot}/ + +The request URIs used in each HTTP requests from the NF service consumer towards the RE-NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-roamingdata". +- The shall be "v1". +- The shall be set as described in clause 5.7.3. + +### 5.7.2 Usage of HTTP + +#### 5.7.2.1 General + +HTTP/2, IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_RoamingData is contained in Annex A. + +#### 5.7.2.2 HTTP standard headers + +##### 5.7.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +##### 5.7.2.2.2 Content type + +JSON, IETF RFC 8259 [10], 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 [6]. 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 [15]. + +### 5.7.2.3 HTTP custom headers + +The Nnwdaf\_RoamingData service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_RoamingData service API. + +## 5.7.3 Resources + +### 5.7.3.1 Resource Structure + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.7.3.1-1 depicts the resource URIs structure for the Nnwdaf\_RoamingData API. + +![Diagram showing the hierarchical structure of Resource URIs for the Nnwdaf_RoamingData API. The root URI is {apiRoot}/nnwda-roamingdata/. It branches to /subscriptions, which further branches to /{subscriptionId}.](746339de60a18834270b45f3928c3e8a_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnwda-roamingdata/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the hierarchical structure of Resource URIs for the Nnwdaf\_RoamingData API. The root URI is {apiRoot}/nnwda-roamingdata/. It branches to /subscriptions, which further branches to /{subscriptionId}. + +Figure 5.7.3.1-1: Resource URI structure of the Nnwdaf\_RoamingData API + +Table 5.7.3.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 5.7.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------|---------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------| +| NWDAF Roaming Data Subscriptions | /subscriptions | POST | Create a new Individual NWDAF Roaming Data Subscription resource on the NWDAF. | +| Individual NWDAF Roaming Data Subscription | /subscriptions/{subscriptionId} | PUT | Modifies an existing Roaming Data Subscription resource on the NWDAF. | +| | | DELETE | Delete an Individual NWDAF Roaming Data Subscription identified by {subscriptionId} on the NWDAF. | + +### 5.7.3.2 Resource: NWDAF Roaming Data Subscriptions + +#### 5.7.3.2.1 Description + +The NWDAF Roaming Data Subscriptions resource represents all subscriptions to the Nnwdaf\_RoamingData Service at a given RE-NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF Roaming Data Subscription resource. + +### 5.7.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnwda-roamingdata//subscriptions + +The shall be set as described in clause 5.7.1. + +This resource shall support the resource URI variables defined in table 5.7.3.2.2-1. + +**Table 5.7.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.7.1 | + +### 5.7.3.2.3 Resource Standard Methods + +#### 5.7.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.7.3.2.3.1-1. + +**Table 5.7.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.7.3.2.3.1-2 and the response data structures and response codes specified in table 5.7.3.2.3.1-3. + +**Table 5.7.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-------------------------------------------------------------------| +| RoamingDataSub | M | 1 | Create a new Individual NWDAF Roaming Data Subscription resource. | + +**Table 5.7.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------| +| RoamingDataSub | M | 1 | 201
Created | The creation of an Individual NWDAF Roaming Data Subscription resource is confirmed and a representation of that resource is returned. | +| NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. | | | | | +| NOTE 2: Failure cases are described in clause 5.7.7. | | | | | + +**Table 5.7.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}/nnwda-roamingdata//subscriptions/{subscriptionId} | + +### 5.7.3.2.4 Resource Custom Operations + +None in this release of the specification. + +### 5.7.3.3 Resource: Individual NWDAF Roaming Data Subscription + +#### 5.7.3.3.1 Description + +The Individual NWDAF Roaming Data Subscription resource represents a single subscription to the Nnwdaf\_RoamingData Service at a given RE-NWDAF. + +#### 5.7.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-roamingdata//subscriptions/{subscriptionId} + +The shall be set as described in clause 5.7.1. + +This resource shall support the resource URI variables defined in table 5.7.3.3.2-1. + +**Table 5.7.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------| +| apiRoot | string | See clause 5.7.1. | +| subscriptionId | string | Identifies a subscription to the Nnwdaf_RoamingData Service. | + +#### 5.7.3.3.3 Resource Standard Methods + +##### 5.7.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 5.7.3.3.3.1-1. + +**Table 5.7.3.3.3.1-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.7.3.3.3.1-2 and the response data structures and response codes specified in table 5.7.3.3.3.1-3. + +**Table 5.7.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-----------------------------------------------------------------------------------| +| RoamingDataSub | M | 1 | Parameters to replace a subscription to NWDAF Roaming Data Subscription resource. | + +**Table 5.7.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| RoamingDataSub | M | 1 | 200 OK | The Individual NWDAF Roaming Data Subscription resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF Roaming Data Subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Roaming Data Subscription modification.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Roaming Data subscription modification.
(NOTE 3) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +NOTE 2: Failure cases are described in clause 5.7.7. + +NOTE 3: The RedirectResponse data structure may be provided by an SEPP or SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.7.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 | Contains an alternative URI of the resource located in an alternative RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SEPP or SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.7.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 | Contains an alternative URI of the resource located in an alternative RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SEPP or SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +### 5.7.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.7.3.3.3.2-1. + +**Table 5.7.3.3.3.2-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.7.3.3.3.2-2 and the response data structures and response codes specified in table 5.7.3.3.3.2-3. + +**Table 5.7.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.7.3.3.3.2-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 NWDAF Roaming Data Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Roaming Data Subscription deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Roaming Data Subscription deletion.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SEPP or SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.7.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 | Contains an alternative URI of the resource located in an alternative RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SEPP or SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +**Table 5.7.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 | Contains an alternative URI of the resource located in an alternative RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SEPP or SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +### 5.7.3.3.4 Resource Custom Operations + +None in this release of the specification. + +## 5.7.4 Custom Operations without associated resources + +None in this release of the specification. + +## 5.7.5 Notifications + +### 5.7.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.7.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|-------------------|---------------------------------|---------------------------------------------------| +| Event Notification | {notificationUri} | POST | Report data information related to roaming UE(s). | + +### 5.7.5.2 Event Notification + +#### 5.7.5.2.1 Description + +The Event Notification is used by the RE-NWDAF to report data information to the NF service consumer that has subscribed to such Notifications. + +#### 5.7.5.2.2 Operation Definition + +Callback URI: {notificationUri} + +The operation shall support the callback URI variables defined in Table 5.7.5.2.2-1, the request data structures specified in table 5.7.5.2.2-2 and the response data structure and response codes specified in Table 5.7.5.2.2-3. + +**Table 5.7.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationUri | Uri | The Notification Uri is assigned within the Individual NWDAF Roaming Data Subscription Resource and described within the RoamingDataSub data type (see table 5.7.6.2.3-1). | + +**Table 5.7.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|-----------------------------------------| +| NnwdafDataManagementNotif | M | 1 | Provides data related to roaming UE(s). | + +**Table 5.7.5.2.2-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 the event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SEPP or SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.7.5.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SEPP or SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 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.7.5.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SEPP or SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.7.6 Data Model + +### 5.7.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.7.6.1-1 specifies the data types defined for the Nnwdaf\_RoamingData service based interface protocol. + +**Table 5.7.6.1-1: Nnwdaf\_RoamingData specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------|----------------|---------------------------------------------------|---------------| +| RoamingDataSub | 5.7.6.2.2 | Represents roaming data subscription information. | | + +Table 5.7.6.1-2 specifies data types re-used by the Nnwdaf\_RoamingData 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 Nnwdaf\_RoamingData service based interface. + +**Table 5.7.6.1-2: Nnwdaf\_RoamingData re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|---------------------------|---------------------|----------------------------------------------------------------------------------------|----------------------| +| DataSubscription | 3GPP TS 29.575 [27] | Subscription information for data retrieval from data source. | | +| DateTime | 3GPP TS 29.571 [8] | Identifies the time. | | +| FormattingInstruction | 3GPP TS 29.574 [26] | DCCF formatting Instructions. | | +| NfInstanceId | 3GPP TS 29.571 [8] | Identifies an NF instance | | +| NfSetId | 3GPP TS 29.571 [8] | Identifies an NF Set instance. | | +| NnwdafDataManagementNotif | 5.3.6.2.3 | The data notification. | | +| NwdafEvent | 5.1.6.3.4 | Indicates the NWDAF events. | | +| NnwdafEventsSubscription | 5.1.6.2.2 | Represents an NWDAF analytics subscription information. | | +| PlmnId | 3GPP TS 29.571 [8] | Identifies a PLMN Identifier. | | +| ProcessingInstruction | 3GPP TS 29.574 [26] | DCCF processing Instructions. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of the optional features defined in table 5.7.8-1. | | +| TimeWindow | 3GPP TS 29.122 [19] | Represents a time window. | | +| Uinteger | 3GPP TS 29.571 [8] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. | | +| Uri | 3GPP TS 29.571 [8] | Indicates the URI. | | + +## 5.7.6.2 Structured data types + +### 5.7.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.7.6.2.2 Type RoamingDataSub + +**Table 5.7.6.2.2-1: Definition of type RoamingDataSub** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notificationUri | Uri | M | 1 | Notification target address. | | +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| plmnId | PlmnId | M | 1 | PLMN ID of the consumer. | | +| dataSub | DataSubscription | C | 0..1 | Subscribed data events.
(NOTE 1) | | +| anaSub | NnwdafEventsSubscription | C | 0..1 | Analytics subscription information to be used by the NWDAF to determine the data that can be used to generate these analytics, specified by the "anaSub" attribute.
(NOTE 1) | | +| formatInstruct | FormattingInstruction | O | 0..1 | Formatting instructions to be used for sending event notifications. If provided, they take precedence over any potentially conflicting event reporting requirements provided within the "dataSub" attribute. | | +| procInstructs | array(ProcessingInstruction) | O | 1..N | Processing instructions to be used for sending event notifications. | | +| timePeriod | TimeWindow | O | 0..1 | Represents a start time and a stop time during which the data was collected or is requested to be collected. If provided, the time period related attributes contained in "dataSub" attribute shall be ignored.
(NOTE 2) | | +| targetNfId | NfInstanceId | O | 0..1 | The NF instance identifier from which the NWDAF may collect the requested data.
(NOTE 3) | | +| targetNfSetId | NfSetId | O | 0..1 | NF set identifier from which the NWDAF may collect the requested data.
(NOTE 3) | | +| immReports | array(NnwdafDataManagementNotif) | O | 1..N | Immediately reported roaming data notifications. It may only be provided in the HTTP POST response of a subscription creation/update and only if the immediate reporting flag was set to "true" in the HTTP POST request. | | +| suppFeat | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.7.8.
It shall be present in the POST request if at least one feature defined in clause 5.1.8 is supported, and it shall be present in the POST response if the NF service consumer included the "suppFeat" attribute in the POST request. | | + +NOTE 1: One of these attributes shall be provided. + +NOTE 2: It includes the time period either in the past or in the future (i.e., start time as past time and stop time as + +future time is not allowed). + +NOTE 3: The "targetNfId" and "targetNfSetId" attributes are mutually exclusive. + +## 5.7.7 Error handling + +### 5.7.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of TS 29.500 [6]. + +For the Nnwdaf\_RoamingData API, HTTP error responses shall be supported as specified in clause 4.8 of TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of TS 29.500 [6] 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 TS 29.500 [6]. In addition, the requirements in the following clauses shall apply. + +### 5.7.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_RoamingData API. + +### 5.7.7.3 Application Errors + +The application errors defined for the Nnwdaf\_RoamingData API are listed in table 5.7.7.3-1. + +**Table 5.7.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 5.7.8 Feature negotiation + +The optional features in table 5.7.8-1 are defined for the Nnwdaf\_RoamingData API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.7.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 5.7.9 Security + +As indicated in TS 33.501 [13] and TS 29.500 [6], the access to the Nnwdaf\_RoamingData API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [14]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnwdaf\_RoamingData API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in TS 29.510 [12], 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 Nnwdaf\_RoamingData service. + +The Nnwdaf\_RoamingData API defines a single scope "nnwdaf-roamingdata" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 5.8 Nnwdaf\_RoamingAnalytics Service API + +### 5.8.1 Introduction + +The Nnwdaf\_RoamingAnalytics service shall use the Nnwdaf\_RoamingAnalytics API. + +The API URI of the Nnwdaf\_RoamingAnalytics API shall be: + +{apiRoot}/ + +The request URIs used in each HTTP requests from the NF service consumer towards the RE-NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-roaminganalytics". +- The shall be "v1". +- The shall be set as described in clause 5.8.3. + +### 5.8.2 Usage of HTTP + +#### 5.8.2.1 General + +HTTP/2, IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_RoamingAnalytics API is contained in Annex A.9. + +#### 5.8.2.2 HTTP standard headers + +##### 5.8.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +##### 5.8.2.2.2 Content type + +JSON, IETF RFC 8259 [10], 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 [6]. 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 an HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [15]. + +#### 5.8.2.3 HTTP custom headers + +The Nnwdaf\_RoamingAnalytics service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_RoamingAnalytics service API. + +## 5.8.3 Resources + +### 5.8.3.1 Resource Structure + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.8.3.1-1 depicts the resource URIs structure for the Nnwdaf\_RoamingAnalytics API. + +![Diagram showing the hierarchical structure of resource URIs for the Nnwdaf_RoamingAnalytics API. The root is {apiRoot}/nnwda-roaminganalytics/. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subscriptionId}.](eabcc5363ff05be5b1ec4bf0aa360d2f_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnwda-roaminganalytics/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the hierarchical structure of resource URIs for the Nnwdaf\_RoamingAnalytics API. The root is {apiRoot}/nnwda-roaminganalytics/. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subscriptionId}. + +**Figure 5.8.3.1-1: Resource URI structure of the Nnwdaf\_RoamingAnalytics API** + +Table 5.8.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.8.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------------------------|---------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| NWDAF Roaming Analytics Subscriptions | /subscriptions | POST | Create a new Individual NWDAF Roaming Analytics Subscription resource on the NWDAF with roaming exchange capability. | +| Individual NWDAF Roaming Analytics Subscription | /subscriptions/{subscriptionId} | PUT | Modifies an existing Individual NWDAF Roaming Analytics Subscription resource on the NWDAF with roaming exchange capability. | +| | | DELETE | Delete the Individual NWDAF Roaming Analytics Subscription resource identified by {subscriptionId} on the NWDAF with roaming exchange capability. | + +### 5.8.3.2 Resource: NWDAF Roaming Analytics Subscriptions + +#### 5.8.3.2.1 Description + +The NWDAF Roaming Analytics Subscriptions resource represents all subscriptions to the Nnwdaf\_RoamingAnalytics Service at a given RE-NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF Roaming Analytics Subscription resource. + +#### 5.8.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnwda-roaminganalytics//subscriptions + +The shall be set as described in clause 5.8.1. + +This resource shall support the resource URI variables defined in table 5.8.3.2.2-1. + +**Table 5.8.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.8.1 | + +### 5.8.3.2.3 Resource Standard Methods + +#### 5.8.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.8.3.2.3.1-1. + +**Table 5.8.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.8.3.2.3.1-2 and the response data structures and response codes specified in table 5.8.3.2.3.1-3. + +**Table 5.8.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------------|---|-------------|------------------------------------------------------------------------| +| RoamingAnalytics Subscription | M | 1 | Create a new Individual NWDAF Roaming Analytics subscription resource. | + +**Table 5.8.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| RoamingAnalyticsSubscription | M | 1 | 201 Created | The creation of an Individual NWDAF Roaming Analytics subscription resource is confirmed and a representation of that resource is returned. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure cases are described in clause 5.8.7. + +**Table 5.8.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}/nnwdaf-roaminganalytics//subscriptions/{subscriptionId} | + +### 5.8.3.2.4 Resource Custom Operations + +None in this release of the specification. + +### 5.8.3.3 Resource: Individual NWDAF Roaming Analytics Subscription + +#### 5.8.3.3.1 Description + +The Individual NWDAF Roaming Analytics Subscription resource represents a single subscription to the Nnwdaf\_RoamingAnalytics Service at a given RE-NWDAF. + +#### 5.8.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-roaminganalytics//subscriptions/{subscriptionId} + +The shall be set as described in clause 5.8.1. + +This resource shall support the resource URI variables defined in table 5.8.3.3.2-1. + +**Table 5.8.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|-------------------------------------------------------------------| +| apiRoot | string | See clause 5.8.1. | +| subscriptionId | string | Identifies a subscription to the Nnwdaf_RoamingAnalytics Service. | + +#### 5.8.3.3.3 Resource Standard Methods + +##### 5.8.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 5.8.3.3.3.1-1. + +**Table 5.8.3.3.3.1-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.8.3.3.3.1-2 and the response data structures and response codes specified in table 5.8.3.3.3.1-3. + +**Table 5.8.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|------------------------------------------------------------------| +| RoamingAnalyticsSubscription | M | 1 | Parameters to replace a subscription to NWDAF Roaming Analytics. | + +**Table 5.8.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| RoamingAnalyticsSubscription | M | 1 | 200 OK | The Individual NWDAF Roaming Analytics subscription resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF Roaming Analytics subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Roaming Analytics subscription modification.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Roaming Analytics subscription modification.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure cases are described in clause 5.8.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP or a SEPP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.8.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP or SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +**Table 5.8.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP or SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +### 5.8.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.8.3.3.2-1. + +**Table 5.8.3.3.3.2-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.8.3.3.3.2-2 and the response data structures and response codes specified in table 5.8.3.3.3.2-3. + +**Table 5.8.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.8.3.3.3.2-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 NWDAF Roaming Analytics subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Roaming Analytics subscription deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Roaming Analytics subscription deletion.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP or a SEPP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.8.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 | Contains an alternative URI of the resource located in an alternative RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP or SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +**Table 5.8.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 | Contains an alternative URI of the resource located in an alternative RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP or SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +#### 5.8.3.3.4 Resource Custom Operations + +None in this release of the specification. + +### 5.8.4 Custom Operations without associated resources + +None in this release of the specification. + +### 5.8.5 Notifications + +#### 5.8.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.8.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------|--------------|---------------------------------|--------------------------------------------| +| Roaming Analytics Notification | {notifUri} | POST | Report analytics related to roaming UE(s). | + +#### 5.8.5.2 Roaming Analytics Notification + +##### 5.8.5.2.1 Description + +The Roaming Analytics Notification is used by the RE-NWDAF to report analytics related to roaming UE(s) to the NF service consumer that has subscribed to such notifications. + +##### 5.8.5.2.2 Operation Definition + +Callback URI: **{notifUri}** + +The operation shall support the callback URI variables defined in Table 5.8.5.2.2-1, the request data structures specified in table 5.8.5.2.2-2 and the response data structure and response codes specified in Table 5.8.5.2.2-3. + +**Table 5.8.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri is assigned within the Individual NWDAF Roaming Analytics Subscription Resource and described within the RoamingAnalyticsSubscription data type. | + +**Table 5.8.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|----------------------------------------------| +| RoamingAnalyticsNotification | M | 1 | Provides analytics related to roaming UE(s). | + +**Table 5.8.5.2.2-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 the event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP or a SEPP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.8.5.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP or SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 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.8.5.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP or SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.8.6 Data Model + +### 5.8.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.8.6.1-1 specifies the data types defined for the Nnwdaf\_RoamingAnalytics service based interface protocol. + +**Table 5.8.6.1-1: Nnwdaf\_RoamingAnalytics specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------------------|----------------|---------------------------------|---------------| +| RoamingAnalyticsSubscription | 5.8.6.2.2 | Roaming Analytics Subscription. | | +| RoamingAnalyticsNotification | 5.8.6.2.3 | Roaming Analytics Notification. | | + +Table 5.8.6.1-2 specifies data types re-used by the Nnwdaf\_RoamingAnalytics 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 Nnwdaf\_RoamingAnalytics service based interface. + +**Table 5.8.6.1-2: Nnwdaf\_RoamingAnalytics re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|----------------------------------------------------------------------------------------|----------------------| +| EventNotification | 5.1.6.2.5 | Contains NWDAF events that are being notified. | | +| EventSubscription | 5.1.6.2.3 | Contains NWDAF events to be subscribed. | | +| FailureEventInfo | 5.1.6.2.35 | Information about events for which the subscription failed. | | +| PlmnId | 3GPP TS 29.571 [8] | PLMN identifier. | | +| ReportingInformation | 3GPP TS 29.523 [20] | Represents the type of reporting the subscription requires. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of the optional features defined in table 5.7.8-1. | | +| TermCause | 5.1.6.3.26 | Cause of termination of an analytics subscription. | | +| Uri | 3GPP TS 29.571 [8] | Indicates the URI. | | + +## 5.8.6.2 Structured data types + +### 5.8.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.8.6.2.2 Type RoamingAnalyticsSubscription + +Table 5.8.6.2.2-1: Definition of type RoamingAnalyticsSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| roamEventSubs | array(EventSubscription) | M | 1..N | Subscribed events. (NOTE 1) | | +| evtReq | ReportingInformation | O | 0..1 | Represents the reporting requirements of the event subscription. (NOTE 2, NOTE 3)
If omitted, the default values within the ReportingInformation data type apply. | | +| notifUri | Uri | M | 1 | Identifies the recipient of Notifications sent by the NWDAF. | | +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| consPlmnId | PlmnId | M | 1 | The PLMN ID of the NF service consumer. | | +| roamEventNotifs | array(EventNotification) | C | 1..N | Notifications about Individual Events.
Shall only be present in the response to a subscription creation or modification if the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute was set to true in the request and the reports are available. (NOTE 4) | | +| failEventReports | array(FailureEventInfo) | O | 1..N | It may be supplied by the NWDAF in the response to a subscription creation or modification. When available, it contains the event(s) for which the subscription was not successful including the failure reason(s). | | +| supportedFeatures | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.8.8.
This parameter shall be included in the response to the subscription creation or modification if it was included in the request. | | + +NOTE 1: The attributes "useCaseCxt", "accuReq", "pauseFlg", "resumeFlg", as well as the attributes "anaMeta" and "anaMetaInd" within the "extraReportReq" attribute, are not applicable here. + +NOTE 2: If the "evtReq" attribute (of data type ReportingInformation) is provided and contains the "notifMethod" attribute, the notification method indicated by the "notifMethod" attribute within the ReportingInformation data type takes precedence over the notification method indicated by the "notificationMethod" attribute within the EventSubscription data type. + +NOTE 3: If the "evtReq" attribute (of data type ReportingInformation) is provided and contains the "repPeriod" attribute, the periodic reporting time indicated by the "repPeriod" attribute in the ReportingInformation data type takes precedence over the periodic reporting time indicated by the "repetitionPeriod" attribute in the EventSubscription data type. + +NOTE 4: The attributes "anaMetaInfo", "accuInfo", "cancelAccuInd", "pauseInd", and "resumeInd" are not applicable here. + +### 5.8.6.2.3 Type RoamingAnalyticsNotification + +**Table 5.8.6.2.3-1: Definition of type RoamingAnalyticsNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| roamEventNotifs | array(EventNotification) | M | 1..N | Notifications about Individual Events.
(NOTE) | | +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| termCause | TermCause | O | 0..1 | A cause for which the NWDAF will send no further notifications for this subscription. Its presence indicates that the NWDAF requests the termination of the subscription. | | + +NOTE: The attributes "anaMetaInfo", "accuInfo", "cancelAccuInd", "pauseInd", and "resumeInd" are not applicable here. + +## 5.8.7 Error handling + +### 5.8.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of TS 29.500 [6]. + +For the Nnwdaf\_RoamingAnalytics API, HTTP error responses shall be supported as specified in clause 4.8 of TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of TS 29.500 [6] 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 TS 29.500 [6]. In addition, the requirements in the following clauses shall apply. + +### 5.8.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_RoamingAnalytics API. + +### 5.8.7.3 Application Errors + +The application errors defined for the Nnwdaf\_RoamingAnalytics API are listed in table 5.8.7.3-1. + +**Table 5.8.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BOTH_STAT_PRED_NOT_ALLOWED | 400 Bad Request | For the requested observation period, the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics. | +| UNAVAILABLE_DATA | 500 Internal Server Error | Indicates the requested statistics in the past is rejected since necessary data to perform the service is unavailable. | + +NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. + +## 5.8.8 Feature negotiation + +The optional features in table 5.8.8-1 are defined for the Nnwdaf\_RoamingAnalytics API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.8.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 5.8.9 Security + +As indicated in TS 33.501 [13] and TS 29.500 [6], the access to the Nnwdaf\_RoamingAnalytics API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [14]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnwdaf\_RoamingAnalytics API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in TS 29.510 [12], 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 Nnwdaf\_RoamingAnalytics service. + +The Nnwdaf\_RoamingAnalytics API defines a single scope "nnwdaf-roaminganalytics" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +The present Annex contains an OpenAPI [11] specification of HTTP messages and content bodies used by the Nnwdaf\_EventsSubscription, the Nnwdaf\_AnalyticsInfo, Nnwdaf\_DataManagement, Nnwdaf\_ModelProvision, and Nnwdaf\_ModelTraining APIs. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [16] and clause 5.3.1 of the 3GPP TS 29.501 [7] for further information). + +## A.2 Nnwdaf\_EventsSubscription API + +``` +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.5 + title: Nnwdaf_EventsSubscription + description: | + Nnwdaf_EventsSubscription Service API. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/' + +security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + +servers: + - url: '{apiRoot}/nnwdaf-eventssubscription/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +paths: + /subscriptions: + post: + summary: Create a new Individual NWDAF Events Subscription + operationId: CreateNWDAFEventsSubscription + tags: + - NWDAF Events Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafEventsSubscription' + responses: + '201': + description: Create a new Individual NWDAF Event Subscription resource. + headers: + Location: +``` + +``` + +description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdafeventssubscription/{apiVersion}/subscriptions/{subscriptionId} +required: true +schema: + type: string +content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafeventsSubscription' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + myNotification: + '{ $request.body#/notificationURI }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NnwdafeventsSubscriptionNotification' + minItems: 1 + responses: + '204': + description: The receipt of the Notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +``` + +``` + +/subscriptions/{subscriptionId}: + delete: + summary: Delete an existing Individual NWDAF Events Subscription + operationId: DeleteNWDAFEventsSubscription + tags: + - Individual NWDAF Events Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_EventsSubscription Service + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF Event Subscription resource matching the subscriptionId + was deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + put: + summary: Update an existing Individual NWDAF Events Subscription + operationId: UpdateNWDAFEventsSubscription + tags: + - Individual NWDAF Events Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafEventsSubscription' + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_EventsSubscription Service. + required: true + schema: + type: string + responses: + '200': + description: > + The Individual NWDAF Event Subscription resource was modified successfully and a + representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafEventsSubscription' + '204': + description: The Individual NWDAF Event Subscription resource was modified successfully. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + +``` + +``` +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/transfers: + post: + summary: Provide information about requested analytics subscriptions transfer and potentially +create a new Individual NWDAF Event Subscription Transfer resource. + operationId: CreateNWDAFEventSubscriptionTransfer + tags: + - NWDAF Event Subscription Transfers (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + - nnwdaf-eventssubscription:transfer + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AnalyticsSubscriptionsTransfer' + responses: + '201': + description: Create a new Individual NWDAF Event Subscription Transfer resource. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaf-eventssubscription/{apiVersion}/transfers/{transferId} + required: true + schema: + type: string + '204': + description: > + No Content. The receipt of the information about analytics subscription(s) that are + requested to be transferred and the ability to handle this information (e.g. execute the + steps required to transfer an analytics subscription directly) is confirmed. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/transfers/{transferId}: + delete: + summary: Delete an existing Individual NWDAF Event Subscription Transfer + operationId: DeleteNWDAFEventSubscriptionTransfer + tags: + - Individual NWDAF Event Subscription Transfer (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + - nnwdaf-eventssubscription:transfer + parameters: + - name: transferId + in: path + description: > + String identifying a request for an analytics subscription transfer to the + Nnwdaf_EventsSubscription Service. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF Event Subscription Transfer resource matching the + transferId was deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + put: + summary: Update an existing Individual NWDAF Event Subscription Transfer + operationId: UpdateNWDAFEventSubscriptionTransfer + tags: + - Individual NWDAF Event Subscription Transfer (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + - nnwdaf-eventssubscription:transfer + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AnalyticsSubscriptionsTransfer' + parameters: +``` + +``` +- name: transferId + in: path + description: > + String identifying a request for an analytics subscription transfer to the + Nnwdaf_EventsSubscription Service + required: true + schema: + type: string +responses: + '204': + description: > + The Individual NWDAF Event Subscription Transfer resource was modified successfully. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + +securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnwdafeventssubscription: Access to the Nnwdaf_EventsSubscription API + nnwdafeventssubscription:transfer: > + Access to service operations applying to NWDAF event subscription transfer. + +schemas: + +NnwdafEventsSubscription: + description: Represents an Individual NWDAF Event Subscription resource. + type: object + properties: + eventSubscriptions: + type: array + items: + $ref: '#/components/schemas/EventSubscription' + minItems: 1 + description: Subscribed events + evtReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notificationURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + eventNotifications: +``` + +``` + type: array + items: + $ref: '#/components/schemas/EventNotification' + minItems: 1 + failEventReports: + type: array + items: + $ref: '#/components/schemas/FailureEventInfo' + minItems: 1 + prevSub: + $ref: '#/components/schemas/PrevSubInfo' + consNfInfo: + $ref: '#/components/schemas/ConsumerNfInformation' + required: + - eventSubscriptions + +EventSubscription: + description: Represents a subscription to a single event. + type: object + properties: + anySlice: + $ref: '#/components/schemas/AnySlice' + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + description: Identification(s) of application to which the subscription applies. + deviations: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + minItems: 1 + dnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + description: Identification(s) of DNN to which the subscription applies. + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + event: + $ref: '#/components/schemas/Nwdafevent' + extraReportReq: + $ref: '#/components/schemas/EventReportingRequirement' + ladnDnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + description: Identification(s) of LADN DNN to indicate the LADN service area as the AOI. + loadLevelThreshold: + type: integer + description: > + Indicates that the NWDAF shall report the corresponding network slice load level to the + NF service consumer where the load level of the network slice identified by snssais is + reached. + notificationMethod: + $ref: '#/components/schemas/NotificationMethod' + matchingDir: + $ref: '#/components/schemas/MatchingDirection' + nfLoadLvlThds: + type: array + items: + $ref: '#/components/schemas/ThresholdLevel' + minItems: 1 + description: > + Shall be supplied in order to start reporting when an average load level is reached. + nfInstanceIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + nfSetIds: + type: array +``` + +``` +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +minItems: 1 +nfTypes: +type: array +items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' +minItems: 1 +networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' +location: + $ref: '#/components/schemas/GeoLocation' +temporalGranSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +spatialGranSizeTa: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +spatialGranSizeCell: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +fineGranAreas: +type: array +items: + $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' +minItems: 1 +description: Indicates the fine granularity areas to which the subscription applies. +visitedAreas: +type: array +items: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' +minItems: 1 +maxTopAppUINbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +maxTopAppDlNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +nsiIdInfos: +type: array +items: + $ref: '#/components/schemas/NsiIdInfo' +minItems: 1 +nsiLevelThrds: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +minItems: 1 +qosRequ: + $ref: '#/components/schemas/QosRequirement' +qosFlowRetThrds: +type: array +items: + $ref: '#/components/schemas/RetainabilityThreshold' +minItems: 1 +ranUeThrouThrds: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' +minItems: 1 +repetitionPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +snssai: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +minItems: 1 +description: > + Identification(s) of network slice to which the subscription applies. It corresponds to + snssais in the data model definition of 3GPP TS 29.520. +tgtUe: + $ref: '#/components/schemas/TargetUeInformation' +roamingInfo: + $ref: '#/components/schemas/RoamingInfo' +congThresholds: +type: array +items: + $ref: '#/components/schemas/ThresholdLevel' +minItems: 1 +nwPerfRequs: +type: array +items: + $ref: '#/components/schemas/NetworkPerfRequirement' +``` + +``` + minItems: 1 + ueCommReqs: + type: array + items: + $ref: '#/components/schemas/UeCommReq' + minItems: 1 + ueMobilityReqs: + type: array + items: + $ref: '#/components/schemas/UeMobilityReq' + minItems: 1 + userDataConOrderCri: + $ref: '#/components/schemas/UserDataConOrderCrit' + bwReqs: + type: array + items: + $ref: '#/components/schemas/BwRequirement' + minItems: 1 + excepReqs: + type: array + items: + $ref: '#/components/schemas/Exception' + minItems: 1 + exptAnaType: + $ref: '#/components/schemas/ExpectedAnalyticsType' + exptUeBehav: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExpectedUeBehaviourData' + ratFreqs: + type: array + items: + $ref: '#/components/schemas/RatFreqInformation' + minItems: 1 + listOfAnaSubsets: + type: array + items: + $ref: '#/components/schemas/AnalyticsSubset' + minItems: 1 + disperReqs: + type: array + items: + $ref: '#/components/schemas/DispersionRequirement' + minItems: 1 + redTransReqs: + type: array + items: + $ref: '#/components/schemas/RedundantTransmissionExpReq' + minItems: 1 + wlanReqs: + type: array + items: + $ref: '#/components/schemas/WlanPerformanceReq' + minItems: 1 + upfInfo: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/UpfInformation' + appServerAddrs: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' + minItems: 1 + dnPerfReqs: + type: array + items: + $ref: '#/components/schemas/DnPerformanceReq' + minItems: 1 + pduSesInfos: + type: array + items: + $ref: '#/components/schemas/PduSessionInfo' + minItems: 1 + useCaseCxt: + type: string + description: > + Indicates the context of usage of the analytics. The value and format of this parameter + are not standardized. + pduSesTrafReqs: + type: array + items: + $ref: '#/components/schemas/PduSesTrafficReq' +``` + +``` + + minItems: 1 + locAccReqs: + type: array + items: + $ref: '#/components/schemas/LocAccuracyReq' + minItems: 1 + locGranularity: + $ref: '#/components/schemas/LocInfoGranularity' + locOrientation: + $ref: '#/components/schemas/LocationOrientation' + dataVlTrnsTmRqs: + type: array + items: + $ref: '#/components/schemas/E2eDataVolTransTimeReq' + minItems: 1 + accuReq: + $ref: '#/components/schemas/AccuracyReq' + pauseFlg: + type: boolean + description: > + Pause analytics consumption flag. Set to "true" to indicate the NWDAF to stop sending + the notifications of analytics. Default value is "false" if omitted. + resumeFlg: + type: boolean + description: > + Resume analytics consumption flag. Set to "true" to indicate the NWDAF to resume sending + the notifications of analytics. Default value is "false" if omitted. + movBehavReqs: + type: array + items: + $ref: '#/components/schemas/MovBehavReq' + minItems: 1 + relProxReqs: + type: array + items: + $ref: '#/components/schemas/RelProxReq' + minItems: 1 + feedback: + $ref: '#/components/schemas/AnalyticsFeedbackInfo' + required: + - event + not: + - required: [excepReqs, exptAnaType] + +NnwdafEventsSubscriptionNotification: + description: Represents an Individual NWDAF Event Subscription Notification resource. + type: object + properties: + eventNotifications: + type: array + items: + $ref: '#/components/schemas/EventNotification' + minItems: 1 + description: Notifications about Individual Events + subscriptionId: + type: string + description: String identifying a subscription to the Nnwdaf_EventsSubscription Service + notifCorrId: + type: string + description: Notification correlation identifier. + oldSubscriptionId: + type: string + description: > + Subscription ID which was allocated by the source NWDAF. This parameter shall be present + if the notification is for informing the assignment of a new Subscription Id by the + target NWDAF. + resourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + termCause: + $ref: '#/components/schemas/TermCause' + transEvents: + type: array + items: + $ref: '#/components/schemas/NwdafEvent' + minItems: 1 + required: + - subscriptionId + oneOf: + +``` + +``` +- required: [eventNotifications] +- allOf: + - required: [resourceUri] + - required: [oldSubscriptionId] + +EventNotification: + description: Represents a notification on events that occurred. + type: object + properties: + event: + $ref: '#/components/schemas/Nwdafevent' + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeStampGen: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + failNotifyCode: + $ref: '#/components/schemas/NwdafeventFailureCode' + rvWaitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + anaMetaInfo: + $ref: '#/components/schemas/AnalyticsMetadataInfo' + nfLoadLevelInfos: + type: array + items: + $ref: '#/components/schemas/NfLoadLevelInformation' + minItems: 1 + nsiLoadLevelInfos: + type: array + items: + $ref: '#/components/schemas/NsiLoadLevelInfo' + minItems: 1 + pfdDetermInfos: + type: array + items: + $ref: '#/components/schemas/PfdDeterminationInfo' + minItems: 1 + sliceLoadLevelInfo: + $ref: '#/components/schemas/SliceLoadLevelInformation' + svcExps: + type: array + items: + $ref: '#/components/schemas/ServiceExperienceInfo' + minItems: 1 + qosSustainInfos: + type: array + items: + $ref: '#/components/schemas/QosSustainabilityInfo' + minItems: 1 + ueComms: + type: array + items: + $ref: '#/components/schemas/UeCommunication' + minItems: 1 + ueMobs: + type: array + items: + $ref: '#/components/schemas/UeMobility' + minItems: 1 + userDataCongInfos: + type: array + items: + $ref: '#/components/schemas/UserDataCongestionInfo' + minItems: 1 + abnorBehavrs: + type: array + items: + $ref: '#/components/schemas/AbnormalBehaviour' + minItems: 1 + nwPerfs: + type: array + items: + $ref: '#/components/schemas/NetworkPerfInfo' + minItems: 1 + dnPerfInfos: + type: array + items: +``` + +``` + $ref: '#/components/schemas/DnPerfInfo' + minItems: 1 + disperInfos: + type: array + items: + $ref: '#/components/schemas/DispersionInfo' + minItems: 1 + redTransInfos: + type: array + items: + $ref: '#/components/schemas/RedundantTransmissionExpInfo' + minItems: 1 + wlanInfos: + type: array + items: + $ref: '#/components/schemas/WlanPerformanceInfo' + minItems: 1 + smccExps: + type: array + items: + $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/SmcceInfo' + minItems: 1 + pduSesTrafInfos: + type: array + items: + $ref: '#/components/schemas/PduSesTrafficInfo' + minItems: 1 + dataVlTrnsTmInfos: + type: array + items: + $ref: '#/components/schemas/E2eDataVolTransTimeInfo' + minItems: 1 + accuInfo: + $ref: '#/components/schemas/AccuracyInfo' + cancelAccuInd: + type: boolean + description: > + Indicates cancelled subscription of the analytics accuracy information. + Set to "true" indicates the NWDAF cancelled subscription of analytics accuracy + information as the NWDAF does not support the accuracy checking capability. + Otherwise set to "false". Default value is "false" if omitted. + pauseInd: + type: boolean + description: > + Pause analytics consumption indication. Set to "true" to indicate the consumer to stop + the consumption of the analytics. Default value is "false" if omitted. + resumeInd: + type: boolean + description: > + Resume analytics consumption indication. Set to "true" to indicate the consumer to + resume the consumption of the analytics. Default value is "false" if omitted. + movBehavInfos: + type: array + items: + $ref: '#/components/schemas/MovBehavInfo' + minItems: 1 + locAccInfos: + type: array + items: + $ref: '#/components/schemas/LocAccuracyInfo' + minItems: 1 + relProxInfos: + type: array + items: + $ref: '#/components/schemas/RelProxInfo' + minItems: 1 + required: + - event + +ServiceExperienceInfo: + description: Represents service experience information. + type: object + properties: + svcExprc: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/SvcExperience' + svcExprcVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + supis: +``` + +``` + + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + srvExpctype: + $ref: '#/components/schemas/ServiceExperienceType' + ueLocs: + type: array + items: + $ref: '#/components/schemas/LocationInfo' + minItems: 1 + upfInfo: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/UpfInformation' + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + appServerInst: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + nsiId: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + ratFreq: + $ref: '#/components/schemas/RatFreqInformation' + pduSesInfo: + $ref: '#/components/schemas/PduSessionInfo' + required: + - svcExprc + +BwRequirement: + description: Represents bandwidth requirements. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + required: + - appId + +SliceLoadLevelInformation: + description: Contains load level information applicable for one or several slices. + type: object + properties: + loadLevelInformation: + $ref: '#/components/schemas/LoadLevelInformation' + snssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + description: Identification(s) of network slice to which the subscription applies. + required: + - loadLevelInformation + - snssais + +NsiLoadLevelInfo: + description: > + Represents the network slice and optionally the associated network slice instance and the + load level information. + type: object + properties: + loadLevelInformation: + +``` + +``` +$ref: '#/components/schemas/LoadLevelInformation' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +nsiId: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' +resUsage: + $ref: '#/components/schemas/ResourceUsage' +numOfExceedLoadLevelThr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +exceedLoadLevelThrInd: + type: boolean + description: > + Indicates whether the Load Level Threshold is met or exceeded by the statistics value. + Set to "true" if the Load Level Threshold is met or exceeded, otherwise set to "false". + Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to + EXCEED_LOAD_LEVEL_THR_IND. +networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' +timePeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' +resUsgThrCrossTimePeriod: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + minItems: 1 + description: > + Each element indicates the time elapsed between times each threshold is met or exceeded + or crossed. The start time and end time are the exact time stamps of the resource usage + threshold is reached or exceeded. May be present if the "listOfAnaSubsets" attribute is + provided and the maximum number of instances shall not exceed the value provided in the + "numOfExceedLoadLevelThr" attribute. +numOfUes: + $ref: '#/components/schemas/NumberAverage' +numOfPduSess: + $ref: '#/components/schemas/NumberAverage' +confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +required: +- loadLevelInformation +- snssai + +NsiIdInfo: + description: Represents the S-NSSAI and the optionally associated Network Slice Instance(s). + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + nsiIds: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' + minItems: 1 + required: + - snssai + +EventReportingRequirement: + description: Represents the type of reporting that the subscription requires. + type: object + properties: + accuracy: + $ref: '#/components/schemas/Accuracy' + accPerSubset: + type: array + items: + $ref: '#/components/schemas/Accuracy' + minItems: 1 + description: > + Each element indicates the preferred accuracy level per analytics subset. It may be + present if the "listOfAnaSubsets" attribute is present in the subscription request. + startTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + offsetPeriod: + type: integer + description: > + Offset period in units of seconds to the reporting time, if the value is negative means + statistics in the past offset period, otherwise a positive value means prediction in the +``` + +``` + future offset period. May be present if the "repPeriod" attribute is included within the + "evtReq" attribute or the "repetitionPeriod" attribute is included within the + EventSubscription type. + sampRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + maxObjectNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + maxSupiNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + timeAnaNeeded: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + anaMeta: + type: array + items: + $ref: '#/components/schemas/AnalyticsMetadata' + minItems: 1 + anaMetaInd: + $ref: '#/components/schemas/AnalyticsMetadataIndication' + histAnaTimePeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + +TargetUeInformation: + description: Identifies the target UE information. + type: object + properties: + anyUe: + type: boolean + description: > + Identifies any UE when setting to "true". Default value is "false" if omitted. + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + intGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + +UeMobility: + description: Represents UE mobility information. + type: object + properties: + ts: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + recurringTime: + $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime' + duration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + durationVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + locInfos: + type: array + items: + $ref: '#/components/schemas/LocationInfo' + minItems: 1 + directionInfos: + type: array + items: + $ref: '#/components/schemas/DirectionInfo' + minItems: 1 + allOf: + - required: [duration] + - required: [locInfos] + - oneOf: + - required: [ts] + - required: [recurringTime] + +LocationInfo: + description: Represents UE location information. + type: object + properties: +``` + +``` +loc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' +geoLoc: + $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' +ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' +confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +geoDistrInfos: + type: array + items: + $ref: '#/components/schemas/GeoDistributionInfo' + minItems: 1 +distThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +required: +- loc + +DirectionInfo: +description: Represents the UE direction information. +type: object +properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + numOfUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + avrSpeed: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + direction: + $ref: '#/components/schemas/Direction' +required: +- direction +oneOf: +- required: [supi] +- required: [gpsi] + +GeoDistributionInfo: +description: Represents the geographical distribution of the UEs. +type: object +properties: + loc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 +required: +- loc +oneOf: +- required: [supis] +- required: [gpsis] + +UeCommunication: +description: Represents UE communication information. +type: object +properties: + commDur: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + commDurVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + perioTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + perioTimeVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + ts: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tsVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' +``` + +``` + +recurringTime: + $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime' +trafChar: + $ref: '#/components/schemas/TrafficCharacterization' +ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' +perioCommInd: + type: boolean + description: > + This attribute indicates whether the UE communicates periodically or not. Set to "true" + to indicate the UE communicates periodically, otherwise set to "false" or omitted. +confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +anaOfAppList: + $ref: '#/components/schemas/AppListForUeComm' +sessInactTimer: + $ref: '#/components/schemas/SessInactTimerForUeComm' +allOf: +- required: [commDur] +- required: [trafChar] +- oneOf: + - required: [ts] + - required: [recurringTime] +TrafficCharacterization: + description: Identifies the detailed traffic characterization. + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + fDescs: + type: array + items: + $ref: '#/components/schemas/IpEthFlowDescription' + minItems: 1 + maxItems: 2 + ulVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + ulVolVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + dlVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + dlVolVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + anyOf: + - required: [ulVol] + - required: [dlVol] +UserDataCongestionInfo: + description: Represents the user data congestion information. + type: object + properties: + networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + congestionInfo: + $ref: '#/components/schemas/CongestionInfo' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - networkArea + - congestionInfo +CongestionInfo: + description: Represents the congestion information. + type: object + properties: + congType: + $ref: '#/components/schemas/CongestionType' + timeIntev: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + nsi: + $ref: '#/components/schemas/ThresholdLevel' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + topAppListUl: + +``` + +``` + type: array + items: + $ref: '#/components/schemas/TopApplication' + minItems: 1 + topAppListDl: + type: array + items: + $ref: '#/components/schemas/TopApplication' + minItems: 1 + required: + - congType + - timeIntev + - nsi + + TopApplication: + description: Top application that contributes the most to the traffic. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ipTrafficFilter: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + oneOf: + - required: [appId] + - required: [ipTrafficFilter] + + QosSustainabilityInfo: + description: Represents the QoS Sustainability information. + type: object + properties: + areaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + fineAreaInfos: + type: array + items: + $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' + minItems: 1 + description: > + This attribute contains the geographical locations in a fine granularity. + + startTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + qosFlowRetThd: + $ref: '#/components/schemas/RetainabilityThreshold' + ranUeThrouThd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + oneOf: + - required: [qosFlowRetThd] + - required: [ranUeThrouThd] + + QosRequirement: + description: Represents the QoS requirements. + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + gfbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + gfbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + resType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/QosResourceType' + pdb: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + per: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + deviceSpeed: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + deviceType: + $ref: '#/components/schemas/DeviceType' + oneOf: +``` + +``` +- required: [5qi] +- required: [resType] + +ThresholdLevel: + description: Represents a threshold level. + type: object + properties: + congLevel: + type: integer + nfLoadLevel: + type: integer + nfCpuUsage: + type: integer + nfMemoryUsage: + type: integer + nfStorageUsage: + type: integer + avgTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + aggTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + varTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + maxPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + varPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgPacketLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + maxPacketLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + varPacketLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + svcExpLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + speed: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + +NfLoadLevelInformation: + description: Represents load level information of a given NF instance. + type: object + properties: + nfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + nfStatus: + $ref: '#/components/schemas/NfStatus' + nfCpuUsage: + type: integer + nfMemoryUsage: + type: integer + nfStorageUsage: + type: integer + nfLoadLevelAverage: + type: integer + nfLoadLevelpeak: + type: integer + nfLoadAvgInAoi: + type: integer + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + allOf: + - required: [nfType] + - required: [nfInstanceId] + - anyOf: + - required: [nfStatus] + - required: [nfCpuUsage] +``` + +``` + - required: [nfMemoryUsage] + - required: [nfStorageUsage] + - required: [nfLoadLevelAverage] + - required: [nfLoadLevelPeak] + +NfStatus: + description: Contains the percentage of time spent on various NF states. + type: object + properties: + statusRegistered: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + statusUnregistered: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + statusUndiscoverable: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + anyOf: + - required: [statusRegistered] + - required: [statusUnregistered] + - required: [statusUndiscoverable] + +AnySlice: + type: boolean + description: > + "false" represents not applicable for all slices. "true" represents applicable for all +slices. + +LoadLevelInformation: + type: integer + description: > + Load level information of the network slice and the optionally associated network slice +instance. + +AbnormalBehaviour: + description: Represents the abnormal behaviour information. + type: object + properties: + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + excep: + $ref: '#/components/schemas/Exception' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + addtMeasInfo: + $ref: '#/components/schemas/AdditionalMeasurement' + required: + - excep + +Exception: + description: Represents the Exception information. + type: object + properties: + excepId: + $ref: '#/components/schemas/ExceptionId' + excepLevel: + type: integer + excepTrend: + $ref: '#/components/schemas/ExceptionTrend' + required: + - excepId + +AdditionalMeasurement: + description: Represents additional measurement information. + type: object + properties: + unexpLoc: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + unexpFlowTeps: + type: array + items: +``` + +``` + $ref: '#/components/schemas/IpEthFlowDescription' + minItems: 1 + unexpWakes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minItems: 1 + ddosAttack: + $ref: '#/components/schemas/AddressList' + wrgDest: + $ref: '#/components/schemas/AddressList' + circums: + type: array + items: + $ref: '#/components/schemas/CircumstanceDescription' + minItems: 1 + +IpEthFlowDescription: + description: Contains the description of an Uplink and/or Downlink Ethernet flow. + type: object + properties: + ipTrafficFilter: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + ethTrafficFilter: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + oneOf: + - required: [ipTrafficFilter] + - required: [ethTrafficFilter] + +AddressList: + description: Represents a list of IPv4 and/or IPv6 addresses. + type: object + properties: + ipv4Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + +CircumstanceDescription: + description: Contains the description of a circumstance. + type: object + properties: + freq: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + tm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + locArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + vol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + +RetainabilityThreshold: + description: Represents a QoS flow retainability threshold. + type: object + properties: + relFlowNum: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + relTimeUnit: + $ref: '#/components/schemas/TimeUnit' + relFlowRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + oneOf: + - allOf: + - required: [relFlowNum] + - required: [relTimeUnit] + - required: [relFlowRatio] + +NetworkPerfRequirement: + description: Represents a network performance requirement. + type: object + properties: + nwPerfType: +``` + +``` + $ref: '#/components/schemas/NetworkPerfType' + relativeRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + absoluteNum: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + orderCriterion: + $ref: '#/components/schemas/NetworkPerfOrderCriterion' + rscUsgReq: + $ref: '#/components/schemas/ResourceUsageRequirement' + required: + - nwPerfType + not: + - required: [relativeRatio, absoluteNum] + +NetworkPerfInfo: + description: Represents the network performance information. + type: object + properties: + networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + nwPerfType: + $ref: '#/components/schemas/NetworkPerfType' + anaPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + relativeRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + absoluteNum: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + rscUsgReq: + $ref: '#/components/schemas/ResourceUsageRequirement' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + allOf: + - required: [networkArea] + - required: [nwPerfType] + - oneOf: + - required: [relativeRatio] + - required: [absoluteNum] + +FailureEventInfo: + description: Contains information on the event for which the subscription is not successful. + type: object + properties: + event: + $ref: '#/components/schemas/NwdafEvent' + failureCode: + $ref: '#/components/schemas/NwdafFailureCode' + required: + - event + - failureCode + +AnalyticsMetadataIndication: + description: > + Contains analytics metadata information requested to be used during analytics generation. + type: object + properties: + dataWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dataStatProps: + type: array + items: + $ref: '#/components/schemas/DatasetStatisticalProperty' + minItems: 1 + strategy: + $ref: '#/components/schemas/OutputStrategy' + aggrNwdaIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + +AnalyticsMetadataInfo: + description: Contains analytics metadata information required for analytics aggregation. + type: object + properties: + numSamples: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + dataWindow: +``` + +``` +$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' +dataStatProps: + type: array + items: + $ref: '#/components/schemas/DatasetStatisticalProperty' + minItems: 1 + strategy: + $ref: '#/components/schemas/OutputStrategy' + accuracy: + $ref: '#/components/schemas/Accuracy' +NumberAverage: + description: Represents average and variance information. + type: object + properties: + number: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + variance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + skewness: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + required: + - number + - variance + +AnalyticsSubscriptionsTransfer: + description: Contains information about a request to transfer analytics subscriptions. + type: object + properties: + subsTransInfos: + type: array + items: + $ref: '#/components/schemas/SubscriptionTransferInfo' + minItems: 1 + failTransEventReports: + type: array + items: + $ref: '#/components/schemas/NwdafEvent' + minItems: 1 + required: + - subsTransInfos + +SubscriptionTransferInfo: + description: Contains information about subscriptions that are requested to be transferred. + type: object + properties: + transReqType: + $ref: '#/components/schemas/TransferRequestType' + nwdafEvSub: + $ref: '#/components/schemas/NnwdafEventsSubscription' + consumerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + contextId: + $ref: '#/components/schemas/AnalyticsContextIdentifier' + sourceNfIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + sourceSetIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + modelInfo: + type: array + items: + $ref: '#/components/schemas/ModelInfo' + minItems: 1 + required: + - transReqType + - nwdafEvSub + - consumerId + +ModelInfo: + description: Contains information about an ML model. + type: object + properties: + analyticsId: +``` + +``` + + $ref: '#/components/schemas/NwdafEvent' + mlModelInfos: + type: array + items: + $ref: '#/components/schemas/MLModelInfo' + minItems: 1 + required: + - analyticsId + - mlModelInfos +MLModelInfo: + description: Contains information about an ML models. + type: object + properties: + mlFileAddrs: + type: array + items: + $ref: 'TS29520_Nnwdaf_MLModelProvision.yaml#/components/schemas/MLModelAddr' + minItems: 1 + modelProvId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + modelProvSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + oneOf: + - required: [modelProvId] + - required: [modelProvSetId] + +AnalyticsContextIdentifier: + description: Contains information about available analytics contexts. + type: object + properties: + subscriptionId: + type: string + description: The identifier of a subscription. + nfAnaCtxts: + type: array + items: + $ref: '#/components/schemas/NwdafEvent' + minItems: 1 + description: > + List of analytics types for which NF related analytics contexts can be retrieved. + ueAnaCtxts: + type: array + items: + $ref: '#/components/schemas/UeAnalyticsContextDescriptor' + minItems: 1 + description: > + List of objects that indicate for which SUPI and analytics types combinations analytics + context can be retrieved. + allOf: + - anyOf: + - required: [nfAnaCtxts] + - required: [ueAnaCtxts] + - required: [subscriptionId] + +UeAnalyticsContextDescriptor: + description: Contains information about available UE related analytics contexts. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + anaTypes: + type: array + items: + $ref: '#/components/schemas/NwdafEvent' + minItems: 1 + description: > + List of analytics types for which UE related analytics contexts can be retrieved. + required: + - supi + - anaTypes + +DnPerfInfo: + description: Represents DN performance information. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + dnn: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +dnPerf: + type: array + items: + $ref: '#/components/schemas/DnPerf' + minItems: 1 + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + required: + - dnPerf + +DnPerf: + description: Represents DN performance for the application. + type: object + properties: + appServerInsAddr: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' + upfInfo: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/UpfInformation' + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + perfData: + $ref: '#/components/schemas/PerfData' + spatialValidCon: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + temporalValidCon: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + required: + - perfData + +PerfData: + description: Represents DN performance data. + type: object + properties: + avgTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + aggTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + varTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + trafRateUeIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + avePacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + maxPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + varPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + packDelayUeIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + avgPacketLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + maxPacketLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + varPacketLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + packLossUeIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + numOfUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +DispersionRequirement: + description: Represents the dispersion analytics requirements. +``` + +``` +type: object +properties: + disperType: + $ref: '#/components/schemas/DispersionType' + classCriters: + type: array + items: + $ref: '#/components/schemas/ClassCriterion' + minItems: 1 + rankCriters: + type: array + items: + $ref: '#/components/schemas/RankingCriterion' + minItems: 1 + dispOrderCriter: + $ref: '#/components/schemas/DispersionOrderingCriterion' + order: + $ref: '#/components/schemas/MatchingDirection' +required: +- disperType + +ClassCriterion: +description: > + Indicates the dispersion class criterion for fixed, camper and/or traveller UE, and/or the + top-heavy UE dispersion class criterion. +type: object +properties: + disperClass: + $ref: '#/components/schemas/DispersionClass' + classThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + thresMatch: + $ref: '#/components/schemas/MatchingDirection' +required: +- disperClass +- classThreshold +- thresMatch + +RankingCriterion: +description: Indicates the usage ranking criterion between the high, medium and low usage UE. +type: object +properties: + highBase: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + lowBase: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' +required: +- highBase +- lowBase + +DispersionInfo: +description: > + Represents the Dispersion information. When subscribed event is "DISPERSION", the + "disperInfos" attribute shall be included. +type: object +properties: + tsStart: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tsDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + disperCollects: + type: array + items: + $ref: '#/components/schemas/DispersionCollection' + minItems: 1 + disperType: + $ref: '#/components/schemas/DispersionType' +required: +- tsStart +- tsDuration +- disperCollects +- disperType + +DispersionCollection: +description: Dispersion collection per UE location or per slice. +type: object +properties: + ueLoc: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + appVolumes: + type: array + items: + $ref: '#/components/schemas/ApplicationVolume' + minItems: 1 + disperAmount: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + disperClass: + $ref: '#/components/schemas/DispersionClass' + usageRank: + type: integer + description: Integer where the allowed values correspond to 1, 2, 3 only. + minimum: 1 + maximum: 3 + percentileRank: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + ueRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + allOf: + - oneOf: + - required: [ueLoc] + - required: [snssai] + - anyOf: + - required: [disperAmount] + - required: [disperClass] + - required: [usageRank] + - required: [percentileRank] + +ApplicationVolume: + description: Application data volume per Application Id. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + appVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + required: + - appId + - appVolume + +RedundantTransmissionExpReq: + description: Represents other redundant transmission experience analytics requirements. + type: object + properties: + redTOrderCriter: + $ref: '#/components/schemas/RedTransExpOrderingCriterion' + order: + $ref: '#/components/schemas/MatchingDirection' + +RedundantTransmissionExpInfo: + description: > + The redundant transmission experience related information. When subscribed event is + "RED_TRANS_EXP", the "redTransInfos" attribute shall be included. + type: object + properties: + spatialValidCon: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + redTransExps: + type: array + items: + $ref: '#/components/schemas/RedundantTransmissionExpPerTS' + +``` + +``` + + minItems: 1 + required: + - redTransExps + +RedundantTransmissionExpPerTS: + description: The redundant transmission experience per Time Slot. + type: object + properties: + tsStart: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tsDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + obsvRedTransExp: + $ref: '#/components/schemas/ObservedRedundantTransExp' + redTransStatus: + type: boolean + description: > + Redundant Transmission Status. Set to "true" if redundant transmission was activated, + otherwise set to "false". Default value is "false" if omitted. + ueRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + required: + - tsStart + - tsDuration + - obsvRedTransExp + +ObservedRedundantTransExp: + description: Represents the observed redundant transmission experience related information. + type: object + properties: + avgPktDropRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + varPktDropRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgPktDropRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + varPktDropRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgPktDelayUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + varPktDelayUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgPktDelayDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + varPktDelayDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgE2ePktDelayUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + varE2ePktDelayUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgE2ePktDelayDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + varE2ePktDelayDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgE2ePktLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + varE2ePktLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgE2ePktLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + varE2ePktLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + +WlanPerformanceReq: + description: Represents other WLAN performance analytics requirements. + type: object + properties: + ssIds: + type: array + items: + type: string + minItems: 1 + bssIds: + type: array + items: + type: string + minItems: 1 + +``` + +``` +wlanOrderCriter: + $ref: '#/components/schemas/WlanOrderingCriterion' +order: + $ref: '#/components/schemas/MatchingDirection' + +WlanPerformanceInfo: + description: The WLAN performance related information. + type: object + properties: + networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + wlanPerSsidInfos: + type: array + items: + $ref: '#/components/schemas/WlanPerSsidPerformanceInfo' + minItems: 1 + wlanPerUeIdInfos: + type: array + items: + $ref: '#/components/schemas/WlanPerUeIdPerformanceInfo' + minItems: 1 + description: > + WLAN performance information for UE Id(s) of WLAN access points deployed in the Area + of Interest. + required: + - wlanPerSsidInfos + +WlanPerSsidPerformanceInfo: + description: The WLAN performance per SSID. + type: object + properties: + ssid: + type: string + wlanPerTsInfos: + type: array + items: + $ref: '#/components/schemas/WlanPerTsPerformanceInfo' + minItems: 1 + required: + - ssid + - wlanPerTsInfos + +WlanPerUeIdPerformanceInfo: + description: The WLAN performance per UE ID. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + wlanPerTsInfos: + type: array + items: + $ref: '#/components/schemas/WlanPerTsPerformanceInfo' + minItems: 1 + description: > + WLAN performance information per Time Slot during the analytics target period. + required: + - supi + - wlanPerTsInfos + +WlanPerTsPerformanceInfo: + description: WLAN performance information per Time Slot during the analytics target period. + type: object + properties: + tsStart: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tsDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + rssi: + type: integer + rtt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + trafficInfo: + $ref: '#/components/schemas/TrafficInformation' + numberOfUes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + required: +``` + +``` +- tsStart +- tsDuration +anyOf: +- required: [rssi] +- required: [rtt] +- required: [trafficInfo] +- required: [numberOfUes] + +TrafficInformation: +description: Traffic information including UL/DL data rate and/or Traffic volume. +type: object +properties: + uplinkRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + downlinkRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + uplinkVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + downlinkVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + totalVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' +anyOf: +- required: [uplinkRate] +- required: [downlinkRate] +- required: [uplinkVolume] +- required: [downlinkVolume] +- required: [totalVolume] + +AppListForUeComm: +description: Represents the analytics of the application list used by UE. +type: object +properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + appDur: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + occurRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + spatialValidity: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' +required: +- appId + +SessInactTimerForUeComm: +description: Represents the N4 Session inactivity timer. +type: object +properties: + n4SessId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + sessInactiveTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +required: +- n4SessId +- sessInactiveTimer + +DnPerformanceReq: +description: Represents other DN performance analytics requirements. +type: object +properties: + dnPerfOrderCriter: + $ref: '#/components/schemas/DnPerfOrderingCriterion' + order: + $ref: '#/components/schemas/MatchingDirection' + reportThresholds: + type: array + items: + $ref: '#/components/schemas/ThresholdLevel' + minItems: 1 + +RatFreqInformation: +description: Represents the RAT type and/or Frequency information. +type: object +properties: + allFreq: + type: boolean +``` + +``` + description: > + Set to "true" to indicate to handle all the frequencies the NWDAF received, otherwise + set to "false" or omit. The "allFreq" attribute and the "freq" attribute are mutually + exclusive. + allRat: + type: boolean + description: > + Set to "true" to indicate to handle all the RAT Types the NWDAF received, otherwise + set to "false" or omit. The "allRat" attribute and the "ratType" attribute are mutually + exclusive. + freq: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ArfcnValueNR' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + svcExpThreshold: + $ref: '#/components/schemas/ThresholdLevel' + matchingDir: + $ref: '#/components/schemas/MatchingDirection' + +PrevSubInfo: + description: Information of the previous subscription. + type: object + properties: + producerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + producerSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + subscriptionId: + type: string + description: The identifier of a subscription. + nfAnaEvents: + type: array + items: + $ref: '#/components/schemas/NwdafEvent' + minItems: 1 + ueAnaEvents: + type: array + items: + $ref: '#/components/schemas/UeAnalyticsContextDescriptor' + minItems: 1 + required: + - subscriptionId + oneOf: + - required: [producerId] + - required: [producerSetId] + +ResourceUsage: + description: > + The current usage of the virtual resources assigned to the NF instances belonging to a + particular network slice instance. + type: object + properties: + cpuUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + memoryUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + storageUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +ConsumerNfInformation: + description: Represents the analytics consumer NF Information. + type: object + properties: + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + oneOf: + - oneOf: + - required: [nfId] + - required: [nfSetId] + - required: [taiList] +``` + +``` +UeCommReq: + description: UE communication analytics requirement. + type: object + properties: + orderCriterion: + $ref: '#/components/schemas/UeCommOrderCriterion' + orderDirection: + $ref: '#/components/schemas/MatchingDirection' +UeMobilityReq: + description: UE mobility analytics requirement. + type: object + properties: + orderCriterion: + $ref: '#/components/schemas/UeMobilityOrderCriterion' + orderDirection: + $ref: '#/components/schemas/MatchingDirection' + ueLocOrderInd: + type: boolean + description: > + UE Location order indication. Set to "true" to indicate the NWDAF to provide UE + locations in the UE Mobility analytics in time order, otherwise set to "false" or + omitted. + distThresholds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 + description: Indicates the linear distance threshold. + +PduSessionInfo: + description: Represents combination of PDU Session parameter(s) information. + type: object + properties: + pduSessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + sscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScsMode' + accessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + +PfdDeterminationInfo: + description: Represents the PFD Determination information for a known application identifier. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + flowDescriptions: + type: array + items: + type: string + minItems: 1 + description: > + Represents a 3-tuple with protocol, server ip and server port for UL/DL + application traffic. The content of the string has the same encoding as the IPFilterRule + AVP value as defined in IETF RFC 6733. + urls: + type: array + items: + type: string + minItems: 1 + description: Represents the significant parts of the URL to be matched, e.g. host name. + domainNames: + type: array + items: + type: string + minItems: 1 + description: Represents Domain name matching criteria. + dnProtocol: + $ref: 'TS29122_PfdManagement.yaml#/components/schemas/DomainNameProtocol' + pfdConfidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +``` + +``` +required: + - appId + +PduSesTrafficInfo: + description: Represents the PDU Set traffic analytics information. + type: object + properties: + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + tdMatchTrafes: + type: array + items: + $ref: '#/components/schemas/TdTraffic' + minItems: 1 + tdUnmatchTrafes: + type: array + items: + $ref: '#/components/schemas/TdTraffic' + minItems: 1 + allOf: + - anyOf: + - required: [dnn] + - required: [snssai] + - anyOf: + - required: [tdMatchTrafes] + - required: [tdUnmatchTrafes] + +TdTraffic: + description: Represents traffic that matches or unmatches Traffic Descriptor of URSP rule. + type: object + properties: + pduSesTrafReqs: + type: array + items: + $ref: '#/components/schemas/PduSesTrafficReq' + minItems: 1 + ulVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + dlVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + allVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + ulNumOfPkt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + dlNumOfPkt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + allNumOfPkt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +PduSesTrafficReq: + description: Represents the PDU Session traffic analytics requirements. + type: object + properties: + flowDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + description: > + Indicates traffic flow filtering description(s) for IP flow(s). + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + domainDescs: + type: array + items: + type: string + minItems: 1 + description: > + FQDN(s) or a regular expression which are used as a domain name matching criteria. + oneOf: + - required: [flowDescs] +``` + +``` +- required: [appId] +- required: [domainDescs] + +ResourceUsageRequirement: + description: resource usage requirement. + type: object + properties: + tfcDir: + $ref: '#/components/schemas/TrafficDirection' + valExp: + $ref: '#/components/schemas/ValueExpression' + +E2eDataVolTransTimeReq: + description: Represents other E2E data volume transfer time analytics requirements. + type: object + properties: + criterion: + $ref: '#/components/schemas/E2eDataVolTransTimeCriterion' + order: + $ref: '#/components/schemas/MatchingDirection' + highTransTmThr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + lowTransTmThr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + repeatDataTrans: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + tsIntervalDataTrans: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + dataVolume: + $ref: '#/components/schemas/DataVolume' + maxNumberUes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + oneOf: + - required: [repeatDataTrans] + - required: [tsIntervalDataTrans] + +DataVolume: + description: Data Volume including UL/DL. + type: object + properties: + uplinkVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + downlinkVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + anyOf: + - required: [uplinkVolume] + - required: [downlinkVolume] + +E2eDataVolTransTimeInfo: + description: > + Represents the E2E data volume transfer time analytics information when subscribed event is + "E2E_DATA_VOL_TRANS_TIME", the "dataVlTrnsTmInfos" attribute shall be included. + type: object + properties: + e2eDataVolTransTimes: + type: array + items: + $ref: '#/components/schemas/E2eDataVolTransTimePerTS' + minItems: 1 + e2eDataVolTransTimeUeLists: + type: array + items: + $ref: '#/components/schemas/E2eDataVolTransTimeUeList' + minItems: 1 + geoDistrInfos: + type: array + items: + $ref: '#/components/schemas/GeoDistributionInfo' + minItems: 1 + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + required: + - e2eDataVolTransTimes + +E2eDataVolTransTimePerTS: + description: Represents the E2E data volume transfer time analytics per Time Slot. + type: object + properties: +``` + +``` + +tsStart: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +tsDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +e2eDataVolTransTimePerUe: + type: array + items: + $ref: '#/components/schemas/E2eDataVolTransTimePerUe' + minItems: 1 +required: +- tsStart +- tsDuration +- e2eDataVolTransTimePerUe + +E2eDataVolTransTimePerUe: + description: Represents the E2E data volume transfer time per UE. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ueLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + spatialValidity: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + validityPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dataVolTransTime: + $ref: '#/components/schemas/DataVolumeTransferTime' + oneOf: + - required: [ueLoc] + - required: [snssai] + +E2eDataVolTransTimeUeList: + description: > + Contains the list of UEs classified based on experience level of E2E Data Volume Transfer + Time + properties: + highLevel: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + mediumLevel: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + lowLevel: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + lowRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + mediumRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + highRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + spatialValidity: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + validityPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + anyOf: + - required: [highLevel] + - required: [mediumLevel] + - required: [lowLevel] + +DataVolumeTransferTime: + +``` + +``` +description: > + Indicates the E2E data volume transfer time and the data volume used to derive the transfer + time. +properties: + uplinkVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + avgTransTimeUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + varTransTimeUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + downlinkVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + avgTransTimeDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + varTransTimeDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + +GeoLocation: + description: > + Represents a horizontal and optionally vertical location using either geographic + or local coordinates. + type: object + properties: + point: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Point' + pointAlt: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PointAltitude' + refPoint: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocalOrigin' + localCoords: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RelativeCartesianLocation' + anyOf: + - required: [point] + - required: [pointAlt] + - allOf: + - required: [refPoint] + - required: [localCoords] + +GeoAccuracyReq: + description: > + Contains location accuracy analytics requirements. + type: object + properties: + accThres: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + accThresMatchDir: + $ref: '#/components/schemas/MatchingDirection' + inOutThres: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + inOutThresMatchDir: + $ref: '#/components/schemas/MatchingDirection' + posMethod: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethod' + +GeoAccuracyInfo: + description: > + Contains location accuracy analytics. + type: object + properties: + locAccPerMeths: + type: array + items: + $ref: '#/components/schemas/LocAccuracyPerMethod' + minItems: 1 + description: Location accuracy information per positioning method. + inOutUePct: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + inOutInd: + type: boolean + description: Indicates if the target location is indoors or outdoors. + required: + - locAccPerMeths + not: + required: [inOutUePct, inOutInd] + +LocAccuracyPerMethod: + description: > + Contains location accuracy analytics per positioning method. +``` + +``` +type: object +properties: + posMethod: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethod' + locAcc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + losNlosPercent: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + required: + - posMethod + - locAcc +AccuracyReq: + description: Represents the analytics accuracy requirement information. + type: object + properties: + accuTimeWin: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + accuPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + accuDevThr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minNum: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + updatedAnaFlg: + type: boolean + description: > + Indicates the updated Analytics flag. Set to "true" indicates that the NWDAF can provide + the updated analytics if the analytics can be generated within the analytics accuracy + information time window, which is specified by "accuTimeWin" attribute. + Otherwise set to "false". Default value is "false" if omitted. + correctionInterval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +AccuracyInfo: + description: The analytics accuracy information. + type: object + properties: + accuracyVal: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + accuSampleNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + + anaAccuInd: + $ref: '#/components/schemas/AnalyticsAccuracyIndication' + +MovBehavReq: + description: Represents the Movement Behaviour analytics requirements. + properties: + locationGranReq: + $ref: '#/components/schemas/LocInfoGranularity' + reportThresholds: + $ref: '#/components/schemas/ThresholdLevel' + +MovBehavInfo: + description: Represents the Movement Behaviour information. + properties: + geoLoc: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicalCoordinates' + movBehavs: + type: array + items: + $ref: '#/components/schemas/MovBehav' + minItems: 1 + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +MovBehav: + description: Represents the Movement Behaviour information per time slot. + properties: + tsStart: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tsDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + numOfUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + avrSpeed: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Float' +speedThresdInfos: + type: array + items: + $ref: '#/components/schemas/SpeedThresholdInfo' + minItems: 1 +directionUeInfos: + type: array + items: + $ref: '#/components/schemas/DirectionInfo' + minItems: 1 +required: +- tsStart +- tsDuration + +SpeedThresholdInfo: + description: UEs information whose speed is faster than the speed threshold. + properties: + numOfUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + +RelProxReq: + description: Represents the Relative Proximity analytics requirements. + properties: + direction: + type: array + items: + $ref: '#/components/schemas/Direction' + minItems: 1 + numOfUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + proximityCrits: + type: array + items: + $ref: '#/components/schemas/ProximityCriterion' + minItems: 1 + +RelProxInfo: + description: Represents the Relative Proximity information. + properties: + tsStart: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tsDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + ueProximities: + type: array + items: + $ref: '#/components/schemas/UeProximity' + minItems: 1 + ttcInfo: + $ref: '#/components/schemas/TimeToCollisionInfo' + required: + - tsStart + - tsDuration + - ueProximities + +UeProximity: + description: Represents the Observed or Predicted proximity information. + properties: + ueDistance: + type: integer + ueVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + avrSpeed: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + locOrientation: +``` + +``` +$ref: '#/components/schemas/LocationOrientation' +ueTrajectories: + type: array + items: + $ref: '#/components/schemas/UeTrajectory' + minItems: 1 +ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + +UeTrajectory: + description: Represents timestamped UE positions. + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + timestampedLocs: + type: array + items: + $ref: '#/components/schemas/TimestampedLocation' + minItems: 1 + required: + - timestampedLocs + oneOf: + - required: [supi] + - required: [gpsI] + +TimestampedLocation: + description: The timestamped locations of the trajectory of the UE. + properties: + ts: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + locInfo: + items: + $ref: '#/components/schemas/LocationInfo' + required: + - ts + - locInfo + +TimeToCollisionInfo: + description: Represents Time To Collision (TTC) information. + properties: + ttc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + accuracy: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +AnalyticsFeedbackInfo: + description: Analytics feedback information. + properties: + actionTimes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minItems: 1 + description: The times at which an action was taken. + usedAnaTypes: + type: array + items: + $ref: '#/components/schemas/NwdaEvent' + minItems: 1 + description: The analytics types that were used to take the action. + impactInd: + type: boolean + description: Indication about the impact of an action on the ground truth data. + required: + - actionTimes + +RoamingInfo: + description: Information related to roaming analytics. + type: object + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + aois: + type: array +``` + +``` +items: + $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' +minItems: 1 +description: Areas of Interest in the HPLMN or the VPLMN. +servingNFIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + description: NF ID(s) of the NF(s) serving the roaming UE(s) in the VPLMN. +servingNFSetIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + description: NF Set ID(s) of the NF Set(s) serving the roaming UE(s) in the VPLMN. +``` + +``` +# +# +# +``` + +#### ENUMERATIONS DATA TYPES + +##### NotificationMethod: + +``` +anyOf: +- type: string + enum: + - PERIODIC + - THRESHOLD +- type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +description: | + Represents the notification methods for the subscribed events. + Possible values are: + - PERIODIC: The notification of the subscribed NWDAF Event is periodical. The period + between the notifications is identified by repetitionPeriod and represents time in + seconds. + - THRESHOLD: The subscribe of NWDAF Event is upon threshold exceeded. +``` + +##### NwdafEvent: + +``` +anyOf: +- type: string + enum: + - SLICE_LOAD_LEVEL + - NETWORK_PERFORMANCE + - NF_LOAD + - SERVICE_EXPERIENCE + - UE_MOBILITY + - UE_COMMUNICATION + - QOS_SUSTAINABILITY + - ABNORMAL_BEHAVIOUR + - USER_DATA_CONGESTION + - NSI_LOAD_LEVEL + - DN_PERFORMANCE + - DISPERSION + - RED_TRANS_EXP + - WLAN_PERFORMANCE + - SM_CONGESTION + - PFD_DETERMINATION + - PDU_SESSION_TRAFFIC + - E2E_DATA_VOL_TRANS_TIME + - MOVEMENT_BEHAVIOUR + - NUM_OF_UE + - MOV_UE_RATIO + - AVR_SPEED + - SPEED_THRESHOLD + - MOV_UE_DIRECTION + - LOC_ACCURACY + - RELATIVE_PROXIMITY +- type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +description: | + Describes the NWDAF Events. + Possible values are: + - SLICE_LOAD_LEVEL: Indicates that the event subscribed is load level information of Network +``` + +- Slice. +- NETWORK\_PERFORMANCE: Indicates that the event subscribed is network performance information. + - NF\_LOAD: Indicates that the event subscribed is load level and status of one or several Network Functions. + - SERVICE\_EXPERIENCE: Indicates that the event subscribed is service experience. + - UE\_MOBILITY: Indicates that the event subscribed is UE mobility information. + - UE\_COMMUNICATION: Indicates that the event subscribed is UE communication information. + - QOS\_SUSTAINABILITY: Indicates that the event subscribed is QoS sustainability. + - ABNORMAL\_BEHAVIOUR: Indicates that the event subscribed is abnormal behaviour. + - USER\_DATA\_CONGESTION: Indicates that the event subscribed is user data congestion information. + - NSI\_LOAD\_LEVEL: Indicates that the event subscribed is load level information of Network Slice and the optionally associated Network Slice Instance. + - DN\_PERFORMANCE: Indicates that the event subscribed is DN performance information. + - DISPERSION: Indicates that the event subscribed is dispersion information. + - RED\_TRANS\_EXP: Indicates that the event subscribed is redundant transmission experience. + - WLAN\_PERFORMANCE: Indicates that the event subscribed is WLAN performance. + - SM\_CONGESTION: Indicates the Session Management Congestion Control Experience information for specific DNN and/or S-NSSAI. + - PFD\_DETERMINATION: Indicates that the event subscribed is the PFD Determination information for known application identifier(s). + - PDU\_SESSION\_TRAFFIC: Indicates that the event subscribed is the PDU Session traffic information. + - E2E\_DATA\_VOL\_TRANS\_TIME: Indicates that the event subscribed is of E2E data volume transfer time. + - MOVEMENT\_BEHAVIOUR: Indicates that the event subscribed is the Movement Behaviour information. + - LOC\_ACCURACY: Indicates that the event subscribed is of location accuracy. + - RELATIVE\_PROXIMITY: Indicates that the event subscribed is the Relative Proximity information. + +Accuracy: + +- anyOf: +- type: string +enum: + - LOW + - MEDIUM + - HIGH + - HIGHEST + - type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + - description: | +Represents the preferred level of accuracy of the analytics. +Possible values are: + - LOW: Low accuracy. + - MEDIUM: Medium accuracy. + - HIGH: High accuracy. + - HIGHEST: Highest accuracy. + +CongestionType: + +- anyOf: +- type: string +enum: + - USER\_PLANE + - CONTROL\_PLANE + - USER\_AND\_CONTROL\_PLANE + - type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + - description: | +Indicates the congestion analytics type. +Possible values are: + - USER\_PLANE: The congestion analytics type is User Plane. + - CONTROL\_PLANE: The congestion analytics type is Control Plane. + - USER\_AND\_CONTROL\_PLANE: The congestion analytics type is User Plane and Control Plane. + +ExceptionId: + +- anyOf: +- type: string +enum: + - UNEXPECTED\_UE\_LOCATION + +- UNEXPECTED\_LONG\_LIVE\_FLOW +- UNEXPECTED\_LARGE\_RATE\_FLOW +- UNEXPECTED\_WAKEUP +- SUSPICION\_OF\_DDOS\_ATTACK +- WRONG\_DESTINATION\_ADDRESS +- TOO\_FREQUENT\_SERVICE\_ACCESS +- UNEXPECTED\_RADIO\_LINK\_FAILURES +- PING\_PONG\_ACROSS\_CELLS + +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | +Describes the Exception Id. +Possible values are: +- UNEXPECTED\_UE\_LOCATION: Unexpected UE location. +- UNEXPECTED\_LONG\_LIVE\_FLOW: Unexpected long-live rate flows. +- UNEXPECTED\_LARGE\_RATE\_FLOW: Unexpected large rate flows. +- UNEXPECTED\_WAKEUP: Unexpected wakeup. +- SUSPICION\_OF\_DDOS\_ATTACK: Suspicion of DDoS attack. +- WRONG\_DESTINATION\_ADDRESS: Wrong destination address. +- TOO\_FREQUENT\_SERVICE\_ACCESS: Too frequent Service Access. +- UNEXPECTED\_RADIO\_LINK\_FAILURES: Unexpected radio link failures. +- PING\_PONG\_ACROSS\_CELLS: Ping-ponging across neighbouring cells. + +ExceptionTrend: +anyOf: +- type: string +enum: +- UP +- DOWN +- UNKNOW +- STABLE + +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | +Represents the Exception Trend. +Possible values are: +- UP: Up trend of the exception level. +- DOWN: Down trend of the exception level. +- UNKNOW: Unknown trend of the exception level. +- STABLE: Stable trend of the exception level. + +TimeUnit: +anyOf: +- type: string +enum: +- MINUTE +- HOUR +- DAY + +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | +Represents the unit for the session active time. +Possible values are: +- MINUTE: Time unit is per minute. +- HOUR: Time unit is per hour. +- DAY: Time unit is per day. + +NetworkPerfType: +anyOf: +- type: string +enum: +- GNB\_ACTIVE\_RATIO +- GNB\_COMPUTING\_USAGE +- GNB\_MEMORY\_USAGE +- GNB\_DISK\_USAGE +- GNB\_RSC\_USAGE\_OVERALL\_TRAFFIC +- GNB\_RSC\_USAGE\_GBR\_TRAFFIC +- GNB\_RSC\_USAGE\_DELAY\_CRIT\_GBR\_TRAFFIC +- NUM\_OF\_UE + +- SESS\_SUCC\_RATIO +- HO\_SUCC\_RATIO +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +- description: | +Represents the network performance types. +Possible values are: + - GNB\_ACTIVE\_RATIO: Indicates that the network performance requirement is gNodeB active (i.e. up and running) rate. Indicates the ratio of gNB active (i.e. up and running) number to the total number of gNB. + - GNB\_COMPUTING\_USAGE: Indicates gNodeB computing resource usage. + - GNB\_MEMORY\_USAGE: Indicates gNodeB memory usage. + - GNB\_DISK\_USAGE: Indicates gNodeB disk usage. + - GNB\_RSC\_USAGE\_OVERALL\_TRAFFIC: The gNB resource usage. + - GNB\_RSC\_USAGE\_GBR\_TRAFFIC: The gNB resource usage for GBR traffic. + - GNB\_RSC\_USAGE\_DELAY\_CRIT\_GBR\_TRAFFIC: The gNB resource usage for Delay-critical GBR traffic. + - NUM\_OF\_UE: Indicates number of UEs. + - SESS\_SUCC\_RATIO: Indicates ratio of successful setup of PDU sessions to total PDU session setup attempts. + - HO\_SUCC\_RATIO: Indicates Ratio of successful handovers to the total handover attempts. + +ExpectedAnalyticsType: +anyOf: +- type: string +enum: +- MOBILITY +- COMMUN +- MOBILITY\_AND\_COMMUN + +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | +Represents the expected UE analytics type. +Possible values are: + +- MOBILITY: Mobility related abnormal behaviour analytics is expected by the consumer. +- COMMUN: Communication related abnormal behaviour analytics is expected by the consumer. +- MOBILITY\_AND\_COMMUN: Both mobility and communication related abnormal behaviour analytics is expected by the consumer. + +MatchingDirection: +anyOf: +- type: string +enum: +- ASCENDING +- DESCENDING +- CROSSED + +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | +Represents the matching direction when crossing a threshold. +Possible values are: + +- ASCENDING: Threshold is crossed in ascending direction. +- DESCENDING: Threshold is crossed in descending direction. +- CROSSED: Threshold is crossed either in ascending or descending direction. + +NwdaFailureCode: +anyOf: +- type: string +enum: +- UNAVAILABLE\_DATA +- BOTH\_STAT\_PRED\_NOT\_ALLOWED +- PREDICTION\_NOT\_ALLOWED +- UNSATISFIED\_REQUESTED\_ANALYTICS\_TIME +- OTHER + +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | +Represents the failure reason. +Possible values are: +- UNAVAILABLE\_DATA: Indicates the requested statistics information for the event is rejected since necessary data to perform the service is unavailable. +- BOTH\_STAT\_PRED\_NOT\_ALLOWED: Indicates the requested analysis information for the event is rejected since the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics. +- PREDICTION\_NOT\_ALLOWED: Indicates that the request for the prediction of the analytics event is not allowed. +- UNSATISFIED\_REQUESTED\_ANALYTICS\_TIME: Indicates that the requested event is rejected since the analytics information is not ready when the time indicated by the "timeAnaNeeded" attribute (as provided during the creation or modification of subscription) is reached. +- OTHER: Indicates the requested analysis information for the event is rejected due to other reasons. + +#### AnalyticsMetadata: + +anyOf: +- type: string +enum: +- NUM\_OF\_SAMPLES +- DATA\_WINDOW +- DATA\_STAT\_PROPS +- STRATEGY +- ACCURACY +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Represents the types of analytics metadata information that can be requested. +Possible values are: +- NUM\_OF\_SAMPLES: Number of data samples used for the generation of the output analytics. +- DATA\_WINDOW: Data time window of the data samples. +- DATA\_STAT\_PROPS: Dataset statistical properties of the data used to generate the analytics. +- STRATEGY: Output strategy used for the reporting of the analytics. +- ACCURACY: Level of accuracy reached for the analytics. + +#### DatasetStatisticalProperty: + +anyOf: +- type: string +enum: +- UNIFORM\_DIST\_DATA +- NO\_OUTLIERS +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Represents the dataset statistical properties. +Possible values are: +- UNIFORM\_DIST\_DATA: Indicates the use of data samples that are uniformly distributed according to the different aspects of the requested analytics. +- NO\_OUTLIERS: Indicates that the data samples shall disregard data samples that are at the extreme boundaries of the value range. + +#### OutputStrategy: + +anyOf: +- type: string +enum: +- BINARY +- GRADIENT +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Represents the output strategy used for the analytics reporting. +Possible values are: +- BINARY: Indicates that the analytics shall only be reported when the requested level of accuracy is reached within a cycle of periodic notification. +- GRADIENT: Indicates that the analytics shall be reported according with the periodicity irrespective of whether the requested level of accuracy has been reached or not. + +``` +TransferRequestType: + anyOf: + - type: string + enum: + - PREPARE + - TRANSFER + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Represents the request type for the analytics subscription transfer. + Possible values are: + - PREPARE: Indicates that the request is for analytics subscription transfer preparation. + - TRANSFER: Indicates that the request is for analytics subscription transfer execution. + +AnalyticsSubset: + anyOf: + - type: string + enum: + - NUM_OF_UE_REG + - NUM_OF_PDU_SESS_ESTBL + - RES_USAGE + - NUM_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR + - PERIOD_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR + - EXCEED_LOAD_LEVEL_THR_IND + - LIST_OF_TOP_APP_UL + - LIST_OF_TOP_APP_DL + - NF_STATUS + - NF_RESOURCE_USAGE + - NF_LOAD + - NF_PEAK_LOAD + - NF_LOAD_AVG_IN_AOI + - DISPER_AMOUNT + - DISPER_CLASS + - RANKING + - PERCENTILE_RANKING + - RSSI + - RTT + - TRAFFIC_INFO + - NUMBER_OF_UES + - APP_LIST_FOR_UE_COMM + - N4_SESS_INACT_TIMER_FOR_UE_COMM + - AVG_TRAFFIC_RATE + - MAX_TRAFFIC_RATE + - AGG_TRAFFIC_RATE + - VAR_TRAFFIC_RATE + - AVG_PACKET_DELAY + - MAX_PACKET_DELAY + - VAR_PACKET_DELAY + - AVG_PACKET_LOSS_RATE + - MAX_PACKET_LOSS_RATE + - VAR_PACKET_LOSS_RATE + - UE_LOCATION + - LIST_OF_HIGH_EXP_UE + - LIST_OF_MEDIUM_EXP_UE + - LIST_OF_LOW_EXP_UE + - AVG_UL_PKT_DROP_RATE + - VAR_UL_PKT_DROP_RATE + - AVG_DL_PKT_DROP_RATE + - VAR_DL_PKT_DROP_RATE + - AVG_UL_PKT_DELAY + - VAR_UL_PKT_DELAY + - AVG_DL_PKT_DELAY + - VAR_DL_PKT_DELAY + - TRAFFIC_MATCH_TD + - TRAFFIC_UNMATCH_TD + - NUMBER_OF_UE + - UE_GEOG_DIST + - UE_DIRECTION + - AVG_E2E_UL_PKT_DELAY + - VAR_E2E_UL_PKT_DELAY + - AVG_E2E_DL_PKT_DELAY + - VAR_E2E_DL_PKT_DELAY + - AVG_E2E_UL_PKT_LOSS_RATE + - VAR_E2E_UL_PKT_LOSS_RATE + - AVG_E2E_DL_PKT_LOSS_RATE +``` + +- VAR\_E2E\_DL\_PKT\_LOSS\_RATE +- E2E\_DATA\_VOL\_TRANS\_TIME\_FOR\_UE\_LIST +- IN\_OUT\_PERCENT +- TIME\_TO\_COLLISION +- type: string + - description: > + - This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + - description: | + - Represents the analytics subset. + - Possible values are: + - NUM\_OF\_UE\_REG: The number of UE registered. This value is only applicable to NSI\_LOAD\_LEVEL event. + - NUM\_OF\_PDU\_SESS\_ESTBL: The number of PDU sessions established. This value is only applicable to NSI\_LOAD\_LEVEL event. + - RES\_USAGE: The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance. This value is only applicable to NSI\_LOAD\_LEVEL event. + - NUM\_OF\_EXCEED\_RES\_USAGE\_LOAD\_LEVEL\_THR: The number of times the resource usage threshold of the network slice instance is reached or exceeded if a threshold value is provided by the consumer. This value is only applicable to NSI\_LOAD\_LEVEL event. + - PERIOD\_OF\_EXCEED\_RES\_USAGE\_LOAD\_LEVEL\_THR: The time interval between each time the threshold being met or exceeded on the network slice (instance). This value is only applicable to NSI\_LOAD\_LEVEL event. + - EXCEED\_LOAD\_LEVEL\_THR\_IND: Whether the Load Level Threshold is met or exceeded by the statistics value. This value is only applicable to NSI\_LOAD\_LEVEL event. + - LIST\_OF\_TOP\_APP\_UL: The list of applications that contribute the most to the traffic in the UL direction. This value is only applicable to USER\_DATA\_CONGESTION event. + - LIST\_OF\_TOP\_APP\_DL: The list of applications that contribute the most to the traffic in the DL direction. This value is only applicable to USER\_DATA\_CONGESTION event. + - NF\_STATUS: The availability status of the NF on the Analytics target period, expressed as a percentage of time per status value (registered, suspended, undiscoverable). This value is only applicable to NF\_LOAD event. + - NF\_RESOURCE\_USAGE: The average usage of assigned resources (CPU, memory, storage). This value is only applicable to NF\_LOAD event. + - NF\_LOAD: The average load of the NF instance over the Analytics target period. This value is only applicable to NF\_LOAD event. + - NF\_PEAK\_LOAD: The maximum load of the NF instance over the Analytics target period. This value is only applicable to NF\_LOAD event. + - NF\_LOAD\_AVG\_IN\_AOI: The average load of the NF instances over the area of interest. This value is only applicable to NF\_LOAD event. + - DISPER\_AMOUNT: Indicates the dispersion amount of the reported data volume or transaction dispersion type. This value is only applicable to DISPERSION event. + - DISPER\_CLASS: Indicates the dispersion mobility class: fixed, camper, traveller upon set its usage threshold, and/or the top-heavy class upon set its percentile rating threshold. This value is only applicable to DISPERSION event. + - RANKING: Data/transaction usage ranking high (i.e.value 1), medium (2) or low (3). This value is only applicable to DISPERSION event. + - PERCENTILE\_RANKING: Percentile ranking of the target UE in the Cumulative Distribution Function of data usage for the population of all UEs. This value is only applicable to DISPERSION event. + - RSSI: Indicated the RSSI in the unit of dBm. This value is only applicable to WLAN\_PERFORMANCE event. + - RTT: Indicates the RTT in the unit of millisecond. This value is only applicable to WLAN\_PERFORMANCE event. + - TRAFFIC\_INFO: Traffic information including UL/DL data rate and/or Traffic volume. This value is only applicable to WLAN\_PERFORMANCE event. + - NUMBER\_OF\_UES: Number of UEs observed for the SSID. This value is only applicable to WLAN\_PERFORMANCE event. + - APP\_LIST\_FOR\_UE\_COMM: The analytics of the application list used by UE. This value is only applicable to UE\_COMM event. + - N4\_SESS\_INACT\_TIMER\_FOR\_UE\_COMM: The N4 Session inactivity timer. This value is only applicable to UE\_COMM event. + - AVG\_TRAFFIC\_RATE: Indicates average traffic rate. This value is only applicable to DN\_PERFORMANCE event. + - MAX\_TRAFFIC\_RATE: Indicates maximum traffic rate. This value is only applicable to DN\_PERFORMANCE event. + - AGG\_TRAFFIC\_RATE: Indicates aggregated traffic rate. This value is only applicable to DN\_PERFORMANCE event. + - VAR\_TRAFFIC\_RATE: Indicates variance traffic rate. This value is only applicable to DN\_PERFORMANCE event. + - AVG\_PACKET\_DELAY: Indicates average Packet Delay. This value is only applicable to DN\_PERFORMANCE event. + - MAX\_PACKET\_DELAY: Indicates maximum Packet Delay. This value is only applicable to DN\_PERFORMANCE event. + - VAR\_PACKET\_DELAY: Indicates variance Packet Delay. This value is only applicable to DN\_PERFORMANCE event. + +- AVG\_PACKET\_LOSS\_RATE: Indicates average Loss Rate. This value is only applicable to DN\_PERFORMANCE event. +- MAX\_PACKET\_LOSS\_RATE: Indicates maximum Packet Loss Rate. This value is only applicable to DN\_PERFORMANCE event. +- VAR\_PACKET\_LOSS\_RATE: Indicates variance Packet Loss Rate. This value is only applicable to DN\_PERFORMANCE event. +- UE\_LOCATION: Indicates UE location information. This value is only applicable to SERVICE\_EXPERIENCE event. +- LIST\_OF\_HIGH\_EXP\_UE: Indicates list of high experienced UE. This value is only applicable to SM\_CONGESTION event. +- LIST\_OF\_MEDIUM\_EXP\_UE: Indicates list of medium experienced UE. This value is only applicable to SM\_CONGESTION event. +- LIST\_OF\_LOW\_EXP\_UE: Indicates list of low experienced UE. This value is only applicable to SM\_CONGESTION event. +- AVG\_UL\_PKT\_DROP\_RATE: Indicates average uplink packet drop rate on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_UL\_PKT\_DROP\_RATE: Indicates variance of uplink packet drop rate on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- AVG\_DL\_PKT\_DROP\_RATE: Indicates average downlink packet drop rate on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_DL\_PKT\_DROP\_RATE: Indicates variance of downlink packet drop rate on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- AVG\_UL\_PKT\_DELAY: Indicates average uplink packet delay round trip on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_UL\_PKT\_DELAY: Indicates variance uplink packet delay round trip on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- AVG\_DL\_PKT\_DELAY: Indicates average downlink packet delay round trip on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_DL\_PKT\_DELAY: Indicates variance downlink packet delay round trip on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- TRAFFIC\_MATCH\_TD: Identifies traffic that matches Traffic Descriptor provided by the consumer. +- TRAFFIC\_UNMATCH\_TD: Identifies traffic that does not match Traffic Descriptor provided by the consumer. +- NUMBER\_OF\_UE: Indicates the number of UEs. This value is only applicable to DN\_PERFORMANCE event. +- UE\_GEOG\_DIST: Indicates the geographical distribution of the UEs that can be selected by the AF for application service. This value is only applicable to UE\_MOBILITY event. +- UE\_DIRECTION: Indicates the direction of the UEs. This value is only applicable to UE\_MOBILITY event. +- AVG\_E2E\_UL\_PKT\_DELAY: Indicates average End-to-End (between UE and UPF) uplink packet delay. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_E2E\_UL\_PKT\_DELAY: Indicates the variance of End-to-End (between UE and UPF) uplink packet delay. This value is only applicable to RED\_TRANS\_EXP event. +- AVG\_E2E\_DL\_PKT\_DELAY: Indicates average End-to-End (between UE and UPF) downlink packet delay. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_E2E\_DL\_PKT\_DELAY: Indicates the variance of End-to-End (between UE and UPF) downlink packet delay. This value is only applicable to RED\_TRANS\_EXP event. +- AVG\_E2E\_UL\_PKT\_LOSS\_RATE: Indicates average End-to-End (between UE and UPF) uplink packet loss rate. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_E2E\_UL\_PKT\_LOSS\_RATE: Indicates the variance of End-to-End (between UE and UPF) uplink packet loss rate. This value is only applicable to RED\_TRANS\_EXP event. +- AVG\_E2E\_DL\_PKT\_LOSS\_RATE: Indicates average End-to-End (between UE and UPF) downlink packet loss rate. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_E2E\_DL\_PKT\_LOSS\_RATE: Indicates the variance of End-to-End (between UE and UPF) downlink packet loss rate. This value is only applicable to RED\_TRANS\_EXP event. +- E2E\_DATA\_VOL\_TRANS\_TIME\_FOR\_UE\_LIST: Indicates the classified E2E data volume transfer time statistics or predictions for multiple UEs with respect to one or more reporting thresholds. +- NUM\_OF\_UE: Indicates the total number of users in the area of interest. This value is only applicable to MOVEMENT\_BEHAVIOUR event. +- MOV\_UE\_RATIO: Indicates the Ratio of moving UEs in the area of interest. This value is only applicable to MOVEMENT\_BEHAVIOUR event. +- AVR\_SPEED: Indicates the average speed of all UEs in the area of interest. This value is only applicable to MOVEMENT\_BEHAVIOUR event. +- SPEED\_THRESHOLD: Indicates the information on UEs in the area of interest whose speed is faster than the speed threshold. This value is only applicable to MOVEMENT\_BEHAVIOUR event. +- MOV\_UE\_DIRECTION: Indicates the heading directions of the UE flow in the target area. This value is only applicable to MOVEMENT\_BEHAVIOUR event. +- IN\_OUT\_PERCENT: Indicates the percentage of indoor/outdoor UEs at a location. The value is only applicable to the LOC\_ACCURACY event. +- TIME\_TO\_COLLISION: Indicates the time until for a collision with another UE happens. This value is only applicable to RELATIVE\_PROXIMITY event prediction. + +DispersionType: +oneOf: +- type: string + +``` +enum: + - DVDA + - TDA + - DVDA_AND_TDA +- type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +description: | + Represents the dispersion type. + Possible values are: + - DVDA: Data Volume Dispersion Analytics. + - TDA: Transactions Dispersion Analytics. + - DVDA_AND_TDA: Data Volume Dispersion Analytics and Transactions Dispersion Analytics. + +DispersionClass: + oneOf: + - type: string + enum: + - FIXED + - CAMPER + - TRAVELLER + - TOP_HEAVY + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Represents the dispersion class. + Possible values are: + - FIXED: Dispersion class as fixed UE its data or transaction usage at a location or + a slice, is higher than its class threshold set for its all data or transaction usage. + - CAMPER: Dispersion class as camper UE, its data or transaction usage at a location or + a slice, is higher than its class threshold and lower than the fixed class threshold set + for its all data or transaction usage. + - TRAVELLER: Dispersion class as traveller UE, its data or transaction usage at a location + or a slice, is lower than the camper class threshold set for its all data or transaction + usage. + - TOP_HEAVY: Dispersion class as Top_Heavy UE, who's dispersion percentile rating at a + location or a slice, is higher than its class threshold. + +DispersionOrderingCriterion: + anyOf: + - type: string + enum: + - TIME_SLOT_START + - DISPERSION + - CLASSIFICATION + - RANKING + - PERCENTILE_RANKING + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Represents the order criterion for the list of dispersion. + Possible values are: + - TIME_SLOT_START: Indicates the order of time slot start. + - DISPERSION: Indicates the order of data/transaction dispersion. + - CLASSIFICATION: Indicates the order of data/transaction classification. + - RANKING: Indicates the order of data/transaction ranking. + - PERCENTILE_RANKING: Indicates the order of data/transaction percentile ranking. + +DeviceType: + anyOf: + - type: string + enum: + - MOBILE_PHONE + - SMART_PHONE + - TABLET + - DONGLE + - MODEM + - WLAN_ROUTER + - IOT_DEVICE +``` + +``` +- WEARABLE +- MOBILE_TEST_PLATFORM +- UNDEFINED +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but +is not used to encode content defined in the present version of this API. +description: | +Represents the device type. +Possible values are: +- MOBILE_PHONE: Mobile Phone. +- SMART_PHONE: Smartphone. +- TABLET: Tablet. +- DONGLE: Dongle. +- MODEM: Modem. +- WLAN_ROUTER: WLAN Router. +- IOT_DEVICE: IoT Device. +- WEARABLE: Wearable. +- MOBILE_TEST_PLATFORM: Mobile Test Platform. +- UNDEFINED: Undefined. + +RedTransExpOrderingCriterion: +anyOf: +- type: string +enum: +- TIME_SLOT_START +- RED_TRANS_EXP +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. +description: | +Represents the order criterion for the list of Redundant Transmission Experience. +Possible values are: +- TIME_SLOT_START: Indicates the order of time slot start. +- RED_TRANS_EXP: Indicates the order of Redundant Transmission Experience. + +WlanOrderingCriterion: +anyOf: +- type: string +enum: +- TIME_SLOT_START +- NUMBER_OF_UES +- RSSI +- RTT +- TRAFFIC_INFO +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. +description: | +Represents the order criterion for the list of WLAN performance information. +Possible values are: +- TIME_SLOT_START: Indicates the order of time slot start. +- NUMBER_OF_UES: Indicates the order of number of UEs. +- RSSI: Indicates the order of RSSI. +- RTT: Indicates the order of RTT. +- TRAFFIC_INFO: Indicates the order of Traffic information. + +ServiceExperienceType: +anyOf: +- type: string +enum: +- VOICE +- VIDEO +- OTHER +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration +but is not used to encode content defined in the present version of this API. +description: | +Represents the type of the service experience analytics. +Possible values are: +- VOICE: Indicates that the service experience analytics is for voice service. +- VIDEO: Indicates that the service experience analytics is for video service. +- OTHER: Indicates that the service experience analytics is for other service. +``` + +DnPerfOrderingCriterion: +anyOf: +- type: string +enum: +- AVERAGE\_TRAFFIC\_RATE +- MAXIMUM\_TRAFFIC\_RATE +- AVERAGE\_PACKET\_DELAY +- MAXIMUM\_PACKET\_DELAY +- AVERAGE\_PACKET\_LOSS\_RATE +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Represents the order criterion for the list of DN performance analytics. +Possible values are: +- AVERAGE\_TRAFFIC\_RATE: Indicates the average traffic rate. +- MAXIMUM\_TRAFFIC\_RATE: Indicates the maximum traffic rate. +- AVERAGE\_PACKET\_DELAY: Indicates the average packet delay. +- MAXIMUM\_PACKET\_DELAY: Indicates the maximum packet delay. +- AVERAGE\_PACKET\_LOSS\_RATE: Indicates the average packet loss rate. + +TermCause: +anyOf: +- type: string +enum: +- USER\_CONSENT\_REVOKED +- NWDAF\_OVERLOAD +- UE\_LEFT\_AREA +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Represents the cause for the analytics subscription termination request. +Possible values are: +- USER\_CONSENT\_REVOKED: The user consent has been revoked. +- NWDAF\_OVERLOAD: The NWDAF is overloaded. +- UE\_LEFT\_AREA: The UE has moved out of the NWDAF serving area. + +UserDataConOrderCrit: +anyOf: +- type: string +enum: +- APPLICABLE\_TIME\_WINDOW +- NETWORK\_STATUS\_INDICATION +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Represents the cause for requesting to terminate an analytics subscription. +Possible values are: +- APPLICABLE\_TIME\_WINDOW: The ordering criterion is the Applicable Time Window. +- NETWORK\_STATUS\_INDICATION: The ordering criterion is the network status indication. + +UeMobilityOrderCriterion: +anyOf: +- type: string +enum: +- TIME\_SLOT +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Represents the ordering criterion for the list of UE mobility analytics. +Possible values are: +- TIME\_SLOT: The ordering criterion is the time slot. + +UeCommOrderCriterion: +anyOf: +- type: string +enum: +- START\_TIME +- DURATION +- type: string +description: > + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | + +Represents the ordering criterion for the list of UE communication analytics. + +Possible values are: + +- START\_TIME: The ordering criterion of the analytics is the start time. +- DURATION: The ordering criterion of the analytics is the duration of the communication. + +NetworkPerfOrderCriterion: + +anyOf: + +- type: string + +enum: + +- NUMBER\_OF\_UES +- COMMUNICATION\_PERF +- MOBILITY\_PERF + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | + +Represents the ordering criterion for the list of network performance analytics. + +Possible values are: + +- NUMBER\_OF\_UES: The ordering criterion of the analytics is the number of UEs. +- COMMUNICATION\_PERF: The ordering criterion of the analytics is the communication + +performance. + +- MOBILITY\_PERF: The ordering criterion of the analytics is the mobility performance. + +LocInfoGranularity: + +anyOf: + +- type: string + +enum: + +- TA\_LEVEL +- CELL\_LEVEL +- LON\_AND\_LAT\_LEVEL + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | + +Represents the preferred granularity of location information. + +Possible values are: + +- TA\_LEVEL: Indicates location granularity of TA level. +- CELL\_LEVEL: Indicates location granularity of Cell level. +- LON\_AND\_LAT\_LEVEL: Indicates location granularity of longitude and latitude level. + +TrafficDirection: + +anyOf: + +- type: string + +enum: + +- UL\_AND\_DL +- UL +- DL + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | + +Represents the traffic direction for the resource usage information. + +Possible values are: + +- UL\_AND\_DL: Uplink and downlink traffic. +- UL: Uplink traffic. +- DL: Downlink traffic. + +ValueExpression: + +anyOf: + +- type: string + +enum: + +- AVERAGE +- PEAK + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | + +Represents the average or peak value of the resource usage for the network performance type. + +Possible values are: + +- AVERAGE: Resource usage information in average value. +- PEAK: Resource usage information in peak value. + +E2eDataVolTransTimeCriterion: +anyOf: +- type: string +enum: +- TIME\_SLOT\_START +- E2E\_DATA\_VOL\_TRANS\_TIME +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Represents the ordering criterion for the list of E2E data volume transfer time. +Possible values are: +- TIME\_SLOT\_START: Indicates the order of time slot start. +- E2E\_DATA\_VOL\_TRANS\_TIME: The ordering criterion is the E2E data volume transfer time. + +AnalyticsAccuracyIndication: +anyOf: +- type: string +enum: +- MEET +- NOT\_MEET +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Represents the notification methods for the subscribed events. +Possible values are: +- MEET: Indicates meet the analytics accuracy requirement. +- NOT\_MEET: Indicates not meet the analytics accuracy requirement. + +LocationOrientation: +anyOf: +- type: string +enum: +- HORIZONTAL +- VERTICAL +- HOR\_AND\_VER +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Possible values are: +- HORIZONTAL: Indicates horizontal orientation. +- VERTICAL: Indicates vertical orientation. +- HOR\_AND\_VER: Indicates both horizontal and vertical orientation. + +Direction: +anyOf: +- type: string +enum: +- NORTH +- SOUTH +- EAST +- WEST +- NORTHWEST +- NORTHEAST +- SOUTHWEST +- SOUTHEAST +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Possible values are: +- NORTH: North direction. +- SOUTH: South direction. +- EAST: EAST direction. +- WEST: WEST direction. +- NORTHWEST: Northwest direction. +- NORTHEAST: Northeast direction. +- SOUTHWEST: Southwest direction. + +``` + + - SOUTHEAST: Southeast direction. + +ProximityCriterion: + anyOf: + - type: string + enum: + - VELOCITY + - AVG_SPD + - ORIENTATION + - TRAJECTORY + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration but + is not used to encode content defined in the present version of this API. + description: | + Possible values are: + - VELOCITY: Velocity. + - AVG_SPD: Average speed. + - ORIENTATION: Orientation. + - TRAJECTORY: Mobility trajectory. + +``` + +## A.3 Nnwdaf\_AnalyticsInfo API + +``` + +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.5 + title: Nnwdaf_AnalyticsInfo + description: | + Nnwdaf_AnalyticsInfo Service API. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/' + +security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-analyticsinfo + +servers: + - url: '{apiRoot}/nnwdaf-analyticsinfo/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +paths: + /analytics: + get: + summary: Read a NWDAF Analytics + operationId: GetNWDAFAnalytics + tags: + - NWDAF Analytics (Document) + parameters: + - name: event-id + in: query + description: Identify the analytics. + required: true + schema: + $ref: '#/components/schemas/EventId' + - name: ana-req + in: query + description: Identifies the analytics reporting requirement information. + required: false + content: + application/json: + schema: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventReportingRequirement' + - name: event-filter + in: query + description: Identify the analytics. + +``` + +``` + + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/EventFilter' +- name: supported-features + in: query + description: To filter irrelevant responses related to unsupported features. + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: tgt-ue + in: query + description: Identify the target UE information. + required: false + content: + application/json: + schema: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/TargetUeInformation' +responses: + '200': + description: > + Containing the analytics with parameters as relevant for the requesting NF service + consumer. + content: + application/json: + schema: + $ref: '#/components/schemas/AnalyticsData' + '204': + description: No Content. The requested NWDAF Analytics data does not exist. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + description: Indicates that the NWDAF Analytics resource does not exist. + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + description: > + The request is rejected by the NWDAF and more details (not only the ProblemDetails) are + returned. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsAnalyticsInfoRequest' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/context: + get: + summary: Get context information related to analytics subscriptions. + operationId: GetNnwdafContext + tags: + - NWDAF Context (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-analyticsinfo + - oAuth2ClientCredentials: + - nnwdaf-analyticsinfo + - nnwdaf-analyticsinfo:contexttransfer + parameters: + - name: context-ids + +``` + +``` +in: query +description: Identifies specific context information related to analytics subscriptions. +required: true +content: + application/json: + schema: + $ref: '#/components/schemas/ContextIdList' +- name: req-context +in: query +description: > + Identifies the type(s) of the analytics context information the consumer wishes + to receive. +required: false +content: + application/json: + schema: + $ref: '#/components/schemas/RequestedContext' +responses: + '200': + description: > + Contains context information related to analytics subscriptions corresponding with + one or more context identifiers. + content: + application/json: + schema: + $ref: '#/components/schemas/ContextData' + '204': + description: > + No Content. No context information could be retrieved for the requested context + Identifiers. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + +securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnwdaif-analyticsinfo: Access to the Nnwdaf_AnalyticsInfo API + nnwdaif-analyticsinfo:contexttransfer: > + Access to service operations applying to NWDAF context transfer related service + operations, i.e. ContextTransfer. + +schemas: + +AnalyticsData: + description: > + Represents the description of analytics with parameters as relevant for the requesting NF + service consumer. + type: object + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + expiry: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +timeStampGen: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +anaMetaInfo: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AnalyticsMetadataInfo' +sliceLoadLevelInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/SliceLoadLevelInformation' +minItems: 1 +description: The slices and their load level information. +nsiLoadLevelInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NsiLoadLevelInfo' +minItems: 1 +nfLoadLevelInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NfLoadLevelInformation' +minItems: 1 +nwPerfs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NetworkPerfInfo' +minItems: 1 +svcExps: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ServiceExperienceInfo' +minItems: 1 +qosSustainInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/QosSustainabilityInfo' +minItems: 1 +ueMobs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/UeMobility' +minItems: 1 +ueComms: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/UeCommunication' +minItems: 1 +userDataCongInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/UserDataCongestionInfo' +minItems: 1 +abnorBehavrs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AbnormalBehaviour' +minItems: 1 +smccExps: +type: array +items: +$ref: '#/components/schemas/SmcceInfo' +minItems: 1 +disperInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DispersionInfo' +minItems: 1 +redTransInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RedundantTransmissionExpInfo' +minItems: 1 +wlanInfos: +type: array +items: +``` + +``` +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/WlanPerformanceInfo' +minItems: 1 +dnPerfInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DnPerfInfo' +minItems: 1 +pfdDetermInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/PfdDeterminationInfo' +minItems: 1 +pduSesTrafInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/PduSesTrafficInfo' +minItems: 1 +dataVlTrnsTmInfos: +type: array +items: +$ref: +'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/E2eDataVolTransTimeInfo' +minItems: 1 +locAccInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/LocAccuracyInfo' +minItems: 1 +accuInfo: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AccuracyInfo' +cancelAccuInd: +type: boolean +description: > +Indicates cancelled request of the analytics accuracy information. +Set to "true" indicates the NWDAF cancelled request of analytics accuracy +information as the NWDAF does not support the accuracy checking capability. +Otherwise set to "false". Default value is "false" if omitted. +movBehavInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/MovBehavInfo' +minItems: 1 +relProxInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RelProxInfo' +minItems: 1 +suppFeat: +$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +EventFilter: +description: Represents the event filters used to identify the requested analytics. +type: object +properties: +anySlice: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AnySlice' +snssais: +type: array +items: +$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +minItems: 1 +description: Identification(s) of network slice. +roamingInfo: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RoamingInfo' +appIds: +type: array +items: +$ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' +minItems: 1 +dnns: +type: array +items: +$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +minItems: 1 +dnais: +type: array +items: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + ladnDnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + description: Identification(s) of LADN DNN to indicate the LADN service area as the AOI. + location: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/GeoLocation' + networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + temporalGranSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + spatialGranSizeTa: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + spatialGranSizeCell: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + fineGranAreas: + type: array + items: + $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' + minItems: 1 + description: Indicates the fine granularity areas to which the request applies. + visitedAreas: + type: array + items: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + minItems: 1 + maxTopAppUINbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + maxTopAppDlNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + nfInstanceIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + nfSetIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + nfTypes: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + minItems: 1 + nsiIdInfos: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NsiIdInfo' + minItems: 1 + qosRequ: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/QosRequirement' + nwPerfReqs: + type: array + items: + $ref: '#/components/schemas/NetworkPerfReq' + minItems: 1 + nwPerfTypes: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NetworkPerfType' + minItems: 1 + addNwPerfReqs: + type: array + items: + $ref: '#/components/schemas/ResourceUsageRequPerNwPerfType' + minItems: 1 + userDataConReqs: + type: array + items: + $ref: '#/components/schemas/UserDataCongestReq' + minItems: 1 + bwReqs: + type: array + items: + +``` + +``` +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/BwRequirement' +minItems: 1 +excepIds: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ExceptionId' +minItems: 1 +exptAnaType: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ExpectedAnalyticsType' +exptUeBehav: +$ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExpectedUeBehaviourData' +ratFreqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RatFreqInformation' +minItems: 1 +dispersReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DispersionRequirement' +minItems: 1 +redTransReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RedundantTransmissionExpReq' +minItems: 1 +wlanReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/WlanPerformanceReq' +minItems: 1 +listOfAnaSubsets: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AnalyticsSubset' +minItems: 1 +upfInfo: +$ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/UpfInformation' +appServerAddrs: +type: array +items: +$ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' +minItems: 1 +dnPerfReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DnPerformanceReq' +minItems: 1 +ueMobilityReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/UeMobilityReq' +minItems: 1 +ueCommReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/UeCommReq' +minItems: 1 +pduSesInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/PduSessionInfo' +minItems: 1 +pduSesTrafReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/PduSesTrafficReq' +minItems: 1 +locAccReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/LocAccuracyReq' +minItems: 1 +locGranularity: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/LocInfoGranularity' +locOrientation: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/LocationOrientation' +``` + +``` + useCaseCxt: + type: string + description: > + Indicates the context of usage of the analytics. The value and format of this parameter + are not standardized. + dataVolTrnsTmRqs: + type: array + items: + $ref: + 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/E2eDataVolTransTimeReq' + minItems: 1 + accuReq: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/AccuracyReq' + movBehavReqs: + type: array + items: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/MovBehavReq' + minItems: 1 + relProxReqs: + type: array + items: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/RelProxReq' + minItems: 1 + not: + required: [anySlice, snssais] + +ProblemDetailsAnalyticsInfoRequest: + description: > + Extends ProblemDetails to indicate more details why the analytics request is rejected. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionInfoAnalyticsInfoRequest' + +AdditionInfoAnalyticsInfoRequest: + description: Indicates additional information why the analytics request is rejected. + type: object + properties: + rvWaitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +ContextData: + description: > + Contains context information related to analytics subscriptions corresponding with one or + more context identifiers. + type: object + properties: + contextElem: + type: array + items: + $ref: '#/components/schemas/ContextElement' + minItems: 1 + description: > + List of items that contain context information corresponding with a context identifier. + required: + - contextElem + +ContextElement: + description: Contains context information corresponding with a specific context identifier. + type: object + properties: + contextId: + $ref: + 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/AnalyticsContextIdentifier' + pendAnalytics: + type: array + items: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/EventNotification' + minItems: 1 + description: > + Output analytics for the analytics subscription which have not yet been sent to the + analytics consumer. + histAnalytics: + type: array + items: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/EventNotification' + minItems: 1 + description: Historical output analytics. + lastOutputTime: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +aggrSubs: + type: array + items: + $ref: '#/components/schemas/SpecificAnalyticsSubscription' + minItems: 1 + description: > + Information about analytics subscriptions that the NWDAF has with other NWDAFs to + perform aggregation. +histData: + type: array + items: + $ref: '#/components/schemas/HistoricalData' + minItems: 1 + description: Historical data related to the analytics subscription. +adrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +adrfDataTypes: + type: array + items: + $ref: '#/components/schemas/AdrfDataType' + minItems: 1 + description: Type(s) of data stored in the ADRF by the NWDAF. +aggrNwdaIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + description: > + NWDAF identifiers of NWDAF instances used by the NWDAF service consumer when aggregating + multiple analytics subscriptions. +modelInfo: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ModelInfo' + minItems: 1 + description: > + Contains information identifying the ML model(s) that the consumer NWDAF is currently + subscribing for the analytics. +required: +- contextId + +ContextIdList: + description: > + Contains a list of context identifiers of context information of analytics + subscriptions. + type: object + properties: + contextIds: + type: array + items: + $ref: +'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AnalyticsContextIdentifier' + minItems: 1 + required: + - contextIds + +HistoricalData: + description: Contains historical data related to an analytics subscription. + type: object + properties: + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + subsWithSources: + type: array + items: + $ref: '#/components/schemas/SpecificDataSubscription' + minItems: 1 + description: Information about subscriptions with the data sources. + data: + type: array + items: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataNotification' + minItems: 1 + description: Historical data related to the analytics. + required: +``` + +``` +- data + +NetworkPerfReq: + description: Represents a network performance requirement. + type: object + properties: + orderCriterion: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/NetworkPerfOrderCriterion' + orderDirection: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/MatchingDirection' + +SpecificAnalyticsSubscription: + description: > + Represents an existing subscription for a specific type of analytics to a specific NWDAF. + type: object + properties: + subscriptionId: + type: string + producerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + producerSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + nwdaFevSub: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/NnwdaFEventsSubscription' + allOf: + - oneOf: + - required: [producerId] + - required: [producerSetId] + - required: [subscriptionId] + - required: [nwdaFevSub] + +RequestedContext: + description: Contains types of analytics context information. + type: object + properties: + contexts: + type: array + items: + $ref: '#/components/schemas/ContextType' + minItems: 1 + description: List of analytics context types. + required: + - contexts + +SmcceInfo: + description: Represents the Session Management congestion control experience information. + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + smcceUeList: + $ref: '#/components/schemas/SmcceUeList' + required: + - smcceUeList + +SmcceUeList: + description: > + Represents the List of UEs classified based on experience level of Session Management + congestion control. + type: object + properties: + highLevel: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + mediumLevel: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + lowLevel: + type: array +``` + +``` + + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + anyOf: + - required: [highLevel] + - required: [mediumLevel] + - required: [lowLevel] + +SpecificDataSubscription: + description: > + Represents an existing subscription for data collection to a specific data source NF. + type: object + properties: + subscriptionId: + type: string + producerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + producerSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + dataSub: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSubscription' + allOf: + - oneOf: + - required: [producerId] + - required: [producerSetId] + - required: [subscriptionId] + - required: [dataSub] + +UserDataCongestReq: + description: > + Represents a user data congestion requirement. + type: object + properties: + orderCriterion: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/UserDataConOrderCrit' + orderDirection: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/MatchingDirection' + +ResourceUsageRequPerNwPerfType: + description: More requirement for each network performance type. + type: object + properties: + nwPerfType: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NetworkPerfType' + rscUsgReq: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ResourceUsageRequirement' + required: + - nwPerfType + +# +# ENUMERATIONS DATA TYPES +# +EventId: + anyOf: + - type: string + enum: + - LOAD_LEVEL_INFORMATION + - NETWORK_PERFORMANCE + - NF_LOAD + - SERVICE_EXPERIENCE + - UE_MOBILITY + - UE_COMMUNICATION + - QOS_SUSTAINABILITY + - ABNORMAL_BEHAVIOUR + - USER_DATA_CONGESTION + - NSI_LOAD_LEVEL + - SM_CONGESTION + - DISPERSION + - RED_TRANS_EXP + - WLAN_PERFORMANCE + - DN_PERFORMANCE + - PFD_DETERMINATION + - PDU_SESSION_TRAFFIC + - E2E_DATA_VOL_TRANS_TIME + - MOVEMENT_BEHAVIOUR + - LOC_ACCURACY + - RELATIVE_PROXIMITY + +``` + +``` +- type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Represents the analytics type. + Possible values are: + - LOAD_LEVEL_INFORMATION: Represent the analytics of load level information of corresponding + network slice. + - NETWORK_PERFORMANCE: Represent the analytics of network performance information. + - NF_LOAD: Indicates that the event subscribed is NF Load. + - SERVICE_EXPERIENCE: Represent the analytics of service experience information of the + specific applications. + - UE_MOBILITY: Represent the analytics of UE mobility. + - UE_COMMUNICATION: Represent the analytics of UE communication. + - QOS_SUSTAINABILITY: Represent the analytics of QoS sustainability information in the + certain area. + - ABNORMAL_BEHAVIOUR: Indicates that the event subscribed is abnormal behaviour information. + - USER_DATA_CONGESTION: Represent the analytics of the user data congestion in the certain + area. + - NSI_LOAD_LEVEL: Represent the analytics of Network Slice and the optionally associated + Network Slice Instance. + - SM_CONGESTION: Represent the analytics of Session Management congestion control experience + information for specific DNN and/or S-NSSAI. + - DISPERSION: Represents the analytics of dispersion. + - RED_TRANS_EXP: Represents the analytics of Redundant Transmission Experience. + - WLAN_PERFORMANCE: Represents the analytics of WLAN performance. + - DN_PERFORMANCE: Represents the analytics of DN performance. + - PFD_DETERMINATION: Represents the analytics of PFD Determination information for known + application identifier(s). + - PDU_SESSION_TRAFFIC: Represents the analytics of PDU Session traffic. + - E2E_DATA_VOL_TRANS_TIME: Represents the analytics of E2E data volume transfer time. + - MOVEMENT_BEHAVIOUR: Represents the analytics of the Movement Behaviour information. + - LOC_ACCURACY: Represents the analytics of location accuracy. + - RELATIVE_PROXIMITY: Represents the analytics of Relative Proximity information. + +ContextType: + anyOf: + - type: string + enum: + - PENDING_ANALYTICS + - HISTORICAL_ANALYTICS + - AGGR_SUBS + - DATA + - AGGR_INFO + - ML_MODELS + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Represents the analytics context information type. + Possible values are: + - PENDING_ANALYTICS: Represents context information that relates to pending output + analytics. + - HISTORICAL_ANALYTICS: Represents context information that relates to historical output + analytics. + - AGGR_SUBS: Represents context information about the analytics subscriptions that an NWDAF + has with other NWDAFs that collectively serve an analytics subscription. + - DATA: Represents context information about historical data that is available. + - AGGR_INFO: Represents context information that is related to aggregation of analytics + from multiple NWDAF subscriptions. + - ML_MODELS: Represents context information about used ML models. + +AdrfDataType: + anyOf: + - type: string + enum: + - HISTORICAL_ANALYTICS + - HISTORICAL_DATA + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +``` + +``` + +description: | + Represents a type of data that is stored in the ADRF. + Possible values are: + - HISTORICAL_ANALYTICS: Indicates that historical analytics are stored in the ADRF. + - HISTORICAL_DATA: Indicates that historical data are stored in the ADRF. + +``` + +## A.4 Nnwdaf\_DataManagement API + +``` + +openapi: 3.0.0 +info: + title: Nnwdaf_DataManagement + version: 1.1.0-alpha.4 + description: | + Nnwdaf_DataManagement API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/' + servers: + - url: '{apiRoot}/nnwdaf-datamanagement/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-datamanagement + paths: + /subscriptions: + post: + summary: subscribe to notifications + operationId: CreateIndividualSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafDataManagementSubsc' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafDataManagementSubsc' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaf-datamanagement//subscriptions/{subId}. + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{ $request.body#/notificURI }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafDataManagementNotif' + responses: + '200': + description: The notification is acknowledged and a planned action is provided. + content: + application/json: + schema: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/NotifResponse' + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + Fetch: + '{ $request.body#/fetchInstruct/fetchUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + type: string + minItems: 1 + description: Indicate the fetch correlation identifier. + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafDataManagementNotif' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/subscriptions/{subscriptionId}: + put: + summary: Update an existing Individual NWDAF Data Subscription. + operationId: UpdateNWDAFDataSubscription + tags: + - Individual NWDAF Data Management Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafDataManagementSubsc' + parameters: + - name: subscriptionId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource was successfully modified and representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafDataManagementSubsc' + '204': + description: No Content. Resource was successfully modified + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: unsubscribe from notifications + operationId: DeleteNWDAFDataSubscription + tags: + - Individual NWDAF Data Management Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '200': + description: > + Resource was successfully deleted and including the stored unsent events in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafDataManagementNotif' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnwdaf-datamanagement: Access to the Nnwdaf_DataManagement API +schemas: + NnwdafDataManagementSubsc: + description: Represents an Individual NWDAF Data Management Subscription resource. + type: object + properties: + adrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + adrfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + anaSub: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription' + dataCollectPurposes: + type: array + items: + $ref: 'TS29574_Ndccb_DataManagement.yaml#/components/schemas/DataCollectionPurpose' + minItems: 1 + description: > + The purposes of data collection. This attribute may only be provided if user consent + is required depending on local policy and regulations and the consumer has + not checked user consent. + checkedConsentInd: + +``` + +``` +type: boolean +description: Indication that the NF service consumer has already checked the user consent. +dataSub: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSubscription' +formatInstruct: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/FormattingInstruction' +notifCorrId: + type: string + description: Notification correlation identifier. +notifURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +notifEndpoints: + type: array + items: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/NotifyEndpoint' + minItems: 1 + description: The information of notification endpoints. +procInstruct: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/ProcessingInstruction' +multiProcInstructs: + type: array + items: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/ProcessingInstruction' + minItems: 1 + description: Processing instructions to be used for sending event notifications. +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +targetNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +targetNfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +timePeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' +immReport: + $ref: '#/components/schemas/NnwdafDataManagementNotif' +storeHandl: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/StorageHandlingInformation' +required: +- notifCorrId +- notifURI +oneOf: +- required: [anaSub] +- required: [dataSub] +NnwdafDataManagementNotif: +description: Represents an Individual Notification. +type: object +properties: + dataNotification: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataNotification' + dataReports: + type: array + items: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/NotifSummaryReport' + minItems: 1 + description: List of summary reports of processed notifications. + delAlert: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/DeletionAlert' + notifCorrId: + type: string + description: Notification correlation identifier. + terminationReq: + type: string + description: > + It indicates that the termination of the data management subscription + is requested by the NWDAF. + fetchInstruct: + $ref: 'TS29576_Nmfa_3caDataManagement.yaml#/components/schemas/FetchInstruction' + notifTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + pendNotifCause: + $ref: '#/components/schemas/PendingNotificationCause' +required: +- notifCorrId +- notifTimestamp +oneOf: +- required: [dataNotification] +- required: [dataReports] +- required: [fetchInstruct] +``` + +``` + +# +# ENUMERATIONS DATA TYPES +# + PendingNotificationCause: + anyOf: + - type: string + enum: + - UE_OUT_OF_NF_SERVING_AREA + - OTHER + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration but + is not used to encode content defined in the present version of this API. + description: | + Represents the Pending Notification Cause for the stored unsent data. + Possible values are: + - UE_OUT_OF_NF_SERVING_AREA: The UE moved out of the NF serving area. + - OTHER: Other cause. + +``` + +## A.5 Nnwdaf\_MLModelProvision API + +openapi: 3.0.0 + +``` + +info: + title: Nnwdaf_MLModelProvision + version: 1.1.0-alpha.5 + description: | + Nnwdaf_MLModelProvision API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ + +servers: +- url: '{apiRoot}/nnwdaf-mlmodelprovision/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: +- {} +- oAuth2ClientCredentials: +- nnwdaf-mlmodelprovision + +paths: +/subscriptions: + post: + summary: Create a new Individual NWDAF ML Model Provision Subscription resource. + operationId: CreateNWDAFMLModelProvisionSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelProvSubsc' + responses: + '201': + description: Create a new Individual NWDAF ML Model Provision Subscription resource. + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelProvSubsc' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaf-mlmodelprovision/v1/subscriptions/{subscriptionId}. + required: true + +``` + +``` + + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{ $request.body#/notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NwdaFModelProvNotif' + minItems: 1 + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + put: + summary: update an existing Individual NWDAF ML Model Provision Subscription + operationId: UpdateNWDAFMLModelProvisionSubscription + tags: + - Individual NWDAF ML Model Provision Subscription (Document) + requestBody: + required: true + +``` + +``` +content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelProvSubsc' +parameters: +- name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelProvision Service. + required: true + schema: + type: string +responses: +'200': + description: > + The Individual NWDAF ML Model Provision Subscription resource was modified successfully + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelProvSubsc' +'204': + description: > + The Individual NWDAF ML Model Provision Subscription resource was modified successfully. +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an existing Individual NWDAF ML Model Provision Subscription. + operationId: DeleteNWDAFMLModelProvisionSubscription + tags: + - Individual NWDAF ML Model Provision Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelProvision Service. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF ML Model Provision Subscription matching the + subscriptionId was deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +``` + +``` + + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnwda-mlmodelprovision: Access to the Nnwdaf_MLModelProvision API + +schemas: + NwdafMLModelProvSubsc: + description: Represents NWDAF Event Subscription resources. + type: object + properties: + mLEventSubscs: + type: array + items: + $ref: '#/components/schemas/MLEventSubscription' + minItems: 1 + description: Subscribed events + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + mLEventNotifs: + type: array + items: + $ref: '#/components/schemas/MLEventNotif' + minItems: 1 + description: > + Notifications about Individual Events. Shall only be present if the immediate reporting + indication in the "immRep" attribute within the "eventReq" attribute sets to true in the + event subscription, and the reports are available. + suppFeats: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + notifCorreId: + type: string + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + failEventReports: + type: array + items: + $ref: '#/components/schemas/FailureEventInfoForMLModel' + minItems: 1 + description: > + Supplied by the NWDAF containing MTLF when available, shall contain the event(s) that + the subscription is not successful including the failure reason(s). + required: + - mLEventSubscs + - notifUri + +ModelProvisionParamsExt: + description: > + Extended parameters for ML model provisioning which can optionally be set by a service + consumer NF. + type: object + properties: + reqRepRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + inferInpDataInfos: + type: array + items: + $ref: '#/components/schemas/InputDataInfo' + minItems: 1 + description: > + Inference information that is used by NWDAF containing AnLF during inference. + +``` + +``` +multModelsInd: + type: boolean + description: Indicates if the NF service consumer supports multiple models. +numModels: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +accuLevels: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/Accuracy' + minItems: 1 + description: > + Provided accuracy levels of interest for ML models. + +InputDataInfo: + description: Contains information about inference that is used by NWDAF containing AnLF. + type: object + properties: + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + maxNumSamples: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + maxTimeInterval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + inpEvent: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/DccfEvent' + nfInstanceIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + nfSetIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + required: + - inpEvent + +MLEventSubscription: + description: Represents a subscription to a single event. + type: object + properties: + mLEvent: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + mLEventFilter: + $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventFilter' + tgtUe: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/TargetUeInformation' + mLTargetPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + expiryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeModelNeeded: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + mLEvRepCon: + $ref: '#/components/schemas/MLRepEventCondition' + modelInterInfo: + type: string + description: String representing the ML Model Interoperability Information. + nfConsumerInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorId' + modelProvExt: + $ref: '#/components/schemas/ModelProvisionParamsExt' + description: > + Extended ML model parameters that a service consumer optionally sets when subscribing to + an ML model to be provisioned. + useCaseCxt: + type: string + description: > + Indicates the context of usage of the analytics. The value and format of this parameter + are not standardized. + inferDataForModel: + $ref: '#/components/schemas/InferenceDataForModelTrain' + required: + - mLEvent + - mLEventFilter +``` + +``` +NwdafMLModelProvNotif: + description: Represents notifications on events that occurred. + type: object + properties: + eventNotifs: + type: array + items: + $ref: '#/components/schemas/MLEventNotif' + minItems: 1 + description: Notifications about Individual Events. + subscriptionId: + type: string + description: String identifying a subscription to the Nnwdaf_MLModelProvision Service. + required: + - eventNotifs + - subscriptionId + +MLEventNotif: + description: Represents a notification related to a single event that occurred. + type: object + properties: + event: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + notifCorreId: + type: string + description: > + Contains notification correlation ID used to identify the subscription to which the + notification relates. It shall be set to the same value as the "notifCorreId" attribute + of NwdafMLModelProvSubsc data type. + mlFile: + type: string + description: Contains the ML model file. + mlFileAddr: + $ref: '#/components/schemas/MLModelAddr' + mlModelAdrf: + $ref: '#/components/schemas/MLModelAdrf' + validityPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + spatialValidity: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + addModelInfo: + type: array + items: + $ref: '#/components/schemas/AdditionalMLModelInformation' + minItems: 1 + description: Contains the additional ML Model Information besides the ML Model Address + allOf: + - required: [event] + - oneOf: + - required: [mlFileAddr] + - required: [mlModelAdrf] + +FailureEventInfoForMLModel: + description: > + Represents the event(s) that the subscription is not successful including the failure + reason(s). + type: object + properties: + event: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + failureCode: + $ref: '#/components/schemas/FailureCode' + required: + - event + - failureCode + +MLModelAddr: + description: Addresses of ML model files. + type: object + properties: + mlModelUrl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + mlFileFqdn: + type: string + description: The FQDN of the ML Model file. + oneOf: + - required: [mlModelUrl] + - required: [mlFileFqdn] +``` + +``` +MLRepEventCondition: + description: Indicates the ML event reporting condition. + type: object + properties: + mlTrainRound: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + mlTrainRepTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + mlAccuracyThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + modelMetric: + $ref: '#/components/schemas/MLModelMetric' + +AdditionalMLModelInformation: + description: Represents the additional ML Model Information. + type: object + properties: + mlFileAddr: + $ref: '#/components/schemas/MLModelAddr' + mlModelAdrf: + $ref: '#/components/schemas/MLModelAdrf' + validityPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + spatialValidity: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + modelUniqueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + description: Unique identifier for an ML model. + modelRepRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + description: > + Minimum percentage of UEs whose data is used for training an ML model. + mlDegradInd: + type: boolean + description: > + Set to "true" to indicate support degradation of an ML model. Set to "false" to indicate + not support degradation of an ML model. Default value is "false" if omitted. + trainInpInfos: + type: array + items: + $ref: '#/components/schemas/TrainInputDataInfo' + minItems: 1 + description: > + Training information that is used by NWDAF containing MTLF during training. + modelMetric: + $ref: '#/components/schemas/MLModelMetric' + accMLModel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +MLModelAdrf: + description: ADRF (Set) information of the ML Model. + type: object + properties: + adrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + adrfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + storTransId: + type: string + description: String identifying a Storage Transaction ID. + oneOf: + - required: [adrfId] + - required: [adrfSetId] + +TrainInputDataInfo: + description: Contains Training input data information that is used by NWDAF containing MTLF. + type: object + properties: + dataInfo: + $ref: '#/components/schemas/InputDataInfo' + time: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dataStatisticsInfos: + type: string +``` + +``` + +InferenceDataForModelTrain: + description: > + Indicates the inference data stored in ADRF which can be used by MTLF to retrain or + reprovision of the ML model. + type: object + properties: + adrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + adrfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + dataSetTag: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSetTag' + modelId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + oneOf: + - required: [adrfId] + - required: [adrfSetId] + +# +# ENUMERATIONS DATA TYPES +# + +FailureCode: + anyOf: + - type: string + enum: + - UNAVAILABLE_ML_MODEL + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration but + is not used to encode content defined in the present version of this API. + description: | + Represents the failure code. + Possible values are: + - UNAVAILABLE_ML_MODEL: Indicates the requested ML model for the event is unavailable. + +MLModelMetric: + anyOf: + - type: string + enum: + - ACCURACY + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration but + is not used to encode content defined in the present version of this API. + description: | + Represents the metric of the ML model. + Possible values are: + - ACCURACY: ML Model Accuracy metric. + +``` + +## A.6 Nnwdaf\_MLModelTraining API + +openapi: 3.0.0 + +``` + +info: + title: Nnwdaf_MLModelTraining + version: 1.0.0-alpha.3 + description: | + Nnwdaf_MLModelTraining API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ + +``` + +``` + +servers: + - url: '{apiRoot}/nnwdaf-mlmodeltraining/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +``` + +``` + +security: + - {} + - oAuth2ClientCredentials: + +``` + +``` + +- nnwda-mlmodeltraining + +paths: + /subscriptions: + post: + summary: Create a new Individual NWDAF ML Model Training Subscription resource. + operationId: CreateNWDAFMLModelTrainingSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelTrainSubsc' + responses: + '201': + description: Create a new Individual NWDAF ML Model Training Subscription resource. + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelTrainSubsc' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwda-mlmodeltraining/v1/subscriptions/{subscriptionId}. + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{ $request.body#/notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NwdafMLModelTrainNotif' + minItems: 1 + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + +``` + +``` + + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/subscriptions/{subscriptionId}: + put: + summary: update an existing Individual NWDAF ML Model Training Subscription + operationId: UpdateNWDAFMLModelTrainingSubscription + tags: + - Individual NWDAF ML Model Training Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelTrainSubsc' + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelTraining Service. + required: true + schema: + type: string + responses: + '200': + description: > + The Individual NWDAF ML Model Training Subscription resource was modified successfully + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelTrainSubsc' + '204': + description: > + The Individual NWDAF ML Model Training Subscription resource was modified successfully. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: partial update an existing Individual NWDAF ML Model Training Subscription + operationId: PartialUpdateNWDAFMLModelTrainingSubscription + tags: + - Individual NWDAF ML Model Training Subscription (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/NwdafMLModelTrainSubscPatch' + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelTraining Service. + required: true + schema: + type: string + responses: + '200': + description: > + The Individual NWDAF ML Model Training Subscription resource was partial modified + successfully and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelTrainSubsc' + '204': + description: > + The Individual NWDAF ML Model Training Subscription resource was partial modified + successfully. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an existing Individual NWDAF ML Model Training Subscription. + operationId: DeleteNWDAFMLModelTrainingSubscription + tags: + - Individual NWDAF ML Model Training Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelTraining Service. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF ML Model Training Subscription matching the + subscriptionId was deleted. + '307': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnwdaif-mlmodeltraining: Access to the Nnwdaif_MLModelTraining API + +schemas: + NwdaifMLModelTrainSubsc: + description: Represents a ML Model Training subscription. + type: object + properties: + mLEventSubscs: + type: array + items: + $ref: 'TS29520_Nnwdaif_MLModelProvision.yaml#/components/schemas/MLEventSubscription' + minItems: 1 + description: Subscribed events + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + suppFeats: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + failEventReports: + type: array + items: + $ref: '#/components/schemas/FailureEventInfoForMLModelTrain' + minItems: 1 + description: > + Supplied by the NWDAF containing MTTF when available, shall contain the event(s) that + the subscription is not successful including the failure reason(s). + mlCorreId: + type: string + description: String identifying the subscription is for a Federated Learning procedure. + mLModelInfos: + type: array + items: + $ref: 'TS29520_Nnwdaif_MLModelProvision.yaml#/components/schemas/MLEventNotif' + minItems: 1 + description: Represents the ML Model information. + immReports: + type: array + items: + $ref: '#/components/schemas/NwdaifMLModelTrainNotif' + minItems: 1 + description: Immediately reported ML Model Training notifications. + mLModelTrainInfos: + type: array + items: + $ref: '#/components/schemas/MLModelTrainInfo' + minItems: 1 + description: Represents the ML Model training information. +``` + +``` + mLPreFlag: + type: boolean + description: > + Indicates whether the subscription is for preparation of ML Model training. Set to + "true" if it is for ML training preparation, otherwise set to "false". + mLAccChkFlg: + type: boolean + description: > + Indicates whether request using the local training data as the testing dataset to + calculate the Model Accuracy of the global ML model provided by the consumer. Set to + "true" if it is requested, otherwise set to "false". + mLTrainRepInfo: + $ref: '#/components/schemas/MLTrainReportInfo' + notifCorreId: + type: string + description: > + String identifying the Notification Correlation ID in the corresponding notification. + roundInd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + tgtRepUe: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/TargetUeInformation' + uCaseCont: + type: string + description: > + String identifying the use case context of the ML model. The value and format of this + parameter is not standardized. + required: + - mLEventSubscs + - notifUri + - notifCorreId + +NnwdafMLModelTrainSubscPatch: + description: > + Represents parameters to request the modification of a ML Model Training subscription. + type: object + properties: + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + mLModelInfos: + type: array + items: + $ref: 'TS29520_Nnwdaf_MLModelProvision.yaml#/components/schemas/MLEventNotif' + minItems: 1 + description: Represents the ML Model information. + mLModelTrainInfos: + type: array + items: + $ref: '#/components/schemas/MLModelTrainInfo' + minItems: 1 + description: Represents the ML Model training information. + mLPreFlag: + type: boolean + description: > + Indicates whether the subscription is for preparation of ML Model training. Set to + "true" if it is for ML training preparation, otherwise set to "false". + mLAccChkFlg: + type: boolean + description: > + Indicates whether request using the local training data as the testing dataset to + Calculate the Model Accuracy of the global ML model provided by the consumer. Set to + "true" if it is requested, otherwise set to "false". + mLTrainRepInfo: + $ref: '#/components/schemas/MLTrainReportInfo' + roundInd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + tgtRepUe: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/TargetUeInformation' + uCaseCont: + type: string + description: > + String identifying the use case context of the ML model. The value and format of this + parameter are not standardized. + +NnwdafMLModelTrainNotif: + description: Represents notifications on events that occurred. + type: object +``` + +``` + +properties: + delayEventNotif: + $ref: '#/components/schemas/DelayEventNotif' + mlCorreId: + type: string + description: String identifying the subscription is for a Federated Learning procedure. + mLModelInfos: + type: array + items: + $ref: 'TS29520_Nnwdaf_MLModelProvision.yaml#/components/schemas/MLEventNotif' + minItems: 1 + description: Represents the ML Model information. + notifCorreId: + type: string + description: > + String identifying the Notification Correlation ID in the corresponding notification. + roundInd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + statusReport: + $ref: '#/components/schemas/StatusReportInfo' + termTrainReq: + $ref: '#/components/schemas/TermTrainCause' + uCaseCont: + type: string + description: > + String identifying the context of use of ML model. The value and format of this + parameter are not standardized. +required: +- notifCorreId +oneOf: +- required: [delayEventNotif] +- required: [mLModelInfos] +- required: [termTrainReq] +- required: [mLModelInfos, termTrainReq] + +MLModelTrainInfo: +description: > + Represents the ML Model training information, include requirement on data availability and + time availability, training filter information. +type: object +properties: + dataAvReq: + $ref: '#/components/schemas/DataAvReq' + timeAvReq: + type: string + description: > + String representing the requirement on available time for the ML model training. + +MLTrainReportInfo: +description: Represents the ML Model training reporting information. +type: object +properties: + maxResTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +FailureEventInfoForMLModelTrain: +description: Represents the failure event information for a ML Model Training subscription. +type: object +properties: + mLTrainEvent: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEvent' + failureCodeTrain: + $ref: '#/components/schemas/FailureCodeTrain' +required: +- mLTrainEvent +- failureCodeTrain + +DataAvReq: +description: Represents the requirement on available data for the ML model training. +type: object +properties: + dataStatProps: + type: array + items: + $ref: + 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DatasetStatisticalProperty' + minItems: 1 + inpEvents: + +``` + +``` + + type: array + items: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/DccfEvent' + minItems: 1 + minNumSamples: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + timeWindows: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + minItems: 1 + required: + - inpEvents + +DelayEventNotif: + description: > + Indicating that the NWDAF containing MTTF is not able to complete the training of ML model + within the maximum response time, the cause code, and the expected time complete the + training. + type: object + properties: + delayEventInd: + type: boolean + description: > + Indicates that the NWDAF containing MTTF is not able to complete the training of ML + model within the maximum response time. Set to "true" if not able to complete the ML + model training on time, otherwise set to "false". + delayCause: + $ref: '#/components/schemas/DelayCause' + expCompTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + required: + - delayEventInd + +StatusReportInfo: + description: > + Indicating status information generated by the NWDAF containing MTTF during ML model + training. + type: object + properties: + mlModelAcc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + trainInDataInfo: + $ref: '#/components/schemas/TrainDataInfo' + +TrainDataInfo: + description: Represents the training input data information. + type: object + properties: + areaDataSet: + type: string + description: Indicates the areas covered by the data set. + maxValues: + type: array + items: + type: string + minItems: 1 + description: Represents the maximum value of one dimension of data. + minValues: + type: array + items: + type: string + minItems: 1 + description: Represents the minimum value of one dimension of data. + samplRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +# +# ENUMERATIONS DATA TYPES +# +FailureCodeTrain: + anyOf: + - type: string + enum: + - UNAVAILABLE_ML_MODEL_TRAIN + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration but + +``` + +``` + + is not used to encode content defined in the present version of this API. + description: | + Represents the failure reason. + Possible values are: + - UNAVAILABLE_ML_MODEL_TRAIN: The ML model training is unavailable. + +TermTrainCause: + anyOf: + - type: string + enum: + - NWDAF_OVERLOAD + - NOT_AVAILABLE_ML_TRAIN + - OTHERS + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration but + is not used to encode content defined in the present version of this API. + description: | + Represents the reasons that ML Model Training to be terminated. + Possible values are: + - NWDAF_OVERLOAD: The NWDAF is overloaded for the ML model training. + - NOT_AVAILABLE_ML_TRAIN: The ML model training process is not available. + - OTHERS: Other cause. + +DelayCause: + anyOf: + - type: string + enum: + - ML_MODEL_TRAIN_FAILURE + - NEED_MORE_TIME + - OTHERS + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration but + is not used to encode content defined in the present version of this API. + description: | + Represents the reasons for ML Model training delay. + Possible values are: + - ML_MODEL_TRAIN_FAILURE: The ML model training is failure. + - NEED_MORE_TIME: The ML model training needs more time. + - OTHERS: Other cause. + +``` + +## A.7 Nnwdaf\_ MLModelMonitor API + +openapi: 3.0.0 + +``` + +info: + title: Nnwdaf_ MLModelMonitor + version: 1.0.0-alpha.1 + description: | + Nnwdaf_ MLModelMonitor API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ + +servers: + - url: '{apiRoot}/nnwdaf-mlmodelmonitor/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-mlmodelmonitor + +paths: + /registrations: + post: + summary: Create a new Individual NWDAF ML Model monitoring registration resource. + operationId: CreateNWDAFMLModelMonitoringRegistration + +``` + +``` + +tags: + - registrations (Collection) +requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorReg' +responses: + '201': + description: Create a new Individual NWDAF ML Model monitoring registration resource. + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorReg' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaF-mlmodelmonitor//registrations/{registrationId}. + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/registrations/{registrationId}: + delete: + summary: Delete an existing Individual NWDAF ML model monitoring registration. + operationId: DeleteNWDAFMLModelMonitoringRegistration + tags: + - Individual NWDAF ML model monitoring registration (Document) + parameters: + - name: registrationId + in: path + description: String identifying a registration to the NnwdaF_MLModelMonitor Service. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF ML Model monitoring registration matching the + registrationId was deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + +``` + +``` + + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions: + post: + summary: Create a new Individual NWDAF ML model monitoring Subscription. + operationId: CreateNWDAFMLModelMonitoringSubscription + tags: + - NWDAF ML model monitoring Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorSub' + responses: + '201': + description: Create a new Individual NWDAF ML model monitoring Subscription resource. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId} + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorSub' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{ $request.body#/notificationUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MLModelMonitorNotify' + minItems: 1 + responses: + '204': + description: The receipt of the Notification is acknowledged. + +``` + +``` + + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + put: + summary: Update an existing Individual NWDAF ML model monitoring Subscription resource. + operationId: UpdateNWDAFMLModelMonitoringSubscription + tags: + - Individual NWDAF ML model monitoring Subscription resource (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorSub' + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelMonitor Service. + required: true + schema: + type: string + responses: + '200': + description: > + The Individual NWDAF ML model monitoring Subscription resource was modified successfully + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorSub' + '204': + description: > + The Individual NWDAF ML model monitoring Subscription resource was modified + successfully. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an existing Individual NWDAF ML model monitoring Subscription. + operationId: DeleteNWDAFMLModelMonitoringSubscription + tags: + - Individual NWDAF ML model monitoring Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelMonitor Service + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF ML model monitoring Subscription resource matching the + subscriptionId was deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnwdaf-mlmodelmonitor: Access to the Nnwdaf_MLModelMonitor API + +schemas: + MLModelMonitorReg: + description: Represents a ML Model monitoring registration. + type: object + properties: + consumerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + consumerSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + modelId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + modelAccuInd: + type: boolean + +``` + +``` + description: > + Indicates the ML Model accuracy transfer indication. Set to "true" to indicate that the + monitoring of the accuracy of the ML model is supported, otherwise set to "false". + Default value is "false" if omitted. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - modelId + oneOf: + - required: [consumerId] + - required: [consumerSetId] + +MLModelMonitorSub: + description: > + Represents parameters to request the modification of a ML Model monitoring registration. + type: object + properties: + modelIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 + description: Represents the ML Model IDs. + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + modelMetric: + $ref: 'TS29520_Nnwdaif_MLModelProvision.yaml#/components/schemas/MLModelMetric' + accuThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + eventReportReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + immReports: + $ref: '#/components/schemas/MLModelMonitorNotify' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - modelIds + - notificationUri + - notifCorrId + +MLModelMonitorNotify: + description: Represents notifications on events that occurred. + type: object + properties: + notifCorrId: + type: string + description: Notification correlation identifier. + modelAccuInfos: + type: array + items: + $ref: '#/components/schemas/MLModelAccuracyInfo' + minItems: 1 + description: The accuracy related information of the ML model. + anaFeedbacks: + type: array + items: + $ref: '#/components/schemas/AnalyticsFeedback' + minItems: 1 + description: The analytics feedback information. + validPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + required: + - notifCorrId + anyOf: + - required: [modelAccuInfos] + - required: [anaFeedbacks] + +MLModelAccuracyInfo: + description: Represents the ML Model accuracy information. + type: object + properties: + modelId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + deviation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' +``` + +``` + +inferenceNum: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +adrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +adrfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +dataSetTag: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSetTag' +modelMetric: + $ref: 'TS29520_Nnwdaf_ModelProvision.yaml#/components/schemas/MLModelMetric' +required: +- modelId + +AnalyticsFeedback: + description: Represents the analytics feedback. + type: object + properties: + events: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEvent' + minItems: 1 + description: Indicates the Analytics IDs that were used to take this action. + modelIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 + description: Indicates the ML Model identifier that were used to take this action. + groundDataImpactInd: + type: boolean + description: > + Indication whether the action will affect on ground truth data. Set to "true" to + indicate that the action will affect on ground truth data. Otherwise set to "false", + default value is "false" if omitted. + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - events + - modelIds + +``` + +## A.8 Nnwdaf\_RoamingData API + +openapi: 3.0.0 + +``` + +info: + title: Nnwdaf_RoamingData + version: 1.0.0-alpha.1 + description: | + Nnwdaf_RoamingData API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` + +externalDocs: + description: 3GPP TS 29.520 V18.3.0; 5G System; Network Data Analytics Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ + +``` + +``` + +servers: +- url: '{apiRoot}/nnwdaf-roamingdata/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +``` + +``` + +security: +- {} +- oAuth2ClientCredentials: + - nnwdaf-roamingdata + +``` + +``` + +paths: + /subscriptions: + post: + summary: Create a new Individual NWDAF Roaming Data Subscription + operationId: CreateNWDAFRoamingDataSubscription + tags: + +``` + +``` + +- NWDAF Roaming Data Subscriptions (Collection) +requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingDataSub' +responses: + '201': + description: Create a new Individual NWDAF Roaming Data Subscription resource. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaf-roamingdata//subscriptions/{subscriptionId} + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingDataSub' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + myNotification: + '{ $request.body#/notificationUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: 'TS29520_Nnwdaf_DataManagement.yaml#/components/schemas/NnwdafDataManagementNotif' + minItems: 1 +responses: + '204': + description: The receipt of the Notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + put: + summary: Update an existing Individual NWDAF Roaming Data Subscription resource. + operationId: UpdateNWDAFRoamingDataSubscription + tags: + - Individual NWDAF Roaming Data Subscription resource (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingDataSub' + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_RoamingData Service. + required: true + schema: + type: string + responses: + '200': + description: > + The Individual NWDAF Roaming Data Subscription resource was modified successfully + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingDataSub' + '204': + description: > + The Individual NWDAF Roaming Data Subscription resource was modified successfully. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + delete: + summary: Delete an existing Individual NWDAF Roaming Data Subscription. + operationId: DeleteNWDAFRoamingDataSubscription + +``` + +``` +tags: + - Individual NWDAF Roaming Data Subscription (Document) +parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_RoamingData Service + required: true + schema: + type: string +responses: + '204': + description: > + No Content. The Individual NWDAF Roaming Data Subscription resource matching the + subscriptionId was deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnwdaf-roamingdata: Access to the Nnwdaf_RoamingData API + +schemas: + RoamingDataSub: + description: > + Represents roaming data subscription information. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + dataSub: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSubscription' + anaSub: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription' + formatInstruct: + $ref: 'TS29574_Ndccb_DataManagement.yaml#/components/schemas/FormattingInstruction' + procInstructs: + type: array + items: + $ref: 'TS29574_Ndccb_DataManagement.yaml#/components/schemas/ProcessingInstruction' + minItems: 1 + description: Processing instructions to be used for sending event notifications. + timePeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + targetNfId: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + targetNfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + immReport: + $ref: 'TS29520_Nnwdaf_DataManagement.yaml#/components/schemas/NnwdafDataManagementNotif' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - notificationUri + - notifCorrId + - plmnId + oneOf: + - required: [anaSub] + - required: [dataSub] + +``` + +## A.9 Nnwdaf\_RoamingAnalytics API + +openapi: 3.0.0 + +``` + +info: + title: Nnwdaf_RoamingAnalytics + version: 1.0.0-alpha.1 + description: | + Nnwdaf_RoamingAnalytics API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ + +servers: +- url: '{apiRoot}/nnwdaf-roaminganalytics/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: +- {} +- oAuth2ClientCredentials: + - nnwdaf-roaminganalytics + +paths: + /subscriptions: + post: + summary: Create a new Individual NWDAF Roaming Analytics Subscription + operationId: CreateNnwdafRoamingAnalyticsSubscription + tags: + - NWDAF Roaming Analytics Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingAnalyticsSubscription' + responses: + '201': + description: Create a new Individual Roaming Analytics Subscription resource. + headers: + Location: + description: > + Contains the URI of the newly created resource. + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingAnalyticsSubscription' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + +``` + +``` + + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RoamingAnalyticsNotification' + minItems: 1 + responses: + '204': + description: The receipt of the Notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + put: + summary: Update an existing Individual Roaming Analytics Subscription resource. + operationId: UpdateNwdaRoamingAnalyticsSubscription + tags: + - Individual NWDAF Roaming Analytics Subscription resource (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingAnalyticsSubscription' + parameters: + +``` + +``` +- name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_RoamingAnalytics service. + required: true + schema: + type: string +responses: + '200': + description: > + The Individual NWDAF Roaming Analytics Subscription resource was modified successfully + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingAnalyticsSubscription' + '204': + description: > + The Individual NWDAF Roaming Analytics Subscription resource was modified + successfully. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an existing Individual NWDAF Roaming Analytics Subscription. + operationId: DeleteNnwdafRoamingAnalyticsSubscription + tags: + - Individual NWDAF Roaming Analytics Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_RoamingAnalytics service + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF Roaming Analytics Subscription resource matching the + subscriptionId was deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +``` + +``` +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnwdaf-roaminganalytics: Access to the Nnwdaf_RoamingAnalytics API + +schemas: + RoamingAnalyticsSubscription: + description: Represents a Roaming Analytics subscription. + type: object + properties: + roamEventSubs: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventSubscription' + minItems: 1 + description: Represents Roaming Analytics subscription for a specific event. + evtReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + consPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + roamEventNotifs: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventNotification' + minItems: 1 + description: Contains immediate reports for Roaming Analytics. + failEventReports: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/FailureEventInfo' + minItems: 1 + description: Contains information about failed events. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - roamEventSubs + - notifUri + - notifCorrId + - consPlmnId + +RoamingAnalyticsNotification: + description: Represents a Roaming Analytics notification. + type: object + properties: + roamEventNotifs: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventNotification' + minItems: 1 + description: Contains Roaming Analytics notification for a specific event. + notifCorrId: + type: string + description: Notification correlation identifier. + termCause: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/TermCause' +``` + +``` +required: + - roamEventNotifs + - notifCorrId +``` + +--- + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | | | | | | TS skeleton of Network Data Analytics Services. | 0.0.0 | +| 2017-11 | CT3#92 | | | | | Inclusion of documents agreed in CT3#92 C3-175356. | 0.1.0 | +| 2017-12 | CT3#93 | | | | | Inclusion of documents agreed in CT3#93 C3-176166, C3-176260, C3-176324, C3-176325, C3-176326, and C3-176327. | 0.2.0 | +| 2018-01 | CT3#94 | | | | | Inclusion of documents agreed in CT3#94 C3-180252, C3-180253, C3-180254, C3-180255, C3-180256, C3-180257, C3-180344, C3-180345, C3-180346, C3-180323 and C3-180347. | 0.3.0 | +| 2018-03 | CT3#95 | | | | | Inclusion of documents agreed in CT3#95 C3-181253, C3-181255, C3-181256, C3-181257, C3-181260, C3-181312, C3-181342 and C3-181343. | 0.4.0 | +| 2018-03 | CT3#96 | | | | | Inclusion of documents agreed in CT3#96 C3-182379 and C3-182380. | 0.5.0 | +| 2018-05 | CT3#97 | | | | | Inclusion of documents agreed in CT3#97 C3-183285, C3-183532, C3-183533, C3-183534 and C3-183535. | 0.6.0 | +| 2018-06 | CT#80 | CP-181032 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181032 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 3 | F | Clarification on mandatory HTTP error status codes | 15.1.0 | +| 2018-09 | CT#81 | CP-182209 | 0002 | 4 | B | OpenAPI for TS 29.520 | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0003 | 1 | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | 1 | F | Resource structure presentation | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0006 | | F | Default value for apiRoot | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0007 | 2 | F | Correct Nnwdaf service | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0008 | 1 | F | Cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0009 | | F | API version | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0010 | | F | ExternalDocs OpenAPI field | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0011 | 1 | F | Security | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0012 | 1 | F | Supported content types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0013 | 2 | F | HTTP Error responses | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0014 | 2 | F | Correct NWDAF resource | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0016 | 1 | F | Adding HTTP status code "204 No Content" | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0019 | | F | Location header field in OpenAPI | 15.2.0 | +| 2019-03 | CT#83 | CP-190113 | 0020 | | F | Support of NSSF as the service consumer | 15.3.0 | +| 2019-03 | CT#83 | CP-190113 | 0021 | 1 | F | Formatting of structured data types in query | 15.3.0 | +| 2019-03 | CT#83 | CP-190113 | 0022 | | F | OpenAPI info version update | 15.3.0 | +| 2019-03 | CT#83 | CP-190213 | 0023 | 1 | F | Correction of Location header in Nnwdaf_EventsSubscription OpenAPI | 15.3.0 | +| 2019-06 | CT#84 | CP-191078 | 0024 | 1 | F | Correction of Nnwdaf_EventsSubscription OpenAPI | 15.4.0 | +| 2019-06 | CT#84 | CP-191078 | 0029 | 7 | F | Corrections on TS 29.520 | 15.4.0 | +| 2019-06 | CT#84 | CP-191078 | 0035 | 1 | F | Precedence of OpenAPI file | 15.4.0 | +| 2019-06 | CT#84 | CP-191078 | 0037 | 1 | F | Copyright Note in YAML files | 15.4.0 | +| 2019-06 | CT#84 | CP-191090 | 0025 | 1 | B | Reference update and service representation | 16.0.0 | +| 2019-06 | CT#84 | CP-191090 | 0027 | 3 | B | Support of more consumers | 16.0.0 | +| 2019-06 | CT#84 | CP-191090 | 0028 | 1 | B | Support of more analytic events | 16.0.0 | +| 2019-06 | CT#84 | CP-191225 | 0031 | 9 | B | Subscribing of service experience for the application | 16.0.0 | +| 2019-06 | CT#84 | CP-191090 | 0033 | 2 | B | Delete the subscription of service experience for the application | 16.0.0 | +| 2019-06 | CT#84 | CP-191090 | 0034 | 5 | B | Notification of service experience for the application | 16.0.0 | +| 2019-06 | CT#84 | CP-191090 | 0039 | 2 | F | Copyright Note in YAML files | 16.0.0 | +| 2019-09 | CT#85 | CP-192146 | 0041 | 2 | F | Correct cardinality in NnwdafEventsSubscription | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0042 | 4 | B | UE mobility and communication analytics | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0043 | 2 | B | Support of network performance analytics in Nnwdaf_AnalyticsInfo_Request | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0047 | 1 | B | OAM as service consumer | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0048 | 1 | B | Update Nnwdaf_EventSubscription service for service experience | 16.1.0 | +| 2019-09 | CT#85 | CP-192261 | 0049 | 1 | B | Enhance the Nnwdaf_AnalyticsInfo service to support service experience | 16.1.0 | +| 2019-09 | CT#85 | CP-192177 | 0050 | 2 | B | Enhance the Nnwdaf_EventsSubscription service to support QoS sustainability | 16.1.0 | +| 2019-09 | CT#85 | CP-192177 | 0051 | 2 | B | Enhance the Nnwdaf_AnalyticsInfo service to support QoS sustainability | 16.1.0 | +| 2019-09 | CT#85 | CP-192173 | 0054 | 2 | F | OpenAPI version update TS 29.520 Rel-16 | 16.1.0 | +| 2019-12 | CT#86 | CP-193198 | 0055 | 3 | B | Abnormal behaviour analytics | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0056 | 4 | B | Enhance the Nnwdaf_EventsSubscription service to support User Data Congestion | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0057 | 2 | B | Enhance the Nnwdaf_AnalyticsInfo service to support user data congestion | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0058 | 1 | B | Definination of QoS sustainability information | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0059 | 4 | B | Inclusion of QoS requirements and thresholds for QoS Sustainability | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0062 | 2 | F | Clarify references to QoS sustainability analytics | 16.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------|--------| +| 2019-12 | CT#86 | CP-193198 | 0063 | 2 | F | Clarifications on NWDAF generalities | 16.2.0 | +| 2019-12 | CT#86 | CP-193267 | 0102 | 3 | B | OpenAPI file Update for Nnwdaf_EventsSubscription API | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0103 | | B | OpenAPI file Update for Nnwdaf_AnalyticsInfo API | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0104 | 1 | B | Slice identification for all analytics types | 16.2.0 | +| 2019-12 | CT#86 | CP-193234 | 0106 | 2 | B | NF Load analytics generalities | 16.2.0 | +| 2019-12 | CT#86 | CP-193212 | 0107 | 1 | F | Update of API version and TS version in OpenAPI file | 16.2.0 | +| 2020-03 | CT#87e | CP-200208 | 0109 | 1 | B | Definition of QoS Requirement | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0110 | 1 | B | Description of consumer functionalities | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0111 | 1 | B | Update the types of analytics events | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0114 | | B | DNN Clarification | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0115 | 1 | F | Update Feature applicability for Rel-16 new data types | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0118 | 2 | D | Corrections in TS29.520 | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0120 | 1 | F | Clarify start time and end time | 16.3.0 | +| 2020-03 | CT#87e | CP-200182 | 0121 | 2 | F | Correct QoS sustainability | 16.3.0 | +| 2020-03 | CT#87e | CP-200232 | 0122 | 1 | F | Correct UE mobility and communication | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0123 | 1 | B | Support network performance analytics | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0124 | 1 | F | Correcting QoS sustainability information | 16.3.0 | +| 2020-03 | CT#87e | CP-200214 | 0125 | | F | OpenAPI: usage of the "tags" keyword | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0126 | 1 | F | Corrections on resource name | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0127 | 1 | F | Data used for area of interest | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0128 | 1 | F | Any UE possibility for UE mobility and UE communication | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0129 | 1 | B | Nnwdaf_EventsSubscription API, Support of Service experience | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0130 | 1 | B | Nnwdaf_EventsSubscription API, Support of Service experience | 16.3.0 | +| 2020-03 | CT#87e | CP-200236 | 0131 | 2 | B | Nnwdaf_EventsSubscription API, Support of abnormal behaviour | 16.3.0 | +| 2020-03 | CT#87e | CP-200224 | 0132 | 1 | B | Nnwdaf_AnalyticsInfo API, Support of abnormal behaviour | 16.3.0 | +| 2020-03 | CT#87e | CP-200228 | 0136 | 2 | B | Support of NF Load analytics | 16.3.0 | +| 2020-03 | CT#87e | CP-200216 | 0140 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-06 | CT#88e | CP-201234 | 0142 | 1 | F | Condition description for threshold related attributes | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0143 | 1 | F | Some corrections to Nnwdaf_AnalyticsInfo Service | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0144 | 1 | F | Clarification on applicability for network slice information | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0145 | 1 | F | Analytics result per DNN | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0146 | 3 | F | Maximum number of SUPIs | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0147 | 1 | F | Correction on FlowDescription | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0149 | 3 | F | Support of Abnormal Behaviour | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0150 | 2 | F | Confidence for User Data Congestion Information. | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0151 | 1 | F | Data types used for NWDAF services | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0153 | 2 | F | Adding maxObjectNbr attribute in related feature of NWDAF analytics service | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0154 | 1 | F | Adding UDM as consumer of services provided by NWDAF | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0155 | | F | Corrections on descriptions of NF service consumers offered by NWDAF | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0157 | 1 | D | Updates to Abbreviations | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0158 | 2 | B | Support NSI ID | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0163 | 3 | B | Support Service Experience Variance | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0165 | 1 | F | Correction to Service Description | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0166 | 1 | F | Correction to description of consumer functionalities | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0167 | 1 | F | Correction to variance of Start time in UE Communication | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0169 | 1 | B | Correct supported feature in AnalyticsData | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0170 | 1 | F | Clarify service experience data | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0171 | | F | Correct threshold | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0172 | 1 | F | Resource type in QoS requirement | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0173 | 1 | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0176 | 2 | F | Analytics result per S-NSSAI | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0177 | 1 | F | Corrections on confidence for other NWDAF events | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0179 | 1 | F | URI of the Nnwdaf services | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0180 | 1 | F | Default value for matching direction | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0181 | | F | Support of immediate reporting | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0182 | 1 | F | Optionality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0183 | 1 | F | Correction to abnormal traffic volume | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0186 | 2 | F | Corrections on ratio of UEs in NWDAF event reports | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0187 | 1 | F | Corrections to TargetUeInformation | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0188 | | F | Corrections on AbnormalBehaviour | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0189 | | F | Plural of NF load level information related attribute | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0190 | 1 | F | locInfo attribute within the UeMobility data | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0191 | | F | Corrections on NfLoadLevelInformation | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0192 | 1 | F | Supported headers, Resource Data type, Operation Name and yaml mapping | 16.4.0 | +| 2020-06 | CT#88e | CP-201255 | 0193 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2020-09 | CT#89e | CP-202066 | 0196 | 1 | F | Description for NWDAF services | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0197 | 1 | F | Zero confidence | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0199 | | F | Correct QoS sustainability requirement | 16.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------|--------| +| 2020-09 | CT#89e | CP-202066 | 0200 | | F | Validity period for analytics information | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0201 | 1 | F | Timestamp of analytics generation | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0202 | | F | Notification about subscribed event | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0204 | 1 | F | Omitted event reporting information | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0205 | | F | Optional network slice identification | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0206 | | F | Slice load level information | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0207 | 1 | F | Matching direction | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0208 | | F | Time when analytics information is needed | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0209 | 1 | F | Confidence for UE mobility | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0210 | | F | Supported feature in Nnwdaf_AnalyticsInfo API | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0211 | | F | Target UE identification | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0212 | | F | Correction on NetworkPerfType | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0214 | | F | Corrections on appIds and dnnns | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0215 | 1 | F | Corrections to networkArea with anyUE | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0216 | 1 | F | Corrections to abnormal behaviour for any UE | 16.5.0 | +| 2020-09 | CT#89e | CP-202054 | 0218 | | A | ResourceURI correction during subscription update | 16.5.0 | +| 2020-09 | CT#89e | CP-202084 | 0221 | 1 | F | Update of OpenAPI version and TS version in externalDocs field | 16.5.0 | +| 2020-09 | CT#89e | CP-202073 | 0198 | | F | Reference to enumeration Accuracy | 17.0.0 | +| 2020-09 | CT#89e | CP-202085 | 0220 | 1 | F | Update of OpenAPI version and TS version in externalDocs field | 17.0.0 | +| 2020-12 | CT#90e | CP-203139 | 0223 | 1 | A | Essential corrections and alignments | 17.1.0 | +| 2020-12 | CT#90e | CP-203117 | 0226 | 1 | A | Correction to notificationURI attribute | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0228 | | A | Mapping of expected analytics types and exception Ids | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0230 | 1 | A | Analytics report correction | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0232 | 1 | A | Error response for statistics request | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0234 | | A | S-NSSAI applicability | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0236 | 1 | A | Reversal of Service Experience feature for nsiLevelThrds attribute | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0238 | 1 | A | Correction to sups of Service Experience Analytics | 17.1.0 | +| 2020-12 | CT#90e | CP-203155 | 0240 | 1 | A | Updates CEF as NWDAF consumer of Nnwdaf_EventsSubscription service | 17.1.0 | +| 2020-12 | CT#90e | CP-203130 | 0242 | 1 | F | Corrections to Validity Period | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0244 | 1 | A | Corrections to Threshold | 17.1.0 | +| 2020-12 | CT#90e | CP-203153 | 0246 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-03 | CT#91e | CP-210191 | 0248 | 1 | F | Support of stateless NFs | 17.2.0 | +| 2021-03 | CT#91e | CP-210217 | 0250 | | A | Storage of YAML files in ETSI Forge | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0251 | | F | OpenAPI reference | 17.2.0 | +| 2021-03 | CT#91e | CP-210206 | 0253 | 1 | A | Correction to S-NSSAI applicability | 17.2.0 | +| 2021-03 | CT#91e | CP-210206 | 0255 | 1 | A | Adding network slice instance load level information | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0256 | | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0257 | | F | Removal of the NnwdafFailureCode data type from the Nnwdaf_AnalyticsInfo API | 17.2.0 | +| 2021-03 | CT#91e | CP-210230 | 0258 | | F | Missing data type in the Nnwdaf_EventsSubscription specific Data Types table | 17.2.0 | +| 2021-03 | CT#91e | CP-210230 | 0259 | | F | Wrong description of the EventFilter data type in the Nnwdaf_AnalyticsInfo specific Data Types table | 17.2.0 | +| 2021-03 | CT#91e | CP-210206 | 0261 | | A | Any Slice applicability | 17.2.0 | +| 2021-03 | CT#91e | CP-210206 | 0263 | 1 | A | Partial failure during event subscription | 17.2.0 | +| 2021-03 | CT#91e | CP-210206 | 0265 | | A | Supported feature | 17.2.0 | +| 2021-03 | CT#91e | CP-210240 | 0267 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-06 | CT#92e | CP-211220 | 0269 | 3 | A | Adding missing description for partial failure operation | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0270 | 4 | B | Adding time when analytics needed and revised time to analytics subscriptions | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0271 | 2 | B | Adding NWDAF as NWDAF services consumer due to analytics aggregation | 17.3.0 | +| 2021-06 | CT#92e | CP-211234 | 0272 | 1 | F | Support of optional HTTP custom header fields | 17.3.0 | +| 2021-06 | CT#92e | CP-211206 | 0278 | 1 | A | Correction on 404 Not Found | 17.3.0 | +| 2021-06 | CT#92e | CP-211220 | 0280 | | A | Missing attributes in subscription procedure | 17.3.0 | +| 2021-06 | CT#92e | CP-211220 | 0282 | 1 | A | Correction on the value of confidence | 17.3.0 | +| 2021-06 | CT#92e | CP-211206 | 0285 | 1 | A | Correction to Load Level Information | 17.3.0 | +| 2021-06 | CT#92e | CP-211220 | 0287 | 1 | A | Correction to NSI Load Level Information | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0288 | 1 | B | Service introduction of Nnwdaf_DataManagement service | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0289 | 1 | B | Service operations for Nnwdaf_DataManagement | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0290 | 1 | B | Nnwdaf_DataManagement Service API | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0291 | 1 | B | Service introduction of Nnwdaf_ModelProvision service | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0292 | 1 | B | Service operations for Nnwdaf_ModelProvision service | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0293 | 1 | B | Nnwdaf_ModelProvision Service API | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0294 | 2 | B | Partitioning criteria for applying sampling in specific UE partitions in NWDAF event exposure | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0295 | 1 | B | Complete definition of the Nnwdaf_ModelProvision API | 17.3.0 | +| 2021-06 | CT#92e | CP-211200 | 0297 | 1 | A | Redirect responses with "application/json" media type | 17.3.0 | +| 2021-06 | CT#92e | CP-211251 | 0298 | 1 | F | analytics for a specific time | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0299 | 1 | B | Service operations of Nnwdaf_ModelProvision service | 17.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------------|--------| +| 2021-06 | CT#92e | CP-211221 | 0300 | 1 | B | Service description of Nnwdaf_ MLModelProvision service | 17.3.0 | +| 2021-06 | CT#92e | CP-211275 | 0301 | 1 | B | Extension to User Data Congestion Analytics with GPSI | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0302 | 1 | F | Correction of the description of the snssai attribute | 17.3.0 | +| 2021-06 | CT#92e | CP-211265 | 0305 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2021-09 | CT#93e | CP-212203 | 0306 | 1 | B | Aggregation support in analytics requests | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0307 | 1 | B | Aggregation support in analytics subscriptions | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0310 | | F | Small corrections in NWDAF APIs | 17.4.0 | +| 2021-09 | CT#93e | CP-212232 | 0311 | 1 | B | Extensions of Slice load level related network data analytics | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0312 | | F | Extend General for OpenAPI specification | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0313 | | B | Redirection handling for Nnwdaf_ MLModelProvision Service | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0314 | 2 | B | Extension to User Data Congestion Analytics in Nnwdaf_ EventsSubscription API | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0315 | 1 | B | Extension to User Data Congestion Analytics in Nnwdaf_ AnalyticsInfo API | 17.4.0 | +| 2021-09 | CT#93e | CP-212202 | 0317 | | A | Removal of NSI ID from PCF as consumer of NWDAF | 17.4.0 | +| 2021-09 | CT#93e | CP-212223 | 0318 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.4.0 | +| 2021-12 | CT#94e | CP-213228 | 0322 | 3 | F | Extension to Observed Service Experience in Nnwdaf_ EventsSubscription Service API | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0323 | 3 | F | Extension to Observed Service Experience in Nnwdaf_ AnalyticsInfo Service API | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0324 | 1 | B | Addition of network analytics for the PCF | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0325 | 2 | B | Updates to User Data Congestion Extension in Nnwdaf_ EventsSubscription API | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0326 | 1 | B | Updates to User Data Congestion Extension in Nnwdaf_ AnalyticsInfo API | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0327 | 1 | B | Analytics info context transfer operation descriptions | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0328 | 2 | B | Analytics info context transfer operation data model and OpenAPI | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0329 | 1 | B | Analytics info context transfer operation overview | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0330 | 1 | B | Analytics info context transfer operation resources | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0331 | 1 | B | Analytics subscription transfer operation descriptions | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0332 | 2 | B | Analytics subscription transfer operation data model and OpenAPI | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0333 | | B | Analytics subscription transfer operation overview | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0334 | 1 | B | Analytics subscription transfer operation resources | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0335 | 1 | B | Extending analytics subscription to enable context transfer | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0336 | 1 | B | Subscription modification procedure of Nnwdaf_ MLModelProvision service | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0337 | 1 | B | Support of Nnwdaf_ MLModelInfo Service | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0338 | | B | The OpenAPI file for Nnwdaf_ MLModelProvision | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0339 | 1 | B | Update of procedures and data type definition for Nnwdaf_ MLModelProvision | 17.5.0 | +| 2021-12 | CT#94e | CP-213239 | 0340 | 1 | F | Aligning API URI with SBI template | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0341 | 3 | B | Support of SM congestion control experience analytics by Nnwdaf_ AnalyticsInfo service | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0342 | | B | Adding DCCF as NWDAF events subscription NF service consumer | 17.5.0 | +| 2021-12 | CT#94e | CP-213226 | 0344 | | A | Remove QoS sustainability as analytics for PCF | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0347 | 1 | B | Support of DN performance analytics | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0348 | 1 | B | Define the list of analytics subsets in the request | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0349 | 1 | B | Add load level related information for NSI_LOAD_LEVEL event | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0350 | | B | Add load level related information for LOAD_LEVEL_INFORMATION event | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0352 | 1 | F | Corrections to EventReportingRequirement | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0353 | 1 | B | Add consumer NF information in Subscription | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0354 | | B | Updates geenrak description to analytics subscription transfer operation | 17.5.0 | +| 2021-12 | CT#94e | CP-213246 | 0355 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.5.0 | +| 2022-03 | CT#95e | CP-220190 | 0357 | 1 | B | Resolve Editor's Note on Slice load level related network data analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0358 | 1 | F | Clarification about conditional descriptions for Slice load level related network data analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0359 | | F | Correction of DN performance analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0360 | | F | Update the Nnwdaf_ AnalyticsInfo Service API specific data types table | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0362 | | F | Editorial correction of offsetPeriod attribute for Nnwdaf_ EventsSubscription API | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0365 | 1 | B | NF Load analytics extensions in Nnwdaf_ EventsSubscription API | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0366 | 1 | B | NF Load analytics extensions in Nnwdaf_ AnalyticsInfo API | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0367 | 3 | B | Support Dispersion Analytics in Nnwdaf_ EventsSubscription API | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0368 | 2 | B | Support Dispersion Analytics in Nnwdaf_ AnalyticsInfo API | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0369 | 1 | B | Support Redundant Transmission Experience Analytics in Nnwdaf_ EventsSubscription API | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0370 | | B | Support Redundant Transmission Experience Analytics in Nnwdaf_ AnalyticsInfo API | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0371 | 2 | B | Support WLAN performance analytics in | 17.6.0 | + +| | | | | | | | | +|--|--|--|--|--|--|-------------------------------|--| +| | | | | | | Nnwdaf_EventsSubscription API | | +|--|--|--|--|--|--|-------------------------------|--| + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------|--------| +| 2022-03 | CT#95e | CP-220189 | 0372 | 1 | B | Support WLAN performance analytics in Nnwdaf_AnalyticsInfo API | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0373 | | F | Corrections to DN Performance Events | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0374 | 1 | B | Update extended features description and analytics events applicability | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0375 | 1 | F | Corrections to Nnwdaf_AnalyticsInfo Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0376 | 1 | F | Clarification on GPSI for UserDataCongestionExt | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0377 | 1 | F | Features in the applicability section | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0378 | 1 | F | Update of 5.1.6.1 | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0379 | 1 | F | Adding ADRF as a consumer of Nnwdaf_DataManagement Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220176 | 0381 | 2 | A | Alignment of "Application Errors" clauses with SBI TS template | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0382 | | B | Adding DCCF as Nnwdaf_AnalyticsInfo service consumer | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0383 | 1 | B | Service Description of Nnwdaf_DataManagement Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0384 | | F | Clarification on NF consumer of Nnwdaf_ModelProvision Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0385 | | F | Corrections to Nnwdaf_ModelProvision Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0386 | 1 | B | Support reporting the analytics of the application list used by UE in the UE communication analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0387 | 1 | B | Support reporting N4 session inactivity timer in the UE communication analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0388 | 1 | B | Support list of analytics subsets for Nnwdaf_AnalyticsInfo Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0389 | | B | Resolve the Editor's Note for partial failure events handling in ML model subscription procedure | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0390 | 2 | B | Resolve the Editor's Note for ML model filter information | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0391 | 1 | B | Add visited AOI(s) to analytics filter for UE mobility analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0392 | 2 | B | Add UPF ID to analytics filter for Service Experience analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0393 | 1 | B | Add the periodic communication indicator to UeCommunication data type | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0394 | 1 | B | Add Service Experience Type to Service Experience analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0395 | 3 | B | Add Application Server Address(es) to analytics filter for Service Experience analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0400 | | B | Extension of UE Mobility Analytics to support LADN DNN | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0401 | 1 | F | References to apiSpecificResourceUriPart for Nnwdaf_DataManagement and Nnwdaf_ModelProvision APIs | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0402 | 1 | D | Editorial modifications | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0403 | 1 | B | Add load level related information to analytics subset | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0404 | 1 | B | Add missing attribute to SM congestion control experience analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0405 | 1 | F | Correction on freqs attribute for Nnwdaf_EventsSubscription API | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0406 | 1 | B | Add missing attributes to DN Performance analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0407 | 1 | B | Add service description and operations to DN Performance analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220173 | 0409 | 1 | A | Correction of the description of end time | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0410 | 1 | F | Incorrect response code of PUT method for Event Subscription Transfer | 17.6.0 | +| 2022-03 | CT#95e | CP-220196 | 0411 | | F | Correction to descriptions in OpenAPI file | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0412 | 1 | B | Service Operation of Nnwdaf_DataManagement_Subscribe Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0413 | 1 | B | Service Operation of Nnwdaf_DataManagement_Unsubscribe Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0414 | 1 | B | Nnwdaf_DataManagement Service Resources | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0415 | 1 | B | Nnwdaf_DataManagement Service Data Model | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0417 | 1 | B | Add accuracy per analytics subset for the specific events | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0418 | 1 | B | Add list of analytics subsets to the Nnwdaf_AnalyticsInfo_Request procedure | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0419 | | B | Add list of analytics subsets to the subscription procedure | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0420 | 1 | B | Add requirement for DN performance analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0421 | 1 | B | Add the missing data structure to the specific Data Types table | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0422 | | B | Solve the Editor's Note for ML model filter information | 17.6.0 | +| 2022-03 | CT#95e | CP-220194 | 0423 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221130 | 0426 | 1 | B | Correction of DN Performance Analytics | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0427 | 1 | B | Update Observed Service Experience Analytics | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0429 | 1 | F | Resolving ENs about references in the Transfer procedures | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0430 | 1 | B | Resolving ENs about subscriptions with data sources in ContextTransfer | 17.7.0 | +| 2022-06 | CT#96 | CP-221132 | 0431 | 1 | F | Resolving EN about the definition of previous subscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0432 | | F | Removing inapplicable feature ES3XX in Transfer operation | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0433 | | F | Removing inapplicable feature ES3XX in ML provisioning | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0434 | | F | Resolving EN about partitioning criteria | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0435 | | B | Resolving ENs about how to implement NF ID in NF consumer information | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0436 | | F | Resolving EN about CANCEL type in Transfer request | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0437 | | F | Resolving EN about redirection codes in Context Transfer | 17.7.0 | +| 2022-06 | CT#96 | CP-221132 | 0438 | 1 | B | Fixing the data type for historcial data | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0439 | 1 | B | Add clarifications for analytics subsets of some attributes | 17.7.0 | +| 2022-06 | CT#96 | CP-221132 | 0440 | 1 | B | Clarification for the presence of some attributes in the request | 17.7.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|----------------------------------------------------------------------------------------------------|--------| +| 2022-06 | CT#96 | CP-221131 | 0441 | 1 | F | Correct the Cardinality of some attributes | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0442 | | B | Define Error Handling and Security for Nnwdaf_DataManagement Service | 17.7.0 | +| 2022-06 | CT#96 | CP-221134 | 0443 | 2 | B | Update the Service Experience Analytics for Nnwdaf_EventsSubscription service | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0444 | 1 | F | Update the Nnwdaf_ MLModelProvision OpenAPI and related data types | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0445 | 1 | F | Correction to topAppListUI and topAppListDI attributes | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0446 | | F | replace NwdafeventsSubscription with NnwdafEventsSubscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0447 | | F | Incorrect definition of smcceUeList in openAPI file | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0453 | | F | Nnwdaf_ EventsSubscription API: n4SessId and lowBase properties | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0454 | 1 | F | Nnwdaf_ EventsSubscription API: removal of sibling elements | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0455 | | F | Nnwdaf_ AnalyticsInfo API: removal of sibling elements | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0456 | 1 | B | Updates on Dispersion Analytics | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0457 | 3 | B | Update RAT types and Frequencies in Service Experience Analytics in Nnwdaf_ EventsSubscription API | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0458 | 1 | B | Update RAT types and Frequencies in Service Experience Analytics in Nnwdaf_ AnalyticsInfo API | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0459 | 1 | B | Updates UE location in Service Experience Analytics | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0460 | 2 | B | Resolve editor's note for Analytics Subscription Transfer | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0464 | 1 | B | Updates to SMCCE | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0465 | 1 | B | Updates to Service Experience Type | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0468 | | B | Supplement the missing events and remove the ENs for ML model subscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0469 | 1 | B | Remove the Editor's Note for Nnwdaf_ MLModelInfo service | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0470 | 2 | B | Define SMCCE event for Nnwdaf_ EventsSubscription service | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0471 | 3 | B | Define Nnwdaf_ DataManagement API | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0472 | 1 | F | Formatting of description fields of Nnwdaf_ MLModelProvision API | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0473 | 1 | F | Correction to MLEventNotif data type | 17.7.0 | +| 2022-06 | CT#96 | CP-221134 | 0474 | 1 | B | Adding NF load over AOI to analytics subset | 17.7.0 | +| 2022-06 | CT#96 | CP-221128 | 0476 | | A | Removing UDM from the list of service consumers for Analytics Subscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221128 | 0478 | | A | Removing UDM from the list of service consumers for Analytics Information | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0479 | | F | Feature handling corrections in EventsSubscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0480 | 1 | F | Feature for Analytics Subsets in EventsSubscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0481 | 1 | F | Feature for ContextTransfer in EventsSubscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0483 | 1 | B | Separate feature for Slice Load Level analytics extensions in EventsSubscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0484 | | F | Removing EneNA dependency from the Aggregation feature in AnalyticsInfo | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0485 | 1 | F | Feature for Analytics Subsets in AnalyticsInfo | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0486 | 1 | F | Correcting the usage of features in AnalyticsInfo | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0487 | 1 | F | Correcting the definition and usage of features in MLModelProvision | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0488 | 1 | B | Corrections for the ML model related information in Transfer and ContextTransfer | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0491 | | B | Muting notifications | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0492 | 1 | B | Service Operation of Nnwdaf_ DataManagement_ Notify | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0493 | 1 | B | Nnwdaf_ DataManagement Data Model | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0494 | 1 | B | Service Operation of Nnwdaf_ DataManagement_ Fetch | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0495 | 1 | B | Nnwdaf_ DataManagement Service Notifications | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0496 | 1 | F | Removal of repetition in HTTP error response | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0498 | 1 | F | Analytics subscription data model sync for events | 17.7.0 | +| 2022-06 | CT#96 | CP-221155 | 0499 | 1 | F | Nnwdaf_ EventsSubscription API: formatting of description fields | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0500 | | F | Nnwdaf_ AnalyticsInfo: formatting of description fields | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0501 | 1 | B | Add Notification Correlation ID to Nnwdaf_ EventsSubscription service | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0503 | 1 | F | Add the missing required fields in the OpenAPI for SMCCE | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0504 | | F | Add the missing status codes for Nnwdaf_ EventsSubscription and Nnwdaf_ MLModelProvision service | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0505 | | F | Corrections on ML model data structure and Nnwdaf_ MLModelProvision API | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0506 | | F | Corrections on the data type of the revised waiting time | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0507 | 1 | F | Presence condition on consumer NF information data types | 17.7.0 | +| 2022-06 | CT#96 | CP-221238 | 0509 | 2 | A | Presence condition on data types of UE related analytics | 17.7.0 | +| 2022-06 | CT#96 | CP-221237 | 0510 | 3 | F | Presence condition on Dispersion data types | 17.7.0 | +| 2022-06 | CT#96 | CP-221128 | 0512 | 1 | A | Presence condition on Network Performance and Flow Description data types | 17.7.0 | +| 2022-06 | CT#96 | CP-221239 | 0514 | 2 | A | Presence condition on NF load data types | 17.7.0 | +| 2022-06 | CT#96 | CP-221240 | 0516 | 2 | A | Presence condition on QoS Sustainability data types | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0517 | 1 | F | Presence condition on SpecificAnalyticsSubscription data type | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0518 | 1 | B | Solve the ENs for exposing the network topology to the untrusted | 17.7.0 | + +| | | | | | | | | +|--|--|--|--|--|--|----|--| +| | | | | | | AF | | +|--|--|--|--|--|--|----|--| + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------|--------| +| 2022-06 | CT#96 | CP-221135 | 0519 | 1 | B | Update the analytics subscription transfer procedure | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0520 | 1 | B | Update the ML model related information | 17.7.0 | +| 2022-06 | CT#96 | CP-221134 | 0521 | | F | Update the OpenAPI of DN performance and User data congestion | 17.7.0 | +| 2022-06 | CT#96 | CP-221134 | 0522 | | B | Update the UPF information for Service Experience and DN performance | 17.7.0 | +| 2022-06 | CT#96 | CP-221255 | 0523 | 1 | F | Corrections related to confidence | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0524 | 1 | F | Remove inapplicable event for EXCEED_LOAD_LEVEL_THR_IND | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0525 | 1 | F | Correct common attributes in analytics result for subscription and analytics request | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0526 | 1 | B | Support of Time Window in Nnwdaf_DataManagement_Subscribe service operation | 17.7.0 | +| 2022-06 | CT#96 | CP-221128 | 0528 | 1 | A | Correction to Threshold value in QosSustainabilityInfo | 17.7.0 | +| 2022-06 | CT#96 | CP-221128 | 0530 | | A | Correction to time period in CongestionInfo | 17.7.0 | +| 2022-06 | CT#96 | CP-221119 | 0536 | 1 | A | Correction to the re-used data types for the re-using Nnwdaf_AnalyticsInfo API | 17.7.0 | +| 2022-06 | CT#96 | CP-221155 | 0537 | 1 | F | Update the apiVersion placeholder 29.520 Rel-17 | 17.7.0 | +| 2022-06 | CT#96 | CP-221151 | 0538 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-09 | CT#97e | CP-222103 | 0463 | 4 | F | Updates on analytics target period | 17.8.0 | +| 2022-09 | CT#97e | CP-222103 | 0541 | 1 | F | ML Model Application Error code addition | 17.8.0 | +| 2022-09 | CT#97e | CP-222103 | 0542 | 2 | F | Correction of UPF information for Service Experience and DN performance | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0543 | 1 | B | Update Dispersion Analytics for missing conditional descriptions | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0544 | | F | Update re-used data type for Nnwdaf_AnalyticsInfo Service API | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0545 | | F | Update re-used data types for Nnwdaf_EventsSubscription Service API | 17.8.0 | +| 2022-09 | CT#97e | CP-222104 | 0546 | 1 | F | Update inputs of Nnwdaf_DataManagement service | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0547 | 1 | F | Removal of repetition in HTTP error response | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0548 | | F | Remove EN about further information in previous subscription information | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0549 | | F | Specifying the applicability of event subscription attributes to NSI load analytics | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0551 | | F | Corrections in the NumberAverage data type | 17.8.0 | +| 2022-09 | CT#97e | CP-222104 | 0552 | 1 | F | Aligning the NWDAF hosting DCCF with the DCCF - service descriptions | 17.8.0 | +| 2022-09 | CT#97e | CP-222104 | 0553 | 1 | F | Aligning the NWDAF hosting DCCF with the DCCF - resources and errors | 17.8.0 | +| 2022-09 | CT#97e | CP-222104 | 0555 | 1 | F | Aligning the NWDAF hosting DCCF with the DCCF - OpenAPI | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0556 | | F | Nnwdaf_EventsSubscription API: required n4SessId property | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0557 | | F | Correction of the name of appServerAddrs attribute | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0558 | | F | Incorrect data type name | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0559 | | F | missing presence condition for some conditional attributes | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0560 | | F | Clarification for SM_CONGESTION | 17.8.0 | +| 2022-09 | CT#97e | CP-222103 | 0561 | 1 | F | Clarification on notificationURI transferred by source NWDAF | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0562 | | F | Incorrect attribute name in AnalyticsContextIdentifier data type | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0563 | | F | Corrections in the error handling of NWDAF Analytics | 17.8.0 | +| 2022-09 | CT#97e | CP-222103 | 0564 | 1 | F | Update of Scope and Overview and Service Architecture | 17.8.0 | +| 2022-09 | CT#97e | CP-222103 | 0565 | 1 | F | Applicability corrections | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0567 | 1 | F | Correct the errors of the cardinality and data type in the data structures | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0568 | 1 | F | Remove the Editor's Note for analytics subset | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0569 | 1 | F | Remove the Editor's Note for ML model | 17.8.0 | +| 2022-09 | CT#97e | CP-222104 | 0571 | 1 | F | Update Nnwdaf_DataManagement_Fetch service operation | 17.8.0 | +| 2022-09 | CT#97e | CP-222103 | 0572 | 1 | F | Update Resource usage threshold crossings time period for NSI load | 17.8.0 | +| 2022-09 | CT#97e | CP-222210 | 0573 | 1 | F | Update the redundant transmission analytics | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0574 | | F | Updates to any UE for Dispersion | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0575 | 1 | F | Corrections to EventSubscription | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0577 | | F | Corrections on percentage value range | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0578 | | F | Correction to ConsumerNfInformation | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0579 | | F | Corrections to EventFilter | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0580 | 1 | F | Miscellaneous corrections on NWDAF services | 17.8.0 | +| 2022-09 | CT#97e | CP-222121 | 0581 | | F | Update of info and externalDocs fields | 17.8.0 | +| 2022-12 | CT#98e | CP-223173 | 0582 | 1 | F | Missing data reports for processed data notifications | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0583 | | F | Correcting the role of analytics subscription information for data collection | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0584 | 1 | F | User consent corrections for NWDAF data management | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0587 | 1 | F | Analytics output restrictions | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0591 | 1 | F | Corrections for time stamp in NWDAF | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0594 | | F | Corrections for Nnwdaf_AnalyticsInfo_Request procedure | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0595 | | F | Corrections related to analytics subscription transfer | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0596 | 1 | F | Corrections to NnwdafDataManagementNotif | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0597 | | F | Correction to visitedAreas attribute | 17.9.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------|--------| +| 2022-12 | CT#98e | CP-223172 | 0598 | | F | Incorrect attribute name referenced in DnPerformanceReq data type | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0599 | | F | Incorrect attribute name referenced in NwdaifMLModelProvSubsc data type | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0600 | | F | Aligning the notifications of Nnwdaif_DataManagement API with service description | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0602 | | F | features in Nnwdaif_MLModelProvision Service API | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0603 | 2 | F | Correction of data type of terminationReq | 17.9.0 | +| 2022-12 | CT#98e | CP-223224 | 0604 | 1 | F | adding resourceUri for analytics subscription transfer notification | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0608 | 2 | F | Correction to Event Notification in Nnwdaif_MLModelProvision API | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0610 | 1 | F | Corrections to NF Service Consumers | 17.9.0 | +| 2022-12 | CT#98e | CP-223174 | 0613 | 1 | F | Corrections to Slice Load level Analytics | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0616 | 1 | F | Corrections for DispersionCollection data type and MLEventSubscription data type | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0619 | 1 | F | Miscellaneous corrections | 17.9.0 | +| 2022-12 | CT#98e | CP-223188 | 0621 | | F | Update of info and externalDocs fields | 17.9.0 | +| 2022-12 | CT#98e | CP-223176 | 0585 | 1 | B | User consent enhancements for NWDAF analytics subscriptions | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0586 | 1 | B | User consent enhancements for NWDAF analytics info | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0588 | 1 | B | Analytics subscription termination request | 18.0.0 | +| 2022-12 | CT#98e | CP-223191 | 0590 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0605 | 1 | B | Correction of data type of procInstr | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0606 | 1 | F | Corrections in ServiceExperienceInfo data type | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0611 | 1 | F | Corrections to service operation procedures in Nnwdaif_EventsSubscription API | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0612 | 1 | F | Corrections to service operation procedures in Nnwdaif_AnalyticsInfo API | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0618 | 1 | F | Correct the presence and add the missing feature of some attributes | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0620 | | B | User consent enhancements for NWDAF data management | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0622 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230291 | 0624 | 2 | B | PFD Determination Analytics for Nnwdaif_AnalyticsInfo API | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0625 | | F | Update abbreviations clause and table of NWDAF services | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0632 | 1 | B | OAuth2 scopes in Nnwdaif_AnalyticsInfo API | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0633 | 1 | B | OAuth2 scopes in Nnwdaif_EventsSubscription API | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0635 | 1 | F | Corrections on offsetPeriod | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0637 | 1 | F | Corrections on list of analytics subsets in Network Performance Analytics | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0638 | 1 | B | Updates on analytics target period subset in Network Performance Analytics | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0639 | 1 | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230145 | 0641 | | A | Correction to DnPerformanceReq for Nnwdaif_AnalyticsInfo API | 18.1.0 | +| 2023-03 | CT#99 | CP-230145 | 0643 | 1 | A | Corrections related to ServiceExperienceExt | 18.1.0 | +| 2023-03 | CT#99 | CP-230145 | 0645 | | A | misplaced description and useless NOTE | 18.1.0 | +| 2023-03 | CT#99 | CP-230145 | 0647 | 2 | A | definition of the value for boolean data type | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0648 | 1 | F | Handling of fetch Instruction | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0649 | | B | Partial failure during analytics subscription transfer | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0650 | | F | Update of 5.1.6.1 and 5.2.6.1 | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0651 | 1 | F | Fix the description formatting issue | 18.1.0 | +| 2023-03 | CT#99 | CP-230129 | 0655 | 1 | A | Invalid JSON value | 18.1.0 | +| 2023-03 | CT#99 | CP-230145 | 0657 | 1 | A | Corrections for historical analytics exposure procedures | 18.1.0 | +| 2023-03 | CT#99 | CP-230147 | 0659 | 1 | B | QoS sustainability analytics with fine granularity | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0660 | 1 | F | Clarification for Analytics Specification in Nnwdaif_DataManagement Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0661 | 1 | F | Corrections for descriptions of boolean data types | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0662 | 1 | B | Enhancement of network performance for AnalyticsInfo Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0663 | 1 | F | Corrections for MLModelProvision | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0664 | 1 | B | Enhancement of UE communication for AnalyticsInfo Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0665 | 1 | B | Enhancement of UE mobility for AnalyticsInfo Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0666 | 1 | B | Enhancement of user data congestion for AnalyticsInfo Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0667 | | B | Support of multiple notification endpoints | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0668 | | B | Support of ordering criterion for network performance | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0669 | | B | Support of ordering criterion for UE communication | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0670 | 1 | B | Support of ordering criterion for UE mobility | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0671 | 1 | B | Support of ordering criterion for user data congestion | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0672 | | B | Support of the acceptable deviation from the threshold for QoS Sustainability | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0673 | | B | Support of the amount information in the notification for Abnormal behaviour | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0674 | 1 | B | Update the enumeration value of preferred level of accuracy | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0687 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231127 | 0626 | 3 | B | Updates for DN performance of Group UEs in Nnwdaif_EventsSubscription API | 18.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------------------|--------| +| 2023-06 | CT#100 | CP-231127 | 0627 | 2 | B | Updates for DN performance of Group UEs in Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0628 | 2 | B | Updates to UE Mobility support FL in Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0629 | 2 | B | Update for UE Mobility support FL in Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0675 | 2 | B | Support NWDAF assisted URSPs in Service Experience in Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0676 | 2 | B | Support NWDAF assisted URSPs in Service Experience in Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0677 | 1 | B | Support use case context in Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0678 | 2 | B | Support use case context in Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0679 | 2 | B | Support use case context in Nnwdaf_ModelProvision API | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0680 | 3 | B | Support PFD Determination Analytics in Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0682 | 2 | B | Update to Nnwdaf_ModelProvision Service API for Federated Learning | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0683 | 4 | B | Update to Nnwdaf_ModelProvision Service API for Model Sharing | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0688 | 1 | B | Event muting enhancements for Analytics Subscriptions | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0689 | 1 | B | Event muting enhancements for ML Model Provisioning | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0690 | 1 | B | Implementing immediate reports for NWDAF Data Management subscriptions | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0691 | 3 | F | Adding missing presence conditions | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0692 | | B | Update PFD Determination Analytics for Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231314 | 0693 | 4 | B | PDU Session traffic analytics for Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 0694 | 2 | B | PDU Session traffic analytics for Nnwdaf_AnalyticsInfo Service API | 18.2.0 | +| 2023-06 | CT#100 | CP-231338 | 0695 | 4 | B | Support Nnwdaf_ModelTraining Service | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0696 | 1 | B | End-to-end data volume transfer time analytics for Nnwdaf_EventsSubscription Service | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0697 | 1 | B | End-to-end data volume transfer time analytics for Nnwdaf_AnalyticsInfo Service | 18.2.0 | +| 2023-06 | CT#100 | CP-231316 | 0698 | 2 | B | End-to-end data volume transfer time analytics for Nnwdaf_ModelProvision Service | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0699 | 3 | B | Update to support extended parameters for ML model provisioning | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0700 | 1 | F | Addition of network analytics for the SMF | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0701 | 1 | F | Addition of network analytics for the PCF | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0702 | | F | Correction of the DnPerfOrderingCriterion enumeration | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0703 | 1 | B | Support of preferred granularity of location for EventsSubscription service | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0704 | 1 | B | Support of preferred granularity of location for AnalyticsInfo service | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0707 | 1 | B | Enhancements on UE Mobility analytics | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0708 | 1 | B | Enhancements to WLAN performance analytics for Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0709 | 1 | B | Enhancements to WLAN performance analytics for Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0710 | 1 | B | Enhancements to Network performance in Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0711 | 1 | B | Enhancements to Network performance in Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0712 | 1 | B | Adding Storage Handling Information in NWDAF Data Management subscriptions | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0713 | 1 | B | Sending NWDAF Deletion Alerts | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0714 | 1 | B | Event muting enhancements for NWDAF Data Management subscriptions | 18.2.0 | +| 2023-06 | CT#100 | CP-231157 | 0715 | 1 | B | Usage of the upflnfo attribute | 18.2.0 | +| 2023-06 | CT#100 | CP-231157 | 0716 | 1 | B | Adding support of UPF events by the NWDAF | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0717 | 1 | B | Support of analytics subset and accuracy per analytics subset for UE mobility for Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231303 | 0718 | 2 | B | End-to-end data volume transfer time analytics for Nnwdaf_EventsSubscription Service API | 18.2.0 | +| 2023-06 | CT#100 | CP-231128 | 0719 | 1 | B | End-to-end data volume transfer time analytics for Nnwdaf_AnalyticsInfo Service API | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0720 | 1 | B | Update to Nnwdaf_ModelProvision API for Supporting ML Model Retrieval with ADRF | 18.2.0 | +| 2023-06 | CT#100 | CP-231159 | 0722 | 1 | A | Corrections on the validity period in the analytics | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0723 | 1 | B | Enhancement of DN Performance Analytics | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0724 | 1 | B | Support of analytics accuracy information for Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0725 | 1 | B | Support of analytics accuracy information for Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0726 | 1 | B | Support of analytics subset and accuracy per analytics subset for UE mobility for Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231138 | 0727 | 1 | F | Removal of the redundant descriptions for ML model service | 18.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------------|--------| +| 2023-06 | CT#100 | CP-231125 | 0728 | 1 | B | Updates for UE mobility analytics using fine granularity | 18.2.0 | +| 2023-06 | CT#100 | CP-231138 | 0730 | 1 | F | misplaced attributes | 18.2.0 | +| 2023-06 | CT#100 | CP-231138 | 0731 | 1 | F | Correction to EnAbnormalBehaviour feature | 18.2.0 | +| 2023-06 | CT#100 | CP-231138 | 0733 | 1 | F | Missing attributes in procedure description for NsiLoadExt feature | 18.2.0 | +| 2023-06 | CT#100 | CP-231159 | 0735 | 1 | A | Correction to UeCommunicationExt feature | 18.2.0 | +| 2023-06 | CT#100 | CP-231132 | 0736 | 1 | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0737 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232082 | 0738 | 1 | B | Immediate reporting in the MLModelTraining API | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0739 | 1 | B | Applicabilities and restrictions in the MLModelProvision and MLModelTraining APIs | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0740 | 1 | F | Redundancies in the MLModelTraining service | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0741 | | F | Procedure descriptions corrections | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0742 | 1 | B | Location Accuracy Analytics for subscriptions | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0743 | 1 | B | Location Accuracy Analytics for requests | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0746 | 1 | B | Movement Behaviour analytics for Nnwdaf_EventsSubscription API | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0747 | 1 | B | Movement Behaviour analytics for Nnwdaf_AnalyticsInfo Service API | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0749 | | B | Update UE Mobility analytics | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0750 | 2 | B | Update End-to-end data volume transfer time analytics | 18.3.0 | +| 2023-09 | CT#101 | CP-232255 | 0751 | 2 | B | Update to Nnwdaf_ MLModelTraining Service API | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0752 | 1 | B | Update for adding NEF as Consumer of Multiple Analytics IDs | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0753 | 1 | D | Corrections to Nnwdaf_ MLModelProvision Service API | 18.3.0 | +| 2023-09 | CT#101 | CP-232097 | 0754 | 1 | F | Corrections to Nnwdaf_ EventsSubscription Service API | 18.3.0 | +| 2023-09 | CT#101 | CP-232097 | 0755 | 1 | F | Corrections to Nnwdaf_ AnalyticsInfo Service API | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0756 | 1 | B | Resolve the Editor's Note for the analytics subset of E2E data volume transfer time | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0757 | 1 | B | Support of reporting the E2E data volume transfer time and the corresponding volume | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0758 | 1 | B | Enhancement of Redundant Transmission Experience analytics for NWDAF-assisted URSP | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0759 | 1 | B | Enhancements of the QoS sustainability analytics request | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0760 | 1 | B | Enhancements of the QoS sustainability subscription | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0761 | 1 | B | Miscellaneous corrections for analytics | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0762 | 1 | B | Support for stopping and resuming the consumption of the analytics | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0763 | 1 | B | Support of spatial granularity size and temporal granularity size of the analytics request | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0764 | 1 | B | Support of spatial granularity size and temporal granularity size of the analytics subscription | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0765 | 1 | B | Support of the analytics subsets of PDU session traffic | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0766 | 1 | B | New ML Model Provisioning parameter | 18.3.0 | +| 2023-09 | CT#101 | CP-232097 | 0767 | | F | Merging two NetworkPerformanceExt_eNA features | 18.3.0 | +| 2023-09 | CT#101 | CP-232097 | 0768 | | F | misalignment of transEvents attribute | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0769 | 1 | F | Editors Note removal for E2E Data Volume Transfer Time analytics | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0770 | 1 | B | Corrections to PDU Session Traffic Analytics | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0771 | 1 | B | Updates to Analytics Accuracy Monitoring in Nnwdaf_ EventsSubscription API | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0772 | | B | Updates to Analytics Accuracy Monitoring in Nnwdaf_ AnalyticsInfo API | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0773 | 1 | B | Updates ML Model Provisioning supporting ML model accuracy monitoring | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0775 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-09 | CT#101 | CP-232097 | 0777 | | B | Support of providing the number of impacted UE for Abnormal Behaviour analytics | 18.3.0 | +| 2023-12 | CT#102 | CP-233235 | 0778 | 1 | F | Corrections on End-to-end data volume transfer time analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0779 | 1 | B | Resolve the Editor's Note of UE mobility analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0780 | 1 | B | Support of End-to-end data volume transfer time for list of UEs | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0781 | 1 | B | Clarifications for UE Location order indicator in UE mobility analytics request | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0782 | 1 | F | Corrections on ML model provisioning | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0783 | 2 | B | Define Nnwdaf_ MLModelMonitor API | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0784 | 1 | B | Define the linear distance threshold for the UE mobility analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0785 | 2 | B | Enhancements on the inference input data and training input data | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0786 | 1 | B | Support list of Access Types in the Service Experience analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0787 | 1 | B | Support the consumer to provide the inference data stored in ADRF for model training | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0788 | 1 | B | Support the consumer to provide the time when the ML model is needed | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0789 | 1 | B | Relative Proximity analytics for Nnwdaf_ EventsSubscription API | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0790 | | B | Relative Proximity analytics for Nnwdaf_ AnalyticsInfo API | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0791 | | B | Adding confidence attributes to PFD Determination Analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0792 | | B | Update conditional description to locGranularity attribute. | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0793 | | B | Update direction data type | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------|--------| +| 2023-12 | CT#102 | CP-233224 | 0794 | | B | Update the description of accPerSubset attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233258 | 0796 | | A | Correcting a contradiction in the meaning of expiry | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0797 | 1 | B | Analytics feedback information in Subscriptions | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0798 | | F | add ENAExt feature for Nnwdaf_AnalyticsInfo Service | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0801 | 1 | B | Pending Notification in Nnwdaf_DataManagement API | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0802 | 1 | B | Updates to MLEventNotif in Nnwdaf_MLModelProvision API | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0803 | 1 | B | Adding confidence attribute to E2E data volume transfer time analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0805 | 1 | B | Applicability of UNAVAILABLE_DATA failure code | 18.4.0 | +| 2023-12 | CT#102 | CP-233258 | 0807 | | A | Corrections on attribute names | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0808 | 1 | F | Corrections for UE mobility analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0809 | 1 | B | Define service descriptions of Nnwdaf_MLModelMonitor API | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0810 | | B | Define OpenAPI of Nnwdaf_MLModelMonitor API | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0811 | | B | Define Nnwdaf_RoamingData API | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0812 | 1 | B | Define service descriptions of Nnwdaf_RoamingData API | 18.4.0 | +| 2023-12 | CT#102 | CP-233136 | 0813 | 1 | B | Define OpenAPI of Nnwdaf_RoamingData API | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0814 | | F | Corrections on the presence and description of dnais attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0815 | 1 | B | Roaming Analytics service definition | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0816 | 1 | B | Roaming Analytics service data model | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0817 | 1 | B | Roaming Analytics service OpenAPI | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0818 | 1 | B | Analytics subscription extensions to support analytics for roaming UEs | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0819 | | B | Analytics info extensions to support analytics for roaming UEs | 18.4.0 | +| 2023-12 | CT#102 | CP-233227 | 0820 | 1 | F | Applicability of muting exception instructions | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0821 | 1 | F | Wrong feature and service operation names | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0822 | | F | Data fetching correction | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0824 | 1 | F | Corrections to boolean type definitions | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0825 | 1 | B | Updates to error handling | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0826 | 1 | B | Updates for the Support of Nnwdaf_MLModelTraining_Subscribe Service Operation | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0827 | 1 | F | Update to the NnwdafMLModelTrainNotif Data Type | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0828 | | B | Updates for Application Error Handling | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0829 | 1 | F | Updates to the Data Model for Nnwdaf_EventsSubscription Service API | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0830 | | F | Updates to Nnwdaf_AnalyticsInfo Service API | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0831 | | F | Updates to NnwdafEventsSubscriptionNotification Data Type | 18.4.0 | +| 2023-12 | CT#102 | CP-233229 | 0832 | 1 | F | IETF RFC 7540, RFC 7807 obsoleted by RFC 9113 and RFC 9457 respectively | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0833 | | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29521/raw.md b/raw/rel-18/29_series/29521/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e97aa059b8f71d60caf775bab8df1ec04e047348 --- /dev/null +++ b/raw/rel-18/29_series/29521/raw.md @@ -0,0 +1,4222 @@ + + +# 3GPP TS 29.521 V18.3.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Binding Support Management Service; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'P', and the text 'A GLOBAL INITIATIVE' in smaller letters below the logo. + +3GPP logo + +## --- Keywords --- + +### **3GPP** + +### --- Postal address --- + +### 3GPP support office address --- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## Internet --- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 Binding Support Management Service ..... | 8 | +| 4.1 Service Description ..... | 8 | +| 4.1.1 Overview ..... | 8 | +| 4.1.2 Service Architecture ..... | 9 | +| 4.1.3 Network Functions ..... | 10 | +| 4.1.3.1 Binding Support Function (BSF)..... | 10 | +| 4.1.3.2 NF Service Consumers ..... | 10 | +| 4.2 Service Operations ..... | 12 | +| 4.2.1 Introduction ..... | 12 | +| 4.2.2 Nbsf_Management_Register Service Operation ..... | 12 | +| 4.2.2.1 General..... | 12 | +| 4.2.2.2 Register a new PCF for a PDU Session binding information..... | 13 | +| 4.2.2.3 Register a new PCF for a UE binding information..... | 15 | +| 4.2.2.4 Register a new PCF for an MBS Session binding information ..... | 16 | +| 4.2.3 Nbsf_Management_Deregister Service Operation..... | 17 | +| 4.2.3.1 General..... | 17 | +| 4.2.3.2 Deregister an individual PCF for a PDU Session binding information..... | 18 | +| 4.2.3.3 Deregister an individual PCF for a UE binding information..... | 18 | +| 4.2.3.4 Deregister an individual PCF for an MBS Session binding information ..... | 19 | +| 4.2.4 Nbsf_Management_Discovery Service Operation..... | 19 | +| 4.2.4.1 General..... | 19 | +| 4.2.4.2 Retrieve the PCF binding information for a PDU session..... | 20 | +| 4.2.4.3 Retrieve the PCF binding information for a UE ..... | 21 | +| 4.2.4.4 Retrieve the PCF binding information for an MBS Session..... | 21 | +| 4.2.5 Nbsf_Management_Update Service Operation..... | 22 | +| 4.2.5.1 General..... | 22 | +| 4.2.5.2 Update an existing PCF for a PDU Session binding information..... | 23 | +| 4.2.5.3 Update an existing PCF for a UE binding information ..... | 24 | +| 4.2.5.4 Update an existing PCF for an MBS Session binding information ..... | 25 | +| 4.2.6 Nbsf_Management_Subscribe Service Operation..... | 26 | +| 4.2.6.1 General..... | 26 | +| 4.2.6.2 Creating a new subscription..... | 26 | +| 4.2.6.3 Modifying an existing subscription ..... | 27 | +| 4.2.7 Nbsf_Management_Unsubscribe Service Operation..... | 28 | +| 4.2.7.1 General..... | 28 | +| 4.2.7.2 Unsubscription from event notifications..... | 28 | +| 4.2.8 Nbsf_Management_Notify Service Operation ..... | 29 | +| 4.2.8.1 General..... | 29 | +| 4.2.8.2 Notification about subscribed events ..... | 29 | +| 5 Nbsf_Management Service API..... | 30 | +| 5.1 Introduction ..... | 30 | +| 5.2 Usage of HTTP..... | 31 | +| 5.2.1 General ..... | 31 | +| 5.2.2 HTTP standard headers ..... | 31 | +| 5.2.2.1 General..... | 31 | +| 5.2.2.2 Content type..... | 31 | +| 5.2.3 HTTP custom headers ..... | 31 | +| 5.2.3.1 General..... | 31 | + +| | | | +|------------|----------------------------------------------------------|----| +| 5.3 | Resources ..... | 31 | +| 5.3.1 | Resource Structure..... | 31 | +| 5.3.2 | Resource: PCF for a PDU Session Bindings..... | 33 | +| 5.3.2.1 | Description..... | 33 | +| 5.3.2.2 | Resource definition..... | 33 | +| 5.3.2.3 | Resource Standard Methods ..... | 34 | +| 5.3.2.3.1 | POST ..... | 34 | +| 5.3.2.3.2 | GET ..... | 34 | +| 5.3.3 | Resource: Individual PCF for a PDU Session Binding ..... | 36 | +| 5.3.3.1 | Description..... | 36 | +| 5.3.3.2 | Resource definition..... | 36 | +| 5.3.3.3 | Resource Standard Methods ..... | 36 | +| 5.3.3.3.1 | DELETE..... | 36 | +| 5.3.3.3.2 | PATCH..... | 37 | +| 5.3.4 | Resource: Binding Subscriptions ..... | 38 | +| 5.3.4.1 | Description..... | 38 | +| 5.3.4.2 | Resource definition..... | 39 | +| 5.3.4.3 | Resource Standard Methods ..... | 39 | +| 5.3.4.3.1 | POST ..... | 39 | +| 5.3.4.4 | Resource Custom Operations..... | 39 | +| 5.3.5 | Resource: Individual Binding Subscription..... | 39 | +| 5.3.5.1 | Description..... | 39 | +| 5.3.5.2 | Resource definition..... | 40 | +| 5.3.5.3 | Resource Standard Methods ..... | 40 | +| 5.3.5.3.1 | PUT ..... | 40 | +| 5.3.5.3.2 | DELETE..... | 41 | +| 5.3.5.4 | Resource Custom Operations..... | 42 | +| 5.3.6 | Void ..... | 43 | +| 5.3.7 | Resource: PCF for a UE Bindings..... | 43 | +| 5.3.7.1 | Description..... | 43 | +| 5.3.7.2 | Resource definition..... | 43 | +| 5.3.7.3 | Resource Standard Methods ..... | 43 | +| 5.3.7.3.1 | POST ..... | 43 | +| 5.3.7.3.2 | GET ..... | 44 | +| 5.3.8 | Resource: Individual PCF for a UE Binding ..... | 44 | +| 5.3.8.1 | Description..... | 44 | +| 5.3.8.2 | Resource definition..... | 44 | +| 5.3.8.3 | Resource Standard Methods ..... | 45 | +| 5.3.8.3.1 | DELETE..... | 45 | +| 5.3.8.3.2 | PATCH..... | 45 | +| 5.3.9 | Resource: PCF for an MBS Session Bindings ..... | 47 | +| 5.3.9.1 | Description..... | 47 | +| 5.3.9.2 | Resource definition..... | 47 | +| 5.3.9.3 | Resource Standard Methods ..... | 47 | +| 5.3.9.3.1 | POST ..... | 47 | +| 5.3.9.3.2 | GET ..... | 48 | +| 5.3.9.4 | Resource Custom Operations..... | 48 | +| 5.3.10 | Resource: Individual PCF for an MBS Session Binding..... | 48 | +| 5.3.10.1 | Description..... | 48 | +| 5.3.10.2 | Resource definition..... | 49 | +| 5.3.10.3 | Resource Standard Methods ..... | 49 | +| 5.3.10.3.1 | PATCH..... | 49 | +| 5.3.10.3.2 | DELETE..... | 50 | +| 5.3.10.4 | Resource Custom Operations..... | 51 | +| 5.4 | Custom Operations without associated resources ..... | 52 | +| 5.5 | Notifications..... | 52 | +| 5.5.1 | General ..... | 52 | +| 5.5.2 | BSF Notification..... | 52 | +| 5.5.2.1 | Description..... | 52 | +| 5.5.2.2 | Target URI..... | 52 | +| 5.5.2.3 | Standard Methods ..... | 52 | +| 5.5.2.3.1 | POST ..... | 52 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------------------------|-----------| +| 5.6 | Data Model..... | 53 | +| 5.6.1 | General ..... | 53 | +| 5.6.2 | Structured data types ..... | 55 | +| 5.6.2.1 | Introduction..... | 55 | +| 5.6.2.2 | Type PcfBinding..... | 56 | +| 5.6.2.3 | Type PcfBindingPatch ..... | 58 | +| 5.6.2.4 | Type ParameterCombination ..... | 58 | +| 5.6.2.5 | Type ExtProblemDetails..... | 59 | +| 5.6.2.6 | Type BindingResp ..... | 59 | +| 5.6.2.7 | Type BsfSubscription ..... | 59 | +| 5.6.2.8 | Type BsfNotification ..... | 60 | +| 5.6.2.9 | Type BsfEventNotification ..... | 60 | +| 5.6.2.10 | Type PcfForUeBinding..... | 61 | +| 5.6.2.11 | Type PcfForUeBindingPatch ..... | 61 | +| 5.6.2.12 | Type SnssaiDnnPair..... | 61 | +| 5.6.2.13 | Type PcfForUeInfo ..... | 62 | +| 5.6.2.14 | Type PcfForPduSessionInfo ..... | 62 | +| 5.6.2.15 | Type PcfMbsBinding..... | 63 | +| 5.6.2.16 | Type PcfMbsBindingPatch ..... | 64 | +| 5.6.2.17 | Type MbsExtProblemDetails..... | 64 | +| 5.6.2.18 | Type MbsBindingResp ..... | 64 | +| 5.6.3 | Simple data types and enumerations ..... | 64 | +| 5.6.3.1 | Introduction..... | 64 | +| 5.6.3.2 | Simple data types..... | 64 | +| 5.6.3.3 | Enumeration: BindingLevel..... | 65 | +| 5.6.3.4 | Void ..... | 65 | +| 5.6.3.5 | Enumeration: BsfEvent..... | 65 | +| 5.6.4 | Data types describing alternative data types or combinations of data types ..... | 65 | +| 5.6.4.1 | Type: BsfSubscriptionResp ..... | 65 | +| 5.7 | Error handling ..... | 65 | +| 5.7.1 | General ..... | 65 | +| 5.7.2 | Protocol Errors..... | 66 | +| 5.7.3 | Application Errors ..... | 66 | +| 5.8 | Feature negotiation..... | 66 | +| 5.9 | Security..... | 67 | +| Annex A (normative): | OpenAPI specification ..... | 68 | +| A.1 | General..... | 68 | +| A.2 | Nbsf_Management API..... | 68 | +| Annex B (informative): | Deployment option to support BSF and DRA coexistence due to network migration ..... | 86 | +| Annex C (informative): | Change history..... | 87 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd 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. + +# --- 1 Scope + +The present specification provides the stage 3 definition of the Binding Support Management Service of the 5G System. + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The stage 2 definition and related procedures for Binding Support Management Service is specified in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. + +The 5G System stage 3 call flows are provided in 3GPP TS 29.513 [5]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [6] and 3GPP TS 29.501 [7]. + +The Binding Support Management Service is provided by the Binding Support Function (BSF). + +# --- 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [5] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [6] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [7] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [8] IETF RFC 9113: "HTTP/2". +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [11] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [12] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 29.213: " Policy and Charging Control signalling flows and Quality of Service (QoS) parameter mapping". +- [15] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [16] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [17] 3GPP TS 23.527: "5G System; Restoration Procedures". + +- [18] 3GPP TR 21.900: "Technical Specification Group working methods". +- [19] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [20] IETF RFC 7396: "JSON Merge Patch". +- [21] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". + +# --- 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]. + +| | | +|----------|----------------------------------------------------------------| +| 5G DDNMF | 5G Direct Discovery Name Management Function | +| 5G-RG | 5G Residential Gateway | +| AF | Application Function | +| AM | Access and Mobility Management | +| BSF | Binding Support Function | +| DNN | Data Network Name | +| DRA | Diameter Routing Agent | +| HTTP | Hypertext Transfer Protocol | +| FN-RG | Fixed Network Residential Gateway | +| FQDN | Fully Qualified Domain Name | +| GPSI | Generic Public Subscription Identifier | +| JSON | JavaScript Object Notation | +| MAC | Media Access Control | +| MBSF | Multicast/Broadcast Service Function | +| NEF | Network Exposure Function | +| NRF | Network Repository Function | +| NWDAF | Network Data Analytics Function | +| PCF | Policy Control Function | +| SMF | Session Management Function | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SUPI | Subscription Permanent Identifier | +| TSCTSF | Time Sensitive Communication and Time Synchronization Function | +| UDR | Unified Data Repository | + +# --- 4 Binding Support Management Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The Binding Support Management Service as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4], is provided by the Binding Support Function (BSF). + +The Nbsf\_Management service is used to provide: + +- a PCF for a PDU session binding functionality, which ensures that an AF request for a certain PDU Session reaches the relevant PCF holding that PDU Session information, or ensures that the same PCF is selected for multiple PDU sessions. +- a PCF for an MBS session binding functionality, which ensures that for location-dependent MBS services, an AF request for a certain MBS Session reaches the relevant PCF holding that MBS Session information. +- a PCF for a UE binding functionality, which ensures that an AF request for Access and Mobility related Policy Authorization for a UE reaches the relevant PCF for a UE holding the AM Policy Association. +- Subscription to notification events about a newly registered or deregistered PCF for a UE or PCF for a PDU session. + +This service: + +- allows NF service consumers to register, update and remove binding information; +- allows NF service consumers to retrieve binding information; +- allows NF service consumers to subscribe to notifications of registration/deregistration events of newly registered or deregistered PCF for a UE or PCF for a PDU session. + +### 4.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Policy and Charging related 5G architecture is also described in 3GPP TS 23.503 [4] and 3GPP TS 29.513 [5]. + +The Binding Support Management Service (Nbsf\_Management) is exhibited by the Binding Support Function (BSF). + +The known consumers of the Nbsf\_Management service are: + +- Policy Control Function (PCF) +- Network Exposure Function (NEF) +- Application Function (AF); +- Multicast/Broadcast Service Function (MBSF); +- 5G Direct Discovery Name Management Function (5G DDNMF); +- Network Data Analytics Function (NWDAF); and +- Time Sensitivity Communication and Time Synchronization Function (TSCTSF). + +As described in 3GPP TS 23.503 [4], the BSF is a function that can be deployed standalone or as a functionality provided by other network functions, such as PCF, UDR, NRF, SMF. + +NOTE 1: The PCF accesses the Nbsf\_Management service at the BSF via an internal interface when it is collocated with BSF. + +NOTE 2: The DRA decides to select a BSF based on user IP address range when the DRA has no binding information for the subscriber to get the relevant PCF for a PDU session address. DRA and BSF coexistence is described in 3GPP TS 29.513 [5], Annex A. + +NOTE 2: The DRA decides to select a BSF based on user IP address range when the DRA has no binding information for the subscriber to get the relevant PCF for a PDU session address. DRA and BSF coexistence is described in 3GPP TS 29.513 [5], Annex A. + +![Figure 4.1.2-1: Reference Architecture for the Nbsf_Management service; SBI representation. The diagram shows a central BSF box containing an Nbsf service. Below it, the Nbsf_Management service is connected to seven network functions: PCF, NEF, AF, NWDAF, TSCTSF, MBSF, and 5G DDNMF.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +graph TD + BSF[BSF] -- Nbsf --> Nbsf_Management_service((Nbsf_Management service)) + Nbsf_Management_service --- PCF[PCF] + Nbsf_Management_service --- NEF[NEF] + Nbsf_Management_service --- AF[AF] + Nbsf_Management_service --- NWDAF[NWDAF] + Nbsf_Management_service --- TSCTSF[TSCTSF] + Nbsf_Management_service --- MBSF[MBSF] + Nbsf_Management_service --- 5GDDNMF[5G DDNMF] + +``` + +Figure 4.1.2-1: Reference Architecture for the Nbsf\_Management service; SBI representation. The diagram shows a central BSF box containing an Nbsf service. Below it, the Nbsf\_Management service is connected to seven network functions: PCF, NEF, AF, NWDAF, TSCTSF, MBSF, and 5G DDNMF. + +**Figure 4.1.2-1: Reference Architecture for the Nbsf\_Management service; SBI representation** + +NOTE 3: The PCF in the figure represents both, the PCF for a UE and the PCF for a PDU session. The PCF for a UE and the PCF for a PDU session separately and independently register themselves at the BSF, regardless they are deployed in the same NF instance or separately in different NF instances. + +### 4.1.3 Network Functions + +#### 4.1.3.1 Binding Support Function (BSF) + +The BSF: + +- stores the binding information for a certain PDU Session; +- stores the binding information for a certain MBS Session; +- stores the binding information for a certain UE; +- enables the subscription to notifications of PCF for a PDU session registration/deregistration events; +- enables the subscription to notifications of PCF for a UE registration/deregistration events; and +- enables the discovery of binding information (e.g. the address information of the selected PCF for a PDU session). + +The BSF allows NF service consumers (e.g. PCF) to register, update and remove a binding information, and allows NF service consumers (e.g. AF, NEF, NWDAF) to discover a binding information (e.g. the address information of the selected PCF). The BSF also allows NF service consumers (e.g. PCF for a UE, AF, NEF) to subscribe to notifications of PCF registration/deregistration events. + +The BSF can be deployed standalone or collocated with other network functions, such as PCF, UDR, NRF and SMF. + +#### 4.1.3.2 NF Service Consumers + +The Policy Control Function (PCF): + +- The PCF for a PDU session: + - a. registers binding information in the BSF for a UE when an IPv4 address and/or IPv6 prefix is allocated, or a MAC address is used for the PDU session; + +- b. updates binding information in the BSF when a UE address information is changed for the PDU Session; and +- c. removes binding information in the BSF when an IPv4 address and/or IPv6 prefix is released, or a MAC address is not used for the PDU Session. +- The PCF for an MBS session: + - a. registers binding information in the BSF for an MBS session; + - b. updates binding information in the BSF for the MBS session; + - c. removes binding information in the BSF for the MBS session. +- The PCF for a UE: + - a. registers binding information in the BSF for a UE when an AM/UE Policy Association is established; + - b. updates binding information in the BSF when a new PCF instance for a UE is selected; + - c. removes binding information in the BSF when the AM/UE Policy Association is terminated; and + - d. subscribes with the BSF to notification of registration/deregistration events of the PCF for a PDU session. + +##### The Network Exposure Function (NEF): + +- provides means for the Application Functions to securely interact with the Policy framework for policy control to 3GPP network. During the procedure, it needs to discover the selected PCF for a PDU session, the selected PCF for an MBS Session (if applicable) or the selected PCF for a UE by using the Nbsf\_Management\_Discovery service operation and the selected PCF for a UE by using the Nbsf\_Management\_Subscribe/Notify service operations. + +##### The Application Function (AF): + +- discovers the selected PCF for a PDU session, the selected PCF for an MBS Session (if applicable) or the selected PCF for a UE by using the Nbsf\_Management\_Discovery service operation and the selected PCF for a UE by using the Nbsf\_Management\_Subscribe/Notify service operations when it is allowed to interact directly with the policy framework for policy control. + +##### The Network Data Analytics Function (NWDAF): + +- discovers the selected PCF for a PDU session by using the Nbsf\_Management\_Discovery service operation. + +##### The Time Sensitive Communication and Time Synchronization Function (TSCTSF) + +- discovers the selected PCF for a PDU session by using the Nbsf\_Management\_Discovery service operation and the selected PCF for a UE by using Nbsf\_Management\_Subscribe/Notify service operations when it is allowed to interact with the policy framework for time sensitive communication and time synchronization control. + +##### The Multicast/Broadcast Service Function (MBSF): + +- discovers the selected PCF for an MBS session by using the Nbsf\_Management\_Discovery service operation. + +##### The 5G Direct Discovery Name Management Function (5G DDNMF): + +- handles the discovery of the selected PCF for a UE by using the Nbsf\_Management\_(un)Subscribe/Notify service operations. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +**Table 4.2.1-1: Operations of the Nbsf\_Management Service** + +| Service operation name | Description | Initiated by | +|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| Nbsf_Management_Register | This service operation is used to register the binding information for a PDU session or an MBS session or a UE. | NF service consumer (PCF) | +| Nbsf_Management_Deregister | This service operation is used to deregister the binding information for a PDU session or an MBS session or a UE. | NF service consumer (PCF) | +| Nbsf_Management_Discovery | This service operation is used by an NF service consumer to discover a selected PCF for a PDU session or a selected PCF for an MBS session or a selected PCF for a UE. | NF service consumer (NEF, AF, NWDAF, MBSF, TSCTSF) | +| Nbsf_Management_Update | This service operation is used to update an existing binding information for a PDU session or an MBS session or a UE. | NF service consumer (PCF) | +| Nbsf_Management_Subscribe | This service operation is used by an NF service consumer to subscribe or to modify a subscription for event notifications of PCF for the UE or PCF for the PDU session binding related events. | NF service consumer (NEF, AF, PCF, TSCTSF, 5G DDNMF) | +| Nbsf_Management_Unsubscribe | This service operation is used by an NF service consumer to terminate a previous subscription. | NF service consumer (NEF, AF, PCF, TSCTSF, 5G DDNMF) | +| Nbsf_Management_Notify | This service operation is used by the BSF to notify binding related event(s) to the NF service consumer which has subscribed to such event(s). | BSF | + +### 4.2.2 Nbsf\_Management\_Register Service Operation + +#### 4.2.2.1 General + +This service operation allows a NF service consumer (e.g. PCF for a PDU session) to register the session binding information for a UE in the BSF by providing the user identity, the DNN, the UE address(es) and the selected PCF address for a certain PDU Session to the BSF, and BSF stores the information. + +If the BindingUpdate feature is not supported and the NF service consumer (e.g. PCF for a PDU session) receives a new UE address (e.g. IPv6 prefix) and has already registered session binding information for this PDU session, the NF service consumer (e.g. PCF for a PDU session) shall register a new session binding information in the BSF. + +If the SamePcf feature or the ExtendedSamePcf feature is supported, this service operation allows the NF service consumer (e.g. PCF for a PDU session) to check whether PCF addressing information for Npcf\_SMPolicyControl service is already registered in the BSF by another PCF for a combination of the UE ID, DNN and S-NSSAI parameters of the PDU session. + +This service operation also allows a NF service consumer (e.g. PCF for a UE) to register PCF for a UE binding information for a UE in the BSF, by providing to the BSF the user identity and the selected PCF address for a certain UE, and the BSF stores the information. + +In addition, this service operation also allows a NF service consumer (e.g. PCF for an MBS session) to register the session binding information for an MBS Session at the BSF, by providing the MBS Session ID, the identifier of the selected PCF for the MBS Session and the related information (e.g. PCF (service) set information), and the BSF stores the information. + +The following procedures using the Nbsf\_Management\_Register service operation are supported: + +- Register a new PCF for a PDU Session binding information. + +- Register a new PCF for a UE binding information. +- Register a new PCF for an MBS Session binding information. + +#### 4.2.2.2 Register a new PCF for a PDU Session binding information + +![Sequence diagram showing the interaction between an NF Service Consumer and a BSF. The NF Service Consumer sends a POST request to the BSF at step 1, and the BSF responds with a 201 Created status at step 2.](410562339ce067fdc6fa41940c118658_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant BSF + Note left of NF Service Consumer: + NF Service Consumer->>BSF: 1. POST ../pcfBindings + BSF-->>NF Service Consumer: 2. 201 Created + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a BSF. The NF Service Consumer sends a POST request to the BSF at step 1, and the BSF responds with a 201 Created status at step 2. + +**Figure 4.2.2.2-1: NF service consumer register a new PCF for a PDU Session binding information** + +The NF service consumer shall invoke the Nbsf\_Management\_Register service operation to register the PDU session binding information for a UE in the BSF. The NF service consumer shall send for this an HTTP POST request with "{apiRoot}/nbsf-management/{apiVersion}/pcfBindings" as Resource URI representing the "PCF for a PDU Session Bindings", as shown in figure 4.2.2.2-1, step 1, to create a binding information for an "Individual PCF for a PDU Session Binding" according to the information (e.g. UE address(es), SUPI, GPSI, DNN, S-NSSAI) in the message body. When the "ExtendedSamePcf" feature is not supported, the "PcfBinding" data structure provided in the request body shall include: + +- if the "MultiUeAddr" feature is not supported or not yet known, address information of the served UE consisting of: + - (i) either IP address information consisting of: + - + the IPv4 address encoded as "ipv4Addr" attribute; and/or + - + the /128 IPv6 address, the IPv6 address prefix or an IPv6 prefix shorter than /64 encoded as "ipv6Prefix" attribute; or + - (ii) the MAC address encoded as "macAddr48" attribute; + +Otherwise, address information of the served UE consisting of: + +- (i) any IP address information consisting of: + - + the IPv4 address encoded as "ipv4Addr" attribute; + - + the /128 IPv6 address, the IPv6 address prefix or an IPv6 prefix shorter than /64 encoded as "ipv6Prefix" attribute; and/or + +NOTE 1: IPv6 prefix shorter than /64 are received when IPv6 Prefix Delegation applies, as specified in 3GPP TS 29.512 [21]. The /128 IPv6 address applies to wireline and wireless convergence, as described in 3GPP TS 29.512 [21], clause C.2.1.6. + +- + the additional /128 IPv6 addresses, the IPv6 address prefixes or IPv6 prefixes shorter than /64 encoded as "addIpv6Prefixes" attribute; or + +NOTE 2: Additional /128 IPv6 addresses and additional IPv6 prefixes shorter than /64 apply for wireline and wireless convergence, as specified in 3GPP TS 29.512 [21], clause C.2.1.6. + +- (ii) the MAC address encoded as "macAddr48" attribute and/or the additional MAC addresses encoded as "addMacAddrs" attribute; + +- PCF address information consisting of: + +- (i) if the PCF supports the Npcf\_PolicyAuthorization service: + - + the FQDN of the PCF encoded as "pcfFqdn" attribute; and/or + +- + a description of IP endpoints at the PCF hosting the Npcf\_PolicyAuthorization service encoded as "pcfIpEndPoints" attribute; and +- (ii) if the PCF supports the Rx interface: + - + the Diameter host id of the PCF encoded as "pcfDiamHost"; and + - + the Diameter realm of the PCF encoded as "pcfDiamRealm" attributes; +- DNN encoded as "dnn" attribute; +- S-NSSAI encoded as "snssai" attribute; and +- If the "SamePcf" feature defined in clause 5.8 is supported and the PCF determines based on operator policies that the same PCF shall be selected for the SM Policy associations: + - (i) PCF address information for Npcf\_SMPolicyControl service consisting of: + - + the FQDN of the PCF encoded as "pcfSmFqdn" attribute; or + - + a description of IP endpoints at the PCF hosting the Npcf\_SMPolicyControl service encoded as "pcfSmIpEndPoints" attribute; and + - (ii) the parameters combination for selecting the same PCF encoded within the "paraCom" attribute if the PCF registers the binding information for the indicated parameter combination for the first time. + +NOTE 3: When the "SamePcf" feature is supported, the PCF omits the "paraCom" attribute when creates the corresponding binding information related to the subsequent PDU sessions for the same parameter combination. + +and may include: + +- SUPI encoded as "supi" attribute; +- GPSI encoded as "gpsi" attribute; +- IPv4 address domain encoded as "ipDomain" attribute; and +- framed routes consisting of: + - (i) one or more framed routes within the "ipv4FrameRouteList" attribute for IPv4; and/or + - (ii) one or more framed routes within the "ipv6FrameRouteList" attribute for IPv6. + +When the "TimeSensitiveNetworking" feature or the "TimeSensitiveCommunication" feature is supported by the PCF as defined in clause 5.8 of 3GPP TS 29.512 [21], and for Ethernet type of PDU sessions, the address information of the served UE contains the MAC address of the DS-TT port encoded in the "macAddr48" attribute as received by the PCF when the SMF reports the bridge information of the detected TSC user plane node. + +NOTE 4: For the integration with time sensitive communication networks using IP type of applications, the address information of the served UE contains the UE IP address of the corresponding PDU session. + +When the "ExtendedSamePcf" feature is supported the address information of the served UE may be provided if available, i.e., the "ipv4Addr", the "ipv6Prefix" and/or "addIpv6Prefixes" attributes or the "macAddr48" and/or "addMacAddrs" attributes may be provided if available. + +When the "ExtendedSamePcf" feature is supported the PCF address for the Npcf\_PolicyAuthorization and/or Rx interface may be provided if available, i.e., the "pcfFqdn" and/or the "pcfIpEndPoints" attributes, and/or the "pcfDiamHost" and/or the "pcfDiamRealm" attributes may be provided if available. + +NOTE 5: Before requesting the BSF to check if there is an existing PCF binding information for the same UE ID, S-NSSAI and DNN combination registered by other PCF(s), the PCF determines whether the BSF supports the "SamePcf" and/or "ExtendedSamePcf" features either via local configuration or by checking the BSF profile retrieved from the NRF as specified in 3GPP TS 29.510 [12]. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nbsf-management//pcfBindings" as Resource URI and "PcfBinding" data structure as request body, the BSF shall: + +- create new binding information; +- assign a bindingId; and +- store the binding information. + +The PCF as NF service consumer may provide PCF Id in "pcfId" attribute and recovery timestamp in "recoveryTime" attribute. The BSF may use the "pcfId" attribute to supervise the status of the PCF as described in clause 5.2 of 3GPP TS 29.510 [12] and perform necessary clean up upon status change of the PCF later, and/or both the "pcfId" attribute and the "recoveryTime" attribute in clean up procedure as described in clause 6.4 of 3GPP TS 23.527 [17]. + +The PCF as a NF service consumer may provide PCF Set Id within the "pcfSetId" attribute and "bindLevel" attribute set to NF\_SET or provide PCF Set Id within the "pcfSetId" attribute, PCF instance Id within the "pcfId" attribute and "bindLevel" attribute set to NF\_INSTANCE. + +If the BSF created an "Individual PCF for a PDU Session Binding" resource, the BSF shall respond with "201 Created" status code with the message body containing a representation of the created binding information, as shown in figure 4.2.2.2-1, step 2. The BSF shall include a Location HTTP header field containing the URI of the created binding information, i.e. "{apiRoot}/nbsf-management//pcfBindings/{bindingId}". + +If errors occur when processing the HTTP POST request, the PCF shall apply error handling procedures as specified in clause 5.7. + +If the "SamePcf" feature defined in clause 5.8 is supported and the "paraCom" attribute is included in the HTTP POST message, the BSF shall check the received "paraCom" attribute. If the BSF detects that there is an existing PCF binding information including the same "dnn", "snssai" and "supi" attribute values as each of the corresponding attribute values within the "paraCom" attribute, the BSF shall reject the request with an HTTP "403 Forbidden" status code and shall include in the response the "ExtProblemDetails" data structure including the FQDN of the existing PCF hosting the Npcf\_SMPolicyControl service within the "pcfSmFqdn" attribute or the description of IP endpoints at the existing PCF hosting the Npcf\_SMPolicyControl service within the "pcfSmIpEndPoint" attribute of "BindingResp" data structure, and the "cause" attribute of the "ProblemDetails" data structure set to "EXISTING\_BINDING\_INFO\_FOUND". + +#### 4.2.2.3 Register a new PCF for a UE binding information + +![Sequence diagram showing the interaction between an NF service consumer and a BSF to register a new PCF for a UE binding information. Step 1: The consumer sends a POST request to the BSF. Step 2: The BSF responds with a 201 Created status.](70de8885bd7de15723aaad5eb5c5febf_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note right of NF service consumer: 1. POST .../pcf-ue-bindings + NF service consumer->>BSF: Request + Note left of BSF: 2. "201 Created" + BSF-->>NF service consumer: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and a BSF to register a new PCF for a UE binding information. Step 1: The consumer sends a POST request to the BSF. Step 2: The BSF responds with a 201 Created status. + +Figure 4.2.2.3-1: NF service consumer registers a new PCF for a UE binding information + +The NF service consumer shall invoke the Nbsf\_Management\_Register service operation to register the PCF for a UE binding information in the BSF. The NF service consumer shall send for this an HTTP POST request with "{apiRoot}/nbsf-management//pcf-ue-bindings" as Resource URI representing the "PCF for a UE Bindings", as shown in figure 4.2.2.3-1, step 1, to create a binding information for an "Individual PCF for a UE Binding" according to the information in the message body. + +The "PcfForUeBinding" data structure included in the request message body shall include: + +- SUPI encoded as "supi" attribute; and + +- if the PCF supports the Npcf\_AMPolicyAuthorization service, the Npcf\_AMPolicyAuthorization service address information consisting of: + - a. the FQDN of the PCF encoded as "pcfForUeFqdn" attribute; and/or + - b. a description of IP endpoints at the PCF hosting the Npcf\_AMPolicyAuthorization service encoded as "pcfForUeIpEndPoints" attribute; + +NOTE: In this release of the specification the PCF for a UE registering the binding information in the BSF supports the Npcf\_AMPolicyAuthorization service. + +and may include: + +- GPSI encoded as "gpsi" attribute; +- PCF instance Id in "pcfId" attribute; +- the PCF Set identifier in the "pcfSetId" attribute; and +- the binding level in the "bindLevel" attribute. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nbsf-management//pcf-ue-bindings" as Resource URI and "PcfForUeBinding" data structure as request body, the BSF shall: + +- create new binding information; +- assign a bindingId; and +- store the binding information. + +The PCF as a NF service consumer may provide information about the PCF Set and the binding level of subsequent request to the same or different PCF instances for the Npcf\_AMPolicyControl service. The PCF may provide the PCF Set Id within the "pcfSetId" attribute and "bindLevel" attribute set to NF\_SET, or may provide the PCF Set Id within the "pcfSetId" attribute, PCF instance Id within the "pcfId" attribute and "bindLevel" attribute set to NF\_INSTANCE. + +If the BSF created an "Individual PCF for a UE Binding" resource, the BSF shall respond with "201 Created" status code with the message body containing a representation of the created binding information, as shown in figure 4.2.2.3-1, step 2. The BSF shall include a Location HTTP header field containing the URI of the created binding information, i.e. "{apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId}". + +If errors occur when processing the HTTP POST request, the PCF shall apply error handling procedures as specified in clause 5.7. + +#### 4.2.2.4 Register a new PCF for an MBS Session binding information + +![Sequence diagram showing the registration procedure for an MBS Session binding information. The NF service consumer sends a POST request to the BSF, and the BSF responds with a 201 Created status.](2de714cedbbdd36f901f71bafa78f75a_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: Register a new PCF for an MBS Session binding information + NF service consumer->>BSF: 1. POST .../pcf-mbs-bindings (PcfMbsBinding) + BSF-->>NF service consumer: 2. 201 Created (PcfMbsBinding) + +``` + +Sequence diagram showing the registration procedure for an MBS Session binding information. The NF service consumer sends a POST request to the BSF, and the BSF responds with a 201 Created status. + +Figure 4.2.2.4-1: PCF for an MBS Session Binding information Registration procedure + +1. The NF service consumer (e.g. PCF for an MBS Session) shall invoke the Nbsf\_Management\_Register service operation to register a new PCF for an MBS Session binding at the BSF. The NF service consumer shall send for this purpose an HTTP POST request targeting the "PCF for an MBS Session Bindings" resource URI, i.e. "{apiRoot}/nbsf-management//pcf-mbs-bindings", with the request body containing the PcfMbsBinding data structure that shall include: + +- the identifier of the MBS Session to which the MBS Session binding is related, within the "mbsSessionId" attribute; +- the FQDN of the PCF handling the MBS Session, if available, within the "pcfFqdn" attribute; and +- the IP end point(s) of the PCF handling the MBS Session, if available, within the "pcfIpEndPoints" attribute; and may include: + - the identifier of the PCF instance handling the concerned MBS Session, within the "pcfId" attribute; + - the identifier of the PCF set to which the PCF instance handling the concerned MBS Session belongs, within the "pcfSetId" attribute; + - the level of binding of the PCF handling the concerned MBS Session, within the "bindLevel" attribute; and + - the recovery timestamp of the NF service consumer (e.g. PCF for an MBS Session), within the "recoveryTime" attribute. + +If the NF service consumer (e.g. PCF for an MBS Session) provides the PCF instance ID within the "pcfId" attribute, and optionally the recovery timestamp within "recoveryTime" attribute, the BSF may use this information to carry out the clean-up procedures defined in subclause 6.4 of 3GPP TS 23.527 [17], if necessary. + +2. Upon successful processing of the received HTTP POST request, the BSF shall check if there is an existing MBS Session Binding information with the same "mbsSessionId" attribute value. If it is the case, the the BSF shall reject the request with an HTTP "403 Forbidden" status code with the response body containing the MbsExtProblemDetails data structure that shall include the FQDN of the existing PCF within the "pcfFqdn" attribute or the description of the IP endpoints of the existing PCF within the "pcfIpEndPoints" attribute of the MbsBindingResp data structure, and the "cause" attribute of the ProblemDetails data structure set to "EXISTING\_BINDING\_INFO\_FOUND". + +If there is not existing MBS Session Binding information for the provided "mbsSessionId" attribute, the BSF shall create a new "Individual PCF for an MBS Session Binding" resource to store the requested PCF for an MBS Session binding. The BSF shall then respond to the NF service consumer with an HTTP "201 Created" status code including an HTTP Location header field containing the URI of the created "Individual PCF for an MBS Session Binding" resource, and the response body containing a representation of the created resource within the PcfMbsBinding data structure. + +If errors occur when processing the HTTP POST request, the BSF shall apply the error handling procedures, as specified in subclause 5.7. + +### 4.2.3 Nbsf\_Management\_Deregister Service Operation + +#### 4.2.3.1 General + +This service operation allows the NF service consumer to delete existing PCF for a PDU session binding information for a UE at the BSF. It is executed by deleting the corresponding "Individual PCF for a PDU Session Binding" resource. The operation is invoked by issuing an HTTP DELETE request targeting the resource URI representing the specific PCF for a PDU session binding information that is to be deleted. + +This service operation also allows the NF service consumer to delete existing PCF for a UE binding information for a UE at the BSF. It is executed by deleting the corresponding "Individual PCF for a UE Binding" resource. The operation is invoked by issuing an HTTP DELETE request targeting the resource URI representing the specific PCF for a UE binding information that is to be deleted. + +This service operation also allows the NF service consumer to delete existing PCF for an MBS Session binding information for an MBS Session at the BSF. It is executed by deleting the corresponding "Individual PCF for an MBS Session Binding" resource. The operation is invoked by issuing an HTTP DELETE request targeting the resource URI representing the specific PCF for an MBS Session binding information that is to be deleted. + +The following procedures using the Nbsf\_Management\_Deregistration service operation are supported: + +- Deregister an individual PCF for a PDU Session binding information. + +- Deregister an individual PCF for a UE binding information. +- Deregister an individual PCF for an MBS Session binding information. + +#### 4.2.3.2 Deregister an individual PCF for a PDU Session binding information + +![Sequence diagram for PDU Session Binding Information Deregistration](9cd90f495b95ad2116ff780248c26d95_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. DELETE .../pcfBindings/{bindingId} + BSF-->>NF service consumer: 2. 204 No Content +``` + +The diagram shows a sequence of two messages between an NF service consumer and a BSF. The NF service consumer sends a DELETE request to the BSF, and the BSF responds with a 204 No Content status code. + +Sequence diagram for PDU Session Binding Information Deregistration + +**Figure 4.2.3.2-1: PCF for a PDU Session Binding Information Deregistration** + +The NF service consumer shall invoke the Nbsf\_Management\_Deregister service operation to deregister the PCF for a PDU session binding information for a UE in the BSF. The NF service consumer shall send an HTTP DELETE request with "{apiRoot}/nbsf-management//pcfBindings/{bindingId}" as Resource URI, where "{bindingId}" is the "Individual PCF for a PDU Session Binding" resource identifier that is to be deleted, as shown in figure 4.2.3.2-1, step 1. + +Upon the reception of an HTTP DELETE request with: "{apiRoot}/nbsf-management//pcfBindings/{bindingId}" as Resource URI, the BSF shall: + +- remove the corresponding binding information. + +If the HTTP DELETE request message from the NF service consumer is accepted, the BSF shall respond with "204 No Content" status code, as shown in figure 4.2.3.2-1, step 2. + +If errors occur when processing the HTTP DELETE request, the BSF shall send an HTTP error response as specified in clause 5.7. + +If the Individual PCF for a PDU Session Binding resource does not exist, the BSF shall respond with "404 Not Found" error code. + +If the feature "ES3XX" is supported, and the BSF determines the received HTTP DELETE request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.2.3.3 Deregister an individual PCF for a UE binding information + +![Sequence diagram for UE Binding Information Deregistration](1320668e9151c5144f7e3696ae57e07f_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. DELETE .../pcf-ue-bindings/{bindingId} + BSF-->>NF service consumer: 2. "204 No Content" +``` + +The diagram shows a sequence of two messages between an NF service consumer and a BSF. The NF service consumer sends a DELETE request to the BSF, and the BSF responds with a 204 No Content status code. + +Sequence diagram for UE Binding Information Deregistration + +**Figure 4.2.3.3-1: PCF for a UE Binding Information Deregistration** + +The NF service consumer shall invoke the Nbsf\_Management\_Deregister service operation to deregister the session binding information for a UE in the BSF. The NF service consumer shall send an HTTP DELETE request with + +"`{apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId}`" as Resource URI, where "`{bindingId}`" is the "Individual PCF for a UE Binding" resource identifier that is to be deleted, as shown in figure 4.2.3.3-1, step 1. + +Upon the reception of an HTTP DELETE request with: "`{apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId}`" as Resource URI, the BSF shall: + +- remove the corresponding binding information. + +If the HTTP DELETE request message from the NF service consumer is accepted, the BSF shall respond with "204 No Content" status code, as shown in figure 4.2.3.3-1, step 2. + +If errors occur when processing the HTTP DELETE request, the BSF shall send an HTTP error response as specified in clause 5.7. + +If the Individual PCF for a UE Binding resource does not exist, the BSF shall respond with "404 Not Found" error code. + +If the BSF determines the received HTTP DELETE request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.2.3.4 Deregister an individual PCF for an MBS Session binding information + +![Sequence diagram for PCF for an MBS Session Binding information Deregistration procedure. The diagram shows two lifelines: 'NF service consumer' on the left and 'BSF' on the right. Step 1: A message '1. DELETE .../pcf-mbs-bindings/{bindingId}' is sent from the NF service consumer to the BSF. Step 2: A response '2. 204 No Content' is sent from the BSF back to the NF service consumer.](cdd4dfacab004e9979caed3fffea69e5_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. DELETE .../pcf-mbs-bindings/{bindingId} + BSF-->>NF service consumer: 2. 204 No Content + Note right of BSF: +``` + +Sequence diagram for PCF for an MBS Session Binding information Deregistration procedure. The diagram shows two lifelines: 'NF service consumer' on the left and 'BSF' on the right. Step 1: A message '1. DELETE .../pcf-mbs-bindings/{bindingId}' is sent from the NF service consumer to the BSF. Step 2: A response '2. 204 No Content' is sent from the BSF back to the NF service consumer. + +**Figure 4.2.3.4-1: PCF for an MBS Session Binding information Deregistration procedure** + +1. The NF service consumer shall invoke the `Nbsf_Management_Deregister` service operation to deregister an existing PCF for an MBS Session Binding at the BSF. The NF service consumer shall send for this purpose an HTTP DELETE request targeting the URI of the concerned "Individual PCF for an MBS Session Binding" resource, i.e. "`{apiRoot}/nbsf-management//pcf-mbs-bindings/{bindingId}`". +2. Upon success, the BSF shall delete the concerned "Individual PCF for an MBS Session Binding" resource and respond to the NF service consumer with an HTTP "204 No Content" status code. + +If errors occur when processing the HTTP DELETE request, the BSF shall apply the error handling procedures specified in subclause 5.7. + +If the BSF determines the received HTTP DELETE request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If the "Individual PCF for an MBS Session Binding" resource does not exist, the BSF shall respond with "404 Not Found" error code. + +### 4.2.4 Nbsf\_Management\_Discovery Service Operation + +#### 4.2.4.1 General + +This service operation allows the service consumer to use the HTTP GET method to obtain the address information of the selected PCF. + +- Retrieve the PCF binding information for a PDU session. +- Retrieve the PCF binding information for a UE. +- Retrieve the PCF binding information for an MBS Session. + +#### 4.2.4.2 Retrieve the PCF binding information for a PDU session + +![Sequence diagram showing the interaction between an NF service consumer and a BSF to retrieve PCF binding information. The consumer sends a GET request to the BSF, and the BSF responds with a 200 OK containing the binding information.](523ab7b925beb555f88b2e1e1336974f_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. GET .../pcfBindings?query_parameters + BSF-->>NF service consumer: 2. 200 OK (pcfBinding) + +``` + +Sequence diagram showing the interaction between an NF service consumer and a BSF to retrieve PCF binding information. The consumer sends a GET request to the BSF, and the BSF responds with a 200 OK containing the binding information. + +**Figure 4.2.4.2-1: NF service consumer retrieve the PCF binding information for a PDU session** + +The NF service consumer shall invoke the Nbsf\_Management\_Discovery service operation to obtain address information of the selected PCF for a PDU session in the BSF. The NF service consumer shall send an HTTP GET request with "{apiRoot}/nbsf-management//pcfBindings" as Resource URI, and "query parameters" that shall include: + +- UE address; + +and may include: + +- SUPI or GPSI; +- DNN and optionally S-NSSAI; and +- IPv4 address domain. + +NOTE 1: The query parameters S-NSSAI and/or IPv4 address domain are helpful in the scenario of IPv4 address overlapping where the same IPv4 address may be allocated to UE PDU sessions. + +Upon the reception of an HTTP GET request with: "{apiRoot}/nbsf-management//pcfBindings" as Resource URI, the BSF shall search the corresponding binding information. + +If "ipv6Prefix" is used as an UE IPv6 address in the query parameters, the BSF shall use the longest prefix match to find a matching IPv6 prefix so that the IPv6 address in the query parameters is within the address range covered by that matching IPv6 prefix. + +NOTE 2: The matching is done by comparing the /128 IPv6 address of the query parameter with the IPv6 prefix of the PDU session. The management of the IPv6 prefix of the PDU session is specified in 3GPP TS 29.512 [9], clause 4.2.8, and the differences and additions in wireline and wireless convergence scenarios specified in 3GPP TS 23.512 [9], clause C.2.1.6. For IPv6 prefix delegation, the IPv6 network prefix of the PDU session is shorter than /64. + +The IPv6 address in the query parameters shall be formatted as an IPv6 prefix value including the trailing prefix length "/128". If the framed routes exist in the binding information, the BSF shall use framed routes to match the UE address in the query parameters. + +If the HTTP request message from the NF service consumer is accepted and a session binding resource matching the query parameters exists, the BSF shall reply with an HTTP "200 OK" response, as shown in figure 4.2.4.2-1, step 2, containing the corresponding "PcfBinding" data structure, as provided by the PCF during the Nbsf\_Management\_Register Service Operation, in the response body containing PCF addressing information, and if available, the related PCF Set Id and PCF instance Id. If there is no PCF binding information for a PDU session matching the query parameters, the BSF shall respond with an HTTP "204 No Content". + +NOTE 3: The NF service consumer (such as the AF or NEF) uses the PCF binding information as described in 3GPP TS 29.513 [5] clause 8.4.2 (see bullets d) and e) in that clause). If the NF service consumer (such as the AF or NEF) is not able to reach the received PCF address(es), the NF service consumer can use the PCF Set Id and the PCF instance Id as specified in 3GPP TS 29.513 [5] clause 8.4.2. + +If the "PCF for a PDU Session Bindings" resource does not exist, the BSF shall respond with "404 Not Found" HTTP error code. If an invalid combination of query parameters (i.e. a combination without UE address) is contained in the + +request URI, the BSF shall respond with an HTTP "400 Bad Request" error code containing "MANDATORY\_QUERY\_PARAM\_MISSING" as application error within the ProblemDetails IE. If more than one Individual PCF for a PDU Session Binding resources are found, the BSF shall respond with an HTTP "400 Bad Request" error code containing "MULTIPLE\_BINDING\_INFO\_FOUND" as application error within the ProblemDetails IE. + +#### 4.2.4.3 Retrieve the PCF binding information for a UE + +![Sequence diagram showing the NF service consumer retrieving PCF binding information for a UE from the BSF.](a24e89a6fe9bb70c83f8bf5202baba95_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. GET .../pcf-ue-bindings?query_parameters + BSF-->>NF service consumer: 2. 200 OK (array(PcfForUeBinding)) +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a BSF. The NF service consumer sends a GET request to the BSF for PCF-UE bindings with query parameters. The BSF responds with a 200 OK status containing an array of PcfForUeBinding objects. + +Sequence diagram showing the NF service consumer retrieving PCF binding information for a UE from the BSF. + +Figure 4.2.4.3-1: NF service consumer retrieve the PCF binding information for a UE + +The NF service consumer shall invoke the Nbsf\_Management\_Discovery service operation to obtain address information of the selected PCF for a UE in the BSF. The NF service consumer shall send an HTTP GET request with "{apiRoot}/nbsf-management//pcf-ue-bindings" as Resource URI, and "query parameters" that shall include: + +- SUPI and/or GPSI; + +Upon the reception of an HTTP GET request with: "{apiRoot}/nbsf-management//pcf-ue-bindings" as Resource URI, the BSF shall search the corresponding binding information. + +If the HTTP request message from the NF service consumer is accepted and a binding resource matching the query parameters exists, the BSF shall reply with an HTTP "200 OK" response, as shown in figure 4.2.4.3-1, step 2, containing the corresponding "PcfForUeBinding" data structure(s), as provided by the PCF during the Nbsf\_Management\_Register Service Operation, in the response body containing PCF addressing information, and if available, the related PCF Set Id and PCF instance Id. If there is no PCF binding information for a UE matching the query parameters, the BSF shall respond with an HTTP "200 OK" response with an empty array (i.e. "[]" in JSON). + +NOTE: If the NF service consumer (such as the AF or NEF) is not able to reach the received PCF address(es), the NF service consumer can use the PCF Set Id and the PCF instance Id as specified in 3GPP TS 29.513 [5] clause 6.2. + +If the "PCF for a UE Bindings" resource does not exist, the BSF shall respond with a "404 Not Found" HTTP error code. + +#### 4.2.4.4 Retrieve the PCF binding information for an MBS Session + +![Sequence diagram showing the NF service consumer retrieving PCF binding information for an MBS Session from the BSF.](2876be3592c7b4878400b85f209b2b6a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. GET .../pcf-mbs-bindings? + BSF-->>NF service consumer: 2. 200 OK (array(PcfMbsBinding)) +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a BSF. The NF service consumer sends a GET request to the BSF for PCF-MBS bindings with query parameters. The BSF responds with a 200 OK status containing an array of PcfMbsBinding objects. + +Sequence diagram showing the NF service consumer retrieving PCF binding information for an MBS Session from the BSF. + +Figure 4.2.4.4-1: PCF for an MBS Session Binding Retrieval procedure + +1. The NF service consumer (e.g. NEF, MBSF, AF) shall invoke the Nbsf\_Management\_Discovery service operation to obtain from the BSF the addressing information of the selected PCF for an MBS Session. The NF service consumer shall send for this purpose an HTTP GET request targeting the "PCF for an MBS Session Bindings" resource URI, i.e. "{apiRoot}/nbsf-management//pcf-mbs-bindings", which shall include the following query parameters: + - the identifier of the MBS Session to which the requested MBS Session binding is related, within the "mbs-session-id" query parameter; and +2. Upon reception of the HTTP GET request with: "{apiRoot}/nbsf-management//pcf-mbs-bindings" as Resource URI, the BSF shall search the corresponding binding information. Then, + - if the HTTP GET request from the NF service consumer is accepted and a corresponding "Individual PCF for an MBS Session Binding" resource matching the provided query parameters exists, the BSF shall respond with an HTTP "200 OK" response, as shown in figure 4.2.4.4-1, step 2, containing the corresponding "PcfMbsBinding" data structure, as provided by the PCF during the Nbsf\_Management\_Register Service Operation, in the response body containing PCF addressing information, and if available, the related PCF Set Id and PCF instance Id; and + - if there is no PCF binding information for an MBS Session matching the received query parameters, the BSF shall respond with an HTTP "200 OK" response with an empty array (i.e. "[ ]" in JSON). + +NOTE: If the NF service consumer (such as the AF, NEF or MBSF) is not able to reach the received PCF address(es), the NF service consumer can use the PCF Set Id and the PCF instance Id as specified in subclause 8.6 of 3GPP TS 29.513 [5]. + +If errors occur when processing the HTTP GET request, the BSF shall apply the error handling procedures, as specified in subclause 5.7. + +If an invalid combination of query parameters (i.e. a combination without MBS Session Id) is contained in the request URI, the BSF shall respond with an HTTP "400 Bad Request" error code containing "MANDATORY\_QUERY\_PARAM\_MISSING" as application error within the ProblemDetails IE. If more than one Individual PCF for an MBS Session Binding resources are found, the BSF shall respond with an HTTP "400 Bad Request" error code containing "MULTIPLE\_BINDING\_INFO\_FOUND" as application error within the ProblemDetails IE. + +If the "PCF for an MBS Session Bindings" resource does not exist, the BSF shall respond with a "404 Not Found" HTTP error code. + +### 4.2.5 Nbsf\_Management\_Update Service Operation + +#### 4.2.5.1 General + +This service operation allows the NF service consumer to update an existing PCF for a PDU session binding information for a UE in the BSF by providing the information to be updated (e.g. the UE address(es)), and the BSF updates the PDU session binding information. + +This service operation also allows the NF service consumer to update an existing PCF for a UE binding information for a UE in the BSF by providing the information to be updated (e.g. PCF instance, and related PCF address), and the BSF updates the UE binding information. + +This service operation also allows the NF service consumer to update existing PCF for an MBS Session binding information for an MBS Session at the BSF by providing the information to be updated (e.g. PCF instance, PCF addresses), and the BSF update the MBS session binding information. + +The following procedures using the Nbsf\_Management\_Update service operation are supported: + +- Update an existing PCF for a PDU Session binding information. +- Update an existing PCF for a UE binding information. +- Update an existing PCF for an MBS Session binding information. + +#### 4.2.5.2 Update an existing PCF for a PDU Session binding information + +![Sequence diagram showing the interaction between an NF service consumer and a BSF to update a PCF binding. Step 1: The consumer sends a PATCH request to the BSF. Step 2: The BSF responds with a 200 OK status.](844077b3034f0030b404207db0ad76b4_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. PATCH .../pcfBindings/{bindingId} + BSF-->>NF service consumer: 2. 200 OK + +``` + +Sequence diagram showing the interaction between an NF service consumer and a BSF to update a PCF binding. Step 1: The consumer sends a PATCH request to the BSF. Step 2: The BSF responds with a 200 OK status. + +**Figure 4.2.5.2-1: NF service consumer update an existing PCF for a PDU Session binding information** + +If the feature "BindingUpdate" is supported, the NF service consumer shall invoke the Nbsf\_Management\_Update service operation to update PCF for a PDU the session binding information for a UE in the BSF. The NF service consumer shall send an HTTP PATCH request with "{apiRoot}/nbsf-management//pcfBindings/{bindingId}" as Resource URI, where "{bindingId}" is the "Individual PCF for a PDU Session Binding" resource identifier that is to be updated, as shown in figure 4.2.5.2-1, step 1. The "PcfBindingPatch" data structure provided in the request body shall contain the information to be updated as follows. + +The "PcfBindingPatch" data structure: + +- for the IP address information of the served UE: + - a) shall contain the "ipv4Addr" attribute if the IPv4 address is modified, or if the "ExtendedSamePcf" feature is supported, if the IPv4 address was not previously provided, and may contain the "ipDomain" attribute if the IPv4 address domain is modified or if the "ExtendedSamePcf" feature is supported, if the IPv4 address domain was not previously provided and applies. To remove the IPv4 address the "ipv4Addr" attribute shall be set to "null" and if applicable, the "ipDomain" attribute shall be set to "null"; and/or + - b) shall contain the "ipv6Prefix" attribute if the IPv6 address information is modified, or if the "ExtendedSamePcf" feature is supported, if the IPv6 address information was not previously provided. The "ipv6Prefix" attribute shall be set to "null" if the IPv6 address information is removed; and/or + - c) if the "MultiUeAddr" feature is supported, shall contain: + - 1) the "addIpv6Prefixes" attribute containing the new complete list of additional IPv6 Address Prefixes if the additional IPv6 address information is modified, or if the "ExtendedSamePcf" feature is supported, the current list of IPv6 address prefixes if it was not previously provided; or + - 2) the "addIpv6Prefixes" attribute set to "null" if all additional IPv6 Address Prefixes are removed; or +- for the MAC address information of the served UE: + - a) shall contain the "macAddr48" attribute if the MAC address is modified, or if the "ExtendedSamePcf" feature is supported, if the MAC address was not previously provided. The "macAddr48" attribute shall be set to "null" if the MAC address is removed; and/or + - b) if the "MultiUeAddr" feature is supported, shall contain: + - 1) the "addMacAddrs" attribute containing the new complete list of additional MAC addresses if the additional MAC address information is modified, or if the "ExtendedSamePcf" feature is supported, the current list of MAC address(es) if it was not previously provided; or + - 2) the "addMacAddrs" attribute set to "null" if all additional MAC addresses are removed; or +- for the PCF instance and the associated PCF address information of the PCF holding the SM policy association, should contain if a new PCF instance is selected: + - a) the PCF instance ID encoded as "pcfId" attribute; + - b) if the PCF supports the Npcf\_PolicyAuthorization service: + +- 1) the FQDN of the PCF encoded as "pcfFqdn" attribute; and/or + - 2) a description of IP endpoints at the PCF hosting the Npcf\_PolicyAuthorization service encoded as "pcfIpEndPoints" attribute; and/or +- c) if the PCF supports the Rx interface: + - 1) the Diameter host id of the PCF encoded as "pcfDiamHost"; and + - 2) the Diameter realm of the PCF and "pcfDiamRealm" attributes; and/or +- for the S-NSSAI of the PDU session, if the S-NSSAI has been replaced: + - a) shall contain the "snssai" attribute containing the alternate S-NSSAI used to replace the existing S-NSSAI if the "NetSliceRepl" feature is supported. + +If the BSF cannot successfully fulfil the received HTTP PATCH request due to the internal BSF error or due to the error in the HTTP PATCH request, the BSF shall send the HTTP error response as specified in clause 5.7. + +Otherwise, upon the reception of the HTTP PATCH request with: "{apiRoot}/nbsf-management//pcfBindings/{bindingId}" as Resource URI and the "PcfBindingPatch" data structure as request body, the BSF shall update the binding information. + +If the BSF successfully updated an "Individual PCF for a PDU Session Binding" resource, the BSF shall respond with "200 OK" status code with the message body containing the resource representation with the updated PCF for a PDU session binding information in the "PcfBinding" data structure, as shown in figure 4.2.5.2-1, step 2. + +If errors occur when processing the HTTP PATCH request, the BSF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the BSF determines the received HTTP PATCH request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.2.5.3 Update an existing PCF for a UE binding information + +![Sequence diagram showing the interaction between an NF service consumer and a BSF to update a PCF for a UE binding information. The consumer sends a PATCH request to the BSF, and the BSF responds with a 200 OK status.](d3b5eac55166fc428a223bba5c46961b_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note right of NF service consumer: 1. PATCH .../pcf-ue-bindings/{bindingId} + NF service consumer->>BSF: 1. PATCH .../pcf-ue-bindings/{bindingId} + Note left of BSF: 2. "200 OK" + BSF-->>NF service consumer: 2. "200 OK" +``` + +Sequence diagram showing the interaction between an NF service consumer and a BSF to update a PCF for a UE binding information. The consumer sends a PATCH request to the BSF, and the BSF responds with a 200 OK status. + +Figure 4.2.5.3-1: NF service consumer update an existing PCF for a UE binding information + +The NF service consumer shall invoke the Nbsf\_Management\_Update service operation to update the PCF for a UE binding information for a UE in the BSF. The NF service consumer shall send an HTTP PATCH request with "{apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId}" as Resource URI, where "{bindingId}" is the "Individual PCF for a UE Binding" resource identifier that is to be updated, as shown in figure 4.2.5.3-1, step 1. The "PcfForUeBindingPatch" data structure provided in the request body shall contain the information to be updated as follows. + +The "PcfForUeBindingPatch" data structure, for the PCF instance and the associated PCF address information of the PCF holding the AM policy association, shall contain if a new PCF instance is selected: + +- a) the PCF instance ID encoded as "pcfId" attribute; and + +- b) if the PCF supports the Npcf\_AMPolicyAuthorization service, the Npcf\_AMPolicyAuthorization service address information consisting of: + - 1) the FQDN of the PCF encoded as "pcfForUeFqdn" attribute; and/or + - 2) a description of IP endpoints at the PCF hosting the Npcf\_AMPolicyAuthorization service encoded as "pcfForUeIpEndPoints" attribute. + +NOTE: In this release of the specification the PCF for a UE registering the binding information in the BSF supports the Npcf\_AMPolicyAuthorization service. + +If the BSF cannot successfully fulfill the received HTTP PATCH request due to the internal BSF error or due to the error in the HTTP PATCH request, the BSF shall send the HTTP error response as specified in clause 5.7. + +Otherwise, upon the reception of the HTTP PATCH request with: "{apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId}" as Resource URI and the "PcfForUeBindingPatch" data structure as request body, the BSF shall update the binding information. + +If the BSF successfully updated an "Individual PCF for a UE Binding" resource, the BSF shall respond with "200 OK" status code with the message body containing the resource representation with the updated PCF for a UE binding information in the "PcfForUeBinding" data structure, as shown in figure 4.2.5.3-1, step 2. + +If the BSF determines the received HTTP PATCH request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.2.5.4 Update an existing PCF for an MBS Session binding information + +![Sequence diagram showing the interaction between an NF service consumer and a BSF to update an existing PCF for an MBS Session binding information.](dd380ccd5aca1151074fede04826f1a4_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: Update an existing PCF for an MBS Session binding information + NF service consumer->>BSF: 1. PATCH .../pcf-mbs-bindings/{bindingId} (PcfMbsBindingPatch) + BSF-->>NF service consumer: 2. 200 OK (PcfMbsBinding) / 204 No Content +``` + +Sequence diagram showing the interaction between an NF service consumer and a BSF to update an existing PCF for an MBS Session binding information. + +Figure 4.2.5.4-1: NF service consumer updates an existing PCF for an MBS Session binding information + +1. The NF service consumer (e.g. PCF handling the MBS Session) shall invoke the Nbsf\_Management\_Update service operation to request the modification of an existing PCF for an MBS Session binding information for an MBS Session at the BSF. The NF service consumer shall send for this purpose an HTTP PATCH request targeting the URI of the concerned "Individual PCF for an MBS Session Binding" resource, i.e. "{apiRoot}/nbsf-management//pcf-mbs-bindings/{bindingId}", with the request body containing the PcfMbsBindingPatch data structure including the requested modifications. +2. Upon successful modification of the PCF for an MBS Session binding, the BSF shall respond with either: + - an HTTP "200 OK" status code with the response body containing a representation of the updated "Individual PCF for an MBS Session Binding" resource within the PcfMbsBinding data structure; or + - an HTTP "204 No Content" status code. + +If errors occur when processing the HTTP PATCH request, the BSF shall apply the error handling procedures specified in subclause 5.7. + +If the BSF determines the received HTTP PATCH request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +### 4.2.6 Nbsf\_Management\_Subscribe Service Operation + +#### 4.2.6.1 General + +This service operation is used by an NF service consumer to subscribe to the notifications of registration/deregistration events for the PCF for a PDU Session or PCF for a UE. + +The following procedures using the Nbsf\_Management\_Subscribe service operation are supported: + +- Creating a new subscription; +- Modifying an existing subscription. + +#### 4.2.6.2 Creating a new subscription + +Figure 4.2.6.2-1 illustrates the creation of a subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the BSF, and the BSF responds with a 201 Created status.](f1fbb1287d999c7034742de35bdab836_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant BSF + Note right of NF service consumer: 1. POST .../subscriptions + NF service consumer->>BSF: Request + Note left of BSF: 2. "201 Created" + BSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the BSF, and the BSF responds with a 201 Created status. + +**Figure 4.2.6.2-1: Creation of a subscription** + +To subscribe to event notifications, the NF service consumer shall send an HTTP POST request with: "{apiRoot}/nbsf-management//subscriptions" as Resource URI and the BsfSubscription data structure as request body that shall include: + +- an URI where to receive the requested notifications within the "notifUri" attribute; +- a Notification Correlation Identifier provided by the NF service consumer for the requested notifications within the "notifCorrelId" attribute; +- identification of the events to subscribe as "events" attribute; +- the SUPI within the "supi" attribute; +- if the NF service consumer subscribes to event notifications of newly registered and deregistered PCF for a PDU session, the "events" attribute indicating "PCF\_PDU\_SESSION\_BINDING\_REGISTRATION"/"PCF\_PDU\_SESSION\_BINDING\_DEREGISTRATION" and/or subscribes to the event notifications of binding registration of the first PDU session and deregistration of the last PDU session for a S-NSSAI and DNN combination indicating "SNSSAI\_DNN\_BINDING\_REGISTRATION"/"SNSSAI\_DNN\_BINDING\_DEREGISTRATION" respectively, and one DNN and S-NSSAI pair to which the subscription applies within the "snssaiDnnPairs" attribute and, when the subscription applies to more than one DNN and S-NSSAI, the list of the remaining DNN and S-NSSAI pairs to which the subscription applies within the "addSnssaiDnnPairs" attribute, which includes the DNN within the "dnn" attribute and the S-NSSAI within the "snssai" attribute; + +NOTE 1: When the subscribed event is SNSSAI\_DNN\_BINDING\_REGISTRATION and SNSSAI\_DNN\_BINDING\_DEREGISTRATION, only the status of the binding for the concerned S-NSSAI and DNN combination is reported, i.e., it is not needed to report the complete binding related information, but only an indication of registration or deregistration event. + +- if the NF service consumer subscribes to event notifications of newly registered and deregistered PCF for a UE, the "events" attribute indicating "PCF\_UE\_BINDING\_REGISTRATION"/"PCF\_UE\_BINDING\_DEREGISTRATION". + +The BsfSubscription data structure as request body may also include: + +- the GPSI within the "gpsi" attribute. + +If the BSF cannot successfully fulfil the received HTTP POST request due to an internal BSF error or an error in the HTTP POST request, the PCF shall send an HTTP error response as specified in clause 5.7. + +Upon successful reception of the HTTP POST request with "{apiRoot}/nbsf-management//subscriptions" as request URI and "BsfSubscription" data structure as request body, the BSF shall create a new "Individual Binding Subscription" resource, store the subscription and send a HTTP "201 Created" response as shown in figure 4.2.6.2-1, step 2. The BSF shall include in the "201 Created" response: + +- a Location header field; and +- a "BsfSubscriptionResp" data type in the content. + +The Location header field shall contain the URI of the created individual application session context resource i.e., "{apiRoot}/nbsf-management//subscriptions/{subId}". + +The "BsfSubscriptionResp" data type shall contain: + +- the representation of the created "Individual Binding Subscription" resource within the "BsfSubscription" data type; and +- when the BSF already has available the requested information at the time of the event subscription request, the related notification information within the "BsfNotification" data type as specified in clause 4.2.8.2. + +The subscription to any event lasts till the NF service consumer terminates it as described in subclause 4.2.7.2. For every subscribed event, the continuous reporting notification method shall apply. + +#### 4.2.6.3 Modifying an existing subscription + +Figure 4.2.6.3-1 illustrates the modification of an existing subscription. + +![Sequence diagram illustrating the modification of an existing subscription. The NF service consumer sends a PUT request to the BSF. The BSF responds with either a 200 OK or a 204 No Content.](db7ae70402c81d140ae7df14b002e057_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note right of NF service consumer: 1. PUT .../subscriptions/{subId} + NF service consumer->>BSF: Request + Note left of BSF: 2a. "200 OK" +2b. "204 No Content" + BSF-->>NF service consumer: Response +``` + +Sequence diagram illustrating the modification of an existing subscription. The NF service consumer sends a PUT request to the BSF. The BSF responds with either a 200 OK or a 204 No Content. + +Figure 4.2.6.3-1: Modification of an existing subscription + +To modify an existing subscription to event notifications, the NF service consumer shall send an HTTP PUT request with: "{apiRoot}/nbsf-management//subscriptions/{subId}" as Resource URI, where "{subId}" is the subscription correlation ID of the existing subscription, and BsfSubscription data structure as request body as described in clause 4.2.6.2. + +NOTE 1: The "notifUri" attribute within the BsfSubscription data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +NOTE 2: This service operation does not allow the unsubscription of all subscribed events. The unsubscription of all subscribed events is described in clause 4.2.7.2. + +Upon the reception of an HTTP PUT request with: "{apiRoot}/nbsf-management//subscriptions/{subId}" as Resource URI and BsfSubscription data structure as request body, if the received HTTP request is successfully processed and accepted, the BSF shall: + +- update the concerned subscription; and +- send an HTTP "200 OK" response with a response body containing a representation of the updated subscription in the BsfSubscriptionResp data structure or send an HTTP "204 No Content". + +If errors occur when processing the HTTP PUT request, the BSF shall send an HTTP error response as specified in clause 5.7. + +If the BSF determines the received HTTP PUT request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +### 4.2.7 Nbsf\_Management\_Unsubscribe Service Operation + +#### 4.2.7.1 General + +This service operation is used by an NF service consumer to unsubscribe from event notifications. + +The following procedure using the Nbsf\_Management\_Unsubscribe service operation is supported: + +- Unsubscription from event notifications. + +#### 4.2.7.2 Unsubscription from event notifications + +Figure 4.2.7.2-1 illustrates the unsubscription from event notifications. + +![Sequence diagram showing the unsubscription process between an NF service consumer and a BSF.](d5918cee231b536f20789a18d861fae3_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note right of NF service consumer: 1. DELETE .../subscriptions/{subId} + NF service consumer->>BSF: 1. DELETE .../subscriptions/{subId} + Note left of BSF: 2. "204 No Content" + BSF-->>NF service consumer: 2. "204 No Content" +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a BSF. The NF service consumer sends a DELETE request to the BSF, and the BSF responds with a 204 No Content status. The sequence is as follows: 1. The NF service consumer sends a DELETE request to the BSF. 2. The BSF responds with a 204 No Content status. + +Sequence diagram showing the unsubscription process between an NF service consumer and a BSF. + +Figure 4.2.7.2-1: Unsubscription from event notifications + +To unsubscribe from all event(s) notifications, the NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nbsf-management//subscriptions/{subId}" as Resource URI, where "{subId}" is the subscription correlation ID of the existing subscription that is to be deleted. + +Upon the reception of the HTTP DELETE request with: "{apiRoot}/nbsf-management//subscriptions/{subId}" as Resource URI, if the received HTTP request is successfully processed and accepted, the BSF shall: + +- remove the corresponding subscription; and +- send an HTTP "204 No Content" response. + +If errors occur when processing the HTTP DELETE request, the BSF shall send an HTTP error response as specified in clause 5.7. + +If the BSF determines the received HTTP DELETE request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +### 4.2.8 Nbsf\_Management\_Notify Service Operation + +#### 4.2.8.1 General + +The Nbsf\_Management\_Notify service operation enables the BSF to send notifications to NF service consumers upon the occurrence of a previously subscribed event. + +The following procedure using the Nbsf\_Management\_Notify service operation is supported: + +- Notification about subscribed events. + +#### 4.2.8.2 Notification about subscribed events + +The present "notification about subscribed events" procedure is performed by the BSF when any of the subscribed events occur. + +Figure 4.2.8.2-1 illustrates the notification about subscribed events. + +![Sequence diagram illustrating the notification about subscribed events. The diagram shows two lifelines: BSF and NF service consumer. Step 1: BSF sends a POST {notifUri} request to the NF service consumer. Step 2: NF service consumer responds with a 204 No Content response.](68d8089266ace7197304b43dcaf5d08e_img.jpg) + +``` +sequenceDiagram + participant BSF + participant NF as NF service consumer + Note right of BSF: 1. POST {notifUri} + BSF->>NF: 1. POST {notifUri} + Note left of NF: 2. "204 No Content" + NF-->>BSF: 2. "204 No Content" +``` + +Sequence diagram illustrating the notification about subscribed events. The diagram shows two lifelines: BSF and NF service consumer. Step 1: BSF sends a POST {notifUri} request to the NF service consumer. Step 2: NF service consumer responds with a 204 No Content response. + +Figure 4.2.8.2-1: Notification about subscribed events + +If the BSF observes event(s) for which an NF service consumer has subscribed, the BSF shall send an HTTP POST request as shown in figure 4.2.8.2-1, step 1, with the "{notifUri}" as request URI containing the value previously provided by the NF service consumer within the corresponding subscription, and the BsfNotification data structure. + +The BsfNotification data structure shall include: + +- the notification correlation ID provided by the NF service consumer during the subscription within "notifCorreId" attribute; +- the list of the reported events within the "eventNotifs" attribute. For each reported event, the BsfEventNotification data type shall include the event identifier and may include additional event information. + +Within each instance of BsfEventNotification data type, the BSF shall include: + +- When a subscription to "PCF\_PDU\_SESSION\_BINDING\_REGISTRATION" and "PCF\_PDU\_SESSION\_BINDING\_DEREGISTRATION" exists: + - a. When the BSF detects the registration of a PCF for a PDU session for a DNN and S-NSSAI, SUPI, and GPSI, if available, matching one of the DNN, S-NSSAI pairs, the SUPI and the GPSI, if available, provided during subscription, the BSF shall set the "event" attribute to "PCF\_PDU\_SESSION\_BINDING\_REGISTRATION" and shall include the "pcfForPduSessInfos" with the binding information of the detected PDU session. + - b. When the BSF detects the deregistration of a PCF for a PDU session for a DNN and S-NSSAI, SUPI, and GPSI, if available, matching one of the DNN, S-NSSAI pairs, the SUPI and the GPSI, if available, provided during subscription, the BSF shall set the "event" attribute to + +"PCF\_PDU\_SESSION\_BINDING\_DEREGISTRATION" and shall include the "pcfForPduSessInfos" with the binding information of the removed PDU session. + +- When a subscription to "PCF\_UE\_BINDING\_REGISTRATION" and "PCF\_UE\_BINDING\_DEREGISTRATION" exists: + - a. When the BSF detects the registration of a PCF for a UE for a SUPI and, if available, GPSI matching the SUPI and, if available, GPSI provided during subscription, the BSF shall set the "event" attribute to "PCF\_UE\_BINDING\_REGISTRATION" and shall include the "pcfForUeInfo" with the binding information of the detected UE. + - b. When the BSF detects the deregistration of a PCF for a UE for a SUPI and, if available, GPSI matching the SUPI and, if available, GPSI provided during subscription, the BSF shall set the "event" attribute to "PCF\_UE\_BINDING\_DEREGISTRATION" and shall include the "pcfForUeInfo" with the binding information of the removed UE. +- When a subscription to "SNSSAI\_DNN\_BINDING\_REGISTRATION" and "SNSSAI\_DNN\_BINDING\_DEREGISTRATION" exists: + - a. When the BSF detects the registration of PCF for a PDU session for a DNN and S-NSSAI, SUPI, and GPSI, if available, matching one of the DNN, S-NSSAI pairs, the SUPI and the GPSI, if available, provided during subscription, and this is the first PDU session for the DNN and S-NSSAI, SUPI, and GPSI, if available, combination, the BSF shall set the "event" attribute to "SNSSAI\_DNN\_BINDING\_REGISTRATION" and the "matchSnssaiDnns" attribute with the matching S-NSSAI and DNN pairs. + - b. When the BSF detects the deregistration of PCF for a PDU session for a DNN and S-NSSAI, SUPI, and GPSI, if available, matching one of the DNN, S-NSSAI pairs, the SUPI and the GPSI, if available, provided during subscription, and this is the last PDU session for the DNN and S-NSSAI, SUPI, and GPSI, if available, combination, the BSF shall set the "event" attribute to "SNSSAI\_DNN\_BINDING\_DEREGISTRATION" and the removed S-NSSAI and DNN combinations within the "matchSnssaiDnns" attribute. + +If the HTTP POST request from the BSF is accepted, the NF service consumer shall acknowledge the receipt of the event notification with a "204 No Content" response to HTTP POST request, as shown in figure 4.2.8.2-1, step 2. + +If the HTTP POST request from the BSF is not accepted, the NF service consumer shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 5.7. If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +# --- 5 Nbsf\_Management Service API + +## 5.1 Introduction + +The Nbsf\_Management Service shall use the Nbsf\_Management API. + +The API URI of the Nbsf\_Management API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the BSF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nbsf-management". +- The shall be "v1". + +- The `` shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nbsf\_Management is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +#### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [9], 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 [6]. 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 9457 [13]. + +JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" and shall be signalled by the content type "application/merge-patch+json", as defined in IETF RFC 7396 [20]. + +### 5.2.3 HTTP custom headers + +#### 5.2.3.1 General + +The Nbsf\_Management Service API shall support the mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nbsf\_Management Service API. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +The structure of the Resource URI of the Nbsf\_Management service is shown in figure 5.3.1-1. + +![Resource URI structure of the Nbsf_Management API diagram](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +{apiRoot}/nbsf-management/ + +``` +graph TD; Root["{apiRoot}/nbsf-management/"] --- pcfBindings["/pcfBindings"]; Root --- pcfUeBindings["/pcf-ue-bindings"]; Root --- pcfMbsBindings["/pcf-mbs-bindings"]; Root --- subscriptions["/subscriptions"]; pcfBindings --- bindingId1["/{bindingId}"]; pcfUeBindings --- bindingId2["/{bindingId}"]; pcfMbsBindings --- bindingId3["/{bindingId}"]; subscriptions --- subId["/{subId}"]; +``` + +The diagram illustrates the hierarchical structure of the Nbsf\_Management API. The root path is {apiRoot}/nbsf-management/. It branches into four main resource paths: /pcfBindings, /pcf-ue-bindings, /pcf-mbs-bindings, and /subscriptions. Each of these paths further branches into a specific resource identifier: /{bindingId} for the first three, and /{subId} for subscriptions. + +Resource URI structure of the Nbsf\_Management API diagram + +**Figure 5.3.1-1: Resource URI structure of the Nbsf\_Management API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 5.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------------------|----------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| PCF for a PDU Session Bindings | /pcfBindings

(NOTE) | POST | Register a new PCF for a PDU Session binding information of a given UE address in the BSF. | +| | | GET | Retrieve the PCF for a PDU Session binding information i.e. PCF address information of a given tuple (UE address, SUPI; GPSI, DNN, S-NSSAI). | +| Individual PCF for a PDU Session Binding | /pcfBindings/{bindingId}

(NOTE) | DELETE | Deregister an existing PCF for a PDU Session binding information from the BSF. | +| | | PATCH | Update an existing PCF for a PDU Session binding information in the BSF. | +| PCF for a UE Bindings | /pcf-ue-bindings | POST | Register a new PCF for a UE binding information of a given UE identity in the BSF. | +| | | GET | Retrieve the PCF for a UE binding information i.e. PCF address information of a UE. | +| Individual PCF for a UE Binding | pcf-ue-bindings/{bindingId} | DELETE | Deregister an existing PCF for a UE binding information from the BSF. | +| | | PATCH | Update an existing PCF for a UE binding information in the BSF. | +| PCF for an MBS Session Bindings | /pcf-mbs-bindings | POST | Register a new PCF for an MBS Session Binding. | +| | | GET | Retrieve PCF for an MBS Session Binding information. | +| Individual PCF for an MBS Session Binding | /pcf-mbs-bindings/{bindingId} | PATCH | Modify an existing PCF for an MBS Session Binding. | +| | | DELETE | Deregister an existing PCF for an MBS Session Binding. | +| Binding Subscriptions | /subscriptions | POST | Create a new Individual Binding Subscription resource. | +| Individual Binding Subscription | /subscriptions/{subId} | PUT | Modify an existing Individual Binding Subscription resource. | +| | | DELETE | Delete an Individual Binding Subscription resource and cancel the related subscription. | + +NOTE: The path segment does not follow the related naming convention defined in 3GPP TS 29.501 [7]. The path segment is kept though as defined in the current specification for backward compatibility considerations. + +### 5.3.2 Resource: PCF for a PDU Session Bindings + +#### 5.3.2.1 Description + +This resource represents a collection of the different PCF for a PDU Session binding information of given UE address(es) registered in the BSF. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//pcfBindings + +The shall be set as described in clause 5.1. + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------|---|-------------|----------------------------------------------------------------------| +| PcfBinding | M | 1 | Register a new Individual PCF for a PDU Session binding information. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------|---------------------------------------------------------------------------------------------------| +| PcfBinding | M | 1 | 201
Created | The creation of an individual PCF for a PDU Session binding. | +| ExtProblemDetails | O | 0..1 | 403
Forbidden | The existing PCF binding information stored in the BSF for the indicated combination is returned. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. | | | | | + +**Table 5.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}/nbsf-management//pcfBindings/{bindingId} | + +##### 5.3.2.3.2 GET + +This method shall support the URI query parameters specified in table 5.3.2.3.2-1. + +Table 5.3.2.3.2-1: URI query parameters supported by the GET method on this resource + +| Name | Data type | P | Cardinality | Description | +|------------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipv4Addr
(NOTE 7) | Ipv4Addr | C | 0..1 | The IPv4 Address of the served UE. (NOTE 1) (NOTE 3) (NOTE 4) | +| ipv6Prefix
(NOTE 7) | Ipv6Prefix | C | 0..1 | The IPv6 Address of the served UE. (NOTE 1) (NOTE 3) (NOTE 4)
The NF service consumer shall append '/128' to the IPv6 address in the attribute value. E.g. '2001:db8:85a3::8a2e:370:7334/128'. | +| macAddr48
(NOTE 7) | MacAddr48 | C | 0..1 | The MAC Address of the served UE. (NOTE 1) | +| dnn | Dnn | O | 0..1 | Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 6) | +| supi | Supi | O | 0..1 | Subscription Permanent Identifier | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier | +| snssai | Snssai | O | 0..1 | The identification of slice. (NOTE 2) | +| ipDomain
(NOTE 7) | string | O | 0..1 | The IPv4 address domain identifier. (NOTE 2) | +| supp-feat | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. (NOTE 5) | + +NOTE 1: One and only one of query parameter ipv4Addr, ipv6Prefix or macAddr48 shall be present. +NOTE 2: The query parameters snssai and/or ipDomain, if applicable (IPv4 address overlapping), shall be present with query parameter ipv4Addr. +NOTE 3: 5G-RG and FN-RG replaces UE for wireline access support. See 3GPP TS 23.316 [19]. +NOTE 4: The ipv4Addr and ipv6Prefix query parameters may include the IP address of devices in networks behind the UE (see clauses 5.6.14 and 5.8.2.2 of 3GPP TS 23.501 [2] and clause 4.6.2.3 of 3GPP TS 23.316 [19]). +NOTE 5: This query parameter may be present when there are supported features that apply to the retrieval of the "Individual PCF for a PDU Session Binding" resource as defined in clause 4.2.4.2. Otherwise, it shall be omitted. +NOTE 6: The BSF uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. +NOTE 7: The query parameter does not follow the related naming convention (i.e. "lower-with-hyphen") defined in clause 5.1.3.3 of 3GPP TS 29.501 [7]. This query parameter is however kept as currently defined in this specification for backward compatibility considerations. + +This method shall support the request data structures specified in table 5.3.2.3.2-2 and the response data structures and response codes specified in table 5.3.2.3.2-3. + +Table 5.3.2.3.2-2: Data structures supported by the GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.2.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|-----------------|----------------------------------------------------------------------------------------------------------------| +| PcfBinding | M | 1 | 200 OK | The individual PCF for a PDU Session binding information resource matching the query parameter(s) is returned. | +| n/a | | | 204 No Content | There is no PCF for a PDU Session binding information matching the query parameter(s). | +| ProblemDetails | O | 0..1 | 400 Bad Request | More than one binding information is found. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. +NOTE 2: Failure cases are described in clause 5.7. + +### 5.3.3 Resource: Individual PCF for a PDU Session Binding + +#### 5.3.3.1 Description + +This resource represents an individual PCF for a PDU Session binding information of a given UE address(es) registered in the BSF. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//pcfBindings/{bindingId} + +The shall be set as described in clause 5.1. + +This resource shall support the resource URI variables defined in table 5.3.3.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| bindingId | string | Represents the individual PCF for a PDU Session Binding. To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [7]. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-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.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.3.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.1-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 PCF for a PDU Session binding information resource is deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a PDU Session Binding deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a PDU Session Binding deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +**Table 5.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-----------------------------------------------| +| PcfBindingPatch | M | 1 | Update an individual PCF binding information. | + +**Table 5.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PcfBinding | M | 1 | 200 OK | Successful case: The Individual PCF for a PDU Session binding information resource is updated. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a PDU Session Binding modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a PDU Session Binding modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +### 5.3.4 Resource: Binding Subscriptions + +#### 5.3.4.1 Description + +The Binding Subscriptions resource represents the collection of subscriptions to events in the Nbsf\_Management service. + +#### 5.3.4.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//subscriptions + +The shall be set as described in clause 5.1. + +This resource shall support the resource URI variables defined in table 5.3.4.2-1. + +**Table 5.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +#### 5.3.4.3 Resource Standard Methods + +##### 5.3.4.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.4.3.1-1. + +**Table 5.3.4.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.4.3.1-2 and the response data structures and response codes specified in table 5.3.4.3.1-3. + +**Table 5.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|--------------------------------------------------------| +| BsfSubscription | M | 1 | Create a new Individual binding Subscription resource. | + +**Table 5.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------| +| BsfSubscriptionResp | M | 1 | 201 Created | The creation of an Individual Binding Subscription resource is confirmed. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. | | | | | + +**Table 5.3.4.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}/nbsf-management//subscriptions/{subId} | + +#### 5.3.4.4 Resource Custom Operations + +None. + +### 5.3.5 Resource: Individual Binding Subscription + +#### 5.3.5.1 Description + +The Individual Binding Subscription resource represents a single subscription to the event notification in the service. + +#### 5.3.5.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//subscriptions/{subId} + +The shall be set as described in clause 5.1. + +This resource shall support the resource URI variables defined in table 5.3.5.2-1. + +**Table 5.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| subId | string | Identifies a subscription to event notification. | + +#### 5.3.5.3 Resource Standard Methods + +##### 5.3.5.3.1 PUT + +This method shall support the URI query parameters specified in table 5.3.5.3.1-1. + +**Table 5.3.5.3.1-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.3.5.3.1-2 and the response data structures and response codes specified in table 5.3.5.3.1-3. + +**Table 5.3.5.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| BsfSubscription | M | 1 | Modify the existing Individual Binding Subscription resource matching the subId according to the representation in the BsfSubscription. | + +**Table 5.3.5.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| BsfSubscriptionResp | M | 1 | 200 OK | Successful case: The Individual Binding Subscription resource matching the subId was modified and a representation is returned. | +| n/a | | | 204 No Content | Successful case: The Individual Binding Subscription resource matching the subId was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Binding Subscription modification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Binding Subscription modification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.3.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +**Table 5.3.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +##### 5.3.5.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.3.5.3.2-1. + +**Table 5.3.5.3.2-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.3.5.3.2-2 and the response data structures and response codes specified in table 5.3.5.3.2-3. + +**Table 5.3.5.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.5.3.2-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 Binding Subscription resource matching the subId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a PDU Session Binding deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a PDU Session Binding deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.3.5.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +**Table 5.3.5.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +#### 5.3.5.4 Resource Custom Operations + +None. + +### 5.3.6 Void + +### 5.3.7 Resource: PCF for a UE Bindings + +#### 5.3.7.1 Description + +This resource represents a collection of the different PCF for a UE binding information of given UE identifier (i.e., SUPI) registered in the BSF. + +#### 5.3.7.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//pcf-ue-bindings + +The shall be set as described in clause 5.1. + +This resource shall support the resource URI variables defined in table 5.3.7.2-1. + +**Table 5.3.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +#### 5.3.7.3 Resource Standard Methods + +##### 5.3.7.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.7.3.1-1. + +**Table 5.3.7.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.7.3.1-2 and the response data structures and response codes specified in table 5.3.7.3.1-3. + +**Table 5.3.7.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-------------------------------------------------------------| +| PcfForUeBinding | M | 1 | Register a new Individual PCF for a UE Binding information. | + +**Table 5.3.7.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------| +| PcfForUeBinding | M | 1 | 201
Created | The creation of an individual PCF for a UE Binding. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. | | | | | + +**Table 5.3.7.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}/nbsf-management//pcf-ue-bindings/{bindingId} | + +##### 5.3.7.3.2 GET + +This method shall support the URI query parameters specified in table 5.3.7.3.2-1. + +**Table 5.3.7.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|--------------------------------------------------------------------------| +| supi | Supi | O | 0..1 | Subscription Permanent Identifier. (NOTE 1) | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier. (NOTE 1) | +| supp-feat | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. (NOTE 2) | + +NOTE 1: At least one parameter shall be present. + +NOTE 2: This query parameter may be present when there are supported features that apply to the retrieval of the "Individual PCF for a UE Binding" resource as defined in clause 4.2.4.3. Otherwise, it shall be omitted. + +This method shall support the request data structures specified in table 5.3.7.3.2-2 and the response data structures and response codes specified in table 5.3.7.3.2-3. + +**Table 5.3.7.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.7.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------| +| array(PcfForUeBinding) | M | 0..N | 200 OK | The individual PCF for a UE binding resource(s) matching the query parameter(s) are returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. | | | | | + +### 5.3.8 Resource: Individual PCF for a UE Binding + +#### 5.3.8.1 Description + +This resource represents an individual PCF for a UE binding information of given UE identifier (i.e SUPI) registered in the BSF. + +#### 5.3.8.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId} + +The shall be set as described in clause 5.1. + +This resource shall support the resource URI variables defined in table 5.3.8.2-1. + +**Table 5.3.8.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| bindingId | string | Represents the individual PCF for a UE Binding.
To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [7]. | + +#### 5.3.8.3 Resource Standard Methods + +##### 5.3.8.3.1 DELETE + +This method shall support the URI query parameters specified in table 5.3.8.3.1-1. + +**Table 5.3.8.3.1-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.3.8.3.1-2 and the response data structures and response codes specified in table 5.3.8.3.1-3. + +**Table 5.3.8.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.8.3.1-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 PCF for a UE Binding information resource is deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a UE Binding deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a UE Binding deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. | | | | | + +**Table 5.3.8.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 BSF (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.3.8.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 BSF (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.3.8.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.3.8.3.2-1. + +**Table 5.3.8.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.8.3.2-2 and the response data structures and response codes specified in table 5.3.8.3.2-3. + +**Table 5.3.8.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|--------------------------------------------------------| +| PcfForUeBinding
Patch | M | 1 | Update an individual PCF for a UE binding information. | + +**Table 5.3.8.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PcfForUeBinding | M | 1 | 200 OK | Successful case: The Individual PCF for a UE binding information resource is updated. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a PDU Session Binding modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a PDU Session Binding modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.3.8.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +**Table 5.3.8.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +### 5.3.9 Resource: PCF for an MBS Session Bindings + +#### 5.3.9.1 Description + +This resource represents the collection of PCF for an MBS Session Bindings registered at the BSF. + +#### 5.3.9.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//pcf-mbs-bindings + +The shall be set as described in clause 5.1. + +This resource shall support the resource URI variables defined in table 5.3.9.2-1. + +**Table 5.3.9.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------| +| apiRoot | string | See subclause 5.1. | + +#### 5.3.9.3 Resource Standard Methods + +##### 5.3.9.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.9.3.1-1. + +**Table 5.3.9.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.9.3.1-2 and the response data structures and response codes specified in table 5.3.9.3.1-3. + +**Table 5.3.9.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|--------------------------------------------------------------------------------------| +| PcfMbsBinding | M | 1 | Contains the parameters to request to register a new PCF for an MBS Session Binding. | + +**Table 5.3.9.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| PcfMbsBinding | M | 1 | 201 Created | Successful case. A new "Individual PCF for an MBS Session Binding" resource is created and the corresponding URI is returned in an HTTP Location header. | +| MbsExtProblemDetails | O | 0..1 | 403 Forbidden | The existing PCF binding information stored in the BSF for the MBS session shall be returned within the MbsExtProblemDetails data structure.
(NOTE 2) | +| NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. | | | | | +| NOTE 2: Failure cases are described in clause 5.7. | | | | | + +**Table 5.3.9.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}/nbsf-management//pcf-mbs-bindings/{bindingId} | + +##### 5.3.9.3.2 GET + +This method shall support the URI query parameters specified in table 5.3.9.3.2-1. + +**Table 5.3.9.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbs-session-id | MbsSessionId | M | 1 | Contains the identifier of the MBS Session to which the requested MBS Session binding is related. | +| supp-feat | SupportedFeatures | C | 0..1 | Contains the list of features supported by the NF service consumer and used to filter irrelevant responses related to unsupported features.

This query parameter shall be included if feature negotiation needs to take place. | + +This method shall support the request data structures specified in table 5.3.9.3.2-2 and the response data structures and response codes specified in table 5.3.9.3.2-3. + +**Table 5.3.9.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.9.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------------|---|-------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------| +| array(PcfMbsBinding)

(NOTE 2) | M | 0..N | 200 OK | Successful case. The "Individual PCF for an MBS Session Binding" resource matching the provided query parameter(s) is returned. | +| ProblemDetails | O | 0..1 | 400 Bad Request | More than one binding information matching the provided query parameter(s) is found.

(NOTE 3) | + +NOTE 1: The mandatory HTTP error status codes for the HTTP GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. +NOTE 2: In this release of the specification, only a single element shall be provided within the array. +NOTE 3: Failure cases are described in clause 5.7. + +#### 5.3.9.4 Resource Custom Operations + +None. + +### 5.3.10 Resource: Individual PCF for an MBS Session Binding + +#### 5.3.10.1 Description + +This resource represents an "Individual PCF for an MBS Session Binding" registered at the BSF. + +#### 5.3.10.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//pcf-mbs-bindings/{bindingId} + +The shall be set as described in clause 5.1. + +This resource shall support the resource URI variables defined in table 5.3.10.2-1. + +**Table 5.3.10.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See subclause 5.1. | +| bindingId | string | Represents the identifier of the "Individual PCF for an MBS Session Binding" resource.
To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [7]. | + +#### 5.3.10.3 Resource Standard Methods + +##### 5.3.10.3.1 PATCH + +This method shall support the URI query parameters specified in table 5.3.10.3.1-1. + +**Table 5.3.10.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.10.3.1-2 and the response data structures and response codes specified in table 5.3.10.3.1-3. + +**Table 5.3.10.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------------------------------------------| +| PcfMbsBindingPatch | M | 1 | Contains the requested modifications to the PCF for an MBS Session Binding. | + +**Table 5.3.10.3.1-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PcfMbsBinding | M | 1 | 200 OK | Successful case: The "Individual PCF for an MBS Session Binding" resource is successfully modified and a representation of the updated resource is returned in the response body. | +| n/a | | | 204 No Content | Successful case: The "Individual PCF for an MBS Session Binding" resource is successfully modified and no content is returned in the response body. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a PDU Session Binding modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a PDU Session Binding modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.3.10.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +**Table 5.3.10.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +##### 5.3.10.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.3.10.3.2-1. + +**Table 5.3.10.3.2-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.3.10.3.2-2 and the response data structures and response codes specified in table 5.3.10.3.2-3. + +**Table 5.3.10.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.3.10.3.2-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 PCF for an MBS Session Binding" resource is successfully deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a PDU Session Binding deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a PDU Session Binding deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the HTTP DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.3.10.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +**Table 5.3.10.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative BSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +#### 5.3.10.4 Resource Custom Operations + +None. + +## 5.4 Custom Operations without associated resources + +None in this release of this specification. + +## 5.5 Notifications + +### 5.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------|--------------|---------------------------------|-------------------------------------------------| +| BSF Notification | {notifUri} | POST | Provides information about observed BSF events. | + +### 5.5.2 BSF Notification + +#### 5.5.2.1 Description + +The BSF Notification is used by the BSF to report one or several observed events to an NF service consumer that has subscribed to such Notifications via the Individual Binding Subscription Resource. + +#### 5.5.2.2 Target URI + +The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 5.5.2.2-1. + +**Table 5.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned within the Individual Binding Subscription Resource and described within the BsfSubscription type (see table 5.6.2.7-1). | + +#### 5.5.2.3 Standard Methods + +##### 5.5.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.2.3.1-1. + +**Table 5.5.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.2.3.1-2 and the response data structures and response codes specified in table 5.5.2.3.1-3. + +**Table 5.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|--------------------------------------------| +| BsfNotification | M | 1 | Provides Information about observed events | + +**Table 5.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 the event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.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 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 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.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 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.1-1 specifies the data types defined for the Nbsf\_Management service based interface protocol. + +Table 5.6.1-1: Nbsf\_Management specific Data Types + +| Data type | Section defined | Description | Applicability | +|----------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| BindingLevel | 5.6.3.3 | Contains the binding level. | | +| BindingResp | 5.6.2.6 | Contains the binding information. | SamePcf | +| BsfEvent | 5.6.3.5 | Contains the event notified by the BSF. | | +| BsfEventNotification | 5.6.2.9 | Contains an event notification. | | +| BsfNotification | 5.6.2.8 | Contains the notification to the events. | | +| BsfSubscription | 5.6.2.7 | Contains the event subscription data. | | +| BsfSubscriptionResp | 5.6.4.1 | Contains the response to the subscription request. It consists of the resource representation within BsfSubscription data type and, if available, the matched observed event within the BsfNotification data type. | | +| ExtProblemDetails | 5.6.2.5 | Contains the FQDN or IP endpoints of the existing PCF and cause value if there is an existing PCF binding information for the indicated combination. | SamePcf | +| ParameterCombination | 5.6.2.4 | The combination used by the BSF to check whether there is an existing PCF binding information. | SamePcf | +| PcfBinding | 5.6.2.2 | Identifies an Individual PCF for a PDU session binding. | | +| PcfBindingPatch | 5.6.2.3 | Identifies an Individual PCF for a PDU session binding used for Patch method. | BindingUpdate | +| PcfMbsBinding | 5.6.2.15 | Represents an Individual PCF for an MBS Session binding. | | +| PcfMbsBindingPatch | 5.6.2.16 | Represents the requested modifications to an Individual PCF for an MBS Session binding. | | +| PcfForPduSessionInfo | 5.6.2.13 | The information of the PCF for a PDU session. | | +| PcfForUeBinding | 5.6.2.10 | Identifies an Individual PCF for a UE binding. | | +| PcfForUeBindingPatch | 5.6.2.11 | Identifies the updates to an Individual PCF for a UE binding. | | +| PcfForUeInfo | 5.6.2.14 | The information of the PCF for a UE. | | +| SnssaiDnnPair | 5.6.2.12 | Represents a S-NSSAI and DNN pair. | | + +Table 5.6.1-2 specifies data types re-used by the Nbsf\_Management 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 Nbsf\_Management service based interface. + +Table 5.6.1-2: Nbsf\_Management re-used Data Types + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|--------------------------------------------------------------------------------------|---------------| +| DateTime | 3GPP TS 29.571 [10] | | | +| DiameterIdentity | 3GPP TS 29.571 [10] | | | +| Dnn | 3GPP TS 29.571 [10] | | | +| Fqdn | 3GPP TS 29.571 [10] | | | +| Gpsi | 3GPP TS 29.571 [10] | | | +| IpEndPoint | 3GPP TS 29.510 [12] | | | +| Ipv4Addr | 3GPP TS 29.571 [10] | | | +| Ipv4AddrMask | 3GPP TS 29.571 [10] | String identifying an IPv4 address mask. | | +| Ipv4AddrRm | 3GPP TS 29.571 [10] | | | +| Ipv6Prefix | 3GPP TS 29.571 [10] | | | +| Ipv6PrefixRm | 3GPP TS 29.571 [10] | | | +| MacAddr48 | 3GPP TS 29.571 [10] | | | +| MacAddr48Rm | 3GPP TS 29.571 [10] | | | +| MbsSessionId | 3GPP TS 29.571 [10] | Represents the identifier of an MBS Session. | | +| NfInstanceId | 3GPP TS 29.571 [10] | | | +| NfSetId | 3GPP TS 29.571 [10] | | | +| ProblemDetails | 3GPP TS 29.571 [10] | Used in error responses to provide more detailed information about an error. | | +| RedirectResponse | 3GPP TS 29.571 [10] | Contains redirection related information. | ES3XX | +| Snssai | 3GPP TS 29.571 [10] | | | +| Supi | 3GPP TS 29.571 [10] | | | +| SupportedFeatures | 3GPP TS 29.571 [10] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 5.6.2.2 Type PcfBinding + +Table 5.6.2.2-1: Definition of type PcfBinding + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | O | 0..1 | Subscription Permanent Identifier | | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier | | +| ipv4Addr | Ipv4Addr | C | 0..1 | The IPv4 Address of the served UE. (NOTE 4) (NOTE 8) | | +| ipv6Prefix | Ipv6Prefix | C | 0..1 | The IPv6 Address Prefix of the served UE. (NOTE 4) (NOTE 5) (NOTE 8) | | +| addIpv6Prefixes | array(Ipv6Prefix) | O | 1..N | The additional IPv6 Address Prefixes of the served UE. (NOTE 4) (NOTE 5) (NOTE 8) (NOTE 10) | MultiUeAddr | +| ipDomain | string | O | 0..1 | IPv4 address domain identifier. (NOTE 1) (NOTE 8) | | +| macAddr48 | MacAddr48 | C | 0..1 | The MAC Address of the served UE. (NOTE 8) | | +| addMacAddrs | array(MacAddr48) | O | 1..N | The additional MAC Addresses of the served UE. (NOTE 8) (NOTE 10) | MultiUeAddr | +| dnn | Dnn | M | 1 | DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 11) | | +| pcfFqdn | Fqdn | C | 0..1 | FQDN of the PCF hosting the Npcf_PolicyAuthorization service. (NOTE 2) (NOTE 9) | | +| pcfIpEndPoints | array(IpEndPoint) | C | 1..N | IP end points of the PCF hosting the Npcf_PolicyAuthorization service. (NOTE 2) (NOTE 9) | | +| pcfDiamHost | DiameterIdentity | C | 0..1 | The diameter host for an individual PCF. (NOTE 3) (NOTE 9) | | +| pcfDiamRealm | DiameterIdentity | C | 0..1 | The diameter realm for an individual PCF. (NOTE 3) (NOTE 9) | | +| pcfSmFqdn | Fqdn | O | 0..1 | FQDN of the PCF hosting the Npcf_SMPolicyControl service. (NOTE 7) (NOTE 10) | SamePcf | +| pcfSmIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF hosting the Npcf_SMPolicyControl service. (NOTE 7) (NOTE 10) | SamePcf | +| snssai | Snssai | M | 1 | The identification of slice. | | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the supported optional features 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. | | +| pcfId | NfInstanceId | O | 0..1 | PCF instance identifier | | +| pcfSetId | NfSetId | O | 0..1 | The PCF set Id | | +| recoveryTime | DateTime | O | 0..1 | Recovery time of the PCF | | +| paraCom | ParameterCombination | O | 0..1 | If it is included, the BSF shall check whether there is an existing PCF binding information for the indicated combination. (NOTE 6) (NOTE 10) | SamePcf | +| bindLevel | BindingLevel | O | 0..1 | Contains the level of binding. | | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|------|-------------------------------------------|--| +| ipv4FrameRoute List | array(Ipv4AddrMask) | O | 1..N | List of Framed Route information of IPv4. | | +| ipv6FrameRoute List | array(Ipv6Prefix) | O | 1..N | List of Framed Route information of IPv6. | | +|

NOTE 1: The ipDomain attribute may only be provided if the ipv4Addr attribute is present.

NOTE 2: When the "ExtendedSamePcf" feature is not supported, at least one of "pcfFqdn" or "pcfIpEndPoints" shall be included if the PCF supports the Npcf_PolicyAuthorization service. When the "ExtendedSamePcf" feature is supported these attributes may be provided if available.

NOTE 3: When the "ExtendedSamePcf" feature is not supported, both pcfDiamHost and pcfDiamRealm are provided if the PCF supports Rx interface. When the "ExtendedSamePcf" feature is supported these attributes may be provided if available.

NOTE 4: 5G-RG and FN-RG replaces UE for wireline access support. See 3GPP TS 23.316 [19].

NOTE 5: IPv6 prefix(es) shorter than /64, according to 3GPP TS 23.501 [2], clause 5.8.2.2 and 3GPP TS 23.316 [19], clause 8.3.1, or full IPv6 address(es) with a /128 prefix, according to 3GPP TS 23.316 [19], clause 8.3.1, may be encoded as the "ipv6Prefix" and "addIpv6Prefixes" attributes.

NOTE 6: If the BSF finds that there is an existing Individual PCF for a PDU Session Binding resource for the indicated combination containing Npcf_SMPolicyControl service addressing information, the BSF shall not check other Individual PCF for a PDU Session Binding resources and shall reject the ongoing registration, and return the FQDN or IP endpoints of the Npcf_SMPolicyControl service of the matching Individual PCF for a PDU Session Binding resource to the requesting PCF.

NOTE 7: At least one of the "pcfSmFqdn" attribute or the "pcfSmIpEndPoints" attribute shall be included in the binding information, if the binding refers to an SM Policy association and if the "SamePcf" feature is supported and the PCF determines that the same PCF shall be selected for the SM Policy associations with the same SUPI/DNN/S-NSSAI parameter combination in the non-roaming or home-routed scenario based on operator's policies and configuration.

NOTE 8: When the "ExtendedSamePcf" feature is not supported the address information of the served UE shall be provided, i.e., either the "ipv4Addr", the "ipv6Prefix" and/or "addIpv6Prefixes" attributes or the "macAddr48" and/or "addMacAddrs" attributes shall be provided as specified in clause 4.2.2.2.

NOTE 9: When the "ExtendedSamePcf" feature is not supported the address information of the Npcf_PolicyAuthorization service and/or Rx interface shall be provided, i.e., both "pcfDiamHost" and "pcfDiamRealm" and/or at least one of the "pcfFqdn" or "pcfEndPoints" shall be provided as specified in clause 4.2.2.2.

NOTE 10: This attribute does not apply when the NF service consumer is an AF/NEF.

NOTE 11: The BSF uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration.

| | | | | | + +#### 5.6.2.3 Type PcfBindingPatch + +**Table 5.6.2.3-1: Definition of type PcfBindingPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------|---|-------------|--------------------------------------------------------------------------|---------------| +| ipv4Addr | Ipv4AddrRm | O | 0..1 | The IPv4 Address of the served UE. (NOTE 2) | | +| ipDomain | string | O | 0..1 | IPv4 address domain identifier. (NOTE 1) | | +| ipv6Prefix | Ipv6PrefixRm | O | 0..1 | The IPv6 Address Prefix of the served UE. (NOTE 2) (NOTE 3) | | +| addIpv6Prefixes | array(Ipv6Prefix) | O | 1..N | The additional IPv6 Address Prefixes of the served UE. (NOTE 2) (NOTE 3) | MultiUeAddr | +| macAddr48 | MacAddr48Rm | O | 0..1 | The MAC Address of the served UE. | | +| addMacAddrs | array(MacAddr48) | O | 1..N | The additional MAC Addresses of the served UE. | MultiUeAddr | +| pcfId | NfInstanceId | O | 0..1 | PCF instance identifier | | +| pcfFqdn | Fqdn | O | 0..1 | FQDN of the PCF hosting the Npcf_PolicyAuthorization service. | | +| pcfIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF hosting the Npcf_PolicyAuthorization service. | | +| pcfDiamHost | DiameterIdentity | O | 0..1 | The diameter host for an individual PCF. | | +| pcfDiamRealm | DiameterIdentity | O | 0..1 | The diameter realm for an individual PCF. | | +| snssai | Snssai | O | 0..1 | The updated S-NSSAI. | NetSliceRepl | + +NOTE 1: If applicable, the consumer (e.g. PCF) shall also request to remove the ipDomain attribute if the ipv4Addr attribute is requested to be removed. + +NOTE 2: 5G-RG and FN-RG replaces UE for wireline access support. See 3GPP TS 23.316 [19]. + +NOTE 3: IPv6 prefix(es) shorter than /64, according to 3GPP TS 23.501 [2], clause 5.8.2.2 and 3GPP TS 23.316 [19], clause 8.3.1, or full IPv6 address(es) with a /128 prefix, according to 3GPP TS 23.316 [19], clause 8.3.1, can be encoded as the "ipv6Prefix" and "addIpv6Prefixes" attributes. + +#### 5.6.2.4 Type ParameterCombination + +**Table 5.6.2.4-1: Definition of type ParameterCombination** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | O | 0..1 | Subscription Permanent Identifier | | +| dnn | Dnn | O | 0..1 | DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 3) | | +| snssai | Snssai | O | 0..1 | The identification of slice. | | + +NOTE 1: At least one of the attributes in this table shall be included. + +NOTE 2: The applicable parameter combinations in a given deployment shall be disjoint combinations. E.g., if a deployment requires a parameter combination that includes a SUPI value for a DNN/S-NSSAI combination, subsequent parameter combinations of that DNN/S-NSSAI combination shall also include the corresponding SUPI attribute. + +NOTE 3: The BSF uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. + +#### 5.6.2.5 Type ExtProblemDetails + +**Table 5.6.2.5-1: Definition of type ExtProblemDetails as a list of to be combined data types** + +| Data Type | P | Cardinality | Description | Applicability | +|----------------|---|-------------|-------------------------|---------------| +| ProblemDetails | O | 0..1 | Problem Details | | +| BindingResp | O | 0..1 | PCF Binding Information | | + +#### 5.6.2.6 Type BindingResp + +**Table 5.6.2.6-1: Definition of type BindingResp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------|---|-------------|---------------------------------------------------------------------------|---------------| +| pcfSmFqdn | Fqdn | O | 0..1 | FQDN of the PCF hosting the Npcf_SMPolicyControl service. (NOTE) | | +| pcfSmIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF hosting the Npcf_SMPolicyControl service. (NOTE) | | + +NOTE: Either the "pcfSmFqdn" attribute or the "pcfSmIpEndPoints" attribute shall be included. + +#### 5.6.2.7 Type BsfSubscription + +**Table 5.6.2.7-1: Definition of type BsfSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| events | array(BsfEvent) | M | 1..N | Subscribed Events. | | +| notifUri | Uri | M | 1 | Notification URI. | | +| notifCorrelId | string | M | 1 | It is used to set the value of Notification Correlation ID in the corresponding notification. | | +| supi | Supi | M | 1 | Subscription Permanent Identifier. | | +| gpsi | Gpsi | O | 0..1 | Identifies a GPSI. | | +| snssaiDnnPairs | SnssaiDnnPair | C | 0..1 | Represents the S-NSSAI and DNN pair for which the binding event report(s) shall apply. (NOTE) | | +| addSnssaiDnnPairs | array(SnssaiDnnPair) | C | 1..N | Represents the additional S-NSSAI and DNN pairs for which the binding event report(s) shall apply. (NOTE) | AddSnssaiDnnPair | +| suppFeat | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.8. This parameter shall be supplied by NF service consumer and BSF in the POST request that request the creation of an Individual Binding Subscription resource and the related reply, respectively. | | + +NOTE: If the NF service consumer needs to subscribe to notifications for more than one S-NSSAI and DNN pairs and the "AddSnssaiDnnPair" feature is supported, the NF service consumer shall include one S-NSSAI and DNN pair in the "snssaiDnnPairs" attribute and the remaining S-NSSAI and DNN pairs in the "addSnssaiDnnPairs" attribute. + +#### 5.6.2.8 Type BsfNotification + +**Table 5.6.2.8-1: Definition of type BsfNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifCorrId | string | M | 1 | Notification correlation ID used to identify the subscription to which the notification relates. It shall be set to the same value as the "notifCorrId" attribute of BsfSubscription data type. | | +| eventNotifs | array(BsfEventNotification) | M | 1..N | Notifications about Individual Events. | | + +#### 5.6.2.9 Type BsfEventNotification + +**Table 5.6.2.9-1: Definition of type BsfEventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| event | BsfEvent | M | 1 | Event that is notified. | | +| pcfForUeInfo | PcfForUeInfo | C | 0..1 | The binding information of the PCF for a UE.
It shall be included if the BSF is subscribed to the notification of "PCF_UE_BINDING_REGISTRATION" and "PCF_UE_BINDING_DEREGISTRATION" event and the registration or deregistration of PCF for a UE is detected. | | +| pcfForPduSessionInfos | array(PcfForPduSessionInfo) | C | 1..N | The binding information of the PCF for a PDU session.
It shall be included if the BSF is subscribed to the notification of PCF_PDU_SESSION_BINDING_REGISTRATION event and the registration of the PCF for the PDU session is detected, and the BSF is subscribed to the notification of PCF_PDU_SESSION_BINDING_DEREGISTRATION and the deregistration of the PCF for the PDU session is detected. | | +| matchSnssaiDnns | array(SNSSAI_DNN_Pair) | C | 1..N | Matching S-NSSAI and DNN pairs.
It shall be included if the BSF is subscribed to the notification of SNSSAI_DNN_BINDING_REGISTRATION and a PCF registration for the first PDU session for the DNN and SNSSAI combination is detected, and the BSF is subscribed to the notification of SNSSAI_DNN_BINDING_DEREGISTRATION and a PCF deregistration for the last PDU session for the DNN and SNSSAI combination is detected . | | + +#### 5.6.2.10 Type PcfForUeBinding + +Table 5.6.2.10-1: Definition of type PcfForUeBinding + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | Subscription Permanent Identifier | | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier | | +| pcfForUeFqdn | Fqdn | C | 0..1 | FQDN of the PCF hosting the Npcf_AMPolicyAuthorization service, if available. (NOTE) | | +| pcfForUeIpEndPoints | array(IpEndPoint) | C | 1..N | IP end points of the PCF hosting the Npcf_AMPolicyAuthorization service, if available. (NOTE) | | +| pcfId | NfInstanceId | O | 0..1 | PCF instance identifier | | +| pcfSetId | NfSetId | O | 0..1 | The PCF set Id | | +| bindLevel | BindingLevel | O | 0..1 | Contains the level of binding. | | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the supported optional features 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" query parameter is included in the HTTP GET request. | | + +NOTE: At least one of the "pcfForUeFqdn" attribute or "pcfForUeIpEndPoints" attribute shall be provided. + +#### 5.6.2.11 Type PcfForUeBindingPatch + +Table 5.6.2.11-1: Definition of type PcfForUeBindingPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------|---------------| +| pcfForUeFqdn | Fqdn | O | 0..1 | FQDN of the PCF hosting the Npcf_AMPolicyAuthorization service, if available. | | +| pcfForUeIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF hosting the Npcf_AMPolicyAuthorization service, if available. | | +| pcfId | NfInstanceId | O | 0..1 | PCF instance identifier | | + +#### 5.6.2.12 Type SnssaiDnnPair + +Table 5.6.2.12-1: Definition of type SnssaiDnnPair + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | S-NSSAI | | +| dnn | Dnn | M | 1 | Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE) | | + +NOTE: The BSF uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. + +#### 5.6.2.13 Type PcfForUeInfo + +Table 5.6.2.13-1: Definition of type PcfForUeInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|--------------------------------------------------------------------------|---------------| +| pcfId | NfInstanceId | O | 0..1 | PCF instance identifier. | | +| pcfSetId | NfSetId | O | 0..1 | The PCF set ID. | | +| bindLevel | BindingLevel | O | 0..1 | Contains the level of binding. | | +| pcfFqdn | Fqdn | O | 0..1 | FQDN of the PCF hosting the Npcf_AMPolicyAuthorization service. | | +| pcfIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF hosting the Npcf_AMPolicyAuthorization service. | | + +NOTE: Either the "pcfFqdn" attribute or the "pcfIpEndPoints" attribute shall be included. + +#### 5.6.2.14 Type PcfForPduSessionInfo + +Table 5.6.2.14-1: Definition of type PcfForPduSessionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | S-NSSAI | | +| dnn | Dnn | M | 1 | Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 3) | | +| pcfId | NfInstanceId | O | 0..1 | PCF instance identifier. | | +| pcfSetId | NfSetId | O | 0..1 | The PCF set ID. | | +| bindLevel | BindingLevel | O | 0..1 | Contains the level of binding. | | +| ipv4Addr | Ipv4Addr | O | 0..1 | The IPv4 Address of the served UE. | | +| ipDomain | string | O | 0..1 | IPv4 address domain identifier. (NOTE 2) | | +| ipv6Prefixes | array(Ipv6Prefix) | O | 1..N | The IPv6 Address Prefixes of the served UE. | | +| macAddrs | array(MacAddr48) | O | 1..N | The MAC Addresses of the served UE. | | +| pcfFqdn | Fqdn | O | 0..1 | FQDN of the PCF hosting the Npcf_PolicyAuthorization service. | | +| pcfIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF hosting the Npcf_PolicyAuthorization service. | | + +NOTE 1: Either the "pcfFqdn" attribute or the "pcfIpEndPoints" attribute shall be included. +NOTE 2: The "ipDomain" attribute may only be provided if the "ipv4Addr" attribute is present. +NOTE 3: The BSF uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. + +#### 5.6.2.15 Type PcfMbsBinding + +Table 5.6.2.15-1: Definition of type PcfMbsBinding + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsSessionId | MbsSessionId | M | 1 | Contains the identifier of the MBS Session to which the MBS Session binding is related. | | +| pcfFqdn | Fqdn | C | 0..1 | Contains the FQDN of the PCF handling the MBS Session.

This attribute shall be provided, if available.

(NOTE) | | +| pcfIpEndPoints | array(IpEndPoint) | C | 1..N | Contains the IP end points of the PCF handling the MBS Session.

This attribute shall be provided, if available.

(NOTE) | | +| pcfId | NfInstanceId | O | 0..1 | Contains the identifier of the PCF instance handling the concerned MBS Session. | | +| pcfSetId | NfSetId | O | 0..1 | Contains the identifier of the PCF set to which the PCF instance handling the MBS Session belongs. | | +| bindLevel | BindingLevel | O | 0..1 | Contains the level of binding of the PCF handling the MBS Session. | | +| recoveryTime | DateTime | O | 0..1 | Contains the recovery timestamp of the NF service consumer (e.g. PCF handling the MBS Session).

This attribute may be present only in the HTTP POST request. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the supported features and is used to negotiate the supported optional features as described in clause 5.8.

This attribute may be present in the HTTP POST request. It shall be present in the HTTP POST response, if it is included in the corresponding HTTP POST request, or in the HTTP GET response, if the "supp-feat" query parameter is included in the corresponding HTTP GET request. | | + +NOTE: At least one of the "pcfFqdn" attribute or the "pcfIpEndPoints" attribute shall be present. + +#### 5.6.2.16 Type PcfMbsBindingPatch + +**Table 5.6.2.16-1: Definition of type PcfMbsBindingPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------|---------------| +| pcfFqdn | Fqdn | O | 0..1 | Contains the updated FQDN of the PCF handling the MBS Session. | | +| pcfIpEndPoints | array(IpEndPoint) | O | 1..N | Contains the updated IP end points of the PCF handling the MBS Session. | | +| pcfId | NfInstanceId | O | 0..1 | Contains the updated identifier of the PCF instance handling the concerned MBS Session. | | + +#### 5.6.2.17 Type MbsExtProblemDetails + +**Table 5.6.2.17-1: Definition of type MbsExtProblemDetails as a list of to be combined data types** + +| Data Type | P | Cardinality | Description | Applicability | +|----------------|---|-------------|----------------------------------------------|---------------| +| ProblemDetails | O | 0..1 | Problem Details | | +| MbsBindingResp | O | 0..1 | PCF Binding Information for the MBS Session. | | + +#### 5.6.2.18 Type MbsBindingResp + +**Table 5.6.2.18-1: Definition of type MbsBindingResp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------|---------------| +| pcfFqdn | Fqdn | O | 0..1 | FQDN of the PCF handling the MBS Session.

(NOTE) | | +| pcfIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF handling the MBS Session.

(NOTE) | | + +NOTE: At least one of the "pcfFqdn" attribute or the "pcfIpEndPoints" attribute shall be present. + +### 5.6.3 Simple data types and enumerations + +#### 5.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.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 5.6.3.3 Enumeration: BindingLevel + +**Table 5.6.3.3-1: Enumeration BindingLevel** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------|---------------| +| NF_SET | Indicates the NF set level of binding. | | +| NF_INSTANCE | Indicates the NF instance level of binding. | | + +#### 5.6.3.4 Void + +#### 5.6.3.5 Enumeration: BsfEvent + +**Table 5.6.3.5-1: Enumeration BsfEvent** + +| Enumeration value | Description | Applicability | +|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| PCF_PDU_SESSION_BINDING_REGISTRATION | Indicates the binding of a PCF for a PDU session is registered. | | +| PCF_PDU_SESSION_BINDING_DEREGISTRATION | Indicates the binding of a PCF for a PDU session is deregistered. | | +| PCF_UE_BINDING_REGISTRATION | Indicates the binding of a PCF for a UE is registered. | | +| PCF_UE_BINDING_DEREGISTRATION | Indicates the binding of a PCF for a UE is deregistered. | | +| SNSSAI_DNN_BINDING_REGISTRATION | Indicates the binding of a PCF for a PDU session corresponding to the first PDU session for a DNN and S-NSSAI combination is registered. | | +| SNSSAI_DNN_BINDING_DEREGISTRATION | Indicates the binding of a PCF for a PDU session corresponding to the last PDU session for a DNN and S-NSSAI combination is deregistered. | | + +### 5.6.4 Data types describing alternative data types or combinations of data types + +#### 5.6.4.1 Type: BsfSubscriptionResp + +**Table 5.6.4.1-1: Definition of type BsfSubscriptionResp as a list of non-exclusive alternatives** + +| Data type | Cardinality | Description | Applicability | +|-----------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------|---------------| +| BsfNotification | 0..1 | It represents the notification of a match event during the creation or modification of the Individual Binding Subscription resource. | | +| BsfSubscription | 1 | It represents the Individual PCFBinding Subscription resource. | | + +## 5.7 Error handling + +### 5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [6]. + +For the Nbsf\_Management Service API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] 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 [6]. + +In addition, the requirements in the following clauses shall apply. + +### 5.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nbsf\_Management Service API. + +### 5.7.3 Application Errors + +The application errors defined for the Nbsf\_Management Service API are listed in table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| MULTIPLE_BINDING_INFO_FOUND | 400 Bad Request | Indicates that the BSF found more than one binding resource so it cannot provide the selected PCF to the consumer. (NOTE 1) | +| EXISTING_BINDING_INFO_FOUND | 403 Forbidden | Indicates that the BSF found an existing PCF binding information for the indicated combination or for the applicable MBS Session. (NOTE 2) | +| NOTE 1: This application error is included in the responses to the GET request. | | | +| NOTE 2: This application error is included in the responses to the POST request. | | | +| NOTE 3: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Nbsf\_Management Service API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +Table 5.8-1: Supported Features + +| Feature number | Feature Name | Description | +|----------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | MultiUeAddr | This feature indicates the support of multiple UE addresses (IPv6 prefixes or MAC addresses) in the same binding information. | +| 2 | BindingUpdate | The consumer can use this feature for updating the session binding information. | +| 3 | SamePcf | This feature indicates the support of same PCF selection for the indicated combination.
(NOTE) | +| 4 | 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 [6] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. | +| 5 | ExtendedSamePcf | This feature extends the support of same PCF selection for the indicated combination. This feature requires the support of SamePcf feature.
(NOTE) | +| 6 | AddSnssaiDnnPair | This feature indicates the support of additional S-NSSAI and DNN pair(s) for which the binding event report(s) apply. | +| 7 | NetSliceRepl | This feature indicates the support of the network slice replacement functionality introduced in this specification as part of the end-to-end network slicing functionality.

The following functionalities are supported:
- Support the reporting of the network slice replacement information to the BSF. | + +NOTE: The "SamePcf" feature is applicable to the deployments where the N5 and/or Rx interface apply and the UE address is available in the PCF at the creation of the SM Policy Association. The "ExtendedSamePcf" feature is applicable for any PCF deployment, regardless of UE address availability at the creation of SM Policy association and/or N5 and/or Rx applicability. + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [15] and 3GPP TS 29.500 [6], the access to the Nbsf\_Management API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [16]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, a n NF Service Consumer, prior to consuming services offered by the Nbsf\_Management API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], 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 Nbsf\_Management service. + +The Nbsf\_Management API defines a single scope "nbsf-management" for the entire service, and it does not define any additional scopes at resource or operation level. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +The present Annex contains an OpenAPI [11] specification of HTTP messages and content bodies used by the Nbsf\_Management API. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [18] and clause 5.3.1 of the 3GPP TS 29.501 [7] for further information). + +## --- A.2 Nbsf\_Management API + +``` +openapi: 3.0.0 + +info: + version: 1.4.0-alpha.3 + title: Nbsf_Management + description: | + Binding Support Management Service API. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.521 V18.2.0; 5G System; Binding Support Management Service. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.521/' + +servers: + - url: '{apiRoot}/nbsf-management/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nbsf-management + +paths: + /pcfBindings: + post: + summary: Create a new Individual PCF for a PDU Session binding information + operationId: CreatePCFBinding + tags: + - PCF Bindings (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcfBinding' + responses: + '201': + description: The creation of an individual PCF for a PDU Session binding. + content: + application/json: + schema: +``` + +``` + $ref: '#/components/schemas/PcfBinding' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nbsf-management/{apiVersion}/pcf-mbs-bindings/{bindingId} + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: > + The existing PCF binding information stored in the BSF for the indicated combination is + returned. + + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Read PCF for a PDU Session Bindings information + operationId: GetPCFBindings + tags: + - PCF Bindings (Collection) + parameters: + - name: ipv4Addr + in: query + description: The IPv4 Address of the served UE. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + - name: ipv6Prefix + in: query + description: > + The IPv6 Address of the served UE. The NF service consumer shall append '/128' to the + IPv6 address in the attribute value. E.g. '2001:db8:85a3::8a2e:370:7334/128'. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + - name: macAddr48 + in: query + description: The MAC Address of the served UE. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + - name: dnn + in: query + description: DNN. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: supi + in: query + description: Subscription Permanent Identifier. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +``` + +``` +- name: gpsi + in: query + description: Generic Public Subscription Identifier + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' +- name: snssai + in: query + description: The identification of slice. + required: false + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' +- name: ipDomain + in: query + description: The IPv4 address domain identifier. + required: false + schema: + type: string +- name: supp-feat + in: query + description: To filter irrelevant responses related to unsupported features. + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: > + The individual PCF for a PDU Session binding session binding information resource + matching the query parameter(s) is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PcfBinding' + '204': + description: > + There is no PCF for a PDU Session binding information matching the query parameter(s). + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/pcfBindings/{bindingId}: + delete: + summary: Delete an existing Individual PCF for a PDU Session Binding information + operationId: DeleteIndPCFBinding + tags: + - Individual PCF Binding (Document) + parameters: + - name: bindingId + in: path + description: Represents the individual PCF for a PDU Session Binding. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual PCF for a PDU Session Binding information resource is + deleted. +``` + +``` + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Update an existing Individual PCF for a PDU Session Binding information + operationId: UpdateIndPCFBinding + tags: + - Individual PCF for a PDU Session Binding (Document) + parameters: + - name: bindingId + in: path + description: Represents the individual PCF for a PDU Session Binding. + required: true + schema: + type: string + requestBody: + description: Parameters to update the existing PCF for a PDU Session binding. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PcfBindingPatch' + responses: + '200': + description: OK (Successful update of the PCF for a PDU Session binding). + content: + application/json: + schema: + $ref: '#/components/schemas/PcfBinding' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions: +``` + +``` + +post: + operationId: CreateIndividualSubscription + summary: Create an individual subscription for event notifications from the BSF + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BsfSubscription' + responses: + '201': + description: Created. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nsmf-management//subscriptions/{subId} + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BsfSubscriptionResp' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BsfNotification' + responses: + '204': + description: No Content. Notification was successful. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subId}: + put: + operationId: ReplaceIndividualSubscription + summary: Replace an individual subscription for event notifications from the BSF + tags: + - IndividualSubscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BsfSubscription' + parameters: + - name: subId + in: path + description: Subscription correlation ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource was successfully modified and representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/BsfSubscriptionResp' + '204': + description: No Content. Resource was successfully modified. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + delete: + operationId: DeleteIndividualSubscription + summary: Delete an individual subscription for event notifications from the BSF + tags: + - IndividualSubscription (Document) + parameters: + - name: subId + in: path +``` + +``` + description: Subscription correlation ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/pcf-ue-bindings: + post: + summary: Create a new Individual PCF for a UE binding information + operationId: CreatePCFForUEBinding + tags: + - PCF for a UE Bindings (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcfForUeBinding' + responses: + '201': + description: The creation of an individual PCF for a UE binding. + content: + application/json: + schema: + $ref: '#/components/schemas/PcfForUeBinding' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId} + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +get: + summary: Read PCF for a UE Bindings information + operationId: GetPCFForUeBindings + tags: + - PCF for a UE Bindings (Collection) + parameters: + - name: supi + in: query + description: Subscription Permanent Identifier. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: gpsi + in: query + description: Generic Public Subscription Identifier + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + - name: supp-feat + in: query + description: To filter irrelevant responses related to unsupported features. + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + The individual PCF for a UE binding session binding information resource matching the + query parameter(s) is returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PcfForUeBinding' + minItems: 0 + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/pcf-ue-bindings/{bindingId}: +delete: + summary: Delete an existing Individual PCF for a UE Binding information + operationId: DeleteIndPCFforUEBinding + tags: + - Individual PCF for a UE Binding (Document) + parameters: + - name: bindingId + in: path + description: Represents the individual PCF for a UE Binding. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual PCF for a UE binding information resource is deleted. +``` + +``` + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Update an existing Individual PCF for a UE Binding information + operationId: UpdateIndPCFforUEBinding + tags: + - Individual PCF for a UE Binding (Document) + parameters: + - name: bindingId + in: path + description: Represents the individual PCF for a UE Binding. + required: true + schema: + type: string + requestBody: + description: Parameters to update the existing PCF for a UE binding. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PcfForUeBindingPatch' + responses: + '200': + description: OK. Successful update of the PCF for a PDU Session binding. + content: + application/json: + schema: + $ref: '#/components/schemas/PcfForUeBinding' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/pcf-mbs-bindings: +``` + +``` +post: + summary: Create a new Individual PCF for an MBS Session binding. + operationId: CreatePCFMbsBinding + tags: + - PCF for an MBS Session Bindings (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcfMbsBinding' + responses: + '201': + description: > + Created. A new Individual PCF for an MBS Session Binding resource is created + and the corresponding URI is returned in an HTTP Location header. + content: + application/json: + schema: + $ref: '#/components/schemas/PcfMbsBinding' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nbsf-management/v1/pcf-mbs-bindings/{bindingId} + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: > + The existing PCF binding information stored in the BSF for the MBS session is + returned. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/MbsExtProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve an existing PCF for an MBS Session binding. + operationId: GetPCFMbsBinding + tags: + - PCF for an MBS Session Bindings (Collection) + parameters: + - name: mbs-session-id + in: query + description: > + Contains the identifier of the MBS Session to which the requested MBS Session + binding is related. + required: true + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + - name: supp-feat + in: query +``` + +``` +description: > + Contains the list of features supported by the NF service consumer and used to + filter irrelevant responses related to unsupported features. +content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: > + OK. The Individual PCF for an MBS Session Binding resource(s) matching the provided + query parameter(s) are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PcfMbsBinding' + minItems: 0 + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/pcf-mbs-bindings/{bindingId}: + parameters: + - name: bindingId + in: path + description: > + Represents the identifier of the Individual PCF for an MBS Session Binding resource. + required: true + schema: + type: string + + patch: + summary: Request the modification of an existing Individual PCF for an MBS Session Binding + resource. + operationId: ModifyIndPCFMbsBinding + tags: + - Individual PCF for an MBS Session Binding (Document) + requestBody: + description: Parameters to request the modification of the PCF for an MBS Session Binding. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PcfMbsBindingPatch' + responses: + '200': + description: > + OK. The Individual PCF for an MBS Session Binding resource is successfully modified and + a representation of the updated resource is returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/PcfMbsBinding' + '204': + description: > + No Content. The Individual PCF for an MBS Session Binding resource is successfully + modified and no content is returned in the response body. +``` + +``` +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Request the deletion of an existing Individual PCF for an MBS Session Binding. + operationId: DeleteIndPCFMbsBinding + tags: + - Individual PCF for an MBS Session Binding (Document) + responses: + '204': + description: > + No Content. The Individual PCF for an MBS Session Binding resource is successfully + Deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nbsf-management: Access to the Nbsf_Management API + + schemas: + + PcfBinding: + description: Identifies an Individual PCF for a PDU Session binding. + type: object +``` + +``` +properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + addIpv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + description: The additional IPv6 Address Prefixes of the served UE. + ipDomain: + type: string + macAddr48: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + addMacAddrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + minItems: 1 + description: The additional MAC Addresses of the served UE. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + pcfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_PolicyAuthorization service + pcfDiamHost: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + pcfDiamRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + pcfSmFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfSmIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_SMPolicyControl service. + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + paraCom: + $ref: '#/components/schemas/ParameterCombination' + bindLevel: + $ref: '#/components/schemas/BindingLevel' + ipv4FrameRouteList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrMask' + minItems: 1 + ipv6FrameRouteList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + required: + - dnn + - snssai + +PcfBindingPatch: + description: Identifies an Individual PCF binding used in an HTTP Patch method. + type: object +``` + +``` +properties: + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrRm' + ipDomain: + type: string + nullable: true + ipv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6PrefixRm' + addIpv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + description: The additional IPv6 Address Prefixes of the served UE. + nullable: true + macAddr48: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48Rm' + addMacAddrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + minItems: 1 + description: The additional MAC Addresses of the served UE. + nullable: true + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_PolicyAuthorization service. + pcfDiamHost: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + pcfDiamRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +ParameterCombination: + description: > + Represents the combination used by the BSF to check whether there is an existing PCF binding + information. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +ExtProblemDetails: + description: > + Contains the FQDN or IP endpoints of the existing PCF and the cause value if there is an + existing PCF binding information for the indicated combination. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/BindingResp' + +MbsExtProblemDetails: + description: > + Contains the FQDN or IP endpoints of the existing PCF and the cause value if there is an + existing PCF binding information for the MBS session. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/MbsBindingResp' + +BindingResp: + description: Contains the binding information for a PCF for a PDU Session. + type: object + properties: + pcfSmFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfSmIpEndPoints: + type: array +``` + +``` + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_SMPolicyControl service. + +MbsBindingResp: + description: Contains the binding information for a PCF for an MBS Session. + type: object + properties: + pcfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF handling the MBS Session. + anyOf: + - required: [pcfFqdn] + - required: [pcfIpEndPoints] + +BsfSubscription: + description: Contains the event subscription data. + type: object + properties: + events: + type: array + items: + $ref: '#/components/schemas/BsfEvent' + minItems: 1 + description: Contain te subscribed events. + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorreId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssaiDnnPairs: + $ref: '#/components/schemas/SnssaiDnnPair' + addSnssaiDnnPairs: + type: array + items: + $ref: '#/components/schemas/SnssaiDnnPair' + minItems: 1 + description: > + Represents the additional S-NSSAI and DNN pair(s) for which the binding event report(s) + shall apply. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - events + - notifUri + - notifCorreId + - supi + +BsfNotification: + description: Contains the event notifications. + type: object + properties: + notifCorreId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + bindLevel: + $ref: '#/components/schemas/BindingLevel' + eventNotifs: + type: array + items: + $ref: '#/components/schemas/BsfEventNotification' + minItems: 1 + description: Notifications about Individual Events. + required: +``` + +``` +- notifCorreId +- eventNotifs + +BsfEventNotification: + description: Contains an event notification. + type: object + properties: + event: + $ref: '#/components/schemas/BsfEvent' + pcfForUeInfo: + $ref: '#/components/schemas/PcfForUeInfo' + pcfForPduSessInfos: + type: array + items: + $ref: '#/components/schemas/PcfForPduSessionInfo' + minItems: 1 + description: The information of the PCF for a PDU session. + matchSnssaiDnns: + type: array + items: + $ref: '#/components/schemas/SnssaiDnnPair' + minItems: 1 + description: Matching S-NSSAI and DNN pairs. + required: + - event + +PcfForUeInfo: + description: Contains the information of the PCF for a UE. + type: object + properties: + pcfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_AmPolicyAuthorization service. + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + bindLevel: + $ref: '#/components/schemas/BindingLevel' + +PcfForPduSessionInfo: + description: Contains the information of the PCF for a PDU session. + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + pcfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_AmPolicyAuthorization service. + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrRm' + ipDomain: + type: string + ipv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + description: The IPv6 Address Prefixes of the served UE. + macAddrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + minItems: 1 + description: The MAC Addresses of the served UE. + pcfId: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + bindLevel: + $ref: '#/components/schemas/BindingLevel' + required: + - snssai + - dnn + +PcfForUeBinding: + description: Identifies an Individual PCF for a UE binding. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pcfForUeFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfForUeIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_AmPolicyAuthorization service. + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + bindLevel: + $ref: '#/components/schemas/BindingLevel' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supi + anyOf: + - required: [pcfForUeFqdn] + - required: [pcfForUeIpEndPoints] + +PcfForUeBindingPatch: + description: Identifies the updates of an Individual PCF for a UE binding. + type: object + properties: + pcfForUeFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfForUeIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_AmPolicyAuthorization service. + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +SnssaiDnnPair: + description: Contains a S-NSSAI and DNN combination. + type: object + required: + - snssai + - dnn + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +PcfMbsBinding: + description: Represents an Individual PCF for an MBS Session binding. + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + pcfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfIpEndPoints: + type: array + items: +``` + +``` + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + bindLevel: + $ref: '#/components/schemas/BindingLevel' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - mbsSessionId + anyOf: + - required: [pcfFqdn] + - required: [pcfIpEndPoints] + +PcfMbsBindingPatch: + description: > + Represents the requested modification to an Individual PCF for an MBS Session binding. + type: object + properties: + pcfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +BindingLevel: + anyOf: + - type: string + enum: + - NF_SET + - NF_INSTANCE + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Represents the binding level. + Possible values are: + - NF_SET: Indicates the NF set level of binding. + - NF_INSTANCE: Indicates the NF instance level of binding. + +BsfEvent: + description: Represents an event to be notified by the BSF. + anyOf: + - type: string + enum: + - PCF_PDU_SESSION_BINDING_REGISTRATION + - PCF_PDU_SESSION_BINDING_DEREGISTRATION + - PCF_UE_BINDING_REGISTRATION + - PCF_UE_BINDING_DEREGISTRATION + - SNSSAI_DNN_BINDING_REGISTRATION + - SNSSAI_DNN_BINDING_DEREGISTRATION + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +BsfSubscriptionResp: + description: > + It represents a response to a modification or creation request of an Individual Binding + Subscription resource. It may contain the notification of the already met events. + anyOf: + - $ref: '#/components/schemas/BsfSubscription' + - $ref: '#/components/schemas/BsfNotification' +``` + +# --- Annex B (informative): Deployment option to support BSF and DRA coexistence due to network migration + +As described in Annex B of 3GPP TS 23.503 [4], the Diameter Routing Agent (DRA) and the BSF can coexist in an operator's network during the network migration to 5GC. The DRA is described in 3GPP TS 29.213 [14] and can be a service consumer of the Nbsf\_Management service. + +During the Rx session establishment, the DRA can discover the selected PCF for the related subscriber by using the Nbsf\_Management\_Discovery service operation to obtain the related PCF address if it has no stored binding information derived from an ongoing Gx session for that subscriber. + +NOTE 1: For a UE in the EPC there is a Gx session and the DRA stores the binding information. For a UE in the 5GC the Npcf\_SmPolicyControl service is used and the BSF stores the binding information. + +NOTE 2: If the DRA has no stored binding information derived from an ongoing Gx session for a subscriber, the DRA needs to request new binding information for each Rx session establishment because the information in the BSF could have changed compared to any previous binding information the DRA requested. + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-01 | | | | | | TS skeleton of Binding Support Management Service specification | 0.0.0 | +| 2018-01 | | | | | | Inclusion of documents agreed in CT3#94 C3-180301, C3-180191, C3-180192 and C3-180193. | 0.1.0 | +| 2018-03 | | | | | | Inclusion of documents agreed in CT3#95 C3-181350 and C3-181352. | 0.2.0 | +| 2018-04 | | | | | | Inclusion of documents agreed in CT3#96 C3-182424 and C3-182510. | 0.3.0 | +| 2018-05 | | | | | | Inclusion of documents agreed in CT3#97 C3-183287, C3-183500, C3-183881, C3-183502 and C3-183733. | 0.4.0 | +| 2018-06 | CT#80 | CP-181031 | | | | TS sent to plenary for approval. | 1.0.0 | +| 2018-06 | CT#80 | CP-181031 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 2 | F | PCF id correction for BSF | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0002 | | F | Reference update: OpenAPI specification | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | 2 | F | Clarification on mandatory HTTP error status codes | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0005 | 6 | B | OpenAPI for TS 29.521 | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0006 | 1 | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0007 | 1 | B | Support of IPv4 overlapping | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0008 | | F | Correction of the service name | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0009 | 1 | F | Resource structure presentation | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0011 | | F | Default value for apiRoot Default value for apiRoot | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0012 | | F | Correction to DELETE Method for Nbsf_Management Service API | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0013 | | F | Correction to Typos in URI Paths | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0015 | | F | API version | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0016 | | F | ExternalDocs OpenAPI field | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0017 | | F | Location header field in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0018 | 1 | F | Security | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0019 | 1 | F | supported content types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0020 | 2 | F | HTTP Error responses | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0021 | 2 | F | DRA as service consumer | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0023 | | F | Change presence in BSF binding | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0024 | 1 | F | Presence conditions in yaml file | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0025 | 1 | F | Missing 201 response body for POST to /pcfBindings | 15.2.0 | +| 2019-03 | CT#83 | CP-190113 | 0028 | 2 | F | Handling of unsupported query parameter combinations | 15.3.0 | +| 2019-03 | CT#83 | CP-190113 | 0029 | 1 | F | Correction of description of the Nbsf_Management_Register Service and Nbsf_Management_Discovery service operations | 15.3.0 | +| 2019-03 | CT#83 | CP-190113 | 0030 | | F | BSF resource cleanup | 15.3.0 | +| 2019-03 | CT#83 | CP-190113 | 0031 | 1 | F | Formatting of structured data types in query parameters | 15.3.0 | +| 2019-03 | CT#83 | CP-190113 | 0032 | 1 | F | Correction on the handling of UE addresses | 15.3.0 | +| 2019-03 | CT#83 | CP-190110 | 0033 | 2 | F | Miscellaneous BSF correction | 15.3.0 | +| 2019-03 | CT#83 | CP-190140 | 0034 | 1 | F | OpenAPI Version number update | 15.3.0 | +| 2019-06 | CT#84 | CP-191079 | 0036 | | F | Remove NSI ID | 15.4.0 | +| 2019-06 | CT#84 | CP-191106 | 0037 | 5 | B | Support multiple UE addresses in one binding | 16.0.0 | +| 2019-06 | CT#84 | CP-191106 | 0038 | 5 | B | Binding update support | 16.0.0 | +| 2019-06 | CT#84 | CP-191079 | 0039 | 1 | F | Precedence of OpenAPI file | 15.4.0 | +| 2019-06 | CT#84 | CP-191079 | 0040 | 1 | F | Copyright Note in YAML files | 15.4.0 | +| 2019-06 | CT#84 | CP-191089 | 0041 | 1 | F | Correction of Location header in Nbsf_Management OpenAPI | 16.0.0 | +| 2019-06 | CT#84 | CP-191101 | 0043 | 2 | F | OpenAPI version number update | 16.0.0 | +| 2019-09 | CT#85 | CP-192199 | 0045 | 2 | F | Session binding for IPv6 addresses | 16.1.0 | +| 2019-09 | CT#85 | CP-192156 | 0046 | | F | Support multiple UE addresses in BSF | 16.1.0 | +| 2019-09 | CT#85 | CP-192152 | 0047 | 1 | B | IP address handling in wireline access | 16.1.0 | +| 2019-09 | CT#85 | CP-192234 | 0050 | 2 | F | OpenAPI version update TS 29.521 Rel-16 | 16.1.0 | +| 2019-12 | CT#86 | CP-193197 | 0053 | 3 | B | Same PCF selection for the same UE ID, S-NSSAI and DNN combination | 16.2.0 | +| 2019-12 | CT#86 | CP-193197 | 0054 | | F | Update of API version and TS version in OpenAPI file | 16.2.0 | +| 2020-03 | CT#87e | CP-200207 | 0055 | 1 | B | Update of the same PCF selection | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0056 | | B | DNN Clarification | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0058 | 2 | B | Adding NWDAF as Nbsf_management service consumer | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0059 | | F | Resolve editor note for PATCH | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0060 | 1 | F | Miscellaneous errors | 16.3.0 | +| 2020-03 | CT#87e | CP-200253 | 0061 | 1 | F | Support of the Update service operation | 16.3.0 | +| 2020-03 | CT#87e | CP-200214 | 0062 | | F | OpenAPI: usage of the "tags" keyword | 16.3.0 | +| 2020-03 | CT#87e | CP-200260 | 0063 | 1 | B | PCF set Id/PCF Id in Nbsf_Management_Register/Update | 16.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------|--------| +| 2020-03 | CT#87e | CP-200215 | 0064 | | F | Correction on PcfBinding | 16.3.0 | +| 2020-03 | CT#87e | CP-200216 | 0065 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-06 | CT#88e | CP-201233 | 0066 | 1 | F | Corrections on SamePcf | 16.4.0 | +| 2020-06 | CT#88e | CP-201246 | 0067 | 1 | F | Corrections related to UEaddr | 16.4.0 | +| 2020-06 | CT#88e | CP-201259 | 0068 | 3 | B | Update of PCF address(es) | 16.4.0 | +| 2020-06 | CT#88e | CP-201275 | 0069 | 2 | B | Clarification of the DS-TT MAC address | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0070 | 3 | B | Support of full Frame Routing feature | 16.4.0 | +| 2020-06 | CT#88e | CP-201212 | 0071 | 1 | F | Binding information retrieval: PCF set ID and PCF instance ID | 16.4.0 | +| 2020-06 | CT#88e | CP-201296 | 0073 | 2 | F | Correct use of application error | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0074 | 1 | F | Correct IPv6 prefix | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0076 | 1 | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201246 | 0080 | 1 | F | Adding DRA as Nbsf_management service consumer | 16.4.0 | +| 2020-06 | CT#88e | CP-201258 | 0081 | 1 | B | Update of PCF address(es) | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0083 | 1 | F | URI of the Nbsf_Management service | 16.4.0 | +| 2020-06 | CT#88e | CP-201222 | 0085 | 1 | A | Correction to the condition of BSF service operations | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0086 | 1 | F | Optionality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0087 | 1 | F | suppFeat attribute within PcfBinding data | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0088 | 1 | F | Supported headers, Resource Data type and yaml mapping | 16.4.0 | +| 2020-06 | CT#88e | CP-201255 | 0090 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2020-09 | CT#89e | CP-202077 | 0092 | | F | Data type corrections | 16.5.0 | +| 2020-12 | CT#90e | CP-203139 | 0093 | 1 | F | Essential Corrections and alignments | 16.6.0 | +| 2021-03 | CT#91e | CP-210191 | 0094 | 1 | F | Support of stateless NFs | 16.7.0 | +| 2021-03 | CT#91e | CP-210202 | 0095 | | F | Correction to Framed Routing feature | 16.7.0 | +| 2021-03 | CT#91e | CP-210217 | 0096 | | F | Storage of YAML files in ETSI Forge | 16.7.0 | +| 2021-03 | CT#91e | CP-210205 | 0098 | 1 | F | Correction to SamePcf feature | 16.7.0 | +| 2021-03 | CT#91e | CP-210219 | 0097 | | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.0.0 | +| 2021-03 | CT#91e | CP-210221 | 0099 | 1 | F | OpenAPI reference | 17.0.0 | +| 2021-03 | CT#91e | CP-210240 | 0102 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.0.0 | +| 2021-06 | CT#92e | CP-211234 | 0103 | 1 | F | Support of optional HTTP custom header fields | 17.1.0 | +| 2021-06 | CT#92e | CP-211219 | 0105 | | A | Correction to Overview and Introduction | 17.1.0 | +| 2021-06 | CT#92e | CP-211200 | 0107 | 1 | A | Redirect responses with "application/json" media type | 17.1.0 | +| 2021-06 | CT#92e | CP-211219 | 0109 | 1 | A | Correction to ExtendedSamePcf feature | 17.1.0 | +| 2021-06 | CT#92e | CP-211265 | 0111 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-09 | CT#93e | CP-212225 | 0113 | 1 | B | Subscription to notification of PCF registration | 17.2.0 | +| 2021-09 | CT#93e | CP-212224 | 0114 | | F | Correcting CR #0107 implementation | 17.2.0 | +| 2021-09 | CT#93e | CP-212225 | 0115 | 1 | B | DCAMP related update of BSF services | 17.2.0 | +| 2021-09 | CT#93e | CP-212225 | 0116 | 1 | B | DCAMP related updates in the resource structure | 17.2.0 | +| 2021-09 | CT#93e | CP-212225 | 0119 | 1 | B | Registration and Deregistration of the PCF for a UE | 17.2.0 | +| 2021-09 | CT#93e | CP-212225 | 0120 | 1 | B | DCAMP related updates in the OpenAPI file | 17.2.0 | +| 2021-09 | CT#93e | CP-212223 | 0121 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-12 | CT#94e | CP-213194 | 0122 | | F | Correction to PCF for a UE binding update procedure | 17.3.0 | +| 2021-12 | CT#94e | CP-213194 | 0123 | 1 | B | Subscription to PCF registration/deregistration events for multiple DNN and SNNSAI | 17.3.0 | +| 2021-12 | CT#94e | CP-213234 | 0124 | | B | Update of BSF NF service consumers | 17.3.0 | +| 2021-12 | CT#94e | CP-213234 | 0125 | | B | Clarification to the registered UE address for TSN and non-TSN scenarios. | 17.3.0 | +| 2021-12 | CT#94e | CP-213239 | 0126 | | F | Aligning API URI with SBI template | 17.3.0 | +| 2021-12 | CT#94e | CP-213200 | 0130 | 1 | B | Discover a PCF for a UE | 17.3.0 | +| 2021-12 | CT#94e | CP-213224 | 0132 | | A | Correction to PCF Session binding update procedure | 17.3.0 | +| 2021-12 | CT#94e | CP-213239 | 0135 | 1 | F | Naming Convention | 17.3.0 | +| 2021-12 | CT#94e | CP-213246 | 0136 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2022-03 | CT#95e | CP-220197 | 0137 | 1 | B | Completion of subscription to notification of PCF registration | 17.4.0 | +| 2022-03 | CT#95e | CP-220197 | 0138 | 1 | F | Clarification of table 4.2.1-1 | 17.4.0 | +| 2022-03 | CT#95e | CP-220176 | 0139 | 2 | A | Alignment of "Application Errors" clause with SBI TS template | 17.4.0 | +| 2022-03 | CT#95e | CP-220197 | 0140 | | F | Correction of references to the PCF Session binding resource | 17.4.0 | +| 2022-03 | CT#95e | CP-220197 | 0142 | | F | Removal of BindingSubscription data type | 17.4.0 | +| 2022-03 | CT#95e | CP-220194 | 0143 | | F | Update of info and externalDocs fields | 17.4.0 | +| 2022-06 | CT#96 | CP-221159 | 0144 | 1 | F | Correction to subscription procedures | 17.5.0 | +| 2022-06 | CT#96 | CP-221155 | 0145 | 1 | F | Update of Fqdn data type definition | 17.5.0 | +| 2022-06 | CT#96 | CP-221154 | 0146 | | F | Formatting of description fields | 17.5.0 | +| 2022-06 | CT#96 | CP-221155 | 0147 | 1 | F | Update the apiVersion placeholder | 17.5.0 | +| 2022-06 | CT#96 | CP-221151 | 0148 | | F | Update of info and externalDocs fields | 17.5.0 | +| 2022-09 | CT#97e | CP-222125 | 0149 | 1 | F | Correction in the handling of features for Nbsf | 17.6.0 | +| 2022-09 | CT#97e | CP-222125 | 0150 | 2 | F | Routing binding indication in the interactions with the PCF | 17.6.0 | +| 2022-09 | CT#97e | CP-222127 | 0151 | 1 | F | Corrections to Nbsf_Management_Subscribe service operation | 17.6.0 | +| 2022-09 | CT#97e | CP-222127 | 0152 | | F | Corrections to Nbsf_Management_Notify service operation | 17.6.0 | +| 2022-09 | CT#97e | CP-222127 | 0153 | 1 | F | Replacement of subsld with subld | 17.6.0 | +| 2022-09 | CT#97e | CP-222127 | 0154 | | F | Alignment of ipDomain in PcfForPduSessionInfo data type | 17.6.0 | +| 2022-09 | CT#97e | CP-222127 | 0155 | 1 | F | Correction to PCF address in PcfForUeBinding | 17.6.0 | +| 2022-09 | CT#97e | CP-222127 | 0156 | 1 | F | Corrections to UE binding information update procedure | 17.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------|--------| +| 2022-09 | CT#97e | CP-222127 | 0157 | | F | incorrect data structure in PUT response for subscription modification | 17.6.0 | +| 2022-09 | CT#97e | CP-222095 | 0158 | 1 | B | Updating the service description clauses to support the PCF for a MBS Session binding | 17.6.0 | +| 2022-09 | CT#97e | CP-222095 | 0159 | 1 | B | Defining the resources part to support the PCF for an MBS Session binding | 17.6.0 | +| 2022-09 | CT#97e | CP-222095 | 0160 | 1 | B | Defining the data model part to support the PCF for an MBS Session binding | 17.6.0 | +| 2022-09 | CT#97e | CP-222208 | 0161 | 1 | B | Updating the OpenAPI description part to support the PCF for an MBS Session binding | 17.6.0 | +| 2022-09 | CT#97e | CP-222121 | 0162 | 1 | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-12 | CT#98e | CP-223167 | 0164 | 1 | F | adding MBSF as a consumer of Nbsf_Management_Discovery service | 17.7.0 | +| 2022-12 | CT#98e | CP-223167 | 0165 | 1 | F | missing MBS session binding functionality related description | 17.7.0 | +| 2022-12 | CT#98e | CP-223167 | 0169 | 1 | F | Correction in Registration of a new PCF for an MBS Session | 17.7.0 | +| 2022-12 | CT#98e | CP-223167 | 0170 | 1 | F | Correction to service description clauses to support the PCF for a MBS Session binding | 17.7.0 | +| 2022-12 | CT#98e | CP-223197 | 0173 | 1 | F | Corrections for Nbsf_Management API | 17.7.0 | +| 2022-12 | CT#98e | CP-223188 | 0174 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-12 | CT#98e | CP-223191 | 0163 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223200 | 0167 | 3 | F | Update of 4.2.1 to add TSCTSF | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0168 | 1 | F | Indication of API version and BsFEvent enumeration | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0171 | 1 | F | Correction to DNN encoding | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0175 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230166 | 0176 | | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230131 | 0178 | 1 | A | Miscellaneous essential corrections to the MBS related procedures | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0179 | | F | Corrections to query parameters not respecting the naming convention | 18.1.0 | +| 2023-03 | CT#99 | CP-230177 | 0180 | | B | Support of IPv6 prefix delegation | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0181 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231133 | 0182 | 1 | F | Corrections related to DCAMP | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 0183 | | F | Missing description of 404 Not Found in procedures | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0184 | 2 | F | Missing description of HTTP redirect response for 5MBS | 18.2.0 | +| 2023-06 | CT#100 | CP-231152 | 0185 | 1 | B | updating the S-NSSAI of the session binding information | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 0187 | 1 | F | Error response for BSF notification | 18.2.0 | +| 2023-06 | CT#100 | CP-231179 | 0189 | 1 | A | Adding 5G DDNMF as consumer | 18.2.0 | +| 2023-06 | CT#100 | CP-231132 | 0190 | 1 | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0191 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-12 | CT#102 | CP-233250 | 0192 | 1 | F | feature naming for network slice replacement | 18.3.0 | +| 2023-12 | CT#102 | CP-233229 | 0194 | 1 | F | IETF RFC 7540 and 9457 obsoleted by RFC 9113 and 7807 | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29536/4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg b/raw/rel-18/29_series/29536/4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fe62a697edd8d9f040205d451d4ab85c6cd2cfd7 --- /dev/null +++ b/raw/rel-18/29_series/29536/4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4040f103cca1c9a310345f391db694711a5b001af223f99187e712749fe3458b +size 24529 diff --git a/raw/rel-18/29_series/29536/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29536/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..08c5eb99d3fc961ef2cd296499fe90d71ada6f52 --- /dev/null +++ b/raw/rel-18/29_series/29536/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cee8e84875f9639a4392ae1362bdb8d4e35efd1602f6c630603be6dbdd58ecc6 +size 9617 diff --git a/raw/rel-18/29_series/29536/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29536/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6afa44e2c47875e5da44542c898c22bcdff166b6 --- /dev/null +++ b/raw/rel-18/29_series/29536/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:69579bf38f4c3d65131528646668bdcb14eac57ae7230dcb7e5512ced5054bb9 +size 5710 diff --git a/raw/rel-18/29_series/29536/6e15fc9ea763541c5913d26f85072ae1_img.jpg b/raw/rel-18/29_series/29536/6e15fc9ea763541c5913d26f85072ae1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..85c21bde2f44059846dd55d1784ecce1d2de4728 --- /dev/null +++ b/raw/rel-18/29_series/29536/6e15fc9ea763541c5913d26f85072ae1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a64e085f128d263700e04f98486ad67ea4624835b0d2ba8f4279dc05f1b71b30 +size 37547 diff --git a/raw/rel-18/29_series/29536/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg b/raw/rel-18/29_series/29536/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..94635a52f82b970d0f6ef5fd03d09195bce8b27b --- /dev/null +++ b/raw/rel-18/29_series/29536/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d2074ac87d1acf1ae7aaa8601c433f4e14ea4be552373511e1d3b4ddd7eb407d +size 65962 diff --git a/raw/rel-18/29_series/29536/91b12db3c85bbf466ad27eb3665a1b06_img.jpg b/raw/rel-18/29_series/29536/91b12db3c85bbf466ad27eb3665a1b06_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..062fe33f79d92ec4e27deb5e18ae1a39778093ec --- /dev/null +++ b/raw/rel-18/29_series/29536/91b12db3c85bbf466ad27eb3665a1b06_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e562a7d79e60ce318403415ec83f7a5ca1fe00bdfb698ce0ba17209a5bf5d5d3 +size 11683 diff --git a/raw/rel-18/29_series/29536/98e54d5540b2efe3e24af3cf936bc4ea_img.jpg b/raw/rel-18/29_series/29536/98e54d5540b2efe3e24af3cf936bc4ea_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b9de7fcbe8357cb9b579acff58ccadef1f0a22dc --- /dev/null +++ b/raw/rel-18/29_series/29536/98e54d5540b2efe3e24af3cf936bc4ea_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c6a8e2a93db6d53c84aab92d89e0f3dbc66d298d9fb0cfa92b83a11973f6c493 +size 35731 diff --git a/raw/rel-18/29_series/29536/b54ce9bffd341cd643e196d5f4538829_img.jpg b/raw/rel-18/29_series/29536/b54ce9bffd341cd643e196d5f4538829_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b2a12dc5e6473e763ad4872a639addebf851e932 --- /dev/null +++ b/raw/rel-18/29_series/29536/b54ce9bffd341cd643e196d5f4538829_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5642a39e45c2e70a89f8e2020f708389b7e99eee8e76baed7dcea02fbe348841 +size 38784 diff --git a/raw/rel-18/29_series/29536/e5d1bcc699904ca5d56caf65ec83f5f3_img.jpg b/raw/rel-18/29_series/29536/e5d1bcc699904ca5d56caf65ec83f5f3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ffff21267f37441035456fea97695100d6412af1 --- /dev/null +++ b/raw/rel-18/29_series/29536/e5d1bcc699904ca5d56caf65ec83f5f3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7559fa582c3a6bb6100129e2882df9c381d5cc9da3d92855a11eb09902dbff37 +size 38178 diff --git a/raw/rel-18/29_series/29536/ead623e6a8ec701df64567695a57d01c_img.jpg b/raw/rel-18/29_series/29536/ead623e6a8ec701df64567695a57d01c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f177c9b7871014661e17d61d7a162e1347ab81ab --- /dev/null +++ b/raw/rel-18/29_series/29536/ead623e6a8ec701df64567695a57d01c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:45c6947fa5738bb243e7a239a95cd796024544bedb0f6d466a9b13a22c102af8 +size 30454 diff --git a/raw/rel-18/29_series/29537/raw.md b/raw/rel-18/29_series/29537/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..880ceec5a5295d66b2cdd4780dea04b671a66a1c --- /dev/null +++ b/raw/rel-18/29_series/29537/raw.md @@ -0,0 +1,2995 @@ + + +# 3GPP TS 29.537 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Multicast/Broadcast Policy Control Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font. Below the 'P' is a red signal wave icon, and below the entire logo is the text 'A GLOBAL INITIATIVE'. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Overview..... | 9 | +| 5 Services offered by the PCF..... | 10 | +| 5.1 Introduction ..... | 10 | +| 5.2 Npcf_MBSPolicyControl Service..... | 11 | +| 5.2.1 Service Description ..... | 11 | +| 5.2.2 Service Operations..... | 11 | +| 5.2.2.1 Introduction..... | 11 | +| 5.2.2.2 Npcf_MBSPoliyControl_Create..... | 11 | +| 5.2.2.2.1 General ..... | 11 | +| 5.2.2.2.2 MBS Policy Association Establishment..... | 11 | +| 5.2.2.3 Npcf_MBSPolicyControl_Update ..... | 14 | +| 5.2.2.3.1 General ..... | 14 | +| 5.2.2.3.2 MBS Policy Association Update..... | 14 | +| 5.2.2.4 Npcf_MBSPolicyControl_Delete ..... | 16 | +| 5.2.2.4.1 General ..... | 16 | +| 5.2.2.4.2 MBS Policy Association Deletion..... | 16 | +| 5.2.3 MBS Policy Decision Management ..... | 16 | +| 5.2.3.1 General..... | 16 | +| 5.2.3.1.1 MBS PCC Rule definition..... | 17 | +| 5.2.3.1.2 MBS QoS Decision..... | 18 | +| 5.2.3.1.3 MBS QoS Characteristics..... | 18 | +| 5.2.3.1.4 MBS Session-AMBR..... | 18 | +| 5.2.3.1.5 MBS Policy Control Request Triggers..... | 19 | +| 5.2.3.2 Provisioning and enforcement of MBS Policy Decisions ..... | 19 | +| 5.2.3.2.1 General ..... | 19 | +| 5.2.3.2.2 Provisioning and enforcement of MBS PCC rules..... | 19 | +| 5.2.3.2.3 Provisioning and enforcement of authorized MBS QoS for an MBS service data flow ..... | 19 | +| 5.2.3.2.4 Provisioning and enforcement of authorized MBS Session-AMBR..... | 20 | +| 5.2.3.2.5 Provisioning and enforcement of MBS Policy Control Request Triggers ..... | 20 | +| 5.2.4 MBS Policy Error Handling ..... | 21 | +| 5.2.4.1 MBS Policy Error Reporting ..... | 21 | +| 5.3 Npcf_MBSPolicyAuthorization Service..... | 22 | +| 5.3.1 Service Description ..... | 22 | +| 5.3.2 Service Operations..... | 22 | +| 5.3.2.1 Introduction..... | 22 | +| 5.3.2.2 Npcf_MBSPoliyAuthorization_Create..... | 22 | +| 5.3.2.2.1 General ..... | 22 | +| 5.3.2.2.2 MBS Application Session Context Establishment..... | 22 | +| 5.3.2.3 Npcf_MBSPoliyAuthorization_Update..... | 24 | +| 5.3.2.3.1 General ..... | 24 | +| 5.3.2.3.2 MBS Application Session Context Update ..... | 24 | +| 5.3.2.4 Npcf_MBSPoliyAuthorization_Delete..... | 25 | +| 5.3.2.4.1 General ..... | 25 | +| 5.3.2.4.2 MBS Application Session Context Deletion..... | 26 | +| 6 API Definitions ..... | 27 | +| 6.1 Npcf_MBSPolicyControl Service API..... | 27 | + +| | | | +|-------------|----------------------------------------------------------------------------------|----| +| 6.1.1 | Introduction ..... | 27 | +| 6.1.2 | Usage of HTTP ..... | 27 | +| 6.1.2.1 | General ..... | 27 | +| 6.1.2.2 | HTTP standard headers ..... | 27 | +| 6.1.2.2.1 | General ..... | 27 | +| 6.1.2.2.2 | Content type ..... | 27 | +| 6.1.2.3 | HTTP custom headers ..... | 27 | +| 6.1.3 | Resources ..... | 28 | +| 6.1.3.1 | Overview ..... | 28 | +| 6.1.3.2 | Resource: MBS Policies ..... | 28 | +| 6.1.3.2.1 | Description ..... | 28 | +| 6.1.3.2.2 | Resource Definition ..... | 28 | +| 6.1.3.2.3 | Resource Standard Methods ..... | 29 | +| 6.1.3.2.3.1 | POST ..... | 29 | +| 6.1.3.2.4 | Resource Custom Operations ..... | 30 | +| 6.1.3.3 | Resource: Individual MBS Policy ..... | 30 | +| 6.1.3.3.1 | Description ..... | 30 | +| 6.1.3.3.2 | Resource Definition ..... | 30 | +| 6.1.3.3.3 | Resource Standard Methods ..... | 30 | +| 6.1.3.3.3.1 | GET ..... | 30 | +| 6.1.3.3.3.2 | DELETE ..... | 31 | +| 6.1.3.3.4 | Resource Custom Operations ..... | 32 | +| 6.1.3.3.4.1 | Overview ..... | 32 | +| 6.1.3.3.4.2 | Operation: Update ..... | 33 | +| 6.1.4 | Custom Operations without associated resources ..... | 34 | +| 6.1.5 | Notifications ..... | 34 | +| 6.1.6 | Data Model ..... | 34 | +| 6.1.6.1 | General ..... | 34 | +| 6.1.6.2 | Structured data types ..... | 35 | +| 6.1.6.2.1 | Introduction ..... | 35 | +| 6.1.6.2.2 | Type: MbsPolicyCtxData ..... | 35 | +| 6.1.6.2.3 | Type: MbsPolicyDecision ..... | 36 | +| 6.1.6.2.4 | Type: MbsPolicyData ..... | 36 | +| 6.1.6.2.5 | Void ..... | 37 | +| 6.1.6.2.6 | Void ..... | 37 | +| 6.1.6.2.7 | Type: MbsPccRule ..... | 37 | +| 6.1.6.2.8 | Type: MbsQosDec ..... | 38 | +| 6.1.6.2.9 | Type: MbsQosChar ..... | 39 | +| 6.1.6.2.10 | Type: MbsErrorReport ..... | 39 | +| 6.1.6.2.11 | Type: MbsPolicyCtxDataUpdate ..... | 39 | +| 6.1.6.2.12 | Type: MbsReport ..... | 40 | +| 6.1.6.3 | Simple data types and enumerations ..... | 40 | +| 6.1.6.3.1 | Introduction ..... | 40 | +| 6.1.6.3.2 | Simple data types ..... | 40 | +| 6.1.6.3.3 | Enumeration: MbsPcrt ..... | 40 | +| 6.1.6.3.4 | Enumeration: MbsFailureCode ..... | 41 | +| 6.1.6.3.5 | Enumeration: MbsPccRuleStatus ..... | 41 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 41 | +| 6.1.6.5 | Binary data ..... | 42 | +| 6.1.6.5.1 | Binary Data Types ..... | 42 | +| 6.1.7 | Error Handling ..... | 42 | +| 6.1.7.1 | General ..... | 42 | +| 6.1.7.2 | Protocol Errors ..... | 42 | +| 6.1.7.3 | Application Errors ..... | 42 | +| 6.1.8 | Feature negotiation ..... | 43 | +| 6.1.9 | Security ..... | 43 | +| 6.2 | Npcf_MBSPolicyAuthorization Service API ..... | 44 | +| 6.2.1 | Introduction ..... | 44 | +| 6.2.2 | Usage of HTTP ..... | 44 | +| 6.2.2.1 | General ..... | 44 | +| 6.2.2.2 | HTTP standard headers ..... | 44 | +| 6.2.2.2.1 | General ..... | 44 | + +| | | | +|------------------------------------------------------------|----------------------------------------------------------------------------------|-----------| +| 6.2.2.2.2 | Content type ..... | 44 | +| 6.2.2.3 | HTTP custom headers..... | 44 | +| 6.2.3 | Resources..... | 45 | +| 6.2.3.1 | Overview..... | 45 | +| 6.2.3.2 | Resource: MBS Application Session Contexts..... | 45 | +| 6.2.3.2.1 | Description ..... | 45 | +| 6.2.3.2.2 | Resource Definition..... | 45 | +| 6.2.3.2.3 | Resource Standard Methods..... | 46 | +| 6.2.3.2.3.1 | POST ..... | 46 | +| 6.2.3.2.4 | Resource Custom Operations..... | 46 | +| 6.2.3.3 | Resource: Individual MBS Application Session Context..... | 47 | +| 6.2.3.3.1 | Description ..... | 47 | +| 6.2.3.3.2 | Resource Definition..... | 47 | +| 6.2.3.3.3 | Resource Standard Methods..... | 47 | +| 6.2.3.3.3.1 | GET ..... | 47 | +| 6.2.3.3.3.2 | PATCH..... | 48 | +| 6.2.3.3.3.3 | DELETE ..... | 49 | +| 6.2.3.3.4 | Resource Custom Operations..... | 51 | +| 6.2.4 | Custom Operations without associated resources ..... | 51 | +| 6.2.5 | Notifications ..... | 51 | +| 6.2.6 | Data Model ..... | 51 | +| 6.2.6.1 | General..... | 51 | +| 6.2.6.2 | Structured data types..... | 51 | +| 6.2.6.2.1 | Introduction ..... | 51 | +| 6.2.6.2.2 | Type: MbsAppSessionCtxt ..... | 52 | +| 6.2.6.2.3 | Type: MbsAppSessionCtxtPatch..... | 53 | +| 6.2.6.2.4 | Type: AcceptableMbsServInfo ..... | 53 | +| 6.2.6.3 | Simple data types and enumerations..... | 53 | +| 6.2.6.3.1 | Introduction ..... | 53 | +| 6.2.6.3.2 | Simple data types ..... | 53 | +| 6.2.6.4 | Data types describing alternative data types or combinations of data types ..... | 54 | +| 6.2.6.4.1 | Type: MbsExtProblemDetails ..... | 54 | +| 6.2.6.5 | Binary data ..... | 54 | +| 6.2.6.5.1 | Binary Data Types..... | 54 | +| 6.2.7 | Error Handling ..... | 54 | +| 6.2.7.1 | General..... | 54 | +| 6.2.7.2 | Protocol Errors ..... | 54 | +| 6.2.7.3 | Application Errors..... | 54 | +| 6.2.8 | Feature negotiation ..... | 55 | +| 6.2.9 | Security..... | 55 | +| Annex A (normative): OpenAPI specification ..... | | 56 | +| A.1 | General..... | 56 | +| A.2 | Npcf_MBSPolicyControl API ..... | 57 | +| A.3 | Npcf_MBSPolicyAuthorization API ..... | 64 | +| Annex B (informative): Withdrawn API versions ..... | | 68 | +| B.1 | General..... | 68 | +| B.2 | Npcf_MBSPolicyControl API ..... | 68 | +| B.3 | Npcf_MBSPolicyAuthorization API ..... | 68 | +| Annex C (informative): Change history..... | | 69 | + +# Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Service Based Interfaces of the Multicast/Broadcast Policy Control Services. It provides stage 3 protocol definitions and message flows, and specifies the APIs of the Multicast/Broadcast Services provided by the PCF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. The stage 2 architecture and procedures for 5G Multicast/Broadcast Services are specified in 3GPP TS 23.247 [14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services; Stage 2". +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [16] 3GPP TS 29.532: "5G System; 5G Multicast-Broadcast Session Management Services; Stage 3". +- [17] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [18] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [19] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". + +- [20] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for Exposure; Stage 3". +- [21] 3GPP TS 29.521: "5G System; Binding Support Management Service; Stage 3". +- [22] IETF RFC 7396: "JSON Merge Patch". + +# --- 3 Definitions, symbols 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]. + +For the purpose of the present document, the terms and definitions given in clause 3 of 3GPP TS 23.247 [14] also apply, including the ones referencing other specifications. + +## 3.2 Symbols + +None. + +## 3.3 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]. + +| | | +|--------|-------------------------------------------------| +| MBS | Multicast/Broadcast Service | +| MB-SMF | Multicast/Broadcast Session Management Function | +| MBSF | Multicast/Broadcast Service Function | + +# --- 4 Overview + +In the frame of supporting Multicast/Broadcast Services (MBS), the Policy Control Function (PCF) provides services to NF service consumers (e.g. MB-SMF) via the Npcf Service Based Interface. The PCF supports for this purpose the functionalities defined in 3GPP TS 23.247 [14], i.e. MBS related Policy and Charging Control procedures. + +Figures 4-1 and 4-2 depict the Multicast/Broadcast related reference architecture of the PCF respectively in SBI representation and reference point representation. + +![Reference model for the MBS PCF Services – SBI representation diagram showing a central PCF connected to four network functions: MB-SMF, NEF, AF, and MBSF via the Npcf interface.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +graph TD + PCF[PCF] -- Npcf --> MB-SMF[MB-SMF] + PCF -- Npcf --> NEF[NEF] + PCF -- Npcf --> AF[AF] + PCF -- Npcf --> MBSF[MBSF] + style PCF fill:#90EE90 + +``` + +Reference model for the MBS PCF Services – SBI representation diagram showing a central PCF connected to four network functions: MB-SMF, NEF, AF, and MBSF via the Npcf interface. + +Figure 4-1: Reference model for the MBS PCF Services – SBI representation + +![Reference Model for the MBS PCF Services – Reference point representation diagram showing four network functions (MB-SMF, NEF, AF, MBSF) connected to a central PCF via specific reference points: N7mb, N30, N5, and Nmb12.](b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg) + +``` + +graph LR + MB-SMF[MB-SMF] -- N7mb --> PCF[PCF] + NEF[NEF] -- N30 --> PCF + AF[AF] -- N5 --> PCF + MBSF[MBSF] -- Nmb12 --> PCF + style PCF fill:#90EE90 + +``` + +Reference Model for the MBS PCF Services – Reference point representation diagram showing four network functions (MB-SMF, NEF, AF, MBSF) connected to a central PCF via specific reference points: N7mb, N30, N5, and Nmb12. + +Figure 4-2: Reference Model for the MBS PCF Services – Reference point representation + +# 5 Services offered by the PCF + +## 5.1 Introduction + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------------------|--------|----------------------------------|---------------------------------------------------|-------------------------------|-------| +| Npcf_MBSPolicyControl | 5.2 | MBS Policy Control Service | TS29537_Npcf_MBS
SPolicyControl.yaml | npcf-
mbspolicycont
rol | A.2 | +| Npcf_MBSPolicyAuthoriz
ation | 5.3 | MBS Policy Authorization Service | TS29537_Npcf_MBS
SPolicyAuthorization
.yaml | npcf-
mbspolicyauth | A.3 | + +## 5.2 Npcf\_MBSPolicyControl Service + +### 5.2.1 Service Description + +The MBS Session Policy Control Service enables the Policy Control Function (PCF) to provision, update and remove MBS session related policies to NF service consumers (e.g. MB-SMF), i.e.: + +- enable an NF service consumer to request the creation, update and deletion of an MBS Policy Association for an MBS session; and +- enable the PCF to provision/update/remove MBS policies towards an NF service consumer. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operations defined for the Npcf\_MBSPolicyControl Service are shown in table 5.2.2.1-1. + +**Table 5.2.2.1-1: Npcf\_MBSPolicyControl Operations** + +| Service Operation Name | Description | Initiated by | +|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| +| Npcf_MBSPolicyControl_Create | Request the creation of an MBS Policy Association at the PCF in order to receive MBS policies for an MBS session. | NF service consumer (e.g. MB-SMF) | +| Npcf_MBSPolicyControl_Update | Request the update of an existing MBS Policy Association at the PCF in order to receive the updated MBS policies for an MBS session. | NF service consumer (e.g. MB-SMF) | +| Npcf_MBSPolicyControl_Delete | Request the deletion of an existing MBS Policy Association. | NF service consumer (e.g. MB-SMF) | + +#### 5.2.2.2 Npcf\_MBSPolicyControl\_Create + +##### 5.2.2.2.1 General + +The Npcf\_MBSPolicyControl\_Create service operation enables an NF service consumer (e.g. MB-SMF) to request the creation of an MBS Policy Association at the PCF and the provisioning of MBS policies for a multicast or a broadcast MBS session. + +The following procedures using the Npcf\_MBSPolicyControl\_Create service operation are supported: + +- MBS Policy Association Establishment. + +##### 5.2.2.2.2 MBS Policy Association Establishment + +![Sequence diagram showing the procedure for MBS Policy Association establishment between an NF service consumer and a PCF.](a7079ddb124df3f1ee13ae406c7c8982_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note left of NF service consumer: + NF service consumer->>PCF: 1. POST .../mbs-policies (MbsPolicyCtxtData) + Note right of PCF: + PCF-->>NF service consumer: 2. 201 Created (MbsPolicyData) + +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and a PCF. The first message, labeled '1. POST .../mbs-policies (MbsPolicyCtxtData)', is sent from the NF service consumer to the PCF. The second message, labeled '2. 201 Created (MbsPolicyData)', is sent from the PCF back to the NF service consumer. Vertical lines represent the lifelines of the two entities, and horizontal arrows represent the messages. + +Sequence diagram showing the procedure for MBS Policy Association establishment between an NF service consumer and a PCF. + +**Figure 5.2.2.2.2-1: Procedure for MBS Policy Association establishment** + +1. In order to request the creation of an MBS Policy Association, the NF service consumer (e.g. MB-SMF) shall send an HTTP POST request to the PCF targeting the URI of the "MBS Policies" collection resource, with the request body containing the MbsPolicyCtxData data structure that shall contain: + - the identifier of the concerned MBS Session, within the "mbsSessionId" attribute; + - the MBS Service Information, if available, within the "mbsServInfo" attribute; + - the list of supported features, if feature negotiation needs to take place, within the "suppFeat" attribute; and + - the Area Session Policy ID within the "areaSessPolId" attribute, if the "AreaSessPolicy" feature is supported and the request corresponds to an MBS Session that is an instance of a location-dependent MBS service.and may contain: + - the DNN of the MBS session, within the "dnn" attribute; and + - the S-NSSAI of the MBS session, within the "snssai" attribute. +2. Upon reception of the HTTP POST request from the NF service consumer: + - if MBS Service Information is present within the "mbsServInfo" attribute, the MBS session is an instance of a location-dependent MBS service, and if the "AreaSessPolicy" feature is supported, the Area Session Policy ID is present within the "areaSessPolId" attribute, and the PCF is not already serving this location-dependent MBS service (i.e., there is no MBS Policy Association at the PCF for the MBS Session ID provided within "mbsSessionId" attribute), or if the MBS Service Information is not present, the PCF may interact with the BSF by invoking the Nbsf\_Management\_Register service operation, as specified in clause 4.2.2.4 of 3GPP TS 29.521 [21], to check whether there is already a PCF serving the MBS Session, and if it is not the case, register itself as the PCF serving the MBS session; + +NOTE 1: Interacting with the BSF is not necessary in a deployment with a single PCF. + +- if MBS Service Information is present within the "mbsServInfo" attribute, then: + - the PCF may interact with the UDR to retrieve MBS Session policy control data for the MBS session, as specified in 3GPP TS 29.519 [20]; + +NOTE 2: Interacting with the UDR for MBS Session policy control data retrieval is not necessary in a deployment where MBS Policy Session policy control data is stored locally at the PCF. + +- the PCF shall then perform MBS policy authorization based on the received MBS Service Information, the operator policies that are pre-configured at the PCF and the MBS Session policy control data retrieved from the UDR, if any; +- if MBS policy authorization is successful, the PCF shall derive the required MBS policies (e.g. QoS parameters) and determine whether they are allowed or not; +- if the required MBS policies are allowed: + - the PCF shall store the generated MBS policies for the MBS session together with the corresponding MBS session ID, and if the "AreaSessPolicy" feature is supported and the MBS session is an instance of a location-dependent MBS service, the corresponding Area Session Policy ID; and +- if MBS policy authorization is not successful or the required MBS policies are not allowed, the PCF shall reject the request with an appropriate error response as specified below in this clause; +- otherwise, when MBS Service Information is not present within the "mbsServInfo" attribute and the PCF has previously derived the necessary MBS policies for the MBS session using the procedure defined in clause 5.3.2.2, the PCF shall provide these MBS policies in the response message returned to the NF service consumer (MB-SMF) as described below; +- upon success, the PCF shall: + - create a new "Individual MBS Policy" resource; and + +- respond to the NF service consumer with an HTTP "201 Created" status code including a Location header field containing the URI of the created "Individual MBS Policy" resource, and the response body including the MbsPolicyData data structure that shall contain: + - the received input parameters within the corresponding request body, within the "mbsPolicyCtxtData" attribute; + - the provisioned MBS Policy Decision containing the MBS policies derived by the PCF as defined above in this clause, within the "mbsPolicies" attribute; and + - the list of supported features, if feature negotiation is taking place, within the "suppFeat" attribute; +- if errors occur when processing the HTTP POST request, the PCF shall apply the error handling procedures specified in clause 6.1.7; + +NOTE 3: The PCF also deregisters at the BSF from being the PCF serving the MBS Session using the procedure defined in clause 4.2.3.4 of 3GPP TS 29.521 [21], if the PCF created such MBS Session binding as defined above in this clause. Interacting with the BSF to deregister from being the PCF serving the MBS Session is not necessary in a deployment with a single PCF. + +NOTE 4: For a location-dependent MBS service, the PCF deregisters at the BSF from being the PCF serving the MBS Session as indicated in NOTE 3 above only if it is the last MBS Policy Association associated to the location-dependent MBS service (i.e., associated to the corresponding MBS Session ID). + +- if MBS Service Information is provided but is invalid, incorrect or insufficient for the PCF to perform MBS policy authorization, the PCF shall reject the request with an HTTP "400 Bad Request" response message including the ProblemDetails data structure with the "cause" attribute set to "INVALID\_MBS\_SERVICE\_INFO"; +- if MBS Service Information is provided, but the MBS IP flow(s) description provided within the MBS Service Information cannot be handled by the PCF because the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] are not respected, the PCF shall reject the request with an HTTP "400 Bad Request" status code including the ProblemDetails data structure with the "cause" attribute set to "FILTER\_RESTRICTIONS\_NOT\_RESPECTED"; +- if from an application level point of view, the provided set of input parameters is incomplete, erroneous or missing necessary information for the PCF to perform MBS policy control, the PCF shall reject the request with an HTTP "400 Bad Request" response message including the ProblemDetails data structure with the "cause" attribute set to "ERROR\_INPUT\_PARAMETERS"; +- if MBS Service Information is provided but is not authorized, the PCF shall reject the request with an HTTP "403 Forbidden" status code including the MbsExtProblemDetails data structure that shall contain: + - the ProblemDetails data structure with the "cause" attribute set to "MBS\_SERVICE\_INFO\_NOT\_AUTHORIZED"; + +and may contain: + +- the AcceptableMbsServInfo data structure including the MBS Service Information that is acceptable for the PCF; + +and + +- if the PCF denies the creation of the "Individual MBS Policy" resource based on local configuration and/or operator policies, the PCF shall reject the request within an HTTP "403 Forbidden" status code including the "cause" attribute of the ProblemDetails data structure set to "MBS\_POLICY\_CONTEXT\_DENIED". At the reception of this error code and based on the internally configured failure actions, the NF service consumer may reject or allow, by applying local policies, the establishment of the corresponding MBS session. + +#### 5.2.2.3 Npcf\_MBSPolicyControl\_Update + +##### 5.2.2.3.1 General + +The Npcf\_MBSPolicyControl\_Update service operation enables the NF service consumer (e.g. MB-SMF) to request the update of an existing "Individual MBS Policy" resource for a multicast or a broadcast MBS session and/or report MBS Policy Decision installation and/or enforcement failure(s) to the PCF. + +The following procedures using the Npcf\_MBSPolicyControl\_Update service operation are supported: + +- MBS Policy Association Update. + +##### 5.2.2.3.2 MBS Policy Association Update + +![Sequence diagram showing the procedure for MBS Policy Association Update. The NF service consumer sends a POST request to the PCF, and the PCF responds with a 200 OK.](c036e2540a94b31357ceb0002f0cacab_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST .../mbs-policies/{mbsPolicyId}/update (MbsPolicyCtxtDataUpdate) + NF service consumer->>PCF: Request + Note left of PCF: 2. 200 OK (MbsPolicyData) + PCF-->>NF service consumer: Response + +``` + +Sequence diagram showing the procedure for MBS Policy Association Update. The NF service consumer sends a POST request to the PCF, and the PCF responds with a 200 OK. + +**Figure 5.2.2.3.2-1: Procedure for MBS Policy Association Update** + +1. In order to request the update of an existing MBS Policy Association, the NF service consumer shall invoke the "Update" resource custom operation by sending an HTTP POST request to the PCF targeting the URI of the corresponding "Individual MBS Policy" resource custom operation, i.e. "{apiRoot}/npcf-mbspolicycontrol//mbs-policies/{mbsPolicyId}/update", with the request body including the MbsPolicyCtxtDataUpdate data structure that may contain: + - the updated MBS Service Information, within the "mbsServInfo" attribute; + - the MBS Policy Control Request Triggers that are met, within the "mbsPerts" attribute, and/or + - the MBS Error reporting containing the MBS Policy Decision installation and/or enforcement failure(s), within the "mbsErrorReport" attribute. + +If the PCF determines that the received HTTP POST request needs to be redirected, the PCF shall respond with an HTTP redirect response, as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +2. Upon reception of the HTTP POST request from the NF service consumer: + - if the MBS Policy Control Request Trigger "MBS\_SESSION\_UPDATE" is triggered and updated MBS Service Information is present within the "mbsServInfo" attribute, then the PCF shall perform MBS policy authorization for the received updated MBS Service Information taking into account the operator policies pre-configured at the PCF and/or the MBS Session policy control data retrieved from the UDR. Then: + - if MBS policy authorization is successful, the PCF shall determine whether updated MBS policies (e.g. QoS parameters) need to be derived and provisioned. If it is the case, the PCF shall derive these required updated MBS policies (e.g. QoS parameters) and determine whether they are allowed or not; + - if updated MBS policies are derived and allowed, the PCF shall store the generated updated MBS policies for the MBS session together with the corresponding MBS session ID; and + - if MBS policy authorization is not successful or the required updated MBS policies, if any, are not allowed, the PCF shall reject the request with an appropriate error response as specified below in this clause; + - if the MBS Policy Control Request Trigger "MBS\_SESSION\_UPDATE" is triggered and no updated MBS Service Information is provided, then the PCF may identify whether there are any updated MBS policies that need to be applied as per the procedure defined in clause 5.3.2.3 and/or based on local configuration; + +NOTE: If updated MBS Service Information is not present in the received request, then the PCF has previously determined and generated the required updated MBS policies for the MBS session as specified in clause 5.3. + +- if MBS error reporting is present in the request and contains a set of MBS Policy Decision installation and/or enforcement failure(s), the PCF may take it into account when deriving the required updated MBS policies as specified in clause 5.2.4.1; +- upon success, the PCF shall: + - update the corresponding "Individual MBS Policy" resource accordingly; and + - respond to the NF service consumer with an HTTP "200 OK" status code with the response body including the MbsPolicyData data structure that shall contain: + - the updated complete list of input parameters, within the "mbsPolicyCtxtData" attribute;and may contain: + - the updated MBS Policy Decision containing the updated, deleted and/or newly provisioned MBS policies, within the "mbsPolicies" attribute; +- if errors occur when processing the HTTP POST request, the PCF shall apply the error handling procedures specified in clause 6.1.7; +- if updated MBS Service Information is provided but is invalid, incorrect or insufficient for the PCF to perform MBS policy authorization, the PCF shall reject the request with an HTTP "400 Bad Request" response message including the ProblemDetails data structure with the "cause" attribute set to "INVALID\_MBS\_SERVICE\_INFO"; +- if updated MBS Service Information is provided, but the MBS IP flow(s) description provided within the MBS Service Information cannot be handled by the PCF because the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] are not respected, the PCF shall reject the request with an HTTP "400 Bad Request" status code including the ProblemDetails data structure with the "cause" attribute set to "FILTER\_RESTRICTIONS\_NOT\_RESPECTED"; +- if from an application level point of view, the provided set of input parameters is incomplete, erroneous or missing necessary information for the PCF to perform MBS policy control, the PCF shall reject the request with an HTTP "400 Bad Request" response message including the ProblemDetails data structure with the "cause" attribute set to "ERROR\_INPUT\_PARAMETERS"; +- if updated MBS Service Information is provided but is not authorized, the PCF shall reject the request with an HTTP "403 Forbidden" status code including the MbsExtProblemDetails data structure that shall contain: + - the ProblemDetails data structure with the "cause" attribute set to "MBS\_SERVICE\_INFO\_NOT\_AUTHORIZED";and may contain: + - the AcceptableMbsServInfo data structure including the MBS Service Information that is acceptable for the PCF; +- if the PCF denies the update of the "Individual MBS Policy" resource based on local configuration and/or operator policies, the PCF shall reject the request within an HTTP "403 Forbidden" status code including the ProblemDetails data structure with the "cause" attribute set to "MBS\_POLICY\_CONTEXT\_DENIED". At the reception of this error code and based on the internally configured failure actions, the NF service consumer (MB-SMF) may reject or allow, by applying local policies, the update of the corresponding MBS session; and +- if the targeted "Individual MBS Policy" resource does not exist, the PCF shall reject the request with an HTTP "404 Not Found" status code including the ProblemDetails data structure with the "cause" attribute set to "MBS\_POLICY\_ASSOCIATION\_NOT\_FOUND". + +#### 5.2.2.4 Npcf\_MBSPolicyControl\_Delete + +##### 5.2.2.4.1 General + +The Npcf\_MBSPolicyControl\_Delete service operation enables the NF service consumer (e.g. MB-SMF) to request the deletion of an existing "Individual MBS Policy" resource. + +The following procedures using the Npcf\_MBSPolicyControl\_Delete service operation are supported: + +- MBS Policy Association Deletion. + +##### 5.2.2.4.2 MBS Policy Association Deletion + +![Sequence diagram showing the MBS Policy Association Deletion procedure. An NF service consumer sends a DELETE request to the PCF, and the PCF responds with a 204 No Content.](6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note left of NF service consumer: + NF service consumer->>PCF: 1. DELETE .../mbs-policies/{mbsPolicyId} + Note right of PCF: + PCF-->>NF service consumer: 2. 204 No Content +``` + +Sequence diagram showing the MBS Policy Association Deletion procedure. An NF service consumer sends a DELETE request to the PCF, and the PCF responds with a 204 No Content. + +**Figure 5.2.2.4.2-1: MBS Policy Association Deletion procedure** + +1. In order to request the deletion of an existing MBS Policy Association, the NF service consumer shall send an HTTP DELETE request to the PCF, targeting the URI of the corresponding "Individual MBS Policy" resource. + +If the PCF determines that the received HTTP DELETE request needs to be redirected, the PCF shall respond with an HTTP redirect response, as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +2. On successful deletion of the targeted MBS Policy Association: + - the PCF may deregister at the BSF from being the PCF serving the MBS Session using the procedure defined in clause 4.2.3.4 of 3GPP TS 29.521 [21], if the PCF created such MBS Session binding during the creation of the MBS Policy Association, and for a location-dependent MBS service, this is the last MBS Policy Association associated to the location-dependent MBS service (i.e., associated to the corresponding MBS Session ID), as specified in clause 5.2.2.2; and + - the PCF shall respond to the NF service consumer (MB-SMF) with an HTTP "204 No Content" status code. + +If errors occur when processing the HTTP DELETE request, the PCF shall apply the error handling procedures specified in clause 6.1.7. + +If the targeted "Individual MBS Policy" resource does not exist, the PCF shall reject the request with an HTTP "404 Not Found" status code including the ProblemDetails data structure with the "cause" attribute set to "MBS\_POLICY\_ASSOCIATION\_NOT\_FOUND". + +### 5.2.3 MBS Policy Decision Management + +#### 5.2.3.1 General + +An MBS Policy Decision enables to provide the necessary MBS policies for controlling an MBS Session. An MBS Policy Decision is encoded via the MbsPolicyDecision data structure defined in clause 6.1.6.2.3 and composed of the following information: + +- MBS PCC rule(s), within the "mbsPccRules" attribute. +- MBS QoS decision(s), which can be referred by MBS PCC rules, within the "mbsQosDecs" attribute. + +- Set(s) of MBS QoS characteristics for non-standardized and non-preconfigured 5QIs, within the "mbsQosChars" attribute. +- The authorized MBS Session-AMBR, within the "authMbsSessAmbr" attribute. +- The MBS Policy Control Request Trigger(s), within the "mbsPerts" attribute. + +The following clauses describe the above components of an MBS Policy Decision. + +##### 5.2.3.1.1 MBS PCC Rule definition + +An MBS PCC rule enables to provide MBS policy control for an MBS service data flow. It is composed of the following information, as defined in table 5.2.3.1.1-1. + +- Information enabling the detection of the MBS service data flow. +- A set of MBS Policy Control parameters to be enforced for the MBS service data flow. + +**Table 5.2.3.1.1-1: Content of an MBS PCC rule** + +| Name | Description | Category | +|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| MBS PCC Rule identifier | Uniquely identifies the MBS PCC rule, within an MBS Session. It is used between the PCF and the MB-SMF for referencing the MBS PCC rules of an MBS Session. | Mandatory | +| MBS service data flow detection | | | +| Precedence | Determines the order in which the MBS service data flow template of the MBS PCC rule is applied relative to the MBS service data flow templates of the other MBS PCC rules of the MBS session, during MBS service data flow detection and policy enforcement. | Mandatory | +| MBS Service Data Flow Template | The list of MBS service data flow filter(s) for the detection of the MBS service data flow. | Mandatory | +| MBS policy control parameters | | | +| 5QI | Identifier of the authorized set of QoS parameters for the MBS service data flow. | Mandatory | +| ARP | The authorized Allocation and Retention Priority for the MBS service data flow, consisting of the priority level, the pre-emption capability and the pre-emption vulnerability. | Mandatory | +| MBR – Maximum BitRate (DL) | The downlink maximum bitrate authorized for the MBS service data flow. | Optional | +| GBR – Guaranteed BitRate (DL) | The downlink guaranteed bitrate authorized for the MBS service data flow. | Optional | +| Averaging Window | Represents the duration over which the guaranteed and maximum bitrates shall be calculated. | Optional | +| Priority Level | Indicates the level of priority in scheduling resources among MBS QoS flows. | Optional | +| Maximum Data Burst Volume | Denotes the largest amount of data that is required to be transferred within a period of 5G-AN PDB. | Optional | + +NOTE: If the user plane towards the MB-UPF uses a unicast tunnel, the MBS Service Data Flow Template relates to the inner IP layer within the unicast tunnel. + +An MBS PCC rule is encoded via the MbsPccRule data structure defined in clause 6.1.6.2.7 and is composed of the following information: + +- An MBS PCC rule identifier that uniquely identifies the MBS PCC rule within the related MBS Session, within the "mbsPccRuleId" attribute. +- The MBS service data flow template for MBS service data flow detection, within the "mbsDlIpFlowInfo" attribute. +- The precedence information, i.e. the order in which the MBS service data flow template of the MBS PCC rule is applied relative to the MBS service data flow templates of the other MBS PCC rules of the MBS session, during MBS service data flow detection and policy enforcement, within the "precedence" attribute. + +- The MBS authorized QoS to be applied for the MBS service data flow corresponding to the MBS PCC rule, i.e. a reference to an MBS QoS decision instance provisioned by the PCF at MBS Policy Decision level, within the "refMbsQosDec" attribute. + +The following operations are allowed on MBS PCC rule(s): + +- Installation, i.e. to provision MBS PCC rule(s). +- Modification, i.e. to modify MBS PCC rule(s). +- Removal, i.e. to remove MBS PCC rule(s). + +##### 5.2.3.1.2 MBS QoS Decision + +An MBS Policy Decision based on MBS QoS contains the QoS parameters to be applied for an MBS service data flow. It defines the QoS parameters (e.g. 5QI, ARP, maximum/guaranteed bitrates, etc.) to be applied for the corresponding MBS PCC rule. An MBS QoS decision is encoded via the MbsQosDec data structure defined in clause 6.1.6.2.8 and composed of the following information: + +- An identifier of the MBS QoS Decision that uniquely identifies the MBS QoS Decision within the related MBS Session, within the "mbsQosId" attribute. +- The 5QI information, i.e. an identifier of the set of QoS parameters to be applied to an MBS service data flow, within the "5qi" attribute; +- The 5QI Priority Level, within the "priorityLevel" attribute. +- The Allocation and Retention Priority information to be applied for an MBS service data flow, within the "arp" attribute. +- The Maximum Downlink Bit Rate for to be applied for an MBS service data flow, within the "mbrDI" attribute. +- The Guaranteed Downlink Bit Rate to be applied for an MBS service data flow, within the "gbrDI" attribute. +- The averaging window, i.e. the duration over which the guaranteed and maximum bitrates shall be calculated, within the "averWindow" attribute. +- The MBS Maximum Data Burst Volume to be applied for an MBS service data flow, within the "mbsMaxDataBurstVol" attribute. + +##### 5.2.3.1.3 MBS QoS Characteristics + +A set of MBS QoS Characteristics contains the QoS parameters for a non-standardized and non-preconfigured 5QI. It defines the QoS parameters (e.g. 5QI, ARP, maximum/guaranteed bitrates, etc.) to be applied for an MBS PCC rule and the corresponding MBS service data flow. A set of MBS QoS Characteristics is encoded via the MbsQosChars data structure defined in clause 6.1.6.2.9 and composed of the following information: + +- The 5QI information, i.e. an identifier of the set of non-standardized and non-preconfigured QoS parameters for an MBS service data flow, within the "5qi" attribute. It applies at MBS PCC rule level and MBS session level. +- The resource type (i.e. GBR, delay critical GBR or non-GBR), within the "resourceType" attribute. +- The 5QI priority level, within the "priorityLevel" attribute. +- The Packet Delay Budget, within the "packetDelayBudget" attribute. +- The Packet Error Rate, within the "packetErrorRate" attribute. +- The averaging window, within the "averWindow" attribute. +- The MBS Maximum Data Burst Volume, within the "mbsMaxDataBurstVol" attribute. + +##### 5.2.3.1.4 MBS Session-AMBR + +The MBS Session-AMBR contains the Aggregated Maximum Bit Rate to be applied for an MBS session. + +##### 5.2.3.1.5 MBS Policy Control Request Triggers + +The MBS Policy Control Request Triggers identify the conditions based on which the NF service consumer (MB-SMF) shall trigger the MBS Policy Association Update procedure defined in clause 5.2.2.3. They can be either pre-configured at the NF service consumer (MB-SMF), i.e. implicitly subscribed by default by the PCF, or explicitly provisioned by the PCF to the NF service consumer (MB-SMF) during the MBS Policy Association Creation/Update procedures defined in clause 5.2.2. + +The MBS Policy Control Request Triggers are encoded using the MbsPcrt Enumeration data type defined in clause 6.1.6.3.3. The possible values are the following: + +- "MBS\_SESSION\_UPDATE", i.e. MBS Session Update: the MBS policies may need to be updated due to updated MBS Session information. This MBS Policy Control Request Trigger is pre-configured at the NF service consumer (MB-SMF), i.e. implicitly subscribed by the PCF. + +#### 5.2.3.2 Provisioning and enforcement of MBS Policy Decisions + +##### 5.2.3.2.1 General + +MBS Policy Decisions are provided by the PCF to the NF service consumer (MB-SMF) as part of the following service operations: + +- the Npcf\_MBSPolicyControl\_Create service operation defined in clause 5.2.2.2; and +- the Npcf\_MBSPolicyControl\_Update service operation defined in clause 5.2.2.3. + +For the Npcf\_MBSPolicyControl\_Create service operation, the MbsPolicyDecision data structure shall contain the MBS Policy Decision containing a full description of all the MBS policies provisioned by the PCF for the MBS Policy Association. + +For the Npcf\_MBSPolicyControl\_Update service operation for, the MbsPolicyDecision data structure shall contain the updated MBS Policy Decision containing a full description of all the updated MBS policies (if any) provisioned for the MBS Policy Association. + +##### 5.2.3.2.2 Provisioning and enforcement of MBS PCC rules + +The PCF provisions/updates/removes MBS PCC rule(s) via the "mbsPccRules" attribute of the MbsPolicyDecision data structure as part of the provisioning/update/removal of an MBS Policy Decision (cf. clause 5.2.3.2.1). + +- For provisioning or modifying a dynamic PCF-provisioned MBS PCC rule, the corresponding MbsPccRule data structure shall be provided as a map entry value of the "mbsPccRules" attribute within the MbsPolicyDecision data structure representing the related MBS Policy Decision. The corresponding map key shall be set to the value of the "mbsPccRuleId" attribute of the MbsPccRule data structure. +- For removing a previously provisioned MBS PCC rule, the corresponding map entry value shall be set to "NULL" and map key to the value of the "mbsPccRuleId" attribute of the MbsPccRule data structure representing the targeted MBS PCC rule. + +##### 5.2.3.2.3 Provisioning and enforcement of authorized MBS QoS for an MBS service data flow + +The authorized MBS QoS for an MBS service data flow is provisioned along with the corresponding MBS PCC rule, as specified in the clause 5.2.3.2.2. + +The MBS authorized QoS per MBS service data flow shall be provisioned within the MbsQosDec data structure representing the MBS QoS Decision to be applied for the MBS service data flow. For this purpose: + +- the PCF shall include this MBS QoS Decision instance as a map entry within the "mbsQosDecs" attribute of the MbsPolicyDecision data structure of the corresponding MBS Policy Decision, as specified in clause 5.2.3.1.2, and include the reference to this MBS QoS Decision instance within the "refMbsQosDec" attribute of the MbsPccRule data structure representing the corresponding MBS PCC rule; + +- when the PCF provisions a standardized 5QI value, but the Priority Level, the Averaging Window and/or the Maximum Data Burst Volume shall be different from the standardized values defined in the table 5.7.4-1 of 3GPP TS 23.501 [2], the PCF shall include within the corresponding MbsQosDec data structure the required Priority Level within the "priorityLevel" attribute, the Averaging Window within the "averWindow" attribute and/or the MBS Maximum Data Burst Volume within the "mbsMaxDataBurstVol" attribute; +- if the PCF needs to provision dynamically assigned 5QI value(s) (from the non-standardized and non-preconfigured value range) and the associated set(s) of MBS QoS Characteristics, the PCF shall include within the MbsPolicyDecision data structure representing the related MBS Policy Decision the "mbsQosChars" map attribute containing one or more set(s) of MBS QoS Characteristics, with each one of them encoded using the MbsQosChar data structure as specified in clause 5.2.3.1.3. The PCF shall not update nor remove previously provisioned set(s) of MBS QoS Characteristics during the lifetime of the concerned MBS Policy Association; +- when the PCF provisions a dynamically assigned 5QI value (from the non-standardized and non-preconfigured value range) for the MBS PCC rule within the referred MBS QoS Decision instance, then the "5qi" attribute of the corresponding MbsQosDec data structure shall be set to the value of the dynamically assigned 5QI which points to the MBS QoS Characteristics instance containing the related QoS parameters; + +NOTE: Operator configuration is assumed to ensure that a dynamically assigned 5QI value is unique and references at a given time the same set of MBS QoS characteristics within the whole PLMN. + +Upon reception of an MBS PCC rule provisioning including the corresponding authorized MBS QoS information from the PCF, the NF service consumer (MB-SMF) shall perform MBS QoS flow binding as specified in clause 6.10 of 3GPP TS 23.247 [14]. The NF service consumer (MB-SMF) shall also reserve the necessary resources for the guaranteed bitrate of the MBS PCC rule, if provided. For GBR MBS QoS flows, the NF service consumer (MB-SMF) should set the MBS QoS flow's GBR to the sum of the GBR(s) of all the MBS PCC rule(s) that are active/installed and bound to that GBR MBS QoS flow, and the MBS QoS flow's MBR to the sum of the MBR(s) of all the MBS PCC rule(s) that are active/installed and bound to that GBR MBS QoS flow. + +The NF service consumer (MB-SMF) shall assign a new MBS QFI if a new MBS QoS flow needs to be established and derive the MBS QoS profile required towards the Access Network, if applicable, and the MBS QoS information with PDRs towards the MB-UPF. + +During an MBS session policy association update procedure that results in updating all the MBS PCC rule(s) bound to a certain MBS QoS flow, if all these MBS PCC rule(s) are updated with the same values of the QoS parameters (e.g. 5QI, ARP, Priority level, Averaging Window and Maximum Data Burst Volume), the NF service consumer (MB-SMF) should not perform a new MBS QoS flow binding and simply modify this MBS QoS flow with the updated QoS parameters. + +##### 5.2.3.2.4 Provisioning and enforcement of authorized MBS Session-AMBR + +The Provisioning of the authorized MBS Session-AMBR for an MBS session is part of the provisioning of the corresponding MBS Policy Decision, as specified in the clause 5.2.3.2.1. + +Upon reception of the authorized MBS Session-AMBR from the PCF, the NF service consumer (MB-SMF) shall trigger the necessary procedures towards the MB-UPF for the provisioning and enforcement of the MBS Session-AMBR for the concerned MBS session. + +NOTE: For an MBS session, the authorized MBS Session-AMBR is not propagated to neither the access network nor the UE. + +##### 5.2.3.2.5 Provisioning and enforcement of MBS Policy Control Request Triggers + +The PCF may provision one or more MBS Policy Control Request Triggers(s) to the NF service consumer (MB-SMF). In order to do so, the PCF shall include the "mbsPerts" attribute containing one or more MBS Policy Control Request Triggers(s) within the MbsPolicyDecision data structure. + +During the lifetime of the MBS Policy Association, the PCF may update and/or remove previously provisioned MBS Policy Control Request Triggers(s): + +- In order to update a previously subscribed set of MBS Policy Control Request Triggers(s), the PCF shall provide the complete list of the subscribed MBS Policy Control Request Triggers(s) within the "mbsPerts" attribute of the MbsPolicyDecision data structure. + +- In order to remove all the previously subscribed MBS Policy Control Request Triggers(s), the PCF shall provide the "mbsPerts" attribute set to the value "NULL" within the MbsPolicyDecision data structure. Upon reception of a "NULL" value within the "mbsPerts" attribute, the NF service consumer (MB-SMF) shall only trigger the MBS Policy Association Update procedure for the pre-configured MBS Policy Control Request Triggers(s), i.e. the ones implicitly subscribed by the PCF. + +MBS Policy Control Request Triggers(s) may also be pre-configured at the NF service consumer as specified in clause 5.2.3.1.5. In such case, the PCF is implicitly subscribed and does not need to explicitly subscribe to these MBS Policy Control Request Triggers(s) towards the NF service consumer (MB-SMF). A combination of pre-configured MBS Policy Control Request Triggers(s) and explicitly subscribed MBS Policy Control Request Triggers(s) may be present for an MBS Policy Association. + +### 5.2.4 MBS Policy Error Handling + +#### 5.2.4.1 MBS Policy Error Reporting + +Following an MBS Policy Association Creation or Update procedure, as defined in clause 5.2.2.2.2 or 5.2.2.3.2, the NF service consumer (MB-SMF) may report the potentially encountered failure(s) during the installation and/or enforcement of the provisioned MBS Policy Decision, both for MBS Policy Decision level failure(s) (e.g. MBS QoS Decision failure) and MBS PCC rule level failure(s) (e.g. the installation of one or more MBS PCC rule(s) fails or the PCF installed or modified one or more MBS PCC rules but resource allocation for these MBS PCC rule(s) was unsuccessful). + +In order to do so, the NF service consumer (MB-SMF) shall trigger the MBS Policy Association Update procedure defined in clause 5.2.2.3.2 and include within the "mbsErrorReport" attribute of the MbsPolicyCtxtDataUpdate data structure the necessary information on the failure(s) that occurred within one or more MBS Report instance(s), each one of them encoded using the MbsReport data structure that shall include: + +- the failure reason, if available, within the "failureCode" attribute; +- the affected MBS PCC rule(s), if the reported failure is at MBS PCC rule level, within the "mbsPccRuleIds" attribute; and +- the MBS PCC rule status, if the reported failure is at MBS PCC rule level, within the "mbsPccRuleStatus" attribute. + +Depending on the value of the "failureCode" attribute, the PCF may decide on the necessary updates to be applied to the MBS Policy Decision, if any, including whether to retain, re-install, modify or remove the existing MBS PCC rule(s), or any other action applies. + +For MBS PCC rule level failure(s), the following handling shall apply: + +- if the installation of one or more new MBS PCC rule(s) (i.e. MBS PCC rule(s) which were not successfully installed previously) fails, the NF service consumer (MB-SMF) shall set the "mbsPccRuleStatus" attribute to the value "INACTIVE"; +- if one or more MBS PCC rule(s) were successfully installed but can no longer be enforced by the NF service consumer (MB-SMF), the MB-SMF shall set the "mbsPccRuleStatus" attribute to "INACTIVE"; + +NOTE: When the PCF receives the "mbsPccRuleStatus" set to the value "INACTIVE", the PCF does not need to request the MB-SMF to remove the concerned MBS PCC rule(s) within the "mbsPccRuleIds" attribute. + +- if the requested modifications to currently active MBS PCC rule(s) fails, the NF service consumer (MB-SMF) shall: + - retain the targeted existing MBS PCC rule(s) active in their current version (i.e. without any modification), unless the failure reason also impacts the current version of these existing MBS PCC rule(s); and + - report the modification failure to the PCF; + +and + +- the removal of MBS PCC rule(s) shall not fail. The NF service consumer (MB-SMF) shall retain the MBS PCC rule(s) removal request and perform the related necessary actions/procedures in the network when it is possible. + +## 5.3 Npcf\_MBSPolicyAuthorization Service + +### 5.3.1 Service Description + +The MBS Policy Authorization Service enables the Policy Control Function (PCF) to authorize the MBS Service Information provided by an NF service consumer (e.g. AF, NEF, MBSF) and derive the related MBS policies, i.e.: + +- enable an NF service consumer (e.g. AF, NEF, MBSF) to request the creation, update or removal of an MBS Application Session Context, based on the provisioning of MBS Service Information; and +- enable the PCF to authorize the provided MBS Service Information and derive the MBS policies related to the targeted MBS session. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operations defined for the Npcf\_MBSPolicyAuthorization Service are shown in table 5.3.2.1-1. + +**Table 5.3.2.1-1: Npcf\_MBSPolicyAuthorization Service Operations** + +| Service Operation Name | Description | Initiated by | +|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Npcf_MBSPolicyAuthorization_Create | Request the creation of an MBS Application Session Context at the PCF, to enable MBS policy authorization for the provided MBS Service Information. | NF service consumer (e.g. NEF, MBSF, AF) | +| Npcf_MBSPolicyAuthorization_Update | Update an existing MBS Application Session Context at the PCF, to enable MBS policy authorization for the provided updated MBS Service Information. | NF service consumer (e.g. NEF, MBSF, AF) | +| Npcf_MBSPolicyAuthorization_Delete | Delete an existing MBS Application Session Context at the PCF. | NF service consumer (e.g. NEF, MBSF, AF) | + +#### 5.3.2.2 Npcf\_MBSPolicyAuthorization\_Create + +##### 5.3.2.2.1 General + +The Npcf\_MBSPolicyAuthorization\_Create service operation enables an NF service consumer (e.g. AF, NEF, MBSF) to request the creation of an MBS Application Session Context at the PCF, for the purpose of requesting MBS policy authorization for a multicast or a broadcast MBS session. + +The following procedures using the Npcf\_MBSPolicyAuthorization\_Create service operation are supported: + +- MBS Application Session Context Establishment. + +##### 5.3.2.2.2 MBS Application Session Context Establishment + +![Sequence diagram showing the MBS Application Session Context establishment procedure between an NF service consumer and a PCF.](3f36a9a4e71c8afdba94d0eb5b2ebab8_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant PCF as PCF + Note left of NF: + NF->>PCF: 1. POST .../contexts (MbsAppSessionCtxt) + Note right of PCF: + PCF-->>NF: 2. 201 Created (MbsAppSessionCtxt) + +``` + +The diagram illustrates a two-step interaction between an NF service consumer and a PCF. In the first step, the NF service consumer sends a POST request to the PCF with the path .../contexts and the payload (MbsAppSessionCtxt). In the second step, the PCF responds with a 201 Created status and the payload (MbsAppSessionCtxt). + +Sequence diagram showing the MBS Application Session Context establishment procedure between an NF service consumer and a PCF. + +**Figure 5.3.2.2.2-1: MBS Application Session Context establishment procedure** + +1. In order to request the creation of a new MBS Application Session Context, the NF service consumer (e.g. AF, NEF, MBSF) shall send an HTTP POST request to the PCF, targeting the URI of the "MBS Application Session Contexts" collection resource, with the request body containing the MbsAppSessionCtxt data structure that shall contain: + - the MBS session identifier, within the "mbsSessionId" attribute; + - the MBS Service Information, if available, within the "mbsServInfo" attribute; and + - the list of supported features, if feature negotiation needs to take place, within the "suppFeat" attribute;and may contain: + - the DNN of the MBS session, within the "dnn" attribute; + - the S-NSSAI of the MBS session, within the "snssai" attribute; and + - the "request for location-dependent MBS session" indication within the "reqForLocDepMbs" attribute, if the "AreaSessPolicy" feature is supported and the request corresponds to an MBS Session that is an instance of a location-dependent MBS service. + +2. Upon reception of the HTTP POST request from the NF service consumer: + +- the PCF may interact with the UDR to retrieve MBS Session policy control data for the MBS session, as specified in clause 5.2.16 of 3GPP TS 29.519 [20]; + +NOTE 1: Interacting with the UDR for MBS Session policy control data retrieval is not necessary in a deployment where MBS Policy Session policy control data is stored locally at the PCF. + +- the PCF shall perform MBS policy authorization based on the MBS Service Information received from the NF service consumer and the operator policies that are pre-configured at the PCF and/or the MBS Session policy control data retrieved from the UDR. Then: + - if MBS policy authorization is successful, the PCF shall derive the required MBS policies (e.g. QoS parameters) and determine whether they are allowed or not; + - if the required MBS policies are allowed: + - if the "AreaSessPolicy" feature is supported and the "request for location dependent MBS session" indication was present within the "reqForLocDepMbs" attribute and set to "true", the PCF shall assign an Area Session Policy ID within the "areaSessPolId" attribute for this MBS Session as an instance of a location-dependent MBS service; + - the PCF shall store the generated MBS policies for the MBS session together with the corresponding MBS session ID, and if applicable and the "AreaSessPolicy" feature is supported, the corresponding Area Session Policy ID for an MBS Session that is an instance of a location-dependent MBS service; + - the PCF shall create a new "Individual MBS Application Session Context" resource and respond to the NF service consumer with an HTTP "201 Created" status code, including an HTTP Location header field containing the URI of the created "Individual MBS Application Session Context" resource and the response body containing a representation of the created resource within the MbsAppSessionCtxt data structure; and + - the PCF may register itself at the BSF as the PCF handling the MBS session as specified in clause 4.2.2.4 of 3GPP TS 29.521 [21]; + +NOTE 2: Registering at the BSF as the PCF serving the MBS Session is not necessary in a deployment with a single PCF. + +- otherwise, when MBS policy authorization is not successful or the required MBS policies are not allowed, the PCF shall reject the request with an appropriate error response as specified below in this clause; +- if errors occur when processing the HTTP POST request, the PCF shall apply the error handling procedures specified in clause 6.2.7; + +- if the provided MBS Service Information is invalid, incorrect or insufficient for the PCF to perform MBS policy authorization, the PCF shall reject the request with an HTTP "400 Bad Request" status code including the ProblemDetails data structure with the "cause" attribute set to "INVALID\_MBS\_SERVICE\_INFO"; +- if the MBS IP flow(s) description provided within the MBS Service Information cannot be handled by the PCF because the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] are not respected, the PCF shall reject the request with an HTTP "400 Bad Request" status code including the ProblemDetails data structure with the "cause" attribute set to "FILTER\_RESTRICTIONS\_NOT\_RESPECTED"; and +- if the provided MBS Service Information are not authorized, the PCF shall reject the request with an HTTP "403 Forbidden" status code including the MbsExtProblemDetails data structure that shall contain: + - the ProblemDetails data structure with the "cause" attribute set to "MBS\_SERVICE\_INFO\_NOT\_AUTHORIZED"; + and may contain: + - the AcceptableMbsServInfo data structure including the MBS Service Information that is acceptable for the PCF. + +#### 5.3.2.3 Npcf\_MBSPolicyAuthorization\_Update + +##### 5.3.2.3.1 General + +The Npcf\_MBSPolicyAuthorization\_Update service operation enables an NF service consumer (e.g. AF, NEF, MBSF) to request the update of an existing MBS Application Session Context, for the purpose of requesting the authorization of updated MBS Service Information. + +The following procedures using the Npcf\_MBSPolicyAuthorization\_Update service operation are supported: + +- MBS Application Session Context Update. + +##### 5.3.2.3.2 MBS Application Session Context Update + +![Sequence diagram showing the MBS Application Session Context update procedure. An NF service consumer sends a PATCH request to the PCF, and the PCF responds with a 200 OK or 204 No Content.](d3b5eac55166fc428a223bba5c46961b_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note left of NF service consumer: Request update of MBS Application Session Context + NF service consumer->>PCF: 1. PATCH .../contexts/{contextId} (MbsAppSessionCtxtPatch) + Note right of PCF: Process request + PCF-->>NF service consumer: 2. 200 OK (MbsAppSessionCtxt) / 204 No Content + +``` + +Sequence diagram showing the MBS Application Session Context update procedure. An NF service consumer sends a PATCH request to the PCF, and the PCF responds with a 200 OK or 204 No Content. + +**Figure 5.3.2.3.2-1: MBS Application Session Context update procedure** + +1. In order to request the modification of an existing MBS Application Session Context, the NF service consumer (e.g. AF, NEF, MBSF) shall send an HTTP PATCH request to the PCF, targeting the URI of the corresponding "Individual MBS Application Session Context" resource, with the request body containing the MbsAppSessionCtxtPatch data structure that may contain: + - the requested modifications to the MBS Service Information, within the "mbsServInfo" attribute. +2. Upon reception of the HTTP PATCH request from the NF service consumer: + - the PCF may interact with the UDR to retrieve MBS Session policy control data for the MBS session, as specified in 3GPP TS 29.519 [20]; + - the PCF shall perform MBS policy authorization based on the requested modifications to the MBS Service Information received from the NF service consumer and the operator policies that are pre-configured at the PCF and/or the MBS session policy control data retrieved from the UDR. Then: + +- if MBS policy authorization of the requested modifications to the MBS Service Information is successful, the PCF shall derive the required updated MBS policies (e.g. QoS parameters), if any, and determine whether they are allowed or not; +- if the required updated MBS policies are allowed: + - the PCF shall store the generated updated MBS policies for the MBS session, if any, together with the corresponding MBS session ID; + - the PCF shall update the associated "Individual MBS Application Session Context" resource accordingly and respond to the NF service consumer with either an HTTP "200 OK" status code with the response body containing a representation of the updated resource within the MbsAppSessionCtxt data structure, or an HTTP "204 No Content" status code; and + - if the authorized MBS policies have been changed, the PCF shall include the "contactPcfInd" attribute set to "true" within the returned MbsAppSessionCtxt data structure to indicate that the PCF shall be contacted, i.e. to indicate to the NF service consumer (MB-SMF) that it needs to trigger the MBS Policy Association Update procedure, as defined in clause 5.2.2.3, to receive updated MBS policies from the PCF; +- otherwise, when MBS policy authorization is not successful or the required updated MBS policies are not allowed, the PCF shall reject the request with an appropriate error response as specified below in this clause; +- if errors occur when processing the HTTP PATCH request, the PCF shall apply the error handling procedures specified in clause 6.2.7; +- if the targeted "Individual MBS Application Session Context" resource does not exist, the PCF shall reject the request with an HTTP "404 Not Found" status code including the ProblemDetails data structure with the "cause" attribute set to "MBS\_SESSION\_POL\_AUTH\_CTXT\_NOT\_FOUND"; +- if the provided MBS Service Information is invalid, incorrect or insufficient for the PCF to perform MBS policy authorization, the PCF shall reject the request with an HTTP "400 Bad Request" status code including the ProblemDetails data structure with the "cause" attribute set to "INVALID\_MBS\_SERVICE\_INFO"; +- if the MBS IP flow(s) description provided within the MBS Service Information cannot be handled by the PCF because the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] are not respected, the PCF shall reject the request with an HTTP "400 Bad Request" status code including the ProblemDetails data structure with the "cause" attribute set to "FILTER\_RESTRICTIONS\_NOT\_RESPECTED"; and +- if the provided MBS Service Information is not authorized, the PCF shall reject the request with an HTTP "403 Forbidden" status code including the MbsExtProblemDetails data structure that shall contain: + - the ProblemDetails data structure with the "cause" attribute set to "MBS\_SERVICE\_INFO\_NOT\_AUTHORIZED";and may contain: + - the AcceptableMbsServInfo data structure including the MBS Service Information that is acceptable for the PCF. + +#### 5.3.2.4 Npcf\_MBSPolicyAuthorization\_Delete + +##### 5.3.2.4.1 General + +The Npcf\_MBSPolicyAuthorization\_Delete service operation enables an NF service consumer (e.g. AF, NEF, MBSF) to request the deletion of an existing MBS Application Session Context at the PCF. + +The following procedures using the Npcf\_MBSPolicyAuthorization\_Delete service operation are supported: + +- MBS Application Session Context Deletion. + +##### 5.3.2.4.2 MBS Application Session Context Deletion + +![Sequence diagram showing the MBS Application Session Context deletion procedure between an NF service consumer and a PCF.](58f4167687de8d7339594e5f6fbe0bc6_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note left of NF service consumer: + NF service consumer->>PCF: 1. DELETE .../contexts/{contextId} + Note right of PCF: + PCF-->>NF service consumer: 2. 204 No Content +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and a PCF. The NF service consumer sends a DELETE request to the PCF, and the PCF responds with a 204 No Content status code. + +Sequence diagram showing the MBS Application Session Context deletion procedure between an NF service consumer and a PCF. + +**Figure 5.3.2.4.2-1: MBS Application Session Context deletion procedure** + +1. In order to request the deletion of an existing MBS Application Session Context, the NF service consumer (e.g. AF, NEF, MBSF) shall send an HTTP DELETE request to the PCF targeting the URI of the corresponding "Individual MBS Application Session Context" resource. +2. Upon success, the PCF shall respond with an HTTP "204 No Content" status code. + +If errors occur when processing the HTTP DELETE request, the PCF shall apply the error handling procedures specified in clause 6.2.7. + +If the targeted Individual MBS Application Session Context does not exist, the PCF shall reject the request with an HTTP "404 Not Found" status code including the ProblemDetails data structure with the "cause" attribute set to "MBS\_SESSION\_POL\_AUTH\_CTXT\_NOT\_FOUND". + +# 6 API Definitions + +## 6.1 Npcf\_MBSPolicyControl Service API + +### 6.1.1 Introduction + +The Npcf\_MBSPolicyControl Service shall use the Npcf\_MBSPolicyControl API. + +The API URI of the Npcf\_MBSPolicyControl Service shall be: + +**{apiRoot}/** + +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}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "npcf-mbspolicycontrol". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [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 Npcf\_MBSPolicyControl API is contained in Annex A.2. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.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". + +The "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 9754 [13]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the resource URIs and the resources and methods used for the Npcf\_MBSPolicyControl service. + +Figure 6.1.3.1-1 depicts the resource URIs structure for the Npcf\_MBSPolicyControl API. + +![A hierarchical diagram showing the resource URI structure. The root is {apiRoot}/npcf-mbspolicycontrol/. A line descends from the root to a box containing /mbs-policies. From this box, a line descends to another box containing /{mbsPolicyId}. From this second box, a line descends to a dashed box containing /update.](805c475f0859e607af0530ba43194bf1_img.jpg) + +{apiRoot}/npcf-mbspolicycontrol/ + +``` + +graph TD + Root["{apiRoot}/npcf-mbspolicycontrol/"] --> Policies["/mbs-policies"] + Policies --> PolicyId["/{mbsPolicyId}"] + PolicyId --> Update["/update"] + style Update stroke-dasharray: 5 5 + +``` + +A hierarchical diagram showing the resource URI structure. The root is {apiRoot}/npcf-mbspolicycontrol/. A line descends from the root to a box containing /mbs-policies. From this box, a line descends to another box containing /{mbsPolicyId}. From this second box, a line descends to a dashed box containing /update. + +**Figure 6.1.3.1-1: Resource URI structure of the Npcf\_MBSPolicyControl API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) | +|-----------------------|--------------------------------------------|---------------------------------|----------------------------------------------------------------------| +| MBS Policies | /mbs-policies | POST | Request the creation of a new Individual MBS Policy resource. | +| Individual MBS Policy | /mbs-policies/{mbsPolicyId} | GET | Request the retrieval of an existing Individual MBS Policy resource. | +| | | DELETE | Request the deletion of an existing Individual MBS Policy resource. | +| | | Update (POST) | Request the update of an existing Individual MBS Policy resource. | + +#### 6.1.3.2 Resource: MBS Policies + +##### 6.1.3.2.1 Description + +This resource represents the collection of "Individual MBS Policy" resources managed by the PCF. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/npcf-mbspolicycontrol//mbs-policies + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-------------------| +| apiRoot | string | See clause 6.1.1. | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method enables an NF service consumer (e.g. MB-SMF) to request the creation of an MBS Policy Association at the PCF. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.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 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-------------------------------------------------------------------------------| +| MbsPolicyCtxtData | M | 1 | Contains the parameters to request the creation of an MBS Policy Association. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|-----------------------------------------------------------------------------| +| MbsPolicyData | M | 1 | 201 Created | Successful case. An Individual MBS Policy resource is successfully created. | +| n/a | | | 308 Permanent Redirect | Permanent Redirection. Another PCF already serves the MBS Session. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| MbsExtProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: 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. +NOTE 2: Failure cases are described in clause 6.1.7. + +**Table 6.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}/npcf-mbspolicycontrol//mbs-policies/{mbsPolicyId} | + +**Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI (i.e. "apiRoot") of the PCF currently handling the MBS Session and towards which the request is redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Contains the identifier of the PCF (service) instance towards which the request is redirected. | + +##### 6.1.3.2.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +#### 6.1.3.3 Resource: Individual MBS Policy + +##### 6.1.3.3.1 Description + +This resource represents an "Individual MBS Policy" resource managed by the PCF. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/npcf-mbspolicycontrol//mbs-policies/{mbsPolicyId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|---------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1. | +| mbsPolicyId | string | Represents the unique identifier of the "Individual MBS Policy" resource. | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 GET + +This method enables an NF service consumer (e.g. MB-SMF) to retrieve an existing "Individual MBS Policy" resource at the PCF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.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 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------| +| MbsPolicyData | M | 1 | 200 OK | Successful case. The requested Individual MBS Policy resource is successfully returned in the response body. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +###### 6.1.3.3.3.2 DELETE + +This method enables an NF service consumer (e.g. MB-SMF) to request the deletion of an existing "Individual MBS Policy" resource at the PCF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +Table 6.1.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.1.3.3.3.2-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 response. The Individual MBS Policy resource was successfully deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.1.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +Table 6.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +Table 6.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +##### 6.1.3.3.4 Resource Custom Operations + +###### 6.1.3.3.4.1 Overview + +Table 6.1.3.3.4.1-1: Custom operations + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|------------------------------------|--------------------|-----------------------------------------------------------| +| Update | /mbs-policies/{mbsPolicyId}/update | Update (POST) | Request the update of an existing MBS Policy Association. | + +###### 6.1.3.3.4.2 Operation: Update + +###### 6.1.3.3.4.2.1 Description + +This resource custom operation enables an NF service consumer (e.g. MB-SMF) to request the update of an existing MBS Policy Association at the PCF. + +###### 6.1.3.3.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.3.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.3.4.2.2-2. + +**Table 6.1.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|--------------------------------------------------------------------------------------| +| MbsPolicyCtxtDataUpdate | M | 1 | Contains the parameters to request the update of the Individual MBS Policy resource. | + +**Table 6.1.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------| +| MbsPolicyData | M | 1 | 200 OK | Successful case. The targeted Individual MBS Policy resource is successfully updated. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| MbsExtProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: 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. +NOTE 2: Failure cases are described in clause 6.1.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 6.1.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +### 6.1.4 Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +### 6.1.5 Notifications + +There are no notifications defined for this API in this release of the specification. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Npcf\_MBSPolicyControl service based interface protocol. + +**Table 6.1.6.1-1: Npcf\_MBSPolicyControl specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------|----------------|--------------------------------------------------------------------------------------------------------------------------|---------------| +| MbsErrorReport | 6.1.6.2.10 | Contains the reporting of MBS Policy decision level failure(s) and/or MBS PCC rule level failure(s). | | +| MbsFailureCode | 6.1.6.3.4 | Represents the reason behind the MBS Policy Decision(s) enforcement failure or the MBS PCC rule(s) installation failure. | | +| MbsMaxDataBurstVol | 6.1.6.3.2 | Represents the maximum MBS data burst volume. | | +| MbsPccRule | 6.1.6.2.7 | Represents the parameters constituting an MBS PCC rule. | | +| MbsPprt | 6.1.6.3.3 | Represents an MBS Policy Control Request Trigger. | | +| MbsPolicyCtxtData | 6.1.6.2.2 | Contains the parameters used to request the creation of an Individual MBS Policy resource. | | +| MbsPolicyCtxtDataUpdate | 6.1.6.2.11 | Contains the parameters to update an existing MBS Policy Association. | | +| MbsPolicyData | 6.1.6.2.4 | Contains the MBS policy data of an Individual MBS Policy resource. | | +| MbsPolicyDecision | 6.1.6.2.3 | Contains the parameters constituting an MBS Policy Decision. | | +| MbsPccRuleStatus | 6.1.6.3.5 | Represents the status of an MBS PCC rule. | | +| MbsQosChar | 6.1.6.2.9 | Represents the parameters constituting a set of explicitly signalled QoS Characteristics. | | +| MbsQosDec | 6.1.6.2.8 | Represents the parameters constituting an MBS QoS Decision. | | +| MbsReport | 6.1.6.2.12 | Includes the information about the MBS Policy Decision level failure(s) and/or the MBS PCC rule level failure(s). | | + +Table 6.1.6.1-2 specifies data types re-used by the Npcf\_MBSPolicyControl 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 Npcf\_MBSPolicyControl service based interface. + +Table 6.1.6.1-2: Npcf\_MBSPolicyControl re-used Data Types + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|----------------------------------------------------------------------------------------------------------------|----------------| +| 5Qi | 3GPP TS 29.571 [15] | Indicates the 5G QoS Identifier. | | +| 5QiPriorityLevel | 3GPP TS 29.571 [15] | Indicates the 5Qi Priority Level. | | +| AreaSessionPolicyId | 3GPP TS 29.571 [15] | Indicates the Area Session Policy Identifier. | AreaSessPolicy | +| Arp | 3GPP TS 29.571 [15] | Indicates the allocation and retention priority. | | +| AverWindow | 3GPP TS 29.571 [15] | Indicates the Averaging Window. | | +| BitRate | 3GPP TS 29.571 [15] | Indicates the Bit Rate. | | +| Dnn | 3GPP TS 29.571 [15] | Identifies a DNN. | | +| FlowDescription | 3GPP TS 29.512 [18] | Represents packet filtering information for an IP flow. | | +| MbsExtProblemDetails | Clause 6.2.6.4.1 | Identifies the MBS related extensions to the ProblemDetails data structure. | | +| MbsServiceInfo | 3GPP TS 29.571 [15] | Represents MBS Service Information. | | +| MbsSessionId | 3GPP TS 29.571 [15] | Represents an MBS Session Identifier. | | +| PacketDelBudget | 3GPP TS 29.571 [15] | Indicates the Packet Delay Budget. | | +| PacketErrRate | 3GPP TS 29.571 [15] | Indicates the Packet Error Rate. | | +| ProblemDetails | 3GPP TS 29.571 [15] | Contains error related additional information. | | +| QosResourceType | 3GPP TS 29.571 [15] | Indicates the QoS resource type. | | +| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information. | | +| Snssai | 3GPP TS 29.571 [15] | Identifies an S-NSSAI. | | +| SupportedFeatures | 3GPP TS 29.571 [15] | Represents the list of supported features. It is used to negotiate the applicability of the optional features. | | +| Uinteger | 3GPP TS 29.571 [15] | Represents an unsigned integer. | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: MbsPolicyCtxtData + +Table 6.1.6.2.2-1: Definition of type MbsPolicyCtxtData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| mbsSessionId | MbsSessionId | M | 1 | Represents the identifier of the MBS Session. | | +| dnn | Dnn | O | 0..1 | Represents the DNN of the MBS session. | | +| snssai | Snssai | O | 0..1 | Represents the S-NSSAI of the MBS session. | | +| areaSessPolId | AreaSessionPolicyId | C | 0..1 | Represents the Area Session Policy ID.
This attribute shall be present if available. | AreaSessPolicy | +| mbsServInfo | MbsServiceInfo | O | 0..1 | Represents the MBS Service Information.
This attribute shall be provided, if available. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of the supported features among the ones defined in clause 6.1.8.
This attribute shall be present when feature negotiation needs to take place. | | + +##### 6.1.6.2.3 Type: MbsPolicyDecision + +Table 6.1.6.2.3-1: Definition of type MbsPolicyDecision + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsPccRules | map(MbsPccRule) | O | 1..N | A map of MBS PCC rule(s) with the content being the MbsPccRule as described in clause 6.1.6.2.7. The key used in this map for each entry is the "mbsPccRuleId" attribute of the corresponding MbsPccRule instance. | | +| mbsQosDecs | map(MbsQosDec) | O | 1..N | Map of MBS QoS Decision(s). The key used in this map for each entry is the "mbsQosId" attribute of the corresponding MbsQosDec instance.
(NOTE) | | +| mbsQosChars | map(MbsQosChar) | O | 1..N | Map of QoS characteristics for non-standard 5QIs and non-preconfigured 5QIs. The key of the map is the 5QI value within the "5qi" attribute of the corresponding MbsQosChar instance.
(NOTE) | | +| authMbsSessAmbr | BitRate | O | 0..1 | The Authorized MBS Session-AMBR. | | +| mbsPorts | array(MbsPort) | O | 1..N | The MBS Policy Control Request Triggers(s) that the PCF requests to subscribe to. | | + +NOTE: This attribute shall not be removed if it was provisioned. + +##### 6.1.6.2.4 Type: MbsPolicyData + +Table 6.1.6.2.4-1: Definition of type MbsPolicyData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsPolicyCtxtData | MbsPolicyCtxtData | M | 1 | Contains the parameters used to request MBS Policy Association creation/update. | | +| mbsPolicies | MbsPolicyDecision | C | 0..1 | Contains the provisioned MBS Policy Decision containing the MBS policies authorized by the PCF.

This attribute shall be present in the response to a request to create an MBS Policy Association or a request to retrieve the properties of an existing MBS Policy Association, and may be present in the response to a request to update an existing MBS Policy Association. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of negotiated supported features.

This parameter shall be provided by the PCF in the response to a request in which the NF service consumer provided the list of features that it supports. | | + +6.1.6.2.5 Void + +6.1.6.2.6 Void + +6.1.6.2.7 Type: MbsPccRule + +Table 6.1.6.2.7-1: Definition of type MbsPccRule + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsPccRuleId | string | M | 1 | Univocally identifies the MBS PCC rule within the related MBS session. | | +| mbsDlIpFlowInfo | array(FlowDescription) | C | 1..N | Contains the MBS downlink IP flow packet filter(s) information.
(NOTE 3) | | +| precedence | UInteger | O | 0..1 | Determines the order in which this MBS PCC rule is applied relative to other MBS PCC rules within the same MBS session.
(NOTE 1) | | +| refMbsQosDec | array(string) | C | 1..N | A reference to the MbsQosDec policy decision type. It contains the value of the "mbsQosId" attribute of the referred MbsQosDec policy decision defined in clause 6.1.6.2.8.
(NOTE 2, NOTE 3) | | + +NOTE 1: The "precedence" attribute is used to specify the precedence of the MBS PCC rule among all MBS PCC rules associated to an MBS session. It includes an integer value in the range of 0 to 255 (decimal). The higher the value of the "precedence" attribute, the lower the precedence of the MBS PCC rule to which it applies. + +NOTE 2: Arrays are only introduced for future compatibility. In this release of the specification, the maximum number of elements in the array is 1. + +NOTE 3: This attribute shall be present in the response to an MBS Policy Association Creation request and may be present in the response to an MBS Policy Association Update request. + +##### 6.1.6.2.8 Type: MbsQosDec + +Table 6.1.6.2.8-1: Definition of type MbsQosDec + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------|---------------| +| mbsQosId | string | M | 1 | Univocally identifies the MBS QoS Decision within the related MBS session. | | +| 5qi | 5Qi | O | 0..1 | Contains the identifier of the authorized QoS parameters for the MBS service data flow.
(NOTE 2) | | +| priorityLevel | 5QiPriorityLevel | O | 0..1 | Indicates a priority in scheduling resources among MBS QoS flows.
(NOTE 1) | | +| mbrDI | BitRate | O | 0..1 | Indicates the maximum bandwidth in downlink. | | +| gbrDI | BitRate | O | 0..1 | Indicates the guaranteed bandwidth in downlink. | | +| arp | Arp | O | 0..1 | Indicates the allocation and retention priority. | | +| averWindow | AverWindow | O | 0..1 | Represents the duration over which the guaranteed and maximum bitrates shall be calculated.
(NOTE 1) | | +| mbsMaxDataBurstVol | MbsMaxDataBurstVol | O | 0..1 | Denotes the largest amount of data that is required to be transferred within a period.
(NOTE 1) | | + +NOTE 1: This attribute is applicable only when a value different from the standardized 5QI values, defined in table 5.7.4-1 3GPP TS 23.501 [2], is provided. + +NOTE 2: When the provided 5QI value is a dynamically assigned 5QI (i.e. from the non-standardized and non-preconfigured value range), the corresponding QoS parameters (e.g. Packet Delay Budget, Packet Error Rate, etc.) are provided in the corresponding MbsQosChar data structure. + +##### 6.1.6.2.9 Type: MbsQosChar + +Table 6.1.6.2.9-1: Definition of type MbsQosChar + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| 5qi | 5Qi | M | 1 | Represents the identifier of the set of non-standardized and non-preconfigured MBS QoS parameters for an MBS service data flow. | | +| resourceType | QosResourceType | M | 1 | Indicates whether the MBS QoS resource type is GBR, delay critical GBR or non-GBR. | | +| priorityLevel | 5QiPriorityLevel | M | 1 | Indicates the 5QI Priority Level within a range of 1 to 127 and encoded as an unsigned integer. | | +| packetDelayBudget | PacketDelBudget | M | 1 | Indicates the packet delay budget expressed in milliseconds and encoded as an unsigned integer. | | +| packetErrorRate | PacketErrRate | M | 1 | Indicates the packet error rate encoded as a string.
Examples:
- A Packer Error Rate of $4 \times 10^{-6}$ shall be encoded as "4E-6".
- A Packer Error Rate of $10^{-2}$ shall be encoded as "1E-2". | | +| averWindow | AverWindow | C | 0..1 | Indicates the averaging window.

This attribute shall be present only for a GBR QoS flow or a Delay Critical GBR QoS flow. | | +| mbsMaxDataBurstVol | MbsMaxDataBurstVol | M | 1 | Indicates the maximum data burst volume, encoded as an unsigned integer. | | + +##### 6.1.6.2.10 Type: MbsErrorReport + +Table 6.1.6.2.11-1: Definition of type MbsErrorReport + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|------------------------------------------------------------------------------------------------------|---------------| +| mbsReports | array(MbsReport) | O | 1..N | Contains the reporting of MBS Policy decision level failure(s) and/or MBS PCC rule level failure(s). | | + +##### 6.1.6.2.11 Type: MbsPolicyCtxtDataUpdate + +Table 6.1.6.2.11-1: Definition of type MbsPolicyCtxtDataUpdate + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------|---------------| +| mbsServInfo | MbsServiceInfo | O | 0..1 | Represents the updated MBS Service Information. | | +| mbsPorts | array(MbsPort) | O | 1..N | Represents the list of MBS Policy Control Request Triggers that are met. | | +| mbsErrorReport | MbsErrorReport | O | 0..1 | Contains the reporting of MBS Policy decision level failure(s) and/or MBS PCC rule level failure(s). | | + +##### 6.1.6.2.12 Type: MbsReport + +Table 6.1.6.2.12-1: Definition of type MbsReport + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsPccRuleIds | array(string) | C | 1..N | Contains the identifier(s) of the affected MBS PCC rule(s).

This attribute shall be present if the reported failure is related to the MBS PCC rule(s) installation.

(NOTE) | | +| mbsPccRuleStatus | MbsPccRuleStatus | C | 0..1 | Indicates the status of the MBS PCC rule(s) identified by the "mbsPccRuleIds" attribute.

This attribute shall be present only if the "mbsPccRuleIds" attribute is present. | | +| failureCode | MbsFailureCode | C | 0..1 | Indicates the reason of the failure of the MBS Policy Decision or the MBS PCC rule(s) identified by the "mbsPccRuleIds" attribute.

This attribute shall be present when available.

(NOTE) | | + +NOTE: If the reported failure is due to MBS Policy Decision failure, then the "mbsPccRuleIds" attribute shall not be present and the "failureCode" attribute indicates the appropriate failure cause illustrating the MBS Policy Decision failure that occurred. + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.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. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +Table 6.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|--------------------|-----------------|-------------------------------------------------------------------------------------------------|---------------| +| MbsMaxDataBurstVol | Integer | Represents MBS Maximum Data Burst Volume expressed in Bytes.
Minimum = 1. Maximum = 2000000. | | + +##### 6.1.6.3.3 Enumeration: MbsPrt + +The enumeration MbsPrt represents the MBS Policy Control Request Triggers. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration MbsPprt** + +| Enumeration value | Description | Applicability | +|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| MBS_SESSION_UPDATE | Indicates the MBS Session Update policy control request trigger.

This MBS Policy Control Request Trigger is implicitly subscribed by the PCF, i.e. pre-configured at the NF service consumer (MB-SMF). | | + +##### 6.1.6.3.4 Enumeration: MbsFailureCode + +The enumeration MbsFailureCode represents the reason behind the MBS Policy Decision failure. It shall comply with the provisions of table 6.1.6.3.4-1. + +**Table 6.1.6.3.4-1: Enumeration MbsFailureCode** + +| Enumeration value | Description | Applicability | +|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| NF_MALFUNCTION | Indicates that the MBS PCC rule could not be successfully installed due to MB-SMF/MB-UPF malfunction. | | +| NF_RESOURCES_UNAVAILABLE | Indicates that the MBS PCC rule could not be successfully installed due to resources unavailable at the MB-SMF/MB-UPF. | | +| RESOURCE_ALLOCATION_FAILURE | Indicates that the MBS PCC rule could not be successfully installed or maintained since the associated MBS QoS flow establishment/modification failed or the associated MBS QoS flow was released. | | +| MBS_QOS_VALIDATION_FAILURE | Indicate that MBS QoS validation has failed. | | +| NO_MBS_QOS_FLOW | Indicates that there is no MBS QoS flow to which the MB-SMF can bind the MBS PCC rule(s). | | +| MBS_QOS_DECISION_ERROR | Indicates failure in the provisioning of MBS QoS Decision data. | | +| MBS_POLICY_PARAM_ERROR | Indicates that the information related to the provisioned MBS policy parameter(s) is incorrect, incomplete or inconsistent. | | + +##### 6.1.6.3.5 Enumeration: MbsPccRuleStatus + +The enumeration MbsPccRuleStatus represents the status of an MBS PCC rule. It shall comply with the provisions of table 6.1.6.3.5-1. + +**Table 6.1.6.3.5-1: Enumeration MbsPccRuleStatus** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------|---------------| +| ACTIVE | Indicates that the MBS PCC rule(s) are successfully installed. | | +| INACTIVE | Indicates that the MBS PCC rule(s) are removed. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +#### 6.1.6.5 Binary data + +##### 6.1.6.5.1 Binary Data Types + +**Table 6.1.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Npcf\_MBSPolicyControl 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 Npcf\_MBSPolicyControl API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Npcf\_MBSPolicyControl service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Npcf\_MBSPolicyControl service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| INVALID_MBS_SERVICE_INFO | 400 Bad Request | The HTTP request is rejected because the provided MBS Service Information is invalid (e.g. invalid QoS reference), incorrect or insufficient for the PCF to perform MBS policy authorization. | +| FILTER_RESTRICTIONS_NOT_RESPECTED | 400 Bad Request | The HTTP request is rejected because the MBS IP flow(s) description provided within the MBS Service Information cannot be handled due to the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] not being respected. | +| ERROR_INPUT_PARAMETERS | 400 Bad Request | The HTTP request is rejected because the provided set of input parameters are incomplete, erroneous or missing necessary information for the PCF to perform MBS policy control. | +| MBS_SERVICE_INFO_NOT_AUTHORIZED | 403 Forbidden | The HTTP request is rejected because the provided MBS Service Information is not authorized by the PCF. | +| MBS_POLICY_CONTEXT_DENIED | 403 Forbidden | The HTTP request is rejected because the PCF does not accept the NF service consumer request due to operator policies and/or local configuration. | +| MBS_POLICY_ASSOCIATION_NOT_FOUND | 404 Not Found | The HTTP request is rejected because the targeted MBS Policy Association does not exist at the PCF. | + +### 6.1.8 Feature negotiation + +The optional features listed in table 6.1.8-1 are defined for the Npcf\_MBSPolicyControl API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | AreaSessPolicy |

This feature indicates the support of the Area Session Policy ID related handling for location-dependent MBS services.

The following functionalities are supported:

  • - Support the provisioning of the Area Session Policy ID to the PCF for MBS Sessions that are instances of a location-dependent MBS service.
| + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Npcf\_MBSPolicyControl 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 Npcf\_MBSPolicyControl 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 Npcf\_MBSPolicyControl service. + +The Npcf\_MBSPolicyControl API defines a single scope "npcf-mbspolicycontrol" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 6.2 Npcf\_MBSPolicyAuthorization Service API + +### 6.2.1 Introduction + +The Npcf\_MBSPolicyAuthorization Service shall use the Npcf\_MBSPolicyAuthorization API. + +The API URI of the Npcf\_MBSPolicyAuthorization Service shall be: + +**{apiRoot}//** + +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}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "npcf-mbspolicyauth". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, IETF RFC 9113 [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 Npcf\_MBSPolicyAuthorization API is contained in Annex A.2. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.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". + +JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" and shall be signalled by the content type "application/merge-patch+json", as defined in IETF RFC 7396 [22]. + +The "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 9754 [13]. + +#### 6.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +This clause describes the structure of the resource URIs and the resources and methods used for the Npcf\_MBSPolicyAuthorization service. + +Figure 6.2.3.1-1 depicts the resource URIs structure for the Npcf\_MBSPolicyAuthorization API. + +![Diagram showing the resource URI structure. A line from the root URI branches down to a box containing '/contexts'. From this box, another line branches down to a box containing '{contextId}'.](ff5f89b660edddb67971d7d3d4ce87ef_img.jpg) + +{apiRoot}/npcf-mbspolicyauth/ + +``` + +graph TD + Root["{apiRoot}/npcf-mbspolicyauth/"] --> Contexts["/contexts"] + Contexts --> ContextId["/{contextId}"] + +``` + +Diagram showing the resource URI structure. A line from the root URI branches down to a box containing '/contexts'. From this box, another line branches down to a box containing '{contextId}'. + +**Figure 6.2.3.1-1: Resource URI structure of the Npcf\_MBSPolicyAuthorization API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) | +|--------------------------------------------|--------------------------------------------|---------------------------------|---------------------------------------------------------------------------| +| MBS Application Session Contexts | /contexts | POST | Create a new MBS Application Session Context. | +| Individual MBS Application Session Context | /contexts/{contextId} | GET | Retrieve an existing Individual MBS Application Session Context resource. | +| | | PATCH | Modify an existing Individual MBS Application Session Context resource. | +| | | DELETE | Delete an existing Individual MBS Application Session Context resource. | + +#### 6.2.3.2 Resource: MBS Application Session Contexts + +##### 6.2.3.2.1 Description + +This resource represents the collection of "Individual MBS Application Session Context" resources managed by the PCF. + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/npcf-mbspolicyauth//contexts + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-------------------| +| apiRoot | string | See clause 6.2.1. | + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 POST + +This method enables an NF service consumer (e.g. NEF, MBSF, AF) to request the creation of an MBS Application Session Context at the PCF. + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.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 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------| +| MbsAppSessionCtxt | M | 1 | Contains the parameters to create an Individual MBS Application Session Context for MBS policy authorization. | + +**Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MbsAppSessionCtxt | M | 1 | 201 Created | Successful case. An Individual MBS Application Session Context resource is successfully created and a representation of the created resource is returned in the response body.

A Location header field containing the URI of the created resource is also included. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| MbsExtProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the HTTP POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.2.7. + +**Table 6.2.3.2.3.1-4: Headers supported by the POST method 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}/npcf-mbspolicyauth//contexts/{contextId} | + +##### 6.2.3.2.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +#### 6.2.3.3 Resource: Individual MBS Application Session Context + +##### 6.2.3.3.1 Description + +This resource represents an "Individual MBS Application Session Context" resource managed by the PCF. + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/npcf-mbspolicyauth//contexts/{contextId} + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------|-----------|------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1. | +| contextId | string | Represents the unique identifier of the "Individual MBS Application Session Context" resource. | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 GET + +This method enables an NF service consumer (e.g. NEF, MBSF, AF) to retrieve an existing "Individual MBS Application Session Context" resource at the PCF. + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.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 6.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------| +| MbsAppSessionCtxt | M | 1 | 200 OK | Successful case. The requested Individual MBS Application Session Context resource is successfully returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the HTTP GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +###### 6.2.3.3.3.2 PATCH + +This method enables an NF service consumer (e.g. NEF, MBSF, AF) to request the modification of an existing "Individual MBS Application Session Context" resource at the PCF. + +This method shall support the URI query parameters specified in table 6.2.3.3.3.2-1. + +**Table 6.2.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3. + +**Table 6.2.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------| +| MbsAppSessionCtxtPatch | M | 1 | Contains the parameters to request the modification of an existing Individual MBS Application Session Context resource. | + +**Table 6.2.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MbsAppSessionCtxt | M | 1 | 200 OK | Successful case. The corresponding Individual MBS Application Session Context resource is successfully modified and a representation of the updated resource is returned in the response body. | +| n/a | | | 204 No Content | Successful case. The corresponding Individual MBS Application Session Context resource is successfully modified and no content is returned in the response body. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| MbsExtProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the HTTP PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.2.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 6.2.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +###### 6.2.3.3.3.3 DELETE + +This method enables an NF service consumer (e.g. NEF, MBSF, AF) to request the deletion of an existing "Individual MBS Application Session Context" resource at the PCF. + +This method shall support the URI query parameters specified in table 6.2.3.3.3.3-1. + +**Table 6.2.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.3-2 and the response data structures and response codes specified in table 6.2.3.3.3.3-3. + +**Table 6.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 6.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 corresponding Individual MBS Application Session Context resource is successfully deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the HTTP DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.2.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +##### 6.2.3.3.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +### 6.2.4 Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +### 6.2.5 Notifications + +There are no notifications defined for this API in this release of the specification. + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Npcf\_MBSPolicyAuthorization service based interface protocol. + +**Table 6.2.6.1-1: Npcf\_MBSPolicyAuthorization specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------------|----------------|------------------------------------------------------------------------------|---------------| +| AcceptableMbsServInfo | 6.2.6.2.4 | Contains the MBS Service Information that can be accepted by the PCF. | | +| MbsExtProblemDetails | 6.2.6.4.1 | Identifies the MBS related extensions to the ProblemDetails data structure. | | +| MbsAppSessionCtxt | 6.2.6.2.2 | Represents the parameters of an MBS Application Session Context. | | +| MbsAppSessionCtxtPatch | 6.2.6.2.3 | Represents the modifications to an existing MBS Application Session Context. | | + +Table 6.2.6.1-2 specifies data types re-used by the Npcf\_MBSPolicyAuthorization 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 Npcf\_MBSPolicyAuthorization service based interface. + +**Table 6.2.6.1-2: Npcf\_MBSPolicyAuthorization re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|---------------------|---------------------|----------------------------------------------------------------------------------------------------------------|----------------| +| AreaSessionPolicyId | 3GPP TS 29.571 [15] | Indicates the Area Session Policy Identifier. | AreaSessPolicy | +| BitRate | 3GPP TS 29.571 [15] | Represents a bit rate. | | +| Dnn | 3GPP TS 29.571 [15] | Identifies a DNN. | | +| MbsMediaComp | 3GPP TS 29.571 [15] | Represents an MBS Media Component. | | +| MbsServiceInfo | 3GPP TS 29.571 [15] | Represents MBS Service Information. | | +| MbsSessionId | 3GPP TS 29.571 [15] | Represents an MBS Session Identifier. | | +| ProblemDetails | 3GPP TS 29.571 [15] | Contains error related additional information. | | +| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information. | | +| Snssai | 3GPP TS 29.571 [15] | Identifies an S-NSSAI. | | +| SupportedFeatures | 3GPP TS 29.571 [15] | Represents the list of supported features. It is used to negotiate the applicability of the optional features. | | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: MbsAppSessionCtxt + +Table 6.2.6.2.2-1: Definition of type MbsAppSessionCtxt + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| mbsSessionId | MbsSessionId | M | 1 | Represents the identifier of the corresponding MBS Session. | | +| mbsServInfo | MbsServiceInfo | C | 0..1 | Represents the MBS Service Information.

This attribute shall be provided, if available. | | +| dnn | Dnn | O | 0..1 | Represents the DNN of the MBS session. | | +| snssai | Snssai | O | 0..1 | Represents the S-NSSAI of the MBS session. | | +| areaSessPolld | AreaSessionPolicyId | C | 0..1 | Contains the Area Session Policy ID.

This attribute may be present only in the response to an MBS Application Session Context creation request.

This attribute shall be present if the "reqForLocDepMbs" attribute was present and set to "true" in the corresponding request. | AreaSessPolicy | +| reqForLocDepMbs | boolean | O | 0..1 | Indicates whether the request corresponds to a location-dependent MBS service, i.e.:
- "true" means that the request corresponds to a location-dependent MBS service.
- "false" means that the request does not correspond to a location-dependent MBS service.
- When this attribute is not present, the default value is "false".

This attribute may be present only in a request to create an MBS Application Session Context. It shall not be present otherwise. | AreaSessPolicy | +| contactPcfInd | boolean | O | 0..1 | Indicates whether the PCF shall be contacted or not, i.e.:
- "true" means that the PCF shall be contacted.
- "false" means that the PCF shall not be contacted.
- When this attribute is not present, the default value is "false".

This attribute may be present only in the response to an MBS Application Session Context update request. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of the supported features (among the ones defined in clause 6.2.8).

This parameter shall be provided if feature negotiation needs to take place. | | + +##### 6.2.6.2.3 Type: MbsAppSessionCtxtPatch + +Table 6.2.6.2.3-1: Definition of type MbsAppSessionCtxtPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-------------------------------------------------|---------------| +| mbsServInfo | MbsServiceInfo | O | 0..1 | Represents the updated MBS Service Information. | | + +##### 6.2.6.2.4 Type: AcceptableMbsServInfo + +Table 6.2.6.2.4-1: Definition of type AcceptableMbsServInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| accMbsServInfo | map(MbsMediaComp) | C | 1..N | Contains the maximum acceptable bandwidth per media component that can be accepted and authorized by the PCF.

Each map entry encoded using the MbsMediaComp data structure shall only include the "mbsMedCompNum" attribute and the "maxReqMbsBwDI" attribute indicating the maximum acceptable bandwidth.

The key of the map is the "medCompN" attribute of the corresponding MbsMediaComp data structure provided as a map entry.

(NOTE) | | +| accMaxMbsBw | BitRate | C | 0..1 | Contains the maximum acceptable bandwidth.

(NOTE) | | + +NOTE: When the acceptable MBS bandwidth is per MBS media component, only the "accMbsServInfo" attribute shall be present. When the acceptable MBS bandwidth applies to all the MBS media components, only the "accMaxMbsBw" attribute shall be present. + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.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. + +##### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +Table 6.2.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 6.2.6.4 Data types describing alternative data types or combinations of data types + +##### 6.2.6.4.1 Type: MbsExtProblemDetails + +**Table 6.2.6.4.1-1: Definition of type MbsExtProblemDetails as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|-----------------------|-------------|-------------------------------------------------------------------------------------|---------------| +| ProblemDetails | 1 | Contains the details of the encountered problem, as defined in 3GPP TS 29.571 [15]. | | +| AcceptableMbsServInfo | 0..1 | Contains the MBS Service Information that can be accepted by the PCF. | | + +#### 6.2.6.5 Binary data + +##### 6.2.6.5.1 Binary Data Types + +**Table 6.2.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +For the Npcf\_MBSPolicyAuthorization 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 Npcf\_MBSPolicyAuthorization API. + +#### 6.2.7.2 Protocol Errors + +No specific procedures for the Npcf\_MBSPolicyAuthorization service are specified. + +#### 6.2.7.3 Application Errors + +The application errors defined for the Npcf\_MBSPolicyAuthorization service are listed in table 6.2.7.3-1. + +Table 6.2.7.3-1: Application errors + +| Application Error | HTTP status code | Description | +|-------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| INVALID_MBS_SERVICE_INFO | 400 Bad Request | The HTTP request is rejected because the provided MBS Service Information is invalid (e.g. invalid QoS reference), incorrect or insufficient for the PCF to perform MBS policy authorization. | +| FILTER_RESTRICTIONS_NOT_RESPECTED | 400 Bad Request | The HTTP request is rejected because the MBS IP flow(s) description provided within the MBS Service Information cannot be handled due to the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] not being respected. | +| MBS_SERVICE_INFO_NOT_AUTHORIZED | 403 Forbidden | The HTTP request is rejected because the provided MBS Service Information is not authorized by the PCF. | +| MBS_SESSION_POL_AUTH_CTXT_NOT_FOUND | 404 Not Found | The HTTP request is rejected because the targeted Individual MBS Application Session Context does not exist at the PCF. | + +### 6.2.8 Feature negotiation + +The optional features listed in table 6.2.8-1 are defined for the Npcf\_MBSPolicyAuthorization API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +Table 6.2.8-1: Supported Features + +| Feature number | Feature Name | Description | +|----------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | AreaSessPolicy |

This feature indicates the support of the Area Session Policy ID related handling for location-dependent MBS services.

The following functionalities are supported:

  • - Support the provisioning of the "request for location dependent MBS session" indication to the PCF for MBS Sessions that are instances of a location-dependent MBS service.
  • - Support that the PCF assigns and returns to the NF service consumer an Area Session Policy ID for an MBS Session that is an instance of a location-dependent MBS service.
| + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Npcf\_MBSPolicyAuthorization 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 Npcf\_MBSPolicyAuthorization 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 Npcf\_MBSPolicyAuthorization service. + +The Npcf\_MBSPolicyAuthorization API defines a single scope "npcf-mbspolicyauth" for the entire service, and it does not define any additional scopes at resource or operation level. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [7]). + +## A.2 Npcf\_MBSPolicyControl API + +``` +openapi: 3.0.0 + +info: + title: Npcf_MBSPolicyControl API + version: 1.1.0-alpha.3 + description: | + MBS Policy Control Service + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.537 V18.3.0; 5G System; Multicast/Broadcast Policy Control Services. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.537/' + +security: + - {} + - oAuth2ClientCredentials: + - npcf-mbspolicycontrol + +servers: + - url: '{apiRoot}/npcf-mbspolicycontrol/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +paths: + /mbs-policies: + post: + summary: Request the creation of a new MBS Policy Association. + operationId: CreateMBSPolicy + tags: + - MBS Policies (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MbsPolicyCtxtData' + responses: + '201': + description: > + Created. An Individual MBS Policy resource is successfully created. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsPolicyData' + headers: + Location: + description: > + Contains the URI of the newly created Individual MBS Policy resource. + required: true + schema: + type: string + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden. + content: + application/problem+json: + schema: + $ref: 'TS29537_Npcf_MBSPolicyAuthorization.yaml#/components/schemas/MbsExtProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': +$ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': +$ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': +$ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': +$ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': +$ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: +$ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-policies/{mbsPolicyId}: + parameters: + - name: mbsPolicyId + in: path + description: > + Contains the identifier of the concerned Individual MBS Policy resource. + required: true + schema: + type: string + + get: + summary: Read an Individual MBS Policy resource. + operationId: GetIndMBSPolicy + tags: + - Individual MBS Policy (Document) + responses: + '200': + description: > + OK. The requested Individual MBS Policy resource is successfully returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsPolicyData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + delete: + summary: Deletes an existing Individual MBS Policy resource. + operationId: DeleteIndMBSPolicy + tags: + - Individual MBS Policy (Document) + parameters: + - name: mbsPolicyId + in: path + description: > + Contains the identifier of the concerned Individual MBS Policy resource. + required: true + schema: + type: string + responses: + '204': + description: > +``` + +``` + No Content. The concerned Individual MBS Policy resource is successfully deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-policies/{mbsPolicyId}/update: + post: + summary: Request the update of an existing MBS Policy Association. + operationId: UpdateIndMBSPolicy + tags: + - Individual MBS Policy (Document) + parameters: + - name: mbsPolicyId + in: path + description: > + Contains the identifier of the concerned Individual MBS Policy resource. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MbsPolicyCtxtDataUpdate' + responses: + '200': + description: > + OK. The targeted Individual MBS Policy resource is successfully updated. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsPolicyData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden. + content: + application/problem+json: + schema: + $ref: 'TS29537_Npcf_MBSPolicyAuthorization.yaml#/components/schemas/MbsExtProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcfc-mbspolicycontrol: Access to the Npcf_MBSPolicyControl API + +schemas: + MbsPolicyCtxtData: + description: > + Contains the parameters used to request the creation of an MBS Policy + Association. + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + areaSessPolId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionPolicyId' + mbsServInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceInfo' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - mbsSessionId + + MbsPolicyDecision: + description: > + Represents the parameters constituting an MBS Policy Decision. + type: object + properties: + mbsPccRules: + type: object + additionalProperties: + $ref: '#/components/schemas/MbsPccRule' + minProperties: 1 + description: > + A map of MBS PCC rule(s) with each map entry containing the MbsPccRule data structure. + The key of the map for each entry is the mbsPccRuleId attribute of the corresponding + MbsPccRule data structure. + nullable: true + mbsQosDecs: + type: object + additionalProperties: + $ref: '#/components/schemas/MbsQosDec' + minProperties: 1 + description: > + A map of MBS QoS Decision(s) with each map entry containing the MbsQosDec data structure. + The key of the map for each entry is the mbsQosId attribute of the corresponding + MbsQosDec data structure. + mbsQosChars: + type: object + additionalProperties: + $ref: '#/components/schemas/MbsQosChar' + minProperties: 1 + description: > + A map of MBS QoS Characteristics set(s) with each map entry containing the MbsQosChar data + structure. The key of the map for each entry is the 5QI attribute of the corresponding + MbsQosDec data structure. + authMbsSessAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mbsPerts: +``` + +``` + type: array + items: + $ref: '#/components/schemas/MbsPprt' + minItems: 1 + nullable: true + +MbsPolicyData: + description: > + Contains the MBS policy data provisioned as part of an MBS Policy Association. + type: object + properties: + mbsPolicyCtxtData: + $ref: '#/components/schemas/MbsPolicyCtxtData' + mbsPolicies: + $ref: '#/components/schemas/MbsPolicyDecision' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - mbsPolicyCtxtData + +MbsPccRule: + description: Represents the parameters constituting an MBS PCC rule. + type: object + properties: + mbsPccRuleId: + type: string + mbsDlIpFlowInfo: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowDescription' + minItems: 1 + precedence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + refMbsQosDec: + type: array + items: + type: string + minItems: 1 + maxItems: 1 + required: + - mbsPccRuleId + +MbsQosDec: + description: Represents the parameters constituting an MBS QoS Decision. + type: object + properties: + mbsQosId: + type: string + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + priorityLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevel' + mbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + gbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + averWindow: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindow' + mbsMaxDataBurstVol: + $ref: '#/components/schemas/MbsMaxDataBurstVol' + required: + - mbsQosId + +MbsQosChar: + description: > + Represents the parameters constituting a set of explicitly signalled QoS characteristics. + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + priorityLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevel' + resourceType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/QosResourceType' + packetDelayBudget: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' +``` + +``` + packetErrorRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + averWindow: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindow' + mbsMaxDataBurstVol: + $ref: '#/components/schemas/MbsMaxDataBurstVol' + required: + - 5qi + - resourceType + - priorityLevel + - packetDelayBudget + - packetErrorRate + - mbsMaxDataBurstVol + +MbsPolicyCtxtDataUpdate: + description: > + Contains the parameters to request the modification of an existing MBS Policy Association. + type: object + properties: + mbsServInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceInfo' + mbsPcrts: + type: array + items: + $ref: '#/components/schemas/MbsPcrT' + minItems: 1 + mbsErrorReport: + $ref: '#/components/schemas/MbsErrorReport' + +MbsErrorReport: + description: > + Represents the reporting of MBS Policy decision level failure(s) and/or MBS PCC rule level + failure(s). + type: object + properties: + mbsReports: + type: array + items: + $ref: '#/components/schemas/MbsReport' + minItems: 1 + +MbsReport: + description: > + Contains information about the MBS Policy Decision level failure(s) and/or the MBS PCC + rule level failure(s). + type: object + properties: + mbsPccRuleIds: + type: array + items: + type: string + minItems: 1 + mbsPccRuleStatus: + $ref: '#/components/schemas/MbsPccRuleStatus' + failureCode: + $ref: '#/components/schemas/MbsFailureCode' + +# Simple data types: + +MbsMaxDataBurstVol: + description: Represents the MBS Maximum Data Burst Volume expressed in Bytes. + type: integer + minimum: 1 + maximum: 2000000 + +# ENUMS: + +MbsPcrT: + anyOf: + - type: string + enum: + - MBS_SESSION_UPDATE + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents the MBS Policy Control Request Trigger. +``` + +Possible values are: +- MBS\_SESSION\_UPDATE: Indicates the MBS Session Update policy control request trigger. + +### MbsPccRuleStatus: + +##### anyOf: + +- type: string + +#### enum: + +- ACTIVE +- INACTIVE + +- type: string + +##### description: > + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +#### description: | + +Represents the MBS PCC rule status. + +Possible values are: + +- ACTIVE: Indicates that the MBS PCC rule(s) are successfully installed. +- INACTIVE: Indicates that the MBS PCC rule(s) are removed. + +### MbsFailureCode: + +#### anyOf: + +- type: string + +#### enum: + +- NF\_MALFUNCTION +- NF\_RESOURCES\_UNAVAILABLE +- RESOURCE\_ALLOCATION\_FAILURE +- MBS\_QOS\_VALIDATION\_FAILURE +- NO\_MBS\_QOS\_FLOW +- MBS\_QOS\_DECISION\_ERROR +- MBS\_POLICY\_PARAM\_ERROR + +- type: string + +##### description: > + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +##### description: | + +Represents the reason for the MBS Policy Decision(s) enforcement failure or the MBS PCC rule(s) installation failure. + +Possible values are: + +- NF\_MALFUNCTION: Indicates that the MBS PCC rule could not be successfully installed due to MB-SMF/MB-UPF malfunction. +- NF\_RESOURCES\_UNAVAILABLE: Indicates that the MBS PCC rule could not be successfully installed due to resources unavailable at the MB-SMF/MB-UPF. +- RESOURCE\_ALLOCATION\_FAILURE: Indicates that the MBS PCC rule could not be successfully installed or maintained since the associated MBS QoS flow establishment/modification failed or the associated MBS QoS flow was released. +- MBS\_QOS\_VALIDATION\_FAILURE: Indicates that MBS QoS validation has failed. +- NO\_MBS\_QOS\_FLOW: Indicates that there is no MBS QoS flow to which the MB-SMF can bind the MBS PCC rule(s). +- MBS\_QOS\_DECISION\_ERROR: Indicates failure in the provisioning of MBS QoS Decision data. +- MBS\_POLICY\_PARAM\_ERROR: Indicates that the information related to the provisioned MBS policy parameter(s) is incorrect, incomplete or inconsistent. + +## A.3 Npcf\_MBSPolicyAuthorization API + +``` +openapi: 3.0.0 +info: + title: Npcf_MBSPolicyAuthorization API + version: 1.1.0-alpha.2 + description: | + MBS Policy Authorization Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.537 V18.3.0; 5G System; Multicast/Broadcast Policy Control Services. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.537/' + +security: + - {} + - oAuth2ClientCredentials: + - npcf-mbspolicyauth + +servers: + - url: '{apiRoot}/npcf-mbspolicyauth/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501. + +paths: + /contexts: + post: + summary: Request the creation of a new Individual MBS Application Session Context resource. + operationId: CreateMBSAppSessionCtxt + tags: + - MBS Application Session Contexts (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MbsAppSessionCtxt' + responses: + '201': + description: > + Created. An Individual MBS Application Session Context resource is successfully created + and a representation of the created resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsAppSessionCtxt' + headers: + Location: + description: > + Contains the URI of the newly created Individual MBS Application Session Context + resource. + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/MbsExtProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/contexts/{contextId}: + parameters: + - name: contextId + in: path + description: > + Contains the identifier of the Individual MBS Application Session Context resource. + required: true + schema: + type: string + + get: + summary: Read an existing Individual MBS Application Session Context resource. + operationId: GetMBSAppSessionCtxt + tags: + - Individual MBS Application Session Context (Document) + responses: + '200': + description: > + OK. The requested Individual MBS Application Session Context resource is successfully + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsAppSessionCtxt' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + patch: + summary: Request the modification of an existing Individual MBS Application Session Context +resource. + operationId: ModifyMBSAppSessionCtxt + tags: + - Individual MBS Application Session Context (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/MbsAppSessionCtxtPatch' + responses: + '200': + description: > + OK. The requested Individual MBS Application Session Context resource is successfully + modified and a representation of the updated resource is returned in the response body. +``` + +``` + +content: + application/json: + schema: + $ref: '#/components/schemas/MbsAppSessionCtxt' +'204': + description: > + No Content. The corresponding Individual MBS Application Session Context resource is + successfully modified and no content is returned in the response body. +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + description: Forbidden. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/MbsExtProblemDetails' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Request the deletion of an existing Individual MBS Application Session Context +resource. + operationId: DeleteMbsAppSessionCtxt + tags: + - Individual MBS Application Session Context (Document) + responses: + '204': + description: > + No Content. The corresponding Individual MBS Application Session Context resource is + successfully deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + +``` + +``` +clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcfc-mbspolicyauth: Access to the Npcf_MBSPolicyAuthorization API + +schemas: + MbsAppSessionCtxt: + description: > + Represents the parameter of an MBS Application Session Context. + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + mbsServInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceInfo' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + areaSessPolId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionPolicyId' + reqForLocDepMbs: + type: boolean + default: false + contactPcfInd: + type: boolean + default: false + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - mbsSessionId + + MbsAppSessionCtxtPatch: + description: > + Represents the modifications to an existing MBS Application Session Context resource. + type: object + properties: + mbsServInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceInfo' + + AcceptableMbsServInfo: + description: > + Contains the MBS Service Information that can be accepted by the PCF. + type: object + properties: + accMbsServInfo: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsMediaComp' + minProperties: 1 + accMaxMbsBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + oneOf: + - required: [accMbsServInfo] + - required: [accMaxMbsBw] + +# Data types describing alternative data types or combinations of data types: + + MbsExtProblemDetails: + description: Identifies the MBS related extensions to the ProblemDetails data structure. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AcceptableMbsServInfo' +``` + +# --- Annex B (informative): Withdrawn API versions + +## B.1 General + +This Annex lists withdrawn API versions of the APIs defined in the present specification. Clause 4.3.1.6 of 3GPP TS 29.501 [5] describes the withdrawal of API versions. + +## --- B.2 Npcf\_MBSPolicyControl API + +The API versions listed in table B.2-1 are withdrawn for the Npcf\_MBSPolicyControl API. + +**Table B.2-1: Withdrawn API versions of the Npcf\_MBSPolicyControl service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +## --- B.3 Npcf\_MBSPolicyAuthorization API + +The API versions listed in table B.3-1 are withdrawn for the Npcf\_MBSPolicyAuthorization API. + +**Table B.3-1: Withdrawn API versions of the Npcf\_MBSPolicyAuthorization service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +# Annex C (informative): Change history + +| Change history | | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2022-01 | CT3#119bis-e | C3-220401 | | | | TS Skeleton | | 0.0.0 | +| 2022-01 | CT3#119bis-e | C3-220457 | | | | Inclusion of C3-220113, C3-220114, C3-220115, C3-220116, C3-220402, C3-220403, C3-220404, C3-220491, C3-220492, C3-220493 | | 0.1.0 | +| 2022-04 | CT3#121-e | C3-222483 | | | | Inclusion of C3-222056, C3-222124, C3-222127, C3-222403, C3-222404, C3-222405, C3-222406, C3-222407, C3-222462 | | 0.2.0 | +| 2022-05 | CT3#122-e | C3-223506 | | | | Inclusion of C3-223561, C3-223574, C3-223562, C3-223563, C3-223564, C3-223568, C3-223565, C3-223566, C3-223573, C3-223308 | | 0.3.0 | +| 2022-06 | CT#96 | CP-221097 | | | | Presentation to TSG CT for information | | 1.0.0 | +| 2022-06 | | | | | | Update of info and externalDocs fields in OpenAPI specs by MCC | | 1.0.1 | +| 2022-09 | CT3#123-e | | | | | Inclusion of C3-224644, C3-224645, C3-224646, C3-224709, C3-224710, C3-224711 | | 1.0.2 | +| 2022-09 | CT#97e | CP-222129 | | | | Presentation to TSG CT for approval | | 2.0.0 | +| 2022-09 | CT#97e | CP-222129 | | | | Approved by TSG CT | | 17.0.0 | +| 2022-12 | CT#98e | CP-223167 | 0001 | 1 | F | Attribute corrections in the description and data model clause in Npcf_MBSPolicyControl Service | | 17.1.0 | +| 2022-12 | CT#98e | CP-223166 | 0005 | - | F | Wrong data type for MBS QoS information | | 17.1.0 | +| 2022-12 | CT#98e | CP-223167 | 0006 | 1 | F | Add 404 NOT FOUND for the Npcf_MBSPolicyauthorization update and delete service | | 17.1.0 | +| 2022-12 | CT#98e | CP-223166 | 0007 | - | F | Correction to architecture figure | | 17.1.0 | +| 2022-12 | CT#98e | CP-223167 | 0008 | 1 | F | Correction to content type of Npcf_MBSPolicyAuthorization API | | 17.1.0 | +| 2022-12 | CT#98e | CP-223166 | 0009 | - | F | Correction to Individual MBS Policy | | 17.1.0 | +| 2022-12 | CT#98e | CP-223166 | 0010 | - | F | Correction to MbsAppSessionCtxt | | 17.1.0 | +| 2022-12 | CT#98e | CP-223167 | 0011 | 1 | F | Correction to Npcf_MBSPolicyControl_Create operation | | 17.1.0 | +| 2022-12 | CT#98e | CP-223167 | 0012 | 1 | F | Correction to response of create operation | | 17.1.0 | +| 2022-12 | CT#98e | CP-223166 | 0013 | - | F | Correction to the indication that the PCF has to be contacted | | 17.1.0 | +| 2022-12 | CT#98e | CP-223167 | 0014 | 1 | F | Corrections for Npcf_MBSPolicyControl service | | 17.1.0 | +| 2022-12 | CT#98e | CP-223188 | 0015 | - | F | Update of info and externalDocs fields | | 17.1.0 | +| 2022-12 | CT#98e | CP-223192 | 0003 | - | F | Adding the mandatory error code 502 Bad Gateway | | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0004 | 1 | F | Npcf_MBSPolicyControl API: enumeration definitions in the OpenAPI file | | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0016 | - | F | Update of info and externalDocs fields | | 18.0.0 | +| 2023-03 | CT#99 | CP-230166 | 0017 | - | F | Correction of the description fields in enumerations | | 18.1.0 | +| 2023-03 | CT#99 | CP-230131 | 0019 | 1 | A | Miscellaneous essential corrections to the MBS PCF APIs | | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0021 | - | F | Update of info and externalDocs fields | | 18.1.0 | +| 2023-06 | CT#100 | CP-231131 | 0020 | 3 | F | Corrections to the redirection mechanism description | | 18.2.0 | +| 2023-12 | CT#102 | CP-233228 | 0022 | | F | Updating the obsoleted IETF HTTP RFCs | | 18.3.0 | +| 2023-12 | CT#102 | CP-233229 | 0023 | 1 | F | Updating the obsoleted ProblemDetails IETF HTTP RFC | | 18.3.0 | +| 2023-12 | CT#102 | CP-233247 | 0026 | 1 | F | Clarification regarding the MBS service flow template | | 18.3.0 | +| 2023-12 | CT#102 | CP-233123 | 0028 | 2 | A | Correction to Npcf_MBSPolicyControl API for location dependent MBS service | | 18.3.0 | +| 2023-12 | CT#102 | CP-233238 | 0030 | | F | Update of info and externalDocs fields | | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29538/10781f43062bf3e9601a1e086710556c_img.jpg b/raw/rel-18/29_series/29538/10781f43062bf3e9601a1e086710556c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..25e063b95a8839e4b8045d23e4f8c906118549ac --- /dev/null +++ b/raw/rel-18/29_series/29538/10781f43062bf3e9601a1e086710556c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cb31a6f17e6769d36e8458556b5e6365715a4694b4764e4c2b18b3fd8595262d +size 30214 diff --git a/raw/rel-18/29_series/29538/4b87467ad9642943235f48f7d4b59449_img.jpg b/raw/rel-18/29_series/29538/4b87467ad9642943235f48f7d4b59449_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6183b0516db9d4d952c3af75fcd3c6353329c273 --- /dev/null +++ b/raw/rel-18/29_series/29538/4b87467ad9642943235f48f7d4b59449_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ee7556416b73a34ac36de32e9defed27826074ca030dbadbc83c5ec6e804862 +size 24374 diff --git a/raw/rel-18/29_series/29538/552328a9daaf3bc0069424b500025880_img.jpg b/raw/rel-18/29_series/29538/552328a9daaf3bc0069424b500025880_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c3406497051c64d6fadf398f27b38608337222cd --- /dev/null +++ b/raw/rel-18/29_series/29538/552328a9daaf3bc0069424b500025880_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:45fb28fd78041411a23afb172b14296f88dcaa09b693b7ae6a385a26e8bda309 +size 23115 diff --git a/raw/rel-18/29_series/29538/9db324c513563a95ae55c77f4462a969_img.jpg b/raw/rel-18/29_series/29538/9db324c513563a95ae55c77f4462a969_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..45cd129f2cc11b50fd21519904a05504d6bc12fc --- /dev/null +++ b/raw/rel-18/29_series/29538/9db324c513563a95ae55c77f4462a969_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c9025c90073b0957feacdc2908c515f533bb6dd03d5717cc3438f9e779989e2 +size 21224 diff --git a/raw/rel-18/29_series/29538/f0b7aaa539a2f77c98d53ed6c1c2366b_img.jpg b/raw/rel-18/29_series/29538/f0b7aaa539a2f77c98d53ed6c1c2366b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4235918720f85d71475d60bff7645a97a272765a --- /dev/null +++ b/raw/rel-18/29_series/29538/f0b7aaa539a2f77c98d53ed6c1c2366b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b6b27b48ebb96346357516a13bb42258d9167f5da6a824571be14006efaf0bf0 +size 24071 diff --git a/raw/rel-18/29_series/29538/raw.md b/raw/rel-18/29_series/29538/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..775eb9c3a408297f4569c0a8e37e6f7044dd3c06 --- /dev/null +++ b/raw/rel-18/29_series/29538/raw.md @@ -0,0 +1,4253 @@ + + +# 3GPP TS 29.538 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Enabling MSGin5G Service; Application Programming Interfaces (API) specification; Stage 3; (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 9 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions of terms, symbols and abbreviations..... | 12 | +| 3.1 Terms..... | 12 | +| 3.2 Symbols..... | 12 | +| 3.3 Abbreviations ..... | 12 | +| 4 Overview..... | 13 | +| 5 Services offered by the MSGin5G Servers..... | 13 | +| 5.1 Introduction ..... | 13 | +| 5.2 MSGS_ASRegistration Service ..... | 14 | +| 5.2.1 Service Description ..... | 14 | +| 5.2.2 Service Operations..... | 14 | +| 5.2.2.1 Introduction..... | 14 | +| 5.2.2.2 MSGS_ASRegistration_Request..... | 14 | +| 5.2.2.2.1 General ..... | 14 | +| 5.2.2.2.2 Application Server registering to MSGin5G Server using MSGS_ASRegistration_Request operation..... | 14 | +| 5.2.2.3 MSGS_ASRegistration_Deregister ..... | 15 | +| 5.2.2.3.1 General ..... | 15 | +| 5.2.2.3.2 Application Server deregistering from MSGin5G Server using MSGS_ASRegistration_Deregister operation..... | 15 | +| 5.3 MSGS_MSGDelivery Service ..... | 16 | +| 5.3.1 Service Description ..... | 16 | +| 5.3.2 Service Operations..... | 16 | +| 5.3.2.1 Introduction..... | 16 | +| 5.3.2.2 MSGS_MSGDelivery_ASODelivery ..... | 17 | +| 5.3.2.2.1 General ..... | 17 | +| 5.3.2.2.2 AS Originating MSGin5G Message Delivery..... | 17 | +| 5.3.2.3 MSGS_MSGDelivery_ASODeliveryReport ..... | 18 | +| 5.3.2.3.1 General ..... | 18 | +| 5.3.2.3.2 AS Originating Message Delivery Status Report..... | 18 | +| 5.3.2.4 MSGS_MSGDelivery_UEODelivery..... | 18 | +| 5.3.2.4.1 General ..... | 18 | +| 5.3.2.4.2 UE Originating Message Delivery ..... | 19 | +| 5.3.2.5 MSGS_MSGDelivery_UEODeliveryReport..... | 20 | +| 5.3.2.5.1 General ..... | 20 | +| 5.3.2.5.2 UE Originating Message Delivery Status Report ..... | 20 | +| 5.4 MSGS_TopiclistEvent ..... | 20 | +| 5.4.1 Service Description ..... | 20 | +| 5.4.2 Service Operations..... | 21 | +| 5.4.2.1 Introduction..... | 21 | +| 5.4.2.2 MSGS_TopiclistEvent_SubscribeMSGTopiclist ..... | 21 | +| 5.4.2.2.1 General ..... | 21 | +| 5.4.2.2.2 MSGin5G Server subscribing to MSGin5G Messaging Topic List..... | 21 | +| 5.4.2.3 MSGS_TopiclistEvent_UnsubscribeMSGTopiclist ..... | 22 | +| 5.4.2.3.1 General ..... | 22 | +| 5.4.2.3.2 MSGin5G Server Unsubscribing to MSGin5G Messaging Topic List..... | 22 | +| 5.4.2.4 MSGS_TopiclistEvent_NotifyMSGTopiclist..... | 23 | +| 5.4.2.4.1 General ..... | 23 | +| 5.4.2.4.2 Notification about MSGin5G Messaging Topic List ..... | 23 | +| 5.4.2.5 MSGS_TopiclistEvent_SubscribeMSGTopic ..... | 23 | +| 5.4.2.5.1 General ..... | 23 | +| 5.4.2.5.2 MSGin5G Server Subscribing to MSGin5G Messaging Topic ..... | 24 | + +| | | | +|-------------|------------------------------------------------------------------------------|----| +| 5.4.2.6 | MSGs_TopicListEvent_SubscribeMSGTopic ..... | 24 | +| 5.4.2.6.1 | General ..... | 24 | +| 5.4.2.6.2 | MSGin5G Server Unsubscribing to MSGin5G Messaging Topic ..... | 25 | +| 6 | Services offered by the Message Gateway ..... | 25 | +| 6.1 | Introduction ..... | 25 | +| 6.2 | MSGG_L3GDelivery Service ..... | 26 | +| 6.2.1 | Service Description ..... | 26 | +| 6.2.2 | Service Operations ..... | 26 | +| 6.2.2.1 | Introduction ..... | 26 | +| 6.2.2.2 | MSGG_L3GDelivery_GTDelivery ..... | 26 | +| 6.2.2.2.1 | General ..... | 26 | +| 6.2.2.2.2 | Legacy 3GPP Message Gateway Terminating Message Delivery ..... | 27 | +| 6.2.2.3 | MSGG_L3GDelivery_GTDeliveryReport ..... | 27 | +| 6.2.2.3.1 | General ..... | 27 | +| 6.2.2.3.2 | Legacy 3GPP Message Gateway Terminating Message Delivery Status Report ..... | 28 | +| 6.3 | MSGG_N3GDelivery Service ..... | 28 | +| 6.3.1 | Service Description ..... | 28 | +| 6.3.2 | Service Operations ..... | 28 | +| 6.3.2.1 | Introduction ..... | 28 | +| 6.3.2.2 | MSGG_N3GDelivery_GTDelivery ..... | 29 | +| 6.3.2.2.1 | General ..... | 29 | +| 6.3.2.2.2 | Non-3GPP Message Gateway Terminating Message Delivery ..... | 29 | +| 6.3.2.3 | MSGG_N3GDelivery_GTDeliveryReport ..... | 30 | +| 6.3.2.3.1 | General ..... | 30 | +| 6.3.2.3.2 | Non-3GPP Message Gateway Terminating Message Delivery Status Report ..... | 30 | +| 6.4 | MSGG_BGDelivery Service ..... | 30 | +| 6.4.1 | Service Description ..... | 30 | +| 6.4.2 | Service Operations ..... | 31 | +| 6.4.2.1 | Introduction ..... | 31 | +| 6.4.2.2 | MSGG_BGDelivery_GTDelivery ..... | 31 | +| 6.4.2.2.1 | General ..... | 31 | +| 6.4.2.2.2 | Broadcast Message Gateway Terminating Message Delivery ..... | 31 | +| 7 | Common information applicable to several APIs ..... | 32 | +| 7.1 | General ..... | 32 | +| 7.2 | Data Types ..... | 32 | +| 7.2.1 | General ..... | 32 | +| 7.2.2 | Referenced structured data types ..... | 32 | +| 7.2.3 | Referenced Simple data types and enumerations ..... | 33 | +| 7.3 | Usage of HTTP ..... | 33 | +| 7.4 | Content type ..... | 33 | +| 7.5 | URI structure ..... | 33 | +| 7.5.1 | Resource URI structure ..... | 33 | +| 7.5.2 | Custom operations URI structure ..... | 33 | +| 7.6 | Notifications ..... | 33 | +| 7.7 | Error Handling ..... | 33 | +| 7.8 | Feature negotiation ..... | 33 | +| 7.9 | HTTP headers ..... | 34 | +| 7.10 | Conventions for Open API specification files ..... | 34 | +| 8 | Message Server API definition ..... | 34 | +| 8.1 | MSGs_ASRegistration API ..... | 34 | +| 8.1.1 | API URI ..... | 34 | +| 8.1.2 | Resources ..... | 34 | +| 8.1.2.1 | Overview ..... | 34 | +| 8.1.2.2 | Resource: AS Registrations ..... | 35 | +| 8.1.2.2.1 | Description ..... | 35 | +| 8.1.2.2.2 | Resource Definition ..... | 35 | +| 8.1.2.2.3 | Resource Standard Methods ..... | 35 | +| 8.1.2.2.3.1 | POST ..... | 35 | +| 8.1.2.3 | Resource: AS DeRegistration ..... | 36 | +| 8.1.2.3.1 | Description ..... | 36 | + +| | | | +|-------------|------------------------------------------------------|----| +| 8.1.2.3.2 | Resource Definition..... | 36 | +| 8.1.2.3.3 | Resource Standard Methods..... | 36 | +| 8.1.2.3.3.1 | DELETE ..... | 36 | +| 8.1.3 | Custom Operations without associated resources ..... | 37 | +| 8.1.4 | Notifications ..... | 37 | +| 8.1.5 | Data Model ..... | 37 | +| 8.1.5.1 | General ..... | 37 | +| 8.1.5.2 | Structured data types..... | 38 | +| 8.1.5.2.1 | Introduction ..... | 38 | +| 8.1.5.2.2 | Type: ASRegistration..... | 38 | +| 8.1.5.2.3 | Type: ASRegistrationAck ..... | 38 | +| 8.1.5.2.4 | Type: ASProfile..... | 38 | +| 8.1.5.3 | Simple data types and enumerations..... | 38 | +| 8.1.6 | Error Handling ..... | 38 | +| 8.1.6.1 | General ..... | 38 | +| 8.1.6.2 | Protocol Errors ..... | 39 | +| 8.1.6.3 | Application Errors..... | 39 | +| 8.1.7 | Feature negotiation ..... | 39 | +| 8.2 | MSGS_MSGDelivery API ..... | 39 | +| 8.2.1 | API URI..... | 39 | +| 8.2.2 | Resources..... | 39 | +| 8.2.3 | Custom Operations without associated resources ..... | 39 | +| 8.2.3.1 | Overview..... | 39 | +| 8.2.3.2 | Operation: deliver-as-message..... | 40 | +| 8.2.3.2.1 | Description ..... | 40 | +| 8.2.3.2.2 | Operation Definition ..... | 40 | +| 8.2.3.3 | Operation: deliver-ue-message ..... | 41 | +| 8.2.3.3.1 | Description ..... | 41 | +| 8.2.3.3.2 | Operation Definition ..... | 41 | +| 8.2.3.4 | Operation: deliver-report ..... | 41 | +| 8.2.3.4.1 | Description ..... | 41 | +| 8.2.3.4.2 | Operation Definition ..... | 41 | +| 8.2.4 | Notifications ..... | 41 | +| 8.2.5 | Data Model ..... | 42 | +| 8.2.5.1 | General ..... | 42 | +| 8.2.5.2 | Structured data types..... | 43 | +| 8.2.5.2.1 | Introduction ..... | 43 | +| 8.2.5.2.2 | Type: ASMessageDelivery ..... | 43 | +| 8.2.5.2.3 | Type: UEMessageDelivery ..... | 44 | +| 8.2.5.2.4 | Type: MessageDeliveryAck..... | 44 | +| 8.2.5.2.5 | Type: MessageSegmentParameters..... | 45 | +| 8.2.5.2.6 | Type: StoreAndForwardParameters..... | 45 | +| 8.2.5.2.7 | Type: DeliveryStatusReport..... | 45 | +| 8.2.5.3 | Simple data types and enumerations..... | 45 | +| 8.2.5.3.1 | Introduction ..... | 45 | +| 8.2.5.3.2 | Simple data types ..... | 45 | +| 8.2.5.3.3 | Enumeration: DeliveryStatus ..... | 46 | +| 8.2.5.3.4 | Enumeration: ReportDeliveryStatus ..... | 46 | +| 8.2.5.3.5 | Enumeration: Priority ..... | 46 | +| 8.2.6 | Error Handling ..... | 46 | +| 8.2.6.1 | General ..... | 46 | +| 8.2.6.2 | Protocol Errors ..... | 46 | +| 8.2.6.3 | Application Errors..... | 46 | +| 8.2.7 | Feature negotiation ..... | 46 | +| 8.3 | MSGS_TopicListEvent API ..... | 47 | +| 8.3.1 | API URI..... | 47 | +| 8.3.2 | Resources..... | 47 | +| 8.3.2.1 | Overview..... | 47 | +| 8.3.2.2 | Resource: Topic List Subscriptions ..... | 47 | +| 8.3.2.2.1 | Description ..... | 47 | +| 8.3.2.2.2 | Resource Definition..... | 47 | +| 8.3.2.2.3 | Resource Standard Methods..... | 48 | + +| | | | +|-------------|------------------------------------------------------|----| +| 8.3.2.2.3.1 | POST ..... | 48 | +| 8.3.2.3 | Resource: Individual Topic List Subscription ..... | 48 | +| 8.3.2.3.1 | Description ..... | 48 | +| 8.3.2.3.2 | Resource Definition..... | 49 | +| 8.3.2.3.3 | Resource Standard Methods..... | 49 | +| 8.3.2.3.3.1 | POST ..... | 49 | +| 8.3.3 | Custom Operations without associated resources ..... | 50 | +| 8.3.3.1 | Overview..... | 50 | +| 8.3.3.2 | Operation: request-topic-subscription..... | 50 | +| 8.3.3.2.1 | Description ..... | 50 | +| 8.3.3.2.2 | Operation Definition ..... | 50 | +| 8.3.3.3 | Operation: request-topic-unsubscription..... | 51 | +| 8.3.3.3.1 | Description ..... | 51 | +| 8.3.3.3.2 | Operation Definition ..... | 51 | +| 8.3.4 | Notifications ..... | 51 | +| 8.3.4.2 | Topiclist Notification..... | 51 | +| 8.3.4.2.1 | Description ..... | 51 | +| 8.3.4.2.2 | Target URI..... | 52 | +| 8.3.4.2.3 | Standard Methods..... | 52 | +| 8.3.4.2.3.1 | POST ..... | 52 | +| 8.3.5 | Data Model ..... | 52 | +| 8.3.5.1 | General..... | 52 | +| 8.3.5.2 | Structured data types..... | 53 | +| 8.3.5.2.1 | Introduction ..... | 53 | +| 8.3.5.2.2 | Type: TopicListSubscription..... | 53 | +| 8.3.5.2.3 | Type: TopicListUnsubscription..... | 54 | +| 8.3.5.2.4 | Type: TopicListSubscriptionAck..... | 54 | +| 8.3.5.2.5 | Type: TopicListUnsubscriptionAck..... | 54 | +| 8.3.5.2.6 | Type: TopicSubscription..... | 54 | +| 8.3.5.2.7 | Type: TopicSubscriptionAck ..... | 54 | +| 8.3.5.2.8 | Type: TopicUnsubscription..... | 55 | +| 8.3.5.2.9 | Type: TopicListNotification..... | 55 | +| 8.3.5.2.10 | Type: MessagingTopic..... | 55 | +| 8.3.5.3 | Simple data types and enumerations..... | 55 | +| 8.3.5.3.1 | Introduction ..... | 55 | +| 8.3.5.3.2 | Enumeration: UpdateStatus..... | 55 | +| 8.3.6 | Error Handling ..... | 55 | +| 8.3.6.1 | General..... | 55 | +| 8.3.6.2 | Protocol Errors ..... | 55 | +| 8.3.6.3 | Application Errors..... | 56 | +| 8.3.7 | Feature negotiation ..... | 56 | +| 9 | Message Gateway API definition ..... | 56 | +| 9.1 | MSGG_L3GDelivery API..... | 56 | +| 9.1.1 | API URI..... | 56 | +| 9.1.2 | Resources..... | 56 | +| 9.1.3 | Custom Operations without associated resources ..... | 56 | +| 9.1.3.1 | Overview..... | 56 | +| 9.1.3.2 | Operation: deliver-message ..... | 57 | +| 9.1.3.2.1 | Description ..... | 57 | +| 9.1.3.2.2 | Operation Definition ..... | 57 | +| 9.1.3.3 | Operation: deliver-report ..... | 57 | +| 9.1.3.3.1 | Description ..... | 57 | +| 9.1.3.3.2 | Operation Definition ..... | 58 | +| 9.1.4 | Notifications ..... | 58 | +| 9.1.5 | Data Model ..... | 58 | +| 9.1.5.1 | General..... | 58 | +| 9.1.5.2 | Structured data types..... | 59 | +| 9.1.5.2.1 | Introduction ..... | 59 | +| 9.1.5.2.2 | Type: L3gMessageDelivery ..... | 59 | +| 9.1.5.2.3 | Type: Address ..... | 59 | +| 9.1.5.3 | Simple data types and enumerations..... | 60 | + +| | | | +|-----------|------------------------------------------------------|----| +| 9.1.5.3.1 | Introduction ..... | 60 | +| 9.1.5.3.2 | Enumeration: AddressType..... | 60 | +| 9.1.6 | Error Handling..... | 60 | +| 9.1.6.1 | General..... | 60 | +| 9.1.6.2 | Protocol Errors ..... | 60 | +| 9.1.6.3 | Application Errors..... | 60 | +| 9.1.7 | Feature negotiation ..... | 60 | +| 9.2 | MSGG_N3GDelivery API ..... | 60 | +| 9.2.1 | API URI..... | 60 | +| 9.2.2 | Resources..... | 61 | +| 9.2.3 | Custom Operations without associated resources ..... | 61 | +| 9.2.3.1 | Overview..... | 61 | +| 9.2.3.2 | Operation: deliver-message ..... | 61 | +| 9.2.3.2.1 | Description ..... | 61 | +| 9.2.3.2.2 | Operation Definition ..... | 61 | +| 9.2.3.3 | Operation: deliver-report ..... | 62 | +| 9.2.3.3.1 | Description ..... | 62 | +| 9.2.3.3.2 | Operation Definition ..... | 62 | +| 9.2.4 | Notifications ..... | 62 | +| 9.2.5 | Data Model ..... | 62 | +| 9.2.5.1 | General..... | 62 | +| 9.2.5.2 | Structured data types..... | 63 | +| 9.2.5.2.1 | Introduction ..... | 63 | +| 9.2.5.2.2 | Type: N3gMessageDelivery..... | 63 | +| 9.2.6 | Error Handling..... | 63 | +| 9.2.6.1 | General..... | 63 | +| 9.2.6.2 | Protocol Errors ..... | 64 | +| 9.2.6.3 | Application Errors..... | 64 | +| 9.2.7 | Feature negotiation ..... | 64 | +| 9.3 | MSGG_BGDelivery API ..... | 64 | +| 9.3.1 | API URI..... | 64 | +| 9.3.2 | Resources..... | 64 | +| 9.3.3 | Custom Operations without associated resources ..... | 64 | +| 9.3.3.1 | Overview..... | 64 | +| 9.3.3.2 | Operation: deliver-message ..... | 65 | +| 9.3.3.2.1 | Description ..... | 65 | +| 9.3.3.2.2 | Operation Definition ..... | 65 | +| 9.3.4 | Notifications ..... | 65 | +| 9.3.5 | Data Model ..... | 65 | +| 9.3.5.1 | General..... | 65 | +| 9.3.5.2 | Structured data types..... | 67 | +| 9.3.5.2.1 | Introduction ..... | 67 | +| 9.3.5.2.2 | Type: BgMessageDelivery..... | 67 | +| 9.3.5.3 | Simple data types and enumerations..... | 67 | +| 9.3.6 | Error Handling..... | 67 | +| 9.3.6.1 | General..... | 67 | +| 9.3.6.2 | Protocol Errors ..... | 68 | +| 9.3.6.3 | Application Errors..... | 68 | +| 9.3.7 | Feature negotiation ..... | 68 | +| 10 | Security ..... | 68 | +| 11 | Using Common API Framework ..... | 68 | +| 11.1 | General ..... | 68 | +| 11.2 | Security..... | 68 | + +| | | | +|---------------------------------------------------------|-------------------------------------|-----------| +| 12 | Usage of Network Capabilities ..... | 69 | +| Annex A (normative): OpenAPI specification ..... | | 70 | +| A.1 | General..... | 70 | +| A.2 | MSG_S_ASRegistration API..... | 70 | +| A.3 | MSG_S_MSGDelivery API..... | 72 | +| A.4 | MSGG_L3GDelivery API ..... | 77 | +| A.5 | MSGG_N3GDelivery API..... | 79 | +| Annex B (informative): Change history ..... | | 84 | + +# Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# 1 Scope + +The present document specified the Application Programming Interface (API) for enabling the MSGin5G Service over MSGin5G-2/3/4/7/8 interfaces. The application layer architecture, functional requirements, procedures and information flows necessary for MSGin5G Service are contained in 3GPP TS 23.554 [2]. The requirements for MSGin5G are specified in 3GPP TS 22.262 [3]. + +# 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.554: "Application architecture for MSGin5G Service". +- [3] 3GPP TS 22.262: "Message Service within the 5G System". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TS 23.222: "Functional architecture and information flows to support Common API Framework for 3GPP Northbound APIs; Stage 2". +- [8] 3GPP TS 29.222: "Common API Framework for 3GPP Northbound APIs; Stage 3". +- [9] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [10] IETF RFC 9112: "HTTP/1.1". +- [11] IETF RFC 9110: "HTTP Semantics" +- [12] Void. +- [13] Void. +- [14] IETF RFC 9111: "Caching". +- [15] Void +- [16] IETF RFC 9113: "HTTP/2". +- [17] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [18] 3GPP TR 21.900: "Technical Specification Group working methods". +- [19] 3GPP TR 33.862: "Study on security aspects of the Message Service for MIoT over the 5G System (MSGin5G)". +- [20] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [21] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". + +- [22] 3GPP TS 33.122: "Security Aspects of Common API Framework for 3GPP Northbound APIs". +- [23] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [24] 3GPP TS 29.122: "T8 reference point for northbound APIs". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms 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]. + +For the purposes of the present document, the following terms and its definitions given in 3GPP TS 23.554 [2] shall apply: + +- MSGin5G Service +- MSGin5G message +- MSGin5G UE +- MSGin5G Group +- MSGin5G Client +- MSGin5G Server +- Legacy 3GPP Message Gateway +- Non-3GPP Message Gateway +- Broadcast Message Gateway +- Legacy 3GPP UE +- Non-3GPP UE +- Point-to-Point messaging +- Point-to-Application messaging +- Application-to-Point messaging +- Group messaging +- Broadcast messaging +- Messaging Topic +- Message Gateway +- Broadcast Area + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|-----------------------------|----------------------------------| +| <symbol> | <Explanation> | +|-----------------------------|----------------------------------| + +## 3.3 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]. + +| | | +|--------------------|------------------------------------------| +| AS | Application Server | +| BC | Broadcast | +| BMG | Broadcast Message Gateway | +| CAPIF | Common API Framework | +| L3G | Legacy 3GPP Message Gateway | +| N3G | Non-3GPP Message Gateway | + +# 4 Overview + +The MSGin5G Service is designed and optimized for massive IoT device communication including thing-to-thing communication and person-to-thing communication and provides messaging capability in 5GS with messaging communication models including Point-to-Point, Application-to-Point/Point-to-Application, Group and Broadcast messaging. + +3GPP TS 23.554 [2] has specified the application layer architecture, architectural requirements, procedures, information flows and some APIs, in order to support the MSGin5G Service. Various features are defined to ensure the efficient use and deployment of MSGin5G Service, including configuration, registration, message delivery, message aggregation, segmentation and reassembly, topic messaging. + +The present document specifies MSGin5G Services offered by MSGin5G Servers and MSGin5G Gateway, and APIs in detail, needed over MSGin5G-2/3/4/7/8 interfaces for interworking between MSGin5G Server and Legacy 3GPP UE, Non-3GPP UE, Broadcast Message Gateway or Application Server, with following functionalities need to be supported: + +1. Server-side functionality with the sending and receiving of messages to/from Application Servers and/or other MSGin5G Service endpoints on other UEs, provided by MSGin5G Server. +2. Interconnecting two different messaging delivery mechanisms and assure the message integrity between different message delivery mechanisms, provided by Message Gateway. + +And the definition of APIs specified in TS 23.554 [2] clause 9 is introduced in present document. + +# 5 Services offered by the MSGin5G Servers + +## 5.1 Introduction + +The Table 5.1-1 lists the services provided by the MSGin5G Server and corresponding service operations. A service description clause for each API gives a general description of the related API. + +**Table 5.1-1 List of services provided by the MSGin5G Servers** + +| Service Name | Service Operations | Operation Semantics | Example Consumer(s) | +|---------------------|---------------------------------------------|---------------------|-----------------------------------------------------------| +| MSGs_ASRegistration | MSGs_ASRegistration_Request | Request/Response | AS | +| | MSGs_ASRegistration_Deregister | | | +| MSGs_MSGDelivery | MSGs_MSGDelivery_ASODelivery | Request/ Response | AS, Legacy 3GPP Message Gateway, Non-3GPP Message Gateway | +| | MSGs_MSGDelivery_ASODeliveryReport | | | +| | MSGs_MSGDelivery_UODelivery | | | +| | MSGs_MSGDelivery_UODeliveryReport | | | +| MSGs_TopiclistEvent | MSGs_TopiclistEvent_SubscribeMSGTopiclist | Subscribe/Notify | MSGin5G Server | +| | MSGs_TopiclistEvent_UnsubscribeMSGTopiclist | | | +| | MSGs_TopiclistEvent_NotifyMSGTopiclist | | | +| | MSGs_TopiclistEvent_SubscribeMSGTopic | Request/ Response | MSGin5G Server | +| | MSGs_TopiclistEvent_UnsubscribeMSGTopic | | | + +Table 5.1-2 summarizes the corresponding APIs defined in this specification. + +Table 5.1-2: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------|--------|--------------------------|----------------------------------|---------------------|-------| +| MSGs_ASRegistration | 8.1 | AS Registration Service | TS29538_MSGs_ASRegistration.yaml | Msgs-asregistration | A.2 | +| MSGs_MSGDelivery | 8.2 | Message Delivery Service | TS29538_MSGs_MSGDelivery.yaml | Msgs-msgdelivery | A.3 | +| MSGs_TopiclistEvent | 8.3 | Topic Messaging Service | TS29538_MSGs_TopiclistEvent.yaml | Msgs-topiclistevent | A.7 | + +## 5.2 MSGs\_ASRegistration Service + +### 5.2.1 Service Description + +The MSGs\_ASRegistration API, as defined in 3GPP TS 23.554 [2], allows an AS via Mm5s interface to register, and deregister at a given MSGin5G Server. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operation defined for MSGs\_ASRegistration API is shown in the Table 5.2.2.1-1. + +Table 5.2.2.1-1: Operations of the MSGs\_ASRegistration API + +| Service operation name | Description | Initiated by | +|--------------------------------|--------------------------------------------------------------------------------------|--------------| +| MSGs_ASRegistration_Request | This service operation is used by the AS to register itself to MSGin5G Server. | AS | +| MSGs_ASRegistration_Deregister | This service operation is used by the AS to deregister itself from a MSGin5G Server. | AS | + +#### 5.2.2.2 MSGs\_ASRegistration\_Request + +##### 5.2.2.2.1 General + +This service operation is used by the AS to register itself to MSGin5G Server. + +##### 5.2.2.2.2 Application Server registering to MSGin5G Server using MSGs\_ASRegistration\_Request operation + +![Sequence diagram showing the AS registering to the MSGin5G Server. The AS sends a POST request to the MSGin5G Server, and the server responds with a 201 Created status.](9db324c513563a95ae55c77f4462a969_img.jpg) + +``` + +sequenceDiagram + participant AS + participant MSGin5G Server + Note left of AS: AS Registering to MSGin5G Server + AS->>MSGin5G Server: 1. POST .../registrations + MSGin5G Server-->>AS: 2. 201 Created + +``` + +Sequence diagram showing the AS registering to the MSGin5G Server. The AS sends a POST request to the MSGin5G Server, and the server responds with a 201 Created status. + +Figure 5.2.2.2.2-1: AS Registering to MSGin5G Server + +To register itself at the MSGin5G Server, the AS shall send an HTTP POST message to the MSGin5G Server on the "AS Registrations" collection resource. The body of the HTTP POST message shall include ASRegistration data structure that shall include: + +- the Application Server Identifier within the "asSvcId" attribute; and +- may include: + +- the Application Identifier within the "appId" attribute; +- the notification target URI within the "targetUri" attribute; and +- the Application Server Profile Information within the "asProf" attribute, that may include: + - the Application Server name within the "appName" attribute; + - the list of Application Providers name within the "appProviders" attribute; + - the list of Application scenarios within the "appScenarios" attribute; + - the list of Application Server category within the "appCategory" attribute; and + - the list of Application Server status within the "asStatus" attribute. + +Upon receiving the HTTP POST message from the AS, the MSGin5G Server shall: + +1. process the AS registration request information; +2. verify the identity of the AS and check if the AS is authorized to register itself at MSGin5G Server; and +3. if the AS is authorized to register to MSGin5G Server, then the MSGin5G Server shall: + - a. store the AS registration information and create a new resource with the AS registration information as specified in clause 8.1.2.1; and + - b. If the registration is successful, the MSGin5G Server shall respond to the AS with an HTTP "201 Created" status code, including an HTTP Location header field containing the URI of the created "AS Registration" resource and the response body containing ASRegistrationAck data structure that shall contain: + - the Application Server Identifier within the "asSvcId" attribute; and + - the registration result within the "result" attribute. + +If errors occur when processing the HTTP POST request, the MSGin5G Server shall apply error handling procedures as specified in clause 8.1.6. + +### 5.2.2.3 MSGS\_ASRegistration\_Deregister + +#### 5.2.2.3.1 General + +This service operation is used by the AS to deregister itself from a MSGin5G Server. + +#### 5.2.2.3.2 Application Server deregistering from MSGin5G Server using MSGS\_ASRegistration\_Deregister operation + +![Sequence diagram showing AS deregistering from MSGin5G Server. The AS sends a DELETE request to the MSGin5G Server, and the server responds with 200 OK or 204 No Content.](3f1987804d7d78bc3b3bc560e974280a_img.jpg) + +``` +sequenceDiagram + participant AS + participant MSGin5G Server + Note left of AS: AS Deregistering from MSGin5G Server + AS->>MSGin5G Server: 1. DELETE ../registrations/{registrationId} + MSGin5G Server-->>AS: 2. 200 OK or 204 No Content +``` + +Sequence diagram showing AS deregistering from MSGin5G Server. The AS sends a DELETE request to the MSGin5G Server, and the server responds with 200 OK or 204 No Content. + +**Figure 5.2.2.3.2-1: AS Deregistering from MSGin5G Server** + +To deregister itself from the MSGin5G Server, the AS shall send HTTP DELETE message to the MSGin5G Server on the "AS DeRegistration" collection resource, as specified in clause 8.1.2.3.3.2. + +Upon receiving the HTTP DELETE request, the MSGin5G Server shall: + +1. verify the identity of the AS and check if the AS is authorized to deregister the AS registration information; + +2. if the AS is authorized to deregister the AS registration information, then the MSGin5G Server shall deregister the AS profile from the MSGin5G Server and delete the resource representing AS registration information; and +3. return the HTTP "200 OK" status code to the AS, indicating the successful deregistration of the AS information and shall include ASRegistrationAck data structure within the response body or HTTP "204 No Content" status code to the AS. + +If errors occur when processing the HTTP DELETE request, the MSGin5G Server shall apply error handling procedures as specified in clause 8.1.6. + +## 5.3 MSGS\_MSGDelivery Service + +### 5.3.1 Service Description + +The MSGS\_MSGDelivery Service corresponding to Mm5s as defined in 3GPP TS 23.554 [2], is provided by the MSGin5G Server. + +This service: + +- allows AS invokes services provided by MSGin5G Server to send MSGin5G Messages and MSGin5G message delivery status reports to MSGin5G Server; and +- allows L3G/N3G invokes services provided by MSGin5G Server to send MSGin5G Messages and MSGin5G message delivery status reports to MSGin5G Server on behalf of Legacy 3GPP UE or Non-3GPP UE. +- allows BMG invokes services provided by MSGin5G Server to send MSGin5G message delivery status reports to MSGin5G Server. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operation defined for MSGS\_MSGDelivery Service is shown in the Table 5.3.2.1-1. + +**Table 5.3.2.1-1: Operations of the MSGS\_MSGDelivery Service** + +| Service operation name | Description | Initiated by | +|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| +| MSGS_MSGDelivery_ASODelivery | This service operation is used by AS to deliver MSGin5G message to the MSGin5G Server. This service operation corresponds to clause 9.1.1.1.2 as defined in 3GPP TS 23.554 [2]. | AS | +| MSGS_MSGDelivery_ASODeliveryReport | This service operation is used by AS to deliver the delivery status report to the MSGin5G Server. This service operation corresponds to clause 9.1.1.3.2 as defined in 3GPP TS 23.554 [2]. | AS | +| MSGS_MSGDelivery_UODelivery | This service operation is used by Legacy 3GPP Message Gateway or Non-3GPP Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) to deliver MSGin5G message to the MSGin5G Server. This service operation corresponds to clause 9.1.1.2.2 as defined in 3GPP TS 23.554 [2]. | Legacy 3GPP Message Gateway
Non-3GPP Message Gateway | +| MSGS_MSGDelivery_UODeliveryReport | This service operation is used by Message Gateway (on behalf Legacy 3GPP UE or Non-3GPP UE) to deliver the delivery status report to the MSGin5G Server. This service operation corresponds to clause 9.1.1.4.2 as defined in 3GPP TS 23.554 [2]. | Legacy 3GPP Message Gateway
Non-3GPP Message Gateway
Broadcast Message Gateway | + +### 5.3.2.2 MSGS\_MSGDelivery\_ASODelivery + +#### 5.3.2.2.1 General + +This service operation corresponding to clause 9.1.1.1.2 as defined in 3GPP TS 23.554 [2], is used by AS to deliver MSGin5G message to the MSGin5G Server. + +#### 5.3.2.2.2 AS Originating MSGin5G Message Delivery + +![Sequence diagram showing AS Originating MSGin5G Message Delivery. The AS sends a POST request to the MSGin5G Server, and the server responds with a 200 OK.](36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg) + +``` + +sequenceDiagram + participant AS + participant MSGin5G Server + Note left of AS: AS Originating MSGin5G Message Delivery + AS->>MSGin5G Server: 1. POST .../deliver-as-message + MSGin5G Server-->>AS: 2. 200 OK + +``` + +Sequence diagram showing AS Originating MSGin5G Message Delivery. The AS sends a POST request to the MSGin5G Server, and the server responds with a 200 OK. + +**Figure 5.3.2.2.2-1: AS Originating MSGin5G Message Delivery** + +When the AS needs to send the message to the MSGin5G Server, the AS shall send the HTTP POST method as step 1 of the Figure 5.3.2.2.2-1. + +The AS shall include ASMessageDelivery data structure in the content of the HTTP POST request. + +The ASMessageDelivery data structure shall include: + +- the AS Service ID within the "oriAddr" attribute; + - the Recipient Address within the "destAddr" attribute; + - the Message ID within the "msgId" attribute; + - the store and forward flag within the "stoAndFwInd" attribute; and +- may include: +- the Application ID within the "appId" attribute; + - the indication whether the message delivery status report is required within the "delivStReqInd" attribute; + - the Payload within the "payload" attribute; + - the priority type within the "priority" attribute; + - the message segment flag within the "segInd" attribute; + - the message segment parameters within the "segParams" attribute, this attribute may include: + - the segmentation set identifier within the "segId" attribute; + - the total number of message segments within the "totalSegCount" attribute; + - the message segment number within the "segNumb" attribute; and + - the last segment flag within the "lastSegFlag" attribute; + - the store and forward parameters within the "stoAndFwParams" attribute, this attribute may include: + - the message expiration time within the "exprTime" attribute; + - The latency within the "latency" attribute. + +When the MSGin5G Server receives the HTTP POST request from the AS, the MSGin5G Server shall make an authorization based on the information received from the AS. If the authorization is successful, the MSGin5G Server shall respond to the AS with a 200 OK message. + +If errors occur when processing the HTTP POST request, the MSGin5G Server shall apply error handling procedures as specified in clause 8.2.6. + +### 5.3.2.3 MSGS\_MSGDelivery\_ASODeliveryReport + +#### 5.3.2.3.1 General + +This service operation corresponds to clause 9.1.1.3.2 as defined in 3GPP TS 23.554 [2], is used by AS to deliver the delivery status report to the MSGin5G Server. + +#### 5.3.2.3.2 AS Originating Message Delivery Status Report + +![Sequence diagram showing the AS Originating Message Delivery Status Report. The AS sends a POST .../deliver-report to the MSGin5G Server, and the MSGin5G Server responds with a 200 OK.](51db757d054ce1ce83c436a3578b56ca_img.jpg) + +``` +sequenceDiagram + participant AS + participant MSGin5G Server + Note left of AS: AS Originating Message Delivery Status Report + AS->>MSGin5G Server: 1. POST .../deliver-report + MSGin5G Server-->>AS: 2. 200 OK +``` + +Sequence diagram showing the AS Originating Message Delivery Status Report. The AS sends a POST .../deliver-report to the MSGin5G Server, and the MSGin5G Server responds with a 200 OK. + +Figure 5.3.2.3.2-1: AS Originating MSGin5G Delivery Report + +When the AS needs to send the delivery report to the MSGin5G Server, the AS shall send the HTTP POST method as step 1 of the Figure 5.3.2.3.2-1. + +The AS shall include DeliveryStatusReport data structure in the content of the HTTP POST request. + +The DeliveryStatusReport data structure shall include: + +- the AS Service ID within the "oriAddr" attribute; + - the Recipient Address within the "destAddr" attribute; + - the Message ID within the "msgId" attribute; + - the delivery status within the "delivSt" attribute; and +- may include: +- the failure cause within the "failureCause" attribute; + +When the MSGin5G Server receives the HTTP POST request from the AS, the MSGin5G Server shall make an authorization based on the information received from the AS. If the authorization is successful, the MSGin5G Server shall respond to the AS with a 200 OK message. + +If errors occur when processing the HTTP POST request, the MSGin5G Server shall apply error handling procedures as specified in clause 8.2.6. + +### 5.3.2.4 MSGS\_MSGDelivery\_UEODelivery + +#### 5.3.2.4.1 General + +This service operation corresponds to clause 9.1.1.2.2 as defined in 3GPP TS 23.554 [2], is used by Legacy 3GPP Message Gateway or Non-3GPP Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) to deliver MSGin5G message to the MSGin5G Server. + +### 5.3.2.4.2 UE Originating Message Delivery + +![Sequence diagram showing UE Originating Message Delivery. A box on the left contains 'Legacy 3GPP Message Gateway' and 'Non-3GPP Message Gateway'. A box on the right contains 'MSGin5G Server'. Step 1: An arrow points from the left box to the right box with the text '1. POST ../deliver-ue-message'. Step 2: An arrow points from the right box back to the left box with the text '2. 200 OK'.](10781f43062bf3e9601a1e086710556c_img.jpg) + +``` + +sequenceDiagram + participant Gateway as Legacy 3GPP Message Gateway +Non-3GPP Message Gateway + participant Server as MSGin5G Server + Note left of Gateway: + Gateway->>Server: 1. POST ../deliver-ue-message + Note right of Server: + Server-->>Gateway: 2. 200 OK + Note left of Gateway: + +``` + +Sequence diagram showing UE Originating Message Delivery. A box on the left contains 'Legacy 3GPP Message Gateway' and 'Non-3GPP Message Gateway'. A box on the right contains 'MSGin5G Server'. Step 1: An arrow points from the left box to the right box with the text '1. POST ../deliver-ue-message'. Step 2: An arrow points from the right box back to the left box with the text '2. 200 OK'. + +**Figure 5.3.2.4.2-1: Legacy 3GPP UE or Non-3GPP UE Originating MSGin5G Message Delivery** + +When the Legacy 3GPP Message Gateway or Non-3GPP Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) needs to send the message to the MSGin5G Server, the Legacy 3GPP Message Gateway or Non-3GPP Message Gateway shall send the HTTP POST method as step 1 of the Figure 5.3.2.4.2-1. + +The Legacy 3GPP Message Gateway or Non-3GPP Message Gateway shall include UEMessageDelivery data structure in the content of the HTTP POST request. + +The UEMessageDelivery data structure shall include: + +- the Originating UE Service ID within the "oriAddr" attribute; +- the Recipient Address within the "destAddr" attribute; +- the Message ID within the "msgId" attribute; and +- the store and forward flag within the "stoAndFwInd" attribute; + +and may include: + +- the Application ID within the "appId" attribute; +- the Payload within the "payload" attribute; +- the indication whether the message delivery status report is required within the "delivStReqInd" attribute; and +- the message segment flag within the "segInd" attribute; +- the message segment parameters within the "segParams" attribute, this attribute may include: + - the segmentation set identifier within the "segId" attribute; + - the total number of message segments within the "totalSegCount" attribute; + - the message segment number within the "segNumb" attribute; + - the last segment flag within the "lastSegFlag" attribute; +- the store and forward parameters within the "stoAndFwParams" attribute, this attribute may include: + - the message expiration time within the "exprTime" attribute; + +When the MSGin5G Server receives the HTTP POST request from the Legacy 3GPP Message Gateway or Non-3GPP Message Gateway, the MSGin5G Server shall make an authorization based on the information received from the Legacy 3GPP Message Gateway or Non-3GPP Message Gateway. If the authorization is successful, the MSGin5G Server shall respond to the Legacy 3GPP Message Gateway or Non-3GPP Message Gateway with a 200 OK message. + +If errors occur when processing the HTTP POST request, the MSGin5G Server shall apply error handling procedures as specified in clause 8.2.6. + +### 5.3.2.5 MSGS\_MSGDelivery\_UEODeliveryReport + +#### 5.3.2.5.1 General + +This service operation corresponds to clause 9.1.1.4.2 as defined in 3GPP TS 23.554 [2], is used by Message Gateway (on behalf Legacy 3GPP UE or Non-3GPP UE) to deliver the delivery status report to the MSGin5G Server. + +#### 5.3.2.5.2 UE Originating Message Delivery Status Report + +![Sequence diagram showing the interaction between a Message Gateway and an MSGin5G Server for a delivery report. The Message Gateway sends a POST request to the MSGin5G Server, and the MSGin5G Server responds with a 200 OK.](e636d7ccca0ad14c6b95201404324823_img.jpg) + +``` +sequenceDiagram + participant MG as Message Gateway + participant MS as MSGin5G Server + Note left of MG: + MG->>MS: 1. POST .../deliver-report + Note right of MS: + MS-->>MG: 2. 200 OK + Note left of MG: +``` + +Sequence diagram showing the interaction between a Message Gateway and an MSGin5G Server for a delivery report. The Message Gateway sends a POST request to the MSGin5G Server, and the MSGin5G Server responds with a 200 OK. + +**Figure 5.3.2.5.2-1: Legacy 3GPP UE or Non-3GPP UE Originating MSGin5G Delivery Report** + +When the Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) needs to send the delivery report to the MSGin5G Server, the Message Gateway shall send the HTTP POST method as step 1 of the Figure 5.3.2.5.2-1. + +The Message Gateway shall include *DeliveryStatusReport* data structure in the content of the HTTP POST request. + +The *DeliveryStatusReport* data structure shall include: + +- the Originating UE Service ID within the "oriAddr" attribute; +- the Recipient Address within the "destAddr" attribute; +- the Message ID within the "msgId" attribute; and +- the delivery status within the "delivSt" attribute; + +and may include: + +- The failure cause within the "failureCause" attribute; + +When the MSGin5G Server receives the HTTP POST request from the Message Gateway, the MSGin5G Server shall make an authorization based on the information received from the Message Gateway. If the authorization is successful, the MSGin5G Server shall respond to the Message Gateway with a 200 OK message. + +If errors occur when processing the HTTP POST request, the MSGin5G Server shall apply error handling procedures as specified in clause 8.2.6. + +## 5.4 MSGS\_TopiclistEvent + +### 5.4.1 Service Description + +The MSGS\_TopiclistEvent API Service corresponding to Mm5s as defined in 3GPP TS 23.554 [2], is provided by the MSGin5G Server. + +This service: + +- allows another MSGin5G Server invokes services provided by MSGin5G Server to subscribe or unsubscribe to MSGin5G Messaging Topic; +- allows another MSGin5G Server invokes services provided by MSGin5G Server to subscribe or unsubscribe to MSGin5G Messaging Topic list; +- allows another MSGin5G Server invokes services provided by MSGin5G Server to notify changes of MSGin5G Messaging Topic list; + +## 5.4.2 Service Operations + +### 5.4.2.1 Introduction + +The service operation defined for MSGS\_TopiclistEvent service is shown in the Table 5.4.2.1-1, corresponds to clause 9.1.1.6 as defined in 3GPP TS 23.554 [2]. + +**Table 5.4.2.1-1: Operations of the MSGS\_TopiclistEvent Service** + +| Service operation name | Description | Initiated by | +|---------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| MSGS_TopiclistEvent_SubscribeMSGTopiclist | This service operation is used by MSGin5G Server to subscribe to Messaging Topic list on another MSGin5G Server. | MSGin5G Server | +| MSGS_TopiclistEvent_UnsubscribeMSGTopiclist | This service operation is used by MSGin5G Server to unsubscribe to Messaging Topic list on another MSGin5G Server. | MSGin5G Server | +| MSGS_TopiclistEvent_NotifyMSGTopiclist | This service operation is used by MSGin5G Server, to deliver the notification of Messaging Topic list changes. | MSGin5G Server | +| MSGS_TopiclistEvent_SubscribeMSGTopic | This service operation is used by MSGin5G Server (on behalf of Application Server or MSGin5G Client) to subscribe to Messaging Topic on the MSGin5G Server. | MSGin5G Server | +| MSGS_TopiclistEvent_UnsubscribeMSGTopic | This service operation is used by MSGin5G Server(on behalf of Application Server or MSGin5G Client) to unsubscribe to Messaging Topic on the MSGin5G Server. | MSGin5G Server | + +### 5.4.2.2 MSGS\_TopiclistEvent\_SubscribeMSGTopiclist + +#### 5.4.2.2.1 General + +This service operation is used by MSGin5G Server to subscribe to Messaging Topic list on another MSGin5G Server, corresponds to clause 9.1.1.6.2 as defined in 3GPP TS 23.554 [2]. + +#### 5.4.2.2.2 MSGin5G Server subscribing to MSGin5G Messaging Topic List + +![Sequence diagram showing MSGin5G Server 1 sending a POST request to MSGin5G Server 2 for topic list subscriptions, and Server 2 responding with a 201 Created status.](35127fe87029df6f5f0b2ee85f6193f1_img.jpg) + +``` + +sequenceDiagram + participant MSGin5G Server 1 + participant MSGin5G Server 2 + Note left of MSGin5G Server 1: + MSGin5G Server 1->>MSGin5G Server 2: 1. POST ../topiclist-subscriptions + Note right of MSGin5G Server 2: + MSGin5G Server 2-->>MSGin5G Server 1: 2. 201 Created + +``` + +Sequence diagram showing MSGin5G Server 1 sending a POST request to MSGin5G Server 2 for topic list subscriptions, and Server 2 responding with a 201 Created status. + +**Figure 5.4.2.2.2-1: MSGin5G Server Subscribing to Messaging Topic List** + +To subscribe MSGin5G Messaging Topic list on another MSGin5G Server 2, the MSGin5G Server 1 shall send an HTTP POST message to the MSGin5G Server 2 on the "Topic List Subscription" collection resource. The body of the HTTP POST message shall include TopicListSubscription data structure that shall include: + +- the Originating MSGin5G Server ID within the "oriAddr" attribute; + - the Recipient MSGin5G Server ID within the "destAddr" attribute; + - a notification target address within the "notificationURI" attribute; + - a supported features attribute if at least one feature defined is supported; and +- may include: +- the Expiration within the "exprTime" attribute; + +- the security credentials within the "secCred" attribute. + +Upon receiving the HTTP POST message from the MSGin5G Server 1, the MSGin5G Server 2 shall: + +1. make an authorization based on the information received from MSGin5G Server 1; +2. checks the locally stored Messaging Topic list subscription(s): + - a. If the MSGin5G Server 1's subscription has already been created, the MSGin5G Server 2 updates the validity time of this subscription; + - b. If the MSGin5G Server 1's subscription has not been created, the MSGin5G Server 2 creates new subscription; and + +If the subscription request is successfully processed, the MSGin5G Server 2 shall respond to the MSGin5G Server 1 with an HTTP "201 Created" status code, including an HTTP Location header field containing the URI of the created "Topic List Subscription" resource and the response body containing TopicListSubscriptionAck data structure that shall contain: + +- the Subscription Status within the "subStat" attribute; +- a supported features attribute if at least one feature defined is supported; and may contain +- the Expiration within the "exprTime" attribute. + +If errors occur when processing the HTTP POST request, the MSGin5G Server 2 shall apply error handling procedures as specified in clause 8.3.6. + +#### 5.4.2.3 MSGS\_TopiclistEvent\_UnsubscribeMSGTopiclist + +##### 5.4.2.3.1 General + +This service operation is used by MSGin5G Server to subscribe to Messaging Topic list on another MSGin5G Server, corresponds to clause 9.1.1.6.2 as defined in 3GPP TS 23.554 [2]. + +##### 5.4.2.3.2 MSGin5G Server Unsubscribing to MSGin5G Messaging Topic List + +![Sequence diagram showing MSGin5G Server 1 sending a POST request to MSGin5G Server 2 for unsubscribing, and Server 2 responding with 204 No Content or 200 OK.](8ed7f57cc317f6574bec781d01ae6ad2_img.jpg) + +``` +sequenceDiagram + participant MSGin5G Server 1 + participant MSGin5G Server 2 + Note left of MSGin5G Server 1: Unsubscribing to Messaging Topic List + MSGin5G Server 1->>MSGin5G Server 2: 1. POST .../topiclist-subscriptions/{subscriptionId} + MSGin5G Server 2-->>MSGin5G Server 1: 2. 204 No Content or 200 OK +``` + +Sequence diagram showing MSGin5G Server 1 sending a POST request to MSGin5G Server 2 for unsubscribing, and Server 2 responding with 204 No Content or 200 OK. + +**Figure 5.4.2.3.2-1: MSGin5G Server Unsubscribing to Messaging Topic List** + +As shown in Figure 5.4.2.3.2-1, to unsubscribe MSGin5G Messaging Topic list on the MSGin5G Server 2, the MSGin5G Server 1 shall send HTTP POST message to the MSGin5G Server 2 on the "Individual Topic List Subscription" collection resource, where "{subscriptionId}" is the identifier of the existing Messaging Topic list subscription that is to be deleted. The body of the HTTP POST message shall include TopicListUnsubscription data structure that shall include: + +- the Originating MSGin5G Server ID within the "oriAddr" attribute; + - the Recipient MSGin5G Server ID within the "destAddr" attribute; and +- may include: +- the security credentials within the "secCred" attribute. + +Upon receiving the HTTP POST message from the MSGin5G Server 1, the MSGin5G Server 2 shall make an authorization based on the information received. If the authorization is successful, the MSGin5G Server 2 shall remove the corresponding subscription. If the unsubscription request is successfully processed, the MSGin5G Server 2 shall respond to the MSGin5G Server 1 with an HTTP "204 No Content" status code. If the subscription is not successfully deleted, the MSGin5G Server 2 shall respond to the MSGin5G Server 1 with an HTTP "200 OK" status code, and the response body containing TopicListUnsubscriptionAck data structure that shall contain: + +- the Unsubscripoin Status within the "subStat" attribute. + +If errors occur when processing the HTTP POST request, the MSGin5G Server 2 shall apply error handling procedures as specified in clause 8.3.6. + +#### 5.4.2.4 MSGS\_TopiclistEvent\_NotifyMSGTopiclist + +##### 5.4.2.4.1 General + +This service operation is used by MSGin5G Server 1 to notify another MSGin5G Server 2 about changes of Messaging Topic list, corresponds to clause 9.1.1.6.3 as defined in 3GPP TS 23.554 [2]. + +##### 5.4.2.4.2 Notification about MSGin5G Messaging Topic List + +![Sequence diagram showing MSGin5G Server 1 sending a POST {notificationURI} request to MSGin5G Server 2, and Server 2 responding with a 204 No Content message.](f0b7aaa539a2f77c98d53ed6c1c2366b_img.jpg) + +``` +sequenceDiagram + participant MSGin5G Server 1 + participant MSGin5G Server 2 + Note left of MSGin5G Server 1: 5.4.2.4.2 Notification about MSGin5G Messaging Topic List + MSGin5G Server 1->>MSGin5G Server 2: 1. POST {notificationURI} + MSGin5G Server 2-->>MSGin5G Server 1: 2. 204 No Content +``` + +Sequence diagram showing MSGin5G Server 1 sending a POST {notificationURI} request to MSGin5G Server 2, and Server 2 responding with a 204 No Content message. + +**Figure 5.4.2.4.2-1:MSGin5G Server Notification about Messaging Topic List** + +As shown in Figure 5.4.2.4.2-1, the MSGin5G Server 1 shall invoke the MSGS\_TopiclistEvent\_NotifyMSGTopiclist service operation to notify about subscribed Messaging Topic list events. The MSGin5G Server 1 shall send HTTP POST request to the MSGin5G Server 2 with "{notificationURI}" previously received in the subscription. The TopicListNotification data structure provided in the request body shall include: + +- The Messaging Topic list exists in MSGin5G Server 1 within the "msgTopicList" attribute, this attribute may include: + - the unique topic identifier within the "msgTopics" attribute; + - the topic update status indicating if such topic is newly created or deleted within the "updateStat" attribute; and + +may include: + +- the Expiration within the "exprTime" attribute; + +Upon receiving the HTTP POST message from the MSGin5G Server 1, the MSGin5G Server 2 shall make an authorization based on the information received. If the authorization is successful, the MSGin5G Server 2 shall update locally stored Messaging Topic list, and respond to the MSGin5G Server 1 with an HTTP "204 No Content" status code. + +If errors occur when processing the HTTP POST request, the MSGin5G Server 2 shall apply error handling procedures as specified in clause 8.3.6. + +#### 5.4.2.5 MSGS\_TopiclistEvent\_SubscribeMSGTopic + +##### 5.4.2.5.1 General + +This service operation is used by MSGin5G Server 1 to subscribe to Messaging Topic on another MSGin5G Server 2, corresponding to clause 9.1.1.6.4 as defined in 3GPP TS 23.554 [2]. + +#### 5.4.2.5.2 MSGin5G Server Subscribing to MSGin5G Messaging Topic + +![Sequence diagram showing MSGin5G Server 1 sending a POST request to MSGin5G Server 2 and receiving a 200 OK response.](4b87467ad9642943235f48f7d4b59449_img.jpg) + +``` + +sequenceDiagram + participant S1 as MSGin5G Server 1 + participant S2 as MSGin5G Server 2 + Note left of S1: + S1->>S2: 1. POST .../request-topic-subscription + Note right of S2: + S2-->>S1: 2. 200 OK + Note left of S1: + +``` + +Sequence diagram showing MSGin5G Server 1 sending a POST request to MSGin5G Server 2 and receiving a 200 OK response. + +**Figure 5.4.2.5.2-1: Subscribing to Messaging Topic List** + +As shown in Figure 5.4.2.5.2-1, to subscribe MSGin5G Messaging Topic on the MSGin5G Server 2, the MSGin5G Server 1 shall send the HTTP POST method. The body of the HTTP POST message shall include TopicSubscription data structure that shall include: + +- the originating UE Service ID/AS Service ID if the MSGin5G Server forwards the request, or the Service ID of MSGin5G Server subscribing topic on behalf of all MSGin5G Clients and Application Servers served by it within the "oriAddr" attribute + - the requested list of Messaging Topic(s) within the "msgTopics" attribute; + - the security credentials within the "secCred" attribute; and +- may include: +- the Expiration within the "exprTime" attribute; + +Upon receiving the HTTP POST message, the MSGin5G Server 2 shall: + +1. make an authorization based on the information received; +2. checks the locally stored Messaging Topic subscription(s): + - a. If the requested subscription has already been created, the MSGin5G Server 2 updates the validity time of this subscription; + - b. If the requested subscription has not been created, the MSGin5G Server 2 creates new subscription; and + +If the subscription request is successfully processed, the MSGin5G Server 2 shall respond with an HTTP "200 OK" status code. The response body containing TopicSubscriptionAck data structure that shall contain: + +- the Subscription Status within the "subStat" attribute; and may contain +- the Expiration within the "exprTime" attribute. + +If errors occur when processing the HTTP POST request, the MSGin5G Server 2 shall apply error handling procedures as specified in clause 8.3.6. + +#### 5.4.2.6 MSGS\_TopiclistEvent\_SubscribeMSGTopic + +##### 5.4.2.6.1 General + +This service operation is used by MSGin5G Server to unsubscribe to Messaging Topic(s) on another MSGin5G Server, corresponding to clause 9.1.1.6.4 as defined in 3GPP TS 23.554 [2]. + +#### 5.4.2.6.2 MSGin5G Server Unsubscribing to MSGin5G Messaging Topic + +![Sequence diagram showing MSGin5G Server 1 sending a POST request to MSGin5G Server 2, which responds with a 204 No Content.](e354b57563dae469c00b412b2abdf765_img.jpg) + +``` + +sequenceDiagram + participant S1 as MSGin5G Server 1 + participant S2 as MSGin5G Server 2 + Note left of S1: Unsubscribe + S1->>S2: 1. POST .../request-topic-unsubscription + S2-->>S1: 2. 204 No Content + +``` + +Sequence diagram showing MSGin5G Server 1 sending a POST request to MSGin5G Server 2, which responds with a 204 No Content. + +**Figure 5.4.2.6.2-1: Unsubscribing to Messaging Topic(s)** + +As shown in Figure 5.4.2.6.2-1, to unsubscribe one or more MSGin5G Messaging Topic(s) on the MSGin5G Server 2, the MSGin5G Server 1 shall send HTTP POST message to the MSGin5G Server 2. The body of the HTTP POST message shall include TopicUnsubscription data structure that shall include: + +- the originating UE Service ID/AS Service ID if the MSGin5G Server forwards the request, or the Service ID of MSGin5G Server unsubscribing topic on behalf of all MSGin5G Clients and Application Servers served by it within the "oriAddr" attribute; + - the requested list of Messaging Topic(s) within the "msgTopics" attribute; + - the security credentials within the "secCred" attribute; and +- may include: +- the Expiration within the "exprTime" attribute; + +Upon receiving the HTTP POST message, the MSGin5G Server 2 shall make an authorization based on the information received. If the authorization is successful, the MSGin5G Server 2 shall remove the corresponding subscription and respond with an HTTP "204 No Content" status code. + +If errors occur when processing the HTTP POST request, the MSGin5G Server 2 shall apply error handling procedures as specified in clause 8.3.6. + +## 6 Services offered by the Message Gateway + +### 6.1 Introduction + +The Table 6.1-1 lists the services provided by the MSGin5G Message Gateway and corresponding service operations. A service description clause for each API gives a general description of the related API. + +**Table 6.1-1 List of services provided by the MSGin5G Message Gateway** + +| Service Name | Service Operations | Operation Semantics | Example Consumer(s) | +|------------------|-----------------------------------|---------------------|---------------------| +| MSGG_L3GDelivery | MSGG_L3GDelivery_GTDelivery | Request/Response | MSGin5G Server | +| | MSGG_L3GDelivery_GTDeliveryReport | | | +| MSGG_N3GDelivery | MSGG_N3GDelivery_GTDelivery | Request/Response | MSGin5G Server | +| | MSGG_N3GDelivery_GTDeliveryReport | | | +| MSGG_BGDelivery | MSGG_BGDelivery_GTDelivery | Request/Response | MSGin5G Server | + +Table 6.1-2 summarizes the corresponding APIs defined in this specification. + +Table 6.1-2: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Anne
x | +|------------------|--------|------------------------------|-------------------------------|------------------|-----------| +| MSGG_L3GDelivery | 9.1 | L3G Message Delivery Service | TS29538_MSGG_L3GDelivery.yaml | msgg-l3gdelivery | A.4 | +| MSGG_N3GDelivery | 9.2 | N3G Message Delivery Service | TS29538_MSGG_N3GDelivery.yaml | msgg-n3gdelivery | A.5 | +| MSGG_BGDelivery | 9.3 | BMG Message Delivery Service | TS29538_MSGG_BGDelivery.yaml | msgg-bgdelivery | A.6 | + +## 6.2 MSGG\_L3GDelivery Service + +### 6.2.1 Service Description + +The MSGG\_L3GDelivery Service corresponding to MI3g as defined in 3GPP TS 23.554 [2], is provided by the Legacy 3GPP Message Gateway. + +This service: + +- allows MSGin5G Server invokes services provided by Legacy 3GPP Message Gateway to send MSGin5G Messages to Legacy 3GPP Message Gateway. + +### 6.2.2 Service Operations + +#### 6.2.2.1 Introduction + +The service operation defined for MSGG\_L3GDelivery Service is shown in the table 6.2.2.1-1. + +Table 6.2.2.1-1: Operations of the MSGG\_L3GDelivery Service + +| Service operation name | Description | Initiated by | +|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| MSGG_L3GDelivery_GTDelivery | This service operation is used by MSGin5G Server to deliver MSGin5G message to Legacy 3GPP Message Gateway. This service operation corresponds to clause 9.2.1.1.2 as defined in 3GPP TS 23.554 [2]. | MSGin5G Server | +| MSGG_L3GDelivery_GTDeliveryReport | This service operation is used by MSGin5G Server to deliver the delivery status report to Legacy 3GPP Message Gateway. This service operation corresponds to clause 9.2.1.3.2 as defined in 3GPP TS 23.554 [2]. | MSGin5G Server | + +#### 6.2.2.2 MSGG\_L3GDelivery\_GTDelivery + +##### 6.2.2.2.1 General + +This service operation corresponds to clause 9.2.1.1.2 as defined in 3GPP TS 23.554 [2], is used by MSGin5G Server to deliver MSGin5G message to the Legacy 3GPP Message Gateway. + +## 6.2.2.2.2 Legacy 3GPP Message Gateway Terminating Message Delivery + +![Sequence diagram showing the interaction between MSGin5G Server and Legacy 3GPP Message Gateway for message delivery. The MSGin5G Server sends a POST request to the Legacy 3GPP Message Gateway, which responds with a 204 No Content.](e90987faabad6a6665cd8ed1151dc474_img.jpg) + +``` + +sequenceDiagram + participant MSGin5G Server + participant Legacy 3GPP Message Gateway + Note left of MSGin5G Server: MSGin5G Server + Note right of Legacy 3GPP Message Gateway: Legacy 3GPP Message Gateway + MSGin5G Server->>Legacy 3GPP Message Gateway: 1. POST .../deliver-message + Legacy 3GPP Message Gateway-->>MSGin5G Server: 2. 204 No Content + +``` + +Sequence diagram showing the interaction between MSGin5G Server and Legacy 3GPP Message Gateway for message delivery. The MSGin5G Server sends a POST request to the Legacy 3GPP Message Gateway, which responds with a 204 No Content. + +**Figure 6.2.2.2.2-1: Legacy 3GPP Message Gateway Terminating Message Delivery** + +When the MSGin5G Server needs to send the message to the Legacy 3GPP Message Gateway, the MSGin5G Server shall send the HTTP POST request towards the "deliver-message" resource as shown in Figure 6.2.2.2.2-1. + +The MSGin5G Server shall send a POST request to the resource with an L3gMessageDelivery object in the request body. + +The L3gMessageDelivery data type shall include: + +- the Originating UE Service ID/AS Service ID within the "oriAddr" attribute; +- the Recipient UE Service ID within the "destAddr" attribute; +- the Message ID within the "msgId" attribute; and + +may include: + +- the Application ID within the "appId" attribute; +- the indication whether the message delivery status report is required within the "delivStReqInd" attribute; +- the Payload within the "payload" attribute; +- the Message is segmented within the "segInd" attribute; and +- the message segment parameters within the "segParams" attribute, this attribute may include: + - the segmentation set identifier within the "segId" attribute; + - the total number of message segments within the "totalSegCount" attribute; + - the message segment number within the "segNumb" attribute; and + - the last segment flag within the "lastSegFlag" attribute. + +When the Legacy 3GPP Message Gateway receives the HTTP POST request from the MSGin5G Server, the Legacy 3GPP Message Gateway shall respond to the MSGin5G Server with a 204 No Content message. + +If errors occur when processing the HTTP POST request, the Legacy 3GPP Message Gateway shall apply error handling procedures as specified in clause 9.1.6. + +## 6.2.2.3 MSGG\_L3GDelivery\_GTDeliveryReport + +### 6.2.2.3.1 General + +This service operation corresponds to clause 9.2.1.3.2 as defined in 3GPP TS 23.554 [2], is used by MSGin5G Server to deliver the delivery status report to the Legacy 3GPP Message Gateway. + +### 6.2.2.3.2 Legacy 3GPP Message Gateway Terminating Message Delivery Status Report + +![Sequence diagram showing the interaction between MSGin5G Server and Legacy 3GPP Message Gateway for a delivery status report.](eb5677b570ab2a3e9d8f5d35ca5b8a4d_img.jpg) + +``` +sequenceDiagram + participant MSGin5G Server + participant Legacy 3GPP Message Gateway + Note left of MSGin5G Server: MSGin5G Server + Note right of Legacy 3GPP Message Gateway: Legacy 3GPP Message Gateway + MSGin5G Server->>Legacy 3GPP Message Gateway: 1. POST ../deliver-report + Legacy 3GPP Message Gateway-->>MSGin5G Server: 2. 204 No Content +``` + +Sequence diagram showing the interaction between MSGin5G Server and Legacy 3GPP Message Gateway for a delivery status report. + +**Figure 6.2.2.3.2-1: Legacy 3GPP Message Gateway Terminating Delivery Status Report** + +When the MSGin5G Server needs to send the delivery status report to the Legacy 3GPP Message Gateway, the MSGin5G Server shall send the HTTP POST request towards the "deliver-report" resource as shown in Figure 6.2.2.3.2-1. + +The MSGin5G Server shall send a POST request to the resource with a *DeliveryStatusReport* object in the request body. + +The *DeliveryStatusReport* data type shall include: + +- the Originating UE Service ID/AS Service ID within the "oriAddr" attribute; +- the Recipient UE Service ID within the "destAddr" attribute; +- the Message ID within the "msgId" attribute; +- the delivery status within the "delivSt" attribute; and + +may include: + +- the failure cause within the "failureCause" attribute. + +When the Legacy 3GPP Message Gateway receives the HTTP POST request from the MSGin5G Server, the Legacy 3GPP Message Gateway shall respond to the MSGin5G Server with a 204 No Content message. + +If errors occur when processing the HTTP POST request, the Legacy 3GPP Message Gateway shall apply error handling procedures as specified in clause 9.1.6. + +## 6.3 MSGG\_N3GDelivery Service + +### 6.3.1 Service Description + +The MSGG\_N3GDelivery Service corresponding to Mn3g as defined in 3GPP TS 23.554 [2], is provided by the Non-3GPP Message Gateway. + +This service: + +- allows MSGin5G Server invokes services provided by Non-3GPP Message Gateway to send MSGin5G Messages to Non-3GPP Message Gateway. + +### 6.3.2 Service Operations + +#### 6.3.2.1 Introduction + +The service operation defined for MSGG\_N3GDelivery Service is shown in the table 6.3.2.1-1. + +Table 6.3.2.1-1: Operations of the MSGG\_N3GDelivery Service + +| Service operation name | Description | Initiated by | +|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| MSGG_N3GDelivery_GTDelivery | This service operation is used by MSGin5G Server to deliver MSGin5G message to Non-3GPP Message Gateway. This service operation corresponds to clause 9.2.2.1.2 as defined in 3GPP TS 23.554 [2]. | MSGin5G Server | +| MSGG_N3GDelivery_GTDeliveryReport | This service operation is used by MSGin5G Server to deliver the delivery status report to Non-3GPP Message Gateway. This service operation corresponds to clause 9.2.2.2.2 as defined in 3GPP TS 23.554 [2]. | MSGin5G Server | + +## 6.3.2.2 MSGG\_N3GDelivery\_GTDelivery + +### 6.3.2.2.1 General + +This service operation corresponds to clause 9.2.2.1.2 as defined in 3GPP TS 23.554 [2], is used by MSGin5G Server to deliver MSGin5G message to the Non-3GPP Message Gateway. + +### 6.3.2.2.2 Non-3GPP Message Gateway Terminating Message Delivery + +![Sequence diagram showing the interaction between MSGin5G Server and Non-3GPP Message Gateway for message delivery. The MSGin5G Server sends a POST request to the Non-3GPP Message Gateway, and the Non-3GPP Message Gateway responds with a 204 No Content.](e9b43ac020435f8121e8592f31afdc52_img.jpg) + +``` + +sequenceDiagram + participant MSGin5G Server + participant Non-3GPP Message Gateway + Note left of MSGin5G Server: MSGin5G Server + Note right of Non-3GPP Message Gateway: Non-3GPP Message Gateway + MSGin5G Server->>Non-3GPP Message Gateway: 1. POST .../deliver-message + Non-3GPP Message Gateway-->>MSGin5G Server: 2. 204 No Content + +``` + +Sequence diagram showing the interaction between MSGin5G Server and Non-3GPP Message Gateway for message delivery. The MSGin5G Server sends a POST request to the Non-3GPP Message Gateway, and the Non-3GPP Message Gateway responds with a 204 No Content. + +Figure 6.3.2.2.2-1: Non-3GPP Message Gateway Terminating Message Delivery + +When the MSGin5G Server needs to send the message to the Non-3GPP Message Gateway, the MSGin5G Server shall send the HTTP POST request towards the "deliver-message" resource as shown in figure 6.3.2.2.2-1. + +The MSGin5G Server shall send a POST request to the resource with an N3gMessageDelivery object in the request body. + +The N3gMessageDelivery data type shall include: + +- the Originating UE Service ID/AS Service ID within the "oriAddr" attribute; +- the Recipient UE Service ID within the "destAddr" attribute; +- the Message ID within the "msgId" attribute; and + +may include: + +- the Application ID within the "appId" attribute; +- the indication whether the message delivery status report is required within the "delivStReqInd" attribute; +- the Payload within the "payload" attribute; +- the Message is segmented within the "segInd" attribute; and +- the message segment parameters within the "segParams" attribute, this attribute may include: + - the segmentation set identifier within the "segId" attribute; + - the total number of message segments within the "totalSegCount" attribute; + +- the message segment number within the "segNumb" attribute; and +- the last segment flag within the "lastSegFlag" attribute. + +When the Non-3GPP Message Gateway receives the HTTP POST request from the MSGin5G Server, the Non-3GPP Message Gateway shall respond to the MSGin5G Server with a 204 No Content message. + +If errors occur when processing the HTTP POST request, the Non-3GPP Message Gateway shall apply error handling procedures as specified in clause 9.2.6. + +### 6.3.2.3 MSGG\_N3GDelivery\_GTDeliveryReport + +#### 6.3.2.3.1 General + +This service operation corresponds to clause 9.2.2.2.2 as defined in 3GPP TS 23.554 [2], is used by MSGin5G Server to deliver the delivery status report to the Non-3GPP Message Gateway. + +#### 6.3.2.3.2 Non-3GPP Message Gateway Terminating Message Delivery Status Report + +![Sequence diagram showing the interaction between MSGin5G Server and Non-3GPP Message Gateway for a delivery status report. The MSGin5G Server sends a POST request to the Non-3GPP Message Gateway, and the Non-3GPP Message Gateway responds with a 204 No Content message.](17a1ba23b641c01871b08f0a4f08ef48_img.jpg) + +``` +sequenceDiagram + participant MSGin5G Server + participant Non-3GPP Message Gateway + Note left of MSGin5G Server: MSGin5G Server + Note right of Non-3GPP Message Gateway: Non-3GPP Message Gateway + MSGin5G Server->>Non-3GPP Message Gateway: 1. POST ../deliver-report + Non-3GPP Message Gateway-->>MSGin5G Server: 2. 204 No Content +``` + +Sequence diagram showing the interaction between MSGin5G Server and Non-3GPP Message Gateway for a delivery status report. The MSGin5G Server sends a POST request to the Non-3GPP Message Gateway, and the Non-3GPP Message Gateway responds with a 204 No Content message. + +**Figure 6.3.2.3.2-1: Non-3GPP Message Gateway Terminating Delivery Status Report** + +When the MSGin5G Server needs to send the delivery status report to the Non-3GPP Message Gateway, the MSGin5G Server shall send the HTTP POST request towards the "deliver-report" resource as shown in figure 6.3.2.3.2-1. + +The MSGin5G Server shall send a POST request to the resource with a *DeliveryStatusReport* object in the request body. + +The *DeliveryStatusReport* data type shall include: + +- the Originating UE Service ID/AS Service ID within the "oriAddr" attribute; +- the Recipient UE Service ID within the "destAddr" attribute; +- the Message ID within the "msgId" attribute; +- the delivery status within the "delivSt" attribute; and + +may include: + +- the failure cause within the "failureCause" attribute. + +When the Non-3GPP Message Gateway receives the HTTP POST request from the MSGin5G Server, the Non-3GPP Message Gateway shall respond to the MSGin5G Server with a 204 No Content message. + +If errors occur when processing the HTTP POST request, the Non-3GPP Message Gateway shall apply error handling procedures as specified in clause 9.2.6. + +## 6.4 MSGG\_BGDelivery Service + +### 6.4.1 Service Description + +The MSGG\_BGDelivery Service corresponding to *Mbg* as defined in 3GPP TS 23.554 [2], is provided by the Broadcast Message Gateway. + +This service: + +- allows MSGin5G Server invokes services provided by Broadcast Message Gateway to deliver MSGin5G messages to Broadcast Message Gateway. + +## 6.4.2 Service Operations + +### 6.4.2.1 Introduction + +The service operation defined for MSGG\_BGDelivery Service is shown in the table 6.4.2.1-1. + +**Table 6.4.2.1-1: Operations of the MSGG\_BGDelivery Service** + +| Service operation name | Description | Initiated by | +|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| MSGG_BGDelivery_GTDelivery | This service operation is used by MSGin5G Server to deliver MSGin5G message to Broadcast Message Gateway. This service operation corresponds to clause 9.2.3.1.2 as defined in 3GPP TS 23.554 [2]. | MSGin5G Server | + +### 6.4.2.2 MSGG\_BGDelivery\_GTDelivery + +#### 6.4.2.2.1 General + +This service operation corresponds to clause 9.2.3.1.2 as defined in 3GPP TS 23.554 [2], is used by MSGin5G Server to deliver MSGin5G message to the Broadcast Message Gateway. + +#### 6.4.2.2.2 Broadcast Message Gateway Terminating Message Delivery + +![Sequence diagram showing the interaction between MSGin5G Server and Broadcast Message Gateway for message delivery. The MSGin5G Server sends a POST request to the Broadcast Message Gateway, and the Broadcast Message Gateway responds with a 204 No Content.](da6000b1371b5528262d4f9cb2f2707c_img.jpg) + +``` + +sequenceDiagram + participant MSGin5G Server + participant Broadcast Message Gateway + Note left of MSGin5G Server: MSGin5G Server + MSGin5G Server->>Broadcast Message Gateway: 1. POST ../deliver-message + Broadcast Message Gateway-->>MSGin5G Server: 2. 204 No Content + +``` + +Sequence diagram showing the interaction between MSGin5G Server and Broadcast Message Gateway for message delivery. The MSGin5G Server sends a POST request to the Broadcast Message Gateway, and the Broadcast Message Gateway responds with a 204 No Content. + +**Figure 6.4.2.2.2-1: Broadcast Message Gateway Terminating Message Delivery** + +When the MSGin5G Server needs to send the message to the Broadcast Message Gateway, the MSGin5G Server shall send the HTTP POST request towards the "deliver-message" resource as shown in Figure 6.4.2.2.2-1. + +The MSGin5G Server shall send a POST request to the resource with an BGMessageDelivery object in the request body. + +The BGMessageDelivery data type shall include: + +- the Originating UE Service ID/AS Service ID within the "oriAddr" attribute; +- the Recipient ID within the "destAddr" attribute; +- the Message ID within the "msgId" attribute; + +may include: + +- the Payload within the "payload" attribute; and +- the Application ID within the "appId" attribute; and +- the indication whether the message delivery status report is required within the "delivStReqInd" attribute; +- the priority type within the "priority" attribute; +- the message segment flag within the "segInd" attribute; and +- the message segment parameters within the "segParams" attribute, this attribute may include: + +- the segmentation set identifier within the "segId" attribute; +- the total number of message segments within the "totalSegCount" attribute; +- the message segment number within the "segNumb" attribute; and +- the last segment flag within the "lastSegFlag" attribute; + +When the Broadcast Message Gateway receives the HTTP POST request from the MSGin5G Server, the Broadcast Message Gateway shall respond to the MSGin5G Server with a 204 No Content message. + +If errors occur when processing the HTTP POST request, the Broadcast Message Gateway shall apply error handling procedures as specified in clause 9.3.6. + +## 7 Common information applicable to several APIs + +### 7.1 General + +MSGin5G APIs allow secure access to the capabilities provided by the MSGin5G. + +This document specifies the procedures triggered at different functional entities as a result of API invocation requests and event notifications. The stage-2 level requirements and signalling flows are defined in 3GPP TS 23.554 [2]. + +Several design aspects, as mentioned in the following clauses, are specified in 3GPP TS 29.500 [4] and referenced by this specification. + +### 7.2 Data Types + +#### 7.2.1 General + +This clause defines structured data types, simple data types and enumerations that are applicable to several APIs defined in the present specification and can be referenced from data structures defined in the subsequent clauses. + +In addition, data types that are defined in OpenAPI Specification [6] can also be referenced from data structures defined in the subsequent clauses. + +NOTE: As a convention, data types in the present specification are written with an upper-case letter in the beginning. Parameters are written with a lower-case letter in the beginning. As an exception, data types that are also defined in OpenAPI Specification [6] can use a lower-case case letter in the beginning for consistency. + +Table 7.2.1-1 specifies data types re-used by the MSGin5G from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the APIs of this specification. + +**Table 7.2.1-1: Re-used Data Types** + +| Data type | Reference | Comments | +|-----------|-----------|----------| +| | | | + +#### 7.2.2 Referenced structured data types + +Table 7.2.2-1 lists structured data types defined in this specification referenced by multiple services. + +**Table 7.2.2-1: Referenced Structured Data Types** + +| Data type | Reference | Description | +|--------------------------|------------------|---------------------------------------------------------| +| Address | Clause 9.1.5.2.3 | Represent an address | +| DeliveryStatusReport | Clause 8.2.5.2.7 | The message delivery status report request information. | +| MessageSegmentParameters | Clause 8.2.5.2.5 | Parameters for message segmentation | + +### 7.2.3 Referenced Simple data types and enumerations + +Following simple data types defined in Table 7.2.3.1-1 are applicable to several APIs in this document: + +**Table 7.2.3.1-1: Simple data types applicable to several APIs** + +| Type name | Reference | Description | +|-----------|-----------|-------------| +| | | | + +## 7.3 Usage of HTTP + +For MSGin5G APIs, support of HTTP/1.1 (IETF RFC 9110 [11], IETF RFC 9111 [14] and IETF RFC 9912 [10]) over TLS is mandatory and support of HTTP/2 (IETF RFC 9113 [16]) over TLS is recommended. + +A functional entity desiring to use HTTP/2 shall use the HTTP upgrade mechanism to negotiate applicable HTTP version as described in IETF RFC 9113 [16]. + +## 7.4 Content type + +JSON, IETF RFC 8259 [17], 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". + +## 7.5 URI structure + +### 7.5.1 Resource URI structure + +The resource URI structure of all the APIs specified in this document shall be as specified in clause 5.2.4 of 3GPP TS 29.501 [9]. + +### 7.5.2 Custom operations URI structure + +The custom operation definition is in Annex C of 3GPP TS 29.501 [9]. + +The URI of a custom operation which is associated with a resource shall have the following structure: + +**{apiRoot}** + +Custom operations can also be associated with the service instead of a resource. The URI of a custom operation which is not associated with a resource shall have the following structure: + +**{apiRoot}** + +In the above URI structures, "apiRoot", "apiName", "apiVersion" and "apiSpecificResourceUriPart" are as defined in clause 7.5.1 and "custOpName" represents the name of the custom operation as defined in clause 5.1.3.2 of 3GPP TS 29.501 [9]. + +## 7.6 Notifications + +None. + +## 7.7 Error Handling + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +## 7.8 Feature negotiation + +The procedures in clause 6.6.2 of 3GPP TS 29.500 [4] shall be applicable for the APIs defined in the present specification. For each of the APIs defined, the applicable list of features is contained in the related API definition. + +## 7.9 HTTP headers + +The MSGin5G 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]. No specific custom headers are defined for the MSGin5G API in the present specification. + +## 7.10 Conventions for Open API specification files + +The conventions for Open API specification files as specified in clause 5.3 of 3GPP TS 29.501 [9] shall be applicable for all APIs in this document. + +--- + +## 8 Message Server API definition + +### 8.1 MSGS\_ASRegistration API + +#### 8.1.1 API URI + +The MSGS\_ASRegistration service shall use the MSGS\_ASRegistration API. + +The request URIs used in HTTP requests from the AS towards the MSGin5G Server shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "msgs-asregistration". +- The shall be "v1". +- The shall be set as described in clause 8.1.2. + +#### 8.1.2 Resources + +##### 8.1.2.1 Overview + +{apiRoot}/msgs-asregistration/ + +![Diagram showing the resource URI structure for the MSGS_ASRegistration API. The root URI is {apiRoot}/msgs-asregistration/. A line branches down to a box containing /registrations. From this box, another line branches down to a box containing /{registrationId}.](6f90e8489d3449ddab9b5773db240a16_img.jpg) + +``` +graph TD; Root["{apiRoot}/msgs-asregistration/"] --> Reg["/registrations"]; Reg --> Id["/{registrationId}"]; +``` + +Diagram showing the resource URI structure for the MSGS\_ASRegistration API. The root URI is {apiRoot}/msgs-asregistration/. A line branches down to a box containing /registrations. From this box, another line branches down to a box containing /{registrationId}. + +**Figure 8.1.2.1-1: Resource URI structure of the MSGS\_ASRegistration API** + +Table 8.1.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.1.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------|---------------------------------|---------------------------------|-------------------------------------------| +| AS Registrations | /registrations | POST | Registers a new AS at the MSGin5G Server. | +| AS DeRegistration | /registrations/{registrationId} | DELETE | Removes an AS registration resource. | + +### 8.1.2.2 Resource: AS Registrations + +#### 8.1.2.2.1 Description + +This resource represents all the Application Servers that are registered at a given MSGin5G Server. + +#### 8.1.2.2.2 Resource Definition + +Resource URI: {apiRoot}/msgs-asregistration//registrations + +This resource shall support the resource URI variables defined in the table 8.1.2.2.2-1. + +**Table 8.1.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|------------|-----------|------------------| +| apiRoot | string | See clause 7.5 | +| apiVersion | string | See clause 8.1.1 | + +#### 8.1.2.2.3 Resource Standard Methods + +##### 8.1.2.2.3.1 POST + +This method shall support the URI query parameters specified in table 8.1.2.2.3.1-1. + +**Table 8.1.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.1.2.2.3.1-2 and the response data structures and response codes specified in table 8.1.2.2.3.1-3. + +**Table 8.1.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|--------------------------------------| +| ASRegistration | M | 1 | AS registration request information. | + +**Table 8.1.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| ASRegistrationAc
k | M | 1 | 201 Created | AS information is registered successfully at MSGin5G Server.
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.7.1-1 of 3GPP TS 29.500 [4] shall also apply. | | | | | + +Table 8.1.2.2.3.1-4: Headers supported by the POST method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Table 8.1.2.2.3.1-5: 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}/msgs-asregistration//registrations/{registrationId} | + +Table 8.1.2.2.3.1-6: Links supported by the 200 Response Code on this endpoint + +| Name | Resource name | HTTP method or custom operation | Link parameter(s) | Description | +|------|---------------|---------------------------------|-------------------|-------------| +| n/a | | | | | + +### 8.1.2.3 Resource: AS DeRegistration + +#### 8.1.2.3.1 Description + +This resource represents all the Application Servers that are deregistered at a given MSGin5G Server. + +#### 8.1.2.3.2 Resource Definition + +Resource URI: {apiRoot}/msgs-asregistration//registrations/{registrationId} + +This resource shall support the resource URI variables defined in the table 8.1.2.3.2-1. + +Table 8.1.2.3.2-1: Resource URI variables for this resource + +| Name | Data Type | Definition | +|----------------|-----------|---------------------------------| +| apiRoot | string | See clause 7.5 | +| apiVersion | string | See clause 8.1.1 | +| registrationId | string | The AS registration resource id | + +#### 8.1.2.3.3 Resource Standard Methods + +##### 8.1.2.3.3.1 DELETE + +This method deregisters an AS registration from the MSGin5G Server. This method shall support the URI query parameters specified in the table 8.1.2.3.3.1-1. + +Table 8.1.2.3.3.1-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 8.1.2.3.3.1-2 and the response data structures and response codes specified in table 8.1.2.3.3.1-3. + +Table 8.1.2.3.3.1-2: Data structures supported by the DELETE Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.1.2.3.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------| +| ASRegistrationAck | M | 1 | 200 OK | The AS DeRegistration information matching the registrationId is deleted. | +| n/a | | | 204 No Content | Successful response. The individual AS registration matching the registrationId is successfully deleted. | + +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] shall also apply. + +**Table 8.1.2.3.3.1-4: Headers supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +**Table 8.1.2.3.3.1-5: Headers supported by the 204 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +**Table 8.1.2.3.3.1-6: Links supported by the 200 Response Code on this endpoint** + +| Name | Resource name | HTTP method or custom operation | Link parameter(s) | Description | +|------|---------------|---------------------------------|-------------------|-------------| +| n/a | | | | | + +## 8.1.3 Custom Operations without associated resources + +None. + +## 8.1.4 Notifications + +None. + +## 8.1.5 Data Model + +### 8.1.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API. Table 8.1.5.1-1 specifies the data types defined specifically for the MSGS\_ASRegistration API service. + +**Table 8.1.5.1-1: MSGS\_ASRegistration API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-------------------|-----------------|----------------------------------------------------------------------------|---------------| +| ASRegistration | 8.1.5.2.2 | The AS registration request information. | | +| ASRegistrationAck | 8.1.5.2.3 | The AS registration response information. | | +| ASProfile | 8.1.5.2.4 | The profile information related to the AS in the ASRegistration data type. | | + +Table 8.1.5.1-2 specifies data types re-used by the MSGS\_ASRegistration API service. + +Table 8.1.5.1-2: Re-used Data Types + +| Data type | Reference | Comments | Applicability | +|----------------|--------------------|----------|---------------| +| ProblemDetails | 3GPP TS 29.571 [5] | | | +| Uri | 3GPP TS 29.571 [5] | | | + +### 8.1.5.2 Structured data types + +#### 8.1.5.2.1 Introduction + +#### 8.1.5.2.2 Type: ASRegistration + +Table 8.1.5.2.2-1: Definition of type ASRegistration + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------|---------------| +| asSvclD | string | M | 1 | The MSGin5G identifier of the Application Server. | | +| appID | string | O | 0..1 | The identifier of the application specified by the application provider | | +| targetUri | Uri | O | 0..1 | The URL for receiving message, message delivery status report, etc. The MSGin5G Server uses this URL to interact to AS. | | +| asProf | ASProfile | O | 0..1 | The profile information of the AS. | | + +#### 8.1.5.2.3 Type: ASRegistrationAck + +Table 8.1.5.2.3-1: Definition of type ASRegistrationAck + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|---------------------------------------------------|---------------| +| asSvclD | string | M | 1 | The MSGin5G identifier of the Application Server. | | +| result | ProblemDetails | M | 1 | The result of the registration. | | + +#### 8.1.5.2.4 Type: ASProfile + +Table 8.1.5.2.4-1: Definition of type ASProfile + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|---------------------------------------------|---------------| +| appName | string | O | 1 | The name of the Application Server | | +| appProviders | array(string) | O | 1..N | The provider of the Application Server | | +| appSenarios | array(string) | O | 1..N | The application scenario description. | | +| appCategory | string | O | 0..1 | The category or type of Application Server. | | +| asStatus | string | O | 0..1 | AS status (e.g. Enabled, Disabled etc.) | | + +### 8.1.5.3 Simple data types and enumerations + +None. + +## 8.1.6 Error Handling + +### 8.1.6.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +### 8.1.6.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the MSGS\_ASRegistration API. + +### 8.1.6.3 Application Errors + +The application errors defined for the MSGS\_ASRegistration API are listed in table 8.1.6.3-1. + +**Table 8.1.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 8.1.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.1.7-1 lists the supported features for AS\_Registration API. + +**Table 8.1.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 8.2 MSGS\_MSGDelivery API + +### 8.2.1 API URI + +The MSGS\_MSGDelivery service shall use the MSGS\_MSGDelivery API, The MSGS\_MSGDelivery API corresponding to Mm5s APIs as defined in in 3GPP TS 23.554 [2]. + +The request URIs used in HTTP requests from the Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) or the Application Server towards the MSGin5G Server shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "msgs-msgdelivery". +- The shall be "v1". +- The shall be set as described in clause 8.2.2. + +### 8.2.2 Resources + +None. + +### 8.2.3 Custom Operations without associated resources + +#### 8.2.3.1 Overview + +The structure of the custom operation URIs of the MSGS\_MSGDelivery service is shown in Figure 8.2.3.1-1. + +{apiRoot}/msgs-msgdelivery/ + +![Diagram showing the custom operation URI structure for the MSGS_MSGDelivery API. A vertical line branches into three dashed boxes labeled 'deliver-as-message', 'deliver-ue-message', and 'deliver-report'.](f5deee2f3301ee351c4008283ffafbb3_img.jpg) + +``` + +graph LR + Root["{apiRoot}/msgs-msgdelivery/"] --- DashedLine[ ] + style DashedLine fill:none,stroke:none + DashedLine --- DeliverAs[deliver-as-message] + DashedLine --- DeliverUe[deliver-ue-message] + DashedLine --- DeliverReport[deliver-report] + +``` + +Diagram showing the custom operation URI structure for the MSGS\_MSGDelivery API. A vertical line branches into three dashed boxes labeled 'deliver-as-message', 'deliver-ue-message', and 'deliver-report'. + +**Figure 8.2.3.1-1: Custom operation URI structure of the MSGS\_MSGDelivery API** + +Table 8.2.3.1-1 provides an overview of the custom operations and applicable HTTP methods. + +**Table 8.2.3.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|------------------------------------------------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------| +| {apiRoot}/msgs-msgdelivery//deliver-as-message | POST | Request of AS to deliver message to a given MSGin5G Server. | +| {apiRoot}/msgs-msgdelivery//deliver-ue-message | POST | Request of Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) to deliver message to a given MSGin5G Server. | +| {apiRoot}/msgs-msgdelivery//deliver-report | POST | Request of Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) to deliver status report to a given MSGin5G Server. | + +### 8.2.3.2 Operation: deliver-as-message + +#### 8.2.3.2.1 Description + +This operation is used by the Application Server to deliver message to a given MSGin5G Server. + +#### 8.2.3.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in Table 8.2.3.2.2-1 and Table 8.2.3.2.2-2. + +**Table 8.2.3.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-----------------------------------------------------------| +| ASMessageDelivery | M | 1 | Represents the data to be used for AS to deliver message. | + +**Table 8.2.3.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------| +| MessageDeliveryAck | M | 1 | 200 OK | AS Message is delivered successfully. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 8.2.3.3 Operation: deliver-ue-message + +#### 8.2.3.3.1 Description + +This operation is used by the Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) to deliver message to a given MSGin5G Server. + +#### 8.2.3.3.2 Operation Definition + +This operation shall support the response data structures and response codes specified in Table 8.2.3.3.2-1 and Table 8.2.3.3.2-2. + +**Table 8.2.3.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------| +| UEMessageDelivery | M | 1 | Represents the data to be used for Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) to deliver message. | + +**Table 8.2.3.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------| +| MessageDeliveryAck | M | 1 | 200 OK | UE Message is delivered successfully. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 8.2.3.4 Operation: deliver-report + +#### 8.2.3.4.1 Description + +This operation is used by the Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) or the Application Server to deliver status report to a given MSGin5G Server. + +#### 8.2.3.4.2 Operation Definition + +This operation shall support the response data structures and response codes specified in Table 8.2.3.4.2-1 and Table 8.2.3.4.2-2. + +**Table 8.2.3.4.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| DeliveryStatusReport | M | 1 | Represents the data to be used for Message Gateway (on behalf of Legacy 3GPP UE or Non-3GPP UE) or the Application Server to deliver status report. | + +**Table 8.2.3.4.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------| +| MessageDeliveryAck | M | 1 | 200 OK | The status report is delivered successfully. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 8.2.4 Notifications + +None. + +## 8.2.5 Data Model + +### 8.2.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API. Table 8.2.5.1-1 specifies the data types defined specifically for the MSGS\_MSGDelivery API service. + +**Table 8.2.5.1-1: API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|---------------------------|-----------------|----------------------------------------------------------------------------------------|---------------| +| ASMessageDelivery | 8.2.5.2.2 | The AS message delivery request information. | | +| DeliveryStatus | 8.2.5.3.3 | Indicates if delivery is a failure, or if the message is stored for deferred delivery. | | +| DeliveryStatusReport | 8.2.5.2.7 | The message delivery status report request information. | | +| MessageDeliveryAck | 8.2.5.2.4 | The message delivery response information. | | +| MessageSegmentParameters | 8.2.5.2.5 | Contains the message segment information of the message. | | +| Priority | 8.2.5.3.5 | Application priority level requested for this message. | | +| ReportDeliveryStatus | 8.2.5.3.4 | The delivery status description, including success or failure in delivery. | | +| StoreAndForwardParameters | 8.2.5.2.6 | Contains the store forward information of the message. | | +| UEMessageDelivery | 8.2.5.2.3 | The UE message delivery request information. | | + +Table 8.2.5.1-2 specifies data types re-used by the MSGS\_MSGDelivery API service. + +**Table 8.2.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------|--------------------|-------------------------------------------------------------------------|---------------| +| Address | 9.1.5.2.3 | The data type of the oriAddr and destAddr. | | +| DateTime | 3GPP TS 29.571 [5] | String with format "date-time" as defined in OpenAPI Specification [6]. | | + +## 8.2.5.2 Structured data types + +## 8.2.5.2.1 Introduction + +## 8.2.5.2.2 Type: ASMessageDelivery + +Table 8.2.5.2.2-1: Definition of type ASMessageDelivery + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| oriAddr | Address | M | 1 | The service identity of the sending Application Server (NOTE). | | +| destAddr | Address | M | 1 | The service identity of the receiving Legacy 3GPP UE, Non-3GPP UE or MSGin5G UE.
The service identifier of the target MSGin5G Group.
The service identifier of the Broadcast Service Area where the message needs to be broadcast.
Indicates which Messaging Topic this message is related to. | | +| appld | string | O | 0..1 | Identifies the application(s) for which the content is intended.
This list of Application IDs IE is required when the message is sent to one or multiple Application Clients served by same MSGin5G Client. | | +| msgId | string | M | 1 | Unique identifier of this message. | | +| delivStReqInd | boolean | O | 0..1 | Indicates if delivery acknowledgement from the recipient is requested.
Set to "true" if delivery acknowledgement from the recipient is requested. otherwise set to "false". Default value is "false". | | +| payload | string | O | 0..1 | Payload of the message. | | +| priority | Priority | O | 0..1 | Application priority level requested for this message. | | +| segInd | boolean | O | 0..1 | Indicates this message is part of a segmented message.
Set to "true" if the message is part of a segmented message. otherwise set to "false". Default value is "false". | | +| segParams | MessageSegmentParameters | O | 0..1 | The message segment parameters.
This IE shall be included only if the value of the message Segment Flag IE indicates that message Segment services are requested. | | +| stoAndFwInd | boolean | M | 1 | An indicator of whether store and forward services are requested for this message.
Set to "true" if it is required to store and forward services for this message. otherwise set to "false". | | +| stoAndFwParams | StoreAndForwardParameters | O | 0..1 | Parameters used by MSGin5G Server for providing store and forward services.
This IE shall be included only if the value of the Store and forward flag IE indicates that store and forward services are requested. | | +| latency | integer | O | 0..1 | The latency requirement for the message which only applies to AS Originating MSGin5G Message. Unit: millisecond. | | + +NOTE: Only "AS" is applicable to the addrType attribute in the Address data type to represent the originating type of message request. + +## 8.2.5.2.3 Type: UEMessageDelivery + +Table 8.2.5.2.3-1: Definition of type UEMessageDelivery + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| oriAddr | Address | M | 1 | The service identity of the sending Legacy 3GPP UE or Non-3GPP UE (NOTE). | | +| destAddr | Address | M | 1 | The service identity of the receiving Application Server or MSGin5G UE. | | +| appld | string | O | 0..1 | Identifies the application(s) for which the content is intended.
This list of Application IDs IE is required when the message is sent to one or multiple Application Clients served by same MSGin5G Client. | | +| msgId | string | M | 1 | Unique identifier of this message. | | +| delivStReqInd | boolean | O | 0..1 | Indicates if delivery acknowledgement from the recipient is requested.
Set to "true" if delivery acknowledgement from the recipient is requested. otherwise set to "false". Default value is "false". | | +| payload | string | O | 0..1 | Payload of the message. | | +| segInd | boolean | O | 0..1 | Indicates this message is part of a segmented message.
Set to "true" if the message is part of a segmented message. otherwise set to "false". Default value is "false". | | +| segParams | MessageSegmentParameters | O | 0..1 | The message segment parameters.
This IE shall be included only if the value of the message Segment Flag IE indicates that message Segment services are requested. | | +| stoAndFwInd | boolean | M | 1 | An indicator of whether store and forward services are requested for this message.
Set to "true" if it is required to store and forward services for this message. otherwise set to "false". | | +| stoAndFwParams | StoreAndForwardParameters | O | 0..1 | Parameters used by MSGin5G Server for providing store and forward services.
This IE shall be included only if the value of the Store and forward flag IE indicates that store and forward services are requested. | | + +NOTE: Only "UE" is applicable to the addrType attribute in the Address data type to represent the originating type of message request. + +## 8.2.5.2.4 Type: MessageDeliveryAck + +Table 8.2.5.2.4-1: Definition of type MessageDeliveryAck + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-----------------------------------------------------------------------------------------------------------|---------------| +| oriAddr | Address | M | 1 | The service identity of the sending Legacy 3GPP UE, Non-3GPP UE or the sending Application Server (NOTE). | | +| msgId | string | M | 1 | Unique identifier of this message. | | +| status | DeliveryStatus | O | 0..1 | Indicates if delivery is a failure, or if the message is stored for deferred delivery. | | +| failureCause | string | C | 0..1 | The reason for failure.
May only be present if the "status" attribute is set to "DELY_FAILED". | | + +NOTE: Either "UE" or "AS" shall be included in the "addrType" attribute within the Address data type to represent the originating type of message request. + +## 8.2.5.2.5 Type:MessageSegmentParameters + +Table 8.2.5.2.5-1: Definition of type MessageSegmentParameters + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| segId | string | O | 0..1 | All segmented messages associated within the same set of segmented messages (i.e. associated with the same MSGin5G message) are assigned the same unique identifier. | | +| totalSegCount | integer | O | 0..1 | Indicates the total number of segments for the message. | | +| segNumb | integer | O | 0..1 | Indicates segmented message number of each segmented message within a set of segmented messages. | | +| lastSegFlag | boolean | O | 0..1 | An indicator of whether this segmented message is the last segment in the set of segmented messages or not.
Set to "true" if the segmented message is the last segment in the set of segmented messages. otherwise set to "false".
Default value is "false". | | + +## 8.2.5.2.6 Type:StoreAndForwardParameters + +Table 8.2.5.2.6-1: Definition of type StoreAndForwardParameters + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------|---------------| +| exprTime | DateTime | O | 0..1 | Indicates message expiration time. | | + +## 8.2.5.2.7 Type:DeliveryStatusReport + +Table 8.2.5.2.7-1: Definition of type DeliveryStatusReport + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| oriAddr | Address | M | 1 | The service identity of the sending Legacy 3GPP UE, Non-3GPP UE or the sending Application Server (NOTE). | | +| destAddr | Address | M | 1 | The service identity of the receiving Legacy 3GPP UE, Non-3GPP UE or the receiving Application Server (NOTE). | | +| msgId | string | M | 1 | Unique identifier of this message. | | +| failureCause | string | C | 0..1 | The Failure Cause indicates the failure reason, if applicable.
May only be present if the ReportDeliveryStatus sets to "REPT DELY FAILED". | | +| delivSt | ReportDeliveryStatus | M | 1 | The delivery status description, including success or failure in delivery. | | + +NOTE: Either "UE" or "AS" shall be included in the addrType attribute in Address data type to represent the originating type of message request. + +## 8.2.5.3 Simple data types and enumerations + +## 8.2.5.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 8.2.5.3.2 Simple data types + +None. + +## 8.2.5.3.3 Enumeration: DeliveryStatus + +Table 8.2.5.3.3-1: Enumeration DeliveryStatus + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------|---------------| +| DELY_FAILED | Indicates that the message delivery is failed. | | +| DELY_STORED | Indicates that the message is stored for deferred delivery. | | + +## 8.2.5.3.4 Enumeration: ReportDeliveryStatus + +Table 8.2.5.3.4-1: Enumeration ReportDeliveryStatus + +| Enumeration value | Description | Applicability | +|--------------------|---------------------------------------------------|---------------| +| REPT_DEL_Y_SUCCESS | Indicates that the report delivery is successful. | | +| REPT_DEL_Y_FAILED | Indicates that the report delivery is failed. | | + +## 8.2.5.3.5 Enumeration:Priority + +Table 8.2.5.3.5-1: Enumeration Priority + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------|---------------| +| HIGH | Indicates the messages should be sent in high priority. | | +| MIDDLE | Indicates the messages should be sent in middle priority. | | +| LOW | Indicates the messages should be sent in low priority. | | + +## 8.2.6 Error Handling + +## 8.2.6.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +## 8.2.6.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the MSGS\_MSGDelivery API. + +## 8.2.6.3 Application Errors + +The application errors defined for the MSGS\_MSGDelivery API are listed in table 8.2.6.3-1. + +Table 8.2.6.3-1: Application errors + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 8.2.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.2.7-1 lists the supported features for MSGS\_MSGDelivery API. + +Table 8.2.7-1: Supported Features + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 8.3 MSGS\_TopiclistEvent API + +### 8.3.1 API URI + +The MSGS\_TopiclistEvent service shall use the MSGS\_TopiclistEvent API. + +The request URIs used in HTTP requests from the MSGin5G Server 1 towards the MSGin5G Server 2 shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "msgs-topiclistevent". +- The shall be "v1". +- The shall be set as described in clause 8.3.2. + +### 8.3.2 Resources + +#### 8.3.2.1 Overview + +{apiRoot}/msgs-topiclistevent/ + +![Diagram showing the hierarchical structure of the Resource URI. The root URI is {apiRoot}/msgs-topiclistevent/. A line branches down to a box containing /topiclist-subscriptions. From this box, another line branches down to a box containing /{subscriptionId}.](659a041a7997f9eea79f4e2f3ba265a5_img.jpg) + +``` + +graph TD + Root["{apiRoot}/msgs-topiclistevent/"] --> Box1["/topiclist-subscriptions"] + Box1 --> Box2["/{subscriptionId}"] + +``` + +Diagram showing the hierarchical structure of the Resource URI. The root URI is {apiRoot}/msgs-topiclistevent/. A line branches down to a box containing /topiclist-subscriptions. From this box, another line branches down to a box containing /{subscriptionId}. + +Figure 8.3.2.1-1: Resource URI structure of the MSGS\_TopiclistEvent API + +Table 8.3.2.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 8.3.2.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------|-------------------------------------------|---------------------------------|----------------------------------------------------------| +| Topic List Subscriptions | /topiclist-subscriptions | POST | Subscribe to a Messaging Topic list on a MSGin5G Server. | +| Individual Topic List Subscription | /topiclist-subscriptions/{subscriptionId} | POST | Individual Messaging Topic list subscription resource. | + +#### 8.3.2.2 Resource: Topic List Subscriptions + +##### 8.3.2.2.1 Description + +This resource represents all the MSGin5G Servers that are subscribed at a given Messaging Topic on a MSGin5G Server. + +##### 8.3.2.2.2 Resource Definition + +Resource URI: {apiRoot}/msgs-topiclistevent//topiclist-subscriptions + +This resource shall support the resource URI variables defined in the table 8.3.2.2.2-1. + +**Table 8.3.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|------------|-----------|------------------| +| apiRoot | string | See clause 7.5 | +| apiVersion | string | See clause 8.3.1 | + +### 8.3.2.2.3 Resource Standard Methods + +#### 8.3.2.2.3.1 POST + +This method shall support the URI query parameters specified in table 8.3.2.2.3.1-1. + +**Table 8.3.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.3.2.2.3.1-2 and the response data structures and response codes specified in table 8.3.2.2.3.1-3. + +**Table 8.3.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|--------------------------------------------------------| +| TopicListSubscription | M | 1 | Messaging Topic list subscription request information. | + +**Table 8.3.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TopicListSubscriptionAck | M | 1 | 201 Created | The creation of an Messaging Topic list subscription resource is confirmed. 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.7.1-1 of 3GPP TS 29.500 [4] shall also apply. | | | | | + +**Table 8.3.2.2.3.1-4: Headers supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +**Table 8.3.2.2.3.1-5: 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}/msgs-topiclistevent//topiclist-subscriptions/{subscriptionId} | + +### 8.3.2.3 Resource: Individual Topic List Subscription + +#### 8.3.2.3.1 Description + +The Individual Topic List Subscription resource represents single Messaging Topic list subscription at a given MSGin5G Server. The resource allows an MSGin5G Server to delete Individual Topic List Subscription resource. + +### 8.3.2.3.2 Resource Definition + +Resource URI: {apiRoot}/msgs-topiclistevent//topiclist-subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in the table 8.3.2.3.2-1. + +**Table 8.3.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|----------------|-----------|------------------------------------------------------------------| +| apiRoot | string | See clause 7.5 | +| apiVersion | string | See clause 8.3.1 | +| subscriptionId | string | The MSGin5G Server Messaging Topic list subscription resource id | + +### 8.3.2.3.3 Resource Standard Methods + +#### 8.3.2.3.3.1 POST + +This method shall support the URI query parameters specified in table 8.3.2.3.3.1-1. + +**Table 8.3.2.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.3.2.3.3.1-2 and the response data structures and response codes specified in table 8.3.2.3.3.1-3. + +**Table 8.3.2.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.3.2.3.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 | Successful response. The individual MSGin5G Server Messaging Topic list subscription matching the subscriptionId is successfully deleted. | +| TopicListUnsubscriptionAck | M | 1 | 200 OK | Response of successfully handled Topic list unsubscription request with status information if subscription is not deleted. | +| 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] shall also apply. | | | | | + +**Table 8.3.2.3.3.1-4: Headers supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +**Table 8.3.2.3.3.1-5: Headers supported by the 204 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +### 8.3.3 Custom Operations without associated resources + +#### 8.3.3.1 Overview + +The structure of the custom operation URIs of the MSGS\_MSGTopiclistEvent service is shown in Figure 8.3.3.1-1. + +![Diagram showing the URI structure for custom operations. The root URI is {apiRoot}/msgs-topiclistevent/. It branches into two dashed boxes: /request-topic-subscription and /request-topic-unsubscription.](552328a9daaf3bc0069424b500025880_img.jpg) + +``` + +graph TD + Root["{apiRoot}/msgs-topiclistevent/"] --> Sub1["/request-topic-subscription"] + Root --> Sub2["/request-topic-unsubscription"] + +``` + +Diagram showing the URI structure for custom operations. The root URI is {apiRoot}/msgs-topiclistevent/. It branches into two dashed boxes: /request-topic-subscription and /request-topic-unsubscription. + +Figure 8.3.3.1-1: Custom operation URI structure of the MSGS\_TopiclistEvent API + +Table 8.3.3.1-1 provides an overview of the custom operations and applicable HTTP methods. + +Table 8.3.3.1-1: Custom operations without associated resources + +| Custom operation URI | Mapped HTTP method | Description | +|-------------------------------------------------------------------------|--------------------|------------------------------------------------------------------------------------------------------| +| {apiRoot}/msgs-topiclistevent//request-topic-subscription | POST | Request of MSGin5G Server to deliver Messaging Topic subscription to another given MSGin5G Server. | +| {apiRoot}/msgs-topiclistevent//request-topic-unsubscription | POST | Request of MSGin5G Server to deliver Messaging Topic unsubscription to another given MSGin5G Server. | + +#### 8.3.3.2 Operation: request-topic-subscription + +##### 8.3.3.2.1 Description + +The operation is used by the MSGin5G Server to request the other MSGin5G Server to create a subscription for one or more Messaging Topic(s). + +##### 8.3.3.2.2 Operation Definition + +This operation shall support the request data structures shown in Table 8.3.3.2.2-1 and the response data structures and error codes specified in Tables 8.3.3.2.2-2. + +Table 8.3.3.2.2-1: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|------------------------------------------------------------------------------------------| +| TopicSubscription | M | 1 | Information about the Messaging Topic subscription that the MSGin5G Server shall create. | + +**Table 8.3.3.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------| +| TopicSubscription Ack | M | 1 | 200 OK | Successful request to trigger the creation of a subscription for Messaging Topic at the MSGin5G Server. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 8.3.3.3 Operation: request-topic-unsubscription + +#### 8.3.3.3.1 Description + +The operation is used by the MSGin5G Server to request the other MSGin5G Server to remove a subscription for one or more Messaging Topic(s). + +#### 8.3.3.3.2 Operation Definition + +This operation shall support the request data structures shown in Table 8.3.3.3.2-1 and the response data structures and error codes specified in Tables 8.3.3.3.2-2. + +**Table 8.3.3.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|---------------------------------------------------------------------------------------------------| +| TopicUnsubscription | M | 1 | Reference used to identify the Messaging Topic subscription that the MSGin5G Server shall remove. | + +**Table 8.3.3.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful request to trigger the removal of a subscription for Messaging Topic(s) on the MSGin5G Server. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 8.3.4 Notifications + +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 8.3.4.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------------|-------------------|---------------------------------|----------------------------------------------------------------| +| TopicList Notification | {notificationURI} | POST | Notify about Messaging Topic list changes from MSGin5G Server. | + +### 8.3.4.2 Topiclist Notification + +#### 8.3.4.2.1 Description + +The Topiclist Notification is used by the MSGin5G Server to notify Messaging Topic list change events to another MSGin5G Server that has subscribed to such Messaging Topic list. + +### 8.3.4.2.2 Target URI + +The Callback URI "{notificationURI}" shall be used with the callback URI variables defined in table 8.3.4.2.2-1. + +**Table 8.3.4.2.2-1: Callback URI variables** + +| Name | Definition | +|-----------------|-----------------------------------------------| +| notificationURI | String formatted as URI with the Callback Uri | + +### 8.3.4.2.3 Standard Methods + +#### 8.3.4.2.3.1 POST + +This method shall support the request data structures specified in table 8.3.4.2.3.1-1 and the response data structures and response codes specified in table 8.3.4.2.3.1-2. + +**Table 8.3.4.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-------------------------------------------------------------| +| TopicListNotification | M | 1 | Provides information about subscribed Messaging Topic list. | + +**Table 8.3.4.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| NOTE 1: 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. | | | | | + +## 8.3.5 Data Model + +### 8.3.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API. Table 8.3.5.1-1 specifies the data types defined specifically for the MSGS\_TopiclistEvent API service. + +**Table 8.3.5.1-1: TopicListEvent API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|----------------------------|-----------------|---------------------------------------------------------------------------------------------------|---------------| +| TopicListSubscription | 8.3.5.2.2 | The Messaging Topic list subscription request information. | | +| TopicListUnsubscription | 8.3.5.2.3 | The Messaging Topic list unsubscription request information | | +| TopicListSubscriptionAck | 8.3.5.2.4 | The Messaging Topic list subscription response information, indicating the subscription result. | | +| TopicListUnsubscriptionAck | 8.3.5.2.5 | The Messaging Topic list unsubscription response information, indicating the subscription result. | | +| TopicSubscription | 8.3.5.2.6 | The Messaging Topic subscription request information. | | +| TopicSubscriptionAck | 8.3.5.2.7 | The Messaging Topic subscription response information. | | +| TopicUnsubscription | 8.3.5.2.8 | The Messaging Topic list unsubscription request information. | | +| TopicListNotification | 8.3.5.2.9 | The Messaging Topic list notification information, indicating changed Messaging Topics. | | +| MessagingTopic | 8.3.5.2.10 | The individual Messaging Topic information | | + +Table 8.3.5.1-2 specifies data types re-used by the MSGS\_TopicListEvent API service. + +**Table 8.3.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------|--------------------|----------|---------------| +| Uri | 3GPP TS 29.571 [5] | | | + +## 8.3.5.2 Structured data types + +### 8.3.5.2.1 Introduction + +### 8.3.5.2.2 Type: TopicListSubscription + +**Table 8.3.5.2.2-1: Definition of type TopicListSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| oriAddr | Address | M | 1 | The service identity of the MSGin5G Server which requests the Messaging Topic list subscription. | | +| destAddr | Address | M | 1 | The service identity of the receiving MSGin5G Server. | | +| notificationURI | Uri | M | 1 | Notification target address. | | +| secCred | string | O | 0..1 | Security information required by the MSGin5G Server. | | +| exprTime | DateTime | O | 0..1 | The expiration time of this subscription requested, and should be larger than 0 if included. If not included, the expiration time subjects to operator policy. | | +| suppFeat | Supported Features | C | 0..1 | This IE represents a list of Supported features as described in clause 8.3.7. It shall be present if at least one feature defined in clause 8.3.7 is supported. | | + +8.3.5.2.3 Type: TopicListUnsubscription + +**Table 8.3.5.2.3-1: Definition of type TopicListSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------|---------------| +| oriAddr | Address | M | 1 | The service identity of the MSGin5G Server which requests the Messaging Topic list unsubscription. | | +| destAddr | Address | M | 1 | The service identity of the receiving MSGin5G Server. | | +| secCred | string | O | 0..1 | Security information required by the MSGin5G Server. | | + +8.3.5.2.4 Type: TopicListSubscriptionAck + +**Table 8.3.5.2.4-1: Definition of type TopicListSubscriptionAck** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| subStat | string | M | 1 | The result of the subscription. | | +| exprTime | DateTime | O | 0..1 | Indicates the expiration time of the subscription. | | +| suppFeat | Supported Features | C | 0..1 | This IE represents a list of Supported features as described in clause 8.3.7. It shall be present if at least one feature defined in clause 8.3.7 is supported. | | + +8.3.5.2.5 Type: TopicListUnsubscriptionAck + +**Table 8.3.5.2.5-1: Definition of type TopicListSubscriptionAck** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|---------------------------------|---------------| +| subStat | string | M | 1 | The result of the subscription. | | + +8.3.5.2.6 Type: TopicSubscription + +**Table 8.3.5.2.6-1: Definition of type TopicSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| oriAddr | string | M | 1 | The Service identifier of the originating MSGin5G Server | | +| msgTopics | array(string) | M | 1..N | Information of Messaging Topic(s) to be subscribed | | +| secCred | string | O | 0..1 | Security information required by the MSGin5G Server. | | +| exprTime | DateTime | O | 0..1 | The expiration time of this subscription requested, and should be larger than 0 if included. If not included, the expiration time subjects to operator policy. | | + +8.3.5.2.7 Type: TopicSubscriptionAck + +**Table 8.3.5.2.7-1: Definition of type TopicSubscriptionAck** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------|---------------| +| subStat | string | M | 1 | Indicating update status of the Messaging Topic if newly created or deleted. | | +| exprTime | DateTime | O | 0..1 | The expiration time of this subscription set by MSGin5G Server. | | + +## 8.3.5.2.8 Type: TopicUnsubscription + +Table 8.3.5.2.8-1: Definition of type TopicUnsubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-----------------------------------------------------------|---------------| +| oriAddr | string | O | 0..1 | The Service identifier of the originating MSGin5G Server. | | +| secCred | string | O | 0..1 | Security information required by the MSGin5G Server. | | +| msgTopics | array(string) | M | 1..N | Information of Messaging Topic(s) to be unsubscribed. | | + +## 8.3.5.2.9 Type: TopicListNotification + +Table 8.3.5.2.9-1: Definition of type TopicListNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|--------------------------------------------------------------------|---------------| +| exprTime | DateTime | O | 0..1 | The expiration time of this subscription set by MSGin5G Server. | | +| msgTopics | array(MessagingTopic) | M | 1..N | List of Messaging Topic(s) information notified by MSGin5G Server. | | + +## 8.3.5.2.10 Type: MessagingTopic + +Table 8.3.5.2.10-1: Definition of type MessagingTopic + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|------------------------------------------------------------------------------|---------------| +| msgTopic | string | M | 1 | The identifier of the Messaging Topic. | | +| updateStat | UpdateStatus | M | 1 | Indicating update status of the Messaging Topic if newly created or deleted. | | + +## 8.3.5.3 Simple data types and enumerations + +## 8.3.5.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 8.3.5.3.2 Enumeration: UpdateStatus + +Table 8.3.5.3.2-1: Enumeration UpdateStatus + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------|---------------| +| CREATED | The Messaging Topic is newly created. | | +| DELETED | The Messaging Topic is newly deleted. | | + +## 8.3.6 Error Handling + +## 8.3.6.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +## 8.3.6.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the MSGS\_TopicListEvent API. + +### 8.3.6.3 Application Errors + +The application errors defined for the MSGS\_TopiclistEvent API are listed in table 8.3.6.3-1. + +**Table 8.3.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 8.3.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.3.7-1 lists the supported features for MSGS\_TopiclistEvent API. + +**Table 8.3.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +--- + +## 9 Message Gateway API definition + +### 9.1 MSGG\_L3GDelivery API + +#### 9.1.1 API URI + +The MSGG\_L3GDelivery service shall use the MSGG\_L3GDelivery API, The MSGG\_L3GDelivery API corresponding to MI3g APIs as defined in in 3GPP TS 23.554 [2]. + +The request URIs used in HTTP requests from the MSGin5G Server towards the Legacy 3GPP Message Gateway shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "msgg-l3gdelivery". +- The shall be "v1". +- The shall be set as described in clause 9.1.3. + +#### 9.1.2 Resources + +None. + +#### 9.1.3 Custom Operations without associated resources + +##### 9.1.3.1 Overview + +The structure of the custom operation URIs of the MSGG\_L3GDelivery service is shown in Figure 9.1.3.1-1. + +{apiRoot}/msgg-l3gdelivery/ + +![Diagram showing the custom operation URI structure for the MSGG_L3GDelivery API. A vertical line descends from the base URI '{apiRoot}/msgg-l3gdelivery/' and branches to two dashed boxes labeled 'deliver-message' and 'deliver-report'.](0a06de972d61ab9bb901bd74dd4ff51f_img.jpg) + +``` + +graph TD + Base["{apiRoot}/msgg-l3gdelivery/"] --> DM[deliver-message] + Base --> DR[deliver-report] + +``` + +Diagram showing the custom operation URI structure for the MSGG\_L3GDelivery API. A vertical line descends from the base URI '{apiRoot}/msgg-l3gdelivery/' and branches to two dashed boxes labeled 'deliver-message' and 'deliver-report'. + +**Figure 9.1.3.1-1: Custom operation URI structure of the MSGG\_L3GDelivery API** + +Table 9.1.3.1-1 provides an overview of the custom operations and applicable HTTP methods. + +**Table 9.1.3.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|---------------------------------------------------------|--------------------|--------------------------------------------------------------------------------------------| +| {apiRoot}/msgg-l3gdelivery//deliver-message | POST | Request of MSGin5G Server to deliver message to a given Legacy 3GPP Message Gateway. | +| {apiRoot}/msgg-l3gdelivery//deliver-report | POST | Request of MSGin5G Server to deliver status report to a given Legacy 3GPP Message Gateway. | + +### 9.1.3.2 Operation: deliver-message + +#### 9.1.3.2.1 Description + +This operation is used by the MSGin5G Server to deliver message to a given Legacy 3GPP Message Gateway. + +#### 9.1.3.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in table 9.1.3.2.2-1 and table 9.1.3.2.2-2. + +**Table 9.1.3.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------------------------------------| +| L3gMessageDelivery | M | 1 | Represents the data to be used for MSGin5G Server to deliver message. | + +**Table 9.1.3.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------| +| n/a | | | 204 No Content | The Message is Delivered successfully. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 9.1.3.3 Operation: deliver-report + +#### 9.1.3.3.1 Description + +This operation is used by the MSGin5G Server to deliver status report to a given Legacy 3GPP Message Gateway. + +### 9.1.3.3.2 Operation Definition + +This operation shall support the response data structures and response codes specified in Table 9.1.3.3.2-1 and Table 9.1.3.3.2-2. + +**Table 9.1.3.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------------------------| +| DeliveryStatusReport | M | 1 | Represents the data to be used for MSGin5G Server to deliver status report. | + +**Table 9.1.3.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------| +| n/a | | | 204 No Content | The status report is Delivered successfully. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 9.1.4 Notifications + +None. + +## 9.1.5 Data Model + +### 9.1.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API. Table 9.1.5.1-1 specifies the data types defined specifically for the MSGG\_L3GDelivery API service. + +**Table 9.1.5.1-1: MSGG\_L3GDelivery API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------------|-----------------|----------------------------------------------|---------------| +| L3gMessageDelivery | 9.1.5.2.2 | Information within message delivery request. | | + +Table 9.1.5.1-2 specifies data types re-used by the MSGG\_L3GDelivery API service. + +**Table 9.1.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|--------------------------|-----------|----------------------------------------------------------|---------------| +| DeliveryStatusReport | 8.2.5.2.7 | The message delivery status report request information. | | +| MessageSegmentParameters | 8.2.5.2.5 | Contains the message segment information of the message. | | + +## 9.1.5.2 Structured data types + +## 9.1.5.2.1 Introduction + +## 9.1.5.2.2 Type: L3gMessageDelivery + +Table 9.1.5.2.2-1: Definition of type L3gMessageDelivery + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| oriAddr | Address | M | 1 | The service identity of the originating MSGin5G Client or the originating Application Server.
This IE is copied from the associated inbound message (NOTE). | | +| destAddr | Address | M | 1 | The service identity of the receiving entity. The receiving entity can only be Legacy 3GPP UE Service ID in MSGG_L3GDelivery API. | | +| appId | string | O | 0..1 | Identifies the application(s) for which the content is intended.
This list of Application IDs IE is required when the message is sent to one or multiple Application Clients served by same MSGin5G Client. | | +| msgId | string | M | 1 | Unique identifier of this message.
This IE is copied from the associated inbound message request | | +| delivStReqInd | boolean | O | 0..1 | Indicates if delivery acknowledgement from the recipient is requested.
This IE is copied from the associated inbound message.
Set to "true" if delivery acknowledgement from the recipient is requested. otherwise set to "false". Default value is "false". | | +| payload | string | O | 0..1 | Payload of the message.
This IE is copied from the associated inbound message. | | +| segInd | boolean | O | 0..1 | Indicates this message is part of a segmented message.
Set to "true" if the message is part of a segmented message. otherwise set to "false". Default value is "false". | | +| segParams | MessageSegmentParameters | O | 0..1 | The message segment parameters.
This IE shall be included only if the value of segInd is true to indicate that message Segment services are requested. | | + +NOTE: The addrType in Address data type shall only include AS or UE to represent the originating of message request. + +## 9.1.5.2.3 Type: Address + +Table 9.1.5.2.3-1: Definition of type Address + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|------------------------------------------------------------------------------------------------------|---------------| +| addrType | AddressType | M | 1 | Represent the type of message request. | | +| addr | string | M | 1 | Refer to UE Service ID or AS Service ID or Group Service ID or Broadcast Area ID or Messaging Topic. | | + +### 9.1.5.3 Simple data types and enumerations + +#### 9.1.5.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 9.1.5.3.2 Enumeration: AddressType + +**Table 9.1.5.3.2-1: Enumeration AddressType** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------|---------------| +| UE | The address type is UE. | | +| AS | The address type is AS. | | +| GROUP | The address type is GROUP. | | +| BC | The address type is BC. | | +| TOPIC | The address type is TOPIC. | | + +### 9.1.6 Error Handling + +#### 9.1.6.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +#### 9.1.6.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the MSGG\_L3GDelivery API. + +#### 9.1.6.3 Application Errors + +The application errors defined for the MSGG\_L3GDelivery API are listed in table 9.1.6.3-1. + +**Table 9.1.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 9.1.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 9.1.7-1 lists the supported features for MSGG\_L3GDelivery API. + +**Table 9.1.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 9.2 MSGG\_N3GDelivery API + +### 9.2.1 API URI + +The MSGG\_N3GDelivery service shall use the MSGG\_N3GDelivery API, The MSGG\_N3GDelivery API corresponding to Mn3g APIs as defined in in 3GPP TS 23.554 [2]. + +The request URIs used in HTTP requests from the MSGin5G Server towards the Non-3GPP Message Gateway shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "msgg-n3gdelivery". + +- The shall be "v1". +- The shall be set as described in clause 9.2.3. + +## 9.2.2 Resources + +None. + +## 9.2.3 Custom Operations without associated resources + +### 9.2.3.1 Overview + +The structure of the custom operation URIs of the MSGG\_N3GDelivery service is shown in Figure 9.2.3.1-1. + +![Diagram showing the URI structure for custom operations. A vertical line descends from the base URI '{apiRoot}/msgg-n3gdelivery/' and branches to two dashed boxes labeled 'deliver-message' and 'deliver-report'.](8afb16b644b2fe89d5c34251c3e6bf0c_img.jpg) + +{apiRoot}/msgg-n3gdelivery/ + +``` + +graph TD + Base["{apiRoot}/msgg-n3gdelivery/"] --> DM[deliver-message] + Base --> DR[deliver-report] + +``` + +Diagram showing the URI structure for custom operations. A vertical line descends from the base URI '{apiRoot}/msgg-n3gdelivery/' and branches to two dashed boxes labeled 'deliver-message' and 'deliver-report'. + +**Figure 9.2.3.1-1: Custom operation URI structure of the MSGG\_N3GDelivery API** + +Table 9.2.3.1-1 provides an overview of the custom operations and applicable HTTP methods. + +**Table 9.2.3.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|---------------------------------------------------------|--------------------|----------------------------------------------------------------------------------------| +| {apiRoot}/msgg-n3gdelivery//deliver-message | POST | Request of MSGin5G Server to deliver message to a given Non-3GPP Message Gateway | +| {apiRoot}/msgg-n3gdelivery//deliver-report | POST | Request of MSGin5G Server to deliver status report to a given Non-3GPP Message Gateway | + +### 9.2.3.2 Operation: deliver-message + +#### 9.2.3.2.1 Description + +This operation is used by the MSGin5G Server to deliver message to a given Non-3GPP Message Gateway. + +#### 9.2.3.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in table 9.2.3.2.2-1 and table 9.2.3.2.2-2. + +**Table 9.2.3.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------------------------------------| +| N3gMessageDelivery | M | 1 | Represents the data to be used for MSGin5G Server to deliver message. | + +**Table 9.2.3.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|----------------------------------------| +| n/a | | | 204 No Content | The Message is Delivered successfully. | + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +### 9.2.3.3 Operation: deliver-report + +#### 9.2.3.3.1 Description + +This operation is used by the MSGin5G Server to deliver status report to a given Non-3GPP Message Gateway. + +#### 9.2.3.3.2 Operation Definition + +This operation shall support the response data structures and response codes specified in table 9.2.3.3.2-1 and table 9.2.3.3.2-2. + +**Table 9.2.3.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------------------------| +| DeliveryStatusReport | M | 1 | Represents the data to be used for MSGin5G Server to deliver status report. | + +**Table 9.2.3.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|----------------------------------------------| +| n/a | | | 204 No Content | The status report is Delivered successfully. | + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +## 9.2.4 Notifications + +None. + +## 9.2.5 Data Model + +### 9.2.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API. Table 9.2.5.1-1 specifies the data types defined specifically for the MSGG\_N3GDelivery API service. + +**Table 9.2.5.1-1: MSGG\_N3GDelivery API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------------|-----------------|----------------------------------------------|---------------| +| N3gMessageDelivery | 9.2.5.2.2 | Information within message delivery request. | | + +Table 9.2.5.1-2 specifies data types re-used by the MSGG\_N3GDelivery API service. + +Table 9.2.5.1-2: Re-used Data Types + +| Data type | Reference | Comments | Applicability | +|--------------------------|-----------|----------------------------------------------------------|---------------| +| DeliveryStatusReport | 8.2.5.2.7 | The message delivery status report request information. | | +| MessageSegmentParameters | 8.2.5.2.5 | Contains the message segment information of the message. | | +| Address | 9.1.5.2.3 | The data type of the oriAddr and destAddr. | | + +## 9.2.5.2 Structured data types + +### 9.2.5.2.1 Introduction + +### 9.2.5.2.2 Type: N3gMessageDelivery + +Table 9.2.5.2.2-1: Definition of type N3gMessageDelivery + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------------------------------------------------------------------------------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| oriAddr | Address | M | 1 | The oriAddr is the service identity of the originating MSGin5G Client or the originating Application Server. This IE is copied from the associated inbound message (NOTE). | | +| destAddr | Address | M | 1 | The destAddr is the service identity of the receiving entity. The receiving entity can only be Non-3GPP UE Service ID in MSGG_N3GDelivery API. | | +| appld | string | O | 0..1 | Identifies the application(s) for which the content is intended. This list of Application IDs IE is required when the message is sent to one or multiple Application Clients served by same MSGin5G Client. | | +| msgId | string | M | 1 | Unique identifier of this message. This IE is copied from the associated inbound message request. | | +| delivStReqlnd | boolean | O | 0..1 | Indicates if delivery acknowledgement from the recipient is requested. This IE is copied from the associated inbound message. Set to "true" if delivery acknowledgement from the recipient is requested, otherwise set to "false". Default value is "false". | | +| payload | string | O | 0..1 | Payload of the message. This IE is copied from the associated inbound message. | | +| segInd | boolean | O | 0..1 | Indicates this message is part of a segmented message. Set to "true" if the message is part of a segmented message, otherwise set to "false". Default value is "false". | | +| segParams | MessageSegmentParameters | O | 0..1 | The message segment parameters. This IE shall be included only if the value of segInd is true to indicate that message Segment services are requested. | | +| NOTE: The addrType in Address data type shall only include AS or UE to represent the originating of message request. | | | | | | + +## 9.2.6 Error Handling + +### 9.2.6.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +### 9.2.6.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the MSGG\_N3GDelivery API. + +### 9.2.6.3 Application Errors + +The application errors defined for the MSGG\_N3GDelivery API are listed in table 9.2.6.3-1. + +**Table 9.2.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 9.2.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 9.2.7-1 lists the supported features for MSGG\_N3GDelivery API. + +**Table 9.2.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 9.3 MSGG\_BGDelivery API + +### 9.3.1 API URI + +The MSGG\_BGDelivery service shall use the MSGG\_BGDelivery API, The MSGG\_BGDelivery API corresponding to Mbg APIs as defined in in 3GPP TS 23.554 [2]. + +The request URIs used in HTTP requests from the MSGin5G Server towards the Broadcast Message Gateway shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "msgg-bgdelivery". +- The shall be "v1". +- The shall be set as described in clause 9.3.3. + +### 9.3.2 Resources + +None. + +### 9.3.3 Custom Operations without associated resources + +#### 9.3.3.1 Overview + +The structure of the custom operation URIs of the MSGG\_BGDelivery service is shown in Figure 9.3.3.1-1. + +![Diagram showing the URI structure {apiRoot}/msgg-bgdelivery/ with a dashed box labeled 'deliver-message' connected to the end of the URI by a line.](61a7f401eb46fe99a71f27bc37493f04_img.jpg) + +{apiRoot}/msgg-bgdelivery/ + +Diagram showing the URI structure {apiRoot}/msgg-bgdelivery/ with a dashed box labeled 'deliver-message' connected to the end of the URI by a line. + +**Figure 9.3.3.1-1: Custom operation URI structure of the MSGG\_BGDelivery API** + +Table 9.3.3.1-1 provides an overview of the custom operations and applicable HTTP methods. + +**Table 9.3.3.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|--------------------------------------------------------|--------------------|------------------------------------------------------------------------------------| +| {apiRoot}/msgg-bgdelivery//deliver-message | POST | Request of MSGin5G Server to deliver message to a given Broadcast Message Gateway. | + +### 9.3.3.2 Operation: deliver-message + +#### 9.3.3.2.1 Description + +This operation is used by the MSGin5G Server to deliver message to a given Broadcast Message Gateway. + +#### 9.3.3.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in table 9.3.3.2.2-1 and table 9.3.3.2.2-2. + +**Table 9.3.3.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-----------------------------------------------------------------------| +| BgMessageDelivery | M | 1 | Represents the data to be used for MSGin5G Server to deliver message. | + +**Table 9.3.3.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------| +| n/a | | | 204 No Content | The Message is delivered successfully. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 9.3.4 Notifications + +None. + +## 9.3.5 Data Model + +### 9.3.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API. Table 9.3.5.1-1 specifies the data types defined specifically for the MSGG\_BGDelivery API service. + +**Table 9.3.5.1-1: MSGG\_BGDelivery API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-------------------|------------------------|--------------------------------------------------------|----------------------| +| BgMessageDelivery | 9.3.5.2.2 | Information within broadcast message delivery request. | | + +Table 9.3.5.1-2 specifies data types re-used by the MSGG\_BGDelivery API service. + +**Table 9.3.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|--------------------------|------------------|--------------------------------------------|----------------------| +| Address | 9.1.5.2.3 | The data type of the oriAddr and destAddr. | | +| MessageSegmentParameters | 8.2.5.2.5 | The data type of the segParams | | +| Priority | 8.2.5.3.5 | The data type of the priority | | + +### 9.3.5.2 Structured data types + +#### 9.3.5.2.1 Introduction + +#### 9.3.5.2.2 Type: BgMessageDelivery + +**Table 9.3.5.2.2-1: Definition of type BgMessageDelivery** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| oriAddr | Address | M | 1 | The service identity of the originating MSGin5G Client or the originating Application Server.
This IE is copied from the associated inbound message (NOTE). | | +| destAddr | Address | M | 1 | The service identity of the Broadcast Service Area where the message needs to be broadcast. | | +| appld | string | O | 0..1 | Identifies the application(s) for which the content is intended.
This list of Application IDs IE is required when the message is sent to one or multiple Application Clients served by same MSGin5G Client. | | +| msgId | string | M | 1 | Unique identifier of this message.
This IE is copied from the associated inbound message request | | +| delivStReqlnd | boolean | O | 0..1 | Indicates if delivery acknowledgement from the recipient is requested.
This IE is copied from the associated inbound message.
Set to "true" if delivery acknowledgement from the recipient is requested. otherwise set to "false". Default value is "false". | | +| payload | string | O | 1 | Payload of the message.
This IE is copied from the associated inbound message. | | +| segInd | boolean | O | 0..1 | Indicates this message is part of a segmented message.
Set to "true" if the message is part of a segmented message. otherwise set to "false". Default value is "false". | | +| segParams | MessageSegmentParameters | C | 0..1 | The message segment parameters.
This IE shall be included only if the value of the attribute segInd is set to "true". | | +| priority | Priority | O | 0..1 | Application priority level requested for this message. | | + +NOTE: The addrType in Address data type shall only include AS or UE to represent the originating of message request. + +Editor's Note: Definition of all the attributes in BgMessageDelivery data type as defined in 3GPP TS 23.554 [2] clause 8.3.3 is FFS. + +### 9.3.5.3 Simple data types and enumerations + +None. + +## 9.3.6 Error Handling + +### 9.3.6.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +### 9.3.6.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the MSGG\_BGDelivery API. + +### 9.3.6.3 Application Errors + +The application errors defined for the MSGG\_BGDelivery API are listed in table 9.3.6.3-1. + +**Table 9.3.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 9.3.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 9.3.7-1 lists the supported features for MSGG\_BGDelivery API. + +**Table 9.3.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +# 10 Security + +TLS shall be used to support the security communication between the MSGin5G Server and the Application Server over MSGin5G-3 interface, and also between MSGin5G Server and the Message Gateway over MSGin5G-2 or MSGin5G-4 interface as specified in 3GPP TS 33.862 [19] and 3GPP TS 33.501 [20]. The access to the MSGin5G Service APIs shall be authorized by means of OAuth2 protocol (see IETF RFC 6749 [21]), based on local configuration, using the "Client Credentials" authorization grant. If OAuth2 is used, a client, prior to consuming services offered by the MSGin5G Service APIs, shall obtain a "token" from the authorization server. + +# 11 Using Common API Framework + +## 11.1 General + +When CAPIF is used with a MSGin5G service, the MSGin5G Server shall support the following as defined in 3GPP TS 29.222 [8]: + +- the API exposing function and related APIs over CAPIF-2/2e and CAPIF-3/3e reference points; +- the API publishing function and related APIs over CAPIF-4/4e reference point; +- the API management function and related APIs over CAPIF-5/5e reference point; and +- at least one of the security methods for authentication and authorization, and related security mechanisms. + +In a centralized deployment as defined in 3GPP TS 23.222 [7], where the CAPIF core function and API provider domain functions are co-located, the interactions between the CAPIF core function and API provider domain functions may be independent of CAPIF-3/3e, CAPIF-4/4e and CAPIF-5/5e reference points. + +When CAPIF is used with a MSGin5G service, the MSGin5G Server shall register all the features for northbound APIs in the CAPIF Core Function. + +## 11.2 Security + +When CAPIF is used for external exposure, before invoking the API exposed by the MSGin5G Server, the NF service consumer (e.g. the Application Server) as API invoker shall negotiate the security method (PKI, TLS-PSK or OAUTH2) + +with CAPIF core function and ensure the MSGin5G Server has enough credential to authenticate the NF service consumer (e.g. the Application Server), see 3GPP TS 29.222 [8], clause 5.6.2.2 and clause 6.2.2.2. + +If PKI or TLS-PSK is used as the selected security method between the NF service consumer (e.g. the Application Server) and the MSGin5G Server, upon API invocation, the MSGin5G Server shall retrieve the authorization information from the CAPIF core function as described in 3GPP TS 29.222 [8], clause 5.6.2.4. + +As indicated in 3GPP TS 33.122 [22], the access to the MSGin5G APIs may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [21]), using the "Client Credentials" authorization grant, where the CAPIF core function (see 3GPP TS 29.222 [8]) plays the role of the authorization server. + +NOTE 1: In this release, only "Client Credentials" authorization grant is supported. + +If OAuth2 is used as the selected security method between the NF service consumer (e.g. the Application Server) and the MSGin5G Server, the the NF service consumer (e.g. the Application Server), prior to consuming services offered by the MSGin5G APIs, shall obtain a "token" from the authorization server, by invoking the Obtain\_Authorization service, as described in 3GPP TS 29.222 [8], clause 5.6.2.3.2. + +The MSGin5G APIs do not define any scopes for OAuth2 authorization. It is the MSGin5G Server responsibility to check whether the NF service consumer (e.g. the Application Server) is authorized to use an API based on the "token". Once the MSGin5G Server verifies the "token", it shall check whether the MSGin5G Server identifier in the "token" matches its own published identifier, and whether the API name in the "token" matches its own published API name. If those checks are passed, the NF service consumer (e.g. the Application Server) has full authority to access any resource or operation for the invoked API. + +NOTE 2: For aforementioned security methods, the MSGin5G Server needs to apply admission control according to access control policies after performing the authorization checks. + +--- + +## 12 Usage of Network Capabilities + +As specified in 3GPP TS 23.554 [2], MSGin5G Server may perform procedures of UE reachability monitoring and device triggering by consuming the 3GPP core network capabilities from SCEF/NEF as specified in 3GPP TS 29.522 [23], with description of the AF applies to the MSGin5G Server. With usage of network capabilities, the following procedure for UE reachability monitoring and device triggering procedure could be supported. Upon the MSGin5G Server receiving a request to send MSGin5G message to a MSGin5G UE, the MSGin5G Server may determine whether the recipient MSGin5G Client is not reachable: + +- by using the recipient's information received when performing the procedures specified in clause 8.9.2.2 of 3GPP TS 23.554 [2]; or +- by using the recipient's availability information provided by MSGin5G Client at registration as specified in clause 8.2.1 of 3GPP TS 23.554 [2]. + +If the recipient MSGin5G Client is not reachable, the MSGin5G Server may send a request for device triggering to SCEF/NEF as specified in clause 4.4.3 of 3GPP TS 29.522 [23]. The request uses the information provided by the MSGin5G Client at registration in the MSGin5G Client Triggering Information IE. And the MSGin5G Server may use the MSGin5G Client communication availability and/or pre-configured information to determine the timing of the device triggering request, e.g. the trigger request may be sent to ensure that the target UE is reachable prior to resuming MSGin5G communications. + +As specified in clause 4.4.6 of 3GPP TS 29.122 [24], upon the MSGin5G Server receiving an HTTP POST request from SCEF/NEF indicating the result of the triggering delivery, the MSGin5G Server shall respond with an HTTP 200 OK or 204 No Content response. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex is based on the OpenAPI Specification [6] and provides corresponding representations of all APIs defined in the present specification. + +NOTE 1: An OpenAPIs representation embeds JSON Schema representations of HTTP message bodies. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 2: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [18] and clause 5.3.1 of the 3GPP TS 29.501 [9] for further information). + +## A.2 MSGS\_ASRegistration API + +``` +openapi: 3.0.0 +info: + title: MSGS_ASRegistration + version: 1.1.0-alpha.2 + description: | + API for MSGS AS Registration Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.538 V18.4.0; Enabling MSGin5G Service; Application Programming Interfaces (API) + specification; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.538/ + +servers: + - url: '{apiRoot}/msgs-asregistration/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /registrations: + post: + summary: Registers a new AS at a MSGin5G Server + tags: + - AS registration + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ASRegistration' + responses: + '201': + description: AS information is registered successfully at MSGin5G Server + content: + application/json: + schema: + $ref: '#/components/schemas/ASRegistrationAck' +``` + +``` +headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/registrations/{registrationId}: + delete: + summary: Delete an existing AS registration at MSGin5G Server + tags: + - AS DeRegistration + parameters: + - name: registrationId + in: path + description: AS registration Id + required: true + schema: + type: string + responses: + '200': + description: The individual AS registration is deleted successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/ASRegistrationAck' + '204': + description: > + No Content. The individual AS registration resource is deleted successfully. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} +``` + +``` + +schemas: +# +# STRUCTURED DATA TYPES +# + ASRegistration: + description: AS registration data + type: object + required: + - asSvcId + properties: + asSvcId: + type: string + appId: + type: string + targetUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + asProf: + $ref: '#/components/schemas/ASProfile' + + ASRegistrationAck: + description: AS registration response data + type: object + required: + - asSvcId + - result + properties: + asSvcId: + type: string + result: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + + ASProfile: + description: AS profile information + type: object + properties: + appName: + type: string + appProviders: + type: array + items: + type: string + minItems: 1 + description: The provider of the AS. + appSenarios: + type: array + items: + type: string + minItems: 1 + description: The application scenario. + appCategory: + type: string + asStatus: + type: string + +``` + +## A.3 MSGS\_MSGDelivery API + +``` + +openapi: 3.0.0 +info: + title: MSGS_MSGDelivery + version: 1.1.0-alpha.3 + description: | + API for MSGG MSGin5G Server Message Delivery Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.538 V18.4.0; Enabling MSGin5G Service; Application Programming Interfaces (API) + specification; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.538/ + +servers: +- url: '{apiRoot}/msgs-msgdelivery/v1' + variables: + +``` + +``` +apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: +- {} +- oAuth2ClientCredentials: [] + +paths: + /deliver-as-message: + post: + summary: AS deliver message to MSGin5G Server + tags: + - AS Message delivery + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ASMessageDelivery' + responses: + '200': + description: OK, AS Message delivery successful + content: + application/json: + schema: + $ref: '#/components/schemas/MessageDeliveryAck' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /deliver-ue-message: + post: + summary: UE deliver message to MSGin5G Server + tags: + - UE Message delivery + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UEMessageDelivery' + responses: + '200': + description: OK, UE Message delivery successful + content: + application/json: + schema: + $ref: '#/components/schemas/MessageDeliveryAck' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/deliver-report: + post: + summary: AS or UE deliver status report to MSGin5G Server + tags: + - AS/UE status report delivery + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryStatusReport' + responses: + '200': + description: OK, status report delivery successfully + content: + application/json: + schema: + $ref: '#/components/schemas/MessageDeliveryAck' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: +# +# STRUCTURED DATA TYPES +# + ASMessageDelivery: + description: Contains the AS message delivery data + type: object + required: + - oriAddr + - destAddr + - msgId + - stoAndFwInd +``` + +``` +properties: + oriAddr: + $ref: 'TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address' + destAddr: + $ref: 'TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address' + appId: + type: string + msgId: + type: string + delivStReqInd: + type: boolean + payload: + type: string + priority: + $ref: '#/components/schemas/Priority' + segInd: + type: boolean + segParams: + $ref: '#/components/schemas/MessageSegmentParameters' + stoAndFwInd: + type: boolean + stoAndFwParams: + $ref: '#/components/schemas/StoreAndForwardParameters' + latency: + type: integer + +UEMessageDelivery: + description: Contains the UE message delivery data + type: object + required: + - oriAddr + - destAddr + - msgId + - stoAndFwInd + properties: + oriAddr: + $ref: 'TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address' + destAddr: + $ref: 'TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address' + appId: + type: string + msgId: + type: string + delivStReqInd: + type: boolean + payload: + type: string + segInd: + type: boolean + segParams: + $ref: '#/components/schemas/MessageSegmentParameters' + stoAndFwInd: + type: boolean + stoAndFwParams: + $ref: '#/components/schemas/StoreAndForwardParameters' + +MessageDeliveryAck: + description: Contains the message delivery ack data + type: object + required: + - oriAddr + - msgId + properties: + oriAddr: + $ref: 'TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address' + msgId: + type: string + status: + $ref: '#/components/schemas/DeliveryStatus' + failureCause: + type: string + +MessageSegmentParameters: + description: Contains the message segment parameters data + type: object + properties: + segId: + type: string +``` + +``` +totalSegCount: + type: integer +segNumb: + type: integer +lastSegFlag: + type: boolean + +StoreAndForwardParameters: + description: Contains the store and forward parameters data + type: object + properties: + exprTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +DeliveryStatusReport: + description: Contains the delivery status report data + type: object + required: + - oriAddr + - destAddr + - msgId + - delivSt + properties: + oriAddr: + $ref: 'TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address' + destAddr: + $ref: 'TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address' + msgId: + type: string + failureCause: + type: string + delivSt: + $ref: '#/components/schemas/ReportDeliveryStatus' + +# +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + +DeliveryStatus: + anyOf: + - type: string + enum: + - DELY_FAILED + - DELY_STORED + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Indicates if delivery is a failure, or if the message is stored for deferred delivery. + Possible values are: + - DELY_FAILED: Indicates that the message delivery is failed. + - DELY_STORED: Indicates that the message is stored for deferred delivery. + +ReportDeliveryStatus: + anyOf: + - type: string + enum: + - REPT_DELY_SUCCESS + - REPT_DELY_FAILED + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + The delivery status description, including success or failure in delivery. + Possible values are: + - REPT_DELY_SUCCESS: Indicates that the report delivery is successful. + - REPT_DELY_FAILED: Indicates that the report delivery is failed. + +Priority: + anyOf: +``` + +``` + +- type: string +enum: + - HIGH + - MIDDLE + - LOW +- type: string +description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +description: | + Application priority level requested for this message. + Possible values are: + - HIGH: Indicates the messages should be sent in high priority. + - MIDDLE: Indicates the messages should be sent in middle priority. + - LOW: Indicates the messages should be sent in low priority. + +``` + +## A.4 MSGG\_L3GDelivery API + +``` + +openapi: 3.0.0 +info: + title: MSGG_L3GDelivery + version: 1.1.0-alpha.2 + description: | + API for MSGG L3G Message Delivery Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.538 V18.4.0; Enabling MSGin5G Service; Application Programming Interfaces (API) + specification; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.538/ + +servers: + - url: '{apiRoot}/msgg-l3gdelivery/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /deliver-message: + post: + summary: deliver message to Legacy 3GPP Message Gateway + tags: + - L3G Message delivery + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/L3gMessageDelivery' + responses: + '204': + description: No Content, Message delivery successful + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/deliver-report: + post: + summary: deliver status report to Legacy 3GPP Message Gateway + tags: + - L3G status report delivery + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29538_MSGS_MSGDelivery.yaml#/components/schemas/DeliveryStatusReport' + responses: + '204': + description: No Content, status report delivery successfully + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: +# +# STRUCTURED DATA TYPES +# + L3gMessageDelivery: + description: Contains the L3G message delivery data + type: object + required: + - oriAddr + - destAddr + - msgId + properties: + oriAddr: + $ref: '#/components/schemas/Address' + destAddr: + $ref: '#/components/schemas/Address' + appId: + type: string + msgId: + type: string + delivStReqInd: +``` + +``` + + type: boolean + payload: + type: string + segInd: + type: boolean + segParams: + $ref: 'TS29538_MSGS_MSGDelivery.yaml#/components/schemas/MessageSegmentParameters' + +Address: + description: Contains the Message type data + type: object + required: + - addrType + - addr + properties: + addrType: + $ref: '#/components/schemas/AddressType' + addr: + type: string + +# +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + +AddressType: + anyOf: + - type: string + enum: + - UE + - AS + - GROUP + - BC + - TOPIC + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Represent the type of message request. + Possible values are: + - UE: The address type is UE. + - AS: The address type is AS. + - GROUP: The address type is GROUP. + - BC: The address type is BC. + - TOPIC: The address type is TOPIC. + +``` + +## A.5 MSGG\_N3GDelivery API + +``` + +openapi: 3.0.0 +info: + title: MSGG_N3GDelivery + version: 1.1.0-alpha.1 + description: | + API for MSGG N3G Message Delivery Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.538 V18.4.0; Enabling MSGin5G Service; Application Programming Interfaces (API) + specification; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.538/ + +servers: +- url: '{apiRoot}/msgg-n3gdelivery/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +``` + +``` +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /deliver-message: + post: + summary: deliver message to NON-3GPP Message Gateway + tags: + - N3G Message delivery + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/N3gMessageDelivery' + responses: + '204': + description: No Content, Message delivery successful + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /deliver-report: + post: + summary: deliver status report to NON-3GPP Message Gateway + tags: + - N3G status report delivery + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29538_MSGS_MSGDelivery.yaml#/components/schemas/DeliveryStatusReport' + responses: + '204': + description: No Content, status report delivery successfully + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: +# +# STRUCTURED DATA TYPES +# + N3gMessageDelivery: + description: N3G message delivery data + type: object + required: + - oriAddr + - destAddr + - msgId + properties: + oriAddr: + $ref: 'TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address' + destAddr: + $ref: 'TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address' + appId: + type: string + msgId: + type: string + delivStReqInd: + type: boolean + payload: + type: string + segInd: + type: boolean + segParams: + $ref: 'TS29538_MSGS_MSGDelivery.yaml#/components/schemas/MessageSegmentParameters' +``` + +## A.6 MSGG\_BGDelivery API + +``` +openapi: 3.0.0 + +info: + title: MSGG_BGDelivery + version: 1.0.0-alpha.2 + description: | + API for Broadcast Message Delivery Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.538 V18.4.0; Enabling MSGin5G Service; Application Programming Interfaces (API) + specification; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.538/ + +servers: + - url: '{apiRoot}/msgg-bgdelivery/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /deliver-message: + post: +``` + +``` +summary: deliver message to Broadcast Message Gateway +tags: + - Broadcast Message delivery +requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BgMessageDelivery' +responses: + '204': + description: No Content, Message delivery successful + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: +# +# STRUCTURED DATA TYPES +# +BgMessageDelivery: + description: Broadcast message delivery data + type: object + required: + - oriAddr + - destAddr + - msgId + properties: + oriAddr: + $ref: 'TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address' + destAddr: + $ref: 'TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address' + appId: + type: string + msgId: + type: string + delivStReqInd: + type: boolean + payload: + type: string + segInd: + type: boolean + segParams: + $ref: 'TS29538_MSGS_MSGDelivery.yaml#/components/schemas/MessageSegmentParameters' + priority: + $ref: 'TS29538_MSGS_MSGDelivery.yaml#/components/schemas/Priority' +``` + + + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-10 | CT3#118-e | C3-215030 | | | | Draft skeleton provided by the rapporteur | 0.0.0 | +| 2021-10 | CT3#118-e | C3-215479 | | | | Inclusion of documents agreed in CT3#118e C3-215116, C3-215165, C3-215206, C3-215432, C3-215441, C3-215462. Editorial change from the rapporteur. Correction from the rapporteur. | 0.1.0 | +| 2021-11 | CT3#119-e | C3-216552 | | | | Inclusion of documents agreed in CT3#119e C3-216175, C3-216525, C3-216528, C3-216529, C3-216545, C3-216546, C3-216581. Correction from the rapporteur. | 0.2.0 | +| 2022-01 | CT3#119bis-e | C3-220458 | | | | Inclusion of documents agreed in CT3#119bis-e C3-220384, C3-220385, C3-220386, C3-220387, C3-220389, C3-220391, C3-220410, C3-220411, C3-220412 and C3-220413. Correction from the rapporteur. | 0.3.0 | +| 2022-02 | CT3#120e | C3-221559 | | | | Inclusion of documents agreed in CT3#120e C3-221245, C3-221246, C3-221247, C3-221248, C3-221249, C3-221529, C3-221530, C3-221531, C3-221532, C3-221533, C3-222534, C3-221535, C3-221536, C3-221537, C3-221538, C3-221541, C3-221542, C3-221543, C3-221544, C3-221545, C3-221546, C3-221547, C3-221548 and C3-221549. Correction from the rapporteur. | 0.4.0 | +| 2022-03 | CT#95e | CP-220163 | | | | Presentation to TSG CT for approval | 1.0.0 | +| 2022-03 | CT#95e | CP-220163 | | | | Approved by TSG CT | 17.0.0 | +| 2022-06 | CT#96 | CP-221118 | 0001 | 1 | B | Add Usage of Network Capabilities in MSGin5G Server | 17.1.0 | +| 2022-06 | CT#96 | CP-221118 | 0002 | 1 | F | Update of abbreviations and terms | 17.1.0 | +| 2022-06 | CT#96 | CP-221118 | 0003 | 1 | F | Update the Presence condition of appId in Table 8.1.5.2.2-1 | 17.1.0 | +| 2022-06 | CT#96 | CP-221151 | 0004 | | F | Update of info and externalDocs fields | 17.1.0 | +| 2022-09 | CT#97e | CP-222092 | 0005 | 2 | F | Update the Presence condition of Store and forward flag | 17.2.0 | +| 2022-12 | CT#98-e | CP-223199 | 0007 | 1 | F | MSGS_ASRegistration_Deregister operation related corrections in the description clause | 18.0.0 | +| 2022-12 | CT#98-e | CP-223199 | 0008 | 1 | F | MSGS_ASRegistration_Request operation related corrections in the description clause | 18.0.0 | +| 2022-12 | CT#98-e | CP-223185 | 0009 | | F | "Error handling" clause: alignment with other NBI and 5GS APIs | 18.0.0 | +| 2022-12 | CT#98-e | CP-223200 | 0010 | 1 | F | Rewording some description of data structure in clause 5.3.2 | 18.0.0 | +| 2022-12 | CT#98-e | CP-223200 | 0011 | 1 | F | Change the underline to hyphen of the apiname in clause 5.1 | 18.0.0 | +| 2022-12 | CT#98-e | CP-223189 | 0012 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230156 | 0013 | 1 | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0014 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231150 | 0015 | 1 | B | Update of Scope for Broadcast Messaging | 18.2.0 | +| 2023-06 | CT#100 | CP-231150 | 0016 | 1 | D | Editorial Fixes of Words and Numbers | 18.2.0 | +| 2023-06 | CT#100 | CP-231150 | 0017 | 1 | B | Update the terms and overview | 18.2.0 | +| 2023-06 | CT#100 | CP-231150 | 0018 | 1 | B | MSGG_BGDelivery Service introduction | 18.2.0 | +| 2023-06 | CT#100 | CP-231150 | 0019 | 1 | B | MSGG_BGDelivery service description and operations | 18.2.0 | +| 2023-06 | CT#100 | CP-231150 | 0020 | 1 | B | MSGG_BGDelivery API | 18.2.0 | +| 2023-06 | CT#100 | CP-231337 | 0021 | 1 | B | New OpenAPI file for MSGG_BGDelivery API | 18.2.0 | +| 2023-06 | CT#100 | CP-231150 | 0022 | 1 | B | Update Scope for Topic Messaging | 18.2.0 | +| 2023-06 | CT#100 | CP-231150 | 0023 | 1 | B | Add service of Topic Messaging | 18.2.0 | +| 2023-06 | CT#100 | CP-231150 | 0024 | 1 | D | Reference Clause Number Correction | 18.2.0 | +| 2023-08 | CT#101 | CP-232111 | 0026 | 1 | F | Remove the IE of security credentials in message delivery procedures | 18.3.0 | +| 2023-08 | CT#101 | CP-232111 | 0027 | | F | Corrections on MSGS_BGDelivery API | 18.3.0 | +| 2023-08 | CT#101 | CP-232111 | 0028 | 1 | F | Update the service operations of message delivery status report | 18.3.0 | +| 2023-08 | CT#101 | CP-232085 | 0029 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | C3-234522 | 0030 | 1 | F | Correction on the openAPI files | 18.4.0 | +| 2023-12 | CT#102 | C3-234453 | 0032 | 1 | F | Corrections to BgMessageDelivery data type | 18.4.0 | +| 2023-12 | CT#102 | C3-234517 | 0033 | 1 | B | Introduction update for Messaging Topic Events | 18.4.0 | +| 2023-12 | CT#102 | C3-234519 | 0034 | 1 | B | Service Description of Messaging Topic Events | 18.4.0 | +| 2023-12 | CT#102 | C3-234521 | 0035 | 1 | B | Service Operation for Messaging Topic List Subscription | 18.4.0 | +| 2023-12 | CT#102 | C3-234546 | 0036 | 1 | B | Service Operation for Messaging Topic Subscription | 18.4.0 | +| 2023-12 | CT#102 | C3-234701 | 0037 | 2 | B | Messaging Topic Events API | 18.4.0 | +| 2023-12 | CT#102 | C3-234700 | 0039 | 2 | F | Correction on Terms and Abbreviations | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------|--------| +| 2023-12 | CT#102 | C3-235483 | 0040 | 1 | F | Corrections to BgMessageDelivery data type | 18.4.0 | +| 2023-12 | CT#102 | C3-235343 | 0041 | | F | Correction on Messaging Topic Events API | 18.4.0 | +| 2023-12 | CT#102 | C3-235573 | 0042 | 1 | F | IETF HTTP RFCs obsoleted by RFCs 9110, 9111, 9112 and 9113 | 18.4.0 | +| 2023-12 | CT#102 | C3-235450 | 0044 | | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29542/raw.md b/raw/rel-18/29_series/29542/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..fbefaee8fd3d3403b754cc50d7ef3cefabcfa8f7 --- /dev/null +++ b/raw/rel-18/29_series/29542/raw.md @@ -0,0 +1,849 @@ + + +# 3GPP TS 29.542 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Session Management Services for Non-IP Data Delivery (NIDD); Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the letters is a red signal wave icon, and below that, the text 'A GLOBAL INITIATIVE' in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +# --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations ..... | 7 | +| 3.1 Terms..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Overview..... | 7 | +| 4.1 Introduction ..... | 7 | +| 5 Services offered by the SMF for NIDD ..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Nsmf_NIDD Service ..... | 8 | +| 5.2.1 Service Description ..... | 8 | +| 5.2.2 Service Operations..... | 8 | +| 5.2.2.1 Introduction..... | 8 | +| 5.2.2.2 Delivery ..... | 8 | +| 5.2.2.2.1 General ..... | 8 | +| 6 API Definitions ..... | 9 | +| 6.1 Nsmf_NIDD Service API..... | 9 | +| 6.1.1 Introduction ..... | 9 | +| 6.1.2 Usage of HTTP..... | 9 | +| 6.1.2.1 General..... | 9 | +| 6.1.2.2 HTTP standard headers..... | 10 | +| 6.1.2.2.1 General ..... | 10 | +| 6.1.2.2.2 Content type ..... | 10 | +| 6.1.2.3 HTTP custom headers..... | 10 | +| 6.1.3 Resources..... | 10 | +| 6.1.3.1 Overview..... | 10 | +| 6.1.3.2 Resource: Individual PDU session ..... | 11 | +| 6.1.3.2.1 Description ..... | 11 | +| 6.1.3.2.2 Resource Definition..... | 11 | +| 6.1.3.2.3 Resource Standard Methods..... | 11 | +| 6.1.3.2.4 Resource Custom Operations..... | 12 | +| 6.1.3.2.4.2.1 Description..... | 12 | +| 6.1.3.2.4.2.2 Operation Definition ..... | 12 | +| 6.1.4 Custom Operations without associated resources ..... | 13 | +| 6.1.5 Notifications ..... | 13 | +| 6.1.6 Data Model ..... | 13 | +| 6.1.6.1 General..... | 13 | +| 6.1.6.2 Structured data types..... | 14 | +| 6.1.6.2.1 Introduction ..... | 14 | +| 6.1.6.2.2 Type: DeliverReqData..... | 14 | +| 6.1.6.2.3 Type: DeliverAddInfo..... | 14 | +| 6.1.6.3 Simple data types and enumerations..... | 14 | +| 6.1.6.3.1 Introduction ..... | 14 | +| 6.1.6.3.2 Simple data types ..... | 14 | +| 6.1.6.4 Data types describing alternative data types or combinations of data types ..... | 14 | +| 6.1.6.4.1 Type: DeliverError ..... | 14 | +| 6.1.6.5 Binary data..... | 15 | +| 6.1.6.5.1 Mobile Terminated Data ..... | 15 | +| 6.1.7 Error Handling ..... | 15 | +| 6.1.7.1 General..... | 15 | +| 6.1.7.2 Protocol Errors ..... | 15 | + +| | | | +|-------------------------------|------------------------------------|-----------| +| 6.1.7.3 | Application Errors..... | 15 | +| 6.1.8 | Feature negotiation ..... | 15 | +| 6.1.9 | Security ..... | 15 | +| 6.1.10 | HTTP redirection..... | 16 | +| Annex A (normative): | OpenAPI specification ..... | 17 | +| A.1 | General..... | 17 | +| A.2 | Nsmf_NIDD API ..... | 17 | +| Annex B (informative): | Change history ..... | 20 | + +# Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nsmf Service Based Interfaces for Non-IP Data Delivery (NIDD). It provides stage 3 protocol definitions and message flows, and specifies the API for the service offered by the SMF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". + +- [14] 3GPP TS 29.541: "5G System (5GS); Network Exposure (NE) function services for Non-IP Data Delivery (NIDD) and Short Message Services (SMS); Stage 3". +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Terms + +Void. + +## 3.2 Symbols + +Void. + +## 3.3 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]. + +| | | +|-------|-----------------------------------------| +| 5GC | 5G Core Network | +| AMF | Access and Mobility Management Function | +| H-SMF | Home SMF | +| I-SMF | Intermediate SMF | +| NEF | Network Exposure Function | +| NIDD | Non-IP Data Delivery | +| MT | Mobile Terminated | +| SMF | Session Management Function | +| V-SMF | Visited SMF | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the SMF offers services to the NF service consumers via the Nsmf service based interface (see 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the services specified within the present specification. + +![Reference model diagram showing the NEF connected to the SMF via the N29 reference point.](06da11ab76cacc38bbcd714e437797ea_img.jpg) + +The diagram illustrates the reference model for the SMF. It features two main components: a Network Exposure Function (NEF) on the left and a Session Management Function (SMF) on the right. The NEF is represented by a light green rectangle. The SMF is represented by a larger light green rectangle with a semi-circular interface on its left side. A horizontal line connects the NEF to the SMF's interface. This line is labeled with 'N29' near the NEF and 'Nsmf' near the SMF's interface, indicating the reference point and service based interface respectively. + +Reference model diagram showing the NEF connected to the SMF via the N29 reference point. + +Figure 4.1-1: Reference model – SMF + +N29 is the reference point between the (H-)SMF and the NEF. + +The functionalities supported by the SMF are listed in clause 6.2.2 of 3GPP TS 23.501 [2]. + +# 5 Services offered by the SMF for NIDD + +## 5.1 Introduction + +The SMF supports the following service(s) for NIDD. + +**Table 5.1-1: NF Service(s) provided by SMF for NIDD** + +| Service Name | Description | Example Consumer | +|--------------|---------------------------------------------------------------------------------|------------------| +| Nsmf_NIDD | This service allows the NF consumer NF to deliver NIDD MT data to PDU sessions. | NEF | + +## 5.2 Nsmf\_NIDD Service + +### 5.2.1 Service Description + +The Nsmf\_NIDD service operates on the PDU Sessions. The service operations exposed by this service allow an NF consumer (i.e. NEF) to deliver NEF anchored Mobile Terminated (MT) data for a given PDU session of a UE towards the SMF. + +The Nsmf\_NIDD service supports the following service operations: + +**Table 5.2.1-1: Service operations supported by the Nsmf\_NIDD service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|---------------------------------------------------------|---------------------|---------------------| +| Delivery | Deliver MT NIDD user data to the PDU session of the UE. | Request/Response | NEF | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +See Table 5.2.1-1 for an overview of the service operations supported by the Nsmf\_NIDD service. + +#### 5.2.2.2 Delivery + +##### 5.2.2.2.1 General + +The Delivery service operation shall be used to transfer NEF anchored MT data for a given PDU session. + +It is used in the following procedures: + +- NEF anchored Mobile Terminated Data Transport (see clause 4.25.5 of 3GPP TS 23.502 [3]). + +The NF Service Consumer (i.e. NEF) shall deliver MT data to the SMF by using the HTTP POST method ("deliver" custom operation) as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram showing the transfer of MT data from an NF Service Consumer to an SMF. The consumer sends a POST request to the URI '.../pdu-sessions/{pduSessionRef}/deliver' with 'DeliverReqData'. The SMF responds with either a 204 No Content (2a) or an error status code (2b) such as 4xx/5xx (DeliverError/ProblemDetails) or 3xx.](562f471e8153729557e6a4ee6343c32c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: 1. POST .../pdu-sessions/{pduSessionRef}/deliver (DeliverReqData) + NF Service Consumer->>SMF: Request + Note left of SMF: 2a. 204 No Content + SMF-->>NF Service Consumer: Response 2a + Note left of SMF: 2b. 4xx/5xx (DeliverError/ProblemDetails) or 3xx + SMF-->>NF Service Consumer: Response 2b + +``` + +Sequence diagram showing the transfer of MT data from an NF Service Consumer to an SMF. The consumer sends a POST request to the URI '.../pdu-sessions/{pduSessionRef}/deliver' with 'DeliverReqData'. The SMF responds with either a 204 No Content (2a) or an error status code (2b) such as 4xx/5xx (DeliverError/ProblemDetails) or 3xx. + +**Figure 5.2.2.2.1-1: Transfer MT Data** + +1. The NF Service Consumer shall send a POST request to the URI of "deliver" custom operation on an Individual PDU session resource in the SMF. The content of the POST request shall contain the MT data to be delivered. + +NOTE: The URI of the individual PDU session resource is provided by SMF to the NEF during SMF-NEF connection creation (see clause 5.2.2.2.1 of 3GPP TS 29.541 [14]). + +- 2a. On success, "204 No Content" shall be returned. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a DeliverError or ProblemDetails object, with the "cause" attribute indicating the cause of the failure. If Estimated Maximum Waiting Time is received from AMF, the SMF shall include it in the message body. + +# 6 API Definitions + +## 6.1 Nsmf\_NIDD Service API + +### 6.1.1 Introduction + +The Nsmf\_NIDD service shall use the Nsmf\_NIDD API. + +The API URI of the Nsmf\_NIDD API shall be: + +**{apiRoot}///** + +The request URI used in HTTP request 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}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nsmf-nidd". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [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 Nsmf\_NIDD API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- the JSON format (IETF RFC 8259 [12]). The use of the JSON format shall be signalled by the content type "application/json". See also clause 5.4 of 3GPP TS 29.500 [4]. +- the Problem Details JSON Object (IETF RFC 9457 [13]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +NOTE: "application/json" is used in a response that includes a payload body containing an application-specific data structure, see clause 4.8 of 3GPP TS 29.501 [5]. + +Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one or two binary body parts with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported. + +**Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|-----------------|-------------------------------------------------------------------------------------------------------| +| vnd.3gpp.5gnas | Binary encoded payload, encoding a 5GS NAS message or 5G NAS IEs, as specified in 3GPP TS 24.501 [7]. | + +See clause 6.1.6.5 for the binary payloads supported in the binary body part of multipart messages. + +#### 6.1.2.3 HTTP custom headers + +In this release of the specification, no specific custom headers are defined for the Nsmf\_NIDD service. + +For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +Figure 6.1.3.1-1 describes the resource URI structure of the Nsmf\_NIDD API. + +![Figure 6.1.3.1-1: Resource URI structure of the Nsmf_NIDD API. The diagram shows a hierarchical tree structure of URI paths. The root is {apiRoot}/nsmf-nidd/. It branches to /pdu-sessions, which branches to /{pduSessionRef}, which finally branches to /deliver. The /deliver path is enclosed in a dashed box.](e9314c83043183351ed74908e9bf2f90_img.jpg) + +``` + + {apiRoot}/nsmf-nidd/ + | + +-- /pdu-sessions + | + +-- /{pduSessionRef} + | + +-- /deliver + +``` + +Figure 6.1.3.1-1: Resource URI structure of the Nsmf\_NIDD API. The diagram shows a hierarchical tree structure of URI paths. The root is {apiRoot}/nsmf-nidd/. It branches to /pdu-sessions, which branches to /{pduSessionRef}, which finally branches to /deliver. The /deliver path is enclosed in a dashed box. + +**Figure 6.1.3.1-1: Resource URI structure of the Nsmf\_NIDD API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------|---------------------------------------|---------------------------------|----------------------------| +| Individual PDU session | /pdu-sessions/{pduSessionRef}/deliver | deliver (POST) | Delivery Service Operation | + +#### 6.1.3.2 Resource: Individual PDU session + +##### 6.1.3.2.1 Description + +This resource represents an individual PDU session created in SMF for NIDD. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nsmf-nidd//pdu-sessions/{pduSessionRef} + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------------|-------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| pduSessionRef | PDU session reference assigned by the SMF during SMF-NEF Connection creation. | + +##### 6.1.3.2.3 Resource Standard Methods + +None. + +##### 6.1.3.2.4 Resource Custom Operations + +###### 6.1.3.2.4.1 Overview + +**Table 6.1.3.2.4.1-1: Custom operations** + +| Custom operation URI | Mapped HTTP method | Description | +|-----------------------|--------------------|-----------------------------| +| {resourceUri}/deliver | POST | Delivery service operation. | + +###### 6.1.3.2.4.2 Operation: deliver + +###### 6.1.3.2.4.2.1 Description + +This custom operation enables to deliver NEF anchored MT data for a given PDU session towards the SMF. + +###### 6.1.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.2-2. + +**Table 6.1.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|----------------------------------------------------| +| DeliverReqData | M | 1 | Representation of the payload of a Deliver Request | + +**Table 6.1.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful delivery of MT data. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| DeliverError | O | 0..1 | 504 Gateway Timeout | The "cause" attribute may be used to indicate the following application errors:
- UE_NOT_REACHABLE, if the UE is not reachable to deliver the mobile terminated data; if Estimated Maximum Waiting Time shall be included if available;

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.2.2-3: 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 on an alternative service instance within the same SMF or SMF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.2.2-4: 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 on an alternative service instance within the same SMF or SMF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.4 Custom Operations without associated resources + +None + +### 6.1.5 Notifications + +None. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nsmf\_NIDD service based interface protocol. + +**Table 6.1.6.1-1: Nsmf\_NIDD specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------|----------------|-----------------------------------------------|---------------| +| DeliverReqData | 6.1.6.2.2 | Information within Deliver Request | | +| DeliverAddInfo | 6.1.6.2.3 | Deliver Error Response Additional Information | | +| DeliverError | 6.1.6.4.1 | Deliver Error Response | | + +Table 6.1.6.1-2 specifies data types re-used by the N 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 N service based interface. + +**Table 6.1.6.1-2: Nsmf\_NIDD re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|---------------------|------------------------------------------------------------------------------------------------|---------------| +| RefToBinaryData | 3GPP TS 29.571 [15] | Cross-Reference to binary data encoded within a binary body part in an HTTP multipart message. | | +| ProblemDetails | 3GPP TS 29.571 [15] | Error description | | +| DurationSec | 3GPP TS 29.571 [15] | Duration in units of seconds | | +| RedirectResponse | 3GPP TS 29.571 [15] | Redirect Response | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: DeliverReqData + +**Table 6.1.6.2.2-1: Definition of type DeliverReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------|---------------| +| mtData | RefToBinaryData | M | 1 | This IE shall reference the Mobile Terminated Data (see clause 6.1.6.5.1). | | + +##### 6.1.6.2.3 Type: DeliverAddInfo + +**Table 6.1.6.2.3-1: Definition of type DeliverAddInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------------------|---------------| +| maxWaitingTime | DurationSec | C | 0..1 | This IE shall contain the estimated maximum wait time (see clause 4.25.5 of 3GPP 23.502 [3]). | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.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. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +##### 6.1.6.4.1 Type: DeliverError + +**Table 6.1.6.4.1-1: Definition of type DeliverError as a list of "to be combined data types"** + +| Data type | Cardinality | Description | Applicability | +|----------------|-------------|----------------------------------------------------------|---------------| +| ProblemDetails | 1 | Detail information of the problem | | +| DeliverAddInfo | 1 | Additional information to be returned in error response. | | + +#### 6.1.6.5 Binary data + +##### 6.1.6.5.1 Mobile Terminated Data + +Mobile Terminated Data shall encode the Data Contents of the Payload Container specified in 3GPP TS 24.501 [7], using the vnd.3gpp.5gnas content-type, as summarized in Table 6.1.6.5.1-1. + +**Table 6.1.6.5.1-1: Mobile Terminated Data** + +| Mobile Terminated Data | Reference
(3GPP TS 24.501 [7]) | Related NAS SM message | +|---------------------------------------------|-----------------------------------|------------------------| +| Payload container contents in octets 4 to n | 9.11.3.39 | DL NAS Transport | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nsmf\_NIDD 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 Nsmf\_NIDD API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nsmf\_NIDD service are specified. + +#### 6.1.7.3 Application Errors + +The common application errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] may be used for the Nsmf\_NIDD service. + +The application errors defined for the Nsmf\_NIDD service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|---------------------|------------------------------------------| +| UE_NOT_REACHABLE | 504 Gateway Timeout | The UE is not reachable for the service. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nsmf\_NIDD API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nsmf\_NIDD 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 Nsmf\_NIDD 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 Nsmf\_NIDD service. + +The Nsmf\_NIDD API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [15]; it defines a single scope consisting on the name of the service (i.e., "nsmf-nidd"), and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different SMF service instance, within the same SMF or a different SMF of an SMF set, e.g. when an SMF service instance is part of an SMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different SMF producer instance will return the NF Instance ID of the new SMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an SMF within an SMF set redirects a service request to a different SMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new SMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nsmf\_NIDD Service API. It consists of OpenAPI 3.0.0 specifications, in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## --- A.2 Nsmf\_NIDD API + +``` +openapi: 3.0.0 + +info: + version: '1.2.0-alpha.1' + title: 'Nsmf_NIDD' + description: | + SMF NIDD Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.542 V18.0.0; 5G System; Session Management Services for Non-IP Data + Delivery (NIDD); Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.542/ + +servers: + - url: '{apiRoot}/nsmf-nidd/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nsmf-nidd + +paths: + '/pdu-sessions/{pduSessionRef}/deliver': + post: + summary: Delivery Service Operation + tags: + - Individual PDU session + operationId: Deliver + parameters: + - name: pduSessionRef + in: path + description: PDU session reference + required: true + schema: + type: string + requestBody: + description: representation of the payload of Deliver Request + required: true + content: +``` + +``` + + multipart/related: # message with a binary body part + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/DeliverReqData' + binaryMtData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryMtData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: successful transfering of Delivery + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + description: unsuccessful delivery of mobile terminated data - gateway timeout + content: + application/json: + schema: + $ref: '#/components/schemas/DeliverError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nsmf-nidd: Access to the nsmf-nidd API + +schemas: +# +# STRUCTURED DATA TYPES +# + +DeliverReqData: + description: Representation of the payload of a Deliver Request. + type: object + properties: + mtData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + required: + +``` + +- mtData + +DeliverAddInfo: +description: Additional information in an error response to a Deliver Request. +type: object +properties: + maxWaitingTime: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/DurationSec' + +# + +# DATA TYPES DESCRIBING ALTERNATIVE OR COMBINATION OF DATA TYPES + +# + +DeliverError: +description: Representation of the payload in an error response to a Deliver Request. +allOf: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/ProblemDetails' + - \$ref: '#/components/schemas/DeliverAddInfo' + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|----------|-----------|------|-----|-----|-----------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2020-03 | CT4#96-e | C4-201267 | | | | Initial Draft. | | 0.1.0 | +| 2020-03 | CT#87e | CP-200093 | | | | Presented for information and approval | | 1.0.0 | +| 2020-03 | CT#87e | | | | | Approved at CT#87e | | 16.0.0 | +| 2020-06 | CT#88e | CP-201071 | 0001 | 2 | F | Storage of YAML files in ETSI Forge | | 16.1.0 | +| 2020-06 | CT#88e | CP-201046 | 0003 | | F | Miscellaneous Corrections | | 16.1.0 | +| 2020-06 | CT#88e | CP-201073 | 0004 | | F | 29.542 Rel-16 API version and External doc update | | 16.1.0 | +| 2020-09 | CT#89e | CP-202105 | 0005 | | F | Optionality of DeliverError | | 16.2.0 | +| 2020-12 | CT#90e | CP-203032 | 0007 | | F | YAML files in 3GPP Forge | | 16.3.0 | +| 2021-03 | CT#91e | CP-210037 | 0010 | 1 | F | HTTP 3xx redirection | | 17.0.0 | +| 2021-03 | CT#91e | CP-210034 | 0011 | 1 | F | OpenAPI Reference | | 17.0.0 | +| 2021-03 | CT#91e | CP-210054 | 0013 | - | F | 29.542 Rel-16 API version and External doc update | | 17.0.0 | +| 2021-06 | CT#92e | CP-210050 | 0014 | 1 | F | Resolving Warning in Nsmf_NIDD API | | 17.1.0 | +| 2021-06 | CT#92e | CP-210050 | 0017 | 1 | A | Redirect Response | | 17.1.0 | +| 2021-06 | CT#92e | CP-210050 | 0018 | | F | 29.542 Rel-17 API version and External doc update | | 17.1.0 | +| 2021-09 | CT#93e | CP-212060 | 0021 | - | A | 3xx description correction for SCP | | 17.2.0 | +| 2022-03 | CT#95e | CP-220025 | 0025 | 1 | F | SMF reference model update | | 17.3.0 | +| 2022-06 | CT#96 | CP-221051 | 0027 | | F | 29.542 Rel-17 API version and External doc update | | 17.4.0 | +| 2022-12 | CT#98 | CP-223028 | 0029 | 1 | F | Missing Mandatory Status Codes in OpenAPI | | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0030 | | F | 29.542 Rel-18 API version and External doc update | | 18.0.0 | +| 2023-06 | CT#100 | CP-231028 | 0031 | 3 | F | Location header description | | 18.1.0 | +| 2023-09 | CT#101 | CP-232063 | 0035 | 1 | F | Update on the references | | 18.2.0 | +| 2023-12 | CT#102 | CP-233029 | 0036 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | | 18.3.0 | +| 2023-12 | CT#102 | CP-233030 | 0037 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29552/raw.md b/raw/rel-18/29_series/29552/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..0c8742b2613abe5479f71ccca307c21dd0d12b6d --- /dev/null +++ b/raw/rel-18/29_series/29552/raw.md @@ -0,0 +1,4469 @@ + + +# 3GPP TS 29.552 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Network Data Analytics signalling flows; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'G', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations..... | 9 | +| 3.1 Terms..... | 9 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Reference Architecture for Data Analytics..... | 9 | +| 4.1 General ..... | 9 | +| 4.2 Data Collection..... | 10 | +| 4.3 Analytics Exposure ..... | 11 | +| 4.4 Data Storage and Retrieval..... | 12 | +| 4.5 Roaming architecture for data collection and analytics exposure..... | 12 | +| 5 Signalling Flows for the Network Data Analytics Framework..... | 12 | +| 5.1 General ..... | 12 | +| 5.2 Analytics Exposure Procedures..... | 13 | +| 5.2.1 General ..... | 13 | +| 5.2.2 Network data analytics Subscribe/Unsubscribe/Notify ..... | 13 | +| 5.2.2.1 Analytics Subscribe/Unsubscribe/Notify initiated by 5GC NFs, OAM or AFs ..... | 13 | +| 5.2.2.2 Analytics Subscribe/Unsubscribe/Notify initiated by AFs via the NEF..... | 14 | +| 5.2.3 Network data analytics information request..... | 15 | +| 5.2.3.1 Analytics information request initiated by 5GC NFs, OAM or AFs ..... | 15 | +| 5.2.3.2 Analytics information request initiated by AFs via the NEF..... | 16 | +| 5.2.4 Analytics Exposure via DCCF ..... | 16 | +| 5.2.5 Analytics Exposure via DCCF and MFAF..... | 20 | +| 5.2.6 Procedure for Analytics Exposure in Roaming Case ..... | 25 | +| 5.2.6.1 Analytics Exposure from HPLMN to VPLMN for inbound roaming users ..... | 25 | +| 5.2.6.2 Analytics Exposure from VPLMN to HPLMN for outbound roaming users ..... | 26 | +| 5.3 Analytics Aggregation from Multiple NWDAFs..... | 28 | +| 5.3.1 General ..... | 28 | +| 5.3.2 Analytics aggregation with provisioning of Area of Interest ..... | 28 | +| 5.3.3 Analytics aggregation without provisioning of Area of Interest ..... | 30 | +| 5.4 Procedures for Analytics Transferring ..... | 31 | +| 5.4.1 Analytics context transfer initiated by target NWDAF selected by the NWDAF service consumer..... | 31 | +| 5.4.2 Analytics Subscription Transfer initiated by source NWDAF ..... | 33 | +| 5.4.3 Prepared analytics subscription transfer ..... | 36 | +| 5.5 Data Collection..... | 38 | +| 5.5.1 Procedure for Data Collection from NFs..... | 38 | +| 5.5.1.1 Data Collection from NFs..... | 38 | +| 5.5.2 Data collection profile registration ..... | 39 | +| 5.5.3 Procedure for Data Collection using DCCF ..... | 41 | +| 5.5.3.1 Data Collection via DCCF ..... | 41 | +| 5.5.3.2 Data Collection via Messaging Framework..... | 46 | +| 5.5.4 Procedure for Data Collection in Roaming Case..... | 51 | +| 5.5.4.1 Data Collection by H-RE-NWDAF from V-RE-NWDAF for outbound roaming users ..... | 51 | +| 5.5.4.2 Data Collection by V-RE-NWDAF from H-RE-NWDAF for inbound roaming users ..... | 53 | +| 5.6 ML Model provisioning procedures..... | 54 | +| 5.6.1 General ..... | 54 | +| 5.6.2 ML Model Subscribe/Unsubscribe/Notify procedure ..... | 54 | +| 5.6A ML Model Training procedures ..... | 55 | +| 5.6A.1 General ..... | 55 | +| 5.6A.2 ML Model Training Subscribe/Unsubscribe/Notify procedure..... | 55 | +| 5.7 Procedures for Specific Network Data Analytics ..... | 56 | +| 5.7.1 General ..... | 56 | + +| | | | +|---------------------------------------------------|-------------------------------------------------------------------------------|------------| +| 5.7.2 | Network Slice (Instance) load level Analytics ..... | 56 | +| 5.7.3 | Observed Service Experience Analytics..... | 59 | +| 5.7.4 | NF load Analytics..... | 62 | +| 5.7.5 | Network Performance Analytics ..... | 65 | +| 5.7.6 | UE Mobility Analytics ..... | 67 | +| 5.7.7 | UE Communication Analytics..... | 70 | +| 5.7.8 | Expected UE behavioural Analytics..... | 73 | +| 5.7.9 | Abnormal UE behavioural Analytics ..... | 75 | +| 5.7.10 | User Data Congestion Analytics ..... | 76 | +| 5.7.11 | QoS Sustainability Analytics..... | 79 | +| 5.7.12 | Dispersion Analytics ..... | 80 | +| 5.7.13 | WLAN Performance Analytics ..... | 83 | +| 5.7.14 | Session Management Congestion Control Experience Analytics ..... | 85 | +| 5.7.15 | Redundant Transmission Experience Analytics ..... | 86 | +| 5.7.16 | DN Performance Analytics..... | 89 | +| 5.7.17 | PFD Determination Analytics ..... | 91 | +| 5.7.18 | E2E data volume transfer time analytics ..... | 93 | +| 5.7.19 | PDU Session Traffic Analytics ..... | 96 | +| 5.7.20 | Relative Proximity Analytics ..... | 97 | +| 5.7.21 | Movement Behaviour Analytics..... | 100 | +| 5.8 | Procedures for NWDAF Discovery and Selection..... | 101 | +| 5.8.1 | General ..... | 101 | +| 5.8.2 | Procedures related to NRF..... | 101 | +| 5.8.2.1 | General..... | 101 | +| 5.8.2.2 | NWDAF (De-)Registration in NRF..... | 101 | +| 5.8.2.3 | Consumer discovery and selection of NWDAF in NRF..... | 101 | +| 5.8.3 | Procedures related to UDM..... | 102 | +| 5.8.3.1 | General..... | 102 | +| 5.8.3.2 | NWDAF containing AnLF Registration/Deregistration in UDM ..... | 102 | +| 5.8.3.2.1 | NWDAF containing AnLF Registration in UDM..... | 102 | +| 5.8.3.2.2 | NWDAF containing AnLF Update of Registration in UDM..... | 102 | +| 5.8.3.2.3 | NWDAF containing AnLF De-Registration in UDM..... | 103 | +| 5.8.3.3 | Consumer discovery and selection of NWDAF containing AnLF in UDM..... | 104 | +| 5.8.4 | Procedures for PCF learning NWDAF IDs for served UEs ..... | 104 | +| 5.9 | Analytics Data Repository procedures..... | 105 | +| 5.9.1 | General ..... | 105 | +| 5.9.2 | Historical Data and Analytics Storage/Retrieval/Deletion procedure..... | 105 | +| 5.9.3 | Historical Data and Analytics Storage via Notifications..... | 107 | +| 5.10 | Federated Learning among Multiple NWDAFs..... | 109 | +| 5.10.1 | General ..... | 109 | +| 5.10.2 | Procedures related to Federated Learning ..... | 109 | +| 5.10.2.1 | General Procedure for Federated Learning among Multiple NWDAF Instances ..... | 109 | +| 5.10.2.2 | Preparation Procedure for Federated Learning ..... | 113 | +| 5.10.2.3 | Procedure for Maintenance of Federated Learning Process ..... | 113 | +| Annex A (informative): Change history..... | | 116 | + +# Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies detailed call flows of Network Data Analytics over the Nnwdaf, Nsmf, Npcf, Nnsacf, Namf, Nnrf, Nnsnf, Nnef, Naf, Ndcf, Nadrf, Nmfa, Nudm, Nupf and Ngmlc service-based interfaces and their relationship with the flow level signalling in 5G system. + +NOTE: The call flows depicted in this Technical Specification do not cover all traffic cases. + +The stage 2 definition and procedures of Network Data Analytics are contained in 3GPP TS 23.288 [2] and 3GPP TS 23.502 [3]. The 5G System Architecture is defined in 3GPP TS 23.501 [4]. + +Detailed definitions of the involved services are provided in 3GPP TS 29.520 [5], 3GPP TS 29.508 [6], 3GPP TS 29.523 [7], 3GPP TS 29.554 [8], 3GPP TS 29.521 [9], 3GPP TS 29.522 [10], 3GPP TS 29.591 [11], 3GPP TS 29.517 [12], 3GPP TS 29.574 [15], 3GPP TS 29.575 [16], 3GPP TS 29.576 [17], 3GPP TS 29.503 [22], 3GPP TS 29.510 [23], 3GPP TS 29.507 [24], 3GPP TS 29.512 [25], 3GPP TS 29.564 [40] and 3GPP TS 29.515 [41]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition of the 5G System are specified in 3GPP TS 29.500 [13] and 3GPP TS 29.501 [14]. + +# --- 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.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [5] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [6] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [7] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [8] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". +- [9] 3GPP TS 29.521: "5G System; Binding Support Management Service; Stage 3". +- [10] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [11] 3GPP TS 29.591: "5G System; Network Exposure Function Southbound Services; Stage 3". +- [12] 3GPP TS 29.517: "5G System; Application Function Event Exposure Service; Stage 3". +- [13] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [14] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [15] 3GPP TS 29.574: "5G System; Data Collection Coordination Services; Stage 3". + +- [16] 3GPP TS 29.575: "5G System; Analytics Data Repository Services; Stage 3". +- [17] 3GPP TS 29.576: "5G System; Messaging Framework Adaptor Services; Stage 3". +- [18] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [19] 3GPP TS 28.532: "Management and orchestration; Generic management services". +- [20] 3GPP TS 29.536: "5G System: Network Slice Admission Control Services; Stage 3". +- [21] 3GPP TS 29.531: "5G System: Network Slice Selection Services; Stage 3". +- [22] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [23] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [24] 3GPP TS 29.507: "5G System; Access and Mobility Policy Control Service; Stage 3". +- [25] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [26] 3GPP TS 29.510: "5G System: Network function repository services; Stage 3". +- [27] 3GPP TS 28.552: "Management and orchestration; 5G performance measurements". +- [28] 3GPP TS 28.533: "Management and orchestration; Architecture framework". +- [29] 3GPP TS 37.320: " Radio measurement collection for Minimization of Drive Tests (MDT); Overall description". +- [30] 3GPP TS 28.554: " Management and orchestration; 5G end to end Key Performance Indicators (KPI)". +- [31] 3GPP TS 28.550: "Management and orchestration; Performance assurance". +- [32] Void. +- [33] 3GPP TS 38.331: "NR; Radio Resource Control (RRC) protocol specification". +- [34] 3GPP TS 36.331: "Radio Resource Control (RRC); Protocol specification". +- [35] 3GPP TS 38.215: "NR; Physical layer measurements". +- [36] 3GPP TS 28.310: "Management and orchestration; Energy efficiency of 5G". +- [37] 3GPP TS 28.545: "Management and orchestration; Fault Supervision (FS)". +- [38] 3GPP TS 28.104: "Management and orchestration; Management Data Analytics (MDA)". +- [39] 3GPP TS 29.551: "5G System; Packet Flow Description Management Service; Stage 3". +- [40] 3GPP TS 29.564: "5G System; User Plane Function Services; Stage 3". +- [41] 3GPP TS 29.515: "5G System; Gateway Mobile Location Services; Stage 3". +- [42] 3GPP TS 28.622: "Generic Network Resource Model (NRM)Integration Reference Point (IRP); Information Service (IS)". +- [43] 3GPP TS 32.422: "Subscriber and equipment trace; Trace control and configuration management". +- [44] 3GPP TS 28.537: "Management and orchestration; Management capabilities". + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms 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 Symbols + +None. + +## 3.3 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]. + +| | | +|----------|--------------------------------------------| +| ADRF | Analytics Data Repository Function | +| AF | Application Function | +| AMF | Access and Mobility Management Function | +| AnLF | Analytics Logical Function | +| CEF | Charging Enablement Function | +| DCCF | Data Collection Coordination Function | +| FL | Federated Learning | +| GMLC | Gateway Mobile Location Centre | +| LMF | Location Management Function | +| MDAF | Management Data Analytics Function | +| MDT | Minimization of Drive Tests | +| MFAF | Messaging Framework Adaptor Function | +| ML | Machine Learning | +| MTLF | Model Training Logical Function | +| NEF | Network Exposure Function | +| NRF | Network Repository Function | +| NSACF | Network Slice Admission Control Function | +| NSSF | Network Slice Selection Function | +| NWDAF | Network Data Analytics Function | +| OAM | Operation, Administration, and Maintenance | +| PCF | Policy Control Function | +| RE-NWDAF | Roaming Exchange NWDAF | +| SMF | Session Management Function | +| UDM | Unified Data Management | +| UPF | User Plane Function | + +# 4 Reference Architecture for Data Analytics + +## 4.1 General + +For the enablement of network data analytics services, the NWDAF interacts with different entities for different purposes: + +- Data Collection: + - a) collecting Data from OAM, MDAF and/or 5GC NFs (e.g. AMF); + - b) collecting Data from untrusted AF via NEF; and/or + +- c) collecting Analytics and/or Data from 5GC NFs via DCCF or via DCCF together with ADRF and/or MFAF or via NWDAF hosting DCCF i.e. an NWDAF that implements DCCF functionality internally and supports the Nnwdaf\_DataManagement API for collecting data, the Nnwdaf\_EventSubscription API for collecting analytics; +- Analytics Exposure: + - a) Exposing Analytics to 5GC NFs; + - b) Exposing Analytics to untrusted AF via NEF; and/or + - c) Exposing Analytics to 5GC NFs via DCCF or via DCCF together with ADRF and/or MFAF or via NWDAF hosting DCCF and/or ADRF i.e. an NWDAF that implements DCCF and/or ADRF functionality internally and supports the Nnwdaf\_EventSubscription API; +- Storing and Retrieving data in ADRF. + +The entities mentioned above interact also with each other as described in the procedures of clause 5. + +## 4.2 Data Collection + +As depicted in Figure 4.2-1, the 5G System architecture allows NWDAF to collect data from any 5GC NF (e.g. AMF, SMF), OAM and/or MDAF directly or via DCCF, DCCF together with ADRF and/or MFAF, or via NWDAF in non-roaming case. The roaming architecture for data collection is defined in clause 4.5. + +![Figure 4.2-1: Data Collection Architecture diagram showing the NWDAF interacting with various network functions for data collection.](c2fc2621e8206d24427b56bcb2398fc0_img.jpg) + +The diagram illustrates the Data Collection Architecture. On the left is a large box labeled 'NWDAF'. On the right is a large box labeled 'Data Source NF (e.g. AMF)'. In the center, there are four boxes representing different network functions or frameworks: 'DCCF', 'MFAF' (which contains a sub-box 'Messaging Framework'), 'ADRF', and 'NWDAF hosting DCCF'. At the bottom right is a box labeled 'Management Data Source (OAM, MDAF)'. Lines with interface labels connect the NWDAF to these central entities: 'Ndcf' to DCCF, 'Nmfaf' to MFAF, 'Nadrf' to ADRF, and 'Nnwdaf' to NWDAF hosting DCCF. From the central entities, lines with interface labels connect to the Data Source NF: 'Nnf' from DCCF, 'Nnf' from MFAF, 'Nnf' from ADRF, and 'Nnf' from NWDAF hosting DCCF. Finally, a line with the interface label 'MnS' connects the Management Data Source (OAM, MDAF) to the NWDAF. + +Figure 4.2-1: Data Collection Architecture diagram showing the NWDAF interacting with various network functions for data collection. + +Figure 4.2-1: Data Collection Architecture + +When DCCF, ADRF, MFAF or NWDAF hosting DCCF are present in the network, whether the NWDAF directly contacts the Data Source NF or goes via the DCCF, or NWDAF hosting DCCF is based on configuration of the NWDAF. + +The Data Source NF may be AMF, SMF, UDM, UPF, GMLC, AF, NSACF, NRF and/or NEF with the related data collection procedures described in clause 5.5. If the Data Source is OAM, the NWDAF may collect relevant management data from the services in the OAM as configured by the PLMN operator with NG RAN or 5GC performance measurements as defined in TS 28.552 [27] and 5G End to end KPIs as defined in TS 28.554 [30]. The NWDAF may use the OAM services e.g. generic performance assurance and fault supervision management services as defined in TS 28.532 [19], PM (Performance Management) services as defined in TS 28.550 [31] and/or FS (Fault Supervision) services as defined in TS 28.545 [37]. The procedure for data collection from OAM is defined in clause 6.2.3.2 of TS 23.288 [2]. The NWDAF may collect the analysis results from MDAF, e.g. service experience and energy saving state analysis and/or end-to-end latency analysis in TS 28.104 [38]. The procedure for analytics collection from MDAF is defined in clause 6.2.14.2 of TS 23.288 [2]. Before NWDAF requests analytics from the MDA Management Function, the NWDAF firstly discovers the MDAF via the MnS discovery service producer as defined in clause 5 of TS 28.537 [42]. + +For the specific analytics event, the applicable Data Source NF(s) and the related data collection procedures and scope are described in the corresponding analytics event subclause within clause 5.7. + +## 4.3 Analytics Exposure + +As depicted in Figure 4.3-1, the 5G System architecture allows NWDAF to expose data to any 5GC NF (e.g. AMF) directly or via DCCF/MFAF in non-roaming case. For roaming case, the roaming architecture as described in clause 4.5 is added between HPLMN and VPLMN. + +![Figure 4.3-1: Analytics Exposing Architecture. This diagram shows the network architecture for analytics exposure. On the left is the 'Analytics consumer (e.g. AMF)'. On the right is the 'NWDAF'. In the center, there are several network functions: 'DCCF', 'MFAF' (which contains a 'Messaging Framework'), 'ADRF', and 'NWDAF hosting DCCF and/or ADRF'. The Analytics consumer connects to DCCF via 'Ndcdf', to MFAF via 'Nmfaf', to ADRF via 'Nadrf', and to the NWDAF hosting box via 'Nnwdaf'. The DCCF connects to the NWDAF via 'Nnwdaf'. The MFAF connects to the NWDAF via 'Nnwdaf'. The ADRF connects to the NWDAF via 'Nnwdaf' and 'Nadrf'. The NWDAF hosting box connects to the NWDAF via 'Nnwdaf'.](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +Figure 4.3-1: Analytics Exposing Architecture. This diagram shows the network architecture for analytics exposure. On the left is the 'Analytics consumer (e.g. AMF)'. On the right is the 'NWDAF'. In the center, there are several network functions: 'DCCF', 'MFAF' (which contains a 'Messaging Framework'), 'ADRF', and 'NWDAF hosting DCCF and/or ADRF'. The Analytics consumer connects to DCCF via 'Ndcdf', to MFAF via 'Nmfaf', to ADRF via 'Nadrf', and to the NWDAF hosting box via 'Nnwdaf'. The DCCF connects to the NWDAF via 'Nnwdaf'. The MFAF connects to the NWDAF via 'Nnwdaf'. The ADRF connects to the NWDAF via 'Nnwdaf' and 'Nadrf'. The NWDAF hosting box connects to the NWDAF via 'Nnwdaf'. + +**Figure 4.3-1: Analytics Exposing Architecture** + +When DCCF, ADRF, MFAF or NWDAF are present in the network, whether the Analytics consumer directly contacts the NWDAF or goes via the DCCF or via the NWDAF hosting DCCF and/or ADRF is based on configuration of the Analytics consumer. + +The Analytics consumer may be AMF, SMF, NSSF, PCF, LMF, AF, NEF, OAM and/or CEF when directly contacts NWDAF with the related analytics exposure procedures described in clause 5.2.2 and clause 5.2.3. The Analytics consumers may be AMF, SMF, NSSF, PCF, LMF, AF and/or NEF when contacts via the DCCF with the related analytics exposure procedures described in clause 5.2.4 and clause 5.2.5. + +For the specific analytics event, the applicable Analytics consumer(s) and the related analytics exposure procedures and scope are described in the corresponding analytics event subclause within clause 5.7. + +## 4.4 Data Storage and Retrieval + +As depicted in Figure 4.4-1, the 5G System architecture allows the consumer to store and retrieve the collected data in the ADRF directly or via DCCF/MFAF. + +![Figure 4.4-1: Data Storage and Retrieval Architecture. The diagram shows an NF (e.g. NWDAF) on the left connected to a DCCF and an MFAF (which contains a Messaging Framework) in the center, and an ADRF on the right. The NF connects to the DCCF via the Ndcclf interface and to the MFAF via the Nmfaf interface. The DCCF and MFAF are connected to each other via the Nmfaf interface. Both the DCCF and the MFAF connect to the ADRF via the Nadrf interface. There is also a direct connection from the NF to the ADRF.](7f17c430b9598e4d748a8041457810b3_img.jpg) + +Figure 4.4-1: Data Storage and Retrieval Architecture. The diagram shows an NF (e.g. NWDAF) on the left connected to a DCCF and an MFAF (which contains a Messaging Framework) in the center, and an ADRF on the right. The NF connects to the DCCF via the Ndcclf interface and to the MFAF via the Nmfaf interface. The DCCF and MFAF are connected to each other via the Nmfaf interface. Both the DCCF and the MFAF connect to the ADRF via the Nadrf interface. There is also a direct connection from the NF to the ADRF. + +Figure 4.4-1: Data Storage and Retrieval Architecture + +## 4.5 Roaming architecture for data collection and analytics exposure + +Based on operator's policy and local regulations (e.g. privacy), data or analytics may be exchanged between PLMNs (i.e. HPLMN and VPLMN) via RE-NWDAF (i.e. an NWDAF with roaming exchange capability in each PLMN used as exchange point to exchange data and/or analytics with other PLMNs) using the architecture shown in Figure 4.5-1. + +![Figure 4.5-1: Roaming Architecture to exchange Data or Analytics between V-PLMN and H-PLMN. The diagram shows two PLMNs: H-PLMN and V-PLMN. In the H-PLMN, an 'Any NF' is connected to an 'H-RE-NWDAF'. In the V-PLMN, a 'V-RE-NWDAF' is connected to an 'Any NF'. The H-RE-NWDAF and the V-RE-NWDAF are connected to each other via the Nnwdaf interface.](fbfa653853daf5541118a9ddecb92284_img.jpg) + +Figure 4.5-1: Roaming Architecture to exchange Data or Analytics between V-PLMN and H-PLMN. The diagram shows two PLMNs: H-PLMN and V-PLMN. In the H-PLMN, an 'Any NF' is connected to an 'H-RE-NWDAF'. In the V-PLMN, a 'V-RE-NWDAF' is connected to an 'Any NF'. The H-RE-NWDAF and the V-RE-NWDAF are connected to each other via the Nnwdaf interface. + +Figure 4.5-1: Roaming Architecture to exchange Data or Analytics between V-PLMN and H-PLMN + +In roaming scenario, the H-RE-NWDAF is the enforcement point to check user consent. The H-RE-NWDAF retrieves the roaming-related user consent for a user from the UDM. + +# 5 Signalling Flows for the Network Data Analytics Framework + +## 5.1 General + +This clause describes the Network Data Analytics related Signalling Flows, including the procedures for analytics exposure, analytics aggregation from multiple NWDAFs, analytics context and analytics subscription transferring between different NWDAFs, ML model provisioning, data collection, specified Network Data Analytics generation and the NWDAF discovery and selection. The specific NF service operations which are used in these procedures are also provided in the procedure descriptions. + +## 5.2 Analytics Exposure Procedures + +### 5.2.1 General + +The analytics exposure procedures allow the NF service consumers (i.e. NFs, OAM and AFs) to obtain the analytics information from the NWDAF. + +### 5.2.2 Network data analytics Subscribe/Unsubscribe/Notify + +#### 5.2.2.1 Analytics Subscribe/Unsubscribe/Notify initiated by 5GC NFs, OAM or AFs + +This procedure is used in non-roaming case by the NF service consumers (i.e. NFs, OAM and AFs) to subscribe to/unsubscribe from analytics information directly from the NWDAF, it is also used by the NWDAF to notify the observed analytics event(s) to the NF service consumer if subscribed before. + +![Sequence diagram showing the interaction between an NF service consumer and the NWDAF for analytics subscription, notification, and unsubscription.](e9d825d87c5f85c8dba0664eace96ef4_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + NF service consumer->>NWDAF: 1. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>NF service consumer: 2. Nnwdaf_EventsSubscription_Subscribe response + Note right of NWDAF: + NWDAF->>NF service consumer: 3. Nnwdaf_EventsSubscription_Notify request + NF service consumer-->>NWDAF: 4. Nnwdaf_EventsSubscription_Notify response + Note left of NF service consumer: + NF service consumer->>NWDAF: 5. Nnwdaf_EventsSubscription_Unsubscribe request + NWDAF-->>NF service consumer: 6. Nnwdaf_EventsSubscription_Unsubscribe response +``` + +The diagram illustrates a sequence of six messages between an 'NF service consumer' and the 'NWDAF'. The sequence starts with the consumer sending a 'Nnwdaf\_EventsSubscription\_Subscribe request' (1) to the NWDAF, which responds with a 'Nnwdaf\_EventsSubscription\_Subscribe response' (2). The NWDAF then sends a 'Nnwdaf\_EventsSubscription\_Notify request' (3) to the consumer, which responds with a 'Nnwdaf\_EventsSubscription\_Notify response' (4). Finally, the consumer sends a 'Nnwdaf\_EventsSubscription\_Unsubscribe request' (5) to the NWDAF, which responds with a 'Nnwdaf\_EventsSubscription\_Unsubscribe response' (6). + +Sequence diagram showing the interaction between an NF service consumer and the NWDAF for analytics subscription, notification, and unsubscription. + +**Figure 5.2.2.1-1: Analytics Subscribe/Unsubscribe/Notify initiated by 5GC NFs, OAM or AFs** + +1. In order to subscribe to notification(s) of analytics information from the NWDAF, the NF service consumer invokes Nnwdaf\_EventsSubscription\_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF Events Subscriptions". The request includes the subscribed events and may include event filter information. + +In order to update the existing subscription, the NF service consumer invokes Nnwdaf\_EventsSubscription\_Subscribe service operation by sending an HTTP PUT request with Resource URI of the resource "Individual NWDAF Event Subscription". + +2. The NWDAF responds to the Nnwdaf\_EventsSubscription\_Subscribe service operation. Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF responds to the NF service consumer with "201 Created", and the URI of the created subscription is included in the Location header field. + +Upon receipt of the HTTP PUT request, if the subscription is accepted to be updated, the NWDAF responds to the NF service consumer with "200 OK" or "204 No Content" + +3. If the NWDAF observes the subscribed event(s), the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation to report the event(s) by sending an HTTP POST request with {notificationURI} as Notification URI. When calculating accuracy information for the analytics or the ML model for which analytics feedback information has been received, in addition to comparing predictions of ML model and its corresponding ground truth data, the NWDAF may additionally determine and take into account whether the action(s) taken by the NF service consumer affects the ground truth data corresponding to Analytics ID requested at the time which the prediction refers to as described in the procedures for Analytics Accuracy Monitoring and ML Model Accuracy Monitoring, which may affect the accuracy calculation. + +**Editor's Note:** It is FFS to move the specification of this behaviour to the procedures for Analytics Accuracy Monitoring and ML Model Accuracy Monitoring if the latter are agreed and added to the specification. + +4. The NF service consumer sends an HTTP "204 No Content" response to the NWDAF. +5. In order to unsubscribe to the notification(s) of analytics information from the NWDAF, the NF service consumer invokes Nnwdaf\_EventsSubscription\_Unsubscribe service operation by sending an HTTP DELETE request targeting the resource "Individual NWDAF Event Subscription", to the NWDAF to unsubscribe from analytics information. The request includes the event subscriptionId of the existing subscription that is to be deleted. +6. The NWDAF responds to the Nnwdaf\_EventsSubscription\_Unsubscribe service operation. If the unsubscribe is accepted, the NWDAF responds with "204 No Content". + +NOTE: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify service operations refer to 3GPP TS 29.520 [5]. + +#### 5.2.2.2 Analytics Subscribe/Unsubscribe/Notify initiated by AFs via the NEF + +This procedure is used by the AF to subscribe to/unsubscribe from analytics information from the NWDAF via the NEF, it is also used by the NWDAF to notify the analytics event(s) to the AF via the NEF, if subscribed before. + +![Sequence diagram showing the interaction between NWDAF, NEF, and AF for Analytics Subscribe/Unsubscribe/Notify initiated by AFs via the NEF. The diagram consists of 12 numbered steps: 1. AF sends Nnef_AnalyticsExposure_Subscribe request to NEF; 2. NEF sends Nnwdaf_EventsSubscription_Subscribe request to NWDAF; 3. NWDAF sends Nnwdaf_EventsSubscription_Subscribe response to NEF; 4. NEF sends Nnef_AnalyticsExposure_Subscribe response to AF; 5. NWDAF sends Nnwdaf_EventsSubscription_Notify request to NEF; 6. NEF sends Nnef_AnalyticsExposure_Notify request to AF; 7. AF sends Nnef_AnalyticsExposure_Notify response to NEF; 8. NEF sends Nnwdaf_EventsSubscription_Notify response to NWDAF; 9. AF sends Nnef_AnalyticsExposure_Unsubscribe request to NEF; 10. NEF sends Nnwdaf_EventsSubscription_Unsubscribe request to NWDAF; 11. NWDAF sends Nnwdaf_EventsSubscription_Unsubscribe response to NEF; 12. NEF sends Nnef_AnalyticsExposure_Unsubscribe response to AF.](f6e8acf9f931452d01688d311b5c0364_img.jpg) + +``` + +sequenceDiagram + participant AF + participant NEF + participant NWDAF + Note right of AF: 1. Nnef_AnalyticsExposure_Subscribe request + AF->>NEF: + Note right of NEF: 2. Nnwdaf_EventsSubscription_Subscribe request + NEF->>NWDAF: + Note right of NWDAF: 3. Nnwdaf_EventsSubscription_Subscribe response + NWDAF->>NEF: + Note right of NEF: 4. Nnef_AnalyticsExposure_Subscribe response + NEF->>AF: + Note right of NWDAF: 5. Nnwdaf_EventsSubscription_Notify request + NWDAF->>NEF: + Note right of NEF: 6. Nnef_AnalyticsExposure_Notify request + NEF->>AF: + Note right of AF: 7. Nnef_AnalyticsExposure_Notify response + AF->>NEF: + Note right of NEF: 8. Nnwdaf_EventsSubscription_Notify response + NEF->>NWDAF: + Note right of AF: 9. Nnef_AnalyticsExposure_Unsubscribe request + AF->>NEF: + Note right of NEF: 10. Nnwdaf_EventsSubscription_Unsubscribe request + NEF->>NWDAF: + Note right of NWDAF: 11. Nnwdaf_EventsSubscription_Unsubscribe response + NWDAF->>NEF: + Note right of NEF: 12. Nnef_AnalyticsExposure_Unsubscribe response + NEF->>AF: + +``` + +Sequence diagram showing the interaction between NWDAF, NEF, and AF for Analytics Subscribe/Unsubscribe/Notify initiated by AFs via the NEF. The diagram consists of 12 numbered steps: 1. AF sends Nnef\_AnalyticsExposure\_Subscribe request to NEF; 2. NEF sends Nnwdaf\_EventsSubscription\_Subscribe request to NWDAF; 3. NWDAF sends Nnwdaf\_EventsSubscription\_Subscribe response to NEF; 4. NEF sends Nnef\_AnalyticsExposure\_Subscribe response to AF; 5. NWDAF sends Nnwdaf\_EventsSubscription\_Notify request to NEF; 6. NEF sends Nnef\_AnalyticsExposure\_Notify request to AF; 7. AF sends Nnef\_AnalyticsExposure\_Notify response to NEF; 8. NEF sends Nnwdaf\_EventsSubscription\_Notify response to NWDAF; 9. AF sends Nnef\_AnalyticsExposure\_Unsubscribe request to NEF; 10. NEF sends Nnwdaf\_EventsSubscription\_Unsubscribe request to NWDAF; 11. NWDAF sends Nnwdaf\_EventsSubscription\_Unsubscribe response to NEF; 12. NEF sends Nnef\_AnalyticsExposure\_Unsubscribe response to AF. + +**Figure 5.2.2.2-1: Analytics Subscribe/Unsubscribe/Notify initiated by AFs via the NEF** + +1. In order to subscribe to notification(s) of analytics exposure via the NEF, the AF invokes the Nnef\_AnalyticsExposure\_Subscribe request by sending an HTTP POST request message targeting the resource "Analytics Exposure Subscriptions" as defined in clause 4.4.14.1 of 3GPP TS 29.522 [10]. + +In order to update an existing analytics exposure subscription, the AF shall send an HTTP PUT request message to the NEF to the resource "Individual Analytics Exposure Subscription" requesting to change the subscription. + +2. Upon receipt of the HTTP request from the AF, if the AF is authorized with the requested analytics event(s) and the requested parameters comply with the inbound restriction in the analytics exposure mapping, the NEF shall invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in step 1 in clause 5.2.2.1. + +3. The NWDAF responds to the Nnwdaf\_EventsSubscription\_Subscribe service operation as described in step 2 in clause 5.2.2.1. +4. Upon receipt of the HTTP request response from the NWDAF, the NEF shall invoke the Nnef\_AnalyticsExposure\_Subscribe response message by mapping and forwarding the response to the AF. +5. If the NWDAF observes the subscribed event(s), the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in step 3 in clause 5.2.2.1 to the NEF. When calculating accuracy information for the analytics or the ML model for which analytics feedback information has been received, in addition to comparing predictions of ML model and its corresponding ground truth data, the NWDAF may additionally determine and take into account whether the action(s) taken by the AF affects the ground truth data corresponding to Analytics ID requested at the time which the prediction refers to as described in the procedures for Analytics Accuracy Monitoring and ML Model Accuracy Monitoring, which may affect the accuracy calculation. + +**Editor's Note:** It is FFS to move the specification of this behaviour to the procedures for Analytics Accuracy Monitoring and ML Model Accuracy Monitoring if the latter are agreed and added to the specification. + +6. If the NEF receives an analytics information notification from the NWDAF indicating that the subscribed analytics event has been detected, the NEF shall invoke the Nnef\_AnalyticsExposure\_Notify request by sending HTTP POST request message provide a notification to the AF request including the AnalyticsEventNotification data structure at least with the detected analytics event identified by the notification URI together with the notification correlation identifier received during creation of the Individual Analytics Exposure Subscription. +7. Upon receipt of the analytics event notification, the AF shall respond the NEF with a "204 No Content" status code to confirm the received notification in Nnef\_AnalyticsExposure\_Notify response message. +8. The NEF shall forward the HTTP "204 No Content" response to the NWDAF. +9. In order to delete an existing analytics exposure subscription, the AF shall invoke the Nnef\_AnalyticsExposure\_Unsubscribe request by sending an HTTP DELETE request message to the NEF to the resource "Individual Analytics Exposure Subscription". +10. If the NEF receives an HTTP DELETE request from the AF, the NEF shall invoke the Nnwdaf\_EventsSubscription\_Unsubscribe service operation as described in step 5 in clause 5.2.2.1. +11. The NWDAF responds to the Nnwdaf\_EventsSubscription\_Unsubscribe service operation as described in step 6 in clause 5.2.2.1. +12. The NEF shall forward the HTTP "204 No Content" response to the AF. + +NOTE: Details of AnalyticsExposure API refer to clause 4.4.14 and clause 5.6 of 3GPP TS 29.522 [4]. + +### 5.2.3 Network data analytics information request + +#### 5.2.3.1 Analytics information request initiated by 5GC NFs, OAM or AFs + +This procedure is used in non-roaming case by the NF service consumers (i.e. 5GC NFs, OAM and AFs) to retrieve analytics information directly from the NWDAF. The analytics architecture for analytics exposure is defined in clause 4.5. + +![Sequence diagram showing the Network data analytics info request procedure. An NF service consumer sends a request to the NWDAF, and the NWDAF responds.](70de8885bd7de15723aaad5eb5c5febf_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + NF service consumer->>NWDAF: 1. Nnwdaf_AnalyticsInfo_Request request + Note right of NWDAF: + NWDAF-->>NF service consumer: 2. Nnwdaf_AnalyticsInfo_Request response +``` + +Sequence diagram showing the Network data analytics info request procedure. An NF service consumer sends a request to the NWDAF, and the NWDAF responds. + +**Figure 5.2.3.1-1: Network data analytics info request procedure** + +1. The NF Service Consumer invokes Nnwdaf\_AnalyticsInfo\_Request service operation by sending an HTTP GET request targeting the resource "NWDAF Analytics", to the NWDAF to request the analytics information. The request includes analytics identifier and related event filter information. +2. The NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation. If the request is accepted, the response includes the requested analytics information with "200 OK". + +NOTE: For details of Nnwdaf\_AnalyticsInfo\_Request service operation refer to 3GPP TS 29.520 [5]. + +#### 5.2.3.2 Analytics information request initiated by AFs via the NEF + +This procedure is used by the AFs to retrieve analytics information from the NWDAF via the NEF. + +![Sequence diagram showing the interaction between NWDAF, NEF, and AF for an analytics request initiated by AFs via the NEF.](cb4cfa42ce34febde7bdb882f3fc3094_img.jpg) + +``` +sequenceDiagram + participant AF + participant NEF + participant NWDAF + Note right of AF: 1. Nnef_AnalyticsExposure_Fetch request + AF->>NEF: 1. Nnef_AnalyticsExposure_Fetch request + Note left of NEF: 2. Nnwdaf_AnalyticsInfo_Request request + NEF->>NWDAF: 2. Nnwdaf_AnalyticsInfo_Request request + Note left of NWDAF: 3. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>NEF: 3. Nnwdaf_AnalyticsInfo_Request response + Note left of NEF: 4. Nnef_AnalyticsExposure_Fetch response + NEF->>AF: 4. Nnef_AnalyticsExposure_Fetch response +``` + +Sequence diagram showing the interaction between NWDAF, NEF, and AF for an analytics request initiated by AFs via the NEF. + +**Figure 5.2.3.2-1: Analytics Request initiated by AFs via the NEF** + +1. In order to fetch analytics information, the AF invoke the Nnef\_AnalyticsExposure\_Fetch request by sending an HTTP POST request message to the NEF to the customized operation URI "{apiRoot}/3gpp-analyticsexposure/v1/fetch" as defined in clause 4.4.14.2 of 3GPP TS 29.522 [10]. +2. Upon receipt of the HTTP request from the AF, if the AF is authorized with the requested analytics event(s) and the requested parameters comply with the inbound restriction in the analytics exposure mapping, the NEF shall invoke the Nnwdaf\_AnalyticsInfo\_Request service operation as described in step 1 in clause 5.2.3.1. +3. The NWDAF responds with the analytics information as described in step 2 in clause 5.2.3.1 to the NEF. +4. The NEF responds with the analytics information to the AF. + +NOTE: Details of AnalyticsExposure API refer to clause 4.4.14 and clause 5.6 of 3GPP TS 29.522 [4]. + +### 5.2.4 Analytics Exposure via DCCF + +This procedure is used by NF service consumer(s) based on local configuration, to subscribe/unsubscribe to NWDAF analytics event(s) via the DCCF, and upon the delivery option "Delivery via DCCF" configured on the DCCF, also used by DCCF to notify the NF service consumer(s) of the analytics information via the DCCF if subscribed before. + +![Sequence diagram showing Analytics Exposure via DCCF. Lifelines: NF service consumer, DCCF, ADRF, NWDAF. The diagram illustrates the interaction for subscribing, fetching data, and unsubscribing to analytics exposure.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant DCCF + participant ADRF + participant NWDAF + + Note right of DCCF: 2. Determine whether historical analytics data handling is applicable or not + Note right of DCCF: 3a. Determine whether the analytics requested are already being collected + + Note right of DCCF: 3b. If historical analytics data handling is applicable, and DCCF determine to retrieve analytics data from ADRF Instance + Note right of DCCF: 3c. If historical analytics data handling is applicable, and DCCF determine to retrieve analytics data from NWDAF Instance + + Note left of ADRF: Data Fetch + Note left of ADRF: Unsubscribe + + NF->>DCCF: 1. Ndcf_DataManagement_Subscribe request + DCCF-->>NWDAF: 4a. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>DCCF: 5a. Nnwdaf_EventsSubscription_Subscribe response + DCCF-->>ADRF: 4b. Nadrf_DataManagement_RetrievalSubscribe request + ADRF-->>DCCF: 5b. Nadrf_DataManagement_RetrievalSubscribe response + DCCF-->>NWDAF: 4c. Nnwdaf_EventsSubscription_Subscribe request or Nnwdaf_AnalyticsInfo_Request request + NWDAF-->>DCCF: 5c. Nnwdaf_EventsSubscription_Subscribe response or Nnwdaf_AnalyticsInfo_Request response + DCCF-->>NF: 6. Ndcf_DataManagement_Subscribe response + DCCF-->>NWDAF: 7a. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>DCCF: 8a. Nnwdaf_EventsSubscription_Notify response + DCCF-->>ADRF: 7b. Nadrf_DataManagement_RetrievalNotify request + ADRF-->>DCCF: 8b. Nadrf_DataManagement_RetrievalNotify response + DCCF-->>NWDAF: 7c. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>DCCF: 8c. Nnwdaf_EventsSubscription_Notify response + DCCF-->>NF: 9. Ndcf_DataManagement_Notify request + NF-->>DCCF: 10. Ndcf_DataManagement_Notify response + NF-->>DCCF: 11. Ndcf_DataManagement_Fetch Request + DCCF-->>NF: 12. Ndcf_DataManagement_Fetch response + NF->>DCCF: 13. Ndcf_DataManagement_Unsubscribe request + DCCF-->>NF: 14. Ndcf_DataManagement_Unsubscribe response + DCCF-->>NWDAF: 15a. Nnwdaf_EventsSubscription_Unsubscribe request + NWDAF-->>DCCF: 16a. Nnwdaf_EventsSubscription_Unsubscribe response + DCCF-->>ADRF: 15b. Nadrf_DataManagement_RetrievalUnsubscribe request + ADRF-->>DCCF: 16b. Nadrf_DataManagement_RetrievalUnsubscribe response + +``` + +Sequence diagram showing Analytics Exposure via DCCF. Lifelines: NF service consumer, DCCF, ADRF, NWDAF. The diagram illustrates the interaction for subscribing, fetching data, and unsubscribing to analytics exposure. + +Figure 5.2.4-1: Analytics Exposure via DCCF + +1. In order to subscribe to notification(s) of analytics exposure via the DCCF based on local configuration, the NF service consumer invokes the Ndcf\_DataManagement\_Subscribe service operation by sending an HTTP POST request message targeting the resource "DCCF Analytics Subscriptions", the HTTP POST message shall include the NdcfAnalyticsSubscription data structure as request body with parameters as defined in clause 5.1.6.2.2 of 3GPP TS 29.574 [15]. +2. The DCCF keeps track of the analytics actively being collected for the Analytics Subscription it is coordinating. The NWDAF or ADRF may register the analytics data profile (may include the analytics data related service + +operation, Analytics Specification, NWDAF ID or ADRF ID) with the DCCF. The DCCF may then determine whether certain historical analytics data may be available in the NWDAF or ADRF based on the analytics data profile and the request time window. + +If the historical analytics data handling is not applicable or not supported, the DCCF shall proceed step 3a, skip step 3b, step 4b, step 5b, step 3c, step 4c and step 5c. + +If the historical analytics data is available in an ADRF, the DCCF shall proceed step 3a and step 3b, skip step 3c, step 4c and step 5c. + +If the historical analytics data is available in an NWDAF, the DCCF shall proceed step 3a and step 3c, skip step 3b, step 4b and step 5b. + +3a. The DCCF shall determine whether the analytics requested are already being collected. + +If the requested analytics are already being collected by an NF service consumer, the DCCF adds the new NF service consumer to the list of NF service consumers that are subscribed for these analytics. + +If the DCCF cannot handle the subscription request, shall take the error handling as defined in clause 4.2.2.2.2 of 3GPP TS 29.574 [15] + +If the DCCF determines that no subscriptions need to be created or modified (e.g. because all the data can be made available either via pre-existing subscriptions or because of the historical data handling) then step 4a and step 5a are skipped. + +3aa. The DCCF may respond to the Ndcf\_DataManagement\_Subscribe service operation with HTTP "201 Created" status code with the message body containing a representation of the created subscription if the DCCF add the new NF service consumer to the list of NF service consumers that are subscribed, or if error case happened may respond with corresponding error information. + +4a If the analytics requested at step 1 are not already available yet, the DCCF shall invoke the Nnwdaf\_EventsSubscription\_Subscribe service operation by sending an HTTP POST request message request to the NWDAF targeting the resource "NWDAF Events Subscriptions" to subscribe to a new analytics exposure subscription, or if the analytics subscribed in step 1 partially matches an analytics that is already being collected by the DCCF from an NWDAF, and a modification of this subscription to the NWDAF would satisfy both the existing analytics subscriptions as well as the newly requested analytics, by sending an HTTP PUT request to the resource "Individual Analytics Exposure Subscription" to replace an existing analytics exposure subscription. The request includes the subscribed event(s) and event filter information received from the NF service consumer, mapping to the parameters as defined in clause 5.1 of 3GPP TS 29.520 [5]. + +NOTE: If the NWDAF instance or NWDAF Set is not identified by the NF service consumer, the DCCF determines the NWDAF instances that can provide analytics. If the consumer requested storage of analytics in an ADRF but an ADRF ID is not provided by the NF service consumer, or the collected analytics is to be stored in an ADRF according to configuration on the DCCF, the DCCF selects an ADRF to store the collected analytics data. + +5a The NWDAF responds to the Nnwdaf\_EventsSubscription\_Subscribe service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +Upon receipt of the HTTP PUT request, if the subscription is accepted to be updated, the NWDAF responds to the DCCF with "200 OK" or "204 No Content" status code. + +3b If the historical analytics data handling is applicable, and the DCCF determine to retrieve analytics data from the ADRF, the DCCF shall determine which ADRF instances might provide the analytics. + +4b In order to retrieve the historical analytics data from the ADRF, the DCCF shall invoke the Nadrf\_DataManagement\_RetrievalSubscribe service operation by sending an HTTP POST request message targeting the resource "ADRF Data Retrieval Subscriptions", the HTTP POST message shall include the NadrfDataRetrievalSubscription data structure as request body with parameters as defined in clause 5.1.6 of 3GPP TS 29.575 [16]. + +5b The ADRF responds to the Nadrf\_DataManagement\_RetrievalSubscribe service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the ADRF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +- 3c If the historical analytics data handling is applicable, and the DCCF determine to retrieve analytics data from the NWDAF, the DCCF shall determine which NWDAF instances might provide the analytics as described and proceed step 4c. +- 4c In order to retrieve the historical analytics data from the NWDAF, the DCCF may invoke the Nnwdaf\_EventsSubscription\_Subscribe service operation by sending an HTTP POST request message targeting the resource "NWDAF Events Subscriptions", the HTTP POST message shall include the NnwdafEventsSubscription data structure as request body with parameters as defined in clause 5.1.6 of 3GPP TS 29.520 [5] or Nnwdaf\_AnalyticsInfo\_Request request by sending an HTTP GET request message targeting the resource "NWDAF Analytics" with parameters as defined in clause 5.2.3.2.3.1 of 3GPP TS 29.520 [5]. +- 5c The NWDAF responds to the Nnwdaf\_EventsSubscription\_Subscribe or Nnwdaf\_AnalyticsInfo\_Request service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +6. The DCCF responds to the Ndcf\_DataManagement\_Subscribe service operation with HTTP "201 Created" status code with the message body containing a representation of the created subscription. +- 7a. (conditional) When the analytics are available, the NWDAF invokes the Nnwdaf\_EventsSubscription\_Notify service operation by sending an HTTP POST request message to notify the analytics information to the DCCF. +- 8a. The DCCF responds to the Nnwdaf\_EventsSubscription\_Notify service operation with HTTP "204 No Content" status code. +- 7b. (conditional) When the historical analytics data are available in the ADRF, the ADRF shall invoke the Nadrf\_DataManagement\_RetrievalNotify service operation by sending an HTTP POST request message to notify the historical analytics or Fetch Instructions to the DCCF. +- 8b. The DCCF responds to the Nadrf\_DataManagement\_RetrievalNotify service operation with HTTP "204 No Content" status code. +- 7c. (conditional) When the historical analytics data are available in the NWDAF, the NWDAF may invoke the Nnwdaf\_EventsSubscription\_Notify service operation by sending an HTTP POST request message to notify the historical analytics data to the DCCF. +- 8c. The DCCF responds to the Nnwdaf\_EventsSubscription\_Notify service operation with HTTP "204 No Content" status code. +9. Upon the delivery option "Delivery via DCCF" configured on the DCCF, the DCCF invokes the Ndcf\_DataManagement\_Notify service operation by sending HTTP POST request message(s) to send the analytics data to all notification endpoints indicated in step 1. Analytics sent to notification endpoints may be processed and formatted by the DCCF so they conform to delivery requirements for each NF service consumer or notification endpoint. + +NOTE: According to Formatting Instructions provided by the NF service consumer, multiple notifications from a NWDAF can be combined in a single Ndcf\_DataManagement\_Notify so many notifications from an NWDAF results in fewer notifications (or one notification) to the NF service consumer. Alternatively, a notification can instruct the analytics notification endpoint to fetch the analytics from the DCCF. + +10. The NF service consumer responds to the Ndcf\_DataManagement\_Notify service operation with HTTP "204 No Content" status code. +11. (conditional) The NF service consumer invokes the Ndcf\_DataManagement\_Fetch service operation by sending an HTTP GET request message to fetch the analytics from the DCCF before an expiry time, if received the fetch instruction in NdcfDataManagement\_Notify service operation in step 9. + +12. The NF service consumer responds to the Ndcf\_DataManagement\_Fetch service operation with HTTP "204 No Content" status code. +13. When the NF service consumer no longer need the subscription to the analytics requested in step 1, shall invoke the Ndcf\_DataManagement\_Unsubscribe service operation by sending an HTTP DELETE request message with "{xxx}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription that is to be deleted., using the Subscription Correlation Id received in response to its subscription in step 1. The DCCF removes the NF service consumer from the list of NF service consumers that are subscribed for these analytics. +14. The DCCF responds to the Ndcf\_DataManagement\_Unsubscribe service operation with HTTP "204 No Content" status code, upon removed the NF service consumer from the list of NF service consumers that are subscribed for these analytics +- 15a. If there are no other NF service consumers subscribed to the analytics, the DCCF invokes the Nnwdaf\_EventsSubscription\_Unsubscribe service operation by sending an HTTP DELETE request message to the NWDAF. +- 16a. The NWDAF responds to the Nnwdaf\_EventsSubscription\_Unsubscribe service operation with HTTP "204 No Content" status code, upon the analytics event(s) subscription is removed. +- 15b. If DCCF determines that no other NF service consumers requiring the historical analytics data from the ADRF, the DCCF may invoke the Nadrf\_DataManagement\_RetrievalUnSubscribe service operation by sending an HTTP DELETE request message to the ADRF. +- 16b. The ADRF responds to the Nadrf\_DataManagement\_RetrievalUnSubscribe service operation with HTTP "204 No Content" status code, upon the analytics data retrieval subscription is removed. + +### 5.2.5 Analytics Exposure via DCCF and MFAF + +This procedure is used by NF service consumer(s) based on local configuration, to subscribe/unsubscribe to NWDAF analytics event(s) via the DCCF, and upon the delivery option "Delivery via Messaging Framework " configured on the DCCF, the 3GPP DCCF Adaptor (3da) Data Management service and 3GPP Consumer Adaptor (3ca) Data Management service of the Messaging Framework Adaptor Function (MFAF) are used to interact with the 3GPP Network and the Messaging Framework for analytics information delivery to the NF service consumer(s) subscribed notification endpoint(s). + +![Sequence diagram showing Analytics Exposure via DCCF and Messaging Framework. Lifelines: NF service consumer, DCCF, MFAF, ADRF, NWDAF. The diagram is divided into three main sections: Subscription, Data Fetch, and Unsubscribe. It details the message exchanges between the consumer and the network functions for analytics data handling.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant DCCF + participant MFAF + participant ADRF + participant NWDAF + + Note left of DCCF: 4. Determine whether historical analytics data handling is applicable or not + Note left of DCCF: 5a. Determine whether the requested analytics data is already being collected + + Note left of DCCF: 5b. If historical analytics data handling is applicable, and DCCF determine to retrieve data from ADRF Instance + Note left of DCCF: 5c. If historical analytics data handling is applicable, and DCCF determine to retrieve analytics data from NWDAF + + Note left of NF: Data Fetch + Note left of NF: Unsubscribe + + NF->>DCCF: 1. Ndccf_DataManagement_Subscribe request + DCCF->>MFAF: 2. Nmfaf_3daDataManagement_Configure request + MFAF-->>DCCF: 3. Nmfaf_3daDataManagement_Configure response + DCCF-->>NWDAF: 6a. Nnwdaf_EventsSubscription request + NWDAF-->>DCCF: 7a. Nnwdaf_EventsSubscription response + DCCF-->>ADRF: 6b. Nadrf_DataManagement_RetrievalSubscribe request + ADRF-->>DCCF: 7b. Nadrf_DataManagement_RetrievalSubscribe response + DCCF-->>NWDAF: 6c. Nnwdaf_EventsSubscription_Subscribe request or Nnwdaf_AnalyticsInfo_Request request + NWDAF-->>DCCF: 7c. Nnwdaf_EventsSubscription_Subscribe response or Nnwdaf_AnalyticsInfo_Request response + DCCF-->>NF: 8. Ndccf_DataManagement_Subscribe response + MFAF-->>NWDAF: 9a. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>MFAF: 10a. Nnwdaf_EventsSubscription_Notify response + MFAF-->>NF: 11a. Nmfaf_3caDataManagement_Notify request + NF-->>MFAF: 12a. Nmfaf_3caDataManagement_Notify response + MFAF-->>ADRF: 9b. Nadrf_DataManagement_RetrievalNotify request + ADRF-->>MFAF: 10b. Nadrf_DataManagement_RetrievalNotify response + MFAF-->>NF: 11b. Nmfaf_3caDataManagement_Notify request + NF-->>MFAF: 12b. Nmfaf_3caDataManagement_Notify response + MFAF-->>NWDAF: 9c. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>MFAF: 10c. Nnwdaf_EventsSubscription_Notify response + MFAF-->>NF: 11c. Nmfaf_3caDataManagement_Notify request + NF-->>MFAF: 12c. Nmfaf_3caDataManagement_Notify response + NF-->>MFAF: 13. Nmfaf_3caDataManagement_Fetch Request + MFAF-->>NF: 14. Nmfaf_3caDataManagement_Fetch response + NF->>DCCF: 15. Ndccf_DataManagement_Unsubscribe request + DCCF-->>NF: 16. Ndccf_DataManagement_Unsubscribe response + DCCF-->>NWDAF: 17a. Nnwdaf_EventsSubscription_Unsubscribe request + NWDAF-->>DCCF: 18a. Nnwdaf_EventsSubscription_Unsubscribe response + DCCF-->>ADRF: 17b. Nadrf_DataManagement_RetrievalUnsubscribe request + ADRF-->>DCCF: 18b. Nadrf_DataManagement_RetrievalUnsubscribe response + DCCF-->>MFAF: 17c. Nmfaf_3daDataManagement_Deconfigure request + MFAF-->>DCCF: 18c. Nmfaf_3daDataManagement_Deconfigure response + +``` + +Sequence diagram showing Analytics Exposure via DCCF and Messaging Framework. Lifelines: NF service consumer, DCCF, MFAF, ADRF, NWDAF. The diagram is divided into three main sections: Subscription, Data Fetch, and Unsubscribe. It details the message exchanges between the consumer and the network functions for analytics data handling. + +Figure 5.2.5-1: Analytics Exposure via DCCF and Messaging Framework + +1. In order to subscribe to notification(s) of analytics exposure via the DCCF based on local configuration, the NF service consumer invokes the Ndcf\_DataManagement\_Subscribe service operation by sending an HTTP POST request message targeting the resource "DCCF Analytics Subscriptions", the HTTP POST message shall include the NdcfAnalyticsSubscription data structure as request body with parameters as defined in clause 5.1.6.2.2 of 3GPP TS 29.574 [15]. +2. Upon the delivery option "Delivery via MFAF" configured on the DCCF, in order to create configuration of mapping data in the MFAF, the DCCF shall invoke the Nmfa\_3daDataManagement\_Configure service operation by sending an HTTP POST request message targeting the resource "MFAF Configurations", the HTTP POST message shall include the MfafConfiguration data structure as request body with parameters as defined in clause 5.1.6 of 3GPP TS 29.576 [17]. +3. The MFAF responds to the Nmfa\_3daDataManagement\_Configure service operation. + +Upon receipt of the HTTP POST request, if the configuration is accepted to be created, the MFAF responds to the DCCF with "201 Created", and the URI of the created configuration is included in the Location header field. + +4. The DCCF keeps track of the analytics actively being collected for the Analytics Subscription it is coordinating. The NWDAF or ADRF may register the analytics data profile (may include the analytics data collection related service operation, Analytics Specification, NWDAF ID or ADRF ID) with the DCCF. The DCCF may then determine whether certain historical analytics data may be available in the NWDAF or ADRF based on the analytics data profile and the request time window. + +If the historical analytics data handling is not applicable or not supported, the DCCF shall proceed step 5a, skip step 5b step 6b, step 7b, step 5c step 6c and step 7c. + +If the historical analytics data is available in an ADRF, the DCCF shall proceed step 5a and step 5b, skip step 5c, step 6c and step 7c. + +If the historical data is available in an NWDAF, the DCCF shall proceed step 5a and step 5c, skip step 5b, step 6b and step 7b. + +- 5a. The DCCF shall determine whether the analytics data requested in step 1 are already being collected. + +If the analytics data requested are already being collected by an NF service consumer, the DCCF adds the NF service consumer to the list of analytics consumers that are subscribed for these data. + +If the DCCF cannot handle the subscription request, shall take the error handling as defined in clause 4.2.2.2.2 of 3GPP TS 29.574 [15] + +If the DCCF determines that no subscriptions need to be created or modified (e.g. because all the data can be made available either via pre-existing subscriptions or because of the historical data handling) then step 6a and step 7a are skipped. + +- 5aa. The DCCF may respond to the Ndcf\_DataManagement\_Subscribe service operation with HTTP "201 Created" status code with the message body containing a representation of the created subscription if the DCCF adds the new NF service consumer to the list of NF service consumers that are subscribed, or if error case happened may respond with corresponding error information. + +- 6a If the requested data at step 1 are not already available yet, the DCCF shall invoke the Nnwda\_EventsSubscription\_Subscribe service operation by sending an HTTP POST request message request to the NWDAF targeting the resource "NWDAF Events Subscriptions" to subscribe to a new analytics exposure subscription, or if the analytics subscribed in step 1 partially matches an analytics that is already being collected by the DCCF from an NWDAF, and a modification of this subscription to the NWDAF would satisfy both the existing analytics subscriptions as well as the newly requested analytics, by sending an HTTP PUT request to the resource "Individual Analytics Exposure Subscription" to replace an existing analytics exposure subscription. The request includes the subscribed event(s) and event filter information received from the NF service consumer, mapping to the parameters as defined in clause 5.1 of 3GPP TS 29.520 [5]. + +NOTE 1: If the NWDAF instance or NWDAF Set is not identified by the NF service consumer, the DCCF determines the NWDAF instances that can provide analytics. If the consumer requested storage of analytics in an ADRF but an ADRF ID is not provided by the NF service consumer, or the collected analytics is to be stored in an ADRF according to configuration on the DCCF, the DCCF selects an ADRF to store the collected data. + +7a The NWDAF responds to the Nnwdaf\_EventsSubscription\_Subscribe service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +Upon receipt of the HTTP PUT request, if the subscription is accepted to be updated, the NWDAF responds to the DCCF with "200 OK" or "204 No Content" status code. + +5b If the historical analytics data handling is applicable, and the DCCF determine to retrieve analytics data from the ADRF, the DCCF shall determine which ADRF instances might provide the analytics. + +6b In order to retrieve the historical analytics data from the ADRF, the DCCF shall invoke the Nadrf\_DataManagement\_RetrievalSubscribe service operation by sending an HTTP POST request message targeting the resource "ADRF Data Retrieval Subscriptions", the HTTP POST message shall include the NadrfDataRetrievalSubscription data structure as request body with parameters as defined in clause 5.1.6 of 3GPP TS 29.575 [16]. + +7b The ADRF responds to the Nadrf\_DataManagement\_RetrievalSubscribe service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the ADRF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +5c If the historical data handling is applicable, and the DCCF determines to retrieve analytics data from the NWDAF, the DCCF shall determine which NWDAF instances might provide the analytics as described and proceed step 6c. + +6c In order to retrieve the historical analytics data from the NWDAF, the DCCF may invoke the Nnwdaf\_EventsSubscription\_Subscribe service operation by sending an HTTP POST request message targeting the resource "NWDAF Events Subscriptions", the HTTP POST message shall include the NnwdafEventsSubscription data structure as request body with parameters as defined in clause 5.1.6 of 3GPP TS 29.520 [5] or Nnwdaf\_AnalyticsInfo\_Request request by sending an HTTP GET request message targeting the resource "NWDAF Analytics" with parameters as defined in clause 5.2.3.2.3.1 of 3GPP TS 29.520 [5]. + +7c The NWDAF responds to the Nnwdaf\_EventsSubscription\_Subscribe or Nnwdaf\_AnalyticsInfo\_Request service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF responds to the DCCF with "201 Created", and the URI of the created subscription is included in the Location header field. + +8. The DCCF responds to the Ndccf\_DataManagement\_Subscribe service operation with HTTP "201 Created" status code with the message body containing a representation of the created subscription. + +9a. (conditional) When the analytics are available, the NWDAF invokes the Nnwdaf\_EventsSubscription\_Notify service operation by sending an HTTP POST request message to notify the analytics information to the MFAF. + +10a. The MFAF responds to the Nnwdaf\_EventsSubscription\_Notify service operation with HTTP "204 No Content" status code. + +11a. The MFAF invokes the Nmmaf\_3caDataManagement\_Notify service operation by sending HTTP POST request message(s) to send the analytics data to all notification endpoints indicated in step 1. Analytics data sent to notification endpoints may be processed and formatted by the MFAF so that they conform to delivery requirements for each NF service consumer and/or notification endpoint. + +NOTE 2: According to Formatting Instructions provided by the NF service consumer, multiple notifications from the NWDAF can be combined in a single Nmmaf\_3caDataManagement\_Notify so that many notifications from an NWDAF result in fewer notifications (or one notification) to the NF service consumer and/or the subscribed notification endpoint(s). Alternatively, a notification can instruct the analytics data notification endpoint to fetch the analytics data from the MFAF. + +12a. The NF service consumer responds to the Nmmaf\_3caDataManagement\_Notify service operation with HTTP "204 No Content" status code. + +9b. (conditional) When the historical analytics data are available in the ADRF, the ADRF shall invoke the Nadrf\_DataManagement\_RetrievalNotify service operation by sending an HTTP POST request message to notify the historical analytics or Fetch Instructions to the MFAF. + +10b. The MFAF responds to the Nadrf\_DataManagement\_RetrievalNotify service operation with HTTP "204 No Content" status code. + +11b. The MFAF invokes the Nmfaf\_3caDataManagement\_Notify service operation by sending HTTP POST request message(s) to send the analytics data to all notification endpoints indicated in step 1. Analytics data sent to notification endpoints may be processed and formatted by the MFAF so that they conform to delivery requirements for each NF service consumer or notification endpoint. + +NOTE 3: According to Formatting Instructions provided by the NF service consumer, multiple notifications from an ADRF can be combined in a single Nmfaf\_3caDataManagement\_Notify so many notifications from an ADRF results in fewer notifications (or one notification) to the NF service consumer and/or the subscribed notification endpoint(s). Alternatively, a notification can instruct the analytics data notification endpoint to fetch the analytics data from the MFAF. + +12b. The NF service consumer responds to the Nmfaf\_3caDataManagement\_Notify service operation with HTTP "204 No Content" status code. + +9c. (conditional) When the historical analytics data are available in the NWDAF, the NWDAF may invoke the Nnwdaf\_EventsSubscription\_Notify service operation by sending an HTTP POST request message to notify the historical analytics data to the MFAF. + +10c. The MFAF responds to the Nnwdaf\_EventsSubscription\_Notify service operation with HTTP "204 No Content" status code. + +11c. The MFAF invokes the Nmfaf\_3caDataManagement\_Notify service operation by sending HTTP POST request message(s) to send the analytics data to all notification endpoints indicated in step 1. Analytics data sent to notification endpoints may be processed and formatted by the MFAF so they conform to delivery requirements for each NF service consumer or notification endpoint. + +NOTE 4: According to Formatting Instructions provided by the NF service consumer, multiple notifications from a NWDAF can be combined in a single Nmfaf\_3caDataManagement\_Notify so many notifications from a NWDAF results in fewer notifications (or one notification) to the NF service consumer and/or the subscribed notification endpoint(s). Alternatively, a notification can instruct the analytics data notification endpoint to fetch the analytics data from the MFAF. + +12c. The NF service consumer responds to the Nmfaf\_3caDataManagement\_Notify service operation with HTTP "204 No Content" status code. + +13. (conditional) The NF service consumer invoke the Nmfaf\_3caDataManagement\_Fetch service operation by sending an HTTP GET request message to fetch the data from the MFAF before an expiry time, if received the fetch instruction in Nmfaf\_3caDataManagement\_Notify service operation in step 11a, step 11b or step 11c. + +14. The MFAF responds to the Nmfaf\_3caDataManagement\_Fetch service operation with HTTP "200 OK" status code with the message body containing the NmfafResourceRecord data structure. + +15. When the NF service consumer no longer need the subscription to the requested data in step 1, shall invoke the Ndccf\_DataManagement\_Unsubscribe service operation by sending an HTTP DELETE request message with "{apiRoot}/nnwda-f-data-management/v1/subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription that is to be deleted., using the Subscription Correlation Id received in response to its subscription in step 1. The DCCF removes the NF service consumer from the list of NF service consumers that are subscribed for these analytics data. + +16. The DCCF responds to the Ndccf\_DataManagement\_Unsubscribe service operation with HTTP "204 No Content" status code, upon removed the NF service consumer from the list of NF service consumers that are subscribed for these analytics data. + +17a. If there are no other NF service consumers subscribed to the analytics data, the DCCF invoke the Nnwdaf\_EventsSubscription\_Unsubscribe service operation by sending an HTTP DELETE request message to the NWDAF. + +- 18a. The DWDAF responds to the Nnwdaf\_EventsSubscription\_Unsubscribe service operation with HTTP "204 No Content" status code, upon the analytics event(s) subscription is removed. +- 17b. If DCCF determines that no other NF service consumers requiring the historical analytics data from the ADRF, the DCCF may invoke the Nadrf\_DataManagement\_RetrievalUnSubscribe service operation by sending an HTTP DELETE request message to the ADRF. +- 18b. The ADRF responds to the Nadrf\_DataManagement\_RetrievalUnSubscribe service operation with HTTP "204 No Content" status code, upon the data retrieval subscription is removed. +- 17c. When DCCF determines that NF service consumer mapping has to be removed from MFAF, the DCCF may invoke the Nmfa\_3daDataManagement\_Deconfigure service operation by sending an HTTP DELETE request message to the MFAF. +- 18c. The MFAF responds to the Nmfa\_3daDataManagement\_Deconfigure service operation with HTTP "204 No Content" status code, upon removing the individual resource linked to the delete request. + +### 5.2.6 Procedure for Analytics Exposure in Roaming Case + +#### 5.2.6.1 Analytics Exposure from HPLMN to VPLMN for inbound roaming users + +The procedure depicted in Figure 5.2.6.1-1 is used by the V-RE-NWDAF as service consumer to subscribe/unsubscribe to notifications about analytics exposure from the HPLMN for inbound roaming users. + +![Sequence diagram showing the procedure for analytics exposure from HPLMN to VPLMN for inbound roaming users. Lifelines: NF in VPLMN, V-RE-NWDAF, H-RE-NWDAF, Other H-NWDAF(s). The process involves subscription requests, data collection in HPLMN, responses, and subsequent data collection in VPLMN.](8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg) + +``` + +sequenceDiagram + participant NF as NF in VPLMN + participant VRE as V-RE-NWDAF + participant HRE as H-RE-NWDAF + participant OtherH as Other H-NWDAF(s) + + Note right of HRE: 3. H-RE-NWDAF collects data in HPLMN and derives analytics + Note right of VRE: 5. V-RE-NWDAF collects data in VPLMN and derives analytics + + NF->>VRE: 1. Nnwdaf_AnalyticsInfo_Request request/ +Nnwdaf_EventsSubscription_Subscribe request + VRE->>HRE: 2. Nnwdaf_RoamingAnalytics_Request request/ +Nnwdaf_RoamingAnalytics_Subscribe request + HRE-->>VRE: 3a1. Nnwdaf_RoamingAnalytics_Request response/ +Nnwdaf_RoamingAnalytics_Subscribe response + VRE-->>NF: 3a2. Nnwdaf_AnalyticsInfo_Request response/ +Nnwdaf_EventsSubscription_Subscribe response + VRE->>OtherH: 3b. Nnwdaf_AnalyticsInfo_Request request/ +Nnwdaf_EventsSubscription_Subscribe request + OtherH-->>VRE: 3c. Nnwdaf_AnalyticsInfo_Request response/ +Nnwdaf_EventsSubscription_Subscribe response/ +Nnwdaf_EventsSubscription_Notify request + HRE-->>VRE: 4. Nnwdaf_RoamingAnalytics_Request response/ +Nnwdaf_RoamingAnalytics_Subscribe response/ +Nnwdaf_RoamingAnalytics_Notify request + VRE-->>NF: 6. Nnwdaf_AnalyticsInfo_Request response/ +Nnwdaf_EventsSubscription_Subscribe response/ +Nnwdaf_EventsSubscription_Notify request + +``` + +Sequence diagram showing the procedure for analytics exposure from HPLMN to VPLMN for inbound roaming users. Lifelines: NF in VPLMN, V-RE-NWDAF, H-RE-NWDAF, Other H-NWDAF(s). The process involves subscription requests, data collection in HPLMN, responses, and subsequent data collection in VPLMN. + +Figure 5.2.6.1-1: Procedure for analytics exposure from HPLMN to VPLMN + +- 1. The consumer NF in VPLMN (e.g. AMF) discovers a V-RE-NWDAF as described in clause 5.2.8.3 and invoke Nnwdaf\_AnalyticsInfo\_Request or Nnwdaf\_EventsSubscription\_Subscribe service operation to the V-RE-NWDAF. For the inbound roaming user(s) indicated in the Target of Analytics Reporting, V-RE-NWDAF + +determines based on operator configuration and the requested analytics whether analytics from the HPLMN are required, or the analytics can be derived locally. + +NOTE 1: It is possible that the Target of Analytics Reporting sent by the Consumer NF to the V-RE-NWDAF includes both inbound roaming user(s) and non-roaming user(s). + +2. The V-RE-NWDAF checks the roaming agreements related to analytics from HPLMN to determine if the roaming analytics request/subscribe can be accepted or must be rejected. If the request is rejected, the following steps are skipped. + +The V-RE-NWDAF discovers a H-RE-NWDAF as described in clause 5.8.2.3 then invoke Nnwdaf\_RoamingAnalytics\_Request or Nnwdaf\_RoamingAnalytics\_Subscribe service operation as described in clause 4.9.2.2 and clause 4.9.2.3 of 3GPP TS 29.520 [5], based on the Analytics request/subscribe received from the Consumer NF in VPLMN. The Target of Analytics Reporting sent by the V-RE-NWDAF to the H-RE-NWDAF only contains the inbound roaming user(s). + +NOTE 2: The inbound roaming user(s) are distinguished by the V-RE-NWDAF according to UE ID(s) (i.e. SUPI(s)). + +3. The H-RE-NWDAF checks the roaming agreements between the HPLMN and the VPLMN, and user consent for analytics if needed, to determine if the roaming analytics request/subscribe can be accepted or must be rejected. If the roaming analytics request/subscribe is rejected, the following steps are skipped. +- 3a If the H-RE-NWDAF supports to generate the requested analytics, it collects data from the NF(s) and/or OAM in HPLMN and derives the requested analytics, respond with Nnwdaf\_RoamingAnalytics\_Request response or Nnwdaf\_RoamingAnalytics\_Subscribe response to the V-RE-NWDAF then responds to the consumer NF; otherwise steps 3b and 3c are executed. +- 3b-3c. [Optional] If the H-RE-NWDAF does not support to generate the requested analytics, it may request/subscribe to other NWDAF(s) in the HPLMN (if available) by invoking Nnwdaf\_AnalyticsInfo\_Request or Nnwdaf\_EventsSubscription\_Subscribe service operation for the analytics and get corresponding response/notification by Nnwdaf\_AnalyticsInfo\_Request response, Nnwdaf\_EventsSubscription\_Subscribe response or Nnwdaf\_EventsSubscription\_Notify service operation. +4. The H-RE-NWDAF sends the HPLMN analytics information to the V-RE-NWDAF using either Nnwdaf\_RoamingAnalytics\_Request response, Nnwdaf\_RoamingAnalytics\_Subscribe response or Nnwdaf\_RoamingAnalytics\_Notify request message as described in clause 4.9.2.2 and clause 4.9.2.3 of 3GPP TS 29.520 [5], depending on the service used in step 2. The H-RE-NWDAF may restrict the exposed analytics information based on HPLMN operator policies. +5. If the Consumer NF also indicates request or subscription of analytics information available in the VPLMN (e.g. via Target of Analytics Reporting) in step 1, the V-RE-NWDAF collects data from the NF(s) and/or OAM in VPLMN and derives the requested analytics. +6. The V-RE-NWDAF sends the HPLMN analytics information received in step 4, or the aggregated analytics information if step 5 are performed, to the Consumer NF in VPLMN using either Nnwdaf\_AnalyticsInfo\_Request response, Nnwdaf\_EventsSubscription\_Subscribe or Nnwdaf\_EventsSubscription\_Notify request message described in clause 4.2.2 of 3GPP TS 29.520 [5] depending on the service used in step 1. + +NOTE 3: The present document describes that the RE-NWDAF may perform analytics aggregation for roaming scenario, but whether and how the RE-NWDAF performs analytics aggregation for roaming scenario are up to implementation. + +NOTE 4: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify, Nnwdaf\_AnalyticsInfo\_Request and/or Nnwdaf\_RoamingAnalytics\_Subscribe/Unsubscribe/Notify/Request service operations refer to 3GPP TS 29.520 [5]. + +#### 5.2.6.2 Analytics Exposure from VPLMN to HPLMN for outbound roaming users + +The procedure depicted in Figure 5.2.6.2-1 is used by the H-RE-NWDAF as service consumer to subscribe/unsubscribe to notifications about analytics exposure from the VPLMN for outbound roaming users. + +![Sequence diagram illustrating the procedure for analytics exposure from VPLMN to HPLMN. Lifelines: NF in HPLMN, H-RE-NWDAF, V-RE-NWDAF, Other V-NWDAF(s).](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` + +sequenceDiagram + participant NF as NF in HPLMN + participant H-RE-NWDAF as H-RE-NWDAF + participant V-RE-NWDAF as V-RE-NWDAF + participant OtherV-NWDAF as Other V-NWDAF(s) + + Note right of V-RE-NWDAF: 3a. V-RE-NWDAF collects data in VPLMN and derives analytics + Note right of H-RE-NWDAF: 5. H-RE-NWDAF collects data in HPLMN and derives analytics + + NF->>H-RE-NWDAF: 1. Nnwdaf_AnalyticsInfo_Request request/ +Nnwdaf_EventsSubscription_Subscribe request + H-RE-NWDAF->>V-RE-NWDAF: 2. Nnwdaf_RoamingAnalytics_Request request/ +Nnwdaf_RoamingAnalytics_Subscribe request + V-RE-NWDAF-->>H-RE-NWDAF: 3a1. Nnwdaf_RoamingAnalytics_Request response/ +Nnwdaf_RoamingAnalytics_Subscribe response + H-RE-NWDAF-->>NF: 3a2. Nnwdaf_AnalyticsInfo_Request response/ +Nnwdaf_EventsSubscription_Subscribe response + V-RE-NWDAF->>OtherV-NWDAF: 3b. Nnwdaf_AnalyticsInfo_Request request/ +Nnwdaf_EventsSubscription_Subscribe request + OtherV-NWDAF-->>V-RE-NWDAF: 3c. Nnwdaf_AnalyticsInfo_Request response/ +Nnwdaf_EventsSubscription_Subscribe response/ +Nnwdaf_EventsSubscription_Notify request + V-RE-NWDAF-->>H-RE-NWDAF: 4. Nnwdaf_RoamingAnalytics_Request response/ +Nnwdaf_RoamingAnalytics_Subscribe response/ +Nnwdaf_RoamingAnalytics_Notify request + H-RE-NWDAF-->>NF: 6. Nnwdaf_AnalyticsInfo_Request response/ +Nnwdaf_EventsSubscription_Subscribe response/ +Nnwdaf_EventsSubscription_Notify request + +``` + +Sequence diagram illustrating the procedure for analytics exposure from VPLMN to HPLMN. Lifelines: NF in HPLMN, H-RE-NWDAF, V-RE-NWDAF, Other V-NWDAF(s). + +**Figure 5.2.6.2-1: Procedure for analytics exposure from VPLMN to HPLMN** + +- Upon the Consumer NF is aware that the UE(s) indicated in Target of Analytics Reporting is/are roaming, Consumer NF in HPLMN (e.g. H-PCF) discovers a H-RE-NWDAF as described in clause 5.2.8.3 and invoking a Nnwdaf\_AnalyticsInfo\_Request or a Nnwdaf\_EventsSubscription\_Subscribe service operation. For the outbound roaming user(s) indicated in the Target of Analytics Reporting, the H-RE-NWDAF determines based on operator configuration and the requested analytics whether analytics or input data from the VPLMN are required, or the analytics can be derived locally. + +NOTE 1: It is possible that the Target of Analytics Reporting sent by the Consumer NF to the H-RE-NWDAF includes both outbound roaming user(s) and non-roaming user(s). + +NOTE 2: The H-NWDAF is not depicted in the flow. + +- The H-RE-NWDAF checks user consent and roaming agreements between the HPLMN and the VPLMN to determine if the roaming analytics request/subscription can be accepted or must be rejected. If the request is rejected, the following steps are skipped. + +The H-RE-NWDAF discovers the V-RE-NWDAF as described in clause 5.2.8.3. + +The H-RE-NWDAF invoke a Nnwdaf\_RoamingAnalytics\_Request or a Nnwdaf\_RoamingAnalytics\_Subscribe service operation, based on the Analytics request/subscribe received from the Consumer NF in HPLMN. The Target of Analytics Reporting sent by the H-RE-NWDAF to the V-RE-NWDAF only contains the outbound roaming user(s). + +- The V-RE-NWDAF checks the roaming agreements between the HPLMN and the VPLMN, to determine if the roaming analytics request/subscribe can be accepted or must be rejected. If the roaming analytics request/subscribe is rejected, the following steps are skipped. + +If the V-RE-NWDAF supports to generate the requested analytics, it collects data from the NF(s) serving the roaming UE(s) and/or OAM in VPLMN and derives the analytics; otherwise steps 3b and 3c are executed. + +3a1-3a2 The V-RE-NWDAF may respond with Nnwdaf\_RoamingAnalytics\_Request response or Nnwdaf\_RoamingAnalytics\_Subscribe response to the H-RE-NWDAF then responds to the consumer NF; otherwise steps 3b and 3c are executed. + +3b-3c. If the V-RE-NWDAF does not support to generate the requested analytics, it may request/subscribe to other NWDAF(s) in the VPLMN (if available) for the analytics and get corresponding response/notification(s) by invoking Nnwdaf\_AnalyticsInfo\_Request or Nnwdaf\_EventsSubscription\_Subscribe service operation for the analytics and get corresponding response/notification by Nnwdaf\_AnalyticsInfo\_Request response, Nnwdaf\_EventsSubscription\_Subscribe response or Nnwdaf\_EventsSubscription\_Notify service operation. + +4. The V-RE-NWDAF may send the VPLMN analytics information to the H-RE-NWDAF using either Nnwdaf\_RoamingAnalytics\_Request response, Nnwdaf\_RoamingAnalytics\_Subscribe or Nnwdaf\_RoamingAnalytics\_Notify request message as described in clause 4.9.2.2 and clause 4.9.2.3 of 3GPP TS 29.520 [5], depending on the service used in step 2. The V-RE-NWDAF may restrict the exposed analytics information based on VPLMN operator policies. + +5. If the Consumer NF also indicates request or subscription of analytics information available in the HPLMN (e.g. via Target of Analytics Reporting) in step 1, H-RE-NWDAF collects data from the NF(s) and/or OAM in HPLMN and derives the analytics. These steps can be executed in parallel with steps 3-6. The H-RE-NWDAF may perform analytics aggregation with the analytics information received from the V-RE-NWDAF and analytics information generated by itself, based on the analytics request or subscription. + +6. H-RE-NWDAF sends the VPLMN analytics information received in step 4, or the aggregated analytics information if step 5 are performed, to the Consumer NF in HPLMN using either Nnwdaf\_AnalyticsInfo\_Request response, Nnwdaf\_EventsSubscription\_Subscribe response or Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 4.2.2 of 3GPP TS 29.520 [5] depending on the service used in step 1, depending on the service used in step 1. + +NOTE 3: The present document describes that the RE-NWDAF may perform analytics aggregation for roaming scenario, but whether and how the RE-NWDAF performs analytics aggregation for roaming scenario are up to implementation. + +NOTE 4: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify, Nnwdaf\_AnalyticsInfo\_Request and/or Nnwdaf\_RoamingAnalytics\_Subscribe/Unsubscribe/Notify/Request service operations refer to 3GPP TS 29.520 [5]. + +## 5.3 Analytics Aggregation from Multiple NWDAFs + +### 5.3.1 General + +Analytics Aggregation refers to the case in which an NWDAF with respective capabilities aggregates the analytics provided by other NWDAFs to serve a request from an NF service consumer. + +If multiple NWDAFs are deployed, an NWDAF instance may be specialized to provide Analytics for one or more Analytics event(s). Each NWDAF instance may serve a certain Area of Interest or TAI(s) and multiple NWDAFs may be needed to serve a particular Analytics event collectively. An NWDAF may have the capability to aggregate the Analytics (per Analytics event) received from the other NWDAFs and/or the Analytics generated by itself. Analytics aggregation applies to scenarios where NWDAF service consumer requests or subscribes to analytics with or without provisioning of Area of Interest. + +### 5.3.2 Analytics aggregation with provisioning of Area of Interest + +This procedure is used by the service consumer to request Analytics event(s) for an Area of Interest, in which multiple NWDAFs are required to serve the request collectively. + +![Sequence diagram illustrating Analytics aggregation with provisioning of Area of Interest. The diagram shows interactions between NWDAF Service Consumer, Aggregator NWDAF1, NWDAF2, and NWDAF3. The process involves requests for analytics info and subscriptions, followed by responses and notifications from the aggregator to the consumer, after aggregating data from other NWDAF instances.](28d75f39a24203712ee907b32cf0bbe5_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NWDAF Service Consumer + participant Aggregator as Aggregator NWDAF1 + participant NWDAF2 as NWDAF2 + participant NWDAF3 as NWDAF3 + + Note left of Consumer: 1a. Nnwdaf_AnalyticsInfo_Request request + Note left of Consumer: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note left of Consumer: 1c. Nnwdaf_AnalyticsSubscription_Subscribe response + Consumer-->>Aggregator: 1a. Nnwdaf_AnalyticsInfo_Request request + Consumer-->>Aggregator: 1b. Nnwdaf_EventsSubscription_Subscribe request + Aggregator-->>Consumer: 1c. Nnwdaf_AnalyticsSubscription_Subscribe response + + Note left of Aggregator: 2. Nnwdaf_AnalyticsInfo_Request request + Note left of Aggregator: 3. Nnwdaf_AnalyticsInfo_Request request + Note left of Aggregator: 4a. Nnwdaf_EventsSubscription_Subscribe request + Note left of Aggregator: 4b. Nnwdaf_EventsSubscription_Subscribe response + Note left of Aggregator: 5a. Nnwdaf_EventsSubscription_Subscribe request + Note left of Aggregator: 5b. Nnwdaf_EventsSubscription_Subscribe response + Aggregator->>NWDAF2: 2. Nnwdaf_AnalyticsInfo_Request request + Aggregator->>NWDAF3: 3. Nnwdaf_AnalyticsInfo_Request request + Aggregator->>NWDAF2: 4a. Nnwdaf_EventsSubscription_Subscribe request + NWDAF2-->>Aggregator: 4b. Nnwdaf_EventsSubscription_Subscribe response + Aggregator->>NWDAF3: 5a. Nnwdaf_EventsSubscription_Subscribe request + NWDAF3-->>Aggregator: 5b. Nnwdaf_EventsSubscription_Subscribe response + + Note left of Aggregator: 6. Nnwdaf_AnalyticsInfo_Request Response + Note left of Aggregator: 7. Nnwdaf_AnalyticsInfo_Request response + NWDAF2-->>Aggregator: 6. Nnwdaf_AnalyticsInfo_Request Response + NWDAF3-->>Aggregator: 7. Nnwdaf_AnalyticsInfo_Request response + + Note left of Aggregator: 8a. Nnwdaf_EventsSubscription_Notify request + Note left of Aggregator: 8b. Nnwdaf_EventsSubscription_Notify response + Aggregator->>NWDAF2: 8a. Nnwdaf_EventsSubscription_Notify request + NWDAF2-->>Aggregator: 8b. Nnwdaf_EventsSubscription_Notify response + + Note left of Aggregator: 9a. Nnwdaf_EventsSubscription_Notify request + Note left of Aggregator: 9b. Nnwdaf_EventsSubscription_Notify response + Aggregator->>NWDAF3: 9a. Nnwdaf_EventsSubscription_Notify request + NWDAF3-->>Aggregator: 9b. Nnwdaf_EventsSubscription_Notify response + + Note left of Aggregator: 10. Aggregate Analytics Outputs + Aggregator->>Consumer: 11a. Nnwdaf_AnalyticsInfo_Request Response + Aggregator->>Consumer: 11b. Nnwdaf_EventsSubscription_Notify request + Consumer-->>Aggregator: 11c. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram illustrating Analytics aggregation with provisioning of Area of Interest. The diagram shows interactions between NWDAF Service Consumer, Aggregator NWDAF1, NWDAF2, and NWDAF3. The process involves requests for analytics info and subscriptions, followed by responses and notifications from the aggregator to the consumer, after aggregating data from other NWDAF instances. + +**Figure 5.3.2-1: Analytics aggregation with provisioning of Area of Interest** + +1a-1c. In order to obtain the specific network data analytics, the NF service consumer selects an NWDAF (e.g. NWDAF1) with aggregation capability according to the results returned by NRF or available information obtained by other means. The NWDAF service consumer invokes Nnwdaf\_AnalyticsInfo\_Request or Nnwdaf\_EventsSubscription\_Subscribe service operations as described in clause 5.2.3.1 and clause 5.2.2.1 to the selected NWDAF. + +In the request message, the analytics event, analytics filter information including the Area of Interest (e.g. TAI-1, TAI-2, TAI-n, if available) and the Target of Analytics Reporting are provided. The NWDAF service consumer may indicate the time when the analytics is needed in "timeAnaNeeded" attribute, which needs to be equal or greater than the supported Analytics Delay per Analytics event of the Aggregator NWDAF. + +2-5b. The Aggregator NWDAF selects the other NWDAF instances, which collectively can cover the area of interest indicated in the request, according to the results returned by the NRF and/or the UDM, or available information obtained by other means. The Aggregator NWDAF invokes Nnwdaf\_AnalyticsInfo\_Request or Nnwdaf\_EventsSubscription\_Subscribe service operations to each selected NWDAF (e.g. NWDAF2, NWDAF3) as described in clause 4.2.2.2 or clause 4.3.2.2 of 3GPP TS 29.520 [5]. + +6-9b. The selected NWDAFs send response or notification containing the requested analytics to the Aggregator NWDAF. If the selected NWDAFs (e.g. NWDAF 2 and/or NWDAF 3) cannot reply or notify the requested analytics before the expiry of the time that the Aggregator NWDAF has indicated, they may send an error response or error notification to the Aggregator NWDAF including a "revised waiting time" in "rvWaitTime" attribute. + +10. The Aggregator NWDAF aggregates the analytics received from the selected NWDAFs and the analytics of its own. + +11a-11c. The Aggregator NWDAF sends a response or notification containing the aggregated output analytics for the requested Analytics event(s) to the NWDAF service consumer. + +If the Aggregator NWDAF cannot reply or notify the requested analytics before the expiry of the time that the consumer has indicated in "timeAnaNeeded" attribute, it may sends an error response or error notification to the consumer including a "revised waiting time" in "rvWaitTime" attribute. + +### 5.3.3 Analytics aggregation without provisioning of Area of Interest + +This procedure is used by the service consumer to request Analytics event(s) without providing an Area of Interest, in which multiple NWDAFs are required to serve the request collectively. + +![Sequence diagram for Analytics aggregation without provisioning of Area of Interest. Lifelines: NWDAF Service Consumer, Aggregator NWDAF1, NWDAF2, UDM, AMF. The process involves a request from the consumer to the aggregator, followed by internal steps (2a-4b) involving UDM and AMF, and then a series of dashed boxes (5-8) representing internal processing and redirection by the aggregator.](7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NWDAF Service Consumer + participant Aggregator as Aggregator NWDAF1 + participant NWDAF2 as NWDAF2 + participant UDM as UDM + participant AMF as AMF + + Note left of Consumer: 1a-1c. Request and subscribe + Consumer-->>Aggregator: 1a. Nnwdaf_AnalyticsInfo_Request request + Consumer-->>Aggregator: 1b. Nnwdaf_EventsSubscription_Subscribe request + Aggregator-->>Consumer: 1c. Nnwdaf_AnalyticsSubscription_Subscribe response + + Note right of Aggregator: 2a-4b. Interaction with UDM and AMF + Aggregator-->>UDM: 2a. Nudm_UECM_Get request + UDM-->>Aggregator: 2b. Nudm_UECM_Get response + Aggregator-->>AMF: 3a. Namf_EventExposure_Subscribe request + AMF-->>Aggregator: 3b. Namf_EventExposure_Subscribe response + Aggregator-->>AMF: 4a. Namf_EventExposure_Notify request + AMF-->>Aggregator: 4b. Namf_EventExposure_Notify response + + Note right of Aggregator: 5. Retrieve NF service area of the data sources + Note right of Aggregator: 6. Query NRF with analytics events and each NF service area or UE location + Note right of Aggregator: 7. Redirect analytics request/Transfer analytics subscription + Note right of Aggregator: 8. Analytics aggregation as specified in steps 2-11c clause 5.3.2 + +``` + +Sequence diagram for Analytics aggregation without provisioning of Area of Interest. Lifelines: NWDAF Service Consumer, Aggregator NWDAF1, NWDAF2, UDM, AMF. The process involves a request from the consumer to the aggregator, followed by internal steps (2a-4b) involving UDM and AMF, and then a series of dashed boxes (5-8) representing internal processing and redirection by the aggregator. + +Figure 5.3.3-1: Analytics aggregation without provisioning of Area of Interest + +1a-1c. In order to obtain the specific network data analytics, the NF service consumer selects an NWDAF (e.g. NWDAF1) with aggregation capability according to the results returned by NRF or available information obtained by other means. The NWDAF service consumer invokes Nnwdaf\_AnalyticsInfo\_Request or Nnwdaf\_EventsSubscription\_Subscribe service operations as described in clause 5.2.3.1 and clause 5.2.2.1 to the + +selected NWDAF. If not, the NWDAF service consumer should select a NWDAF with large serving area from the candidate NWDAFs which supports analytics aggregation, e.g. NWDAF1. + +2a-4b. If the requested analytics requires UE location information, e.g. for the Analytics events "UE\_MOBILITY", "ABNORMAL\_BEHAVIOUR", or "USER\_DATA\_CONGESTION", then: + +- 2a-2b: The Aggregator NWDAF may query UDM to discover the NWDAF serving the UE by invoking Nudm\_UECM\_Get service operation as described in clause 5.3.2.5.12 of 3GPP TS 29.503 [23], if it is supported. + - 3a-4b: The Aggregator NWDAF may determine the AMF serving the UE, then requests UE location information from the AMF by invoking Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18]. The AMF notifies the UE location information by invoking Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. +5. If the requested analytics does not require UE location information, e.g. for the Analytics events "SERVICE\_EXPERIENCE", "NF\_LOAD", or "UE\_COMM", the Aggregator NWDAF can determine the NFs to be contacted for data collection. + 6. With the data obtained in step 3a-5, the Aggregator NWDAF may query the NRF for discovering the required NWDAF, by sending an NF discovery request including UE location or NF serving area as a filter to NRF, and obtains candidates target NWDAF(s) that can provide the required analytics. + 7. If a single target NWDAF (e.g. NWDAF2) can provide the requested analytics data, the Aggregator NWDAF can redirect the Nnwdaf\_AnalyticsInfo\_Request to that target NWDAF or request an analytics subscription transfer to that target NWDAF. + 8. If the Aggregator NWDAF decides to request analytics from one or more target NWDAFs, the steps 2-9b of the analytics aggregation procedure in clause 5.3.2 are executed. + +## 5.4 Procedures for Analytics Transferring + +### 5.4.1 Analytics context transfer initiated by target NWDAF selected by the NWDAF service consumer + +The procedure in below figure is used when an NWDAF service consumer decides to select a new NWDAF instance due to internal or external triggers, e.g. the NWDAF service consumer starts serving a UE with analytics subscription information received upon UE context transfer procedure as described in 3GPP TS 23.502 [3], or the NWDAF service consumer starts to request NF related analytics, or the NWDAF service consumer receives a "Termination Request" for an existing analytics subscription from an NWDAF. The NWDAF service consumer sends to the target NWDAF information about the NWDAF previously used for analytics subscription, if available, in Nnwdaf\_EventsSubscription\_Subscribe service operation. The target NWDAF may initiate the transfer of the analytics context, using the Nnwdaf\_AnalyticsInfo\_ContextTransfer. + +The procedure in below figure is also used when an Aggregator NWDAF, as the NWDAF service consumer, decides to select a new NWDAF to request output analytics for analytics aggregation. For example, upon receiving a Termination Request from one of the NWDAFs that are collectively serving a request for analytics subscription, the Aggregator NWDAF queries the NRF or UDM to select a target NWDAF using information e.g. the UE location, the 5GC NFs (identified by their NF Set IDs or NF types) serving the UE or to be contacted for data collection (if Area of Interest is not provisioned for the requested analytics), or the subset of AoI (if Area of Interest is provisioned for the requested analytics). Then, the Aggregator NWDAF sends information about the NWDAF previously used for analytics subscription, if available, in Nnwdaf\_EventsSubscription\_Subscribe service operation towards the selected target NWDAF. + +![Sequence diagram illustrating the analytics context transfer initiated by target NWDAF selected by the NWDAF service consumer. The diagram shows five lifelines: (old) NWDAF service consumer, (new) NWDAF service consumer, Source NWDAF, Target NWDAF, and Data Source(s). The sequence of messages is: 0. NWDAF service consumer changes (dashed box); 1. Determines to select an NWDAF (dashed box); 2a. Nnwdaf_EventsSubscription_Subscribe request (from new consumer to Target NWDAF); 2b. Nnwdaf_EventsSubscription_Subscribe response (from Target NWDAF to new consumer); 3a. Nnwdaf_AnalyticsInfo_ContextTransfer request (from Target NWDAF to Source NWDAF); 3b. Nnwdaf_AnalyticsInfo_ContextTransfer response (from Source NWDAF to Target NWDAF); 4. The Source NWDAF purges data and if not already done unsubscribes to data source(s) (dashed box); 5. Target NWDAF subscribes to data source(s) (dashed box).](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +Sequence diagram illustrating the analytics context transfer initiated by target NWDAF selected by the NWDAF service consumer. The diagram shows five lifelines: (old) NWDAF service consumer, (new) NWDAF service consumer, Source NWDAF, Target NWDAF, and Data Source(s). The sequence of messages is: 0. NWDAF service consumer changes (dashed box); 1. Determines to select an NWDAF (dashed box); 2a. Nnwdaf\_EventsSubscription\_Subscribe request (from new consumer to Target NWDAF); 2b. Nnwdaf\_EventsSubscription\_Subscribe response (from Target NWDAF to new consumer); 3a. Nnwdaf\_AnalyticsInfo\_ContextTransfer request (from Target NWDAF to Source NWDAF); 3b. Nnwdaf\_AnalyticsInfo\_ContextTransfer response (from Source NWDAF to Target NWDAF); 4. The Source NWDAF purges data and if not already done unsubscribes to data source(s) (dashed box); 5. Target NWDAF subscribes to data source(s) (dashed box). + +**Figure 5.4.1-1: Analytics context transfer initiated by target NWDAF selected by the NWDAF service consumer** + +0. When the NWDAF service consumer (e.g. AMF) changes, the new NWDAF service consumer may receive the old subscription information from the old NWDAF service consumer. +1. The NWDAF service consumer determines to select an NWDAF instance. The NWDAF service consumer discovers and selects the target NWDAF as specified in clause 5.8. +2. To send a request for analytics subscription to the target NWDAF, the NWDAF service consumer invokes Nnwdaf\_EventsSubscription\_Subscribe service operation by sending the HTTP POST request message targeting the resource "NWDAF Events Subscriptions" to the target NWDAF. The NWDAF service consumer includes information on the previous analytics subscription (e.g., NWDAF ID and Subscription ID) which relates to the requested analytics subscription, if available. If the target NWDAF accepts the analytics subscription request, it responds with HTTP "201 Created" to the NWDAF service consumer. Details are described in clause 4.2.2.2 of 3GPP TS 29.520 [5]. + +If the target NWDAF does not receive information of previous analytics subscription in step 2, for UE related Analytics, the target NWDAF may discover previously used NWDAF in UDM as specified in clause 5.8. + +**NOTE:** If the selected target NWDAF instance is the same as the source NWDAF instance (as received from the other consumer in step 0), the new NWDAF service consumer invokes Nnwdaf\_EventsSubscription\_Subscribe service operation by sending the HTTP PUT request message targeting the resource "Individual NWDAF Event Subscription" to the target NWDAF, and the target NWDAF will update the existing analytics subscription to the new NWDAF service consumer. Following steps are skipped. + +3. If the target NWDAF decides to request an analytics context transfer from the previously used NWDAF, it invokes the Nnwdaf\_AnalyticsInfo\_ContextTransfer service operation by sending the HTTP GET request message targeting the resource "NWDAF Context" to the source NWDAF as described in clause 4.3.2.3 of 3GPP TS 29.520 [5]. + +Target NWDAF is now ready to generate analytics information by taking into account the information received in step 3. + +4. [Optional] Source NWDAF may purge analytics context after completion of step 3a, if performed, and if not already done, unsubscribes from the data source(s) and/or model source(s) that are no longer needed for the remaining analytics subscriptions. + +5. [Optional] Target NWDAF may subscribe to relevant data source(s) and/or model source(s), if it is not yet subscribed to the data source(s) and/or model source(s). + +### 5.4.2 Analytics Subscription Transfer initiated by source NWDAF + +The procedure in below figure is used by a source NWDAF instance to request the transfer of analytics subscription(s) to another target NWDAF instance, using the Nnwdaf\_EventsSubscription\_Transfer service operation. + +If the source NWDAF discovers that the NWDAF service consumer may change concurrently to this procedure, the source NWDAF should not perform the procedure. In such a case, the source NWDAF may send a message to indicate to the NWDAF service consumer that it will not serve this subscription anymore. + +- NOTE 1: To discover the possible change of NWDAF service consumer, if the Analytics Event is UE related, the source NWDAF takes actions responding to external trigger (such as UE mobility), for example, checking if the Target of Analytics Reporting is still within the serving area of the analytics consumer, if the serving area information is available. +- NOTE 2: Handling of overload situation or preparation for a graceful shutdown are preferably executed inside an NWDAF Set, when available, therefore, not requiring an analytics subscription transfer as described in this clause. Below procedure is applicable for analytics subscription transfer across NF Sets or if the NWDAF is not deployed in a Set. + +![Sequence diagram for Analytics subscription transfer initiated by source NWDAF. Lifelines: NWDAF service consumer, Source NWDAF, Target NWDAF, Data source. The process involves subscription, determination, discovery, transfer request/response, takeover, notification, context retrieval, subscription to data source, response, unsubscribe, new data derivation, and final notification.](05eb72d372e4bf78e3d6a64949d77bcc_img.jpg) + +``` + +sequenceDiagram + participant NWDAF service consumer + participant Source NWDAF + participant Target NWDAF + participant Data source + + Note over all: 0. NWDAF service consumer subscribes to Analytics from source NWDAF. +Optionally, the source NWDAF subscribes to UE mobility events. + Note right of Source NWDAF: 1. Source NWDAF determines, e.g. caused by UE mobility event notifications, to trigger a prepared analytics subscription transfer to the target NWDAF. + Note right of Source NWDAF: 2. Source NWDAF determines to request an analytics subscription transfer + Note right of Source NWDAF: 3. Source NWDAF discovers and selects target NWDAF. + Source NWDAF->>Target NWDAF: 4a. Nnwdaf_EventsSubscription_Transfer request + Target NWDAF-->>Source NWDAF: 4b. Nnwdaf_EventsSubscription_Transfer response + Note right of Target NWDAF: 5. Takes over Analytics subscription + Target NWDAF->>NWDAF service consumer: 6a. Nnwdaf_EventsSubscription_Notify request + NWDAF service consumer-->>Target NWDAF: 6b. Nnwdaf_EventsSubscription_Notify response + Note right of Target NWDAF: 7. Target NWDAF retrieves analytics context + Note right of Target NWDAF: 8. Target NWDAF subscribes to data source(s) + Target NWDAF-->>Source NWDAF: 9. Nnwdaf_EventsSubscription_Transfer response + Note right of Source NWDAF: 10. Source NWDAF unsubscribes from data source(s) + Note right of Target NWDAF: 11. Target NWDAF receives new input data from data source(s) and derives new analytics. + Target NWDAF->>NWDAF service consumer: 12a. Nnwdaf_EventsSubscription_Notify request + NWDAF service consumer-->>Target NWDAF: 12b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for Analytics subscription transfer initiated by source NWDAF. Lifelines: NWDAF service consumer, Source NWDAF, Target NWDAF, Data source. The process involves subscription, determination, discovery, transfer request/response, takeover, notification, context retrieval, subscription to data source, response, unsubscribe, new data derivation, and final notification. + +**Figure 5.4.2-1: Analytics subscription transfer initiated by source NWDAF** + +0. The NWDAF service consumer subscribes to analytics from source NWDAF. The NWDAF service consumer may send its NF ID or serving area, enabling the source NWDAF to determine whether the following analytics subscription transfer procedure is applicable. Optionally the source NWDAF subscribes to UE mobility events. + +1. [Optional] Source NWDAF determines, e.g. triggered by a UE mobility event notification, to prepare an analytics subscription transfer to target NWDAF(s) as described in clause 5.4.3 with steps 0-1, 5- 6 will be followed. +2. Source NWDAF determines, e.g. based on the UE location information received and the analytics consumer's serving area either directly received in step 0 or indirectly received via NRF, to perform an analytics subscription transfer to target NWDAF(s). Therefore, the source NWDAF determines the analytics subscription(s) to be transferred to a target NWDAF. +3. Source NWDAF performs an NWDAF discovery and selects the target NWDAF. NWDAF discovery may be skipped if the target NWDAF had already been discovered as part of a prepared analytics subscription transfer. In the case of aggregated analytics from multiple NWDAFs, the source NWDAF may use the set of NWDAF identifiers related to aggregated analytics to preferably select a target NWDAF that is already serving the consumer. +4. Source NWDAF requests, using Nnwdaf\_EventsSubscription\_Transfer service operation, a transfer of the analytics subscription(s) determined in step 2 to the target NWDAF as described in clause 4.2.2.5 of 3GPP TS 29.520 [5], the response message in step 4b is optional. +5. Target NWDAF accepts the analytics subscription transfer and takes over the analytics generation based on the information received from the source NWDAF. + +The ML model related information namely ModelInfo may be provided by the source NWDAF in the Nnwdaf\_EventsSubscription\_Transfer request message. + +- If the instance ID or set ID of NWDAF(s) containing MTLF carried in "modelProvIds" attribute is provided in the Nnwdaf\_EventsSubscription\_Transfer, target NWDAF may request or subscribe to the ML model(s) from the indicated NWDAF(s). + +NOTE 3: If the provided ID(s) of NWDAF(s) containing MTLF carried in "modelProvIds" attribute are not part of the locally configured ID(s) of NWDAFs containing MTLF, the target NWDAF discovers the NWDAF(s) containing MTLF as described in clause 5.8.2.3. + +- When the source NWDAF itself provides the ML models, the address of ML model files may be provided, and the target NWDAF retrieves the ML model(s) from the indicated address. + +Target NWDAF may use the above retrieved ML models and the ML models retrieved from the locally configured NWDAFs containing MTLF for the transferred analytics subscription. + +NOTE 4: If not yet done during a prepared analytics subscription transfer, the target NWDAF allocates a new Subscription ID to the received analytics subscriptions. + +NOTE 5: The target NWDAF might already have received information on some/all of the analytics subscriptions as part of the prepared analytics subscription transfer request received in step 1 and, thus, might already have started to prepare for the analytics generation, e.g. by having already subscribed to relevant event notifications. + +6. Target NWDAF informs the NWDAF service consumer about the successful analytics subscription transfer using a Nnwdaf\_EventsSubscription\_Notify request message. A new Subscription ID, which was assigned by the target NWDAF, is provided in the Subscription ID and the old Subscription Id, which was allocated by the source NWDAF, is provided in the Old Subscription ID parameter of this message. + +NOTE 6: Notification correlation information in the Nnwdaf\_EventsSubscription\_Notify message allows the NWDAF service consumer to correlate the notifications to the initial subscription request made with the source NWDAF in step 0. + +NOTE 7: The existing Analytics context in the source NWDAF is not deleted directly but will be purged first when it was collected by the target NWDAF. + +NOTE 8: If this subscription is used as input for analytics aggregation by the NWDAF service consumer, the NWDAF service consumer may inform the other NWDAFs instance participating in this analytics aggregation that the Set of NWDAF identifiers of NWDAF instances used by the NWDAF service consumer for this analytics aggregation has changed using the Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 4.2.2.2 of 3GPP TS 29.520 [5]. + +7. [Conditional] If "analytics context identifier(s)" had been included in the Nnwdaf\_EventsSubscription\_Transfer Request received in step 4, the target NWDAF requests the "analytics context" by invoking the Nnwdaf\_AnalyticsInfo\_ContextTransfer service operation as described in clause 4.3.2.3 of 3GPP TS 29.520 [5]. +8. [Optional] Target NWDAF subscribes to relevant data source(s), if it is not yet subscribed to the data source(s) for the data required for the Analytics. +9. [Optional] Target NWDAF confirms the analytics subscription transfer to the source NWDAF by sending Nnwdaf\_EventsSubscription\_Transfer response message as described in clause 4.2.2.5 of 3GPP TS 29.520 [5], if the response has not been sent in step 4b. +10. [Optional] Source NWDAF unsubscribes with the data source(s) that are no longer needed for the remaining analytics subscriptions. In addition, Source NWDAF unsubscribes with the NWDAF(s) containing MTLF, if exist, which are no longer needed for the remaining analytics subscriptions. + +NOTE 9: At this point, the analytics subscription transfer is deemed completed, i.e. the source NWDAF can delete all information related to the successfully transferred analytics subscription. + +- 11-12. Target NWDAF at some point derives new output analytics based on new input data and notifies the NWDAF service consumer about the new analytics using a Nnwdaf\_EventsSubscription\_Notify message as described in clause 4.2.2.4 of 3GPP TS 29.520 [5]. + +### 5.4.3 Prepared analytics subscription transfer + +The procedure in below figure is used by a NWDAF instance to request another NWDAF instance for a prepared analytics subscription transfer from the source NWDAF instance, using the Nnwdaf\_EventsSubscription\_Transfer service operation. + +NOTE 1: The source NWDAF might determine that it needs to prepare to transfer analytics to another NWDAF instance, e.g. when the source NWDAF estimates for UE related analytics subscription that the UE might enter an area which is not covered by the source NWDAF (e.g., by subscribing to AMF event exposure service for UE mobility event notifications, by performing UE mobility analytics, or by subscribing to another NWDAF providing UE mobility analytics). If the source NWDAF discovers that the analytics consumer may change concurrently to this procedure, the source NWDAF does not perform the procedure. If the procedure makes use of predictions to determine the candidate NWDAFs, care must be taken with regards to load and signalling cost when sending data to an NWDAF that will not eventually start serving the UE. + +NOTE 2: The source NWDAF might also determine that it needs to prepare to transfer analytics subscriptions to another NWDAF instance, as the source NWDAF wants to resolve an internal load situation or prepare for a graceful shutdown. + +NOTE 3: Handling of overload situation or preparation for a graceful shutdown are preferably executed inside an NWDAF Set, when available. + +![Sequence diagram for Figure 5.4.3-1: Prepared analytics subscription transfer. The diagram shows interactions between four lifelines: NWDAF service consumer, Source NWDAF, Target NWDAF, and Data source. The sequence starts with the consumer subscribing to the source NWDAF (1a, 1b), then receiving a notification (2a, 2b). The source NWDAF then determines to transfer the subscription (3) and discovers a target NWDAF (4). It sends a transfer request to the target (5a, 5b). The target requests context information (6a, 6b). A dashed box indicates the target collecting data from the data source (7). Finally, the source sends another transfer request to the target (8a, 8b).](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NWDAF service consumer + participant SourceNWDAF as Source NWDAF + participant TargetNWDAF as Target NWDAF + participant DataSource as Data source + + Note right of SourceNWDAF: 3. Source NWDAF determines to trigger a prepared analytics subscription transfer to the target NWDAF. + Note right of SourceNWDAF: 4. Source NWDAF discovers and selects target NWDAF. + + Note right of TargetNWDAF: 7. Collect data from the data source + + Consumer->>SourceNWDAF: 1a. Nnwdaf_EventsSubscription_Subscribe request + SourceNWDAF-->>Consumer: 1b. Nnwdaf_EventsSubscription_Subscribe response + SourceNWDAF-->>Consumer: 2a. Nnwdaf_EventsSubscription_Notify request + Consumer-->>SourceNWDAF: 2b. Nnwdaf_EventsSubscription_Notify response + SourceNWDAF->>TargetNWDAF: 5a. Nnwdaf_EventsSubscription_Transfer request + TargetNWDAF-->>SourceNWDAF: 5b. Nnwdaf_EventsSubscription_Transfer response + TargetNWDAF-->>SourceNWDAF: 6a. Nnwdaf_AnalyticsInfo_ContextTransfer Request + SourceNWDAF-->>TargetNWDAF: 6b. Nnwdaf_AnalyticsInfo_ContextTransfer Response + SourceNWDAF->>TargetNWDAF: 8a. Nnwdaf_EventsSubscription_Transfer request + TargetNWDAF-->>SourceNWDAF: 8b. Nnwdaf_EventsSubscription_Transfer response + +``` + +Sequence diagram for Figure 5.4.3-1: Prepared analytics subscription transfer. The diagram shows interactions between four lifelines: NWDAF service consumer, Source NWDAF, Target NWDAF, and Data source. The sequence starts with the consumer subscribing to the source NWDAF (1a, 1b), then receiving a notification (2a, 2b). The source NWDAF then determines to transfer the subscription (3) and discovers a target NWDAF (4). It sends a transfer request to the target (5a, 5b). The target requests context information (6a, 6b). A dashed box indicates the target collecting data from the data source (7). Finally, the source sends another transfer request to the target (8a, 8b). + +**Figure 5.4.3-1: Prepared analytics subscription transfer** + +1a-1b. The NWDAF service consumer subscribes to analytics from source NWDAF by invoking Nnwdaf\_EventsSubscription\_Subscribe service operation. The source NWDAF responds to Nnwdaf\_EventsSubscription\_Subscribe service operation. + +2a-2b. The source NWDAF generates the requested analytics and notify the NWDAF service consumer by invoking the Nnwdaf\_EventsSubscription\_Notify service operation. The NWDAF service consumer responds to the Nnwdaf\_EventsSubscription\_Notify service operation. + +3. The source NWDAF determines that it needs to prepare to transfer the analytics subscription to another NWDAF instance. + +4. The source NWDAF discovers and selects the target NWDAF as described in clause 5.8.2.3. + +5a-5b. The source NWDAF invokes Nnwdaf\_EventsSubscription\_Transfer service operation by sending an HTTP POST request to the target NWDAF and the "transReqType" attribute in the request message is set to "PREPARE". The target NWDAF sends an HTTP "201 Created" to the source NWDAF. + +6a-6b. If analytics context identifier information had been included in the Nnwdaf\_EventsSubscription\_Transfer request message, the target NWDAF requests the analytics context information from the source NWDAF by + +invoking the Nnwdaf\_AnalyticsInfo\_ContextTransfer service operation by sending the HTTP GET request message targeting the resource "NWDAF Context" to the source NWDAF. + +7. The target NWDAF collect the data required for the analytics from the relevant data source(s), if it is not yet collected. + +8a-8b. The source NWDAF invokes the Nnwdaf\_EventsSubscription\_Transfer service operation by sending an HTTP DELETE request to cancel the prepared analytics subscription transfer. The target NWDAF sends response to the source NWDAF and deletes the analytics data that is no longer needed. If the target NWDAF had already subscribed to entities to collect data or ML models during the analytics subscription preparation, it unsubscribes from those entities if the subscriptions are not needed for other active analytics subscriptions. + +## 5.5 Data Collection + +### 5.5.1 Procedure for Data Collection from NFs + +#### 5.5.1.1 Data Collection from NFs + +The procedure in Figure 5.5.1.1-1 is used by NWDAF to subscribe/unsubscribe at NFs in order to be notified for data collection on related event(s), using Event Exposure Services as listed in Table 6.2.2.1-1 defined in TS 23.288 [2] clause 6.2.2. + +![Sequence diagram showing the procedure for Data Collection from NFs. The diagram involves three participants: NWDAF, NF, and UDM. The sequence of messages is as follows: 1a. Nudm_SDM_Get request (NWDAF to UDM), 2a. Nudm_SDM_Get response (UDM to NWDAF), 1b. Nudm_SDM_Subscribe request (NWDAF to UDM), 2b. Nudm_SDM_Subscribe response (UDM to NWDAF), 3. Nnf_EventExposure_Subscribe request (NWDAF to NF), 4. Nnf_EventExposure_Subscribe response (NF to NWDAF), 5. Nnf_EventExposure_Notify request (NF to NWDAF), 6. Nnf_EventExposure_Notify response (NWDAF to NF), 6a. Nudm_SDM_Notification request (NWDAF to UDM), 6b. Nudm_SDM_Notification response (UDM to NWDAF), 6c. Nudm_SDM_Unsubscribe request (NWDAF to UDM), 6d. Nudm_SDM_Unsubscribe response (UDM to NWDAF), 7. Nnf_EventExposure_Unsubscribe request (NWDAF to NF), 8. Nnf_EventExposure_Unsubscribe response (NF to NWDAF).](257c8341b41f1f4a287f27d33227974c_img.jpg) + +``` + +sequenceDiagram + participant NWDAF + participant NF + participant UDM + Note left of NWDAF: 1a. Nudm_SDM_Get request + NWDAF-->>UDM: 1a. Nudm_SDM_Get request + Note right of UDM: 2a. Nudm_SDM_Get response + UDM-->>NWDAF: 2a. Nudm_SDM_Get response + Note left of NWDAF: 1b. Nudm_SDM_Subscribe request + NWDAF-->>UDM: 1b. Nudm_SDM_Subscribe request + Note right of UDM: 2b. Nudm_SDM_Subscribe response + UDM-->>NWDAF: 2b. Nudm_SDM_Subscribe response + Note left of NWDAF: 3. Nnf_EventExposure_Subscribe request + NWDAF->>NF: 3. Nnf_EventExposure_Subscribe request + Note right of NF: 4. Nnf_EventExposure_Subscribe response + NF-->>NWDAF: 4. Nnf_EventExposure_Subscribe response + Note left of NF: 5. Nnf_EventExposure_Notify request + NF->>NWDAF: 5. Nnf_EventExposure_Notify request + Note right of NWDAF: 6. Nnf_EventExposure_Notify response + NWDAF->>NF: 6. Nnf_EventExposure_Notify response + Note left of NWDAF: 6a. Nudm_SDM_Notification request + NWDAF-->>UDM: 6a. Nudm_SDM_Notification request + Note right of UDM: 6b. Nudm_SDM_Notification response + UDM-->>NWDAF: 6b. Nudm_SDM_Notification response + Note left of NWDAF: 6c. Nudm_SDM_Unsubscribe request + NWDAF-->>UDM: 6c. Nudm_SDM_Unsubscribe request + Note right of UDM: 6d. Nudm_SDM_Unsubscribe response + UDM-->>NWDAF: 6d. Nudm_SDM_Unsubscribe response + Note left of NWDAF: 7. Nnf_EventExposure_Unsubscribe request + NWDAF->>NF: 7. Nnf_EventExposure_Unsubscribe request + Note right of NF: 8. Nnf_EventExposure_Unsubscribe response + NF-->>NWDAF: 8. Nnf_EventExposure_Unsubscribe response + +``` + +Sequence diagram showing the procedure for Data Collection from NFs. The diagram involves three participants: NWDAF, NF, and UDM. The sequence of messages is as follows: 1a. Nudm\_SDM\_Get request (NWDAF to UDM), 2a. Nudm\_SDM\_Get response (UDM to NWDAF), 1b. Nudm\_SDM\_Subscribe request (NWDAF to UDM), 2b. Nudm\_SDM\_Subscribe response (UDM to NWDAF), 3. Nnf\_EventExposure\_Subscribe request (NWDAF to NF), 4. Nnf\_EventExposure\_Subscribe response (NF to NWDAF), 5. Nnf\_EventExposure\_Notify request (NF to NWDAF), 6. Nnf\_EventExposure\_Notify response (NWDAF to NF), 6a. Nudm\_SDM\_Notification request (NWDAF to UDM), 6b. Nudm\_SDM\_Notification response (UDM to NWDAF), 6c. Nudm\_SDM\_Unsubscribe request (NWDAF to UDM), 6d. Nudm\_SDM\_Unsubscribe response (UDM to NWDAF), 7. Nnf\_EventExposure\_Unsubscribe request (NWDAF to NF), 8. Nnf\_EventExposure\_Unsubscribe response (NF to NWDAF). + +Figure 5.5.1.1-1: Event Exposure Subscribe/Unsubscribe for NFs + +- 1a. If data is to be collected for a user, i.e. for a SUPI or GPSI, the user consent has not been checked by the data consumer, and local policy and regulations require to check user consent, the NWDAF invokes Nudm\_SDM\_Get service operation by sending an HTTP GET request targeting the resource "AccessAndMobilitySubscriptionData" to the UDM to request the data type "User consent" as described in clause 5.2.2.2 of 3GPP TS 29.503 [22]. Otherwise the procedure begins with step 3. +- 2a. The UDM responds to the Nudm\_SDM\_Get service operation. If the request is accepted, the response includes the requested data with "200 OK". In subsequent steps, the NWDAF excludes the SUPI or GPSI from requests to collect data for users for whom the user consent is not granted. +- 1b. For the users for which the user consent is granted, the NWDAF subscribes to notifications of changes of the user consent by invoking the Nudm\_SDM\_Subscribe service operation by sending an HTTP POST request targeting the resource "SdmSubscriptions" to the UDM as described in clause 5.2.2.3 of 3GPP TS 29.503 [22]. +- 2b. The UDM responds to the Nudm\_SDM\_Subscribe service operation. If the request is accepted, the UDM responds with "201 Created". +3. In order to subscribe to notifications (or to modify subscriptions to notifications) of data events from the data source NF (e.g. UDM, AMF, SMF, NEF, AF), the NWDAF invokes the Nnf\_EventExposure\_Subscribe service operation by sending an HTTP POST (or PUT, for modification) request targeting the resource representing event exposure subscriptions of that NF, e.g. as described in clause 5.5.2.2 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.2 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.3 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.2 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.2 of 3GPP TS 29.517 [12] for the AF. +4. The NF responds to the Nnf\_EventExposure\_Subscribe service operation. Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NF responds to the NWDAF with "201 Created", and the URI of the created subscription is included in the Location header field. +5. If the NF observes the subscribed event(s), the NF invokes Nnf\_EventExposure\_Notify service operation to report the event(s) by sending an HTTP POST request, e.g. as described in clause 5.5.2.4 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.4 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.2 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.4 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.4 of 3GPP TS 29.517 [12] for the AF. +- 6a. If the user consent changes and the NWDAF has subscribed to UDM to notifications of user consent change for a user, the UDM invokes Nudm\_SDM\_Notification service operation by sending an HTTP POST request as described in clause 5.2.2.5 of 3GPP TS 29.503 [22]. +- 6b. The NWDAF responds to the Nudm\_SDM\_Notification service operation with "204 No Content". +- 6c. The NWDAF may invoke Nudm\_SDM\_Unsubscribe service operation by sending an HTTP DELETE request as described in clause 5.2.2.4 of 3GPP TS 29.503 [22] to unsubscribe from UDM to be notified of user consent change for each user whose user consent is revoked. +- 6d. If the deletion request is accepted, the UDM responds to the Nudm\_SDM\_Unsubscribe service operation with "204 No Content". +7. If the user consent is no longer granted or the data collection is no longer required, the NWDAF unsubscribes to the notifications of data events from the NF. The NWDAF invokes Nnf\_EventExposure\_Unsubscribe service operation by sending an HTTP DELETE request targeting the resource that represents the previously created individual event exposure subscription, e.g. as described in clause 5.5.2.3 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.3 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.4 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.3 of 3GPP TS 29.591 [11] for the NEF, clause 4.2.3 of 3GPP TS 29.517 [12] for the AF. The request includes the event subscriptionId of the existing subscription that is to be deleted. +8. The NF responds to the Nnf\_EventExposure\_Unsubscribe service operation. If the subscription deletion is accepted, the NF responds with "204 No Content". + +### 5.5.2 Data collection profile registration + +This procedure depicted in Figure 5.5.2-1 is used by NWDAF or ADRF to register/update a data collection profile to the DCCF during/after the procedure of data collection. + +![Sequence diagram illustrating the procedure for the NWDAF or ADRF to register data profile to DCCF. The diagram shows interactions between Data Consumer, DCCF, and ADRF or NWDAF. The process includes: 1. Data collection by ADRF/NWDAF; 2. Register request from ADRF/NWDAF to DCCF; 3. Register response from DCCF to ADRF/NWDAF; 4. Update request from Data Consumer to DCCF; 5. Update response from DCCF to Data Consumer; 6. Subscribe request from Data Consumer to DCCF (labeled 'Data Collection via DCCF'); 7. Deregister request from ADRF/NWDAF to DCCF; 8. Deregister response from DCCF to ADRF/NWDAF.](329c96049bb432e9c2cbda4e224a0c9c_img.jpg) + +``` + +sequenceDiagram + participant DC as Data Consumer + participant DCCF as DCCF + participant AN as ADRF or NWDAF + + Note right of AN: 1. Collect data directly, i.e. not via DCCF + AN->>DCCF: 2. Ndpcf_ContextManagement_Register Request + DCCF-->>AN: 3. Ndpcf_ContextManagement_Register Response + DC->>DCCF: 4. Ndpcf_ContextManagement_Update Request + DCCF-->>DC: 5. Ndpcf_ContextManagement_Update Response + Note left of DCCF: Data Collection via DCCF + DC->>DCCF: 6. Ndpcf_DataManagement_Subscribe + AN->>DCCF: 7. Ndpcf_ContextManagement_Deregister Request + DCCF-->>AN: 8. Ndpcf_ContextManagement_Deregister Response + +``` + +Sequence diagram illustrating the procedure for the NWDAF or ADRF to register data profile to DCCF. The diagram shows interactions between Data Consumer, DCCF, and ADRF or NWDAF. The process includes: 1. Data collection by ADRF/NWDAF; 2. Register request from ADRF/NWDAF to DCCF; 3. Register response from DCCF to ADRF/NWDAF; 4. Update request from Data Consumer to DCCF; 5. Update response from DCCF to Data Consumer; 6. Subscribe request from Data Consumer to DCCF (labeled 'Data Collection via DCCF'); 7. Deregister request from ADRF/NWDAF to DCCF; 8. Deregister response from DCCF to ADRF/NWDAF. + +**Figure 5.5.2-1: Procedure for the NWDAF or ADRF to register data profile to DCCF** + +1. An ADRF or NWDAF instance is collecting or has collected data directly, e.g. from collocated NF. +2. In order to register a data collection profile, the ADRF or NWDAF invokes the `Ndpcf_ContextManagement_Register` service operation by sending an HTTP POST request targeting the resource "DCCF Data Collection Profiles" as described in clause 4.3.2.2 of 3GPP TS 29.574 [15]. +3. The DCCF responds to the `Ndpcf_ContextManagement_Register` service operation. Upon receipt of the HTTP POST request, if the data profile is accepted to be created, the DCCF responds to the ADRF or NWDAF with "201 Created", and the URI of the created profile is included in the Location header field. +4. In order to update a data collection profile, the Data Consumer invokes the `Ndpcf_ContextManagement_Update` service operation by sending an HTTP PUT request targeting the resource "Individual DCCF Data Collection Profile" as described in clause 4.3.2.3 of 3GPP TS 29.574 [15]. +5. The DCCF responds to the `Ndpcf_ContextManagement_Update` service operation. Upon receipt of the HTTP PUT request, if the data profile is accepted to be updated, the DCCF responds to the ADRF or NWDAF with "200 OK" with a response body containing a representation of the updated data profile or "204 No Content". +6. To obtain historical data and if the data consumer is configured to collect data via the DCCF using the `Ndpcf_DataManagement_Subscribe` service operation, the data consumer uses the procedures described in clause 5.5.3. +7. The ADRF or NWDAF requests to delete a registered data collection profile at the DCCF invoking the `Ndpcf_ContextManagement_Deregister` service operation by sending a HTTP DELETE request targeting the "Individual DCCF Data Collection Profile" resource of the DCCF as described in clause 4.3.2.4 of 3GPP TS 29.574 [15]. +8. The DCCF responds to the `Ndpcf_ContextManagement_Deregister` service operation with HTTP "204 No Content" status code, if the data collection profile is successfully removed. + +### 5.5.3 Procedure for Data Collection using DCCF + +#### 5.5.3.1 Data Collection via DCCF + +The procedure depicted in Figure 5.5.3.1-1 is used by a data consumer (e.g. NWDAF) to obtain data and be notified of events via the DCCF using the Ndcf\_DataManagement\_Subscribe service operation. Whether the data consumer directly contacts the Data Source or goes via the DCCF is based on configuration of the data consumer. + +![Sequence diagram for Data Management in 3GPP TS 29.552 V18.3.0. Lifelines: Data Consumer, DCCF, ADRF, NWDAF, Data Source, UDM. The diagram shows the interaction for subscribing, fetching, and unsubscribing to data.](9252ccfbbe9e34cb108f0060f2b563f1_img.jpg) + +``` + +sequenceDiagram + participant DC as Data Consumer + participant DCCF + participant ADRF + participant NWDAF + participant DS as Data Source + participant UDM + + Note left of DC: 1. Ndcf_DataManagement_Subscribe request + DC->>DCCF: 1. Ndcf_DataManagement_Subscribe request + Note right of DCCF: 2a. Nudm_SDM_Get request + DCCF-->>UDM: 2a. Nudm_SDM_Get request + Note right of UDM: 3a. Nudm_SDM_Get response + UDM-->>DCCF: 3a. Nudm_SDM_Get response + Note right of DCCF: 2b. Nudm_SDM_Subscribe request + DCCF-->>UDM: 2b. Nudm_SDM_Subscribe request + Note right of UDM: 3b. Nudm_SDM_Subscribe response + UDM-->>DCCF: 3b. Nudm_SDM_Subscribe response + + Note left of DC: 4. Determine whether historical data handling is applicable + Note left of DC: 5a. Determine whether the requested data is already being collected + + Note right of DCCF: 6a. Nnf_EventExposure_Subscribe request + DCCF-->>DS: 6a. Nnf_EventExposure_Subscribe request + Note right of DS: 7a. Nnf_EventExposure_Subscribe response + DS-->>DCCF: 7a. Nnf_EventExposure_Subscribe response + + Note left of DC: 5b. If historical data handling is applicable, and DCCF determine to retrieve data from ADRF Instance + Note right of DCCF: 6b. Nadrf_DataManagement_RetrievalSubscribe request + DCCF-->>ADRF: 6b. Nadrf_DataManagement_RetrievalSubscribe request + Note right of ADRF: 7b. Nadrf_DataManagement_RetrievalSubscribe response + ADRF-->>DCCF: 7b. Nadrf_DataManagement_RetrievalSubscribe response + + Note left of DC: 5c. If historical data handling is applicable, and DCCF determine to retrieve analytics data from NWDAF Instance + Note right of DCCF: 6c. Nnwdaf_DataManagement_Subscribe request + DCCF-->>NWDAF: 6c. Nnwdaf_DataManagement_Subscribe request + Note right of NWDAF: 7c. Nnwdaf_DataManagement_Subscribe response + NWDAF-->>DCCF: 7c. Nnwdaf_DataManagement_Subscribe response + + Note left of DC: 8. Ndcf_DataManagement_Subscribe response + DCCF-->>DC: 8. Ndcf_DataManagement_Subscribe response + + Note right of DCCF: 9a. Nnf_EventExposure_Notify request + DCCF-->>DS: 9a. Nnf_EventExposure_Notify request + Note right of DS: 10a. Nnf_EventExposure_Notify response + DS-->>DCCF: 10a. Nnf_EventExposure_Notify response + + Note right of DCCF: 9b. Nadrf_DataManagement_RetrievalNotify request + DCCF-->>ADRF: 9b. Nadrf_DataManagement_RetrievalNotify request + Note right of ADRF: 10b. Nadrf_DataManagement_RetrievalNotify response + ADRF-->>DCCF: 10b. Nadrf_DataManagement_RetrievalNotify response + + Note right of DCCF: 9c. Nnwdaf_DataManagement_Notify request + DCCF-->>NWDAF: 9c. Nnwdaf_DataManagement_Notify request + Note right of NWDAF: 10c. Nnwdaf_DataManagement_Notify response + NWDAF-->>DCCF: 10c. Nnwdaf_DataManagement_Notify response + + Note left of DC: 11. Ndcf_DataManagement_Notify request + DCCF-->>DC: 11. Ndcf_DataManagement_Notify request + Note left of DC: 12. Ndcf_DataManagement_Notify response + DC-->>DCCF: 12. Ndcf_DataManagement_Notify response + + Note left of DC: Data Fetch + Note left of DC: 13. Ndcf_DataManagement_Fetch Request + DC->>DCCF: 13. Ndcf_DataManagement_Fetch Request + Note left of DC: 14. Ndcf_DataManagement_Fetch response + DCCF-->>DC: 14. Ndcf_DataManagement_Fetch response + + Note left of DC: Unsubscribe + Note left of DC: 15. Ndcf_DataManagement_Unsubscribe request + DC->>DCCF: 15. Ndcf_DataManagement_Unsubscribe request + Note left of DC: 16. Ndcf_DataManagement_Unsubscribe response + DCCF-->>DC: 16. Ndcf_DataManagement_Unsubscribe response + + Note right of DCCF: 16a. Nudm_SDM_Notification request + DCCF-->>UDM: 16a. Nudm_SDM_Notification request + Note right of UDM: 16b. Nudm_SDM_Notification response + UDM-->>DCCF: 16b. Nudm_SDM_Notification response + + Note right of DCCF: 16c. Nudm_SDM_Unsubscribe request + DCCF-->>UDM: 16c. Nudm_SDM_Unsubscribe request + Note right of UDM: 16d. Nudm_SDM_Unsubscribe response + UDM-->>DCCF: 16d. Nudm_SDM_Unsubscribe response + + Note right of DCCF: 17a. Nnf_EventExposure_Unsubscribe request + DCCF-->>DS: 17a. Nnf_EventExposure_Unsubscribe request + Note right of DS: 18a. Nnf_EventExposure_Unsubscribe response + DS-->>DCCF: 18a. Nnf_EventExposure_Unsubscribe response + + Note right of DCCF: 17b. Nadrf_DataManagement_RetrievalUnsubscribe request + DCCF-->>ADRF: 17b. Nadrf_DataManagement_RetrievalUnsubscribe request + Note right of ADRF: 18b. Nadrf_DataManagement_RetrievalUnsubscribe response + ADRF-->>DCCF: 18b. Nadrf_DataManagement_RetrievalUnsubscribe response + + Note right of DCCF: 17c. Nnwdaf_DataManagement_Unsubscribe request + DCCF-->>NWDAF: 17c. Nnwdaf_DataManagement_Unsubscribe request + Note right of NWDAF: 18c. Nnwdaf_DataManagement_Unsubscribe response + NWDAF-->>DCCF: 18c. Nnwdaf_DataManagement_Unsubscribe response + +``` + +Sequence diagram for Data Management in 3GPP TS 29.552 V18.3.0. Lifelines: Data Consumer, DCCF, ADRF, NWDAF, Data Source, UDM. The diagram shows the interaction for subscribing, fetching, and unsubscribing to data. + +###### **Figure 5.5.3.1-1: Data Collection via DCCF** + +1. In order to subscribe to notification(s) of events exposure via the DCCF based on local configuration, the Data Consumer invokes the Ndcf\_DataManagement\_Subscribe service operation by sending an HTTP POST request targeting the resource "DCCF Data Subscriptions" as described in clause 4.2.2.2.4 of 3GPP TS 29.574 [15]. +- 2a. If data is to be collected for a user, i.e. for a SUPI or GPSI, the user consent has not been checked by the data consumer, and local policy and regulations require to check user consent, the DCCF invokes the Nudm\_SDM\_Get service operation by sending an HTTP GET request targeting the resource "AccessAndMobilitySubscriptionData" at the UDM to request the data type "User consent" as described in clause 5.2.2.2 of 3GPP TS 29.503 [22]. Otherwise the procedure continues with step 4. +- 3a. The UDM responds to the Nudm\_SDM\_Get service operation. If the request is accepted, the response includes the requested data with "200 OK". In subsequent steps, the DCCF excludes the SUPI or GPSI from requests to collect data for users for whom the user consent is not granted. +- 2b. For the users for which the user consent is granted, the DCCF subscribes to notifications of changes of the user consent by invoking the Nudm\_SDM\_Subscribe service operation by sending an HTTP POST request targeting the resource "SdmSubscriptions" at the UDM as described in clause 5.2.2.3 of 3GPP TS 29.503 [22]. +- 3b. The UDM responds to the Nudm\_SDM\_Subscribe service operation. If the request is accepted, the UDM responds with "201 Created" status code. +4. The DCCF determines the NF type(s) and/or OAM to retrieve the data based on the Service Operation requested in step 1. If the NF instance or NF Set ID is not provided by the data consumer. The DCCF determines the NF instances that can provide data as described in TS 23.288 [2] clause 5A.2 and clause 6.2.2.2. If the consumer requested storage of data in an ADRF but the ADRF ID is not provided by the data consumer, or the collected data is to be stored in an ADRF according to configuration on the DCCF, the DCCF selects an ADRF to store the collected data. + +The DCCF keeps track of the data actively being collected from the Data Sources it is coordinating. The NWDAF or ADRF may register the data collection profile (including the data collection related Service Operation, Analytics/Data Specification, NWDAF ID or ADRF ID) with the DCCF. The DCCF may then determine whether certain historical data may be available in the NWDAF or ADRF based on the data collection profile and the request time window. + +If the historical data handling is not applicable or not supported, the DCCF shall proceed with step 5a and skip step 5b, step 6b, step 7b, step 5c, step 6c, and step 7c. + +If the historical data is available in an ADRF, the DCCF shall proceed with step 5a and step 5b, and skip step 5c, step 6c, and step 7c. + +If the historical data is available in an NWDAF, the DCCF shall proceed with step 5a and step 5c, and skip step 5b, step 6b, and step 7b. + +- 5a. The DCCF shall determine whether the data requested in step 1 are already being collected. + +If the data requested are already being collected by a data consumer, the DCCF adds the data consumer to the list of data consumers that are subscribed for these data. + +If the DCCF determines that no subscriptions need to be created or modified (e.g. because all the data can be made available either via pre-existing subscriptions or because of the historical data handling) then step 6a and step 7a are skipped. + +- 6a. If the data requested in step 1 are not yet available, the DCCF shall invoke the Nnf\_EventExposure\_Subscribe service operation by sending an HTTP POST request message request to the NF targeting the resource representing event exposure subscriptions to subscribe to a new event exposure subscription, e.g. as described in clause 5.5.2.2 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.2 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.3 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.2 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.2 of 3GPP TS 29.517 [12] for the AF. + +Otherwise, if the requested data subscribed in step 1 partially matches data that is already being collected by the DCCF from an NF, and a modification of this subscription to the NF would satisfy both the existing data subscriptions as well as the newly requested data, the DCCF shall send a request to the individual event exposure subscription resource to update an existing event exposure subscription, e.g. as described in clause 5.5.2.5 of + +3GPP TS 29.503 [22] for the UDM, clause 5.3.2.2.3 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.3.3 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.2.3 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.2.3 of 3GPP TS 29.517 [12] for the AF. + +- 7a. The NF responds to the Nnf\_EventExposure\_Subscribe service operation. + +Upon receipt of an HTTP POST request, if the subscription is accepted to be created, the NF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +Upon receipt of an HTTP PUT request, if the subscription is accepted to be updated, the NF responds to the DCCF with "200 OK" or "204 No Content" status code. + +- 5b. If the historical data handling is applicable, and the DCCF determines to retrieve data from the ADRF, the DCCF shall determine which ADRF instances might provide the data. + +- 6b. In order to retrieve the historical data from the ADRF, the DCCF shall invoke the Nadrf\_DataManagement\_RetrievalSubscribe service operation by sending an HTTP POST request message targeting the resource "ADRF Data Retrieval Subscriptions" as described in clause 4.2.2.6 of 3GPP TS 29.575 [16]. + +- 7b. The ADRF responds to the Nadrf\_DataManagement\_RetrievalSubscribe service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the ADRF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +- 5c. If the historical data handling is applicable, and the DCCF determines to retrieve data from the NWDAF, the DCCF shall determine which NWDAF instances might provide the requested data. + +- 6c. In order to retrieve the historical data from the NWDAF, the DCCF shall invoke the Nnwdaf\_DataManagement\_Subscribe service operation by sending an HTTP POST request message targeting the resource "NWDAF Data Management Subscriptions", as described in clause 4.4.2.2 of 3GPP TS 29.520 [5]. + +- 7c. The NWDAF responds to the Nnwdaf\_DataManagement\_Subscribe service operation. + +Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +8. The DCCF responds to the Ndccf\_DataManagement\_Subscribe service operation with HTTP "204 No Content" status code. + +- 9a. When the data are available, the NF invokes the Nnf\_EventExposure\_Notify service operation by sending an HTTP POST request message to notify the data events to the DCCF, e.g. as described in clause 5.5.2.4 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.4 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.2 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.4 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.4 of 3GPP TS 29.517 [12] for the AF. + +- 10a. The DCCF responds to the Nnf\_EventExposure\_Notify service operation with HTTP "204 No Content" status code. + +- 9b. When the historical data are available in the ADRF, the ADRF shall invoke the Nadrf\_DataManagement\_RetrievalNotify service operation by sending an HTTP POST request message to notify the historical data or Fetch Instructions to the DCCF as described in clause 4.2.2.8 of 3GPP TS 29.575 [16]. + +- 10b. The DCCF responds to the Nadrf\_DataManagement\_RetrievalNotify service operation with HTTP "204 No Content" status code. + +- 9c. When the historical data are available in the NWDAF, the NWDAF shall invoke the Nnwdaf\_DataManagement\_Notify service operation by sending an HTTP POST request message to notify the historical data to the DCCF as described in clause 4.4.2.4 of 3GPP TS 29.520 [5]. + +- 10c. The DCCF responds to the Nnwdaf\_DataManagement\_Notify service operation with HTTP "204 No Content" status code. + +11. If the DCCF is configured to deliver the data itself (and not via the MFAF), the DCCF invokes the Ndccf\_DataManagement\_Notify service operation by sending HTTP POST request message(s) to send the data to all notification endpoints indicated in step 1. Data sent to notification endpoints may be processed and formatted by the DCCF, so they conform to delivery requirements for each NF service consumer or notification endpoint. +- NOTE: According to Formatting Instructions provided by the NF service consumer, multiple notifications from a NF can be combined in a single Ndccf\_DataManagement\_Notify so that many notifications from an NF result in fewer notifications (or one notification) to the Data Consumer. Alternatively, a notification can instruct the data notification endpoint to fetch the data from the DCCF. +12. The NF service consumer responds to the Ndccf\_DataManagement\_Notify service operation with HTTP "204 No Content" status code. +13. The Data Consumer invokes the Ndccf\_DataManagement\_Fetch service operation by sending an HTTP GET request message as described in clause 4.2.2.5 of 3GPP TS 29.574 [15] to fetch the data from the DCCF before an expiry time, if the fetch instruction was previously received via the NdccfDataManagement\_Notify service operation in step 11. +14. The DCCF responds to the Ndccf\_DataManagement\_Fetch service operation with HTTP "200 OK" status code with the message body containing the data received earlier from the data source. +15. When the NF service consumer no longer needs the subscription to the requested data in step 1, it shall invoke the Ndccf\_DataManagement\_Unsubscribe service operation by sending an HTTP DELETE request message as described in clause 4.2.2.3.3 of 3GPP TS 29.574 [15]. The DCCF removes the NF service consumer from the list of NF service consumers that are subscribed for these data. +16. The DCCF responds to the Ndccf\_DataManagement\_Unsubscribe service operation with HTTP "204 No Content" status code, if the NF service consumer is successfully removed from the list of NF service consumers that are subscribed for these data. + - 16a. If the user consent changes and the DCCF has subscribed to UDM to notifications of user consent change for a user, the UDM invokes Nudm\_SDM\_Notification service operation by sending an HTTP POST request as described in clause 5.2.2.5 of 3GPP TS 29.503 [22]. + - 16b. The DCCF responds to the Nudm\_SDM\_Notification service operation with "204 No Content". + - 16c. The DCCF may invoke Nudm\_SDM\_Unsubscribe service operation by sending an HTTP DELETE request as described in clause 5.2.2.4 of 3GPP TS 29.503 [22] to unsubscribe from UDM to be notified of user consent change for each user whose user consent is revoked. + - 16d. If the deletion request is accepted, the UDM responds to the Nudm\_SDM\_Unsubscribe service operation with "204 No Content". +- 17a. If there are no other NF service consumers subscribed to the data or the user consent for a user, i.e. for a SUPI or GPSI, is no longer granted, the DCCF invokes the Nnf\_EventExposure\_Unsubscribe service operation by sending an HTTP DELETE request message to the Data Source, e.g. as described in clause 5.5.2.3 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.3 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.4 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.3 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.3 in 3GPP TS 29.517 [12] for the AF. +- 18a. The Data Source responds to the Nnf\_EventExposure\_Unsubscribe service operation with HTTP "204 No Content" status code, if the data event(s) subscription is successfully removed. +- 17b. If the DCCF determines that no other NF service consumers require the historical data from the ADRF, the DCCF invokes the Nadrf\_DataManagement\_RetrievalUnsubscribe service operation by sending an HTTP DELETE request message to the ADRF as described in clause 4.2.2.7 of 3GPP TS 29.575 [16]. +- 18b. The ADRF responds to the Nadrf\_DataManagement\_RetrievalUnsubscribe service operation with HTTP "204 No Content" status code, if the data retrieval subscription is successfully removed. +- 17c. If DCCF determines that no other NF service consumers require the historical data from the NWDAF, the DCCF invokes the Nnwdaf\_DataManagement\_Unsubscribe service operation by sending an HTTP DELETE request message to the NWDAF as described in clause 4.4.2.3 of 3GPP TS 29.520 [5]. + +- 18c. The NWDAF responds to the Nnwdaf\_DataManagement\_Unsubscribe service operation with HTTP "204 No Content" status code, if the data subscription is successfully removed. + +#### 5.5.3.2 Data Collection via Messaging Framework + +This procedure depicted in Figure 5.5.3.2-1 is used by a data consumer (e.g. NWDAF) to obtain data and be notified of events using the DCCF and a Messaging Framework. The 3GPP DCCF Adaptor (3da) Data Management service and 3GPP Consumer Adaptor (3ca) Data Management service of the Messaging Framework Adaptor Function (MFAF) are used to interact with the Messaging Framework. Whether the data consumer directly contacts the Data Source or goes via the DCCF is based on configuration. + +![Sequence diagram for Ndcf_DataManagement operations. Lifelines: Data Consumer, DCCF, UDM, MFAF, ADRF, NWDAF, Data Source. The diagram shows the interaction for subscribing, fetching, and unsubscribing to data management services.](be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg) + +``` + +sequenceDiagram + participant DC as Data Consumer + participant DCCF + participant UDM + participant MFAF + participant ADRF + participant NWDAF + participant DS as Data Source + + Note left of DC: 6. Determine whether historical data handling is applicable or not + Note left of DC: 7a. Determine whether the requested data is already being collected + Note left of DC: 7b. If historical data handling is applicable, and DCCF determine to retrieve data from ADRF Instance + Note left of DC: 7c. If historical data handling is applicable, and DCCF determine to retrieve analytics data from NWDAF Instance + + Note left of DCCF: Data Fetch + Note left of DCCF: Unsubscribe + + DC->>DCCF: 1. Ndcf_DataManagement_Subscribe request + DCCF->>UDM: 2a. Nudm_SDM_Get request + UDM-->>DCCF: 3a. Nudm_SDM_Get response + DCCF->>UDM: 2b. Nudm_SDM_Subscribe request + UDM-->>DCCF: 3b. Nudm_SDM_Subscribe response + DCCF->>MFAF: 4. Nmfaf_3daDataManagement_Configure request + MFAF-->>DCCF: 5. Nmfaf_3daDataManagement_Configure response + + DCCF-->>DS: 8a. Nnf_EventExposure_Subscribe request + DS-->>DCCF: 9a. Nnf_EventExposure_Subscribe response + + DCCF->>ADRF: 8b. Nadrf_DataManagement_RetrievalSubscribe request + ADRF-->>DCCF: 9b. Nadrf_DataManagement_RetrievalSubscribe response + + DCCF->>NWDAF: 8c. Nnwdaf_DataManagement_Subscribe request + NWDAF-->>DCCF: 9c. Nnwdaf_DataManagement_Subscribe response + + DC->>DCCF: 10. Ndcf_DataManagement_Subscribe response + + MFAF->>ADRF: 11a. Nnf_EventExposure_Notify request + ADRF-->>MFAF: 12a. Nnf_EventExposure_Notify response + MFAF->>ADRF: 11b. Nadrf_DataManagement_RetrievalNotify request + ADRF-->>MFAF: 12b. Nadrf_DataManagement_RetrievalNotify response + MFAF->>NWDAF: 11c. Nnwdaf_DataManagement_Notify request + NWDAF-->>MFAF: 12c. Nnwdaf_DataManagement_Notify response + + MFAF->>DC: 13. Nmfaf_3caDataManagement_Notify request + DC-->>MFAF: 14. Nmfaf_3caDataManagement_Notify response + + Note left of DCCF: Data Fetch + DCCF->>MFAF: 15. Nmfaf_3caDataManagement_Fetch request + MFAF-->>DCCF: 16. Nmfaf_3caDataManagement_Fetch response + + Note left of DCCF: Unsubscribe + DC->>DCCF: 17. Ndcf_DataManagement_Unsubscribe request + DC-->>DCCF: 18. Ndcf_DataManagement_Unsubscribe response + + DCCF->>UDM: 18a. Nudm_SDM_Notify request + UDM-->>DCCF: 18b. Nudm_SDM_Notify response + DCCF->>UDM: 18c. Nudm_SDM_Unsubscribe request + UDM-->>DCCF: 18d. Nudm_SDM_Unsubscribe response + + DCCF-->>DS: 19a. Nnf_EventExposure_Unsubscribe request + DS-->>DCCF: 20a. Nnf_EventExposure_Unsubscribe response + DCCF->>ADRF: 19b. Nadrf_DataManagement_RetrievalUnsubscribe request + ADRF-->>DCCF: 20b. Nadrf_DataManagement_RetrievalUnsubscribe response + DCCF->>NWDAF: 19c. Nnwdaf_DataManagement_Unsubscribe request + NWDAF-->>DCCF: 20c. Nnwdaf_DataManagement_Unsubscribe response + + DCCF->>MFAF: 19d. Nmfaf_3daDataManagement_Deconfigure request + MFAF-->>DCCF: 20d. Nmfaf_3daDataManagement_Deconfigure response + +``` + +Sequence diagram for Ndcf\_DataManagement operations. Lifelines: Data Consumer, DCCF, UDM, MFAF, ADRF, NWDAF, Data Source. The diagram shows the interaction for subscribing, fetching, and unsubscribing to data management services. + +###### **Figure 5.5.3.2-1: Data Collection via DCCF and via Messaging Framework** + +1. In order to subscribe to notification(s) of events exposure via the DCCF based on local configuration, the Data Consumer invokes the Ndcf\_DataManagement\_Subscribe service operation by sending an HTTP POST request message targeting the resource "DCCF Data Subscriptions", as described in clause 4.2.2.2.4 of 3GPP TS 29.574 [15]. +- 2a. If data is to be collected for a user, i.e. for a SUPI or GPSI, the user consent has not been checked by the data consumer, and local policy and regulations require to check user consent, the DCCF invokes Nudm\_SDM\_Get service operation by sending an HTTP GET request message targeting the resource "AccessAndMobilitySubscriptionData" at the UDM to request the data type "User consent" as described in clause 5.2.2.2 of 3GPP TS 29.503 [22]. Otherwise the procedure continues with step 4. +- 3a. The UDM responds to the Nudm\_SDM\_Get service operation. If the request is accepted, the response includes the requested data with "200 OK" status code. In subsequent steps, the DCCF excludes the SUPI or GPSI from requests to collect data for users for whom the user consent is not granted. +- 2b. For the users for which the user consent is granted, the DCCF subscribes to notifications of changes of the user consent by invoking the Nudm\_SDM\_Subscribe service operation by sending an HTTP POST request message targeting the resource "SdmSubscriptions" at the UDM as described in clause 5.2.2.3 of 3GPP TS 29.503 [22]. +- 3b. The UDM responds to the Nudm\_SDM\_Subscribe service operation. If the request is accepted, the UDM responds with "201 Created" status code. +4. If the DCCF is configured to perform data delivery via the MFAF, in order to create configuration of mapping data in the MFAF, the DCCF shall invoke the Nmfa\_3daDataManagement\_Configure service operation by sending an HTTP POST request message targeting the resource "MFAF Configurations", as described in clause 4.2.2.2.2 of 3GPP TS 29.576 [17]. + +In order to update configuration of mapping data in the MFAF, the DCCF shall invoke the Nmfa\_3daDataManagement\_Configure service operation by sending an HTTP PUT request message targeting the resource "Individual MFAF Configuration", as described in clause 4.2.2.2.3 of 3GPP TS 29.576 [17]. + +5. The MFAF responds to the Nmfa\_3daDataManagement\_Configure service operation. + +Upon receipt of the HTTP POST request message, if the configuration is accepted to be created, the MFAF responds to the DCCF with "201 Created" status code, and the URI of the created configuration is included in the Location header field. + +Upon receipt of the HTTP PUT request message, if the configuration is accepted to be updated, the MFAF responds to the DCCF with "200 OK" or "204 No Content" status code. + +6. The DCCF determines the NF type(s) and/or OAM to retrieve the data based on the Service Operation requested in step 1. If the NF instance or NF Set ID is not provided by the data consumer, the DCCF determines the NF instances that can provide data as described in TS 23.288 [2] clause 5A.2 and clause 6.2.2.2. If the consumer requested storage of data in an ADRF but the ADRF ID is not provided by the data consumer, or the collected data is to be stored in an ADRF according to configuration on the DCCF, the DCCF selects an ADRF to store the collected data. + +The DCCF keeps track of the data actively being collected from the Data Sources it is coordinating. The NWDAF or ADRF may register the data collection profile (including the data collection related Service Operation, Analytics/Data Specification, NWDAF ID or ADRF ID) with the DCCF. The DCCF may then determine whether certain historical data may be available in the NWDAF or ADRF based on the data collection profile and the request time window. + +If the historical data handling is not applicable or not supported, the DCCF shall proceed with step 7a, and skip step 7b, step 8b, step 9b, step 7c, step 8c, and step 9c. + +If the historical data is available in an ADRF, the DCCF shall proceed with step 7a and step 7b, and skip step 7c, step 8c, and step 9c. + +If the historical data is available in an NWDAF, the DCCF shall proceed with step 7a and step 7c, and skip step 7b, step 8b, and step 9b. + +- 7a. The DCCF shall determine whether the data requested in step 1 are already being collected. + +If the data requested are already being collected by a data consumer, the DCCF adds the data consumer to the list of data consumers that are subscribed for these data. + +If the DCCF determines that no subscriptions need to be created or modified (e.g. because all the data can be made available either via pre-existing subscriptions or because of the historical data handling) then step 8a and step 9a are skipped. + +- 8a. If data requested in step 1 are not available yet, the DCCF shall invoke the Nnf\_EventExposure\_Subscribe service operation by sending an HTTP POST request message to the NF targeting the resource representing event exposure subscriptions to subscribe to a new event exposure subscription, e.g. as described in clause 5.5.2.2 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.2 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.3 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.2 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.2 of 3GPP TS 29.517 [12] for the AF. + +Otherwise, if the requested data subscribed in step 1 partially matches data that is already being collected by the DCCF from an NF, and a modification of this subscription to the NF would satisfy both the existing data subscriptions as well as the newly requested data, the DCCF shall send a request to the individual event exposure subscription resource to update an existing event exposure subscription, e.g. as described in clause 5.5.2.5 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.2.3 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.3.3 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.2.3 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.2.3 of 3GPP TS 29.517 [12] for the AF. + +- 9a. The NF responds to the Nnf\_EventExposure\_Subscribe service operation. + +Upon receipt of the HTTP POST request message, if the subscription is accepted to be created, the NF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +Upon receipt of the HTTP PUT request message, if the subscription is accepted to be updated, the NF responds to the DCCF with "200 OK" or "204 No Content" status code. + +- 7b. If the historical data handling is applicable, and the DCCF determines to retrieve data from the ADRF, the DCCF shall determine which ADRF instances might provide the data. + +- 8b. In order to retrieve the historical data from the ADRF, the DCCF shall invoke the Nadrf\_DataManagement\_RetrievalSubscribe service operation by sending an HTTP POST request message targeting the resource "ADRF Data Retrieval Subscriptions", as described in clause 4.2.2.6 of 3GPP TS 29.575 [16]. + +- 9b. The ADRF responds to the Nadrf\_DataManagement\_RetrievalSubscribe service operation. + +Upon receipt of the HTTP POST request message, if the subscription is accepted to be created, the ADRF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +- 7c. If the historical data handling is applicable, and the DCCF determines to retrieve data from the NWDAF, the DCCF shall determine which NWDAF instances might provide the data. + +- 8c. In order to retrieve the historical data from the NWDAF, the DCCF shall invoke the Nnwdaf\_DataManagement\_Subscribe service operation by sending an HTTP POST request message targeting the resource "NWDAF Data Management Subscriptions", as described in clause 4.4.2.2 of 3GPP TS 29.520 [5]. + +- 9c. The NWDAF responds to the Nnwdaf\_DataManagement\_Subscribe service operation. + +Upon receipt of the HTTP POST request message, if the subscription is accepted to be created, the NWDAF responds to the DCCF with "201 Created" status code, and the URI of the created subscription is included in the Location header field. + +10. The DCCF responds to the Ndccf\_DataManagement\_Subscribe service operation with HTTP "204 No Content" status code. + +- 11a. When the data are available, the NF invokes the Nnf\_EventExposure\_Notify service operation by sending an HTTP POST request message to notify the data events to the MFAF, e.g. as described in clause 5.5.2.4 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.4 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.2 of + +3GPP TS 29.508 [6] for the SMF, clause 4.2.2.4 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.4 of 3GPP TS 29.517 [12] for the AF. + +12a. The MFAF responds to the Nnf\_EventExposure\_Notify service operation with HTTP "204 No Content" status code. + +11b. When the historical data are available in the ADRF, the ADRF shall invoke the Nadrdf\_DataManagement\_RetrievalNotify service operation by sending an HTTP POST request message to notify the historical data or Fetch Instructions to the MFAF as described in clause 4.2.2.8 of 3GPP TS 29.575 [16]. + +12b. The MFAF responds to the Nadrdf\_DataManagement\_RetrievalNotify service operation with HTTP "204 No Content" status code. + +11c. When the historical data are available in the NWDAF, the NWDAF shall invoke the Nnwddf\_DataManagement\_Notify service operation by sending an HTTP POST request message to notify the historical data to the MFAF as described in clause 4.4.2.4 of 3GPP TS 29.520 [5]. + +12c. The MFAF responds to the Nnwddf\_DataManagement\_Notify service operation with HTTP "204 No Content" status code. + +13. The MFAF invokes the Nmfaf\_3caDataManagement\_Notify service operation by sending HTTP POST request message(s) to send the data to all notification endpoints indicated in step 1. Data sent to notification endpoints may be processed and formatted by the MFAF so they conform to delivery requirements for each NF service consumer or notification endpoint. + +NOTE: According to Formatting Instructions provided by the NF service consumer, multiple notifications from a NF can be combined in a single Nmfaf\_3caDataManagement\_Notify so that many notifications from an NF results in fewer notifications (or one notification) to the Data Consumer. Alternatively, a notification can instruct the data notification endpoint to fetch the data from the MFAF. + +14. The NF service consumer responds to the Nmfaf\_3caDataManagement\_Notify service operation with HTTP "204 No Content" status code. + +15. The Data Consumer invokes the Nmfaf\_3caDataManagement\_Fetch service operation by sending an HTTP GET request message as described in clause 4.2.2.5 of 3GPP TS 29.574 [15] to fetch the data from the DCCF before an expiry time, if the fetch instruction was received in Nmfaf\_3caDataManagement\_Notify service operation in step 13. + +16. The MFAF responds to the Nmfaf\_3caDataManagement\_Fetch service operation with HTTP "200 OK" status code with the message body containing the NmfafResourceRecord data structure. + +17. When the NF service consumer no longer needs the subscription to the requested data in step 1, it shall invoke the Ndccf\_DataManagement\_Unsubscribe service operation by sending an HTTP DELETE request message as described in clause 4.2.2.3.3 of 3GPP TS 29.574 [15]. The DCCF removes the NF service consumer from the list of NF service consumers that are subscribed for these data. + +18. The DCCF responds to the Ndccf\_DataManagement\_Unsubscribe service operation with HTTP "204 No Content" status code, if the NF service consumer is successfully removed from the list of NF service consumers that are subscribed for these data. + +18a. If the user consent changes and the DCCF has subscribed to UDM to notifications of user consent change for a user, the UDM invokes Nudm\_SDM\_Notification service operation by sending an HTTP POST request as described in clause 5.2.2.5 of 3GPP TS 29.503 [22]. + +18b. The DCCF responds to the Nudm\_SDM\_Notification service operation with "204 No Content". + +18c. The DCCF may invoke Nudm\_SDM\_Unsubscribe service operation by sending an HTTP DELETE request as described in clause 5.2.2.4 of 3GPP TS 29.503 [22] to unsubscribe from UDM to be notified of user consent change for each user whose user consent is revoked. + +18d. If the deletion request is accepted, the UDM responds to the Nudm\_SDM\_Unsubscribe service operation with "204 No Content". + +- 19a. If there are no other NF service consumers subscribed to the data or the user consent for a user, i.e. for a SUPI or GPSI, is no longer granted, the DCCF invokes the Nnf\_EventExposure\_Unsubscribe service operation by sending an HTTP DELETE request message to the Data Source, e.g. as described in clause 5.5.2.3 of 3GPP TS 29.503 [22] for the UDM, clause 5.3.2.3 of 3GPP TS 29.518 [18] for the AMF, clause 4.2.4 of 3GPP TS 29.508 [6] for the SMF, clause 4.2.2.3 of 3GPP TS 29.591 [11] for the NEF, or clause 4.2.3 in 3GPP TS 29.517 [12] for the AF. +- 20a. The Data Source responds to the Nnf\_EventExposure\_Unsubscribe service operation with HTTP "204 No Content" status code, if the data event(s) subscription is successfully removed. +- 19b. If DCCF determines that no other NF service consumers requiring the historical data from the ADRF, the DCCF may invoke the Nadrf\_DataManagement\_RetrievalUnsubscribe service operation by sending an HTTP DELETE request message to the ADRF as described in clause 4.2.2.7 of 3GPP TS 29.575 [16]. +- 20b. The ADRF responds to the Nadrf\_DataManagement\_RetrievalUnsubscribe service operation with HTTP "204 No Content" status code, upon the data retrieval subscription is removed. +- 19c. If DCCF determines that no other NF service consumers require the historical data from the NWDAF, the DCCF may invoke the Nnwdaf\_DataManagement\_Unsubscribe service operation by sending an HTTP DELETE request message to the NWDAF as described in clause 4.4.2.3 of 3GPP TS 29.520 [5]. +- 20c. The NWDAF responds to the Nnwdaf\_DataManagement\_Unsubscribe service operation with HTTP "204 No Content" status code, upon the data subscription is removed. +- 19d. When the DCCF determines that an NF service consumer mapping has to be removed from MFAF, the DCCF invokes the Nmfaf\_3daDataManagement\_Deconfigure service operation by sending an HTTP DELETE request message to the MFAF as described in clause 4.2.2.3 of 3GPP TS 29.576 [17]. +- 20d. The MFAF responds to the Nmfaf\_3daDataManagement\_Deconfigure service operation with HTTP "204 No Content" status code, if the individual resource linked to the delete request is successfully removed. + +### 5.5.4 Procedure for Data Collection in Roaming Case + +#### 5.5.4.1 Data Collection by H-RE-NWDAF from V-RE-NWDAF for outbound roaming users + +The procedure depicted in Figure 5.5.4.1-1 is used by the H-RE-NWDAF as service consumer to subscribe/unsubscribe to notifications about data event exposure from the VPLMN for outbound roaming users. + +![Sequence diagram illustrating data collection by H-RE-NWDAF from V-RE-NWDAF for outbound roaming users. The diagram shows interactions between HPLMN (H-RE-NWDAF) and VPLMN (V-RE-NWDAF).](40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg) + +``` + +sequenceDiagram + participant H-RE-NWDAF as H-RE-NWDAF + participant V-RE-NWDAF as V-RE-NWDAF + Note left of H-RE-NWDAF: 1. Check user consent + Note left of H-RE-NWDAF: 2. Discover V-RE-NWDAF + H-RE-NWDAF->>V-RE-NWDAF: 3. Nnwdaf_RoamingData_Subscribe request / Nnwdaf_RoamingData_Unsubscribe request + Note right of V-RE-NWDAF: 4a. Authorize request based on operator policy, possibly dependent on HPLMN + V-RE-NWDAF-->>H-RE-NWDAF: 4b. Nnwdaf_RoamingData_Subscribe response / Nnwdaf_RoamingData_Unsubscribe response + Note right of V-RE-NWDAF: 5. collect related data + Note right of V-RE-NWDAF: 6. Apply possible policy to restrict data, possibly dependent on HPLMN + Note right of V-RE-NWDAF: 7a. Nnwdaf_RoamingData_Notify request + Note right of V-RE-NWDAF: 7b. Nnwdaf_RoamingData_Notify response + V-RE-NWDAF-->>H-RE-NWDAF: 7a. Nnwdaf_RoamingData_Notify request + H-RE-NWDAF-->>V-RE-NWDAF: 7b. Nnwdaf_RoamingData_Notify response + +``` + +Sequence diagram illustrating data collection by H-RE-NWDAF from V-RE-NWDAF for outbound roaming users. The diagram shows interactions between HPLMN (H-RE-NWDAF) and VPLMN (V-RE-NWDAF). + +**Figure 5.5.4.1-1: data collection by H-RE-NWDAF from V-RE-NWDAF for outbound roaming users** + +1. For subscription to collected data related to the outbound roaming UE(s), the H-RE-NWDAF checks the user consent of related users. +2. The H-RE-NWDAF of HPLMN discovers V-RE-NWDAF of VPLMN that supports the Nnwdaf\_RoamingData service using the NRF as specified for roaming case in clause 5.8.2.3. + +NOTE 1: The access to the Nnf\_EventExposure services is expected to be restricted to NF service consumers within the same PLMN to prevent bypassing checks based on user consent and operator policy. + +3. The H-RE-NWDAF subscribes/unsubscribes to notifications about data event exposure by invoking the Nnwdaf\_RoamingData\_Subscribe / Nnwdaf\_RoamingData\_Unsubscribe service operation message as described in clause 4.8.2.2 and clause 4.8.2.3 of 3GPP TS 29.520 [5]. +- 4a. The V-RE-NWDAF checks whether the HPLMN is authorised to request the input data based on VPLMN operator policies (that may depend on the HPLMN and may indicate permissible or restricted input data and related parameters). +- 4b. The V-RE-NWDAF responds to the H-RE-NWDAF with Nnwdaf\_RoamingData\_Subscribe / Nnwdaf\_RoamingData\_Unsubscribe service operation message as described in clause 4.8.2.2 and clause 4.8.2.3 of 3GPP TS 29.520 [5]. +5. The V-RE-NWDAF triggers new data collection from NF(s) as described in clause 5.5.1 or clause 5.5.1. +6. The V-RE-NWDAF may restrict the exposed input data based on VPLMN operator policies (that may depend on the HPLMN) and may store them for auditing. +- 7a-7b. The V-RE-NWDAF notifies data to the H-RE-NWDAF as described in clause 4.8.2.4 of 3GPP TS 29.520 [5]. + +NOTE 2: For details of Nnwdaf\_RoamingData\_Subscribe/Unsubscribe/Notify service operations refer to 3GPP TS 29.520 [5]. + +#### 5.5.4.2 Data Collection by V-RE-NWDAF from H-RE-NWDAF for inbound roaming users + +The procedure depicted in Figure 5.5.4.2-1 is used by the V-RE-NWDAF as service consumer to subscribe/unsubscribe to notifications about data event exposure from the HPLMN for inbound roaming users. + +![Sequence diagram showing data collection by V-RE-NWDAF from H-RE-NWDAF for inbound roaming users. The diagram is split into two vertical lanes: VPLMN (left) and HPLMN (right). In the VPLMN lane, there is a box for 'V-RE-NWDAF' and a box for '1. Discover H-RE-NWDAF'. In the HPLMN lane, there is a box for 'H-RE-NWDAF'. The sequence of messages is: 1. A solid line from '1. Discover H-RE-NWDAF' to 'H-RE-NWDAF'. 2. A solid line from 'V-RE-NWDAF' to 'H-RE-NWDAF' labeled '2. Nnwdaf_RoamingData_Subscribe request/ Nnwdaf_RoamingData_Unsubscribe request'. 3. A solid line from 'H-RE-NWDAF' to a box '3a. Authorize request, depending on user consent and operator policy'. 3b. A solid line from this box to 'V-RE-NWDAF' labeled '3b. Nnwdaf_RoamingData_Subscribe response/ Nnwdaf_RoamingData_Unsubscribe response'. 4. A dashed line from 'H-RE-NWDAF' to a box '4. Collect related data'. 5. A dashed line from '4. Collect related data' to a box '5. Apply possible policy to restrict data, possibly dependent on VPLMN'. 6a. A dashed line from 'H-RE-NWDAF' to 'V-RE-NWDAF' labeled '6a. Nnwdaf_RoamingData_Notify request'. 6b. A dashed line from 'V-RE-NWDAF' to 'H-RE-NWDAF' labeled '6b. Nnwdaf_RoamingData_Notify response'.](df1966d80c74bc127f159a48f38b13ee_img.jpg) + +Sequence diagram showing data collection by V-RE-NWDAF from H-RE-NWDAF for inbound roaming users. The diagram is split into two vertical lanes: VPLMN (left) and HPLMN (right). In the VPLMN lane, there is a box for 'V-RE-NWDAF' and a box for '1. Discover H-RE-NWDAF'. In the HPLMN lane, there is a box for 'H-RE-NWDAF'. The sequence of messages is: 1. A solid line from '1. Discover H-RE-NWDAF' to 'H-RE-NWDAF'. 2. A solid line from 'V-RE-NWDAF' to 'H-RE-NWDAF' labeled '2. Nnwdaf\_RoamingData\_Subscribe request/ Nnwdaf\_RoamingData\_Unsubscribe request'. 3. A solid line from 'H-RE-NWDAF' to a box '3a. Authorize request, depending on user consent and operator policy'. 3b. A solid line from this box to 'V-RE-NWDAF' labeled '3b. Nnwdaf\_RoamingData\_Subscribe response/ Nnwdaf\_RoamingData\_Unsubscribe response'. 4. A dashed line from 'H-RE-NWDAF' to a box '4. Collect related data'. 5. A dashed line from '4. Collect related data' to a box '5. Apply possible policy to restrict data, possibly dependent on VPLMN'. 6a. A dashed line from 'H-RE-NWDAF' to 'V-RE-NWDAF' labeled '6a. Nnwdaf\_RoamingData\_Notify request'. 6b. A dashed line from 'V-RE-NWDAF' to 'H-RE-NWDAF' labeled '6b. Nnwdaf\_RoamingData\_Notify response'. + +**Figure 5.5.4.2-1: Data Collection by V-RE-NWDAF from H-RE-NWDAF for inbound roaming users** + +1. The V-RE-NWDAF of VPLMN discovers H-RE-NWDAF of HPLMN that supports the Nnwdaf\_RoamingData service using the NRF as specified in clause 5.8.2.3. + +NOTE 1: The access to the Nnf\_EventExposure services is expected to be restricted to NF service consumers within the same PLMN to prevent bypassing checks based on user consent and operator policy. + +2. The V-RE-NWDAF subscribes/unsubscribes to data event exposure by invoking Nnwdaf\_RoamingData\_Subscribe / Nnwdaf\_RoamingData\_Unsubscribe service operation message as described in clause 4.8.2.2 and clause 4.8.2.3 of 3GPP TS 29.520 [5]. +- 3a. The H-RE-NWDAF checks if the VPLMN is authorised to subscribe to the indicated input data based on HPLMN operator policies (that may depend on the VPLMN and may indicate permissible or restricted input data and related parameters) and user consent of related users. +- 3b. The H-RE-NWDAF responds to the V-RE-NWDAF with Nnwdaf\_RoamingData\_Subscribe / Nnwdaf\_RoamingData\_Unsubscribe service operation message as described in clause 4.8.2.2 and clause 4.8.2.3 of 3GPP TS 29.520 [5]. +4. The H-RE-NWDAF triggers new data collection if needed and monitors the requested input data, using procedures as described in clauses 6.2.1 to 6.2.8. +5. The H-RE-NWDAF may restrict the exposed input data based on HPLMN operator policies (that may depend on the VPLMN) and may store them for auditing. + +6a-6b. The H-RE-NWDAF notifies data event to the V-RE-NWDAF as described in clause 4.8.2.4 of 3GPP TS 29.520 [5]. + +NOTE 2: For details of Nnwdaf\_RoamingData\_Subscribe/Unsubscribe/Notify service operations refer to 3GPP TS 29.520 [5]. + +## 5.6 ML Model provisioning procedures + +### 5.6.1 General + +The ML Model provisioning procedures allow the NF service consumers (i.e. NWDAF (MTLF+AnLF), NWDAF (AnLF)) to obtain the ML model information on the related Analytics from another NWDAF (i.e. an NWDAF containing MTLF). + +### 5.6.2 ML Model Subscribe/Unsubscribe/Notify procedure + +The procedure is used by an NF service consumer to subscribe to/unsubscribe from the ML model information on the related Analytics on NWDAF containing MTLF, and also used by the NWDAF containing MTLF to notify the ML model information to the NF service consumer if it subscribed to the ML model information previously. + +![Sequence diagram of the ML Model Subscribe/Unsubscribe/Notify procedure between an NF Service Consumer and an NWDAF containing MTLF.](e3eebf9854831ba50eca8b26c468f65e_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant NWDAF containing MTLF + Note right of NF Service Consumer: In order to subscribe to ML model information, the NF service consumer invokes Nnwdaf_MLModelProvision_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF ML Model Provision Subscriptions", as described in clause 4.5.2.2 of 3GPP TS 29.520 [5]. See 3GPP TS 29.520 [5] clause 5.4 for details. + Note right of NF Service Consumer: In order to modify the existing subscription, the NF service consumer invokes Nnwdaf_MLModelProvision_Subscribe service operation by sending an HTTP PUT request with Resource URI of the resource "Individual NWDAF ML Model Provision Subscription". + Note right of NWDAF containing MTLF: Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF containing MTLF responds to the NF service consumer with "201 Created", and the URI of the created subscription is included in the Location header field. + Note right of NWDAF containing MTLF: Upon receipt of the HTTP PUT request, if the subscription is accepted to be updated, the NWDAF containing MTLF responds to the NF service consumer an HTTP "200 OK" with a response body containing a representation of the updated subscription or "204 No Content". + NF Service Consumer->>NWDAF containing MTLF: 1. Nnwdaf_MLModelProvision_Subscribe request + NWDAF containing MTLF-->>NF Service Consumer: 2. Nnwdaf_MLModelProvision_Subscribe response + Note right of NWDAF containing MTLF: Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF containing MTLF notifies the NF service consumer by sending an HTTP NOTIFY request targeting the resource "NWDAF ML Model Provision Subscriptions", as described in clause 4.5.2.2 of 3GPP TS 29.520 [5]. See 3GPP TS 29.520 [5] clause 5.4 for details. + Note right of NWDAF containing MTLF: Upon receipt of the HTTP PUT request, if the subscription is accepted to be updated, the NWDAF containing MTLF notifies the NF service consumer an HTTP NOTIFY request with Resource URI of the resource "Individual NWDAF ML Model Provision Subscription". + NWDAF containing MTLF-->>NF Service Consumer: 3. Nnwdaf_MLModelProvision_Notify request + NF Service Consumer-->>NWDAF containing MTLF: 4. Nnwdaf_MLModelProvision_Notify response + Note right of NF Service Consumer: In order to unsubscribe from ML model information, the NF service consumer invokes Nnwdaf_MLModelProvision_Unsubscribe service operation by sending an HTTP DELETE request targeting the resource "Individual NWDAF ML Model Provision Subscription", as described in clause 4.5.2.2 of 3GPP TS 29.520 [5]. See 3GPP TS 29.520 [5] clause 5.4 for details. + NF Service Consumer->>NWDAF containing MTLF: 5. Nnwdaf_MLModelProvision_Unsubscribe request + NWDAF containing MTLF-->>NF Service Consumer: 6. Nnwdaf_MLModelProvision_Unsubscribe response +``` + +Sequence diagram of the ML Model Subscribe/Unsubscribe/Notify procedure between an NF Service Consumer and an NWDAF containing MTLF. + +Figure 5.6.2-1: ML Model Subscribe/Unsubscribe/Notify procedure + +1. In order to subscribe to ML model information, the NF service consumer invokes Nnwdaf\_MLModelProvision\_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF ML Model Provision Subscriptions", as described in clause 4.5.2.2 of 3GPP TS 29.520 [5]. See 3GPP TS 29.520 [5] clause 5.4 for details. + +In order to modify the existing subscription, the NF service consumer invokes Nnwdaf\_MLModelProvision\_Subscribe service operation by sending an HTTP PUT request with Resource URI of the resource "Individual NWDAF ML Model Provision Subscription". + +2. The NWDAF containing MTLF responds to the Nnwdaf\_MLModelProvision\_Subscribe service operation. Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF containing MTLF responds to the NF service consumer with "201 Created", and the URI of the created subscription is included in the Location header field. + +Upon receipt of the HTTP PUT request, if the subscription is accepted to be updated, the NWDAF containing MTLF responds to the NF service consumer an HTTP "200 OK" with a response body containing a representation of the updated subscription or "204 No Content". + +3. If the NWDAF containing MTLF determines that the subscribed ML model information is available, the NWDAF containing MTLF invokes Nnwdaf\_MLModelProvision\_Notify service operation to report the ML model information by sending an HTTP POST request to the NF service consumer identified by the notification URI received during the creation/modification of the subscriptions, as described in clause 4.5.2.4 of 3GPP TS 29.520 [5]. +4. The NF service consumer responds to the NWDAF containing MTLF with an HTTP "204 No Content" message. +5. In order to unsubscribe from the notification(s) of the ML model information, the NF service consumer invokes Nnwdaf\_MLModelProvision\_Unsubscribe service operation by sending an HTTP DELETE request, which targets the resource "Individual NWDAF ML Model Provision Subscription", to the NWDAF containing MTLF. +6. If the request is accepted, the NWDAF containing MTLF deletes the subscription and responds to the NF service consumer with an HTTP "204 No Content" message. + +NOTE: For details of Nnwdaf\_MLModelProvision\_Subscribe/Unsubscribe/Notify service operations refer to 3GPP TS 29.520 [5]. + +## 5.6A ML Model Training procedures + +### 5.6A.1 General + +The ML Model training procedures allow the NF service consumers (i.e. NWDAF containing MTLF) to subscribe to another NWDAF (i.e. an NWDAF containing MTLF) for a trained ML model and/or the information about ML model training based on the ML model file or ML Model information provided by the consumer and the data for the training. + +### 5.6A.2 ML Model Training Subscribe/Unsubscribe/Notify procedure + +The procedure is used by an NF service consumer to subscribe to/unsubscribe from the ML model training, and also used by the NWDAF containing MTLF to notify the ML model and/or ML model training information to the NF service consumer if it subscribed to the ML model and/or ML model training information previously. + +![Sequence diagram of ML Model Training Subscribe/Unsubscribe/Notify procedure](dc37a040cf9e2add7488c7c37cbf3687_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant NWDAF containing MTLF + Note left of NF Service Consumer: NF Service Consumer + Note right of NWDAF containing MTLF: NWDAF containing MTLF + NF Service Consumer->>NWDAF containing MTLF: 1. Nnwdaf_MLModelTraining_Subscribe request + NWDAF containing MTLF-->>NF Service Consumer: 2. Nnwdaf_MLModelTraining_Subscribe response + Note left of NF Service Consumer: + NWDAF containing MTLF-->>NF Service Consumer: 3. Nnwdaf_MLModelTraining_Notify request + NF Service Consumer-->>NWDAF containing MTLF: 4. Nnwdaf_MLModelTraining_Notify response + Note left of NF Service Consumer: + NF Service Consumer->>NWDAF containing MTLF: 5. Nnwdaf_MLModelTraining_Unsubscribe request + NWDAF containing MTLF-->>NF Service Consumer: 6. Nnwdaf_MLModelTraining_Unsubscribe response +``` + +The diagram illustrates the interaction between an NF Service Consumer and an NWDAF containing MTLF. It consists of six numbered steps: 1. Nnwdaf\_MLModelTraining\_Subscribe request (solid arrow from consumer to NWDAF), 2. Nnwdaf\_MLModelTraining\_Subscribe response (dashed arrow from NWDAF to consumer), 3. Nnwdaf\_MLModelTraining\_Notify request (solid arrow from NWDAF to consumer), 4. Nnwdaf\_MLModelTraining\_Notify response (dashed arrow from consumer to NWDAF), 5. Nnwdaf\_MLModelTraining\_Unsubscribe request (solid arrow from consumer to NWDAF), and 6. Nnwdaf\_MLModelTraining\_Unsubscribe response (dashed arrow from NWDAF to consumer). The consumer initiates the sequence with a subscribe request and ends it with an unsubscribe request. The NWDAF responds to these requests and sends a notify request when available. + +Sequence diagram of ML Model Training Subscribe/Unsubscribe/Notify procedure + +Figure 5.6A.2-1: ML Model Training Subscribe/Unsubscribe/Notify procedure + +1. In order to subscribe to ML model and/or ML model training information, the NF service consumer invokes Nnwdaf\_MLModelTraining\_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF ML Model Training Subscriptions", as described in clause 4.6.2.2 of 3GPP TS 29.520 [5]. See 3GPP TS 29.520 [5] clause 5.5 for details. + +In order to modify the existing subscription, the NF service consumer invokes Nnwdaf\_MLModelTraining\_Subscribe service operation by sending an HTTP PUT request or an HTTP PATCH request with Resource URI of the resource "Individual NWDAF ML Model Training Subscription". + +2. The NWDAF containing MTLF responds to the Nnwdaf\_MLModelTraining\_Subscribe service operation. Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NWDAF containing MTLF responds to the NF service consumer with "201 Created", and the URI of the created subscription is included in the Location header field. + +Upon receipt of the HTTP PUT request or the HTTP PATCH request, if the subscription is accepted to be updated, the NWDAF containing MTLF responds to the NF service consumer an HTTP "200 OK" with a response body containing a representation of the updated subscription or "204 No Content". + +3. If the NWDAF containing MTLF determines that the subscribed ML model and/or ML model training information is available, the NWDAF containing MTLF invokes Nnwdaf\_MLModelTraining\_Notify service operation to report the ML model and/or ML model training information by sending an HTTP POST request to the NF service consumer identified by the notification URI received during the creation/modification of the subscriptions, as described in clause 4.6.2.4 of 3GPP TS 29.520 [5]. +4. The NF service consumer responds to the NWDAF containing MTLF with an HTTP "204 No Content" message. +5. In order to unsubscribe from the notification(s) of the ML model and/or ML model training information, the NF service consumer invokes Nnwdaf\_MLModelTraining\_Unsubscribe service operation by sending an HTTP DELETE request, which targets the resource "Individual NWDAF ML Model Training Subscription", to the NWDAF containing MTLF. +6. If the request is accepted, the NWDAF containing MTLF deletes the subscription and responds to the NF service consumer with an HTTP "204 No Content" message. + +NOTE: For details of Nnwdaf\_MLModelTraining\_Subscribe/Unsubscribe/Notify service operations refer to 3GPP TS 29.520 [5]. + +## 5.7 Procedures for Specific Network Data Analytics + +### 5.7.1 General + +### 5.7.2 Network Slice (Instance) load level Analytics + +This procedure is used by the NF to obtain the network slice (instance) load level analytics which are calculated by the NWDAF based on the information collected from the NSACF, NRF, AMF, SMF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram showing the procedure for Network Slice (Instance) load level Analytics. Lifelines: NF, NWDAF, NSACF, NRF, AMF, SMF, NSSF, OAM. The diagram illustrates the interaction between these network functions to collect and derive analytics data.](7ed5d5770331f31ade15439a21c31425_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant NSACF + participant NRF + participant AMF + participant SMF + participant NSSF + participant OAM + + Note left of NF: 1. Analytics requests and subscriptions + 1a. NWDAF->>NF: Nnwdaf_AnalyticsInfo_Request request + 1b. NWDAF->>NF: Nnwdaf_EventsSubscription_Subscribe request + 1c. NF-->>NWDAF: Nnwdaf_EventsSubscription_Subscribe response + + Note left of NWDAF: 2. NRF Discovery + 2a. NWDAF->>NRF: Nnrf_NFDiscovery_Request request + 2b. NRF-->>NWDAF: Nnrf_NFDiscovery_Request response + + Note left of NSACF: 3. NSSF Selection + 3a. NSACF->>NSSF: Nnssf_NSSelection_Get request + 3b. NSSF-->>NSACF: Nnssf_NSSelection_Get response + + Note left of NWDAF: 4-5. NF Management Subscriptions + 4a. NWDAF->>NF: Nnrf_NFManagement_NFStatusSubscribe request + 4b. NF-->>NWDAF: Nnrf_NFManagement_NFStatusSubscribe response + 5a. NWDAF->>NF: Nnrf_NFManagement_NFStatusNotify request + 5b. NF-->>NWDAF: Nnrf_NFManagement_NFStatusNotify response + + Note left of AMF: 6-7. AMF Event Exposure + 6a. NWDAF->>AMF: Namf_EventExposure_Subscribe request + 6b. AMF-->>NWDAF: Namf_EventExposure_Subscribe response + 7a. AMF->>NWDAF: Namf_EventExposure_Notify request + 7b. NWDAF-->>AMF: Namf_EventExposure_Notify response + + Note left of SMF: 8-9. SMF Event Exposure + 8a. NWDAF->>SMF: Nsmf_EventExposure_Subscribe request + 8b. SMF-->>NWDAF: Nsmf_EventExposure_Subscribe response + 9a. SMF->>NWDAF: Nsmf_EventExposure_Notify request + 9b. NWDAF-->>SMF: Nsmf_EventExposure_Notify response + + Note left of OAM: 10. Data collection from OAM + 10. NWDAF->>OAM: Data collection from OAM + + Note left of NSACF: 11-12. Slice Event Exposure + 11a. NSACF->>NWDAF: Nnsacf_SliceEventExposure_Subscribe request + 11b. NWDAF-->>NSACF: Nnsacf_SliceEventExposure_Subscribe response + 12a. NSACF->>NWDAF: Nnsacf_SliceEventExposure_Notify request + 12b. NWDAF-->>NSACF: Nnsacf_SliceEventExposure_Notify response + + Note left of NWDAF: 13. Analytics derivation + 13. NWDAF derives Network Slice (Instance) load level Analytics + + Note left of NF: 14. Analytics responses and notifications + 14a. NWDAF-->>NF: Nnwdaf_AnalyticsInfo_Request response + 14b. NWDAF->>NF: Nnwdaf_EventsSubscription_Notify request + 14c. NF-->>NWDAF: Nnwdaf_EventsSubscription_Notify response + + Note left of NWDAF: 15-16. AMF Notifications + 15a. NWDAF->>AMF: Nnrf_NFManagement_NFStatusNotify request + 15b. AMF-->>NWDAF: Nnrf_NFManagement_NFStatusNotify response + 16a. AMF->>NWDAF: Namf_EventExposure_Notify request + 16b. NWDAF-->>AMF: Namf_EventExposure_Notify response + + Note left of SMF: 17. SMF Notifications + 17a. SMF->>NWDAF: Nsmf_EventExposure_Notify request + 17b. NWDAF-->>SMF: Nsmf_EventExposure_Notify response + + Note left of OAM: 18. Data collection from OAM + 18. NWDAF->>OAM: Data collection from OAM + + Note left of NSACF: 19. Slice Event Notifications + 19a. NSACF->>NWDAF: Nnsacf_SliceEventExposure_Notify request + 19b. NWDAF-->>NSACF: Nnsacf_SliceEventExposure_Notify response + + Note left of NWDAF: 20. Analytics derivation + 20. NWDAF derives Network Slice (Instance) load level Analytics + + Note left of NF: 21. Subscription notifications + 21a. NWDAF->>NF: Nnwdaf_EventsSubscription_Notify request + 21b. NF-->>NWDAF: Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram showing the procedure for Network Slice (Instance) load level Analytics. Lifelines: NF, NWDAF, NSACF, NRF, AMF, SMF, NSSF, OAM. The diagram illustrates the interaction between these network functions to collect and derive analytics data. + +Figure 5.7.2-1: Procedure for Network Slice (Instance) load level Analytics + +- 1a. In order to obtain the network slice (instance) load level analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to obtain the network slice (instance) load level analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a-2b. If the event is set to "LOAD\_LEVEL\_INFORMATION" or "NSI\_LOAD\_LEVEL", the NWDAF invokes Nnrf\_NFDiscovery\_Request service operation as described in clause 5.3.2.2 of 3GPP TS 29.510 [26] to discover the AMF, SMF and NSSF instance(s) relevant to the analytics filters provided in the subscription request. The NRF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. (Only for "NSI\_LOAD\_LEVEL")The NWDAF may invoke Nnsnf\_NSSelection\_Get service operation as described in clause 5.2.2.2 of 3GPP TS 29.531 [21] to obtain the NSI ID(s) corresponding to the S-NSSAI in the subscription request. The NRF responds to the NWDAF an HTTP "201 Created" response. +- 4a-4b. (Only for "NSI\_LOAD\_LEVEL")The NWDAF may invoke Nnrf\_NFManagement\_NFStatusSubscribe service operation as described in clause 5.2.2.5 of 3GPP TS 29.510 [26] to subscribe to the resource usage information of a network slice instance obtained from its constituent NF instances. The NRF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. (Only for "NSI\_LOAD\_LEVEL") If step 4a and step 4b are performed, the NRF may invoke Nnrf\_NFManagement\_NFStatusNotify service operation as described in clause 5.2.2.6 of 3GPP TS 29.510 [26]. The NWDAF responds to the NRF an HTTP "204 No Content" response. +- 6a-6b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to subscribe to the notification of individual UE registration/deregistration registered to an S-NSSAI or to an S-NSSAI and NSI ID, or request the total number of UEs served by the AMF per S-NSSAI or per S-NSSAI and NSI ID. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 7a-7b. If step 6a and step 6b are performed, the AMF invokes Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 8a-8b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to subscribe to the notification of individual PDU session established or PDU session released in an S-NSSAI or request the total number of PDU Sessions established in an S-NSSAI. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 9a-9b. If step 8a and step 8b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +10. The NWDAF may collect "Performance measurement" to the OAM to get the mean number of UEs registered as described in clause 5.2.1 of TS 28.552 [27], mean number of PDU sessions established as described in clause 5.3.1 of TS 28.552 [27] and/or the resource usage information of a network slice instance obtained from its constituent NF instances as described in clause 6.2 of TS 28.552 [27]. (Obtaining the resource usage information of a network slice instance is only applicable for "NSI\_LOAD\_LEVEL" event). +- 11a-11b. The NWDAF may invoke Nnsacf\_SliceEventExposure\_Subscribe service operation as described in clause 5.3.2.2 of 3GPP TS 29.536 [20] to request the number of UEs registered to the network slice and/or the number of PDU sessions established to the network slice. +- 12a-12b. The NSACF may invoke Nnsacf\_SliceEventExposure\_Notify service operation as described in clause 5.3.2.4 of 3GPP TS 29.536 [20]. The NWDAF responds to the NSACF an HTTP "204 No Content" response. +13. The NWDAF calculates the network slice (instance) load level analytics based on the data collected from AMF, SMF, NRF, NSACF and/or OAM. +- 14a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 14b-14c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +15a-15b. The same as step 5a and step 5b. + +16a-16b. The same as step 7a and step 7b. + +17a-17b. The same as step 9a and step 9b. + +18. The same as step 10. + +19a-19b. The same as step 12a and step 12b. + +20. The same as step 13. + +21a-21b. The same as step 14b and step 14c. + +NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 2: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.3 Observed Service Experience Analytics + +This procedure is used by the NF to obtain the Service Experience analytics which are calculated by the NWDAF based on the information collected from the AMF, SMF, UPF, GMLC, AF, OAM and/or MDAF. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram showing interactions between Network Functions (NFs) in a 5G system. Lifelines: NF, NWDAF, AMF, SMF, UPF, GMLC, NEF, AF, OAM, MDAF. The diagram illustrates various request and response messages for analytics, subscriptions, and location services.](b34c69e1ec326b01c3a485b27b1df5f6_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant SMF + participant UPF + participant GMLC + participant NEF + participant AF + participant OAM + participant MDAF + + Note left of NF: 15. NWDAF derives Service Experience Analytics + Note left of NF: 23. NWDAF derives Service Experience Analytics + + Note right of NF: 1a. Nnwdaf_AnalyticsInfo_Request request + Note right of NF: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note right of NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + Note right of NF: 2a. Namf_EventExposure_Subscribe request + Note right of NF: 2b. Namf_EventExposure_Subscribe response + Note right of NF: 3a. Namf_EventExposure_Notify request + Note right of NF: 3b. Namf_EventExposure_Notify response + Note right of NF: 4a. Nsmf_EventExposure_Subscribe request + Note right of NF: 4b. Nsmf_EventExposure_Subscribe response + Note right of NF: 5a. Nsmf_EventExposure_Notify request + Note right of NF: 5b. Nsmf_EventExposure_Notify response + Note right of NF: 6a. Naf_EventExposure_Subscribe request + Note right of NF: 6b. Naf_EventExposure_Subscribe response + Note right of NF: 7a. Naf_EventExposure_Notify request + Note right of NF: 7b. Naf_EventExposure_Notify response + Note right of NF: 8a. Nnef_EventExposure_Subscribe request + Note right of NF: 8b. Naf_EventExposure_Subscribe request + Note right of NF: 8c. Naf_EventExposure_Subscribe response + Note right of NF: 8d. Nnef_EventExposure_Subscribe response + Note right of NF: 9a. Naf_EventExposure_Notify request + Note right of NF: 9b. Nnef_EventExposure_Notify request + Note right of NF: 9c. Nnef_EventExposure_Notify response + Note right of NF: 9d. Naf_EventExposure_Notify response + Note right of NF: 10a. Nsmf_EventExposure_Subscribe request + Note right of NF: 10a1. Nupf_EventExposure_Subscribe request + Note right of NF: 10a2. Nupf_EventExposure_Subscribe response + Note right of NF: 10b. Nsmf_EventExposure_Subscribe response + Note right of NF: 11a. Nupf_EventExposure_Notify request + Note right of NF: 11b. Nupf_EventExposure_Notify response + Note right of NF: 12a. Ngmlc_Location_ProvideLocation request + Note right of NF: 12b. Ngmlc_Location_ProvideLocation response + Note right of NF: 13a. Ngmlc_Location_EventNotify request + Note right of NF: 13b. Ngmlc_Location_EventNotify response + Note right of NF: 14a. NWDAF collects data from OAM + Note right of NF: 14b. NWDAF collects data from MDAF + Note right of NF: 16a. Nnwdaf_AnalyticsInfo_Request response + Note right of NF: 16b. Nnwdaf_EventsSubscription_Notify request + Note right of NF: 16c. Nnwdaf_EventsSubscription_Notify response + Note right of NF: 17a. Namf_EventExposure_Notify request + Note right of NF: 17b. Namf_EventExposure_Notify response + Note right of NF: 18a. Nsmf_EventExposure_Notify request + Note right of NF: 18b. Nsmf_EventExposure_Notify response + Note right of NF: 19a. Naf_EventExposure_Notify request + Note right of NF: 19b. Naf_EventExposure_Notify response + Note right of NF: 20a. Naf_EventExposure_Notify request + Note right of NF: 20b. Nnef_EventExposure_Notify request + Note right of NF: 20c. Nnef_EventExposure_Notify response + Note right of NF: 20d. Naf_EventExposure_Notify response + Note right of NF: 21a. Nupf_EventExposure_Notify request + Note right of NF: 21b. Nupf_EventExposure_Notify response + Note right of NF: 22a. Ngmlc_Location_EventNotify request + Note right of NF: 22b. Ngmlc_Location_EventNotify response + Note right of NF: 24a. Nnwdaf_EventsSubscription_Notify request + Note right of NF: 24b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram showing interactions between Network Functions (NFs) in a 5G system. Lifelines: NF, NWDAF, AMF, SMF, UPF, GMLC, NEF, AF, OAM, MDAF. The diagram illustrates various request and response messages for analytics, subscriptions, and location services. + +**Figure 5.7.3-1: Procedure for Service Experience Analytics** + +- 1a. In order to obtain the Service Experience analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to obtain the Service Experience analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a-2b. If the event is set to "SERVICE\_EXPERIENCE", the NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to subscribe to the notification of UE ID and UE location. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF invokes Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to subscribe to the notification of QFI, IP filter information, DNAI, UPF information, Application ID, DNN and S-NSSAI. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +- 6a-6b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to request the service data and performance data from AF directly. The AF responds to the NWDAF an HTTP "201 Created" response. +- 7a-7b. If step 6a and step 6b are performed, the AF may invoke Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 6a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 8a-8d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions". The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 9a-9d. If step 8a to step 8d are performed, the AF may invoke Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 8b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +- 10a-10b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" as described in 3GPP TS 29.508 [6] to subscribe via the SMF to UPF information for a specific UE. The SMF subscribes to the UPF on behalf of the NWDAF using the Nupf\_EventExposure\_Subscribe service operation as described in 3GPP TS 29.564 [40] and, after having received the successful response from the UPF, it responds to the NWDAF with an HTTP "201 Created" response. +- 11a-11b. If step 10a and step 10b are performed, the UPF may invoke Nupf\_EventExposure\_Notify service operation as described in 3GPP TS 29.564 [40] by sending an HTTP POST request to the NWDAF identified by the notification URI provided in step 6a. The NWDAF responds to the UPF an HTTP "204 No Content" response. +- 12a-12b. If the NF requests fine granularity location analytics information, the NWDAF may invoke Ngmlc\_Location\_ProvideLocation service operation to retrieve UE Location and UE Location Accuracy by sending an HTTP POST request to the URI associated with the "provide-location" custom operation as described in 3GPP TS 29.515 [41] clause 5.2.2.2. The GMLC responds to the NWDAF an HTTP "201 Created" response. + +- 13a-13b. If step 12a and step 12b are performed, the GMLC may invoke Ngmlc\_Location\_EventNotify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the GMLC an HTTP "204 No Content" response. +- 14a. The NWDAF may collect Reference Signal Received Power and Reference Signal Received Quality as specified in clause 5.5 of TS 38.331 [33] and clause 5.5.5 of TS 36.331 [34], Signal-to-noise and interference ratio as specified in clause 5.1 of TS 38.215 [35], the mapping information between cell ID and frequency and/or Cell Energy Saving State data as specified in clauses 3.1 and 6.2 of TS 28.310 [36] from OAM. If the NF is AF or NEF requesting per application analytics with UE granularity, the NWDAF may collect the average UL/DL RAN throughput, the UL/DL RAN packet delay and the UL/DL RAN Packet loss rate as described in clause 5.2.1.1 and 5.4.1.1 of TS 37.320 [29]. +- 14b. The NWDAF may collect service experience and energy saving state analysis as specified in clause 8.4.2.1.3 and clause 8.4.4.3 of TS 28.104 [38] from MDAF. The information element of the analysis from MDAF include ServiceExperienceIssueType, AffectedObjects, ServiceExperienceStatistics, ServiceExperiencePredictions, and StatisticsOfCellsEsState. +15. The NWDAF calculates the Service Experience analytics based on the data collected from AMF, SMF, UPF, GMLC, AF, OAM and/or MDAF. +- 16a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 16b-16c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 17a-17b. The same as step 3a and step 3b. +- 18a-18b. The same as step 5a and step 5b. +- 19a-19d. The same as step 7a and step 7b. +- 20a-20d. The same as step 9a and step 9b. +- 21a-21b. The same as step 11a and step 11b. +- 22a-22b. The same as step 13a and step 13b. +23. The same as step 15. +- 24a-24b. The same as step 16b and step 16c. + +NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 2: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 3: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +### 5.7.4 NF load Analytics + +This procedure is used by the NWDAF service consumer (may be an NF, or the OAM) to obtain the NF load analytics which are calculated by the NWDAF based on the information collected from the NRF and/or the OAM, may also collect UE input data via the AF (for the untrusted AF via the NEF). If target NF type is UPF, the NWDA may collect the information from UPF. + +![Sequence diagram for NF load Analytics procedure. Lifelines: Service Consumer, NWDAF, NRF, UPF, NEF, AF, OAM. The diagram shows a series of requests and responses between these entities to collect and analyze network function load data.](fd3cbb53e991f8209ba17b398f426e13_img.jpg) + +``` + +sequenceDiagram + participant Service Consumer + participant NWDAF + participant NRF + participant UPF + participant NEF + participant AF + participant OAM + + Note left of Service Consumer: 1. Initial Requests + Service Consumer->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Service Consumer->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>Service Consumer: 1c. Nnwdaf_EventsSubscription_Subscribe response + + Note left of NWDAF: 2. NRF Discovery + NWDAF->>NRF: 2a. Nnrf_NFDiscovery_Request request + NRF-->>NWDAF: 2b. Nnrf_NFDiscovery_Request response + + Note left of NWDAF: 3. OAM Data Collection + NWDAF->>OAM: 3. Data collection from OAM + + Note left of NWDAF: 4. NRF Management Subscriptions + NWDAF->>NRF: 4a. Nnrf_NFManagement_NFStatusSubscribe request + NRF-->>NWDAF: 4b. Nnrf_NFManagement_NFStatusSubscribe response + NWDAF->>NRF: 5a. Nnrf_NFManagement_NFStatusNotify request + NRF-->>NWDAF: 5b. Nnrf_NFManagement_NFStatusNotify response + + Note left of NWDAF: 6. UPF Data Collection + NWDAF->>UPF: 6. Data collection from UPF + + Note left of NWDAF: 7. AF Event Exposure Subscription + NWDAF->>AF: 7a. Naf_EventExposure_Subscribe request + AF-->>NWDAF: 7b. Naf_EventExposure_Subscribe response + NWDAF->>AF: 8a. Naf_EventExposure_Notify request + AF-->>NWDAF: 8b. Naf_EventExposure_Notify response + + Note left of NWDAF: 9. NEF Event Exposure Subscription + NWDAF->>NEF: 9a. Nnef_EventExposure_Subscribe request + NEF->>AF: 9b. Naf_EventExposure_Subscribe request + AF-->>NEF: 9c. Naf_EventExposure_Subscribe response + NEF-->>NWDAF: 9d. Nnef_EventExposure_Subscribe response + + Note left of NEF: 10. AF Event Exposure Notification + AF->>NEF: 10a. Naf_EventExposure_Notify request + NEF->>NWDAF: 10b. Nnef_EventExposure_Notify request + NWDAF-->>NEF: 10c. Nnef_EventExposure_Notify response + NEF-->>AF: 10d. Naf_EventExposure_Notify response + + Note left of Service Consumer: 11. NWDAF derives NF load Analytics + Service Consumer->>NWDAF: 12a. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>Service Consumer: 12b. Nnwdaf_EventsSubscription_Notify request + Service Consumer-->>NWDAF: 12c. Nnwdaf_EventsSubscription_Notify response + + Note left of NWDAF: 13. OAM Data Collection + NWDAF->>OAM: 13. Data collection from OAM + + Note left of NWDAF: 14. NRF Management Notifications + NWDAF->>NRF: 14a. Nnrf_NFManagement_NFStatusNotify request + NRF-->>NWDAF: 14b. Nnrf_NFManagement_NFStatusNotify response + + Note left of NWDAF: 15. UPF Data Collection + NWDAF->>UPF: 15. Data collection from UPF + + Note left of NWDAF: 16. AF Event Exposure Notification + NWDAF->>AF: 16a. Naf_EventExposure_Notify request + AF-->>NWDAF: 16b. Naf_EventExposure_Notify response + + Note left of NWDAF: 17. NEF Event Exposure Notification + NWDAF->>NEF: 17a. Nnef_EventExposure_Notify request + NEF->>AF: 17a. Naf_EventExposure_Notify request + AF-->>NEF: 17b. Nnef_EventExposure_Notify request + NEF-->>NWDAF: 17c. Nnef_EventExposure_Notify response + NEF-->>AF: 17d. Naf_EventExposure_Notify response + + Note left of Service Consumer: 18. NWDAF derives NF load Analytics + Service Consumer->>NWDAF: 19a. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>Service Consumer: 19b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for NF load Analytics procedure. Lifelines: Service Consumer, NWDAF, NRF, UPF, NEF, AF, OAM. The diagram shows a series of requests and responses between these entities to collect and analyze network function load data. + +Figure 5.7.4-1: Procedure for NF load Analytics + +- 1a. In order to obtain the NF load analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is set to "NF\_LOAD" with the supported feature "NfLoad". +- 1b-1c. In order to obtain the NF load analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "NF\_LOAD" with the supported feature "NfLoad". +- 2a-2b. The NWDAF may invoke Nnrf\_NFDiscovery\_Request service operation as described in clause 5.3.2.2 of 3GPP TS 29.510 [26] for each NF, to obtain the initial NF profile which contains NF status and may contains NF load information. The NRF responds to the NWDAF an HTTP "201 Created" response. +3. The NWDAF may collect "Performance measurement" to the OAM to get the NF resource usage information as described in clause 5.7 of 3GPP TS 28.552 [27] and/or may collect the NF resource configuration change information as described in clause 5.2 of 3GPP TS 28.533 [28]. The NWDAF may also collect the MDT data information for UE as described in 3GPP TS 37.320 [29]. +- 4a-4b. The NWDAF may invoke Nnrf\_NFManagement\_NFStatusSubscribe service operation as described in clause 5.2.2.5 of 3GPP TS 29.510 [26] to subscribe to the NF status and/or NF load information. The NRF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the NRF may invoke Nnrf\_NFManagement\_NFStatusNotify service operation as described in clause 5.2.2.6 of 3GPP TS 29.510 [26]. The NWDAF responds to the NRF an HTTP "204 No Content" response. +6. If the target NF type is UPF, the NWDAF may collect traffic usage report information from UPF. + +NOTE 1: How the NWDAF collects UPF information is not defined in this release of the specification. + +- 7a-7b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation to the AF directly by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the Collective Behaviour of UEs. The AF responds to the NWDAF an HTTP "201 Created" response. +- 8a-8b. If step 7a and step 7b are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 7a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 9a-9d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the Collective Behaviour of UEs. The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 10a-10d. If step 9a to step 9d are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 9b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 9a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. + +11. The NWDAF calculates the NF load analytics based on the data collected from NRF, OAM, UPF and/or AF. +- 12a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 12b-12c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +13. The same as step 3. +- 14a-14b. The same as step 5a and step 5b. +15. The same as step 6. +- 16a-16b. The same as step 8a and step 8b. + +17a-17d. The same as step 10a to step 10d. + +18. The same as step 11. + +19a-19b. The same as step 12b and step 12c. + +NOTE 2: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 3: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 4: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.5 Network Performance Analytics + +This procedure is used by the NF to obtain the network performance analytics which are calculated by the NWDAF based on the information collected from the AMF, NRF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram for Network Performance Analytics procedure. Lifelines: NF, NWDAF, NRF, AMF, OAM. The diagram shows two parallel procedures for deriving network performance analytics. In the first, the NF sends a request to the NWDAF, which then subscribes to the NRF for NF status and discovery, and to the AMF for event exposure. The NWDAF then sends a response to the NF and notifies the OAM. In the second, the NF sends a subscription to the NWDAF, which similarly interacts with the NRF and AMF, derives analytics, and then notifies the NF and OAM.](fcc757566216206ceddbd6c775e8db02_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant NRF + participant AMF + participant OAM + + Note left of NF: 1a. Nnwdaf_AnalyticsInfo_Request request + NF->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Note left of NF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NF->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note left of NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF-->>NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + + Note left of NWDAF: 2a. Nnrf_NFManagement_NFStatusSubscribe request + NWDAF->>NRF: 2a. Nnrf_NFManagement_NFStatusSubscribe request + Note left of NWDAF: 2b. Nnrf_NFManagement_NFStatusSubscribe response + NRF-->>NWDAF: 2b. Nnrf_NFManagement_NFStatusSubscribe response + Note left of NWDAF: 3a. Nnrf_NFManagement_NFStatusNotify request + NWDAF->>NRF: 3a. Nnrf_NFManagement_NFStatusNotify request + Note left of NWDAF: 3b. Nnrf_NFManagement_NFStatusNotify response + NRF-->>NWDAF: 3b. Nnrf_NFManagement_NFStatusNotify response + Note left of NWDAF: 4a. Nnrf_NFDiscovery_Request request + NWDAF->>NRF: 4a. Nnrf_NFDiscovery_Request request + Note left of NWDAF: 4b. Nnrf_NFDiscovery_Request response + NRF-->>NWDAF: 4b. Nnrf_NFDiscovery_Request response + Note left of NWDAF: 5a. Namf_EventExposure_Subscribe request + NWDAF->>AMF: 5a. Namf_EventExposure_Subscribe request + Note left of NWDAF: 5b. Namf_EventExposure_Subscribe response + AMF-->>NWDAF: 5b. Namf_EventExposure_Subscribe response + Note left of NWDAF: 6a. Namf_EventExposure_Notify request + NWDAF->>AMF: 6a. Namf_EventExposure_Notify request + Note left of NWDAF: 6b. Namf_EventExposure_Notify response + AMF-->>NWDAF: 6b. Namf_EventExposure_Notify response + Note left of NWDAF: 7. Performance threshold monitoring service + NWDAF-->>OAM: 7. Performance threshold monitoring service + + Note right of NF: 8. NWDAF derives Network Performance Analytics + Note left of NF: 9a. Nnwdaf_AnalyticsInfo_Request response + NWDAF-->>NF: 9a. Nnwdaf_AnalyticsInfo_Request response + Note left of NF: 9b. Nnwdaf_EventsSubscription_Notify request + NWDAF->>NF: 9b. Nnwdaf_EventsSubscription_Notify request + Note left of NF: 9c. Nnwdaf_EventsSubscription_Notify response + NF-->>NWDAF: 9c. Nnwdaf_EventsSubscription_Notify response + + Note left of NWDAF: 10a. Nnrf_NFManagement_NFStatusNotify request + NWDAF->>NRF: 10a. Nnrf_NFManagement_NFStatusNotify request + Note left of NWDAF: 10b. Nnrf_NFManagement_NFStatusNotify response + NRF-->>NWDAF: 10b. Nnrf_NFManagement_NFStatusNotify response + Note left of NWDAF: 11a. Namf_EventExposure_Notify request + NWDAF->>AMF: 11a. Namf_EventExposure_Notify request + Note left of NWDAF: 11b. Namf_EventExposure_Notify response + AMF-->>NWDAF: 11b. Namf_EventExposure_Notify response + Note left of NWDAF: 12. Performance threshold monitoring service + NWDAF-->>OAM: 12. Performance threshold monitoring service + + Note right of NF: 13. NWDAF derives Network Performance Analytics + Note left of NF: 14a. Nnwdaf_EventsSubscription_Notify request + NWDAF->>NF: 14a. Nnwdaf_EventsSubscription_Notify request + Note left of NF: 14b. Nnwdaf_EventsSubscription_Notify response + NF-->>NWDAF: 14b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for Network Performance Analytics procedure. Lifelines: NF, NWDAF, NRF, AMF, OAM. The diagram shows two parallel procedures for deriving network performance analytics. In the first, the NF sends a request to the NWDAF, which then subscribes to the NRF for NF status and discovery, and to the AMF for event exposure. The NWDAF then sends a response to the NF and notifies the OAM. In the second, the NF sends a subscription to the NWDAF, which similarly interacts with the NRF and AMF, derives analytics, and then notifies the NF and OAM. + +**Figure 5.7.5-1: Procedure for Network Performance Analytics** + +1a. In order to obtain the network performance analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +1b-1c. In order to obtain the network performance analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. + +- 2a-2b. If the event is set to "NETWORK\_PERFORMANCE", the NWDAF may invoke Nnrf\_NFManagement\_NFStatusSubscribe service operation as described in clause 5.2.2.5 of 3GPP TS 29.510 [26] to subscribe to NF (e.g. SMF, UPF) load and status information. The NRF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the NRF may invoke Nnrf\_NFManagement\_NFStatusNotify service operation as described in clause 5.2.2.6 of 3GPP TS 29.510 [26]. The NWDAF responds to the NRF an HTTP "204 No Content" response. +- 4a-4b. If the event is set to "NETWORK\_PERFORMANCE" and the type of network performance is set to "NUM\_OF\_UE", the NWDAF invokes Nnrf\_NFDiscovery\_Request service operation as described in clause 5.3.2.2 of 3GPP TS 29.510 [26] to discover the AMF(s) belonging to the AMF Region(s) that include(s) the Area of Interest. The NRF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to collect the number of UEs located in the Area of Interest from AMF. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 6a-6b. If step 5a and step 5b are performed, the AMF invokes Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +7. The NWDAF may collect "Performance measurement" to the OAM to get the status and load information and the performance per Cell Id in the Area of Interest as described in clause 5.1 of TS 28.552 [27]. +8. The NWDAF calculates the network performance analytics based on the data collected from AMF, NRF and/or OAM. +- 9a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 9b-9c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 10a-10b. The same as step 3a and step 3b. +- 11a-11b. The same as step 6a and step 6b. +12. The same as step 7. +13. The same as step 8. +- 14a-14b. The same as step 9b and step 9c. + +NOTE: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.6 UE Mobility Analytics + +This procedure is used by the NF to obtain UE mobility analytics, which is calculated by the NWDAF based on the information collected from the AMF, AF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram showing interactions between NF, NWDAF, AMF, NEF, AF, and OAM. The diagram illustrates various service requests, subscriptions, and notifications related to network analytics and event exposure.](db39acbd11df5eb7e79ab84562fb8f74_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant NEF + participant AF + participant OAM + + Note left of NF: 1. NWDAF derives UE Mobility Analytics + NF->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + NF->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + + Note left of AMF: 2. AMF derives UE Mobility Analytics + AMF->>NWDAF: 2a. Namf_EventExposure_Subscribe request + NWDAF-->>AMF: 2b. Namf_EventExposure_Subscribe response + NWDAF->>AMF: 3a. Namf_EventExposure_Notify request + AMF-->>NWDAF: 3b. Namf_EventExposure_Notify response + + Note left of AF: 4. AF derives UE Mobility Analytics + AF->>NWDAF: 4a. Naf_EventExposure_Subscribe request + NWDAF-->>AF: 4b. Naf_EventExposure_Subscribe response + NWDAF->>AF: 5a. Naf_EventExposure_Notify request + AF-->>NWDAF: 5b. Naf_EventExposure_Notify response + + Note left of NEF: 6. NEF derives UE Mobility Analytics + NEF->>NWDAF: 6a. Nnef_EventExposure_Subscribe request + NEF->>AF: 6b. Naf_EventExposure_Subscribe request + AF-->>NEF: 6c. Naf_EventExposure_Subscribe response + NEF-->>NWDAF: 6d. Nnef_EventExposure_Subscribe response + + Note left of AF: 7. AF derives UE Mobility Analytics + AF->>NEF: 7a. Naf_EventExposure_Notify request + NEF-->>AF: 7b. Nnef_EventExposure_Notify request + NEF->>AF: 7c. Nnef_EventExposure_Notify response + AF-->>NEF: 7d. Naf_EventExposure_Notify response + + Note left of OAM: 8. streaming data reporting service + OAM->>NWDAF: 8. streaming data reporting service reportStreamData + + Note left of OAM: 9. File data reporting service + OAM->>NWDAF: 9. File data reporting service subscribe or listAvailableFiles + + Note left of NWDAF: 10. NWDAF derives UE Mobility Analytics + NWDAF-->>NF: 11a. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>NF: 11b. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 11c. Nnwdaf_EventsSubscription_Notify response + + Note left of AMF: 12. AMF derives UE Mobility Analytics + AMF->>NWDAF: 12a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 12b. Namf_EventExposure_Notify response + + Note left of AF: 13. AF derives UE Mobility Analytics + AF->>NWDAF: 13a. Naf_EventExposure_Notify request + NWDAF-->>AF: 13b. Naf_EventExposure_Notify response + + Note left of NEF: 14. NEF derives UE Mobility Analytics + NEF->>AF: 14a. Naf_EventExposure_Notify request + AF-->>NEF: 14b. Nnef_EventExposure_Notify request + NEF->>AF: 14c. Nnef_EventExposure_Notify response + AF-->>NEF: 14d. Naf_EventExposure_Notify response + + Note left of OAM: 15. File data reporting service + OAM->>NWDAF: 15. File data reporting service notification request + + Note left of NWDAF: 16. NWDAF derives UE Mobility Analytics + NWDAF-->>NF: 17a. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 17b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram showing interactions between NF, NWDAF, AMF, NEF, AF, and OAM. The diagram illustrates various service requests, subscriptions, and notifications related to network analytics and event exposure. + +###### **Figure 5.7.6-1: Procedure for UE Mobility analytics** + +- 1a. In order to obtain the UE mobility analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to obtain the UE mobility analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18]. This step may be skipped when e.g. the UE mobility information is available. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF invokes Namf\_EventExposure\_Notify service operation as described in clause 5.3.2.4 of 3GPP TS 29.518 [18]. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation to the AF directly by sending an HTTP POST request targeting the resource "Application Event Subscriptions". The AF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 6a-6d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions". The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 7a-7d. If step 6a to step 6d are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 6b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 6a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +8. The NWDAF may invoke "streaming data reporting service reportStreamData" service operation to the OAM as described in clause 12.5.1.1.5 of 3GPP TS 28.532 [19]. +9. The NWDAF may invoke the "File data reporting service subscribe" service operation to the OAM as described in clause 12.6.1.1.3 of 3GPP TS 28.532 [19] or invoke "File data reporting service listAvailableFiles" service operation to the OAM as described in clause 12.6.1.1.2 of 3GPP TS 28.532 [19]. +10. The NWDAF calculates the requested UE mobility analytics based on the data collected from AMF, AF and/or OAM. +- 11a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 11b-11c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 12a-12b. The same as step 3a and step 3b. +- 13a-13b. The same as step 5a and step 5b. +- 14a-14d. The same as step 7a and step 7d. +15. The same as step 9. +16. The same as step 10. +- 17a-17b. The same as step 11b and step 11c. + +NOTE 1: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 2: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 3: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.7 UE Communication Analytics + +This procedure is used by the NF to obtain UE communication analytics, which is calculated by the NWDAF based on the information collected from the AMF, SMF, UPF, and/or AF. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram showing network function interactions for UE Communication Analytics. Lifelines: NF, NWDAF, AMF, SMF, UPF, NEF, AF. The diagram details the flow of requests and responses for analytics information and event subscriptions between these functions.](5e9af8986a5845504f251d3079da8078_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant SMF + participant UPF + participant NEF + participant AF + + Note right of NWDAF: 12. NWDAF derives UE Communication Analytics + + Note right of NWDAF: 19. NWDAF derives UE Communication Analytics + + Note right of AMF: 3GPP + +``` + +The sequence diagram illustrates the following interactions: + +- 1a. Nnwdaf\_AnalyticsInfo\_Request**: NF to NWDAF +- 1b. Nnwdaf\_EventsSubscription\_Subscribe**: NF to NWDAF +- 1c. Nnwdaf\_EventsSubscription\_Subscribe response**: NWDAF to NF +- 2a. Namf\_EventExposure\_Subscribe**: NWDAF to AMF +- 2b. Namf\_EventExposure\_Subscribe response**: AMF to NWDAF +- 3a. Namf\_EventExposure\_Notify**: AMF to NWDAF +- 3b. Namf\_EventExposure\_Notify response**: NWDAF to AMF +- 4a. Nsmf\_EventExposure\_Subscribe**: NWDAF to SMF +- 4b. Nsmf\_EventExposure\_Subscribe response**: SMF to NWDAF +- 5a. Nsmf\_EventExposure\_Notify**: SMF to NWDAF +- 5b. Nsmf\_EventExposure\_Notify response**: NWDAF to SMF +- 6a. Nsmf\_EventExposure\_Subscribe**: NWDAF to SMF +- 6a1. Nupf\_EventExposure\_Subscribe**: SMF to UPF +- 6a2. Nupf\_EventExposure\_Subscribe response**: UPF to SMF +- 6b. Nsmf\_EventExposure\_Subscribe response**: SMF to NWDAF +- 7a. Nupf\_EventExposure\_Notify**: UPF to SMF +- 7b. Nupf\_EventExposure\_Notify response**: SMF to UPF +- 8a. Naf\_EventExposure\_Subscribe**: NWDAF to AF +- 8b. Naf\_EventExposure\_Subscribe response**: AF to NWDAF +- 9a. Naf\_EventExposure\_Notify**: AF to NWDAF +- 9b. Naf\_EventExposure\_Notify response**: NWDAF to AF +- 10a. Nnef\_EventExposure\_Subscribe**: NWDAF to NEF +- 10b. Naf\_EventExposure\_Subscribe**: NEF to AF +- 10c. Naf\_EventExposure\_Subscribe response**: AF to NEF +- 10d. Nnef\_EventExposure\_Subscribe response**: NEF to NWDAF +- 11a. Naf\_EventExposure\_Notify**: AF to NEF +- 11b. Nnef\_EventExposure\_Notify**: NEF to NWDAF +- 11c. Nnef\_EventExposure\_Notify response**: NWDAF to NEF +- 11d. Naf\_EventExposure\_Notify response**: NEF to AF +- 12. NWDAF derives UE Communication Analytics**: (Internal NWDAF process) +- 13a. Nnwdaf\_AnalyticsInfo\_Request response**: NWDAF to NF +- 13b. Nnwdaf\_EventsSubscription\_Notify**: NWDAF to NF +- 13c. Nnwdaf\_EventsSubscription\_Notify response**: NF to NWDAF +- 14a. Namf\_EventExposure\_Notify**: AMF to NWDAF +- 14b. Namf\_EventExposure\_Notify response**: NWDAF to AMF +- 15a. Nsmf\_EventExposure\_Notify**: SMF to NWDAF +- 15b. Nsmf\_EventExposure\_Notify response**: NWDAF to SMF +- 16a. Nupf\_EventExposure\_Notify**: UPF to NWDAF +- 16b. Nupf\_EventExposure\_Notify response**: NWDAF to UPF +- 17a. Naf\_EventExposure\_Notify**: AF to NWDAF +- 17b. Naf\_EventExposure\_Notify response**: NWDAF to AF +- 18a. Naf\_EventExposure\_Notify**: AF to NEF +- 18b. Nnef\_EventExposure\_Notify**: NEF to NWDAF +- 18c. Nnef\_EventExposure\_Notify response**: NWDAF to NEF +- 18d. Naf\_EventExposure\_Notify response**: NEF to AF +- 19. NWDAF derives UE Communication Analytics**: (Internal NWDAF process) +- 20a. Nnwdaf\_EventsSubscription\_Notify**: NWDAF to NF +- 20b. Nnwdaf\_EventsSubscription\_Notify response**: NF to NWDAF + +Sequence diagram showing network function interactions for UE Communication Analytics. Lifelines: NF, NWDAF, AMF, SMF, UPF, NEF, AF. The diagram details the flow of requests and responses for analytics information and event subscriptions between these functions. + +###### **Figure 5.7.7-1: Procedure for UE Communication analytics** + +- 1a. In order to obtain the UE communication analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to obtain the UE communication analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to retrieve one or more Type Allocation codes, UE connection management state, UE access behaviour trends and UE location trends from AMF. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF may invoke Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to request the information of the UE and/or N4 session related data to calculate the analytics. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +- 6a-6b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" as described in 3GPP TS 29.508 [6] to subscribe via the SMF to UPF information for a specific UE. The SMF subscribes to the UPF on behalf of the NWDAF using the Nupf\_EventExposure\_Subscribe service operation as described in 3GPP TS 29.564 [40] and, after having received the successful response from the UPF, it responds to the NWDAF with an HTTP "201 Created" response. +- 7a-7b. If step 6a and step 6b are performed, the UPF may invoke Nupf\_EventExposure\_Notify service operation as described in 3GPP TS 29.564 [40] by sending an HTTP POST request to the NWDAF identified by the notification URI provided in step 6a. The NWDAF responds to the UPF an HTTP "204 No Content" response. +- 8a-8b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to request the service data from AF directly. The AF responds to the NWDAF an HTTP "201 Created" response. +- 9a-9b. If step 8a and step 8b are performed, the AF may invoke Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 10a-10d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions". The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 11a-11d. If step 10a to step 10d are performed, the AF may invoke Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 8b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +12. The NWDAF calculates the requested UE communication analytics based on the data collected from AMF, SMF, UPF and/or AF. +- 13a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 13b-13c. If step 1b and step 1c are performed, the NWDAF may invoke Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +14a-14b. The same as step 3a and step 3b. + +15a-15b. The same as step 5a and step 5b. + +16a-16b. The same as step 7a and step 7b. + +17a-17b. The same as step 9a and step 9b. + +18a-18d. The same as step 11a and step 11d. + +19. The same as step 12. + +20a-20b. The same as step 13b and step 13c. + +NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 2: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 3: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 4: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.8 Expected UE behavioural Analytics + +This procedure is used by the NF to obtain the expected UE behavioural parameters, which are calculated by the NWDAF based on the information collected from the AMF, SMF, AF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram for Expected behavioural Analytics procedure involving NF, NWDAF, AMF, SMF, NEF, AF, and OAM.](694df81535f89c7bfb9ef0df6f130dc0_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant SMF + participant NEF + participant AF + participant OAM + + NF->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + NF->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + + Note over AMF, OAM: 2a. NWDAF collects data as described in clause 5.7.6 from step 2a to step 9 + Note over AMF, OAM: 2b. NWDAF collects data as described in clause 5.7.7 from step 2a to step 9d + + Note over NWDAF: 3. NWDAF derives Expected UE +behavioural Analytics + + NWDAF-->>NF: 4a. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>NF: 4b. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 4c. Nnwdaf_EventsSubscription_Notify response + + Note over AMF, OAM: 5a. NWDAF receives data as described in clause 5.7.6 from step 12a to step 15 + Note over AMF, OAM: 5b. NWDAF receives data as described in clause 5.7.7 from step 12a to step 15d + + Note over NWDAF: 6. NWDAF derives Expected UE +behavioural Analytics + + NWDAF->>NF: 7a. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 7b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for Expected behavioural Analytics procedure involving NF, NWDAF, AMF, SMF, NEF, AF, and OAM. + +**Figure 5.7.8-1: Procedure for Expected behavioural Analytics** + +- 1a. In order to obtain the expected UE behavioural parameters, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to obtain expected UE behavioural parameters, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a. If the event is set to "UE\_MOBILITY", the NWDAF collects data from AMF, AF and/or OAM as described in clause 5.7.6 from step 2a to step 9. +- 2b. If the event is set to "UE\_COMM", the NWDAF collects data from AMF, SMF and/or AF as described in clause 5.7.7 from step 2a to step 9d. +3. The NWDAF calculates the expected UE behavioural parameters based on the collected data from AMF, SMF, AF and/or OAM. +- 4a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 4b-4c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 5a-5b. The AMF, SMF, AF and/or OAM send the notifications to the NWDAF if it has subscribed to the related events in step 2a or step 2b. +6. The same as step 3. + +7a-7b. The same as step 4b and step 4c. + +NOTE: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.9 Abnormal UE behavioural Analytics + +This procedure is used by the NF to obtain the abnormal UE behavioural analytics which are calculated by the NWDAF based on the information collected from the AMF, SMF, AF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram for Abnormal UE behavioural Analytics procedure. Lifelines: NF, NWDAF, AMF, SMF, NEF, AF, OAM. The diagram shows the interaction between the NF and NWDAF, with NWDAF collecting data from AMF, SMF, AF, and OAM. The process involves Nnwdaf_AnalyticsInfo_Request, Nnwdaf_EventsSubscription_Subscribe, and Nnwdaf_EventsSubscription_Notify operations.](0f7871077bba48a2c97f7859a5edda0d_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant SMF + participant NEF + participant AF + participant OAM + + Note right of AMF: 2a. NWDAF collects data as described in clause 5.7.6 from step 2a to step 9 + Note right of AMF: 2b. NWDAF collects data as described in clause 5.7.7 from step 2a to step 9d + Note right of AMF: 5a. NWDAF receives data as described in clause 5.7.6 from step 12a to step 15 + Note right of AMF: 5b. NWDAF receives data as described in clause 5.7.7 from step 12a to step 15d + + NF->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + NWDAF-->>NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + Note left of AMF: 3. NWDAF derives Abnormal UE behaviour Analytics + NWDAF-->>NF: 4a. Nnwdaf_AnalyticsInfo_Request response + NWDAF-->>NF: 4b. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 4c. Nnwdaf_EventsSubscription_Notify response + Note left of AMF: 6. NWDAF derives Abnormal UE behaviour Analytics + NWDAF-->>NF: 7a. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 7b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for Abnormal UE behavioural Analytics procedure. Lifelines: NF, NWDAF, AMF, SMF, NEF, AF, OAM. The diagram shows the interaction between the NF and NWDAF, with NWDAF collecting data from AMF, SMF, AF, and OAM. The process involves Nnwdaf\_AnalyticsInfo\_Request, Nnwdaf\_EventsSubscription\_Subscribe, and Nnwdaf\_EventsSubscription\_Notify operations. + +Figure 5.7.9-1: Procedure for Abnormal UE behavioural Analytics + +1a. In order to obtain the abnormal UE behavioural parameters, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +1b-1c. In order to obtain abnormal UE behavioural parameters, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. + +2a. If the event is set to "ABNORMAL\_BEHAVIOUR" and the expected UE analytics type is set to "MOBILITY" or "MOBILITY\_AND\_COMMUN", or the list of exception IDs includes "UNEXPECTED\_UE\_LOCATION", "PING\_PONG\_ACROSS\_CELLS", "UNEXPECTED\_RADIO\_LINK\_FAILURES", or "UNEXPECTED\_WAKEUP", the NWDAF collects data from AMF, AF and/or OAM as described in clause 5.7.6 from step 2a to step 9. + +- 2b. If the event is set to "ABNORMAL\_BEHAVIOUR" and the expected UE analytics type is set to "COMMUN" or "MOBILITY\_AND\_COMMUN", or the list of exception IDs includes "SUSPICION\_OF\_DDOS\_ATTACK", "UNEXPECTED\_LONG\_LIVE\_FLOW", "UNEXPECTED\_LARGE\_RATE\_FLOW", "WRONG\_DESTINATION\_ADDRESS", "TOO\_FREQUENT\_SERVICE\_ACCESS" or "UNEXPECTED\_WAKEUP", the NWDAF collects data from AMF, SMF and/or AF as described in clause 5.7.7 from step 2a to step 9d. +3. The NWDAF calculates the abnormal UE behavioural parameters based on the collected data from AMF, SMF, AF and/or OAM. +- 4a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 4b-4c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 5a-5b. The AMF, SMF, AF and/or OAM send the notifications to the NWDAF if it has subscribed to the related events in step 2a or step 2b. +6. The same as step 3. +- 7a-7b. The same as step 4b and step 4c. + +NOTE: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.10 User Data Congestion Analytics + +This procedure is used by the NWDAF service consumer (may be an NF e.g. NEF, AF, or PCF) to obtain the User Data Congestion analytics which are calculated by the NWDAF based on the information collected from the AMF, OAM, UPF and/or AF. + +![Sequence diagram showing the procedure for User Data Congestion Analytics. Lifelines: Service Consumer, NWDAF, AMF, UPF, NEF, AF, OAM. The diagram illustrates the interaction between these entities to collect and analyze user data congestion analytics.](ffb6acd27b8e3a54392840948a75869f_img.jpg) + +``` + +sequenceDiagram + participant Service Consumer + participant NWDAF + participant AMF + participant UPF + participant NEF + participant AF + participant OAM + + Note left of Service Consumer: 1. Service Consumer requests analytics + Service Consumer->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Service Consumer->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>Service Consumer: 1c. Nnwdaf_EventsSubscription_Subscribe response + + Note left of NWDAF: 2. NWDAF subscribes to AMF + NWDAF->>AMF: 2a. Namf_EventExposure_Subscribe request + AMF-->>NWDAF: 2b. Namf_EventExposure_Subscribe response + + Note left of NWDAF: 3. NWDAF receives notifications from AMF + AMF->>NWDAF: 3a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 3b. Namf_EventExposure_Notify response + + Note left of NWDAF: 4. Data collection from OAM + NWDAF->>OAM: 4. Data collection from OAM + + Note left of NWDAF: 5. Data collection from UPF + NWDAF->>UPF: 5. Data collection from UPF + + Note left of NWDAF: 6. NWDAF subscribes to AF + NWDAF->>AF: 6a. Naf_EventExposure_Subscribe request + AF-->>NWDAF: 6b. Naf_EventExposure_Subscribe response + + Note left of NWDAF: 7. NWDAF receives notifications from AF + AF->>NWDAF: 7a. Naf_EventExposure_Notify request + NWDAF-->>AF: 7b. Naf_EventExposure_Notify response + + Note left of NWDAF: 8. NWDAF subscribes to NEF + NWDAF->>NEF: 8a. Nnef_EventExposure_Subscribe request + NEF->>AF: 8b. Naf_EventExposure_Subscribe request + AF-->>NEF: 8c. Naf_EventExposure_Subscribe response + NEF-->>NWDAF: 8d. Nnef_EventExposure_Subscribe response + + Note left of NWDAF: 9. NWDAF receives notifications from NEF + NEF->>AF: 9a. Naf_EventExposure_Notify request + AF->>NEF: 9b. Nnef_EventExposure_Notify request + NEF-->>AF: 9c. Nnef_EventExposure_Notify response + AF-->>NEF: 9d. Naf_EventExposure_Notify response + + Note left of Service Consumer: 10. NWDAF derives User Data Congestion Analytics + Service Consumer->>NWDAF: 11a. Nnwdaf_AnalyticsInfo_Request response + Service Consumer->>NWDAF: 11b. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>Service Consumer: 11c. Nnwdaf_EventsSubscription_Notify response + + Note left of NWDAF: 12. NWDAF receives notifications from AMF + AMF->>NWDAF: 12a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 12b. Namf_EventExposure_Notify response + + Note left of NWDAF: 13. Data collection from OAM + NWDAF->>OAM: 13. Data collection from OAM + + Note left of NWDAF: 14. Data collection from UPF + NWDAF->>UPF: 14. Data collection from UPF + + Note left of NWDAF: 15. NWDAF receives notifications from AF + AF->>NWDAF: 15a. Naf_EventExposure_Notify request + NWDAF-->>AF: 15b. Naf_EventExposure_Notify response + + Note left of NWDAF: 16. NWDAF receives notifications from NEF + NEF->>AF: 16a. Naf_EventExposure_Notify request + AF->>NEF: 16b. Nnef_EventExposure_Notify request + NEF-->>AF: 16c. Nnef_EventExposure_Notify response + AF-->>NEF: 16d. Naf_EventExposure_Notify response + + Note left of Service Consumer: 17. NWDAF derives User Data Congestion Analytics + Service Consumer->>NWDAF: 18a. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>Service Consumer: 18b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram showing the procedure for User Data Congestion Analytics. Lifelines: Service Consumer, NWDAF, AMF, UPF, NEF, AF, OAM. The diagram illustrates the interaction between these entities to collect and analyze user data congestion analytics. + +Figure 5.7.10-1: Procedure for User Data Congestion Analytics + +- 1a. In order to obtain the User Data Congestion analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is set to "USER\_DATA\_CONGESTION" with the supported feature "UserDataCongestion". + - 1b-1c. In order to obtain the User Data Congestion analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "USER\_DATA\_CONGESTION" with the supported feature "UserDataCongestion". + - 2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to retrieve the UE location information. The AMF responds to the NWDAF an HTTP "201 Created" response. + - 3a-3b. If step 2a and step 2b are performed, the AMF may invoke Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. + 4. The NWDAF may collect "Performance measurement" to the OAM to get the Performance Measurements that will be used by the NWDAF to determine congestion levels. Performance Measurements are related to information transfer over the user plane and/or the control plane (e.g. UE Throughput, DRB Setup Management, RRC Connection Number, PDU Session Management, and Radio Resource Utilization as defined in 3GPP TS 28.552 [27]). The NWDAF may obtain measurements by invoking management services that are defined in 3GPP TS 28.532 [19] and 3GPP TS 28.550 [31]. + 5. The NWDAF may collect data related to User Data Congestion analytics information from UPF. +- NOTE 1: How the NWDAF collects UPF information is not defined in this release of the specification. +- 6a-6b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation to the AF directly by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the data related to User Data Congestion analytics information. The AF responds to the NWDAF an HTTP "201 Created" response. + - 7a-7b. If step 6a and step 6b are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 6a. The NWDAF responds to the AF an HTTP "204 No Content" response. + - 8a-8d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the data related to User Data Congestion analytics information. The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. + - 9a-9d. If step 8a to step 8d are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 8b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +10. The NWDAF calculates the User Data Congestion analytics based on the data collected from AMF, OAM, UPF and/or AF. + - 11a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + - 11b-11c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + - 12a-12b. The same as step 3a and step 3b. + 13. The same as step 4. + 14. The same as step 5. + - 15a-15b. The same as step 7a and step 7b. + +16a-16d. The same as step 9a to step 9d. + +17. The same as step 10. + +18a-18b. The same as step 11b and step 11c. + +NOTE 2: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 3: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 4: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.11 QoS Sustainability Analytics + +This procedure is used by the NWDAF service consumer (maybe an NF, e.g. AF) to obtain the QoS Sustainability analytics, which are calculated by the NWDAF based on the information collected from the OAM, for a path of interest or for an area of interest with coarse granularity (i.e. TAIs or Cell IDs). + +![Sequence diagram illustrating the procedure for QoS Sustainability Analytics. The diagram shows interactions between a Service Consumer, NWDAF, and OAM. The Service Consumer sends requests to the NWDAF (1a, 1b, 1c). The NWDAF then interacts with the OAM (2, 5) to collect data. The NWDAF derives QoS Sustainability Analytics (3, 6) and sends responses/notifications to the Service Consumer (4a, 4b, 4c, 7a, 7b).](5492fadb32a8df1ee9f2528a053c9862_img.jpg) + +``` + +sequenceDiagram + participant Service Consumer + participant NWDAF + participant OAM + + Note right of NWDAF: 3. NWDAF derives QoS Sustainability Analytics + Note right of NWDAF: 6. NWDAF derives QoS Sustainability Analytics + + Service Consumer->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Service Consumer->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>Service Consumer: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF->>OAM: 2. Data collection from OAM + Note right of NWDAF: 3. NWDAF derives QoS Sustainability Analytics + NWDAF-->>Service Consumer: 4a. Nnwdaf_AnalyticsInfo_Request response + NWDAF-->>Service Consumer: 4b. Nnwdaf_EventsSubscription_Notify request + Service Consumer-->>NWDAF: 4c. Nnwdaf_EventsSubscription_Notify response + NWDAF->>OAM: 5. Data collection from OAM + Note right of NWDAF: 6. NWDAF derives QoS Sustainability Analytics + NWDAF-->>Service Consumer: 7a. Nnwdaf_EventsSubscription_Notify request + Service Consumer-->>NWDAF: 7b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram illustrating the procedure for QoS Sustainability Analytics. The diagram shows interactions between a Service Consumer, NWDAF, and OAM. The Service Consumer sends requests to the NWDAF (1a, 1b, 1c). The NWDAF then interacts with the OAM (2, 5) to collect data. The NWDAF derives QoS Sustainability Analytics (3, 6) and sends responses/notifications to the Service Consumer (4a, 4b, 4c, 7a, 7b). + +**Figure 5.7.11-1: Procedure for QoS Sustainability Analytics** + +1a. In order to obtain the QoS sustainability analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is sent to "QOS\_SUSTAINABILITY" with the supported feature "QoSSustainability". + +1b-1c. In order to obtain the QoS sustainability analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "QOS\_SUSTAINABILITY" with the supported feature "QoSSustainability". + +2. The NWDAF may collect "Performance measurement" to the OAM to get the RAN UE Throughput in clause 6.3.6 of 3GPP TS 28.554 [30], QoS flow Retainability information as described in clause 6.5.1 of 3GPP TS 28.554 [30]. If the "QoSSustainabilityExt\_eNA" feature is supported, the NWDAF may collect the average UL/DL packet transmission delay through RAN part to the UE as described in clause 6.3.1.2 of + +3GPP TS 28.554 [30], the UL/DL packet delay on GTP path on N3 for non-GBR traffic, the UL/DL capacity measurement from UPF to NG-RAN or from UE to UPF based on GTP path, and the UL/DL available capacity measurement from UPF to NG-RAN or from UE to UPF based on GTP path as described in clause 5.1 and clause 5.4 of 3GPP TS 28.552 [27]. + +3. The NWDAF calculates the QoS sustainability analytics based on the data collected from OAM. +- 4a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 4b-4c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +5. The same as step 2. +6. The same as step 3. +- 7a-7b. The same as step 4b and step 4c. + +NOTE: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.12 Dispersion Analytics + +This procedure is used by the NWDAF service consumer to obtain the dispersion analytics which are calculated by the NWDAF based on the information collected from the AMF, SMF, UPF and/or AF. + +![Sequence diagram showing interactions between Service Consumer, NWDAF, AMF, SMF, UPF, NEF, and AF. The diagram illustrates various subscription and notification messages for analytics and events.](2f587210e4f97c32758c5972e2e83d20_img.jpg) + +``` + +sequenceDiagram + participant SC as Service Consumer + participant NWDAF as NWDAF + participant AMF as AMF + participant SMF as SMF + participant UPF as UPF + participant NEF as NEF + participant AF as AF + + Note left of SC: 1. NWDAF derives Dispersion Analytics + SC->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + NWDAF-->>SC: 1b. Nnwdaf_EventsSubscription_Subscribe request + SC-->>NWDAF: 1c. Nnwdaf_EventsSubscription_Subscribe response + + Note left of SC: 2. NWDAF derives Dispersion Analytics + NWDAF->>AMF: 2a. Namf_EventExposure_Subscribe request + AMF-->>NWDAF: 2b. Namf_EventExposure_Subscribe response + AMF->>NWDAF: 3a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 3b. Namf_EventExposure_Notify response + + Note left of SC: 4. NWDAF derives Dispersion Analytics + NWDAF->>SMF: 4a. Nsmf_EventExposure_Subscribe request + SMF-->>NWDAF: 4b. Nsmf_EventExposure_Subscribe response + SMF->>NWDAF: 5a. Nsmf_EventExposure_Notify request + NWDAF-->>SMF: 5b. Nsmf_EventExposure_Notify response + + Note left of SC: 6. NWDAF derives Dispersion Analytics + NWDAF->>SMF: 6a1. Nsmf_EventExposure_Subscribe request + SMF->>UPF: 6a2. Nupf_EventExposure_Subscribe request + UPF-->>SMF: 6a3. Nupf_EventExposure_Subscribe response + SMF-->>NWDAF: 6a4. Nsmf_EventExposure_Subscribe response + NWDAF->>UPF: 6b1. Nupf_EventExposure_Subscribe request + UPF-->>NWDAF: 6b2. Nupf_EventExposure_Subscribe response + UPF->>NWDAF: 6c1. Nupf_EventExposure_Notify request + NWDAF-->>UPF: 6c2. Nupf_EventExposure_Notify response + + Note left of SC: 7. NWDAF derives Dispersion Analytics + NWDAF->>AF: 7a. Naf_EventExposure_Subscribe request + AF-->>NWDAF: 7b. Naf_EventExposure_Subscribe response + AF->>NWDAF: 8a. Naf_EventExposure_Notify request + NWDAF-->>AF: 8b. Naf_EventExposure_Notify response + + Note left of SC: 9. NWDAF derives Dispersion Analytics + NWDAF->>NEF: 9a. Nnef_EventExposure_Subscribe request + NEF->>AF: 9b. Naf_EventExposure_Subscribe request + AF-->>NEF: 9c. Naf_EventExposure_Subscribe response + NEF-->>NWDAF: 9d. Nnef_EventExposure_Subscribe response + NEF->>AF: 10a. Naf_EventExposure_Notify request + AF-->>NEF: 10b. Nnef_EventExposure_Notify request + NEF-->>AF: 10c. Nnef_EventExposure_Notify response + AF-->>NEF: 10d. Naf_EventExposure_Notify response + + Note left of SC: 11. NWDAF derives Dispersion Analytics + NWDAF-->>SC: 12a. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>SC: 12b. Nnwdaf_EventsSubscription_Notify request + SC-->>NWDAF: 12c. Nnwdaf_EventsSubscription_Notify response + + Note left of SC: 13. NWDAF derives Dispersion Analytics + NWDAF->>AMF: 13a. Namf_EventExposure_Notify request + AMF-->>NWDAF: 13b. Namf_EventExposure_Notify response + AMF->>NWDAF: 14a. Nsmf_EventExposure_Notify request + NWDAF-->>AMF: 14b. Nsmf_EventExposure_Notify response + + Note left of SC: 15. NWDAF derives Dispersion Analytics + NWDAF->>UPF: 15a. Nupf_EventExposure_Subscribe request + UPF-->>NWDAF: 15b. Nupf_EventExposure_Subscribe response + UPF->>NWDAF: 16a. Naf_EventExposure_Notify request + NWDAF-->>UPF: 16b. Naf_EventExposure_Notify response + + Note left of SC: 17. NWDAF derives Dispersion Analytics + NWDAF->>NEF: 17b. Nnef_EventExposure_Notify request + NEF->>AF: 17a. Naf_EventExposure_Notify request + AF-->>NEF: 17c. Nnef_EventExposure_Notify response + NEF-->>AF: 17d. Naf_EventExposure_Notify response + + Note left of SC: 18. NWDAF derives Dispersion Analytics + NWDAF-->>SC: 19a. Nnwdaf_EventsSubscription_Notify request + SC-->>NWDAF: 19b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram showing interactions between Service Consumer, NWDAF, AMF, SMF, UPF, NEF, and AF. The diagram illustrates various subscription and notification messages for analytics and events. + +###### **Figure 5.7.12-1: Procedure for Dispersion Analytics** + +- 1a. In order to obtain the Dispersion analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is set to "DISPERSION" with the supported feature "Dispersion". +- 1b-1c. In order to obtain the Dispersion analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "DISPERSION" with the supported feature "Dispersion". +- 2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to retrieve the location and/or slice based UE transactions dispersion information. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF may invoke Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to subscribe to the notification of UE transactions dispersion information which may be slice based. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +- 6a-6c. The NWDAF may subscribe to collect UE data volume dispersion information from the serving UPF either via the SMF (by performing steps 6a1, 6a2, 6a3, and 6a4, which are the same as steps 3a, 4a, 4b, and 3b of clause 5.7.17) or directly to the UPF (by performing steps 6b1, 6b2, which are the same as steps 5a and 5b of clause 5.7.17). Then, the UPF may invoke the Nupf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI provided in step 6a1 or step 6b1 and the NWDAF responds to the UPF with an HTTP "204 No Content" response as described in 3GPP TS 29.564 [40]. + +NOTE 1: How the NWDAF collects UPF information is not defined in this release of the specification. + +- 7a-7b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation to the AF directly by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the UE data volume dispersion information. The AF responds to the NWDAF an HTTP "201 Created" response. +- 8a-8b. If step 7a and step 7b are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 7a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 9a-9d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the UE data volume dispersion information. The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 10a-10d. If step 9a to step 9d are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 8b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 9a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +11. The NWDAF calculates the Dispersion analytics based on the data collected from AMF, SMF, UPF and/or AF. +- 12a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 12b-12c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +13a-13b. The same as step 3a and step 3b. + +14a-14b. The same as step 5a and step 5b. + +15a-15b. The same as step 6c1 and step 6c2. + +16a-16b. The same as step 8a and step 8b. + +17a-17d. The same as step 10a to step 10d. + +18. The same as step 11. + +19a-19b. The same as step 12b and step 12c. + +NOTE 2: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 3: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 4: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 5: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.13 WLAN Performance Analytics + +This procedure is used by the NWDAF service consumer to obtain the WLAN performance analytics which are calculated by the NWDAF based on the information collected from the SMF, UPF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram for WLAN Performance Analytics procedure involving Service Consumer, NWDAF, SMF, UPF, and OAM.](4806f9f95fff13a30d6523bd6ffeac63_img.jpg) + +``` + +sequenceDiagram + participant SC as Service Consumer + participant NWDAF + participant SMF + participant UPF + participant OAM + + Note right of NWDAF: 6. NWDAF derives WLAN Performance Analytics + + Note right of NWDAF: 11. NWDAF derives WLAN Performance Analytics + + SC->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + SC->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>SC: 1c. Nnwdaf_EventsSubscription_Subscribe response + + NWDAF->>SMF: 2a. Nsmf_EventExposure_Subscribe request + SMF-->>NWDAF: 2b. Nsmf_EventExposure_Subscribe response + + NWDAF->>SMF: 3a. Nsmf_EventExposure_Notify request + SMF-->>NWDAF: 3b. Nsmf_EventExposure_Notify response + + NWDAF->>SMF: 4a1. Nsmf_EventExposure_Subscribe request + SMF->>UPF: 4a2. Nupf_EventExposure_Subscribe request + UPF-->>SMF: 4a3. Nupf_EventExposure_Subscribe response + SMF-->>NWDAF: 4a4. Nsmf_EventExposure_Subscribe response + + NWDAF->>UPF: 4b1. Nupf_EventExposure_Subscribe request + UPF-->>NWDAF: 4b2. Nupf_EventExposure_Subscribe response + + NWDAF->>UPF: 4c1. Nupf_EventExposure_Notify request + UPF-->>NWDAF: 4c2. Nupf_EventExposure_Notify response + + NWDAF->>OAM: 5. Data collection from OAM + + Note right of NWDAF: 6. NWDAF derives WLAN Performance Analytics + + SC->>NWDAF: 7a. Nnwdaf_AnalyticsInfo_Request response + SC->>NWDAF: 7b. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>SC: 7c. Nnwdaf_EventsSubscription_Notify response + + NWDAF->>SMF: 8a. Nsmf_EventExposure_Notify request + SMF-->>NWDAF: 8b. Nsmf_EventExposure_Notify response + + NWDAF->>UPF: 9a. Nupf_EventExposure_Notify request + UPF-->>NWDAF: 9b. Nupf_EventExposure_Notify response + + NWDAF->>OAM: 10. Data collection from OAM + + Note right of NWDAF: 11. NWDAF derives WLAN Performance Analytics + + SC->>NWDAF: 12a. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>SC: 12b. Nnwdaf_EventsSubscription_Notify response + +``` + +The sequence diagram illustrates the procedure for WLAN Performance Analytics. It involves five main participants: Service Consumer, NWDAF, SMF, UPF, and OAM. The process begins with the Service Consumer sending three initial messages to the NWDAF: 1a. Nnwdaf\_AnalyticsInfo\_Request request, 1b. Nnwdaf\_EventsSubscription\_Subscribe request, and 1c. Nnwdaf\_EventsSubscription\_Subscribe response. The NWDAF then interacts with the SMF via 2a. Nsmf\_EventExposure\_Subscribe request and 2b. Nsmf\_EventExposure\_Subscribe response. It also receives 3a. Nsmf\_EventExposure\_Notify request and 3b. Nsmf\_EventExposure\_Notify response from the SMF. The NWDAF sends 4a1. Nsmf\_EventExposure\_Subscribe request to the SMF, which in turn sends 4a2. Nupf\_EventExposure\_Subscribe request to the UPF, receiving 4a3. Nupf\_EventExposure\_Subscribe response. The SMF then sends 4a4. Nsmf\_EventExposure\_Subscribe response to the NWDAF. The NWDAF sends 4b1. Nupf\_EventExposure\_Subscribe request to the UPF, receiving 4b2. Nupf\_EventExposure\_Subscribe response. It also sends 4c1. Nupf\_EventExposure\_Notify request to the UPF, receiving 4c2. Nupf\_EventExposure\_Notify response. The NWDAF performs data collection from the OAM (5. Data collection from OAM). A note indicates that the NWDAF derives WLAN Performance Analytics (6. NWDAF derives WLAN Performance Analytics). The Service Consumer receives 7a. Nnwdaf\_AnalyticsInfo\_Request response, sends 7b. Nnwdaf\_EventsSubscription\_Notify request, and receives 7c. Nnwdaf\_EventsSubscription\_Notify response. The NWDAF sends 8a. Nsmf\_EventExposure\_Notify request to the SMF, receiving 8b. Nsmf\_EventExposure\_Notify response. It also sends 9a. Nupf\_EventExposure\_Notify request to the UPF, receiving 9b. Nupf\_EventExposure\_Notify response. The NWDAF performs another data collection from the OAM (10. Data collection from OAM). Another note indicates that the NWDAF derives WLAN Performance Analytics (11. NWDAF derives WLAN Performance Analytics). Finally, the Service Consumer sends 12a. Nnwdaf\_EventsSubscription\_Notify request and receives 12b. Nnwdaf\_EventsSubscription\_Notify response from the NWDAF. + +Sequence diagram for WLAN Performance Analytics procedure involving Service Consumer, NWDAF, SMF, UPF, and OAM. + +Figure 5.7.13-1: Procedure for WLAN Performance Analytics + +- 1a. In order to obtain the WLAN performance analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is set to "WLAN\_PERFORMANCE" with the supported feature "WlanPerformance". +- 1b-1c. In order to obtain the WLAN performance analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "WLAN\_PERFORMANCE" with the supported feature "WlanPerformance". +- 2a-2b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to subscribe to the notification of Information on PDU Session for WLAN. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 2a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +4. The NWDAF may subscribe to collect UE communications information for WLAN from the UPF either via the SMF (by performing steps 6a1, 6a2, 6a3, and 6a4, which are the same as steps 3a, 4a, 4b, and 3b of clause 5.7.17) or directly to the UPF (by performing steps 6b1, 6b2, which are the same as steps 5a and 5b of clause 5.7.17). Then, the UPF may invoke the Nupf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI provided in step 6a1 or step 6b1 and the NWDAF responds to the UPF with an HTTP "204 No Content" response as described in 3GPP TS 29.564 [40]. +5. The NWDAF may collect WLAN measurement results from the OAM. The WLAN measurement data from OAM is collected via MDT and aligned with the WLAN measurement reporting list described in clause 5.1.1.3.3 of TS 37.320 [29]. +6. The NWDAF calculates the WLAN performance analytics based on the data collected from SMF, UPF and/or OAM. +- 7a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 7b-7c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 8a-8b. The same as step 3a and step 3b. +- 9a-9b. The same as step 4c1 and step 6c2. +10. The same as step 5. +11. The same as step 6. +- 12a-12b. The same as step 7b and step 7c. + +NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 2: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.14 Session Management Congestion Control Experience Analytics + +This procedure is used by the NWDAF service consumer e.g. SMF to obtain the Session Management Congestion Control Experience Analytics which are calculated by the NWDAF based on the information collected from the SMF. + +![Sequence diagram illustrating the procedure for Session Management Congestion Control Experience Analytics. The diagram shows interactions between Service Consumer, NWDAF, and SMF. The Service Consumer sends requests to the NWDAF. The NWDAF then sends a subscribe request to the SMF. The SMF responds, and the NWDAF derives analytics. Finally, the NWDAF sends responses and notifications back to the Service Consumer.](9c45844d796e85ae05505870a54e4eb4_img.jpg) + +``` + +sequenceDiagram + participant SC as Service Consumer + participant NWDAF as NWDAF + participant SMF as SMF + + Note right of NWDAF: 4. NWDAF derives Session Management Congestion Control Experience Analytics + + SC->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + SC->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>SC: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF->>SMF: 2a. Nsmf_EventExposure_Subscribe request + SMF-->>NWDAF: 2b. Nsmf_EventExposure_Subscribe response + SMF->>NWDAF: 3a. Nsmf_EventExposure_Notify request + NWDAF-->>SMF: 3b. Nsmf_EventExposure_Notify response + Note right of NWDAF: 4. NWDAF derives Session Management Congestion Control Experience Analytics + NWDAF-->>SC: 5a. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>SC: 5b. Nnwdaf_EventsSubscription_Notify request + SC-->>NWDAF: 5c. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram illustrating the procedure for Session Management Congestion Control Experience Analytics. The diagram shows interactions between Service Consumer, NWDAF, and SMF. The Service Consumer sends requests to the NWDAF. The NWDAF then sends a subscribe request to the SMF. The SMF responds, and the NWDAF derives analytics. Finally, the NWDAF sends responses and notifications back to the Service Consumer. + +**Figure 5.7.14-1: Procedure for Session Management Congestion Control Experience Analytics** + +- 1a. In order to obtain the SMCCE (Session Management Congestion Control Experience) analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is set to "SM\_CONGESTION" with the supported feature "SMCCE". +- 1b-1c. In order to obtain the SMCCE (Session Management Congestion Control Experience) analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "SM\_CONGESTION" with the supported feature "SMCCE". +- 2a-2b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to subscribe to the notification of Information on UE ID and SMCC experience for PDU Session. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 2a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +4. The NWDAF calculates the Session Management Congestion Control Experience analytics based on the data collected from SMF. +- 5a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 5b-5c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 2: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify and Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.15 Redundant Transmission Experience Analytics + +This procedure is used by the NWDAF service consumer (may be an NF e.g. SMF) to obtain the Redundant Transmission Experience Analytics which are calculated by the NWDAF based on the information collected from the AMF, AF, SMF, UPF OAM and/or MDAF. + +![Sequence diagram showing the procedure for Redundant Transmission Experience Analytics. Lifelines: Service Consumer, NWDAF, AMF, SMF, UPF, NEF, AF, OAM, MDAF. The diagram illustrates the flow of requests and responses for analytics collection, including steps for deriving redundant transmission experience analytics at the NWDAF.](49fe8fe978c0f7e73112d231feb377eb_img.jpg) + +``` + +sequenceDiagram + participant SC as Service Consumer + participant NWDAF as NWDAF + participant AMF as AMF + participant SMF as SMF + participant UPF as UPF + participant NEF as NEF + participant AF as AF + participant OAM as OAM + participant MDAF as MDAF + + Note left of SC: 12. NWDAF derives Redundant Transmission Experience Analytics + Note left of SC: 20. NWDAF derives Redundant Transmission Experience Analytics + + Note right of NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Note right of NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note right of NWDAF: 1c. Nnwdaf_EventsSubscription_Subscribe response + Note right of NWDAF: 2a. Namf_EventExposure_Subscribe request + Note right of NWDAF: 2b. Namf_EventExposure_Subscribe response + Note right of NWDAF: 3a. Namf_EventExposure_Notify request + Note right of NWDAF: 3b. Namf_EventExposure_Notify response + Note right of NWDAF: 4a. Nsmf_EventExposure_Subscribe request + Note right of NWDAF: 4b. Nsmf_EventExposure_Subscribe response + Note right of NWDAF: 5a. Nsmf_EventExposure_Notify request + Note right of NWDAF: 5b. Nsmf_EventExposure_Notify response + Note right of NWDAF: 6a1. Nsmf_EventExposure_Subscribe request + Note right of AMF: 6a2. Nupf_EventExposure_Subscribe request + Note right of UPF: 6a3. Nupf_EventExposure_Subscribe response + Note right of NWDAF: 6a4. Nsmf_EventExposure_Subscribe response + Note right of NWDAF: 6b1. Nupf_EventExposure_Subscribe request + Note right of UPF: 6b2. Nupf_EventExposure_Subscribe response + Note right of NWDAF: 6c1. Nupf_EventExposure_Notify request + Note right of UPF: 6c2. Nupf_EventExposure_Notify response + Note right of NWDAF: 7a. Data collection from OAM + Note right of NWDAF: 7b. Data collection from MDAF + Note right of NWDAF: 8a. Naf_EventExposure_Subscribe request + Note right of AF: 8b. Naf_EventExposure_Subscribe response + Note right of NWDAF: 9a. Naf_EventExposure_Notify request + Note right of AF: 9b. Naf_EventExposure_Notify response + Note right of NWDAF: 10a. Nnef_EventExposure_Subscribe request + Note right of NEF: 10b. Naf_EventExposure_Subscribe request + Note right of AF: 10c. Naf_EventExposure_Subscribe response + Note right of NWDAF: 10d. Nnef_EventExposure_Subscribe response + Note right of NEF: 11a. Naf_EventExposure_Notify request + Note right of NWDAF: 11b. Nnef_EventExposure_Notify request + Note right of NEF: 11c. Nnef_EventExposure_Notify response + Note right of AF: 11d. Naf_EventExposure_Notify response + Note right of NWDAF: 13a. Nnwdaf_AnalyticsInfo_Request response + Note right of NWDAF: 13b. Nnwdaf_EventsSubscription_Notify request + Note right of NWDAF: 13c. Nnwdaf_EventsSubscription_Notify response + Note right of NWDAF: 14a. Namf_EventExposure_Notify request + Note right of AMF: 14b. Namf_EventExposure_Notify response + Note right of NWDAF: 15a. Nsmf_EventExposure_Notify request + Note right of SMF: 15b. Nsmf_EventExposure_Notify response + Note right of NWDAF: 16a. Nupf_EventExposure_Notify request + Note right of UPF: 16b. Nupf_EventExposure_Notify response + Note right of NWDAF: 17. Data collection from OAM + Note right of NWDAF: 18a. Naf_EventExposure_Notify request + Note right of AF: 18b. Naf_EventExposure_Notify response + Note right of NWDAF: 19a. Naf_EventExposure_Notify request + Note right of NEF: 19b. Nnef_EventExposure_Notify request + Note right of NEF: 19c. Nnef_EventExposure_Notify response + Note right of AF: 19d. Naf_EventExposure_Notify response + Note right of NWDAF: 21a. Nnwdaf_EventsSubscription_Notify request + Note right of NWDAF: 21b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram showing the procedure for Redundant Transmission Experience Analytics. Lifelines: Service Consumer, NWDAF, AMF, SMF, UPF, NEF, AF, OAM, MDAF. The diagram illustrates the flow of requests and responses for analytics collection, including steps for deriving redundant transmission experience analytics at the NWDAF. + +Figure 5.7.15-1: Procedure for Redundant Transmission Experience Analytics + +- 1a. In order to obtain the Redundant Transmission Experience Analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1, the requested event is set to "RED\_TRANS\_EXP" with the supported feature "RedundantTransmissionExp". +- 1b-1c. In order to obtain the Redundant Transmission Experience Analytics, the NWDAF service consumer may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1, the subscribed event is set to "RED\_TRANS\_EXP" with the supported feature "RedundantTransmissionExp". +- 2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to retrieve the UE Mobility information. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF may invoke Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to subscribe to the notification of Information related to PDU Session established with redundant transmission. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +6. The NWDAF may collect data related to packet delay measurement information from UPF either via the SMF (by performing steps 6a1, 6a2, 6a3, and 6a4, which are the same as steps 3a, 4a, 4b, and 3b of clause 5.7.17) or directly to the UPF (by performing steps 6b1, 6b2, which are the same as steps 5a and 5b of clause 5.7.17). Then, the UPF may invoke the Nupf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI provided in step 6a1 or step 6b1 and the NWDAF responds to the UPF with an HTTP "204 No Content" response as described in 3GPP TS 29.564 [40]. +- 7a. The NWDAF may collect "Performance measurement" to the OAM to get the UL/DL packet drop rate on GTP path on N3, UL/DL packet delay measurement on GTP path on N3 and/or UL/DL packet drop/loss rate of RAN part measurement refer to clause 5.1 of TS 28.552 [27] for the performance measurement in NG-RAN. +- 7b. The NWDAF may collect end-to-end analysis as specified in clause 8.4.2.4.3 of TS 28.104 [38] from MDAF. The information element of the analysis from MDAF include E2ELatencyIssueType and AffectedObjects. +- 8a-8b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation to the AF directly by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the service data related to UE mobility information. The AF responds to the NWDAF an HTTP "201 Created" response. +- 9a-9b. If step 8a and step 8b are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 10a-10d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the service data related to UE mobility information. The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 11a-11d. If step 10a to step 10d are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 10b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 10a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +12. The NWDAF calculates the Redundant Transmission Experience Analytics based on the data collected from AMF, AF SMF, UPF OAM and/or MDAF. + +- 13a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 13b-13c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 14a-14b. The same as step 3a and step 3b. +- 15a-15b. The same as step 5a and step 5b. +- 16a-16b. The same as step 6c1 and step 6c2. +17. The same as step 7. +- 18a-18b. The same as step 9a and step 9b. +- 19a-19d. The same as step 11a and step 11d. +20. The same as step 12. +- 21a-21b. The same as step 13b and step 13c. + +NOTE 1: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 2: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 3: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.16 DN Performance Analytics + +This procedure is used by the NF to obtain DN performance analytics, which is calculated by the NWDAF based on the information collected from the AMF, SMF, AF, UPF and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram for DN Performance Analytics procedure. Lifelines: NF, NWDAF, AMF, SMF, NEF, AF, UPF, OAM. The diagram shows the interaction between these entities to collect and derive DN performance analytics. Steps include service requests (Nnwdaf_AnalyticsInfo_Request, Nnwdaf_EventsSubscription_Subscribe), event exposures (Namf_EventExposure, Nsmf_EventExposure), data collection from UPF and OAM, and final analytics derivation and notification.](f61d0925551545b5938b3a4d1bbf63c3_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant SMF + participant NEF + participant AF + participant UPF + participant OAM + + Note left of NF: 1a. Nnwdaf_AnalyticsInfo_Request request + NF-->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Note left of NF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NF-->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note left of NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF-->>NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + Note left of NWDAF: 2a. Namf_EventExposure_Subscribe request + NWDAF-->>AMF: 2a. Namf_EventExposure_Subscribe request + Note left of NWDAF: 2b. Namf_EventExposure_Subscribe response + AMF-->>NWDAF: 2b. Namf_EventExposure_Subscribe response + Note left of NWDAF: 3a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 3a. Namf_EventExposure_Notify request + Note left of NWDAF: 3b. Namf_EventExposure_Notify response + AMF-->>NWDAF: 3b. Namf_EventExposure_Notify response + Note left of NWDAF: 4a. Nsmf_EventExposure_Subscribe request + NWDAF-->>SMF: 4a. Nsmf_EventExposure_Subscribe request + Note left of NWDAF: 4b. Nsmf_EventExposure_Subscribe response + SMF-->>NWDAF: 4b. Nsmf_EventExposure_Subscribe response + Note left of NWDAF: 5a. Nsmf_EventExposure_Notify request + NWDAF-->>SMF: 5a. Nsmf_EventExposure_Notify request + Note left of NWDAF: 5b. Nsmf_EventExposure_Notify response + SMF-->>NWDAF: 5b. Nsmf_EventExposure_Notify response + + Note right of NWDAF: 6. NWDAF collects data as described in clause 5.7.7 from step 6a to step 9d + Note right of NWDAF: 7. NWDAF collects data from UPF + NWDAF-->>UPF: 7. NWDAF collects data from UPF + Note right of NWDAF: 8. Data collection from OAM + NWDAF-->>OAM: 8. Data collection from OAM + + Note left of NF: 9. NWDAF derives DN Performance Analytics + Note left of NF: 10a. Nnwdaf_AnalyticsInfo_Request response + NWDAF-->>NF: 10a. Nnwdaf_AnalyticsInfo_Request response + Note left of NF: 10b. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>NF: 10b. Nnwdaf_EventsSubscription_Notify request + Note left of NF: 10c. Nnwdaf_EventsSubscription_Notify response + NF-->>NWDAF: 10c. Nnwdaf_EventsSubscription_Notify response + + Note left of NWDAF: 11a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 11a. Namf_EventExposure_Notify request + Note left of NWDAF: 11b. Namf_EventExposure_Notify response + AMF-->>NWDAF: 11b. Namf_EventExposure_Notify response + Note left of NWDAF: 12a. Nsmf_EventExposure_Notify request + NWDAF-->>SMF: 12a. Nsmf_EventExposure_Notify request + Note left of NWDAF: 12b. Nsmf_EventExposure_Notify response + SMF-->>NWDAF: 12b. Nsmf_EventExposure_Notify response + + Note right of NWDAF: 13. NWDAF collects data as described in clause 5.7.7 from step 14a to step 15d + Note left of NF: 14. NWDAF derives DN Performance Analytics + Note left of NF: 15a. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>NF: 15a. Nnwdaf_EventsSubscription_Notify request + Note left of NF: 15b. Nnwdaf_EventsSubscription_Notify response + NF-->>NWDAF: 15b. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for DN Performance Analytics procedure. Lifelines: NF, NWDAF, AMF, SMF, NEF, AF, UPF, OAM. The diagram shows the interaction between these entities to collect and derive DN performance analytics. Steps include service requests (Nnwdaf\_AnalyticsInfo\_Request, Nnwdaf\_EventsSubscription\_Subscribe), event exposures (Namf\_EventExposure, Nsmf\_EventExposure), data collection from UPF and OAM, and final analytics derivation and notification. + +Figure 5.7.16-1: Procedure for DN Performance Analytics + +1a. In order to obtain the DN performance analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +1b-1c. In order to obtain the DN performance analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. + +2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to retrieve the UE location information and SUPI(s) from AMF. The AMF responds to the NWDAF an HTTP "201 Created" response. + +3a-3b. If step 2a and step 2b are performed, the AMF may invoke Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. + +4a-4b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to request DNN, S-NSSAI, application ID, UPF info, DNAI, IP filter information and QFI. The SMF responds to the NWDAF an HTTP "201 Created" response. + +5a-5b. If step 4a and step 4b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the SMF an HTTP "204 No Content" response. + +6. The NWDAF may collect performance data from AF as described in clause 5.7.7 from step 6a to step 9d. + +7. The NWDAF may collect QoS flow bit rate, QoS flow packet delay, packet transmission and packet retransmission information from UPF. + +NOTE 1: How NWDAF collects UE communication related data from UPF is not defined in this Release of the specification. + +8. The NWDAF may collect Reference Signal Received Power and Reference Signal Received Quality as specified in clause 5.5 of TS 38.331 [33] and clause 5.5.5 of TS 36.331 [34], Signal-to-noise and interference ratio as specified in clause 5.1 of TS 38.215 [35], the mapping information between cell ID and frequency and Cell Energy Saving State data as specified in clauses 3.1 and 6.2 of TS 28.310 [36] from OAM. + +9. The NWDAF calculates the DN performance analytics based on the data collected from AMF, SMF, AF, UPF and/or OAM. + +10a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +10b-10c. If step 1b and step 1c are performed, the NWDAF may invoke Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +11a-11b. The same as step 3a and step 3b. + +12a-12b. The same as step 5a and step 5b. + +13. The same as step 6. + +14. The same as step 9. + +15a-15b. The same as step 10b and step 10c. + +NOTE 2: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 3: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.17 PFD Determination Analytics + +This procedure is used by the NWDAF service consumer e.g. NEF(PFDF) to obtain PFD determination analytics for the know application(s), which is calculated by the NWDAF based on the information collected from the UPF and the NEF(PFDF). + +![Sequence diagram for PFD Determination Analytics procedure. Lifelines: Consumer (NEF(PFDF)), NWDAF, SMF, UPF. The diagram shows two main paths for data collection: Option 1 (Indirect subscription via SMF) and Option 2 (Direct subscription).](38d82ffe820e339811b396206f40a201_img.jpg) + +``` + +sequenceDiagram + participant Consumer as Consumer (NEF(PFDF)) + participant NWDAF + participant SMF + participant UPF + + Note left of Consumer: 1a. Nnwdaf_AnalyticsInfo_Request request + Consumer->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + Note left of Consumer: 1b. Nnwdaf_EventsSubscription_Subscribe request + Consumer->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note left of Consumer: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF-->>Consumer: 1c. Nnwdaf_EventsSubscription_Subscribe response + Note left of Consumer: 2a. Nnef_PFDManagement_Fetch request + Consumer->>NWDAF: 2a. Nnef_PFDManagement_Fetch request + Note left of Consumer: 2b. Nnef_PFDManagement_Fetch response + NWDAF-->>Consumer: 2b. Nnef_PFDManagement_Fetch response + + Note right of NWDAF: 3. Determine whether it needs to collect data and then select the related SMF/UPF + NWDAF->>NWDAF: 3. Determine whether it needs to collect data and then select the related SMF/UPF + + Note right of NWDAF: Option 1: Indirect subscription via SMF + Note right of NWDAF: 3a. Nsmf_EventExposure_Subscribe request + NWDAF->>SMF: 3a. Nsmf_EventExposure_Subscribe request + Note right of SMF: 4a. Nupf_EventExposure_Subscribe request + SMF->>UPF: 4a. Nupf_EventExposure_Subscribe request + Note right of SMF: 4b. Nupf_EventExposure_Subscribe response + UPF-->>SMF: 4b. Nupf_EventExposure_Subscribe response + Note right of NWDAF: 3b. Nsmf_EventExposure_Subscribe response + SMF-->>NWDAF: 3b. Nsmf_EventExposure_Subscribe response + + Note right of NWDAF: Option 2: Direct subscription + Note right of NWDAF: 5a. Nupf_EventExposure_Subscribe request + NWDAF->>UPF: 5a. Nupf_EventExposure_Subscribe request + Note right of NWDAF: 5b. Nupf_EventExposure_Subscribe response + UPF-->>NWDAF: 5b. Nupf_EventExposure_Subscribe response + + Note right of NWDAF: 6a. Nupf_EventExposure_Notify request + NWDAF->>UPF: 6a. Nupf_EventExposure_Notify request + Note right of NWDAF: 6b. Nupf_EventExposure_Notify response + UPF-->>NWDAF: 6b. Nupf_EventExposure_Notify response + + Note right of NWDAF: 7. NWDAF derives PFD Determination Analytics + NWDAF->>NWDAF: 7. NWDAF derives PFD Determination Analytics + + Note left of Consumer: 8a. Nnwdaf_AnalyticsInfo_Request response + NWDAF-->>Consumer: 8a. Nnwdaf_AnalyticsInfo_Request response + Note left of Consumer: 8b. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>Consumer: 8b. Nnwdaf_EventsSubscription_Notify request + Note left of Consumer: 8c. Nnwdaf_EventsSubscription_Notify response + Consumer-->>NWDAF: 8c. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for PFD Determination Analytics procedure. Lifelines: Consumer (NEF(PFDF)), NWDAF, SMF, UPF. The diagram shows two main paths for data collection: Option 1 (Indirect subscription via SMF) and Option 2 (Direct subscription). + +**Figure 5.7.17-1: Procedure for PFD Determination Analytics** + +- 1a. In order to obtain the PFD determination analytics, the consumer NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to obtain the PFD determination analytics, the consumer NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a-2b. The NWDAF invokes Nnef\_PFDManagement\_Fetch service operation as described in clause 4.2.2 of 3GPP TS 29.551 [39] by sending an HTTP POST request targeting the resource "Individual application PFD" to retrieve PFDs for an Application Identifier(s) from the NEF (PFDF). The NEF (PFDF) responds to the NWDAF an HTTP "200 OK" response, with the content containing a representation of an "Individual application PFD" resource or a "PFD of applications" resource for the requested application identifier(s). +3. The NWDAF determines whether it needs to collect data and, if needed, it collects the data either directly from the UPF or indirectly via the SMF and identifies the SMF(s) and/or UPF(s) to retrieve the data. + +- 3a-3b. [Option 1] The NWDAF invokes Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to retrieve the IP flow related information for the application. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 4a-4b. The SMF invokes Nupf\_EventExposure\_Subscribe service operation as described in clause 5.2.2.2 of 3GPP TS 29.564 [40] to retrieve the IP flow related information for the application from UPF. The UPF responds to the SMF an HTTP "201 Created" response. +- 5a-5b. [Option 2] The NWDAF directly invokes Nupf\_EventExposure\_Subscribe service operation as described in clause 5.2.2.2 of 3GPP TS 29.564 [40] to retrieve the IP flow related information for the application from UPF. The UPF responds to the NWDAF an HTTP "201 Created" response. +- 6a-6b. The UPF invokes Nupf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a or step 5a. The NWDAF responds to the UPF an HTTP "204 No Content" response. +7. The NWDAF calculates the PFD determination analytics based on the data collected from UPF and NEF (PFDf). +- 8a. If step 1a is performed, the NWDAF sends the Nnwdaf\_AnalyticsInfo\_Request response as described in clause 5.2.3.1, with HTTP "204 No Content" response if the NWDAF decides no PFD data to be updated or newly reported; or with HTTP "200 OK" response containing the PFD determination analytics in the case that the NWDAF decides the PFD information for the existing Application ID is new or to be updated. +- 8b-8c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1 containing the PFD determination analytics information in the case that the NWDAF decides the PFD information for the existing Application ID is new or to be updated. +- NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. +- NOTE 2: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. +- NOTE 3: For details of Nnef\_PFDManagement\_Fetch service operation refer to 3GPP TS 29.551 [39]. +- NOTE 4: For details of Nupf\_EventExposure\_Subscribe/Unsubscribe/Notify service operations refer to 3GPP TS 29.564 [40]. + +### 5.7.18 E2E data volume transfer time analytics + +This procedure is used by the NWDAF service consumer (may be an NF e.g. AF or NEF) to obtain E2E (end-to-end) data volume transfer time analytics, which is calculated by the NWDAF based on the information collected from the AMF, SMF, AF, and/or OAM. If the NF is an AF which is untrusted, the AF will request analytics via the NEF as described in clause 5.2.3.2. + +![Sequence diagram for E2E data volume transfer time analytics procedure. Lifelines: NF, NWDAF, AMF, SMF, NEF, AF, OAM. The procedure involves multiple steps of requests and responses between these entities to collect data and derive analytics.](1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant SMF + participant NEF + participant AF + participant OAM + + Note left of NF: 11. NWDAF derives End-to-end data volume transfer Analytics + + NF->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + NWDAF-->>NF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NF-->>NWDAF: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF->>AMF: 2a. Namf_EventExposure_Subscribe request + AMF-->>NWDAF: 2b. Namf_EventExposure_Subscribe response + NWDAF->>AMF: 3a. Namf_EventExposure_Notify request + AMF-->>NWDAF: 3b. Namf_EventExposure_Notify response + NWDAF->>SMF: 4a. Nsmf_EventExposure_Subscribe request + SMF-->>NWDAF: 4b. Nsmf_EventExposure_Subscribe response + NWDAF->>SMF: 5a. Nsmf_EventExposure_Notify request + SMF-->>NWDAF: 5b. Nsmf_EventExposure_Notify response + NWDAF->>AF: 6a. Naf_EventExposure_Subscribe request + AF-->>NWDAF: 6b. Naf_EventExposure_Subscribe response + NWDAF->>AF: 7a. Naf_EventExposure_Notify request + AF-->>NWDAF: 7b. Naf_EventExposure_Notify response + NWDAF->>NEF: 8a. Nnef_EventExposure_Subscribe request + NEF->>AF: 8b. Naf_EventExposure_Subscribe request + AF-->>NEF: 8c. Naf_EventExposure_Subscribe response + NEF-->>NWDAF: 8d. Nnef_EventExposure_Subscribe response + NEF->>AF: 9a. Naf_EventExposure_Notify request + NWDAF->>NEF: 9b. Nnef_EventExposure_Notify request + NEF-->>NWDAF: 9c. Nnef_EventExposure_Notify response + NEF-->>AF: 9d. Naf_EventExposure_Notify response + AF->>OAM: 10. Data collection from OAM + OAM-->>AF: + Note left of NF: 11. NWDAF derives End-to-end data volume transfer Analytics + NF-->>NWDAF: 12a. Nnwdaf_AnalyticsInfo_Request response + NF-->>NWDAF: 12b. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>NF: 12c. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for E2E data volume transfer time analytics procedure. Lifelines: NF, NWDAF, AMF, SMF, NEF, AF, OAM. The procedure involves multiple steps of requests and responses between these entities to collect data and derive analytics. + +**Figure 5.7.17-1: Procedure for E2E data volume transfer time analytics** + +1a. In order to obtain the E2E data volume transfer time analytics, the NWDAF service consumer may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +1b-1c. In order to obtain the E2E data volume transfer time analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. + +- 2a-2b. The NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to retrieve the UE location information and SUPI(s) from AMF. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF may invoke Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to request DNN, S-NSSAI, application ID, QoS flow packet delay, and QFI. The SMF responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the SMF may invoke Nsmf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the SMF an HTTP "204 No Content" response. +- 6a-6b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation to the AF directly by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the End-to-end data volume transfer time information. The AF responds to the NWDAF an HTTP "201 Created" response. +- 7a-7b. If step 6a and step 6b are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 7a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 8a-8d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to collect the E2E data volume transfer time information. The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 9a-9d. If step 8a to step 8d are performed, the AF invokes Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 8b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 9a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +10. The NWDAF may collect RAN part delay in clause 6.3.1.2, and 6.3.1.7 of TS 28.554 [30], RAN Throughput for DL and UL in clauses 5.2.1.1 and 5.4.1.1 of TS 37.320 [29], RAN Packet delay for DL and UL per QCI per UE packet delay as specified in clauses 5.2.1.1 of TS 37.320 [29] and and per DRB per UE packet delay as specified in clauses 5.4.1.1 of TS 37.320 [29]. RAN Packet loss rate for DL and UL including the per QCI per UE packet loss rate as specified in clauses 5.2.1.1 of TS 37.320 [29] and the per DRB per UE packet loss rate as specified in clauses 5.4.1.1 of TS 37.320 [29], the distribution of UL/DL/round trip packet delay between PSA UPF and UE as captured in TS 28.552 [27]. from OAM. +11. The NWDAF calculates the End-to-end data volume transfer time analytics based on the data collected from AMF, SMF, AF, and/or OAM. +- 12a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 12b-12c. If step 1b and step 1c are performed, the NWDAF may invoke Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +NOTE 1: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +NOTE 2: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +NOTE 3: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 4: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +### 5.7.19 PDU Session Traffic Analytics + +This procedure is used by the NWDAF service consumer (e.g. PCF) to subscribe or request PDU Session Traffic analytics statistics on whether traffic of UEs via one or multiple PDU sessions is according to the information provided by the service consumer. + +![Sequence diagram illustrating the procedure for PDU Session Traffic Analytics. The diagram shows interactions between NWDAF service consumer, NWDAF, SMF, and UPF. The process starts with the service consumer sending requests to the NWDAF. The NWDAF then determines the data source and either subscribes indirectly via the SMF or directly to the UPF. The UPF provides data to the SMF, which then provides it to the NWDAF. Finally, the NWDAF derives the analytics and responds to the service consumer.](a4eb9fe011f0e6dc8405f777c5f3f766_img.jpg) + +``` + +sequenceDiagram + participant SC as NWDAF service consumer + participant NWDAF + participant SMF + participant UPF + + Note right of NWDAF: 2. Determine whether it needs to collect data and then select the related SMF/UPF + + Note right of NWDAF: Option 1: Indirect subscription via SMF + Note right of NWDAF: Option 2: Direct subscription + + Note right of NWDAF: 7. NWDAF derives PDU Session Traffic analytics + + SC->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + SC->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>SC: 1c. Nnwdaf_EventsSubscription_Subscribe response + + NWDAF->>SMF: 3a. Nsmf_EventExposure_Subscribe request + Note right of SMF: 4a. Nupf_EventExposure_Subscribe request + Note right of SMF: 4b. Nupf_EventExposure_Subscribe response + SMF-->>NWDAF: 3b. Nsmf_EventExposure_Subscribe response + + Note right of NWDAF: 5a. Nupf_EventExposure_Subscribe request + Note right of NWDAF: 5b. Nupf_EventExposure_Subscribe response + + Note right of NWDAF: 6a. Nupf_EventExposure_Notify request + Note right of NWDAF: 6b. Nupf_EventExposure_Notify response + + NWDAF-->>SC: 8a. Nnwdaf_AnalyticsInfo_Request response + NWDAF-->>SC: 8b. Nnwdaf_EventsSubscription_Notify request + NWDAF-->>SC: 8c. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram illustrating the procedure for PDU Session Traffic Analytics. The diagram shows interactions between NWDAF service consumer, NWDAF, SMF, and UPF. The process starts with the service consumer sending requests to the NWDAF. The NWDAF then determines the data source and either subscribes indirectly via the SMF or directly to the UPF. The UPF provides data to the SMF, which then provides it to the NWDAF. Finally, the NWDAF derives the analytics and responds to the service consumer. + +**Figure 5.7.19-1: Procedure for PDU Session Traffic Analytics** + +1a. In order to obtain the PDU Session Traffic analytics, the NWDAF service consumer (e.g. PCF) may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +1b-1c. In order to obtain the PDU Session Traffic analytics, the NWDAF service consumer (e.g. PCF) may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. + +2. The NWDAF determines whether it needs to collect the data and, if needed, it collects the data either directly from the UPF or indirectly via the SMF and identifies the SMF(s) and/or UPF(s) to retrieve the data. + +3a-3b. [Option 1] The NWDAF invokes Nsmf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "SMF Notification Subscriptions" to retrieve "UserDataUsageMeasures" UPF event for the S-NSSAI/DNN and SUPI(s). The SMF responds to the NWDAF an HTTP "201 Created" response. + +4a-4b. The SMF invokes Nupf\_EventExposure\_Subscribe service operation as described in clause 5.2.2.2 of 3GPP TS 29.564 [40] to retrieve "UserDataUsageMeasures" UPF event for the S-NSSAI/DNN and SUPI(s) from the UPF. The UPF responds to the SMF an HTTP "201 Created" response. + +- 5a-5b. [Option 2] The NWDAF directly invokes Nupf\_EventExposure\_Subscribe service operation as described in clause 5.2.2.2 of 3GPP TS 29.564 [40] to retrieve "UserDataUsageMeasures" UPF event for the S-NSSAI/DNN and SUPI(s) from the UPF. The UPF responds to the NWDAF an HTTP "201 Created" response. +- 6a-6b. The UPF invokes Nupf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a or step 5a. The NWDAF responds to the UPF an HTTP "204 No Content" response. +7. The NWDAF derives analytics indicating a list of UEs and the traffic they route according to the provided information provided by the consumer (i.e. Traffic Descriptor, S-NSSAI and DNN), including its volume and the traffic they route and a list of UEs which route traffic that it is not expected according to the information provided by the consumer (i.e. Traffic Descriptor, S-NSSAI and DNN) including its volume.). +- 8a. If step 1a is performed, the NWDAF sends the Nnwdaf\_AnalyticsInfo\_Request response containing the PDU Session Traffic analytics as described in clause 5.2.3.1. +- 8b-8c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation containing the PDU Session Traffic analytics as described in clause 5.2.2.1. +- NOTE 1: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. +- NOTE 2: For details of Nsmf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.508 [6]. + +### 5.7.20 Relative Proximity Analytics + +This procedure is used by the NWDAF service consumer e.g. NEF or AF to obtain Relative Proximity Analytics among UEs provided by NWDAF to assist more accurately localize a cluster (or a set) of UEs via provisioning statistics and/or prediction information related to their relative proximity. + +![Sequence diagram for Relative Proximity Analytics procedure involving NF, NWDAF, AMF, GMLC, NEF, AF, and OAM.](ffe0fef452a0ae9a20253c319c54e13c_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant GMLC + participant NEF + participant AF + participant OAM + + Note left of NWDAF: 11. NWDAF derives Relative Proximity Analytics + Note left of NWDAF: 18. NWDAF derives Relative Proximity Analytics + + Note right of NF: 1a. Nnwdaf_AnalyticsInfo_Request request + Note right of NF: 1b. Nnwdaf_EventsSubscription_Subscribe request + Note right of NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + Note right of NF: 2a. Namf_EventExposure_Subscribe request + Note right of NF: 2b. Namf_EventExposure_Subscribe response + Note right of NF: 3a. Namf_EventExposure_Notify request + Note right of NF: 3b. Namf_EventExposure_Notify response + Note right of NF: 4a. Ngmlc_Location_ProvideLocation request + Note right of NF: 4b. Ngmlc_Location_ProvideLocation response + Note right of NF: 5a. Ngmlc_Location_EventNotify request + Note right of NF: 5b. Ngmlc_Location_EventNotify response + Note right of NF: 6a. Naf_EventExposure_Subscribe request + Note right of NF: 6b. Naf_EventExposure_Subscribe response + Note right of NF: 7a. Naf_EventExposure_Notify request + Note right of NF: 7b. Naf_EventExposure_Notify response + Note right of NF: 8a. Nnef_EventExposure_Subscribe request + Note right of NF: 8b. Naf_EventExposure_Subscribe request + Note right of NF: 8c. Naf_EventExposure_Subscribe response + Note right of NF: 8d. Nnef_EventExposure_Subscribe response + Note right of NF: 9a. Naf_EventExposure_Notify request + Note right of NF: 9b. Nnef_EventExposure_Notify request + Note right of NF: 9c. Nnef_EventExposure_Notify response + Note right of NF: 9d. Naf_EventExposure_Notify response + Note right of NF: 10. NWDAF collects data from OAM + Note right of NF: 12a. Nnwdaf_AnalyticsInfo_Request response + Note right of NF: 12b. Nnwdaf_EventsSubscription_Notify request + Note right of NF: 12c. Nnwdaf_EventsSubscription_Notify response + Note right of NF: 13a. Namf_EventExposure_Notify request + Note right of NF: 13b. Namf_EventExposure_Notify response + Note right of NF: 14a. Ngmlc_Location_EventNotify request + Note right of NF: 14b. Ngmlc_Location_EventNotify response + Note right of NF: 15a. Naf_EventExposure_Notify request + Note right of NF: 15b. Naf_EventExposure_Notify response + Note right of NF: 16a. Naf_EventExposure_Notify request + Note right of NF: 16b. Nnef_EventExposure_Notify request + Note right of NF: 16c. Nnef_EventExposure_Notify response + Note right of NF: 16d. Naf_EventExposure_Notify response + Note right of NF: 17. NWDAF collects data from OAM + Note right of NF: 19a. Nnwdaf_EventsSubscription_Notify request + Note right of NF: 19b. Nnwdaf_EventsSubscription_Notify response + +``` + +The sequence diagram illustrates the procedure for Relative Proximity Analytics. It begins with the NF sending three requests to the NWDAF: 1a. Nnwdaf\_AnalyticsInfo\_Request, 1b. Nnwdaf\_EventsSubscription\_Subscribe, and 1c. Nnwdaf\_EventsSubscription\_Subscribe response. The NWDAF then sends a series of requests and responses to the AMF (2a-3b), GMLC (4a-5b), and AF (6a-7b). The NEF sends a request to the AF (8a), which in turn sends a request to the AF (8b) and receives a response (8c). The NEF then sends a response to the NWDAF (8d). The AF sends a request to the NEF (9a), which sends a request to the NWDAF (9b) and receives a response (9c). The NEF then sends a response to the AF (9d). The NWDAF collects data from the OAM (10). The NWDAF then derives Relative Proximity Analytics (11). The NF receives three responses from the NWDAF: 12a. Nnwdaf\_AnalyticsInfo\_Request response, 12b. Nnwdaf\_EventsSubscription\_Notify request, and 12c. Nnwdaf\_EventsSubscription\_Notify response. The NWDAF then sends a series of requests and responses to the AMF (13a-13b), GMLC (14a-14b), and AF (15a-15b). The NEF sends a request to the AF (16a), which sends a request to the NWDAF (16b) and receives a response (16c). The NEF then sends a response to the AF (16d). The NWDAF collects data from the OAM (17). The NWDAF then derives Relative Proximity Analytics (18). The NF receives two responses from the NWDAF: 19a. Nnwdaf\_EventsSubscription\_Notify request and 19b. Nnwdaf\_EventsSubscription\_Notify response. + +Sequence diagram for Relative Proximity Analytics procedure involving NF, NWDAF, AMF, GMLC, NEF, AF, and OAM. + +Figure 5.7.20-1: Procedure for Relative Proximity Analytics + +- 1a. In order to obtain the Relative Proximity Analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 1b-1c. In order to subscribe to the Relative Proximity Analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. +- 2a-2b. If the event is set to "RELATIVE\_PROXIMITY" and the subscription/request is authorized, the NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to subscribe to the notification of UE ID and UE location. The AMF responds to the NWDAF an HTTP "201 Created" response. +- 3a-3b. If step 2a and step 2b are performed, the AMF invokes Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Ngmlc\_Location\_ProvideLocation service operation to retrieve UE Location and UE Location Accuracy by sending an HTTP POST request to the URI associated with the "provide-location" custom operation as described in 3GPP TS 29.515 [41] clause 5.2.2.2. The GMLC responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the GMLC may invoke Ngmlc\_Location\_EventNotify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the GMLC an HTTP "204 No Content" response. +- 6a-6b. If the AF is trusted, the NWDAF may invoke Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions" to subscribe the Proximity attributes and/or Proximity related input data of UE(s) from AF directly. The AF responds to the NWDAF an HTTP "201 Created" response. +- 7a-7b. If step 6a and step 6b are performed, the AF may invoke Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 6a. The NWDAF responds to the AF an HTTP "204 No Content" response. +- 8a-8d. If the AF is untrusted, the NWDAF may invoke Nnef\_EventExposure\_Subscribe service operation to the NEF by sending an HTTP POST request targeting the resource "Network Exposure Event Subscriptions" and then the NEF invokes Naf\_EventExposure\_Subscribe service operation by sending an HTTP POST request targeting the resource "Application Event Subscriptions". The AF responds to the NEF an HTTP "201 Created" response and then the NEF responds to the NWDAF an HTTP "201 Created" response. +- 9a-9d. If step 8a to step 8d are performed, the AF may invoke Naf\_EventExposure\_Notify service operation by sending an HTTP POST request to the NEF identified by the notification URI received in step 8b and the NEF invokes Nnef\_EventExposure\_Notify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 8a. The NWDAF responds to the NEF an HTTP "204 No Content" response and then the NEF responds to the AF an HTTP "204 No Content" response. +10. The NWDAF may collect Per UE information of Speed and Orientation related input data as specified in clause 4.3.30 of TS 28.622 [42], clause 11.1 of TS 28.532 [19] and clause 5.10.29 of TS 32.422 [43]. +11. The NWDAF derives the Relative Proximity Analytics based on the data collected from AMF, GMLC, (DC)AF, and/or OAM. +- 12a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 12b-12c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. +- 13a-13b. The same as step 3a and step 3b. +- 14a-14b. The same as step 5a and step 5b. +- 15a-15b. The same as step 7a and step 7b. +- 16a-16d. The same as step 9a and step 9b. +17. The same as step 10. + +18. The same as step 11. + +19a-19b. The same as step 12b and step 12c. + +NOTE 1: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +NOTE 2: For details of Nnef\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.591 [11]. + +NOTE 3: For details of Naf\_EventExposure\_Subscribe/Notify service operations refer to 3GPP TS 29.517 [12]. + +### 5.7.21 Movement Behaviour Analytics + +This procedure is used by the NWDAF service consumer e.g. NEF or AF to obtain Movement Behaviour Analytics provided by NWDAF regarding the location, direction and velocity of UEs during an analytics target period in a target area. + +![Sequence diagram for Movement Behaviour Analytics procedure. Lifelines: NF, NWDAF, AMF, GMLC. The sequence starts with NF sending 1a. Nnwdaf_AnalyticsInfo_Request request to NWDAF. 1b. Nnwdaf_EventsSubscription_Subscribe request to NWDAF. 1c. Nnwdaf_EventsSubscription_Subscribe response from NWDAF to NF. 2a. Namf_EventExposure_Subscribe request from NWDAF to AMF. 2b. Namf_EventExposure_Subscribe response from AMF to NWDAF. 3a. Namf_EventExposure_Notify request from AMF to NWDAF. 3b. Namf_EventExposure_Notify response from NWDAF to AMF. 4a. Ngmlc_Location_ProvideLocation request from NWDAF to GMLC. 4b. Ngmlc_Location_ProvideLocation response from GMLC to NWDAF. 5a. Ngmlc_Location_EventNotify request from GMLC to NWDAF. 5b. Ngmlc_Location_EventNotify response from NWDAF to GMLC. A box labeled '6. NWDAF derives Movement Behaviour Analytics' is shown. 7a. Nnwdaf_AnalyticsInfo_Request response from NWDAF to NF. 7b. Nnwdaf_EventsSubscription_Notify request from NWDAF to NF. 7c. Nnwdaf_EventsSubscription_Notify response from NF to NWDAF.](ffd8c2986aabedc8b6db2d8f2ed7a994_img.jpg) + +``` + +sequenceDiagram + participant NF + participant NWDAF + participant AMF + participant GMLC + Note right of NWDAF: 6. NWDAF derives Movement Behaviour Analytics + NF->>NWDAF: 1a. Nnwdaf_AnalyticsInfo_Request request + NF->>NWDAF: 1b. Nnwdaf_EventsSubscription_Subscribe request + NWDAF-->>NF: 1c. Nnwdaf_EventsSubscription_Subscribe response + NWDAF->>AMF: 2a. Namf_EventExposure_Subscribe request + AMF-->>NWDAF: 2b. Namf_EventExposure_Subscribe response + AMF->>NWDAF: 3a. Namf_EventExposure_Notify request + NWDAF-->>AMF: 3b. Namf_EventExposure_Notify response + NWDAF->>GMLC: 4a. Ngmlc_Location_ProvideLocation request + GMLC-->>NWDAF: 4b. Ngmlc_Location_ProvideLocation response + GMLC->>NWDAF: 5a. Ngmlc_Location_EventNotify request + NWDAF-->>GMLC: 5b. Ngmlc_Location_EventNotify response + Note right of NWDAF: 6. NWDAF derives Movement Behaviour Analytics + NWDAF-->>NF: 7a. Nnwdaf_AnalyticsInfo_Request response + NWDAF->>NF: 7b. Nnwdaf_EventsSubscription_Notify request + NF-->>NWDAF: 7c. Nnwdaf_EventsSubscription_Notify response + +``` + +Sequence diagram for Movement Behaviour Analytics procedure. Lifelines: NF, NWDAF, AMF, GMLC. The sequence starts with NF sending 1a. Nnwdaf\_AnalyticsInfo\_Request request to NWDAF. 1b. Nnwdaf\_EventsSubscription\_Subscribe request to NWDAF. 1c. Nnwdaf\_EventsSubscription\_Subscribe response from NWDAF to NF. 2a. Namf\_EventExposure\_Subscribe request from NWDAF to AMF. 2b. Namf\_EventExposure\_Subscribe response from AMF to NWDAF. 3a. Namf\_EventExposure\_Notify request from AMF to NWDAF. 3b. Namf\_EventExposure\_Notify response from NWDAF to AMF. 4a. Ngmlc\_Location\_ProvideLocation request from NWDAF to GMLC. 4b. Ngmlc\_Location\_ProvideLocation response from GMLC to NWDAF. 5a. Ngmlc\_Location\_EventNotify request from GMLC to NWDAF. 5b. Ngmlc\_Location\_EventNotify response from NWDAF to GMLC. A box labeled '6. NWDAF derives Movement Behaviour Analytics' is shown. 7a. Nnwdaf\_AnalyticsInfo\_Request response from NWDAF to NF. 7b. Nnwdaf\_EventsSubscription\_Notify request from NWDAF to NF. 7c. Nnwdaf\_EventsSubscription\_Notify response from NF to NWDAF. + +**Figure 5.7.21-1: Procedure for Movement Behaviour Analytics** + +1a. In order to obtain the Movement Behaviour Analytics, the NF may invoke Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. + +1b-1c. In order to subscribe to the Movement Behaviour Analytics, the NF may invoke Nnwdaf\_EventsSubscription\_Subscribe service operation as described in clause 5.2.2.1. + +2a-2b. If the event is set to "MOVEMENT\_BEHAVIOUR" and the subscription/request is authorized, the NWDAF may invoke Namf\_EventExposure\_Subscribe service operation as described in clause 5.3.2.2.2 of 3GPP TS 29.518 [18] to subscribe to the notification of UE ID and UE positions. The AMF responds to the NWDAF an HTTP "201 Created" response. + +- 3a-3b. If step 2a and step 2b are performed, the AMF invokes Namf\_EventExposure\_Notify service operation as described in 3GPP TS 29.518 [18] clause 5.3.2.4. The NWDAF responds to the AMF an HTTP "204 No Content" response. +- 4a-4b. The NWDAF may invoke Ngmlc\_Location\_ProvideLocation service operation to retrieve UE Fine granularity locations by sending an HTTP POST request to the URI associated with the "provide-location" custom operation as described in 3GPP TS 29.515 [41] clause 5.2.2.2. The GMLC responds to the NWDAF an HTTP "201 Created" response. +- 5a-5b. If step 4a and step 4b are performed, the GMLC may invoke Ngmlc\_Location\_EventNotify service operation by sending an HTTP POST request to the NWDAF identified by the notification URI received in step 4a. The NWDAF responds to the GMLC an HTTP "204 No Content" response. +- 6. The NWDAF derives the Movement Behaviour Analytics based on the data collected from AMF and/or GMLC. +- 7a. If step 1a is performed, the NWDAF responds to the Nnwdaf\_AnalyticsInfo\_Request service operation as described in clause 5.2.3.1. +- 7b-7c. If step 1b and step 1c are performed, the NWDAF invokes Nnwdaf\_EventsSubscription\_Notify service operation as described in clause 5.2.2.1. + +NOTE: For details of Nnwdaf\_EventsSubscription\_Subscribe/Unsubscribe/Notify or Nnwdaf\_AnalyticsInfo\_Request service operations refer to 3GPP TS 29.520 [5]. + +## 5.8 Procedures for NWDAF Discovery and Selection + +### 5.8.1 General + +NWDAF may be deployed in multiple configuration options. Not all these configurations require the same registration, discovery and selection procedures. The discovery and selection may depend on the NWDAF deployment option and the types of analytics it procedures, (i.e., whether it is related to Network Functions or to UEs) or the data that is able to collect from NFs. + +### 5.8.2 Procedures related to NRF + +#### 5.8.2.1 General + +#### 5.8.2.2 NWDAF (De-)Registration in NRF + +NWDAF (de-)registers in NRF as a regular network function. See TS 29.510 [23] for details. + +#### 5.8.2.3 Consumer discovery and selection of NWDAF in NRF + +A consumer of analytics services may use the NRF for discovering an NWDAF containing AnLF or MTLF. + +If the NWDAF service consumer needs to discover an NWDAF containing AnLF that is able to collect data from particular data sources identified by their NF Set IDs or NF types, the consumer may query NRF with the Nnrf\_NFDiscovery\_NFDiscover service operation, providing the NF Set IDs (serving-nf-set-id attribute) or NF types (serving-nf-type attribute) in the discovery request. See 3GPP TS 29.510 [23] for details. + +If the NWDAF service consumer (NWDAF containing MTLF) needs to discover an NWDAF containing MTLF that support Federated Learning identified by their FL capability (i.e. FL server or FL client), the consumer may query NRF with the Nnrf\_NFDiscovery\_NFDiscover service operation for discovery of FL Server NWDAF (NWDAF containing MTLF) or FL Client NWDAF (NWDAF containing MTLF). See 3GPP TS 29.510 [23] for details. + +If the NWDAF service consumer needs to discover an NWDAF containing MTLF that is able to provide ML model provisioning services with trained ML models available for one or more Analytics ID(s), the consumer may query NRF with the Nnrf\_NFDiscovery\_NFDiscover service operation for discovery of NWDAF containing the required trained ML model. See 3GPP TS 29.510 [23] for details. + +In the roaming architecture, a consumer in the same PLMN as the RE-NWDAF discovers the RE-NWDAF by querying for an NWDAF where the roaming exchange capability is indicated in its NRF profile. A consumer in a peer PLMN (i.e. RE-NWDAF) discovers the RE-NWDAF by querying for an NWDAF in the target PLMN that is supporting the specific services defined for roaming. A RE-NWDAF discovers the RE-NWDAF in a different PLMN (i.e. HPLMN or VPLMN) using the procedure defined in clause 4.17.5 (if delegated discovery is not used) or clause 4.17.10 (if delegated discovery is used) of TS 23.502 [3], where the detailed parameters are determined based on the analytics request or subscription from the consumer 5GC NF, operator policy, user consent and/or local configuration. See 3GPP TS 29.510 [23] for details. + +### 5.8.3 Procedures related to UDM + +#### 5.8.3.1 General + +#### 5.8.3.2 NWDAF containing AnLF Registration/Deregistration in UDM + +##### 5.8.3.2.1 NWDAF containing AnLF Registration in UDM + +For UE-related analytics or for analytics that involve UE-related data collection, an NWDAF containing AnLF may register in UDM using the Nudm\_UECM\_Register service operation (see TS 29.503 [22] clause 5.3.2.2.8). This is useful especially in scenarios of co-location of the NWDAF containing AnLF with other network functions (e.g., AMF, SMF) and in certain deployment models. Figure 5.8.3.2.1-1 illustrates the signalling flow. + +![Sequence diagram illustrating the NWDAF containing AnLF registration in UDM. The diagram shows two lifelines: NWDAF containing AnLF and UDM. The process starts with the NWDAF containing AnLF triggering a registration in UDM. It then sends a Nudm_UECM_Registration request to the UDM, which responds with a Nudm_UECM_Registration response.](1069cea91549f4b971298888e7982f53_img.jpg) + +``` +sequenceDiagram + participant NWDAF as NWDAF containing AnLF + participant UDM as UDM + Note left of NWDAF: 1. Trigger to register in UDM + NWDAF->>UDM: 2. Nudm_UECM_Registration request + UDM-->>NWDAF: 3. Nudm_UECM_Registration response +``` + +Sequence diagram illustrating the NWDAF containing AnLF registration in UDM. The diagram shows two lifelines: NWDAF containing AnLF and UDM. The process starts with the NWDAF containing AnLF triggering a registration in UDM. It then sends a Nudm\_UECM\_Registration request to the UDM, which responds with a Nudm\_UECM\_Registration response. + +**Figure 5.8.3.2.1-1: NWDAF containing AnLF registration in UDM** + +1. NWDAF containing AnLF triggers a registration in UDM, e.g. based on local configuration in the NWDAF containing AnLF, the reception of a new Analytics subscription request, start of collection of UE related data or an OAM configuration action. +2. The NWDAF containing AnLF registers into UDM for the served UE, by sending Nudm\_UECM\_Registration request (UE ID of the served user, NWDAF Instance ID, NF Set ID, Analytics ID(s)). +3. UDM sends a response to NWDAF containing AnLF. A successful response consists of a "200 OK" or "201 Created". If the operation is unsuccessful, UDM responds with proper error response code. See TS 29.503 [22] for details. + +##### 5.8.3.2.2 NWDAF containing AnLF Update of Registration in UDM + +If an NWDAF containing AnLF has previously registered in UDM for one or more analytics IDs for a given UE, the NWDAF containing AnLF may modify the registration at any time. This may be due to, e.g., the NWDAF containing AnLF adds one or more Analytic IDs for the UE, or the NWDAF containing AnLF removes one or more Analytics IDs, but keep registered in UDM for at least one Analytic ID. The NWDAF containing AnLF sends an Nudm\_UECM\_Update service operation (NWDAF registration ID, added or removed Analytics ID(s)), see TS 29.503 [22] clause 5.3.2.6.4. Figure 5.8.3.2.2-1 illustrates the signalling flow. + +![Sequence diagram for NWDAF containing AnLF registration update in UDM](fc3e2b49a9f850951570e502393b697f_img.jpg) + +``` +sequenceDiagram + participant NWDAF as NWDAF containing AnLF + participant UDM + Note left of NWDAF: 1. Trigger to update registration in UDM + NWDAF->>UDM: 2. Nudm_UECM_Update request + UDM-->>NWDAF: 3. Nudm_UECM_Update response +``` + +The diagram illustrates the signaling flow for a registration update. It starts with a box labeled 'NWDAF containing AnLF' with a sub-box '1. Trigger to update registration in UDM'. An arrow labeled '2. Nudm\_UECM\_Update request' points from the NWDAF to a box labeled 'UDM'. A return arrow labeled '3. Nudm\_UECM\_Update response' points from the UDM back to the NWDAF. + +Sequence diagram for NWDAF containing AnLF registration update in UDM + +**Figure 5.8.3.2.2-1: NWDAF containing AnLF registration update in UDM** + +1. If an NWDAF containing AnLF has previously registered one or more Analytics IDs for a UE in UDM, the NWDAF containing AnLF triggers an update of the registration in UDM, e.g. based on the NWDAF containing AnLF serving the UE of one or more additional Analytic ID(s) or based on the NWDAF containing AnLF not serving the UE for one or more Analytic ID(s) but serving the UE for at least one Analytic ID. +2. The NWDAF containing AnLF updates its registration in UDM for the served UE, by sending Nudm\_UECM\_Update request (NWDAF Registration Id, added or removed Analytic ID(s)). +3. Upon success UDM sends a "204 No Content" response to the NWDAF containing AnLF. If the operation is unsuccessful, UDM responds with proper error response code. See TS 29.503 [22] for details. + +##### 5.8.3.2.3 NWDAF containing AnLF De-Registration in UDM + +If an NWDAF containing AnLF has previously registered in UDM for one or more analytics ID for a given UE, when the NWDAF containing AnLF no longer serves the UE, e.g., it does not collect data for the UE for that Analytics ID or does no keep produce analytic reports or does not keep any data related to the UE, the NWDAF containing AnLF should de-register from UDM by invoking the Nudm\_UECM\_Deregistration service operation (NWDAF registration ID, Analytics ID(s)), see TS 29.503 [22] clause 5.3.2.4.8). Figure 5.8.3.2.3-1 illustrates the signalling flow. + +![Sequence diagram for NWDAF containing AnLF deregistration from UDM](2957154f4dc666a6cafb7b4d2d882910_img.jpg) + +``` +sequenceDiagram + participant NWDAF as NWDAF containing AnLF + participant UDM + Note left of NWDAF: 1. Trigger to de-register from UDM + NWDAF->>UDM: 2. Nudm_UECM_Deregistration request + UDM-->>NWDAF: 3. Nudm_UECM_Deregistration response +``` + +The diagram illustrates the signaling flow for a deregistration. It starts with a box labeled 'NWDAF containing AnLF' with a sub-box '1. Trigger to de-register from UDM'. An arrow labeled '2. Nudm\_UECM\_Deregistration request' points from the NWDAF to a box labeled 'UDM'. A return arrow labeled '3. Nudm\_UECM\_Deregistration response' points from the UDM back to the NWDAF. + +Sequence diagram for NWDAF containing AnLF deregistration from UDM + +**Figure 5.8.3.2.3-1: NWDAF containing AnLF deregistration from UDM** + +1. If an NWDAF containing AnLF has previously registered one or more Analytics IDs for a UE in UDM, the NWDAF containing AnLF triggers a complete deregistration from UDM, e.g. based on the NWDAF containing AnLF not collecting data any longer for the UE, or the NWDAF containing AnLF not producing analytics reports for the UE, or the NWDAF containing AnLF not keeping analytics data for the UE. +2. The NWDAF containing AnLF deregisters from UDM for the served UE, by sending Nudm\_UECM\_Deregistration request (NWDAF Registration Id). +3. UDM sends a "204 No Content" response to the NWDAF containing AnLF. See TS 29.503 [22] for details. + +#### 5.8.3.3 Consumer discovery and selection of NWDAF containing AnLF in UDM + +For UE related analytics, if the NWDAF service consumer needs to discover an NWDAF containing AnLF that is serving or holds data for a UE, the NWDAF serving consumer may query UDM with the target SUPI and the Analytics ID. If the response from UDM indicates multiple candidate NWDAFs, the NWDAF service consumer may, e.g., determine an instance of an NWDAF containing AnLF that has registered in UDM (registrationTime attribute) around the time of interest of the data or analytics, and may also query NRF, as specified in clause 5.8.2.3 in order to determine the capabilities of these NWDAFs and select the most appropriate one. Figure 5.8.3.3-1 illustrates the signalling flow. + +![Sequence diagram showing the discovery of an NWDAF containing AnLF in UDM. The NWDAF Service Consumer sends a Nudm_UECM_Get request to the UDM, and the UDM responds with a Nudm_UECM_Get response.](ff1a293f8118c0f00dbfeb0ab843d6e6_img.jpg) + +``` +sequenceDiagram + participant NWDAF Service Consumer + participant UDM + Note left of NWDAF Service Consumer: 1. Nudm_UECM_Get request + NWDAF Service Consumer->>UDM: 1. Nudm_UECM_Get request + Note right of UDM: 2. Nudm_UECM_Get response + UDM-->>NWDAF Service Consumer: 2. Nudm_UECM_Get response +``` + +Sequence diagram showing the discovery of an NWDAF containing AnLF in UDM. The NWDAF Service Consumer sends a Nudm\_UECM\_Get request to the UDM, and the UDM responds with a Nudm\_UECM\_Get response. + +**Figure 5.8.3.3-1: Discovery of NWDAF containing AnLF in UDM** + +1. The NWDAF service consumer sends an Nudm\_UECM\_Get request to the UDM (UE ID, Analytics ID(s), NF type = NWDAF). +2. Upon success, UDM sends a "200 OK" response to the service consumer including the NWDAF information registered for the UE ID. If the operation is unsuccessful, UDM responds with proper error response code. See TS 29.503 [22] for details. + +### 5.8.4 Procedures for PCF learning NWDAF IDs for served UEs + +PCF may receive from AMF and SMF the IDs of the NWDAFs containing AnLF that are used by AMF, SMF, and UPF, so that the PCF may select the same NWDAF containing AnLF being used for a specific UE. + +When the AMF creates or updates an Access and Mobility Policy Association for a UE, the AMF may include the IDs of the NWDAF containing AnLF that are used by the AMF, along with their Analytic ID(s), in the Npcf\_AMPolicyControl\_Create/Update service operations, as illustrated in Figure 5.8.4-1. See details in TS 29.507 [24]. + +![Sequence diagram showing the PCF learning from AMF NWDAFs containing AnLF. The AMF sends an Npcf_AMPolicyControl_Create/Update request to the PCF, and the PCF responds with an Npcf_AMPolicyControl_Create/Update response.](8198a1ee0b1f6ef1c5f1bf702dc74eca_img.jpg) + +``` +sequenceDiagram + participant AMF + participant PCF + Note left of AMF: 1. Npcf_AMPolicyControl_Create/Update request + AMF->>PCF: 1. Npcf_AMPolicyControl_Create/Update request + Note right of PCF: 2. Npcf_AMPolicyControl_Create/Update response + PCF-->>AMF: 2. Npcf_AMPolicyControl_Create/Update response +``` + +Sequence diagram showing the PCF learning from AMF NWDAFs containing AnLF. The AMF sends an Npcf\_AMPolicyControl\_Create/Update request to the PCF, and the PCF responds with an Npcf\_AMPolicyControl\_Create/Update response. + +**Figure 5.8.4-1: PCF leaning from AMF NWDAFs containing AnLF** + +The PCF may select those NWDAF instances discovered through the Npcf\_AMPolicyControl\_Create/Update request as the ones to use for their associated analytic ID(s) for the UE for which those AM Policy Associations are related to. + +When the SMF creates or updates a Session Management Policy Association for a UE, the SMF may include the IDs of the NWDAF containing AnLF that are used by the SMF and UPF, along with their Analytic ID(s), in the Npcf\_SMPolicyControl\_Create/Update service operations, as illustrated in Figure 5.8.4-2. See details in TS 29.512 [25]. + +![Sequence diagram showing the interaction between SMF and PCF. The SMF sends a '1. Npcf_SMPolicyControl_Create/Update request' to the PCF, and the PCF responds with '2. Npcf_SMPolicyControl_Create/Update response'.](c00d3fb4f9d9609639a6e7d7a356afd3_img.jpg) + +``` +sequenceDiagram + participant SMF + participant PCF + Note left of SMF: SMF + Note right of PCF: PCF + SMF->>PCF: 1. Npcf_SMPolicyControl_Create/Update request + PCF-->>SMF: 2. Npcf_SMPolicyControl_Create/Update response +``` + +Sequence diagram showing the interaction between SMF and PCF. The SMF sends a '1. Npcf\_SMPolicyControl\_Create/Update request' to the PCF, and the PCF responds with '2. Npcf\_SMPolicyControl\_Create/Update response'. + +**Figure 5.8.4-2: PCF leaning from SMF and UPF NWDAFs containing AnLF** + +The PCF may select those NWDAF instances discovered through the Npcf\_SMPolicyControl\_Create/Update request as the ones to subscribe for their associated analytic ID(s) for the UE for which those SM Policy Associations are related to. + +## 5.9 Analytics Data Repository procedures + +### 5.9.1 General + +The Analytics Data Repository procedures allow the NF service consumers (e.g. NWDAF, DCCF or MFAF) to store, retrieve or delete collected data and analytics in the ADRF. + +### 5.9.2 Historical Data and Analytics Storage/Retrieval/Deletion procedure + +The procedure is used by an NF service consumer (e.g. NWDAF, DCCF or MFAF) to store, retrieve or delete historical data and/or analytics, i.e. data and/or analytics related to past time period that has been obtained by the consumer. + +![Sequence diagram illustrating the Historical Data and Analytics storage/deletion procedure. The diagram shows four lifelines: NWDAF, DCCF, MFAF, and ADRF. The procedure consists of three main parts: storage, retrieval, and deletion. 1. Storage: NWDAF sends a Nadrf_DataManagement_StorageRequest Request to ADRF via DCCF and MFAF. ADRF stores the data (step 2) and returns a Nadrf_DataManagement_StorageRequest Response (step 3) back through MFAF and DCCF to NWDAF. 2. Retrieval: NWDAF sends a Nadrf_DataManagement_RetrievalRequest Request to ADRF via DCCF and MFAF. ADRF returns a Nadrf_DataManagement_RetrievalRequest Response (step 5) back through MFAF and DCCF to NWDAF. 3. Deletion: NWDAF sends a Nadrf_DataManagement_Delete Request to ADRF via DCCF and MFAF. ADRF deletes the data (step 7) and returns a Nadrf_DataManagement_Delete Response (step 8) back through MFAF and DCCF to NWDAF.](e18841eb4a995df8354a793459e12fd0_img.jpg) + +``` + +sequenceDiagram + participant NWDAF + participant DCCF + participant MFAF + participant ADRF + + Note right of ADRF: 2. ADRF stores data + + Note right of ADRF: 7. ADRF deletes stored data + + NWDAF->>ADRF: 1. Nadrf_DataManagement_StorageRequest Request + ADRF-->>NWDAF: 3. Nadrf_DataManagement_StorageRequest Response + Note right of ADRF: 2. ADRF stores data + NWDAF->>ADRF: 4. Nadrf_DataManagement_RetrievalRequest Request + ADRF-->>NWDAF: 5. Nadrf_DataManagement_RetrievalRequest Response + NWDAF->>ADRF: 6. Nadrf_DataManagement_Delete Request + ADRF-->>NWDAF: 8. Nadrf_DataManagement_Delete Response + Note right of ADRF: 7. ADRF deletes stored data + +``` + +Sequence diagram illustrating the Historical Data and Analytics storage/deletion procedure. The diagram shows four lifelines: NWDAF, DCCF, MFAF, and ADRF. The procedure consists of three main parts: storage, retrieval, and deletion. 1. Storage: NWDAF sends a Nadrf\_DataManagement\_StorageRequest Request to ADRF via DCCF and MFAF. ADRF stores the data (step 2) and returns a Nadrf\_DataManagement\_StorageRequest Response (step 3) back through MFAF and DCCF to NWDAF. 2. Retrieval: NWDAF sends a Nadrf\_DataManagement\_RetrievalRequest Request to ADRF via DCCF and MFAF. ADRF returns a Nadrf\_DataManagement\_RetrievalRequest Response (step 5) back through MFAF and DCCF to NWDAF. 3. Deletion: NWDAF sends a Nadrf\_DataManagement\_Delete Request to ADRF via DCCF and MFAF. ADRF deletes the data (step 7) and returns a Nadrf\_DataManagement\_Delete Response (step 8) back through MFAF and DCCF to NWDAF. + +**Figure 5.9.2-1: Historical Data and Analytics storage/deletion procedure** + +1. In order to store data or analytics, the NF service consumer invokes Nadrf\_DataManagement\_StorageRequest service operation by sending an HTTP POST request targeting the resource "ADRF Data Store Records" in clause 4.2.2.2 of 3GPP TS 29.575 [16]. +2. The ADRF stores the data or analytics sent by the consumer. The ADRF may, based on implementation, determines whether the same data or analytics is already stored or being stored based on the information sent in step 1 by the consumer and, if the data or analytics is already stored or being stored in the ADRF, the ADRF decides to not store again the data or analytics sent by the consumer. +3. If the data or analytics is stored, the ADRF sends Nadrf\_DataManagement\_StorageRequest Response message to the consumer with HTTP "201 Created" status code including a representation of the created record. +4. In order to retrieve the stored data or analytics from the ADRF, the NF service consumer shall invoke the Nadrf\_DataManagement\_RetrievalRequest service operation by sending an HTTP GET request targeting the resource "ADRF Data Store Records" as described in clause 4.2.2.5 of 3GPP TS 29.575 [16]. +5. If the requested data is found, the ADRF sends Nadrf\_DataManagement\_RetrievalRequest Response message to the consumer with HTTP "200 OK" status code including a representation of the matched record. +6. In order to delete the specified data or analytics from the ADRF, the NF service consumer shall invoke the Nadrf\_DataManagement\_Delete service operation by sending an HTTP DELETE request targeting the resource "Individual ADRF Data Store Record" as described in clause 4.2.2.9 of 3GPP TS 29.575 [16] if the NF service consumer delete the resource including the transaction identifier, or by sending an HTTP POST request including the time window in which the data to be deleted was collected and data or analytics specification. +7. The ADRF deletes the specified stored data or analytics requested by the consumer. +8. If the deletion is successfully processed, the ADRF sends Nadrf\_DataManagement\_Delete Response message to the consumer with HTTP "204 No Content" status code. + +### 5.9.3 Historical Data and Analytics Storage via Notifications + +The procedure is used by an NF service consumer (e.g. NWDAF, DCCF) to store received notifications in the ADRF. + +![Sequence diagram illustrating the Historical Data and Analytics storage/deletion procedure. Lifelines: Data or Analytics Consumer, NWDAF, DCCF, MFAF, ADRF. The process involves subscription, determination of storage, request to ADRF, response, and subsequent notification handling.](346324c08906e6d9320f632ab916f73e_img.jpg) + +``` + +sequenceDiagram + participant Consumer as Data or Analytics Consumer + participant NWDAF + participant DCCF + participant MFAF + participant ADRF + + Consumer->>DCCF: 1a. Ndccf_DataManagement_Subscribe + Consumer->>NWDAF: 1b. Nnwdaf_DataManagement_Subscribe + + Note over NWDAF: 2b. NWDAF Determines Data +and/or Analytics is to be +stored in ADRF + Note over DCCF: 2a. DCCF Determines Data +and/or Analytics is to be +stored in ADRF + + DCCF->>ADRF: 3. Nadrf_DataManagement_StorageSubscriptionRequest + + Note over ADRF: 4. ADRF Determines Data and/or +Analytics are already stored or +being stored + + ADRF->>DCCF: 5. Nadrf_DataManagement_StorageSubscriptionRequest Response + + ADRF->>DCCF: 6a. Ndccf_DataManagement_Subscribe + ADRF->>NWDAF: 6b. Nnwdaf_DataManagement_Subscribe + + DCCF->>ADRF: 7a. Ndccf_DataManagement_Subscribe Response + NWDAF->>ADRF: 7b. Nnwdaf_DataManagement_Subscribe Response + + rect rgb(255, 255, 255) + Note over Consumer, ADRF: 8. Notifications Stored in ADRF + end + + Note over NWDAF: 9a. NWDAF Determines Data no +longer is to be stored in ADRF + Note over DCCF: 9b. DCCF Determines Data is no +longer to be stored in ADRF + + DCCF->>ADRF: 10. Nadrf_DataManagement_StorageSubscriptionRemoval request + ADRF->>DCCF: 11. Nadrf_DataManagement_StorageSubscriptionRemoval Response + + ADRF->>DCCF: 12a. Ndccf_DataManagement_Unsubscribe + ADRF->>NWDAF: 12b. Nnwdaf_DataManagement_Unsubscribe + + DCCF->>ADRF: 13a. Ndccf_DataManagement_Unsubscribe Response + NWDAF->>ADRF: 13b. Nnwdaf_DataManagement_Unsubscribe Response + +``` + +Sequence diagram illustrating the Historical Data and Analytics storage/deletion procedure. Lifelines: Data or Analytics Consumer, NWDAF, DCCF, MFAF, ADRF. The process involves subscription, determination of storage, request to ADRF, response, and subsequent notification handling. + +**Figure 5.9.3-1: Historical Data and Analytics storage/deletion procedure** + +- 1-2. Based on provisioning or based on reception of a DataManagement subscription request (e.g. see clause 5.5.3.1), the NF service consumer (e.g. DCCF or NWDAF) determines that notifications are to be stored in the ADRF. +3. The NF service consumer invokes Nadrf\_DataManagement\_StorageSubscriptionRequest service operation by sending an HTTP POST request in clause 4.2.2.3 of 3GPP TS 29.575 [16]. +4. The ADRF may, based on implementation, determines whether the same data or analytics is already stored or being stored based on the information sent in step 3 by the consumer. +5. If the request is successfully processed and accepted, the ADRF sends Nadrf\_DataManagement\_StorageSubscriptionRequest Response message to the consumer with HTTP "200 OK" status code including a transaction reference identifier. If the data and/or analytics is already stored or being stored in the ADRF, the ADRF sends Nadrf\_DataManagement\_StorageSubscriptionRequest Response message to the consumer indicating that data or analytics is stored. +- 6a. ADRF invokes Ndccf\_DataManagement\_Subscribe service operation to subscribe to the DCCF to receive notifications by sending an HTTP POST request message targeting the resource "DCCF Analytics" + +Subscriptions", the HTTP POST message shall include notification endpoint address and a notification correlation ID as defined in clause 5.1.6.2.2 of 3GPP TS 29.574 [15]. + +- 6b. ADRF invokes Nnwdaf\_DataManagement\_Subscribe service operation to subscribe to the NWDAF to receive notifications by sending an HTTP POST request message targeting the resource "NWDAF Data Management Subscriptions", the HTTP POST message shall include notification endpoint address and a notification correlation ID as defined in clause 4.4.2.2 of 3GPP TS 29.520 [5]. +- 7a If the Subscription is successfully processed and accepted, the DCCF sends Ndccf\_DataManagement\_Subscribe Response message to the consumer with HTTP "201 Created" status code with the message body containing a representation of the created subscription. +- 7b If the Subscription is successfully processed and accepted, the NWDAF sends Nnwdaf\_DataManagement\_Subscribe Response message to the consumer with HTTP "201 Created" status code with the message body containing a representation of the created subscription. +8. The NF service consumer (e.g. DCCF, MFAF or NWDAF) sends Analytics or Data notifications containing the notification correlation ID provided by the ADRF to ADRF notification endpoint address when the historical analytics data are available. + +If the NWDAF is the service consumer in step 7, the NWDAF invokes Nnwdaf\_DataManagement\_Notify service operation as defined in clause 4.4.2.4 of 3GPP TS 29.520 [5]. The ADRF stores the notifications and responses to the Nnwdaf\_DataManagement\_Notify service operation with HTTP "204 No Content" status code. + +If the DCCF is used for data collection in step 7, the DCCF invokes Ndccf\_DataManagement\_Notify service operation as defined in clause 4.2.2.4 of 3GPP TS 29.574 [15]. The ADRF stores the notifications and responses to the Ndccf\_DataManagement\_Notify service operation with HTTP "204 No Content" status code. + +If the Messaging Framework is used for data collection in step 7, the procedure defined in clause 5.5.3.2 is applicable. + +9. The NF service consumer determines that notifications no longer need to be stored in the ADRF. +10. In order to request the ADRF to delete the specified data or analytics subscription, the NF service consumer shall invoke the Nadrf\_DataManagement\_StorageSubscriptionRemoval service operation by sending an HTTP POST request as described in clause 4.2.2.4 of 3GPP TS 29.575 [16], including the transaction reference identifier. +11. If the deletion is successfully processed, the ADRF sends Nadrf\_DataManagement\_StorageSubscriptionRemoval Response message with HTTP "204 No Content" status code to the consumer. +- 12a. ADRF invokes Ndccf\_DataManagement\_Unsubscribe service operation to subscribe to the DCCF to receive notifications by sending an HTTP DELETE request message targeting the resource "Individual DCCF Analytics Subscription", the HTTP URI shall include identifier of the existing analytics subscription that is to be deleted as defined in clause 4.2.2.3.2 of 3GPP TS 29.574 [15]. +- 12b. ADRF invokes Nnwdaf\_DataManagement\_Unsubscribe service operation to subscribe to the NWDAF to receive notifications by sending an HTTP DELETE request message targeting the resource "Individual NWDAF Data Management Subscription", the HTTP DELETE URI shall include identifier of the existing analytics subscription that is to be deleted as defined in clause 4.4.2.3.2 of 3GPP TS 29.520 [5]. +- 13a If the removal of the corresponding subscription is successfully processed and accepted, the DCCF sends Ndccf\_DataManagement\_Unsubscribe Response message to the consumer with HTTP "204 No Content" status code. +- 13b If the removal of the corresponding subscription is successfully processed and accepted, the NWDAF sends Nnwdaf\_DataManagement\_Unsubscribe Response message to the consumer with HTTP "204 No Content" status code. + +## 5.10 Federated Learning among Multiple NWDAFs + +### 5.10.1 General + +The NWDAF containing MTLF can leverage Federated Learning (FL) technique to train an ML model. To apply FL technique for ML model training, there is no need for input data transfer (e.g. centralized into one NWDAF) but only need for cooperation among multiple NWDAFs (MTLF) distributed in different areas, i.e. sharing of ML model(s) and of the learning results among multiple NWDAFs (MTLF). + +The NWDAF containing MTLF determines to train an ML model either based on local configuration or when it receives the request from NWDAF containing AnLF as described in clause 5.3 of 3GPP TS 23.288 [17]. If the NWDAF containing MTLF can act as an FL server for the ML model training, then FL procedure is initiated by the NWDAF containing MTLF as FL server NWDAF directly, otherwise, the NWDAF containing MTLF should discover an FL server NWDAF as described in clause 5.3.2.2 of 3GPP TS 29.510 [26] and request the FL server NWDAF to provide the trained ML model as described in clause 5.10.2.1. + +### 5.10.2 Procedures related to Federated Learning + +#### 5.10.2.1 General Procedure for Federated Learning among Multiple NWDAF Instances + +This procedure is used by the NWDAF containing MTLF (FL Server NWDAF) to trigger FL among multiple NWDAF instances, by the multiple NWDAF containing MTLF (the FL Server NWDAF and FL Client NWDAF(s)) to execute Federated Learning in FL execution phase. + +![Sequence diagram showing the general procedure for Federated Learning (FL) among Multiple NWDAF. The diagram involves four lifelines: Consumer, FL Server NWDAF, FL Client NWDAF(s), and NF (data provider). The process starts with a subscription request from the Consumer to the FL Server NWDAF. The FL Server NWDAF then selects FL Client NWDAF(s) and initiates a training subscription with them. The FL Client NWDAF(s) subscribe to events from the NF and notify the FL Server NWDAF. The FL Server NWDAF performs model aggregation and notifies the Consumer. A repeat loop involves the Consumer resubscribing, the FL Server NWDAF repeating the training subscription, and the FL Client NWDAF(s) updating their local models. Finally, the FL Client NWDAF(s) unsubscribe from the NF, and the Consumer unsubscribes from the FL Server NWDAF.](a5404b7275b06497eecf9b5883604753_img.jpg) + +``` + +sequenceDiagram + participant Consumer + participant FL Server NWDAF + participant FL Client NWDAF(s) + participant NF as NF (data provider) + + Note right of FL Server NWDAF: 0e. FL Client NWDAF(s) selection as described in clause 5.10.2.2 + + Note right of FL Server NWDAF: Federated Learning Training + + Consumer->>FL Server NWDAF: 0a. Nnwdaf_MLModelProvision_Subscribe request + FL Server NWDAF-->>Consumer: 0b. Nnwdaf_MLModelProvision_Subscribe response + + FL Server NWDAF->>FL Client NWDAF(s): 1a. Nnwdaf_MLModelTraining_Subscribe request + FL Client NWDAF(s)-->>FL Server NWDAF: 1b. Nnwdaf_MLModelTraining_Subscribe response + + FL Client NWDAF(s)->>NF: 2a. Nnf_EventExposure_Subscribe request + NF-->>FL Client NWDAF(s): 2b. Nnf_EventExposure_Subscribe response + + FL Client NWDAF(s)->>NF: 3a. Nnf_EventExposure_Notify request + NF-->>FL Client NWDAF(s): 3b. Nnf_EventExposure_Notify response + + FL Client NWDAF(s)->>FL Server NWDAF: 4a. Nnwdaf_MLModelTraining_Notify request + FL Server NWDAF-->>FL Client NWDAF(s): 4b. Nnwdaf_MLModelTraining_Notify response + + Note right of FL Server NWDAF: 4c. Same as steps 1a-1b + + Note right of FL Server NWDAF: 5. Model aggregation + + FL Server NWDAF->>Consumer: 6aa. Nnwdaf_MLModelProvision_Notify request + Consumer-->>FL Server NWDAF: 6ab. Nnwdaf_MLModelProvision_Notify response + + Note right of Consumer: 6ba. Same as steps 0a-0b + Note right of Consumer: 6bb. Same as steps 11a-11b + + Note right of FL Server NWDAF: 6c. Update or terminate the FL training process + + Note right of FL Server NWDAF: 7. Same as steps 1a-1b + + Note right of FL Client NWDAF(s): 8. Update the local model based on the aggregated model information + + Note right of FL Client NWDAF(s): Repeat + + FL Client NWDAF(s)->>NF: 9a. Nnf_EventExposure_Unsubscribe request + NF-->>FL Client NWDAF(s): 9b. Nnf_EventExposure_Unsubscribe response + + Note right of Consumer: 10. Same as steps 6aa-6ab + + Consumer->>FL Server NWDAF: 11a. Nnwdaf_MLModelProvision_Unsubscribe request + FL Server NWDAF-->>Consumer: 11b. Nnwdaf_MLModelProvision_Unsubscribe response + +``` + +Sequence diagram showing the general procedure for Federated Learning (FL) among Multiple NWDAF. The diagram involves four lifelines: Consumer, FL Server NWDAF, FL Client NWDAF(s), and NF (data provider). The process starts with a subscription request from the Consumer to the FL Server NWDAF. The FL Server NWDAF then selects FL Client NWDAF(s) and initiates a training subscription with them. The FL Client NWDAF(s) subscribe to events from the NF and notify the FL Server NWDAF. The FL Server NWDAF performs model aggregation and notifies the Consumer. A repeat loop involves the Consumer resubscribing, the FL Server NWDAF repeating the training subscription, and the FL Client NWDAF(s) updating their local models. Finally, the FL Client NWDAF(s) unsubscribe from the NF, and the Consumer unsubscribes from the FL Server NWDAF. + +**Figure 5.10.2.1-1: General procedure for FL among Multiple NWDAF** + +0a-0b. To send a request for ML model analytics events subscription to the NWDAF containing MTLF (the FL Server NWDAF), the NWDAF service consumer (NWDAF containing AnLF or NWDAF containing MTLF) invokes the Nnwdaf\_MLModelProvision\_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF ML Model Provision Subscriptions". + +The FL Server NWDAF responds to the Nnwdaf\_MLModelProvision\_Subscribe service operation. Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the FL Server NWDAF responds + +to the NWDAF service consumer with "201 Created", and the URI of the created subscription is included in the Location header field. Details are described in clause 4.5.2.2 of 3GPP TS 29.520 [5]. + +NOTE 1: The ML model accuracy threshold can be used to indicate the target ML Model Accuracy of the training process, and the FL Server NWDAF may stop the training process when the ML model accuracy threshold is achieved during the training process. + +If the consumer (i.e. the NWDAF containing AnLF or NWDAF containing MTLF) provides the Time when the ML model is needed, the FL Server NWDAF can take this information into account to decide the maximum response time for its FL Client NWDAFs. + +0e. The FL Server NWDAF selects NWDAF(s) containing MTLF (FL Client NWDAF(s)) as described in clause 5.10.2.2. + +1a-1b. To request the selected NWDAF containing MTLF (the FL Client NWDAF) to perform the local model training, the FL Server NWDAF may invoke Nnwdaf\_MLModelTraining\_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF ML Model Training Subscriptions". The FL Client NWDAF responses to the Nnwdaf\_MLModelTraining\_Subscribe service operation with an HTTP "201 Created" status code to the FL Server NWDAF, as defined in clause 4.6.2.2 of 3GPP TS 29.520 [5]. + +2a-2b. To subscribe to notification (or to modify subscriptions to notifications) of data events from the data source NF, each FL Client NWDAF may invoke the Nnf\_EventExposure\_Subscribe service operation by sending an HTTP POST (or PUT, for modification) request targeting the resource representing event exposure subscriptions of that NF. + +The data source NF responds to the Nnf\_EventExposure\_Subscribe service operation. Upon receipt of the HTTP POST request, if the subscription is accepted to be created, the NF responds to the FL Client NWDAF with "201 Created", and the URI of the created subscription is included in the Location header field. + +3a-3b. If the data source NF observes the subscribed event(s), the NF invokes the Nnf\_EventExposure\_Notify service operation to report the event(s) by sending an HTTP POST request. + +On success, the FL Client NWDAF sends an HTTP "204 No Content" response to the NF. + +4. During FL training process, each FL Client NWDAF further trains the retrieved ML model from the FL Server NWDAF based on its own/collected data, and reports interim local ML model information to the FL Server NWDAF before the maximum response time elapses. Each FL Client NWDAF also computes local model metric and reports it to the FL Server NWDAF. The ML model information are exchanged between the FL Client NWDAF(s) and the FL Server NWDAF during the FL training process. + +4a-4b. To report the ML model training information, the FL Client NWDAF may invoke Nnwdaf\_MLModelTraining\_Notify service operation as defined in clause 4.6.2.4 of 3GPP TS 29.520 [5]. The FL Server NWDAF stores the notification and responds to the Nnwdaf\_MLModelTraining\_Notify service operation with an HTTP "204 No Content" status code to the FL Client NWDAF. + +4c. [Optional] If FL Server NWDAF receives notification that the FL Client NWDAF is not able to complete the training within the maximum response time, the FL Server NWDAF may send to the FL Client NWDAF an new maximum response time by invoking Nnwdaf\_MLModelTraining\_Subscribe, before which the FL Client NWDAF shall report the interim local ML model information to the FL Server NWDAF. Otherwise, the FL Server NWDAF may indicate FL Client NWDAF to skip reporting for this iteration. + +5. The FL Server NWDAF aggregates all the local ML model information retrieved at step 4, to update the global ML model. The FL Server NWDAF may also compute the global model metric. + +- If the FL Server NWDAF provides the maximum response time for the FL Client NWDAFs to provide the interim local ML model information in step 1 or the new maximum response time in step 4, the FL Server NWDAF decides either to wait for the FL Client NWDAFs which have not yet provided their interim local ML model within the new maximum response time or to aggregate only the retrieved local ML model information instances to update global ML model. The FL Server NWDAF makes this decision, considering the notification from the FL Client NWDAF or, if the notification is not received, based on local configuration. + +6a. [Optional] Based on the NWDAF service consumer request, the FL Server NWDAF updates the global ML model metric to the NWDAF service consumer periodically or dynamically when some pre-determined status (e.g. ML model accuracy threshold) is achieved. + +6aa-6ab. To report the ML model training information, the FL Server NWDAF invokes Nnwdaf\_MLModelProvision\_Notify service operation as defined in clause 4.5.2.4 of 3GPP TS 29.520 [5]. The NWDAF service consumer stores the notification and responds to the Nnwdaf\_MLModelProvision\_Notify service operation with an HTTP "204 No Content" status code to the FL Server NWDAF. + +6b. [Optional] The NWDAF service consumer decides whether the current model can fulfil the requirement. The NWDAF service consumer modifies subscription (stops or continues the training process) according to the NWDAF service consumer decision. + +6ba. To modify the existing subscription, the NWDAF service consumer invokes Nnwdaf\_MLModelProvision\_Subscribe service operation by sending an HTTP PUT request with Resource URI of the resource "Individual NWDAF ML Model Provision Subscription". The FL Server NWDAF responds to the NWDAF service consumer with an HTTP "200 OK" or "204 No Content" status code, as defined in clause 4.5.2.2.3 of 3GPP TS 29.520 [5]. + +6bb. To unsubscribe the ML model, the NWDAF service consumer invokes Nnwdaf\_MLModelProvision\_Unsubscribe service operation by sending an HTTP DELETE request which targets the resource "Individual NWDAF ML Model Provision Subscription", to the FL Server NWDAF, as defined in clause 4.5.2.3 of 3GPP TS 29.520 [5]. If the request is accepted, the FL Server NWDAF deletes the subscription and responds to the NWDAF service consumer with an HTTP "204 No Content" message. + +6c. [Optional] According to the request from the NWDAF service consumer, the FL Server NWDAF updates or terminates the current FL training process. If it terminates the current FL training process, steps 7 and 8 are skipped. + +7. If the FL procedure continues, the FL Server NWDAF sends the aggregated ML model information to each FL Client NWDAF for next round model training. + +To modify the existing subscription, the FL Server NWDAF invokes Nnwdaf\_MLModelTraining\_Subscribe service operation by sending an HTTP PUT request or an HTTP PATCH request with Resource URI of the resource "Individual NWDAF ML Model Training Subscription". The FL Client NWDAF responds to the FL Server NWDAF an HTTP "200 OK" or "204 No Content" status code, as defined in clauses 4.6.2.2.3 and 4.6.2.2.4 of 3GPP TS 29.520 [5]. + +8. Each FL Client NWDAF updates its own ML model based on the aggregated ML model information distributed by the FL Server NWDAF at step 7. + +NOTE 2: The steps 4-8 should be repeated until the training termination condition (e.g. maximum number of iterations, or the result of loss function is lower than a threshold) is reached. + +9a-9b. To unsubscribe to the notifications of data events from the data source NF, the FL Client NWDAF invokes the Nnf\_EventExposure\_Unsubscribe service operation by sending an HTTP DELETE request targeting the resource that represents the previously created individual event exposure subscription. + +The data source NF responds to the Nnf\_EventExposure\_Unsubscribe service operation. If the subscription deletion is accepted, the NF responds with "204 No Content". + +10. If the FL Server NWDAF determines that the subscribed ML model information is available, the FL Server NWDAF may invoke the Nnwdaf\_MLModelProvision\_Notify service operation or the Nnwdaf\_MLModelTraining\_Notify service operation to report the ML model information by sending an HTTP POST request to the NWDAF service consumer identified by the notification URI received during the creation/modification of the subscriptions. The NWDAF service consumer responds to the FL Server NWDAF with an HTTP "204 No Content" message. + +11a-11b. To unsubscribe from the notification(s) of the ML model information, the NWDAF service consumer invokes the Nnwdaf\_MLModelProvision\_Unsubscribe service operation by sending an HTTP DELETE request, which targets the resource "Individual NWDAF ML Model Provision Subscription", to the FL Server NWDAF, as defined in clause 4.5.2.3 of 3GPP TS 29.520 [5]. + +If the request is accepted, the FL Server NWDAF deletes the subscription and responds to the NWDAF service consumer with an HTTP "204 No Content" message. + +#### 5.10.2.2 Preparation Procedure for Federated Learning + +This procedure is used by the NWDAF containing MTTF (as FL Server NWDAF or FL Client NWDAF(s)) to register into NRF, discover the FL Server NWDAF and select FL Client NWDAF(s) for Federated Learning (FL). + +![Sequence diagram illustrating the Preparation procedure for Federated Learning. The diagram shows three lifelines: FL Server NWDAF, FL Client NWDAF(s), and NRF. Step 1: FL Server NWDAF and FL Client NWDAF(s) discover each other via NRF. Step 2: FL Server NWDAF sends a 'Nnwdaf_MLModelTraining_Subscribe' request to FL Client NWDAF(s). FL Client NWDAF(s) then decides whether to join or not (Step 2b). FL Server NWDAF receives a response (Step 2c). Step 3: FL Server NWDAF selects the FL Client NWDAF(s).](8edfc370769207831f060f44d2281084_img.jpg) + +``` + +sequenceDiagram + participant FL Server NWDAF + participant FL Client NWDAF(s) + participant NRF + Note over FL Server NWDAF, FL Client NWDAF(s), NRF: 1. Discover FL Server and Client NWDAFs via NRF + FL Server NWDAF->>FL Client NWDAF(s): 2a. Nnwdaf_MLModelTraining_Subscribe request + Note right of FL Client NWDAF(s): 2b. Decide to join or not + FL Client NWDAF(s)->>FL Server NWDAF: 2c. Nnwdaf_MLModelTraining_Subscribe response + Note left of FL Server NWDAF: 3. Select FL Client NWDAF(s) + +``` + +Sequence diagram illustrating the Preparation procedure for Federated Learning. The diagram shows three lifelines: FL Server NWDAF, FL Client NWDAF(s), and NRF. Step 1: FL Server NWDAF and FL Client NWDAF(s) discover each other via NRF. Step 2: FL Server NWDAF sends a 'Nnwdaf\_MLModelTraining\_Subscribe' request to FL Client NWDAF(s). FL Client NWDAF(s) then decides whether to join or not (Step 2b). FL Server NWDAF receives a response (Step 2c). Step 3: FL Server NWDAF selects the FL Client NWDAF(s). + +**Figure 5.10.2.2-1: Preparation procedure for Federated Learning** + +The NWDAF containing MTTF as FL Server NWDAF or FL Client NWDAF(s) registered to NRF its NF profiles. Details are described in clause 5.2.2.2 of 3GPP TS 29.510 [26]. + +1. The FL Server NWDAF and FL Client NWDAF(s) are discovered via NRF. Details are described in clause 5.3.2.2 of 3GPP TS 29.510 [26]. +2. The Nnwdaf\_MLModelTraining service may be used for the preparation information exchange between the FL Server NWDAF and the FL Client NWDAF(s). + - 2a. The FL Server NWDAF invokes Nnwdaf\_MLModelTraining\_Subscribe service operation by sending an HTTP POST request targeting the resource "NWDAF ML Model Training Subscriptions", The request shall include the "mLPreFlag" attribute and set to "true". Details are described in clause 4.6.2.2 of 3GPP TS 29.520 [5]. + - 2b. The FL Client NWDAF(s) checks if it meets the ML model training requirement as described in clause 5.5.6.2.2 of 3GPP TS 29.520 [5] and/or can successfully download the model if the model information is provided in the request, and decides whether to join the FL process based on operator policy (e.g. pre-configured list of ML models) and/or implementation. + - 2c. The FL Client NWDAF responds or notifies to the Nnwdaf\_MLModelTraining\_Subscribe request to indicate its decision. Upon receipt of the HTTP POST request, if the preparation request is accepted, the FL Client NWDAF responds to the FL Server NWDAF with "201 Created", otherwise, responds with "403 Forbidden" as described in 3GPP TS 29.520 [5]. + +NOTE: Step 2 can be skipped if the FL Server NWDAF can decide that the FL Client NWDAF(s) supports the FL procedure to be performed, e.g. based on information acquired from previous FL procedures or from the NRF, or based on local configuration. + +3. The FL Server NWDAF determines the final list of FL Client NWDAF(s) to be involved in the FL procedures based on the information received in step 1 and other information received in step 2 (if available). + +#### 5.10.2.3 Procedure for Maintenance of Federated Learning Process + +This procedure is used by the NWDAF containing MTTF (the FL Server NWDAF) to maintain a FL process in FL execution phase, including: the FL Server NWDAF triggers reselection, addition, or removal of FL Client NWDAF(s), discovery of new FL Client NWDAF(s) via NRF, and FL Client NWDAF(s) joins or leaves FL process dynamically. + +In FL execution phase, the FL Server NWDAF monitors the status changes of FL Client NWDAF(s), and may reselect the FL Client NWDAF(s) based on the received information of status changes. + +NOTE: The FL Server NWDAF checks if there is a need to carry on the FL execution phase and then reselects FL members for the next iteration if needed. + +![Sequence diagram illustrating the procedure for maintenance of Federated Learning Process in FL Execution Phase. The diagram shows interactions between FL Client NWDAF(s), FL Server NWDAF, NRF, and New FL Client NWDAF(s). The process includes getting updated status, handling notify requests, dynamically getting new client information, subscribing for analytics, determining re-selection, and performing reselection if needed.](57134800ac3a97b6212b27b93aa196ac_img.jpg) + +``` + +sequenceDiagram + participant FL Client NWDAF(s) + participant FL Server NWDAF + participant NRF + participant New FL Client NWDAF(s) + + Note right of FL Server NWDAF: 1. Get updated status of the current FL Client NWDAF(s) via NRF + FL Server NWDAF-->>NRF: 1. Get updated status of the current FL Client NWDAF(s) via NRF + Note left of FL Client NWDAF(s): 2a. Nnwdaf_MLModelTraining_Notify request + FL Client NWDAF(s)-->>FL Server NWDAF: 2a. Nnwdaf_MLModelTraining_Notify request + Note right of FL Server NWDAF: 2b. Nnwdaf_MLModelTraining_Notify response + FL Server NWDAF-->>FL Client NWDAF(s): 2b. Nnwdaf_MLModelTraining_Notify response + Note right of FL Server NWDAF: 3. FL Server NWDAF may get the information of the new FL Client NWDAF(s) dynamically via NRF + FL Server NWDAF-->>NRF: 3. FL Server NWDAF may get the information of the new FL Client NWDAF(s) dynamically via NRF + Note right of FL Server NWDAF: 4a. FL Server NWDAF subscribes to other NWDAF for analytics of FL Client NWDAF(s) + FL Server NWDAF-->>NRF: 4a. FL Server NWDAF subscribes to other NWDAF for analytics of FL Client NWDAF(s) + Note right of FL Server NWDAF: 4b. FL Server NWDAF subscribes to FL Client NWDAF(s) for analytics of FL Client NWDAF(s) + FL Server NWDAF-->>FL Client NWDAF(s): 4b. FL Server NWDAF subscribes to FL Client NWDAF(s) for analytics of FL Client NWDAF(s) + Note left of FL Client NWDAF(s): 5a. Nnwdaf_MLModelTraining_Notify request + FL Client NWDAF(s)-->>FL Server NWDAF: 5a. Nnwdaf_MLModelTraining_Notify request + Note right of FL Server NWDAF: 5b. Nnwdaf_MLModelTraining_Notify response + FL Server NWDAF-->>FL Client NWDAF(s): 5b. Nnwdaf_MLModelTraining_Notify response + Note right of FL Server NWDAF: 6. Determine whether re-selection is needed + FL Server NWDAF-->>FL Server NWDAF: 6. Determine whether re-selection is needed + Note right of FL Server NWDAF: 7. FL Client NWDAF(s) reselection + FL Server NWDAF-->>FL Client NWDAF(s): 7. FL Client NWDAF(s) reselection + Note left of FL Client NWDAF(s): 8a. Nnwdaf_MLModelTraining_Unsubscribe request + FL Client NWDAF(s)-->>FL Server NWDAF: 8a. Nnwdaf_MLModelTraining_Unsubscribe request + Note right of FL Server NWDAF: 8b. Nnwdaf_MLModelTraining_Unsubscribe response + FL Server NWDAF-->>FL Client NWDAF(s): 8b. Nnwdaf_MLModelTraining_Unsubscribe response + + Note right of New FL Client NWDAF(s): During FL process + +``` + +Sequence diagram illustrating the procedure for maintenance of Federated Learning Process in FL Execution Phase. The diagram shows interactions between FL Client NWDAF(s), FL Server NWDAF, NRF, and New FL Client NWDAF(s). The process includes getting updated status, handling notify requests, dynamically getting new client information, subscribing for analytics, determining re-selection, and performing reselection if needed. + +**Figure 5.10.2.3-1: Procedure for Maintenance of Federated Learning Process in FL Execution Phase** + +The FL Server NWDAF registered to NRF by invoking the Nnrf\_NFManagement\_NFRegister\_request service operation about the FL process, which includes Analytics ID. + +1. The FL Server NWDAF may get the updated status of the current FL Client NWDAF(s) via NRF by using the Nnrf\_NFManagement service in the FL execution phase. Details are described in clauses 5.2.2.5 and 5.2.2.6 of 3GPP TS 29.510 [26]. +2. The current FL Client NWDAF(s) may inform the FL Server NWDAF to leave the FL process. The FL Client NWDAF(s) invokes Nnwdaf\_MLModelTraining\_Notify service operation by sending an HTTP POST request to the FL Server NWDAF identified by the notification URI received during the creation/modification of the subscriptions. The request shall include "termTrainReq" attribute and with the "termTrainCause" attribute in data type "TermMLModelTrainInfo" being provided. Details are described in clause 4.6.2.4 of 3GPP TS 29.520 [5]. The FL Server NWDAF responds to the Nnwdaf\_MLModelTraining\_Notify service operation with an HTTP "204 No Content" status code to the FL Client NWDAF(s). +3. The FL Server NWDAF may get the information of the new FL Client NWDAF(s) dynamically via NRF. Details are described in clauses 5.2.2.5 and 5.2.2.6 of 3GPP TS 29.510 [26]. +4. The FL Server NWDAF may subscribe to other NWDAF (Assist NWDAF) or the FL Client NWDAF(s) for analytics of the FL Client NWDAF(s), as defined in clauses 4.2.2.2 and 4.2.2.4 of 3GPP TS 29.520 [5]. +5. The FL Client NWDAF(s) may send Status report of FL training and Global ML Model Accuracy Information. The FL Client NWDAF(s) invokes Nnwdaf\_MLModelTraining\_Notify service operation to the FL Server + +NWDAF. The FL Server NWDAF stores the notification and responds to the Nnwdaf\_MLModelTraining\_Notify service operation with an HTTP "204 No Content" status code to the FL Client NWDAF(s). Details are described in clause 4.6.2.4 of 3GPP TS 29.520 [5]. + +6. The FL Server NWDAF checks the FL Client NWDAF(s) status based on the received information, determines whether reselection of the FL Client NWDAF(s) for the next round(s) of FL is needed. The checking and determination are made according to the updated status of the FL Client NWDAF(s) received in steps 1-5. + 7. If re-selection is needed as determined in step 6 and if step 3 is not performed, the FL Server NWDAF may discover new candidate FL Client NWDAF(s) via NRF by using the Nnrf\_NFDiscovery services as described in clause 5.3.2.2 of 3GPP TS 29.510 [26]. The FL Server NWDAF reselects the FL Client NWDAF(s) from the current FL Client NWDAF(s) and the new candidate FL Client NWDAF(s). + 8. The FL Server NWDAF sends termination request to the FL Client NWDAF(s) which will be removed from the FL process, and optionally indicating the reason. The FL Client NWDAF(s) terminates FL operations when receives a termination request from the FL Server NWDAF and may perform further action to be qualified in participation of FL training in the next cycles. +- 8a-8b. To send the termination request, the FL Server NWDAF may invoke the Nnwdaf\_MLModelTraining\_Unsubscribe service operation by sending an HTTP DELETE request, which targets the resource "Individual NWDAF ML Model Training Subscription", to the FL Client NWDAF(s). If the request is accepted, the FL Client NWDAF deletes the subscription and responds to the FL Server NWDAF service consumer with an HTTP "204 No Content" message. Details are described in clause 4.6.2.3 of 3GPP TS 29.520 [5]. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-04 | CT3#115e | | | | | TS skeleton for TS 29.552. | 0.0.0 | +| 2021-04 | CT3#115e | | | | | Inclusion of documents agreed in CT3#115e:
C3-212120, C3-212389 | 0.1.0 | +| 2021-05 | CT3#116e | | | | | Inclusion of document agreed in CT3#116e:
C3-213373 | 0.2.0 | +| 2021-08 | CT3#117e | | | | | Inclusion of document agreed in CT3#117e:
C3-214475, C3-214476, C3-214162 | 0.3.0 | +| 2021-10 | CT3#118e | | | | | Inclusion of document agreed in CT3#118e:
C3-215481, C3-215482, C3-215220, C3-215221. | 0.4.0 | +| 2021-11 | CT3#119e | | | | | Inclusion of document agreed in CT3#119e:
C3-216463, C3-216428, C3-216241, C3-216242, C3-216243, C3-216244, C3-216464 | 0.5.0 | +| 2022-01 | CT3#119bis-e | | | | | Inclusion of document agreed in CT3#119bis-e:
C3-220495, C3-220356, C3-220090, C3-220091, C3-220336, C3-220332, C3-220333, C3-220357, C3-220358, C3-220338. | 0.6.0 | +| 2022-02 | CT3#120e | | | | | Inclusion of document agreed in CT3#120e:
C3-221470, C3-221477, C3-221481, C3-221622, C3-221623, C3-221624, C3-221625, C3-221591, C3-221285, C3-221680, C3-221296, C3-221683, C3-221685. | 0.7.0 | +| 2022-03 | CT#95e | CP-220158 | | | | Presentation to TSG CT for approval | 1.0.0 | +| 2022-03 | CT#95e | CP-220158 | | | | Approved by TSG CT | 17.0.0 | +| 2022-06 | CT#96 | CP-221132 | 0001 | 1 | F | Adding "Prepared analytics subscription transfer" signalling flows. | 17.1.0 | +| 2022-06 | CT#96 | CP-221131 | 0002 | 1 | F | Correction Nnwdaf_MLModelProvision Service notification | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0003 | 1 | B | Update procedure for Analytics Exposure via DCCF | 17.1.0 | +| 2022-06 | CT#96 | CP-221130 | 0004 | 1 | B | Update Data Collection Reference Architecture | 17.1.0 | +| 2022-06 | CT#96 | CP-221130 | 0005 | 1 | B | Update Analytics Exposure Reference Architecture | 17.1.0 | +| 2022-06 | CT#96 | CP-221130 | 0006 | 1 | B | Resolve editor's note in Analytics Exposure via DCCF | 17.1.0 | +| 2022-06 | CT#96 | CP-221130 | 0007 | 1 | B | Resolve editor's note in Analytics Exposure via DCCF and MFAF | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0010 | 1 | F | Update Analytics Exposure via DCCF | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0011 | 1 | F | Update Analytics Exposure via DCCF and MFAF | 17.1.0 | +| 2022-06 | CT#96 | CP-221133 | 0012 | 1 | F | Update Analytics context transfer initiated by target NWDAF | 17.1.0 | +| 2022-06 | CT#96 | CP-221133 | 0013 | 1 | F | Update Analytics aggregation with provisioning of Area of Interest | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0014 | 1 | F | Update Data Collection via DCCF | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0015 | 1 | F | Update Data Collection via Messaging Framework | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0016 | 1 | B | SMCCE analytics supports Nnwdaf_EventsSubscription_Subscribe service operation | 17.1.0 | +| 2022-06 | CT#96 | CP-221130 | 0017 | | B | Remove the redundant description for discovery and selection of NWDAF containing AnLF | 17.1.0 | +| 2022-06 | CT#96 | CP-221131 | 0018 | 1 | B | Introducing the Analytics Data Repository procedures | 17.1.0 | +| 2022-06 | CT#96 | CP-221136 | 0020 | 1 | F | Update of transferring ML model during analytics transfer | 17.1.0 | +| 2022-06 | CT#96 | CP-221134 | 0021 | | B | Remove the ENs about when the DCCF sends the response to the consumer | 17.1.0 | +| 2022-06 | CT#96 | CP-221135 | 0022 | 1 | B | Update the Analytics context transfer and Analytics Subscription transfer | 17.1.0 | +| 2022-06 | CT#96 | CP-221135 | 0023 | 1 | F | Correction to Analytics context transfer initiated by target NWDAF | 17.1.0 | +| 2022-09 | CT#97e | CP-222103 | 0025 | 1 | F | Remove EN about using Nadrf_DataManagement_RetrievalRequest in DCCF procedures | 17.2.0 | +| 2022-09 | CT#97e | CP-222102 | 0026 | 1 | F | Add NSACF to the data source list of the NWDAF | 17.2.0 | +| 2022-09 | CT#97e | CP-222102 | 0027 | 1 | F | Support prepared analytics subscription transfer | 17.2.0 | +| 2022-09 | CT#97e | CP-222102 | 0030 | 1 | F | Update the content of Nadrf_DataManagement_RetrievalNotify | 17.2.0 | +| 2022-12 | CT#98e | CP-223173 | 0031 | 1 | F | User consent corrections in data collection procedures | 17.3.0 | +| 2022-12 | CT#98e | CP-223172 | 0037 | | F | Update historical data and analytics storage via Notifications | 17.3.0 | +| 2023-03 | CT#99 | CP-230146 | 0042 | 2 | F | Update for Analytics Exposure via DCCF procedure | 17.4.0 | +| 2023-03 | CT#99 | CP-230148 | 0043 | 1 | F | Support of user consent change for data collection procedures | 18.0.0 | +| 2023-06 | CT#100 | CP-231126 | 0045 | 4 | B | Procedures for Federated Learning among Multiple NWDAFs in 5GC | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0046 | 2 | B | Procedures related to NRF for Federated Learning | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0047 | 2 | B | Updates to ML Model Provisioning Procedures for FL and Model Sharing | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0049 | 2 | B | Update to Reference Architecture for Data Collection from MDAF | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0050 | 2 | B | Support Data Collection from MDAF/MDAS for Service Experience Analytics | 18.1.0 | + +| | | | | | | | | +|---------|---------|-----------|------|---|---|------------------------------------------------------------------------------------|--------| +| 2023-06 | CT#100 | CP-231124 | 0051 | 2 | B | Support Data Collection from MDAF for Redundant Transmission Experience Analytics | 18.1.0 | +| 2023-06 | CT#100 | CP-231137 | 0052 | 1 | F | Addition of Abbreviations | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0053 | | B | Enhancements on QoS Sustainability analytics with coarse granularity | 18.1.0 | +| 2023-06 | CT#100 | CP-231125 | 0055 | 1 | B | Support of PFD determination analytics | 18.1.0 | +| 2023-06 | CT#100 | CP-231137 | 0056 | 1 | B | Updates to Procedures for NWDAF Discovery and Selection | 18.1.0 | +| 2023-06 | CT#100 | CP-231137 | 0057 | 1 | B | Update NRF procedure for NWDAF discovery supporting ML model provisioning | 18.1.0 | +| 2023-06 | CT#100 | CP-231127 | 0058 | | B | Enhancements on service experience analytics | 18.1.0 | +| 2023-06 | CT#100 | CP-231159 | 0060 | 1 | A | Correcting the NF that validates the user consent | 18.1.0 | +| 2023-06 | CT#100 | CP-231128 | 0061 | 1 | B | Signalling flow Support of End-to-end data volume transfer time analytics | 18.1.0 | +| 2023-06 | CT#100 | CP-231126 | 0062 | 1 | B | Preparation and Maintenance Procedures for Federated Learning in 5GC | 18.1.0 | +| 2023-06 | CT#100 | CP-231125 | 0063 | 1 | F | Remove Detail Parameters in ML Model Provisioning Procedures | 18.1.0 | +| 2023-09 | CT3#101 | CP-232082 | 0064 | 1 | B | Adding GMLC to the possible data sources for analytics | 18.2.0 | +| 2023-09 | CT3#101 | CP-232095 | 0065 | | B | Adding UPF to the possible data sources for analytics | 18.2.0 | +| 2023-09 | CT3#101 | CP-232082 | 0066 | 1 | B | Update to the General Procedure for Federated Learning | 18.2.0 | +| 2023-09 | CT3#101 | CP-232082 | 0067 | 1 | B | Update to the Preparation Procedure for Federated Learning | 18.2.0 | +| 2023-09 | CT3#101 | CP-232081 | 0068 | | B | Enhancement of Redundant Transmission Experience analytics for NWDAF-assisted URSP | 18.2.0 | +| 2023-09 | CT3#101 | CP-232082 | 0069 | 1 | B | Procedures for PDU Session Traffic Analytics | 18.2.0 | +| 2023-12 | CT#102 | CP-233224 | 0070 | 1 | B | Analytics feedback information handing at the NWDAF | 18.3.0 | +| 2023-12 | CT#102 | CP-233249 | 0071 | 1 | B | Using UPF Exposure in UE communications procedure | 18.3.0 | +| 2023-12 | CT#102 | CP-233249 | 0072 | 1 | B | Using UPF Exposure in Dispersion analytics procedure | 18.3.0 | +| 2023-12 | CT#102 | CP-233225 | 0073 | 2 | B | Updates to PFD Determination Analytics | 18.3.0 | +| 2023-12 | CT#102 | CP-233225 | 0074 | 1 | B | Procedures for Relative Proximity Analytics | 18.3.0 | +| 2023-12 | CT#102 | CP-233225 | 0075 | 1 | B | Procedures for Movement Behaviour Analytics | 18.3.0 | +| 2023-12 | CT#102 | CP-233226 | 0076 | 2 | F | Update to Procedures for Federated Learning | 18.3.0 | +| 2023-12 | CT#102 | CP-233225 | 0077 | 2 | B | Update to ML Model Training Procedures | 18.3.0 | +| 2023-12 | CT#102 | CP-233249 | 0078 | 1 | B | Updates with UPF Exposure | 18.3.0 | +| 2023-12 | CT#102 | CP-233236 | 0079 | 1 | B | Updates to WLAN Performance Analytics | 18.3.0 | +| 2023-12 | CT#102 | CP-233226 | 0080 | 1 | B | Updates to Service Experience Analytics | 18.3.0 | +| 2023-12 | CT#102 | CP-233226 | 0081 | 1 | B | Updates to Analytics Data Collection from MDAF | 18.3.0 | +| 2023-12 | CT#102 | CP-233226 | 0082 | 1 | B | Data Collection in Roaming Case | 18.3.0 | +| 2023-12 | CT#102 | CP-233226 | 0083 | 1 | B | Analytics Exposure in Roaming Case | 18.3.0 | +| 2023-12 | CT#102 | CP-233246 | 0084 | 1 | F | Corrections to data collection from OAM procedures | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29553/raw.md b/raw/rel-18/29_series/29553/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c055e3c069aafdeae58706d19ce89c5a0fb72f60 --- /dev/null +++ b/raw/rel-18/29_series/29553/raw.md @@ -0,0 +1,1376 @@ + + +# 3GPP TS 29.553 V18.3.0 (2023-12) + +*Technical Specification* + +**3rd Generation Partnership Project; +Technical Specification Group Core Network and Terminals; +5G System; 5G ProSe Anchor Services; +Stage 3 +(Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 5 Services offered by the 5G PAnF ..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Npanf_ProseKey Service ..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 Register ..... | 10 | +| 5.2.2.2.1 General ..... | 10 | +| 5.2.2.3 Retrieve..... | 10 | +| 5.2.2.3.1 General ..... | 10 | +| 5.3 Npanf_ResolveRemoteUserId Service..... | 11 | +| 5.3.1 Service Description ..... | 11 | +| 5.3.2 Service Operations..... | 11 | +| 5.3.2.1 Introduction..... | 11 | +| 5.3.2.2 ResolveRemoteUserId ..... | 11 | +| 5.3.2.2.1 General ..... | 11 | +| 6 API Definitions ..... | 12 | +| 6.1 Npanf_ProseKey Service API..... | 12 | +| 6.1.1 Introduction ..... | 12 | +| 6.1.2 Usage of HTTP..... | 12 | +| 6.1.2.1 General..... | 12 | +| 6.1.2.2 HTTP standard headers..... | 12 | +| 6.1.2.2.1 General ..... | 12 | +| 6.1.2.2.2 Content type ..... | 12 | +| 6.1.2.3 HTTP custom headers..... | 12 | +| 6.1.3 Resources..... | 13 | +| 6.1.3.1 Overview..... | 13 | +| 6.1.3.2 Resource: Prose Keys ..... | 13 | +| 6.1.3.2.1 Description ..... | 13 | +| 6.1.3.2.2 Resource Definition..... | 13 | +| 6.1.3.2.3 Resource Standard Methods..... | 14 | +| 6.1.3.2.4 Resource Custom Operations..... | 14 | +| 6.1.4 Custom Operations without associated resources ..... | 15 | +| 6.1.5 Notifications ..... | 15 | +| 6.1.6 Data Model ..... | 15 | +| 6.1.6.1 General..... | 15 | +| 6.1.6.2 Structured data types..... | 16 | +| 6.1.6.2.1 Introduction ..... | 16 | +| 6.1.6.2.2 Type: ProseContextInfo ..... | 16 | +| 6.1.6.2.3 Type: ProseKeyRequest..... | 16 | +| 6.1.6.2.4 Type: ProseKeyResponse..... | 16 | +| 6.1.6.3 Simple data types and enumerations..... | 16 | +| 6.1.6.3.1 Introduction ..... | 16 | +| 6.1.6.3.2 Simple data types ..... | 17 | +| 6.1.6.4 Data types describing alternative data types or combinations of data types ..... | 17 | +| 6.1.6.5 Binary data..... | 17 | + +| | | | +|-------------------------------|----------------------------------------------------------------------------------|-----------| +| 6.1.7 | Error Handling ..... | 17 | +| 6.1.7.1 | General ..... | 17 | +| 6.1.7.2 | Protocol Errors ..... | 17 | +| 6.1.7.3 | Application Errors ..... | 17 | +| 6.1.8 | Feature negotiation ..... | 17 | +| 6.1.9 | Security ..... | 18 | +| 6.2 | Npanf_ResolveRemoteUserId Service API ..... | 18 | +| 6.2.1 | Introduction ..... | 18 | +| 6.2.2 | Usage of HTTP ..... | 18 | +| 6.2.2.1 | General ..... | 18 | +| 6.2.2.2 | HTTP standard headers ..... | 19 | +| 6.2.2.2.1 | General ..... | 19 | +| 6.2.2.2.2 | Content type ..... | 19 | +| 6.2.2.3 | HTTP custom headers ..... | 19 | +| 6.2.3 | Resources ..... | 19 | +| 6.2.3.1 | Overview ..... | 19 | +| 6.2.3.2 | Resource: Resolve Remote User ID ..... | 20 | +| 6.2.3.2.1 | Description ..... | 20 | +| 6.2.3.2.2 | Resource Definition ..... | 20 | +| 6.2.3.2.3 | Resource Standard Methods ..... | 20 | +| 6.2.3.2.4 | Resource Custom Operations ..... | 20 | +| 6.2.3.2.4.1 | Overview ..... | 20 | +| 6.2.3.2.4.2 | Operation: get ..... | 20 | +| 6.2.3.2.4.2.1 | Description ..... | 20 | +| 6.2.3.2.4.2.2 | Operation Definition ..... | 20 | +| 6.2.4 | Custom Operations without associated resources ..... | 21 | +| 6.2.5 | Notifications ..... | 21 | +| 6.2.6 | Data Model ..... | 21 | +| 6.2.6.1 | General ..... | 21 | +| 6.2.6.2 | Structured data types ..... | 21 | +| 6.2.6.2.1 | Introduction ..... | 21 | +| 6.2.6.2.2 | Type: ResolveReqData ..... | 22 | +| 6.2.6.2.3 | Type: ResolveRspData ..... | 22 | +| 6.2.6.3 | Simple data types and enumerations ..... | 22 | +| 6.2.6.3.1 | Introduction ..... | 22 | +| 6.2.6.3.2 | Simple data types ..... | 22 | +| 6.2.6.4 | Data types describing alternative data types or combinations of data types ..... | 22 | +| 6.2.6.5 | Binary data ..... | 22 | +| 6.2.7 | Error Handling ..... | 22 | +| 6.2.7.1 | General ..... | 22 | +| 6.2.7.2 | Protocol Errors ..... | 22 | +| 6.2.7.3 | Application Errors ..... | 23 | +| 6.2.8 | Feature negotiation ..... | 23 | +| 6.2.9 | Security ..... | 23 | +| Annex A (normative): | OpenAPI specification ..... | 24 | +| A.1 | General ..... | 24 | +| A.2 | Npanf_ProseKey API ..... | 24 | +| A.3 | Npanf_ResolveRemoteUserId API ..... | 26 | +| Annex B (informative): | Change history ..... | 28 | + +# Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Npanf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the 5G PANF. + +The 5G System stage 2 architecture and procedures are specified in TS 23.501 [2] and TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in TS 29.500 [4] and TS 29.501 [5]. + +# --- 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 33.503: "Security Aspects of Proximity based Services (ProSe) in the 5G System (5GS)". +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +# 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]. + +| | | +|------|-----------------------| +| PAnF | Prose Anchor Function | +|------|-----------------------| + +# 4 Overview + +The Prose Anchor Function (PAnF) is the network entity in the 5G Core Network (5GC) supporting security procedure over Control Plane for the 5G ProSe UE-to-Network relay and 5G ProSe UE-to-UE Relay as specified in 3GPP TS 33.503 [14]. Within the 5GC, the PAnF offers services to the AUSF and SMF via the Npanf service based interface. + +Figure 4-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the PAnF: + +![Reference model diagram showing AUSF and SMF connected to PAnF via Npc11 and Npc14 interfaces respectively.](3b621c21b0af3a504a28d2547e87138f_img.jpg) + +``` +graph LR; AUSF[AUSF] -- Npc11 --> Npanf((Npanf)); SMF[SMF] -- Npc14 --> Npanf; Npanf --- PAnF[PAnF]; style PAnF fill:#90EE90,stroke:#000,stroke-width:2px; +``` + +The diagram illustrates the reference model for the PAnF. On the left, two network functions, AUSF (Authentication Server Function) and SMF (Session Management Function), are shown. AUSF is connected to a service based interface (SBI) represented by a circle labeled 'Npanf'. The connection between AUSF and the Npanf interface is labeled 'Npc11'. SMF is also connected to the same 'Npanf' interface, with the connection labeled 'Npc14'. The 'Npanf' interface is part of the PAnF (Prose Anchor Function), which is represented by a green rectangular box on the right. + +Reference model diagram showing AUSF and SMF connected to PAnF via Npc11 and Npc14 interfaces respectively. + +**Figure 4-1: Reference model – PAnF** + +The PAnF supports the following functionalities: + +- Storage and retrieval of ProSe context information of the 5G ProSe Remote UE and ProSe context information of the 5G ProSe End UE; +- Checking whether the 5G ProSe Remote UE is authorized to use the UE-to-Network Relay service and whether the End UE is authorized to use the UE-to-UE Relay service. +- Resolving the ProSe Remote User ID to SUPI. + +# 5 Services offered by the 5G PAnF + +## 5.1 Introduction + +Table 5.1-1 shows the PAnF Services and PAnF Service Operations: + +**Table 5.1-1: List of 5G PAnF Services** + +| Service Name | Service Operations | Operation Semantics | Example Consumer(s) | +|---------------------------|--------------------|---------------------|---------------------| +| Npanf_ProseKey | Register | Request/Response | AUSF | +| | Retrieve | Request/Response | AUSF | +| Npanf_ResolveRemoteUserId | Get | Request/Response | SMF | + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------------|--------|--------------------------------|----------------------------------------|----------------|-------| +| Npanf_ProseKey | 6.1 | PAnF Prose Key Service | TS29553_Npanf_ProseKey.yaml | npanf-prosekey | A.2 | +| Npanf_ResolveRemoteUserId | 6.2 | Resolve Remote User ID Service | TS29553_Npanf_ResolveRemoteUserId.yaml | npanf-userid | A.3 | + +## 5.2 Npanf\_ProseKey Service + +### 5.2.1 Service Description + +The Npanf\_ProseKey service enables an NF to request the PAnF to store the ProSe context information for a 5G ProSe Remote UE or to store the ProSe context information for a 5G ProSe End UE or to request CP-PRUK from the PAnF. The following are the key functionalities of this NF service. + +- Store the Prose context information; +- Retrieve the Prose Key. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operations defined for the Npanf\_ProseKey service are as follows: + +- Register: It allows a consumer NF to store the Prose Context information; +- Retrieve: It provides to the NF service consumer of the CP-PRUK matching input criteria. + +#### 5.2.2.2 Register + +##### 5.2.2.2.1 General + +The Register service operation is invoked by a NF Service Consumer to request the PAnF to store the ProSe context information for a 5G ProSe Remote UE or to store the ProSe context information for a 5G ProSe End UE. + +The Register service operation is used during the following procedure: + +- PC5 security establishment for 5G ProSe UE-to-Network relay communication over Control Plane (see 3GPP TS 33.503 [14], clause 6.3.3.3.2) + +The NF Service Consumer (i.e. AUSF) shall request the PAnF to store the ProSe context information for a 5G ProSe Remote UE or to store the ProSe context information for a 5G ProSe End UE as shown in Figure 5.2.2.2.1-1 + +![Sequence diagram for Prose Keys registration](1eadbbe42cfcac5c0023577110aec5e3_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PAnF + Note left of NF service consumer: + NF service consumer->>PAnF: 1. POST.../prose-keys/register (ProseContextInfo) + Note right of PAnF: + PAnF-->>NF service consumer: 2a. 204 No Content + PAnF-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram shows a sequence of interactions between an 'NF service consumer' and a 'PAnF'. The consumer sends a 'POST.../prose-keys/register (ProseContextInfo)' request to the PAnF. The PAnF responds with either '2a. 204 No Content' on success or '2b. 404 Not Found' if the user does not exist. + +Sequence diagram for Prose Keys registration + +**Figure 5.2.2.2.1-1: Prose Keys registration** + +1. The NF service consumer (e.g. AUSF) sends a POST request to the resource representing the Prose Context Info for a 5G ProSe Remote UE or the Prose Context Info for a 5G ProSe End UE. +- 2a. On success, the PAnF responds with "204 No Content". +- 2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.2.2.3 Retrieve + +##### 5.2.2.3.1 General + +Figure 5.2.2.3.1-1 shows a scenario where the NF service consumer (e.g. AUSF) sends a request to the PAnF to retrieve the CP-PRUK. The request contains the CP-PRUK ID and Relay Service Code. + +![Sequence diagram for Prose Keys retrieval](55a593259a0749ce342bd5eac2ba6b58_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant PAnF + Note left of NF Service Consumer: + NF Service Consumer->>PAnF: 1. POST.../prose-keys/retrieve (ProseKeyRequest) + Note right of PAnF: + PAnF-->>NF Service Consumer: 2a. 200 OK (ProseKeyResponse) + PAnF-->>NF Service Consumer: 2b. 404 Not Found +``` + +The diagram shows a sequence of interactions between an 'NF Service Consumer' and a 'PAnF'. The consumer sends a 'POST.../prose-keys/retrieve (ProseKeyRequest)' request to the PAnF. The PAnF responds with either '2a. 200 OK (ProseKeyResponse)' on success or '2b. 404 Not Found' if the user does not exist. + +Sequence diagram for Prose Keys retrieval + +**Figure 5.2.2.3.1-1: Prose Keys retrieval** + +1. The NF service consumer (e.g. AUSF) sends a POST request to the resource representing the Prose Key. +- 2a. On success, the PAnF responds with "200 OK" with the message body containing the ProseKeyResponse. + +- 2b. If the user does not exist, or the ProSe Key does not exist in the in the PAnF, HTTP status code "404 Not Found" shall be returned and additional error information should be included in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +## 5.3 Npanf\_ResolveRemoteUserId Service + +### 5.3.1 Service Description + +This service enables an NF service consumer (i.e. SMF) to request the PAnF to resolve the Remote User ID. The following are the key functionalities of this NF service. + +- Resolve the Remote User ID + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +#### 5.3.2.2 ResolveRemoteUserId + +##### 5.3.2.2.1 General + +The ResolveRemoteUserId service operation is invoked by a NF Service Consumer, i.e. SMF, towards the PAnF to Resolve the Remote User ID. + +The ResolveRemoteUserId service operation is used during the following procedure: + +- PC5 security establishment for 5G ProSe UE-to-Network relay communication over Control Plane (see 3GPP TS 33.503 [14], clause 6.3.3.3.2) + +The NF Service Consumer (i.e. SMF) shall resolve the Remote User ID by invoking the "get" custom method on the resource URI of "Resolve Remote User ID" resource, see clause 6.y.3.2.4. See also Figure 5.3.2.2.1-1. + +![Sequence diagram showing the interaction between an NF service consumer and a PAnF to resolve a Remote User ID. The consumer sends a POST request to /prose-resolution/get. The PAnF responds with either a 200 OK or a 404 Not Found.](04cefd2bf9de5948b15bea2d0bdc04f4_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PAnF + Note left of NF service consumer: + NF service consumer->>PAnF: 1. POST.../prose-resolution/get (ResolveReqData) + Note right of PAnF: + PAnF-->>NF service consumer: 2a. 200 OK (ResolveRspData) + PAnF-->>NF service consumer: 2b. 404 Not Found +``` + +Sequence diagram showing the interaction between an NF service consumer and a PAnF to resolve a Remote User ID. The consumer sends a POST request to /prose-resolution/get. The PAnF responds with either a 200 OK or a 404 Not Found. + +Figure 5.3.2.2-1: Resolve the Remote User ID + +1. The NF service consumer sends a POST request to the resource representing the get custom operation. The request body shall contain the Remote User ID (CP-PRUK ID). +- 2a. On success, "200 OK" shall be returned. The response body shall contain the SUPI. +- 2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +# 6 API Definitions + +## 6.1 Npanf\_ProseKey Service API + +### 6.1.1 Introduction + +The Npanf\_ProseKey service shall use the Npanf\_ProseKey API. + +The API URI of the Npanf\_ProseKey API shall be: + +**{apiRoot}//** + +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}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "npanf-prosekey". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [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 Npanf\_ProseKey API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.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 9457 [13]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 depicts the resource URIs structure for the Npanf\_ProseKey API. + +![Diagram showing the resource URI structure for the Npanf_ProseKey API. The root is {apiRoot}/npanf-prosekey/, which branches to /prose-keys. /prose-keys then branches to two sub-resources: /register and /retrieve, each enclosed in a dashed box.](3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg) + +``` + + {apiRoot}/npanf-prosekey/ + | + └─ /prose-keys + | + └─ /register + └─ /retrieve + +``` + +Diagram showing the resource URI structure for the Npanf\_ProseKey API. The root is {apiRoot}/npanf-prosekey/, which branches to /prose-keys. /prose-keys then branches to two sub-resources: /register and /retrieve, each enclosed in a dashed box. + +**Figure 6.1.3.1-1: Resource URI structure of the Npanf\_ProseKey API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------|----------------------|---------------------------------|-------------------------| +| Prose Keys | /prose-keys/register | register (POST) | Store the Prose Context | +| | /prose-keys/retrieve | retrieve (POST) | Retrieve the CP-PRUK | + +#### 6.1.3.2 Resource: Prose Keys + +##### 6.1.3.2.1 Description + +This resource is used to represent Prose Keys Registration and Retrieval. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/npanf-prosekey//prose-keys + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +No HTTP method has been defined for the Prose Keys resource. + +##### 6.1.3.2.4 Resource Custom Operations + +##### 6.1.3.2.4.1 Overview + +**Table 6.1.3.2.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|------------------------------| +| register | /prose-keys/register | POST | Store the Prose Context Info | +| retrieve | /prose-keys/retrieve | POST | Retrieve the CP-PRUK | + +###### 6.1.3.2.4.2 Operation: register + +###### 6.1.3.2.4.2.1 Description + +The registration custom operation is used by the NF service consumer (AUSF) to store the Prose context info. For details see 3GPP TS 33.503 [14]. + +###### 6.1.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.2-2. + +**Table 6.1.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|----------------------------------------------| +| ProseContextInfo | M | 1 | Contains the SUPI, CP-PRUK, CP-PRUK ID, RSC. | + +**Table 6.1.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +##### 6.1.3.2.4.3 Operation: retrieve + +###### 6.1.3.2.4.3.1 Description + +The retrieval custom operation is used by the NF service consumer (AUSF) to retrieve the Prose Key. For details see 3GPP TS 33.503 [14]. + +###### 6.1.3.2.4.3.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.3.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.3.2-2. + +**Table 6.1.3.2.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|------------------------------| +| ProseKeyRequest | M | 1 | Contains the 5GPRUK ID, RSC. | + +**Table 6.1.3.2.4.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| ProseKeyResponse | M | 1 | 200 OK | Upon success, a response body containing the Prose Key shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +### 6.1.4 Custom Operations without associated resources + +There is no custom operation without associated resources supported in Npanf\_ProseKey Service. + +### 6.1.5 Notifications + +There is no notification defined for Npanf\_ProseKey service. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Npanf\_ProseKey service based interface protocol. + +**Table 6.1.6.1-1: Npanf\_ProseKey specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------|----------------|------------------------------------------|---------------| +| ProseContextInfo | 6.1.6.2.2 | ProSe Context Information | | +| ProseKeyRequest | 6.1.6.2.3 | Contains the CP-PRUK ID, RSC. | | +| ProseKeyResponse | 6.1.6.2.4 | Contains the CP-PRUK | | +| 5GPruk | 6.1.6.3.2 | ProSe Remote User Key over Control Plane | | + +Table 6.1.6.1-2 specifies data types re-used by the Npanf\_ProseKey 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 Npanf\_ProseKey service based interface. + +**Table 6.1.6.1-2: Npanf\_ProseKey re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|---------------------|---------------------------------------------|---------------| +| RelayServiceCode | 3GPP TS 29.571 [15] | Relay Service Code | | +| Supi | 3GPP TS 29.571 [15] | see 3GPP TS 23.501 [2] clause 5.9.2 | | +| 5GPrukId | 3GPP TS 29.571 [15] | ProSe Remote User Key ID over Control Plane | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: ProseContextInfo + +**Table 6.1.6.2.2-1: Definition of type ProseContextInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | The SUPI of the UE | | +| 5gPrukId | 5GPrukId | M | 1 | This IE shall indicate the CP-PRUK ID of the 5G ProSe Remote UE or the 5G ProSe End UE. | | +| 5gPruk | 5GPruk | M | 1 | This IE shall indicate the CP-PRUK of the 5G ProSe Remote UE or the 5G ProSe End UE. | | +| relayServiceCode | RelayServiceCode | M | 1 | This IE shall indicate the Relay Service Code from the 5G ProSe Remote UE or the 5G ProSe End UE. | | + +##### 6.1.6.2.3 Type: ProseKeyRequest + +**Table 6.1.6.2.3-1: Definition of type ProseKeyRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------|---------------| +| 5gPrukId | 5GPrukId | M | 1 | This IE shall indicate the CP-PRUK ID of the 5G ProSe Remote UE or the 5G ProSe End UE. | | +| relayServiceCode | RelayServiceCode | M | 1 | This IE shall indicate the Relay Service Code from the 5G ProSe Remote UE or the 5G ProSe End UE. | | + +##### 6.1.6.2.4 Type: ProseKeyResponse + +**Table 6.1.6.2.4-1: Definition of type ProseKeyResponse** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------|---------------| +| 5gPruk | 5GPruk | M | 1 | This IE shall indicate the CP-PRUK of the 5G ProSe Remote UE or the 5G ProSe End UE. | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.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. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| 5GPruk | string | ProSe Remote User Key over Control Plane

String value carrying the CP-PRUK in hexadecimal presentation.
pattern: "^[A-Fa-f0-9]{64}\$" | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There is no data type describing alternative data types or combinations of data types in Npanf\_ProseKey Service. + +#### 6.1.6.5 Binary data + +There is no binary data type in Npanf\_ProseKey Service. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Npanf\_ProseKey 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 Npanf\_ProseKey API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Npanf\_ProseKey service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Npanf\_ProseKey service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|--------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The provided subscriber identifier is not found. | +| DATA_NOT_FOUND | 404 Not Found | The requested data is not found/does not exist. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Npanf\_ProseKey API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Npanf\_ProseKey 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 Npanf\_ProseKey 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 Npanf\_ProseKey service. + +The Npanf\_ProseKey API defines the following scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [8]: + +**Table 6.1.9-1: OAuth2 scopes defined in Npanf\_ProseKey API** + +| Scope | Description | +|----------------------------------|-----------------------------------------| +| "npanf_prosekey" | Access to the Npanf_ProseKey API. | +| "npanf_prosekey:register:invoke" | Access to invoke register Prose Context | +| "npanf_prosekey:retrieve:invoke" | Access to invoke retrieve CP-PRUK | + +## 6.2 Npanf\_ResolveRemoteUserId Service API + +### 6.2.1 Introduction + +The Npanf\_ResolveRemoteUserId shall use the Npanf\_ResolveRemoteUserId API. + +The API URI of the Npanf\_ResolveRemoteUserId API shall be: + +**{apiRoot}** + +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 [6], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "npanf-userid". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +The OpenAPI [7] specification of HTTP messages and content bodies for the Npanf\_ResolveRemoteUserId API is contained in Annex A. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers. + +##### 6.2.2.2.2 Content type + +JSON, IETF RFC 8259 [9], 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 [5]. 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 9457 [13]. + +#### 6.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.2.3.1-1 describes the resource URI structure of the Npanf\_ResolveRemoteUserId API. + +![Diagram showing the resource URI structure of the Npanf_ResolveRemoteUserId API. The root URI is {apiRoot}/npanf-userid/. A line branches down to /prose-resolution. Another line branches down from /prose-resolution to /get, which is enclosed in a dashed box.](0d475a233dd118d11e7c7958dce3c1c2_img.jpg) + +``` + +graph TD + Root["{apiRoot}/npanf-userid/"] --> Prose["/prose-resolution"] + Prose --> Get["/get"] + style Get stroke-dasharray: 5 5 + +``` + +Diagram showing the resource URI structure of the Npanf\_ResolveRemoteUserId API. The root URI is {apiRoot}/npanf-userid/. A line branches down to /prose-resolution. Another line branches down from /prose-resolution to /get, which is enclosed in a dashed box. + +**Figure 6.2.3.1-1: Resource URI structure of the Npanf\_ResolveRemoteUserId API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------|-------------------|---------------------------------|---------------------------------------| +| Resolve Remote User ID | /prose-resolution | get
(POST) | ResolveRemoteUserId service operation | + +#### 6.2.3.2 Resource: Resolve Remote User ID + +##### 6.2.3.2.1 Description + +This resource represents resolving Remote User ID by the PAnF. + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}///prose-resolution + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.2.1 | + +##### 6.2.3.2.3 Resource Standard Methods + +There is no standard method supported by the resource. + +##### 6.2.3.2.4 Resource Custom Operations + +###### 6.2.3.2.4.1 Overview + +**Table 6.2.3.2.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|---------------------------------------| +| get | {resourceUri}/get | POST | ResolveRemoteUserId service operation | + +###### 6.2.3.2.4.2 Operation: get + +###### 6.2.3.2.4.2.1 Description + +This custom operation requests to resolve the Remote User ID by the PAnF. + +###### 6.2.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.2.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.2.3.2.4.2.2-2. + +**Table 6.2.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-------------------------------------------------------------------------------| +| ResolveReqData | M | 1 | Resolve Request Data, including the Remote User ID of the 5G ProSe Remote UE. | + +**Table 6.2.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ResolveRspData | M | 1 | 200 OK | Resolve Response Data, including the SUPI of the 5G ProSe Remote UE. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute shall be set to one of the following application error:
- USER_NOT_FOUND
See table 6.2.7.3-1 for the description of these errors. | + +NOTE1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +### 6.2.4 Custom Operations without associated resources + +There is no custom operation without associated resources supported in Npanf\_ResolveRemoteUserId Service. + +### 6.2.5 Notifications + +There is no notification defined for Npanf\_ResolveRemoteUserId service. + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Npanf\_ResolveRemoteUserId service based interface protocol. + +**Table 6.2.6.1-1: Npanf\_ResolveRemoteUserId specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------|----------------|-------------------------------------------------------------------------------|---------------| +| ResolveReqData | 6.2.6.2.2 | Resolve Request Data, including the Remote User ID of the 5G ProSe Remote UE. | | +| ResolveRspData | 6.2.6.2.3 | Resolve Response Data, including the SUPI of the 5G ProSe Remote UE. | | + +Table 6.2.6.1-2 specifies data types re-used by the Npanf\_ResolveRemoteUserId 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 Npanf\_ResolveRemoteUserId service based interface. + +**Table 6.2.6.1-2: Npanf\_ResolveRemoteUserId re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------|---------------------|---------------------------------------------|---------------| +| SUPI | 3GPP TS 29.571 [15] | SUPI | | +| 5GPrukId | 3GPP TS 29.571 [15] | ProSe Remote User Key ID over Control Plane | | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: ResolveReqData + +Table 6.2.6.2.2-1: Definition of type ResolveReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------------------------------|---------------| +| cpPrukId | 5GPrukId | M | 1 | This IE shall indicate the CP-PRUK ID of the 5G ProSe Remote UE. | | + +##### 6.2.6.2.3 Type: ResolveRspData + +Table 6.2.6.2.3-1: Definition of type ResolveRspData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|----------------------------------|---------------| +| supi | Supi | M | 1 | This IE shall indicate the SUPI. | | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.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. + +##### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +Table 6.2.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 6.2.6.4 Data types describing alternative data types or combinations of data types + +There is no data type describing alternative data types or combinations of data types in Npanf\_ResolveRemoteUserId Service. + +#### 6.2.6.5 Binary data + +There is no binary data type in Npanf\_ResolveRemoteUserId Service. + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +For the Npanf\_ResolveRemoteUserId API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] 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 [5]. + +In addition, the requirements in the following clauses are applicable for the Npanf\_ResolveRemoteUserId API. + +#### 6.2.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [5]. + +#### 6.2.7.3 Application Errors + +The application errors defined for the Npanf\_ResolveRemoteUserId service are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|--------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The provided subscriber identifier is not found. | + +### 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the Npanf\_ResolveRemoteUserId API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [5]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| N/A | | | + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [11] and 3GPP TS 29.500 [5], the access to the Npanf\_ResolveRemoteUserId API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [12]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Npanf\_ResolveRemoteUserId API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [13], 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 Npanf\_ResolveRemoteUserId service. + +The Npanf\_ResolveRemoteUserId API defines a single scope "npanf-userid" for OAuth2 authorization (as specified in 3GPP TS 33.501 [11]) for the entire service, and it does not define any additional scopes at resource or operation level. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [7]). + +## --- A.2 Npanf\_ProseKey API + +``` +openapi: 3.0.0 + +info: + title: Npanf_ProseKey + version: 1.1.0-alpha.2 + description: | + PAnF ProseKey Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.553 V18.1.0; 5G System; 5G ProSe Anchor Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.553/ + +servers: + - url: '{apiRoot}/npanf-prosekey/{apiVersion}' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npanf-prosekey + +paths: + /prose-keys/register: + post: + summary: Register the Prose Key + operationId: ProseKeyRegistration + tags: + - prosekey registration + security: + - {} + - oAuth2ClientCredentials: + - npanf_prosekey + - oAuth2ClientCredentials: + - npanf_prosekey + - npanf_prosekey:register:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProseContextInfo' +``` + +``` + required: true + responses: + '204': + description: Successful Response + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/prose-keys/retrieve: + post: + summary: retrieve the prose key + operationId: ProseKeyRetrieval + tags: + - Prose Key Retrieval + security: + - {} + - oAuth2ClientCredentials: + - npanf_prosekey + - oAuth2ClientCredentials: + - npanf_prosekey + - npanf_prosekey:retrieve:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProseKeyRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ProseKeyResponse' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: +``` + +``` + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npanf-prosekey: Access to the Npanf_ProseKey API + npanf-prosekey:register:invoke: Access to invoke register Prose Context + npanf-prosekey:retrieve:invoke: Access to invoke retrieve CP-PRUK + +schemas: +# +# Structured Data Types +# + ProseContextInfo: + description: Prose Context Info. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + 5gPruk: + $ref: '#/components/schemas/5GPruk' + 5gPrukId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GPrukId' + relayServiceCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RelayServiceCode' + required: + - supi + - 5gPruk + - 5gPrukId + - relayServiceCode + + ProseKeyRequest: + description: Prose Key Request. + type: object + properties: + 5gPrukId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GPrukId' + relayServiceCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RelayServiceCode' + required: + - 5gPrukId + - relayServiceCode + + ProseKeyResponse: + description: Prose Key Response. + type: object + properties: + 5gPruk: + $ref: '#/components/schemas/5GPruk' + required: + - 5gPruk + +# +# Simple Data Types +# + 5GPruk: + description: ProSe Remote User Key over Control Plane + type: string + pattern: '^[A-Fa-f0-9]{64}$' + +# +# Enumeration Data Types +# +``` + +## --- A.3 Npanf\_ResolveRemoteUserId API + +``` +openapi: 3.0.0 +info: + version: '1.1.0-alpha.1' +``` + +``` +title: 'Npanf_ResolveRemoteUserId' +description: | + PANF Resolve Remote User Id Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.553 V18.3.0; 5G System; 5G ProSe Anchor Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.553/ + +servers: + - url: '{apiRoot}/npanf-userid/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npanf-userid + +paths: + /prose-resolution/get: + post: + summary: Request to resolve the Remote User ID + operationId: ProseResolve + tags: + - Resolve Remote User ID + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ResolveReqData' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResolveRspData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npanf-userid: Access to the Npanf_ResolveRemoteUserId API + +schemas: +``` + +``` + +# +# Structured Data Types +# +ResolveReqData: + description: Representation of the Resolve Request Data. + type: object + properties: + cpPrukId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GPRukId' + required: + - cpPrukId + +ResolveRspData: + description: Representation of the Resolve Response Data. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + required: + - supi + +# +# Simple Data Types +# + +# +# Enumeration Data Types +# + +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-----------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2022-08 | CT4#111-e | C4-224498 | | | | Initial draft
Implementation of pCRs agreed in CT4#111-e including C4-224430,C4-224046,C4-224431,C4-224432,C4-224592,C4-224433,C4-224593,C4-224373,C4-224374,C4-224594,C4-224595,C4-224377,C4-224378,C4-224596 | 0.1.0 | +| 2022-09 | CT#97-e | CP-222239 | | | | TS presented for information and approval | 1.0.0 | +| 2022-09 | CT#97-e | | | | | Approved in CT#97-e | 17.0.0 | +| 2022-12 | CT#98-e | CP-223054 | 0002 | 2 | F | 5GPRUK Name Alignment | 17.1.0 | +| 2022-12 | CT#98-e | CP-223054 | 0003 | 1 | F | Remove editor's note and white spaces | 17.1.0 | +| 2022-12 | CT#98-e | CP-223028 | 0001 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98-e | CP-223033 | 0007 | - | F | 29.553 Rel-18 API version and External doc update | 18.0.0 | +| 2023-06 | CT#100 | CP-231026 | 0011 | - | B | OAuth2 scopes in the Npanf_ProseKey API | 18.1.0 | +| 2023-06 | CT#100 | CP-231078 | 0015 | 2 | A | Adding Npanf_ResolveRemoteUserId service | 18.1.0 | +| 2023-06 | CT#100 | CP-231070 | 0018 | - | F | 29.553 Rel-18 API version and External doc update | 18.1.0 | +| 2023-09 | CT#101 | CP-232071 | 0021 | - | A | Resolve Editor's Note | 18.2.0 | +| 2023-09 | CT#101 | CP-232071 | 0023 | 1 | F | Corrections on Npanf_ResolveRemoteUserId | 18.2.0 | +| 2023-12 | CT#102 | CP-233055 | 0024 | 1 | B | Update the functionalities of PANF | 18.3.0 | +| 2023-12 | CT#102 | CP-233028 | 0025 | 1 | F | RFC7540 obsoleted by RFC9113 | 18.3.0 | +| 2023-12 | CT#102 | CP-233031 | 0028 | 1 | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.3.0 | +| 2023-12 | CT#102 | CP-233031 | 0029 | 1 | F | Editorial Correction | 18.3.0 | +| 2023-12 | CT#102 | CP-233082 | 0030 | - | F | 29.553 Rel-18 API version and External doc update | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29554/raw.md b/raw/rel-18/29_series/29554/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..61cbecb92a7cd7cafcb46495e2ba26e45f78ddc0 --- /dev/null +++ b/raw/rel-18/29_series/29554/raw.md @@ -0,0 +1,1676 @@ + + +# 3GPP TS 29.554 V18.2.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Background Data Transfer Policy Control Service; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- Keywords --- + +## **3GPP** + +## --- Postal address --- + +### 3GPP support office address --- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## Internet --- + + + +--- + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Background Data Transfer Policy Control Service..... | 8 | +| 4.1 Service Description ..... | 8 | +| 4.1.1 Overview ..... | 8 | +| 4.1.2 Service Architecture ..... | 8 | +| 4.1.3 Network Functions ..... | 9 | +| 4.1.3.1 Policy Control Function (PCF) ..... | 9 | +| 4.1.3.2 NF Service Consumers ..... | 9 | +| 4.2 Service Operations ..... | 9 | +| 4.2.1 Introduction ..... | 9 | +| 4.2.2 Npcf_BDTPolicyControl_Create service operation..... | 10 | +| 4.2.2.1 General..... | 10 | +| 4.2.2.2 Retrieval of BDT policies ..... | 10 | +| 4.2.3 Npcf_BDTPolicyControl_Update service operation..... | 12 | +| 4.2.3.1 General..... | 12 | +| 4.2.3.2 Indication about selected transfer policy ..... | 12 | +| 4.2.3.3 Modification of BDT warning notification request indication ..... | 13 | +| 4.2.4 Npcf_BDTPolicyControl_Notify service operation..... | 13 | +| 4.2.4.1 General..... | 13 | +| 4.2.4.2 Sending the BDT warning notification..... | 14 | +| 5 Npcf_BDTPolicyControl API..... | 15 | +| 5.1 Introduction ..... | 15 | +| 5.2 Usage of HTTP..... | 15 | +| 5.2.1 General ..... | 15 | +| 5.2.2 HTTP standard headers ..... | 15 | +| 5.2.2.1 General..... | 15 | +| 5.2.2.2 Content type..... | 16 | +| 5.2.3 HTTP custom headers ..... | 16 | +| 5.3 Resources ..... | 16 | +| 5.3.1 Resource Structure..... | 16 | +| 5.3.2 Resource: BDT policies (Collection) ..... | 17 | +| 5.3.2.1 Description..... | 17 | +| 5.3.2.2 Resource definition..... | 17 | +| 5.3.2.3 Resource Standard Methods ..... | 17 | +| 5.3.2.3.1 POST ..... | 17 | +| 5.3.2.4 Resource Custom Operations..... | 18 | +| 5.3.3 Resource: Individual BDT policy (Document) ..... | 18 | +| 5.3.3.1 Description..... | 18 | +| 5.3.3.2 Resource definition..... | 18 | +| 5.3.3.3 Resource Standard Methods ..... | 18 | +| 5.3.3.3.1 GET ..... | 18 | +| 5.3.3.3.2 PATCH..... | 19 | +| 5.4 Custom Operations without associated resources ..... | 20 | +| 5.5 Notifications..... | 20 | +| 5.5.1 General ..... | 20 | +| 5.5.2 BDT Notification..... | 21 | +| 5.5.2.1 Description..... | 21 | +| 5.5.2.2 Target URI ..... | 21 | +| 5.5.2.3 Standard Methods ..... | 21 | + +| | | | +|---------------------------------------------------------|------------------------------------------|-----------| +| 5.5.2.3.1 | POST ..... | 21 | +| 5.6 | Data Model..... | 22 | +| 5.6.1 | General ..... | 22 | +| 5.6.2 | Structured data types ..... | 23 | +| 5.6.2.1 | Introduction..... | 23 | +| 5.6.2.2 | Type BdtPolicy ..... | 24 | +| 5.6.2.3 | Type BdtReqData ..... | 25 | +| 5.6.2.4 | Type BdtPolicyData..... | 26 | +| 5.6.2.5 | Type TransferPolicy ..... | 26 | +| 5.6.2.6 | Type BdtPolicyDataPatch..... | 26 | +| 5.6.2.7 | Void ..... | 27 | +| 5.6.2.8 | Type NetworkAreaInfo..... | 27 | +| 5.6.2.9 | Void ..... | 27 | +| 5.6.2.10 | Type Notification..... | 27 | +| 5.6.2.11 | Type PatchBdtPolicy ..... | 27 | +| 5.6.2.12 | Type BdtReqDataPatch..... | 28 | +| 5.6.3 | Simple data types and enumerations ..... | 28 | +| 5.6.3.1 | Introduction..... | 28 | +| 5.6.3.2 | Simple data types ..... | 28 | +| 5.7 | Error handling ..... | 28 | +| 5.7.1 | General ..... | 28 | +| 5.7.2 | Protocol Errors..... | 28 | +| 5.7.3 | Application Errors ..... | 28 | +| 5.8 | Feature negotiation..... | 29 | +| 5.9 | Security..... | 29 | +| Annex A (normative): OpenAPI specification ..... | | 30 | +| A.1 | General..... | 30 | +| A.2 | Npcf_BDTPolicyControl API..... | 30 | +| Annex B (informative): Change history ..... | | 37 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd 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. + +# 1 Scope + +The present specification provides the stage 3 definition of the Background Data Transfer (BDT) Policy Control Service (Npcf\_BDTPolicyControl) of the 5G System. + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The stage 2 definition and related procedures for BDT Policy Control Service are specified in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. + +The 5G System stage 3 call flows are provided in 3GPP TS 29.513 [5]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [6] and 3GPP TS 29.501 [7]. + +The Policy Control Function (PCF) provides the BDT Policy Control Service. This service provides background data transfer policy negotiation function. + +# 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [5] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [6] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [7] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [8] IETF RFC 9113: "HTTP/2". +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [11] 3GPP TS 29.504: "5G System; Unified Data Repository Services; Stage 3". +- [12] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for exposure; Stage 3". +- [13] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [14] 3GPP TS 29.122: "T8 reference point for Northbound APIs". +- [15] IETF RFC 7396: "JSON Merge Patch". +- [16] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". + +- [17] IETF RFC 9457: "Problem Details for HTTP APIs". +- [18] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [19] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [20] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [21] 3GPP TR 21.900: "Technical Specification Group working methods". +- [22] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". + +# --- 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]. + +**Background data transfer:** feature that enables a 3rd party service provider to keep their costs lower by favouring time windows for data transfer to specific UEs in a geographical area during non-busy hours that are less costly and able to handle larger bitrates. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.501 [2], clause 3.1 apply: + +**5G System** + +**Network Function** + +**NF service** + +**NF service operation** + +**Service based interface** + +## 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 | +| ASP | Application Service Provider | +| BDT | Background Data Transfer | +| DNN | Data Network Name | +| JSON | JavaScript Object Notation | +| NEF | Network Exposure Function | +| NG-RAN | Next Generation - Radio Access Network | +| NRF | Network Repository Function | +| NWDAF | Network Data Analytics Function | +| PCF | Policy Control Function | +| SBI | Service Based Interface | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| TAI | Tracking Area Identity | +| UDR | Unified Data Repository | + +# 4 Background Data Transfer Policy Control Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The BDT Policy Control Service, as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4], is provided by the Policy Control Function (PCF). + +This service enables the NF service consumer to negotiate policy for a future background data transfer and offers the following functionalities: + +- get background data transfer policies based on the request from the NF service consumer; +- update background data transfer policies based on the selection provided by the NF service consumer; and +- provide background data transfer warning notification to trigger renegotiation of background data transfer policy. + +### 4.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Policy and Charging related 5G architecture is also described in 3GPP TS 29.513 [5]. + +The BDT Policy Control Service (Npcf\_BDTPolicyControl) is part of the Npcf service-based interface exhibited by the Policy Control Function (PCF). + +The only known NF service consumer of the Npcf\_BDTPolicyControl service is the Network Exposure Function (NEF). + +The NEF accesses the BDT Policy Control Service at the PCF via the N30 Reference point. In the roaming scenario, the N30 reference point is located between the PCF and the NEF in the home network only. + +![Reference Architecture for the Npcf_BDTPolicyControl Service; SBI representation](18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg) + +The diagram illustrates the service-based interface (SBI) representation for the Npcf\_BDTPolicyControl service. It shows a top box labeled 'PCF' containing an oval labeled 'Npcf'. A vertical line descends from this oval to a bottom box labeled 'NEF'. The vertical line is labeled 'Npcf\_BDTPolicyControl' to its right. + +Reference Architecture for the Npcf\_BDTPolicyControl Service; SBI representation + +Figure 4.1.2-1: Reference Architecture for the Npcf\_BDTPolicyControl Service; SBI representation + +![Reference Architecture for the Npcf_BDTPolicyControl Service. The diagram shows a PCF (Policy Control Function) at the top connected to an NEF (Network Exposure Function) at the bottom via a vertical line labeled N30.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` + +graph TD + PCF[PCF] --- N30((N30)) + N30 --- NEF[NEF] + +``` + +Reference Architecture for the Npcf\_BDTPolicyControl Service. The diagram shows a PCF (Policy Control Function) at the top connected to an NEF (Network Exposure Function) at the bottom via a vertical line labeled N30. + +**Figure 4.1.2-2: Reference Architecture for the Npcf\_BDTPolicyControl Service; reference point representation** + +### 4.1.3 Network Functions + +#### 4.1.3.1 Policy Control Function (PCF) + +The Policy Control Function (PCF): + +- Provides background data transfer policies based on the request from the NF service consumer. The PCF determines, based on information provided by the NF service consumer and other available information (e.g. network policy, load status estimation for the requested time window, network area, etc.) one or more transfer policies. +- Updates background data transfer policy based on the selection provided by the NF service consumer. +- Sends the background data transfer warning notification to the NF service consumer. + +#### 4.1.3.2 NF Service Consumers + +The Network Exposure Function (NEF): + +- requests the PCF to provide background data transfer policies; +- provides the selected background data transfer policy to the PCF; and +- indicates to the PCF whether to provide a BDT warning notification. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +**Table 4.2.1-1: Operations of the Npcf\_BDTPolicyControl Service** + +| Service operation name | Description | Initiated by | +|------------------------------|-----------------------------------------------------------------------------------------------|--------------------------------| +| Npcf_BDTPolicyControl_Create | Provides the requested background data transfer policies to the NF service consumer. | NF service consumer (e.g. NEF) | +| Npcf_BDTPolicyControl_Update | Updates the PCF with the background data transfer policy selected by the NF service consumer. | NF service consumer (e.g. NEF) | +| Npcf_BDTPolicyControl_Notify | Sends the BDT notification to the NF service consumer. | PCF | + +### 4.2.2 Npcf\_BDTPolicyControl\_Create service operation + +#### 4.2.2.1 General + +The Npcf\_BDTPolicyControl\_Create service operation is used by an NF service consumer to retrieve BDT policies from the PCF. + +The following procedure using the Npcf\_BDTPolicyControl\_Create service operation is supported: + +- retrieval of BDT policies. + +#### 4.2.2.2 Retrieval of BDT policies + +This procedure is used by the NF service consumer to request BDT policies from the PCF, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. + +Figure 4.2.2.2-1 illustrates a retrieval of BDT policies. + +![Sequence diagram illustrating the retrieval of BDT policies between an NF service consumer and a PCF.](b10763be31553f31cbb795653b731a43_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST .../bdtpolicies + NF service consumer->>PCF: 1. POST .../bdtpolicies + Note left of PCF: 2. "201 Created" + PCF-->>NF service consumer: 2. "201 Created" +``` + +The diagram shows a sequence of two messages between an NF service consumer and a PCF. The first message is a POST request from the NF service consumer to the PCF, labeled "1. POST .../bdtpolicies". The second message is a response from the PCF to the NF service consumer, labeled "2. "201 Created"". The arrows indicate the direction of the messages: the first arrow points from the NF service consumer to the PCF, and the second arrow points from the PCF to the NF service consumer. + +Sequence diagram illustrating the retrieval of BDT policies between an NF service consumer and a PCF. + +**Figure 4.2.2.2-1: Retrieval of BDT policies** + +Upon reception of a Background Data Transfer request from the AF indicating a transfer policy request, the NF service consumer shall invoke the Npcf\_BDTPolicyControl\_Create service operation by sending an HTTP POST request to the URI representing a "BDT policies" collection resource of the PCF (as shown in figure 4.2.2.2-1, step 1). The NF service consumer shall include a "BdtReqData" data type in a content of the HTTP POST request. The "BdtReqData" data type shall contain: + +- an ASP identifier in the "aspId" attribute; +- a volume of data per UE in the "volPerUe" attribute; +- an expected number of UEs in the "numOfUes" attribute; +- a desired time window in the "desTimeInt" attribute; and +- if "BdtNotification\_5G" feature is supported a notification URI in the "notifUri" attribute, + +and may include: + +- a network area information (e.g. list of TAIs and/or NG-RAN nodes and/or cells identifiers) in the "nwAreaInfo" attribute; +- an identification of a group of UE(s) via an "interGroupId" attribute; +- a traffic descriptor of background data within the "trafficDes" attribute; +- if "BdtNotification\_5G" feature is supported an indication whether BDT warning notification is requested in the "warnNotifReq" attribute; and +- a DNN and an S-NSSAI, corresponding to the ASP identifier, in the "dnn" attribute and the "snssai" attribute respectively. + +If the PCF cannot successfully fulfil the received HTTP POST request due to the internal PCF error or due to the error in the HTTP POST request, the PCF shall send the HTTP error response as specified in clause 5.7. + +Otherwise, upon the reception of the HTTP POST request from the NF service consumer indicating a BDT policies request, the PCF: + +- may invoke the Nudr\_DataRepository\_Query service operation, as described in 3GPP TS 29.504 [11] and 3GPP TS 29.519 [12], to request from the UDR all stored transfer policies; + +NOTE 1: In case only one PCF is deployed in the network, transfer policies can be locally stored in the PCF and the interaction with the UDR is not required. + +- shall determine one or more acceptable transfer policies based on: + - a) information provided by the NF service consumer; and + - b) other available information (e.g. the existing transfer policies, network policy, load status estimation for the desired time window); and +- shall create a BDT Reference ID. + +The PCF shall send to the NF service consumer a "201 Created" response to the HTTP POST request, as shown in figure 4.2.2.2-1, step 2. The PCF shall include in the "201 Created" response: + +- a Location header field; and +- a "BdtPolicy" data type in the response content containing the BDT Reference ID in the "bdtRefId" attribute and acceptable transfer policy/ies in the "transfPolicies" attribute. + +The Location header field shall contain the URI of the created individual BDT policy resource i.e. "{apiRoot}/npcf-bdtpolicycontrol/v1/bdtpolicies/{bdtPolicyId}". + +For each included transfer policy, the PCF shall provide: + +- a transfer policy ID in the "transPolicyId" attribute; +- a recommended time window in the "recTimeInt" attribute; and +- a reference to charging rate for the recommended time window in the "ratingGroup" attribute, + +and may provide a maximum aggregated bitrate for the uplink direction in the "maxBitRateU1" attribute and/or a maximum aggregated bitrate for the downlink direction in the "maxBitRateD1" attribute. + +If the BdtNotification\_5G feature is supported the PCF shall not assign value "0" for any transfer policy ID. + +NOTE 2: As specified in clause 4.2.3.2, value "0" of transfer policy ID is reserved and indicates that no transfer policy is selected. + +The PCF may map the ASP identifier into a target DNN and S-NSSAI based on local configuration if the NF service consumer did not provide the DNN and S-NSSAI to the PCF. + +If the PCF included in the "BdtPolicy" data type: + +- more than one transfer policy, the PCF shall wait for the transfer policy selected by the NF service consumer as described in clause 4.2.3; or +- only one transfer policy, the PCF may invoke the Nudr\_DataRepository\_Update service operation, as described in 3GPP TS 29.504 [11] and 3GPP TS 29.519 [12] clause 5.2.9.3.2, to update the UDR with the selected transfer policy, the corresponding BDT Reference ID, the volume of data per UE, the expected number of UEs and, if available, a network area information, the associated DNN and S-NSSAI for the provided ASP identifier, traffic descriptor of background data and if "BdtNotification\_5G" feature is supported an indication whether BDT warning notification is requested. + +NOTE 3: In case only one PCF is deployed in the network, transfer policies can be locally stored in the PCF and the interaction with the UDR is not required. + +### 4.2.3 Npcf\_BDTPolicyControl\_Update service operation + +#### 4.2.3.1 General + +The Npcf\_BDTPolicyControl\_Update service operation is used by an NF service consumer to update a BDT policy to the PCF. + +The following procedure using the Npcf\_BDTPolicyControl\_Update service operation are supported: + +- indication about selected transfer policy; and +- modification of a BDT warning notification request indication. + +#### 4.2.3.2 Indication about selected transfer policy + +When the feature "PatchCorrection" is supported, this procedure is used by the NF service consumer to inform the PCF about selected transfer policy, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4], if the AF selected the transfer policy from the received transfer policy list after: + +- retrieval of the BDT policies as described in clause 4.2.2; or +- reception of the BDT warning notification as described in clause 4.2.4. + +Figure 4.2.3.2-1 illustrates an indication about selected transfer policy. + +![Sequence diagram showing the interaction between an NF service consumer and a PCF for indicating a selected transfer policy. The NF service consumer sends a PATCH request to the PCF. The PCF responds with either a 204 No Content or a 200 OK status.](5a95b187de0044da69b7322e04761b86_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. PATCH .../bdtpolicies/{bdtpolicyId} + NF service consumer->>PCF: 1. PATCH .../bdtpolicies/{bdtpolicyId} + Note left of PCF: 2a. "204 No Content" or + Note left of PCF: 2b. "200 OK" + PCF-->>NF service consumer: 2a. "204 No Content" or 2b. "200 OK" +``` + +Sequence diagram showing the interaction between an NF service consumer and a PCF for indicating a selected transfer policy. The NF service consumer sends a PATCH request to the PCF. The PCF responds with either a 204 No Content or a 200 OK status. + +Figure 4.2.3.2-1: Indication about selected transfer policy + +Upon reception of a Background Data Transfer request from the AF indicating transfer policy selection, the NF service consumer shall invoke the Npcf\_BDTPolicyControl\_Update service operation by sending an HTTP PATCH request to the PCF, as shown in figure 4.2.3.2-1, step 1. The NF service consumer shall set the request URI to "{apiRoot}/npcf-bdtpolicycontrol/v1/bdtpolicies/{bdtpolicyId}". + +The NF service consumer shall include a "PatchBdtPolicy" data type in a content of the HTTP PATCH request. When the AF selects a transfer policy, the "PatchBdtPolicy" data type shall contain a "bdtPolData" attribute which shall encode the transfer policy ID of the selected transfer policy in the "selTransPolicyId" attribute. In the case of transfer policy re-negotiation and if the BdtNotification\_5G feature is supported and the AF did not select any transfer policy, the NF service consumer shall set the "selTransPolicyId" attribute to value "0" to indicate no transfer policy is selected. + +If the PCF cannot successfully fulfil the received HTTP PATCH request due to the internal PCF error or due to the error in the HTTP PATCH request, the PCF shall send the HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the PCF determines the received HTTP PATCH request needs to be redirected, the PCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +Otherwise, upon the reception of the HTTP PATCH request from the NF service consumer, the PCF: + +- in case of the initial transfer policy negotiation may invoke the Nudr\_DataRepository\_Update service operation, as described in 3GPP TS 29.504 [11] and 3GPP TS 29.519 [12] clause 5.2.9.3.2, to update the UDR with the + +selected transfer policy, the corresponding BDT Reference ID, the volume of data per UE, the expected number of UEs and, if available, a network area information, the associated DNN and S-NSSAI for the provided ASP identifier, traffic descriptor of background data and if "BdtNotification\_5G" feature is supported an indication whether BDT warning notification is requested; or + +- in case of transfer policy re-negotiation may invoke: + - a) if a transfer policy is selected the Nudr\_DataRepository\_Update service operation, as described in 3GPP TS 29.504 [11] and 3GPP TS 29.519 [12] clause 5.2.9.3.4, to update the UDR with the selected candidate transfer policy and set the "bdtpStatus" attribute to value "VALID" within the BdtDataPatch data type; or + - b) if no transfer policy is selected the Nudr\_DataRepository\_Delete service operation, as described in 3GPP TS 29.504 [11] and 3GPP TS 29.519 [12] clause 5.2.9.3.3, to remove the transfer policy from the UDR; and + +NOTE: In case only one PCF is deployed in the network, transfer policies can be locally stored in the PCF and the interaction with the UDR is not required. + +- shall send: + - a) a "204 No Content" response (as shown in figure 4.2.3.2-1, step 2a); or + - b) a "200 OK" response (as shown in figure 4.2.3.2-1, step 2b) with a "BdtPolicy" data type in the content, to the HTTP PATCH request to the NF service consumer. + +#### 4.2.3.3 Modification of BDT warning notification request indication + +This procedure is used by an AF to modify a BDT warning notification request indication when the feature "BdtNotification\_5G" and the feature "PatchCorrection" are supported. + +Upon reception of a request from the AF to modify the BDT warning notification request indication, the NF service consumer shall invoke the Npcf\_BDTPolicyControl\_Update service operation by sending an HTTP PATCH request to the PCF, as described in clause 4.2.3.2. The NF service consumer shall indicate whether a BDT warning notification shall be enabled or disabled by including the "warnNotifReq" attribute in the "bdReqData" attribute of the "PatchBdtPolicy" data type. + +If the BDT warning notification is not required anymore the NF service consumer shall set the value of the "warnNotifReq" attribute to "false". + +If the BDT warning notification is again required the NF service consumer shall set the value of the "warnNotifReq" attribute to "true". + +Upon the reception of the HTTP PATCH request from the NF service consumer indicating a modification of the BDT warning notification request indication, the PCF shall: + +- acknowledge that request by sending an HTTP response message as described in clause 4.2.3.2; and +- if the PCF invoked the Nudr\_DataRepository\_Update service operation during the initial transfer policy negotiation, invoke the Nudr\_DataRepository\_Update service operation, as described in 3GPP TS 29.504 [11] and 3GPP TS 29.519 [12] clause 5.2.9.3.4, to update the UDR with the modified BDT warning notification request indication. + +### 4.2.4 Npcf\_BDTPolicyControl\_Notify service operation + +#### 4.2.4.1 General + +The Npcf\_BDTPolicyControl\_Notify service operation is used by the PCF to send the BDT notification to the NF service consumer. + +The following procedure using the Npcf\_BDTPolicyControl\_Notify service operation is supported: + +- sending the BDT warning notification to the NF service consumer. + +#### 4.2.4.2 Sending the BDT warning notification + +This procedure is used by the PCF to inform the NF service consumer that network performance in the area of interest goes below the criteria set by the operator, as defined in clause 6.1.2.4 of 3GPP TS 23.503 [4]. + +Figure 4.2.4.2-1 illustrates a BDT warning notification from the PCF. + +![Sequence diagram showing the BDT warning notification process between PCF and NF service consumer.](1b5a812c8aa20fd5cba28e97001d32de_img.jpg) + +``` +sequenceDiagram + participant PCF + participant NF as NF service consumer + Note right of PCF: 1. POST {notifUri} + PCF->>NF: + Note right of NF: 2. "204 No Content" + NF-->>PCF: +``` + +The diagram illustrates a sequence of two messages between the PCF and the NF service consumer. The first message, labeled '1. POST {notifUri}', is sent from the PCF to the NF service consumer. The second message, labeled '2. "204 No Content"', is sent from the NF service consumer back to the PCF. + +Sequence diagram showing the BDT warning notification process between PCF and NF service consumer. + +Figure 4.2.4.2-1: BDT warning notification + +When the PCF knows that the network performance in the area of interest goes below the criteria set by the operator from the NWDAF as described in 3GPP TS 29.520 [22] and if the BDT warning notification is enabled, the PCF may try to re-negotiate the affected BDT policies with the affected AFs. To do this, the PCF retrieves all the background transfer policies together with their additionally stored AF provided information for BDT policy decision (e.g. their corresponding desired time window, the number of UEs, the volume of data per UE, etc.) from the UDR, identifies the BDT policy(ies) that are not desirable anymore due to the degradation of the network performance and tries to calculate one or more new candidate BDT policies based on the AF provided information, the background transfer policies retrieved from the UDR and the current network performance as follows: + +- If the BDT policies retrieved from the UDR include the "bdtpStatus" attribute indicating the BDT policy is invalid, the PCF may calculate one or more new candidate BDT policies without considering the invalid BDT policy. +- If the PCF does not find any new candidate BDT policies, the previously negotiated BDT policy shall be kept and no interaction with the AF shall occur. + +If one or more new candidate BDT policies are calculated, the PCF shall: + +- if the PCF has not locally stored the background transfer policies, invoke the Nudr\_DataRepository\_Update service operation, as described in 3GPP TS 29.504 [11] and 3GPP TS 29.519 [12] clause 5.2.9.3.4, to invalidate the affected background transfer policy stored in the UDR by including the "bdtpStatus" attribute set to value "INVALID" within the BdtDataPatch data type; and +- invoke the Npcf\_BDTPolicyControl\_Notify service operation by sending the HTTP POST request with the BDT warning notification to the NF service consumer so that the NF service consumer can notify the AF. + +The PCF shall include a "Notification" data type in a content of the HTTP POST request. + +The "Notification" data type provided in the request body: + +- shall contain the BDT Reference ID of the impacted transfer policy within the "bdtrRefId" attribute; +- may contain the time window when the network performance will go below the criteria set by the operator within the "timeWindow" attribute; +- may contain the network area where the network performance will go below the criteria set by the operator within the "nwAreaInfo" attribute; and +- may contain the list of candidate transfer policies in the "candPolicies" attribute. + +NOTE: The AF might select a new background transfer policy or might not select any new background transfer policy from the offered candidate list when receives the BDT warning notification. + +Upon the reception of the HTTP POST request from the PCF, the NF service consumer shall acknowledge that request by sending an HTTP response message with the corresponding status code. + +If the HTTP POST request from the PCF is accepted, the NF service consumer shall acknowledge the receipt of the notification with a "204 No Content" response to HTTP POST request, as shown in figure 4.2.4.2-1, step 2. + +If the HTTP POST request from the PCF is not accepted, the NF service consumer shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +# --- 5 Npcf\_BDTPolicyControl API + +## 5.1 Introduction + +The BDT Policy Control Service shall use the Npcf\_BDTPolicyControl API. + +The API URI of the Npcf\_BDTPolicyControl API shall be: + +**{apiRoot}** + +The request URI used in each HTTP request from the NF service consumer towards the PCF shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "npcf-bdtpolicycontrol". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5.2 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [10] specification of HTTP messages and content bodies for the Npcf\_BDTPolicyControl is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +#### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [9], 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 [6]. The use of the JSON format shall be signalled by the content type "application/json". + +JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" and shall be signalled by the content type "application/merge-patch+json", as defined in IETF RFC 7396 [15]. + +"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 9457 [17]. + +### 5.2.3 HTTP custom headers + +The Npcf\_BDTPolicyControl API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this Release of the specification, no specific custom headers are defined for the Npcf\_BDTPolicyControl API. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.3.1-1 depicts the resource URIs structure for the Npcf\_BDTPolicyControl API. + +![Diagram showing the resource URI structure for the Npcf_BDTPolicyControl API. The root URI is {apiRoot}/npcf-bdtpolicycontrol/v1. A line branches down to a box containing /bdtpolicies. From this box, another line branches down to a box containing /{bdtpolicyId}.](69f52512bb7387a5dc9f952279513019_img.jpg) + +``` + +graph TD + Root["{apiRoot}/npcf-bdtpolicycontrol/v1"] --> Policies["/bdtpolicies"] + Policies --> PolicyId["/{bdtpolicyId}"] + +``` + +Diagram showing the resource URI structure for the Npcf\_BDTPolicyControl API. The root URI is {apiRoot}/npcf-bdtpolicycontrol/v1. A line branches down to a box containing /bdtpolicies. From this box, another line branches down to a box containing /{bdtpolicyId}. + +**Figure 5.3.1-1: Resource URI structure of the Npcf\_BDTPolicyControl API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------|----------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| BDT policies | /bdtpolicies | POST | Npcf_BDTPolicyControl_Create.
Creates a new Individual BDT policy resource. | +| Individual BDT policy | /bdtpolicies/{bdtpolicyId} | GET | Reads an Individual BDT policy resource. | +| | | PATCH | Npcf_BDTPolicyControl_Update.
Modifies an existing Individual BDT policy resource by selecting or reselecting a transfer policy. | + +### 5.3.2 Resource: BDT policies (Collection) + +#### 5.3.2.1 Description + +The BDT policies resource represents all the transfer policies that exist in the BDT Policy Control service at a given PCF instance. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/npcf-bdtpolicycontrol/v1/bdtpolicies + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-----------------| +| apiRoot | string | See clause 5.1. | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------|---|-------------|--------------------------------------------------------------------------------| +| BdtReqData | M | 1 | Contains information for the creation of a new Individual BDT policy resource. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BdtPolicy | M | 1 | 201 Created | Successful case.
The creation of an Individual BDT policy resource is confirmed and a representation of that resource is returned. | +| n/a | | | 303 See Other | The result of the HTTP POST request would be equivalent to the existing Individual BDT policy resource. The HTTP response shall contain a Location header field set to the URI of the existing individual BDT policy resource. | +| NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [6] for the POST method shall also apply. | | | | | + +**Table 5.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}/npcf-bdtpolicycontrol/v1/bdtpolicies/{bdtPolicyId}. | + +**Table 5.3.2.3.1-5: Headers supported by the 303 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the existing individual BDT policy resource. | + +#### 5.3.2.4 Resource Custom Operations + +None. + +### 5.3.3 Resource: Individual BDT policy (Document) + +#### 5.3.3.1 Description + +The Individual BDT policy resource represents the transfer policies that exist in the BDT Policy Control service at a given PCF instance. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/npcf-bdtpolicycontrol/v1/bdtpolicies/{bdtpolicyId} + +This resource shall support the resource URI variables defined in table 5.3.3.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.1. | +| bdtpolicyId | string | Identifies the individual BDT policy resource in the PCF.
To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [7] and rules for a path segment defined in IETF RFC 3986 [16]. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-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.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.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.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------| +| BdtPolicy | M | 1 | 200 OK | A representation of an Individual BDT policy resource is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource retrieval. Applicable if the feature "ES3XX" is supported. (NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource retrieval. Applicable if the feature "ES3XX" is supported. (NOTE 3) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [6] for the GET method shall also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +**Table 5.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PatchBdtPolicy | M | 1 | Contains modification instructions to be performed on the BdtPolicy data structure to select a transfer policy and in addition, may indicate whether the BDT warning notification is enabled or disabled. | + +**Table 5.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------| +| BdtPolicy | M | 1 | 200 OK | Successful case.
The Individual BDT Policy resource is modified and a representation of that resource is returned. | +| n/a | | | 204 No Content | Successful case.
The Individual BDT Policy resource is modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource modification.
Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource modification.
Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [6] for the PATCH method shall also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +## 5.4 Custom Operations without associated resources + +No custom operation is defined in this Release of the specification. + +## 5.5 Notifications + +### 5.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +Table 5.5.1-1: Notifications overview + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------|--------------|---------------------------------|---------------------------------| +| BDT Notification | {notifUri} | POST | Provides BDT notification. | + +### 5.5.2 BDT Notification + +#### 5.5.2.1 Description + +The BDT Notification is used by the PCF to notify the NF service consumer about changed conditions for background data transfer e.g. that a network performance in the area of interest goes below the criteria set by the operator. + +#### 5.5.2.2 Target URI + +The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 5.5.2.2-1. + +Table 5.5.2.2-1: Callback URI variables + +| Name | Data type | Definition | +|----------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | It contains the URI of the recipient of BDT notification as assigned by the NF service consumer during the Create service operation and described within the BdtReqData (see table 5.6.2.3-1). | + +#### 5.5.2.3 Standard Methods + +##### 5.5.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.2.3.1-1. + +Table 5.5.2.3.1-1: URI query parameters supported by the POST method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.2.3.1-2 and the response data structures and response codes specified in table 5.5.2.3.1-3. + +Table 5.5.2.3.1-2: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|----------------------------| +| Notification | M | 1 | Provides BDT notification. | + +**Table 5.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 | Successful case.
The reception of the BDT notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [6] for the POST method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.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 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 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.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 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.1-1 specifies the data types defined for the Npcf\_BDTPolicyControl service based interface protocol. + +**Table 5.6.1-1: Npcf\_BDTPolicyControl specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| BdtPolicy | 5.6.2.2 | Represents an Individual BDT policy resource. | | +| BdtPolicyData | 5.6.2.4 | Describes an Individual BDT policy resource. | | +| BdtPolicyDataPatch | 5.6.2.6 | Contains modification instructions to be performed on the "bdtPolData" property of the BdtPolicy data structure to select a transfer policy. | | +| BdtReqData | 5.6.2.3 | Contains information for creation a new Individual BDT policy resource. | | +| BdtReqDataPatch | 5.6.2.12 | Describes the modifications to the BDT request data of an Individual BDT policy resource. | PatchCorrection | +| NetworkAreaInfo | 5.6.2.8 | Describes a network area information in which the NF service consumer requests the number of UEs. | | +| Notification | 5.6.2.10 | Contains the BDT notification information. | BdtNotification_5G | +| PatchBdtPolicy | 5.6.2.11 | Describes the modifications to the BDT Policy Data and BDT Policy Request data of an Individual BDT policy resource. | PatchCorrection | +| TransferPolicy | 5.6.2.5 | Describes a transfer policy. | | + +Table 5.6.1-2 specifies data types re-used by the Npcf\_BDTPolicyControl 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 Npcf\_BDTPolicyControl service based interface. + +**Table 5.6.1-2: Npcf\_BDTPolicyControl re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|--------------------------------------------------------------------------------------|--------------------| +| BdtReferenceId | 3GPP TS 29.122 [14] | Identifies transfer policy of background data transfer for provided ASP. | | +| BitRate | 3GPP TS 29.571 [13] | Specifies bitrate in kbits per second. | | +| Dnn | 3GPP TS 29.571 [13] | Identifies a Data Network Name. | | +| Ecgi | 3GPP TS 29.571 [13] | Represents an EUTRA cell identifier. | | +| GlobalRanNodeId | 3GPP TS 29.571 [13] | Represents an identity of the NG-RAN node. | | +| GroupId | 3GPP TS 29.571 [13] | Identifies a group of UEs. | | +| Ncgi | 3GPP TS 29.571 [13] | Represents an NR cell identifier. | | +| ProblemDetails | 3GPP TS 29.571 [13] | Used in error responses to provide more detailed information about an error. | | +| RedirectResponse | 3GPP TS 29.571 [13] | Contains redirection related information. | ES3XX | +| Snssai | 3GPP TS 29.571 [13] | Identifies a Single Network Slice Selection Assistance Information. | | +| SupportedFeatures | 3GPP TS 29.571 [13] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | +| Tai | 3GPP TS 29.571 [13] | Represents a tracking area identity. | | +| TimeWindow | 3GPP TS 29.122 [14] | Specifies a time interval. | | +| TrafficDescriptor | 3GPP TS 29.122 [14] | Represents a traffic descriptor. | | +| Uri | 3GPP TS 29.571 [13] | String providing an URI. | BdtNotification_5G | +| UsageThreshold | 3GPP TS 29.122 [14] | Represents a data volume expected to be transferred per UE. | | + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 5.6.2.2 Type BdtPolicy + +Table 5.6.2.2-1: Definition of type BdtPolicy + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| bdtPolData | BdtPolicyData | C | 0..1 | Describes the authorization data of an Individual BDT Policy created by the PCF.
It shall be present in the response to the POST request that requests a creation of an Individual BDT Policy resource and in the response to GET request. | | +| bdtReqData | BdtReqData | C | 0..1 | Identifies the service requirements of an Individual BDT Policy.
It shall be present in the POST request that requests a creation of an Individual BDT Policy resource and in the response to GET request. | | + +#### 5.6.2.3 Type BdtReqData + +Table 5.6.2.3-1: Definition of type BdtReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| aspld | Aspld | M | 1 | This IE contains an identity of an application service provider. | | +| desTimeInt | TimeWindow | M | 1 | This IE indicates a desired time window for BDT. | | +| dnn | Dnn | O | 0..1 | This IE identifies a DNN. A full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.
(NOTE) | | +| interGroupId | GroupId | O | 0..1 | Represents an internal group identifier and identifies a group of UEs. | | +| notifUri | Uri | O | 0..1 | This IE indicates that the NF service consumer requests a BDT notification from the PCF. It contains an URI of the recipient of BDT notification. | BdtNotification_5G | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | This IE represents a network area information in which the NF service consumer requests a number of UEs.
It may be present in the POST request that requests a creation of an Individual BDT Policy and in the response to GET request. | | +| numOfUes | integer | M | 1 | This IE indicates a number of UEs. | | +| snssai | Snssai | O | 0..1 | This IE identifies a slice. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.8.
It shall be supplied by the NF service consumer in the POST request that request a creation of an Individual BDT Policy resource. | | +| trafficDes | TrafficDescriptor | O | 0..1 | Contains the traffic descriptor of the background data. | | +| volPerUe | UsageThreshold | M | 1 | This IE indicates a data volume expected to be transferred per UE. | | +| warnNotifReq | boolean | O | 0..1 | This IE indicates whether the BDT warning notification is enabled or disabled.
It may be present:
- in the POST request that requests a creation of an Individual BDT Policy and in the corresponding response; and
- in responses to GET and PATCH requests.

true: enabled;
false: disabled (default). | BdtNotification_5G | + +NOTE: The PCF uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. + +#### 5.6.2.4 Type BdtPolicyData + +**Table 5.6.2.4-1: Definition of type BdtPolicyData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| bdRefId | BdtReferenceId | M | 1 | This IE indicates transfer policies of background data transfer for provided ASP. | | +| selTransPolicyId | integer | C | 0..1 | This IE contains the identity of the selected transfer policy. It shall be present in the response to the PATCH request that modifies an Individual BDT Policy resource to indicate a selected transfer policy. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.8. It shall be supplied by the PCF in the response to the POST request that requests a creation of an Individual BDT Policy resource. | | +| transfPolicies | array(TransferPolicy) | M | 1..N | This IE contains transfer policies. It shall be supplied by the PCF in the response to the POST request that requests a creation of an Individual BDT Policy resource. | | + +#### 5.6.2.5 Type TransferPolicy + +**Table 5.6.2.5-1: Definition of type TransferPolicy** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| maxBitRateDl | BitRate | O | 0..1 | This IE indicates a maximum aggregated bitrate in the downlink direction authorized by the PCF. | | +| maxBitRateUl | BitRate | O | 0..1 | This IE indicates a maximum aggregated bitrate in the uplink direction authorized by the PCF. | | +| ratingGroup | integer | M | 1 | This IE indicates a rating group for the recommended time window. | | +| recTimeInt | TimeWindow | M | 1 | This IE indicates a recommended time window of a transfer policy. | | +| transPolicyId | integer | M | 1 | This IE contains an identity of a transfer policy. | | + +#### 5.6.2.6 Type BdtPolicyDataPatch + +**Table 5.6.2.6-1: Definition of type BdtPolicyDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| selTransPolicyId | integer | M | 1 | This IE contains an identity (i.e. the transPolicyId value) of a selected transfer policy.
If the BdtNotification_5G feature is supported value "0" indicates that no transfer policy is selected. | | + +#### 5.6.2.7 Void + +#### 5.6.2.8 Type NetworkAreaInfo + +Table 5.6.2.8-1: Definition of type NetworkAreaInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ecgis | array(Ecgi) | O | 1..N | This IE contains a list of E-UTRA cell identities. | | +| ncgis | array(Ncgi) | O | 1..N | This IE contains a list of NR cell identities. | | +| gRanNodeIds | array(GlobalRanNodeId) | O | 1..N | This IE contains a list of the NG-RAN nodes.
The "n3lwfl" attribute within the "GlobalRanNodeId" data type shall not be supplied. | | +| tais | array(Tai) | O | 1..N | This IE contains a list of tracking area identities. | | + +NOTE: The NetworkAreaInfo data type allows any combination of defined properties. + +#### 5.6.2.9 Void + +#### 5.6.2.10 Type Notification + +Table 5.6.2.10-1: Definition of type Notification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| bdRefId | BdtReferenceId | M | 1 | This IE indicates transfer policies of background data transfer which the notification corresponds to. | | +| candPolicies | array(TransferPolicy) | O | 1..N | This IE contains a list of the candidate transfer policies from which the AF may select a new transfer policy due to a network performance is below the criteria set by the operator. | | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | This IE represents a network area where a network performance will go below the criteria set by the operator. | | +| timeWindow | TimeWindow | O | 0..1 | This IE indicates a time window when a network performance will go below the criteria set by the operator. | | + +#### 5.6.2.11 Type PatchBdtPolicy + +Table 5.6.2.11-1: Definition of type PatchBdtPolicy + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| bdPolData | BdtPolicyDataPatch | O | 0..1 | Describes the updates in BDT policy data of an Individual BDT Policy resource, e.g., describes the selected BDT policy. | | +| bdReqData | BdtReqDataPatch | O | 0..1 | Describes the updates in BDT policy request data of an Individual BDT Policy resource, e.g., describes the updates in warning notification requirements. | | + +#### 5.6.2.12 Type BdtReqDataPatch + +**Table 5.6.2.12-1: Definition of type BdtReqDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------|--------------------| +| warnNotifReq | boolean | O | 0..1 | This IE indicates whether the BDT warning notification is enabled or disabled. | BdtNotification_5G | + +### 5.6.3 Simple data types and enumerations + +#### 5.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.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|------------------------------------------------------------------|---------------| +| Aspld | string | This IE contains an identity of an application service provider. | | + +## 5.7 Error handling + +### 5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [6]. + +For the Npcf\_BDTPolicyControl API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [7]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] 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 [6]. + +In addition, the requirements in the following clauses shall apply. + +### 5.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Npcf\_BDTPolicyControl API. + +### 5.7.3 Application Errors + +The application errors defined for the Npcf\_BDTPolicyControl API are listed in table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|---------------------------------------------------------------------------------------------------------------| +| BDT_POLICY_NOT_FOUND | 404 Not Found | The HTTP request is rejected because the specified Individual BDT policy resource does not exist.
(NOTE 1) | +| NOTE 1: This application error is included in the responses to the GET and PATCH requests.
NOTE 2: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Npcf\_BDTPolicyControl API. They shall be negotiated using the extensibility mechanism defined in clause 6.6.2 of 3GPP TS 29.500 [6]. + +When requesting the PCF to create an Individual BDT policy resource the NF service consumer shall indicate the optional features the NF service consumer supports for the Npcf\_BDTPolicyControl service by including the "suppFeat" attribute in the "BdtReqData" data type of the HTTP POST request. + +The PCF shall determine the supported features for the created Individual BDT policy resource as specified in clause 6.6.2 of 3GPP TS 29.500 [6]. The PCF shall indicate the supported features in the HTTP response confirming the creation of the Individual BDT policy resource by including the "suppFeat" attribute in the "BdtPolicyData" data type. + +**Table 5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | BdtNotification_5G | This feature indicates the support of sending the BDT notification to the NF service consumer.
This feature includes sending of the BDT warning notification to the NF service consumer. | +| 2 | 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 [6] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. | +| 3 | PatchCorrection | Indicates support of the correction to the PATCH method.
When this feature is not supported, the interoperability between a NF service consumer and the PCF can only be ensured when it is not required the update of the Individual BDT policy resource. | + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [18] and 3GPP TS 29.500 [6], the access to the Npcf\_BDTPolicyControl API, based on local configuration, may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [19]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [20]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF service consumer, prior to consuming services offered by the Npcf\_BDTPolicyControl API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [20], 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 Npcf\_BDTPolicyControl service. + +The Npcf\_BDTPolicyControl API defines a single scope "npcf-bdtpolicycontrol" for OAuth2 authorization (as specified in 3GPP TS 33.501 [18]) for the entire API, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +The present Annex contains an OpenAPI [10] specification of HTTP messages and content bodies used by the Npcf\_BDTPolicyControl API. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [21] and clause 5.3.1 of the 3GPP TS 29.501 [7] for further information). + +## A.2 Npcf\_BDTPolicyControl API + +openapi: 3.0.0 + +### info: + +title: Npcf\_BDTPolicyControl Service API +version: 1.3.0-alpha.1 +description: | + PCF BDT Policy Control Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +### externalDocs: + +description: > + 3GPP TS 29.554 V18.0.0; 5G System; Background Data Transfer Policy Control Service. +url: 'https://www.3gpp.org/ftp/Specs/archive/29\_series/29.554/' + +### servers: + +- url: '{apiRoot}/npcf-bdtpolicycontrol/v1' +variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +### security: + +- {} +- oAuth2ClientCredentials: + - npcf-bdtpolicycontrol + +### paths: + +/bdtpolicies: + post: + summary: Create a new Individual BDT policy + operationId: CreateBDTPolicy + tags: + - BDT policies (Collection) + requestBody: + description: > + Contains information for the creation of a new Individual BDT policy resource. + required: true + content: + application/json: + schema: + \$ref: '#/components/schemas/BdtReqData' + responses: + '201': + description: Background data transfer policies offered to an ASP. + content: + +``` + application/json: + schema: + $ref: '#/components/schemas/BdtPolicy' + headers: + Location: + description: > + Contains the URI of the created individual BDT policy resource, + according to the structure + {apiRoot}/npcf-bdtpolicycontrol/v1/bdtpolicies/{bdtpolicyId} + required: true + schema: + type: string + '303': + description: > + See Other. The result of the POST request would be equivalent to the + existing Individual BDT policy resource. + headers: + Location: + description: Contains the URI of the existing individual BDT policy resource. + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + BdtNotification: + '{ $request.body#/notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Notification' + responses: + '204': + description: No Content, a reception of the BDT notification was successful. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/bdtpolicies/{bdtpolicyId}: + get: + summary: Read an Individual BDT policy + operationId: GetBDTPolicy + tags: + - Individual BDT policy (Document) + parameters: + - name: bdtpolicyId + description: String identifying the individual BDT policy resource in the PCF. + in: path + required: true + schema: + type: string + responses: + '200': + description: Background data transfer policies offered to and selected by an ASP. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolicy' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + patch: + summary: Update an Individual BDT policy + operationId: UpdateBDTPolicy + tags: + - Individual BDT policy (Document) + parameters: + - name: bdtpolicyId + description: String identifying the individual BDT policy resource in the PCF. + in: path + required: true + schema: + type: string + requestBody: + description: > + Contains modification instruction to be performed on the BdtPolicy data + structure to select a transfer policy and in addition, may indicate whether + the BDT warning notification is enabled or disabled. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PatchBdtPolicy' + responses: + '200': +``` + +``` +description: > + The Individual BDT Policy resource is modified and a representation of that + resource is returned. +content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolicy' +'204': + description: The Individual BDT Policy resource is modified. +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcf-bdtpolicycontrol: Access to the Npcf_BDTPolicyControl API + + schemas: + + # Structured data types + + BdtPolicy: + description: Represents an Individual BDT policy resource. + type: object + properties: + bdtPolData: + $ref: '#/components/schemas/BdtPolicyData' + bdtReqData: + $ref: '#/components/schemas/BdtReqData' + + BdtReqData: + description: > + Contains service requirements for creation a new Individual BDT policy resource. + type: object + required: + - aspId + - desTimeInt + - numOfUes + - volPerUe + properties: + aspId: + $ref: '#/components/schemas/AspId' + desTimeInt: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +``` + +``` +interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' +notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +nwAreaInfo: + $ref: '#/components/schemas/NetworkAreaInfo' +numOfUes: + description: Indicates a number of UEs. + type: integer +volPerUe: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +trafficDes: + $ref: 'TS29122_ResourceManagementOfBdt.yaml#/components/schemas/TrafficDescriptor' +warnNotifReq: + description: Indicates whether the BDT warning notification is enabled or disabled. + type: boolean + default: false + +BdtPolicyData: + description: Describes the authorization data of an Individual BDT policy resource. + type: object + required: + - bdtRefId + - transfPolicies + properties: + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + transfPolicies: + description: Contains transfer policies. + type: array + items: + $ref: '#/components/schemas/TransferPolicy' + minItems: 1 + selTransPolicyId: + description: Contains an identity of the selected transfer policy. + type: integer + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +PatchBdtPolicy: + description: > + Describes the updates in authorization data of an Individual BDT Policy created + by the PCF. + type: object + properties: + bdtPolData: + $ref: '#/components/schemas/BdtPolicyDataPatch' + bdtReqData: + $ref: '#/components/schemas/BdtReqDataPatch' + +BdtPolicyDataPatch: + description: > + A JSON Merge Patch body schema containing modification instruction to be performed + on the bdtPolData attribute of the BdtPolicy data structure to select a transfer + policy. Adds selTransPolicyId to BdtPolicyData data structure. + type: object + required: + - selTransPolicyId + properties: + selTransPolicyId: + description: > + Contains an identity (i.e. transPolicyId value) of the selected transfer + policy. If the BdtNotification_5G feature is supported value 0 indicates that + no transfer policy is selected. + type: integer + +BdtReqDataPatch: + description: > + A JSON Merge Patch body schema containing modification instruction to be performed + on the bdtReqData attribute of the BdtPolicy data structure to indicate whether + the BDT warning notification is enabled or disabled. Modifies warnNotifReq from + BdtReqData data structure. + type: object + properties: +``` + +``` +warnNotifReq: + description: Indicates whether the BDT warning notification is enabled or disabled. + type: boolean + +TransferPolicy: + description: Describes a transfer policy. + type: object + required: + - ratingGroup + - recTimeInt + - transPolicyId + properties: + maxBitRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxBitRateUpl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ratingGroup: + description: Indicates a rating group for the recommended time window. + type: integer + recTimeInt: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + transPolicyId: + description: Contains an identity of a transfer policy. + type: integer + +NetworkAreaInfo: + description: > + Describes a network area information in which the NF service consumer requests + the number of UEs. + type: object + properties: + ecgis: + description: Contains a list of E-UTRA cell identities. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + minItems: 1 + ncgis: + description: Contains a list of NR cell identities. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + minItems: 1 + gRanNodeIds: + description: Contains a list of NG RAN nodes. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + tais: + description: Contains a list of tracking area identities. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + +Notification: + description: Describes a BDT notification. + type: object + required: + - bdtRefId + properties: + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + candPolicies: + description: > + Contains a list of the candidate transfer policies from which the AF may + select a new transfer policy due to a network performance is below the criteria + set by the operator. + type: array + items: + $ref: '#/components/schemas/TransferPolicy' + minItems: 1 + nwAreaInfo: + $ref: '#/components/schemas/NetworkAreaInfo' + timeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' +``` + +``` +# Simple data types +``` + +``` +AspId: + description: Contains an identity of an application service provider. + type: string +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New version | +| 2018-01 | | | | | | TS skeleton | 0.0.0 | +| 2018-01 | CT3#94 | C3-180369 | | | | Inclusion of C3-180188 agreed in CT3#94. | 0.1.0 | +| 2018-03 | CT3#95 | C3-181376 | | | | Inclusion of documents agreed in CT3#95:
C3-181055, C3-181091, C3-181268, C3-181269,
C3-181270. | 0.2.0 | +| 2018-04 | CT3#96 | C3-182524 | | | | Inclusion of documents agreed in CT3#96:
C3-182048, C3-182428, C3-182427, C3-182051,
C3-182052, C3-182053, C3-182429, C3-182454,
C3-182430, C3-182232. | 0.3.0 | +| 2018-06 | CT3#97 | C3-183915 | | | | Inclusion of documents agreed in CT3#97:
C3-183241, C3-183280, C3-183289, C3-183291,
C3-183292, C3-183297, C3-183298, C3-183562,
C3-183563, C3-183564, C3-183565, C3-183714,
C3-183869. | 0.4.0 | +| 2018-06 | CT#80 | CP-181028 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181028 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 1 | B | Format of bdtPolicyId | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0002 | 4 | B | Network area information | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0003 | 1 | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | 1 | F | Resource structure presentation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0005 | 1 | F | Removal of externalDoc field | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0006 | | F | Corrections related to Feature negotiation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0007 | | F | "404 Not found" response in OpenAPI | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0008 | 1 | F | Correction of apiName | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0010 | | F | Supported content types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0011 | | F | Definition of BdtPolicyData structure | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0012 | | F | Non-empty arrays in OpenAPI file | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0013 | 1 | F | Adding the externalDocs field in the OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0014 | | F | Adding HTTP status code "200 OK" | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0015 | 1 | F | Error indicating "Unspecified resource URI structure" | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0016 | 3 | F | Npcf_BDTPolicyControl API Authorization based on OAuth2 | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0017 | 1 | F | API version update | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0018 | | F | Default value for apiRoot | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0019 | 1 | F | OpenAPI: HTTP status codes alignment | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0020 | 1 | F | NgRanNodeId definition in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0021 | | F | OpenAPI: usage of the "tags" keyword | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0022 | | F | Location header field in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0023 | 1 | F | Data structure used in PATCH request | 15.2.0 | +| 2019-03 | CT#83 | CP-190112 | 0024 | | F | Alignment of the BDT procedures | 15.3.0 | +| 2019-05 | CT#84 | CP-191084 | 0025 | 1 | F | Storage and precedence of OpenAPI specification file | 15.4.0 | +| 2019-06 | CT#84 | CP-191084 | 0028 | 1 | F | Copyright Note in YAML file | 15.4.0 | +| 2019-06 | CT#84 | CP-191084 | 0030 | | F | OpenAPI version number update | 15.4.0 | +| 2019-06 | CT#84 | CP-191105 | 0026 | 2 | B | Support of Npcf_BDTPolicyControl_Notify service operation | 16.0.0 | +| 2019-06 | CT#84 | CP-191090 | 0027 | 1 | B | Add External group Id | 16.0.0 | +| 2019-06 | CT#84 | CP-191101 | 0031 | 2 | F | OpenAPI version number update | 16.0.0 | +| 2019-09 | CT#85 | CP-192157 | 0032 | 1 | B | Modification of BDT warning notification request indication | 16.1.0 | +| 2019-09 | CT#85 | CP-192173 | 0034 | | F | OpenAPI version update for TS 29.554 Rel-16 | 16.1.0 | +| 2019-12 | CT#86 | CP-193198 | 0035 | 1 | F | Indication of "BdtNotification_5G" feature | 16.2.0 | +| 2019-12 | CT#86 | CP-193212 | 0037 | | F | Update of API version and TS version in OpenAPI file | 16.2.0 | +| 2020-03 | CT#87e | CP-200208 | 0036 | 2 | B | BDT renegotiation upon the network conditions change | 16.3.0 | +| 2020-03 | CT#87e | CP-200219 | 0038 | 2 | B | map ASPid to DNN and SNSSAI for xBDT | 16.3.0 | +| 2020-03 | CT#87e | CP-200216 | 0039 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-06 | CT#88e | CP-201234 | 0040 | 1 | F | Removal of not valid BDT policy from UDR | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0041 | 1 | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0043 | 1 | F | URI of the Npcf_BDTPolicyControl service | 16.4.0 | +| 2020-06 | CT#88e | CP-201276 | 0045 | 1 | F | Traffic descriptor for xBDT | 16.4.0 | +| 2020-06 | CT#88e | CP-201225 | 0047 | | A | OpenAPI: adding Location header field in 303 response | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0048 | 1 | F | Optionality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0049 | 1 | F | Supported headers, Resource Data type and yaml mapping | 16.4.0 | +| 2020-06 | CT#88e | CP-201255 | 0051 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2020-12 | CT#90e | CP-203139 | 0053 | 1 | F | TS 29.554 Essential Corrections and alignments | 16.5.0 | +| 2020-12 | CT#90e | CP-203129 | 0054 | 1 | F | Correction to the BDT policy re-negotiation | 16.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------|--------| +| 2020-12 | CT#90e | CP-203139 | 0055 | 1 | F | Storage of YAML files in ETSI Forge | 16.5.0 | +| 2020-12 | CT#90e | CP-203110 | 0056 | 1 | F | Correction to support redirection codes and the update of the Callback URI | 16.5.0 | +| 2020-12 | CT#90e | CP-203152 | 0057 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.5.0 | +| 2021-03 | CT#91e | CP-210191 | 0058 | | F | Supported feature number of ES3XX | 16.6.0 | +| 2021-03 | CT#91e | CP-210206 | 0062 | 1 | F | set bdtpStatus to VALID | 16.6.0 | +| 2021-03 | CT#91e | CP-210201 | 0064 | 1 | A | Correction to PATCH method | 16.6.0 | +| 2021-03 | CT#91e | CP-210239 | 0066 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.6.0 | +| 2021-03 | CT#91e | CP-210219 | 0059 | | F | Support of optional HTTP custom header fields | 17.0.0 | +| 2021-03 | CT#91e | CP-210220 | 0060 | | F | Terminology alignment: usage of "NF service consumer" | 17.0.0 | +| 2021-03 | CT#91e | CP-210220 | 0061 | | F | OpenAPI reference | 17.0.0 | +| 2021-06 | CT#92e | CP-211200 | 0068 | 1 | A | Redirect responses with "application/json" media type | 17.1.0 | +| 2021-06 | CT#92e | CP-211265 | 0070 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-12 | CT#94e | CP-213239 | 0071 | | F | API URI of the Npcf_BDTPolicyControl API | 17.2.0 | +| 2022-03 | CT#95e | CP-220176 | 0072 | 2 | A | Alignment of "Application Errors" clause with SBI TS template | 17.3.0 | +| 2022-03 | CT#95e | CP-220201 | 0073 | 1 | F | Formatting of description fields | 17.3.0 | +| 2022-03 | CT#95e | CP-220194 | 0075 | | F | Update of info and externalDocs fields | 17.3.0 | +| 2022-06 | CT#96 | CP-221154 | 0076 | | F | Readability of the OpenAPI file and alignment with the SBI template | 17.4.0 | +| 2022-06 | CT#96 | CP-221152 | 0077 | | F | Update of info and externalDocs fields | 17.4.0 | +| 2022-12 | CT#98e | CP-223192 | 0078 | 1 | F | Adding the mandatory error code 502 Bad Gateway for Npcf_BDTPolicyControl | 18.0.0 | +| 2022-12 | CT#98e | CP-223200 | 0079 | 1 | F | Correction to DNN encoding | 18.0.0 | +| 2022-12 | CT#98e | CP-223190 | 0080 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-06 | CT#100 | CP-231132 | 0081 | 1 | F | Use of a Location header field during redirection | 18.1.0 | +| 2023-12 | CT#102 | CP-233247 | 0082 | | F | Store BDT warning notification indication and AS address in UDR | 18.2.0 | +| 2023-12 | CT#102 | CP-233229 | 0087 | 1 | F | Reference update: IETF RFC 9113 | 18.2.0 | +| 2023-12 | CT#102 | CP-233228 | 0088 | | F | ProblemDetails RFC 7807 obsoleted by RFC 9457 | 18.2.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29555/raw.md b/raw/rel-18/29_series/29555/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3fec7056ad4995f1abebba750a1478dd7b134852 --- /dev/null +++ b/raw/rel-18/29_series/29555/raw.md @@ -0,0 +1,3030 @@ + + +# 3GPP TS 29.555 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; 5G Direct Discovery Name Management Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 5 Services offered by the 5G DDNMF ..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 N5g-ddnmf_Discovery Service..... | 10 | +| 5.2.1 Service Description ..... | 10 | +| 5.2.2 Service Operations..... | 10 | +| 5.2.2.1 Introduction..... | 10 | +| 5.2.2.2 AnnounceAuthorize ..... | 10 | +| 5.2.2.2.1 General ..... | 10 | +| 5.2.2.2.2 Obtain the authorization to announce for a UE ..... | 10 | +| 5.2.2.3 AnnounceUpdate ..... | 11 | +| 5.2.2.3.1 General ..... | 11 | +| 5.2.2.3.2 Update the authorization for announcing for a UE ..... | 11 | +| 5.2.2.4 MonitorAuthorize ..... | 12 | +| 5.2.2.4.1 General ..... | 12 | +| 5.2.2.4.2 Obtain the authorization to monitor for a UE ..... | 12 | +| 5.2.2.5 MonitorUpdate..... | 13 | +| 5.2.2.5.1 General ..... | 13 | +| 5.2.2.5.2 Update the authorization for monitoring for a UE ..... | 13 | +| 5.2.2.6 MonitorUpdateResult..... | 13 | +| 5.2.2.6.1 General ..... | 13 | +| 5.2.2.6.2 Monitor Update Result Notification..... | 13 | +| 5.2.2.7 DiscoveryAuthorize ..... | 14 | +| 5.2.2.7.1 General ..... | 14 | +| 5.2.2.7.2 Obtain the authorization for a discoverer UE to operate Model B restricted discovery ..... | 14 | +| 5.2.2.8 MatchReport ..... | 15 | +| 5.2.2.8.1 General ..... | 15 | +| 5.2.2.8.2 Obtain the information about the indicated discovery code..... | 15 | +| 5.2.2.9 MatchInformation ..... | 15 | +| 5.2.2.9.1 General ..... | 15 | +| 5.2.2.9.2 Match Information Notification ..... | 16 | +| 6 API Definitions ..... | 16 | +| 6.1 N5g-ddnmf_Discovery Service API ..... | 16 | +| 6.1.1 Introduction ..... | 16 | +| 6.1.2 Usage of HTTP..... | 16 | +| 6.1.2.1 General..... | 16 | +| 6.1.2.2 HTTP standard headers..... | 17 | +| 6.1.2.2.1 General ..... | 17 | +| 6.1.2.2.2 Content type ..... | 17 | +| 6.1.2.3 HTTP custom headers..... | 17 | +| 6.1.3 Resources..... | 17 | +| 6.1.3.1 Overview..... | 17 | +| 6.1.3.2 Resource: AnnounceData ..... | 19 | +| 6.1.3.2.1 Description ..... | 19 | +| 6.1.3.2.2 Resource Definition..... | 19 | +| 6.1.3.2.3 Resource Standard Methods..... | 19 | +| 6.1.3.3 Resource: MonitorData..... | 22 | + +| | | | +|------------|----------------------------------------------------------------------------------|----| +| 6.1.3.3.1 | Description ..... | 22 | +| 6.1.3.3.2 | Resource Definition..... | 22 | +| 6.1.3.3.3 | Resource Standard Methods..... | 22 | +| 6.1.3.4 | Resource: DiscoveryData ..... | 25 | +| 6.1.3.4.1 | Description ..... | 25 | +| 6.1.3.4.2 | Resource Definition..... | 25 | +| 6.1.3.4.3 | Resource Standard Methods..... | 25 | +| 6.1.3.5 | Resource: UeData (Custom operation)..... | 27 | +| 6.1.3.5.1 | Description ..... | 27 | +| 6.1.3.5.2 | Resource Definition..... | 27 | +| 6.1.3.5.3 | Resource Standard Methods..... | 27 | +| 6.1.3.5.4 | Resource Custom Operations..... | 27 | +| 6.1.4 | Custom Operations without associated resources ..... | 29 | +| 6.1.5 | Notifications ..... | 29 | +| 6.1.5.1 | General..... | 29 | +| 6.1.5.2 | MonitorUpdateResult..... | 29 | +| 6.1.5.2.1 | Description ..... | 29 | +| 6.1.5.2.2 | Target URI..... | 30 | +| 6.1.5.2.3 | Standard Methods..... | 30 | +| 6.1.5.3 | MatchInformation ..... | 31 | +| 6.1.5.3.1 | Description ..... | 31 | +| 6.1.5.3.2 | Target URI..... | 31 | +| 6.1.5.3.3 | Standard Methods..... | 31 | +| 6.1.6 | Data Model ..... | 32 | +| 6.1.6.1 | General..... | 32 | +| 6.1.6.2 | Structured data types..... | 34 | +| 6.1.6.2.1 | Introduction ..... | 34 | +| 6.1.6.2.2 | Type: AnnounceAuthData..... | 34 | +| 6.1.6.2.3 | Void..... | 35 | +| 6.1.6.2.4 | Type: AnnounceDiscDataForOpen..... | 35 | +| 6.1.6.2.5 | Type: AnnounceDiscDataForRestricted ..... | 35 | +| 6.1.6.2.6 | Type: AnnounceUpdateData ..... | 36 | +| 6.1.6.2.7 | Type: MonitorAuthReqData ..... | 36 | +| 6.1.6.2.8 | Type: MonitorAuthRespData..... | 37 | +| 6.1.6.2.9 | Type: MonitorDiscDataForOpen ..... | 37 | +| 6.1.6.2.10 | Type: MonitorDiscDataForRestricted..... | 37 | +| 6.1.6.2.11 | Type: MonitorAuthDataForOpen..... | 38 | +| 6.1.6.2.12 | Type: MonitorAuthDataForRestricted ..... | 38 | +| 6.1.6.2.13 | Type: MonitorUpdateData ..... | 38 | +| 6.1.6.2.14 | Type: DiscoveryAuthReqData ..... | 39 | +| 6.1.6.2.15 | Type: DiscoveryAuthRespData..... | 39 | +| 6.1.6.2.16 | Type: DiscDataForRestricted..... | 39 | +| 6.1.6.2.17 | Type: AuthDataForRestricted ..... | 39 | +| 6.1.6.2.18 | Type: MatchReportReqData ..... | 40 | +| 6.1.6.2.19 | Type: MatchReportRespData..... | 40 | +| 6.1.6.2.20 | Type: MonitorUpdateResult..... | 41 | +| 6.1.6.2.21 | Type: MatchInformation ..... | 41 | +| 6.1.6.2.22 | Type: MatchInfoForOpen ..... | 41 | +| 6.1.6.2.23 | Type: MatchInfoForRestricted..... | 42 | +| 6.1.6.2.24 | Type: RestrictedCodeSuffixPool..... | 42 | +| 6.1.6.2.25 | Type: RestrictedCodeSuffixRange..... | 42 | +| 6.1.6.2.26 | Type: ProseApplicationCodeSuffixPool ..... | 42 | +| 6.1.6.2.27 | Type: ProseAppCodeSuffixRange..... | 43 | +| 6.1.6.2.28 | Type: MonitorUpdateDataForOpen ..... | 43 | +| 6.1.6.2.29 | Type: MonitorUpdateDataForRestricted..... | 43 | +| 6.1.6.3 | Simple data types and enumerations..... | 43 | +| 6.1.6.3.1 | Introduction ..... | 43 | +| 6.1.6.3.2 | Simple data types ..... | 43 | +| 6.1.6.3.3 | Enumeration: DiscoveryType ..... | 44 | +| 6.1.6.3.4 | Void..... | 44 | +| 6.1.6.3.5 | Enumeration: RevocationResult..... | 44 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 45 | + +| | | | +|-------------------------------|------------------------------------|-----------| +| 6.1.6.5 | Binary data ..... | 45 | +| 6.1.7 | Error Handling ..... | 45 | +| 6.1.7.1 | General ..... | 45 | +| 6.1.7.2 | Protocol Errors ..... | 45 | +| 6.1.7.3 | Application Errors ..... | 45 | +| 6.1.8 | Feature negotiation ..... | 45 | +| 6.1.9 | Security ..... | 46 | +| 6.1.10 | HTTP redirection ..... | 46 | +| Annex A (normative): | OpenAPI specification ..... | 47 | +| A.1 | General ..... | 47 | +| A.2 | N5g-ddnmf_Discovery API ..... | 47 | +| Annex B (informative): | Change history ..... | 63 | + +# Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the N5g-ddnmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the 5G DDNMF as specified in 3GPP TS 23.304 [4]. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [5] and 3GPP TS 29.501 [6]. + +# --- 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.304: "Proximity based Services (ProSe) in the 5G System (5GS)". +- [5] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [6] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [7] OpenAPI : "OpenAPI Specification Version 3.0.0", . +- [8] IETF RFC 9113: "HTTP/2". +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] IETF RFC 9457: "Problem Details for HTTP APIs". +- [11] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [12] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [13] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [14] 3GPP TR 21.900: "Technical Specification Group working methods". + +- [15] IETF RFC 7396: "JSON Merge Patch". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [17] 3GPP TS 23.003: "Numbering, addressing and identification". + +# --- 3 Definitions, symbols 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]. + +**5G DDNMF:** The 5G DDNMF is the logical function handling network related actions required for dynamic ProSe Direct Discovery. The 5G DDNMF in the HPLMN may interact with the 5G DDNMF in a VPLMN or Local PLMN in order to manage the ProSe Direct Discovery service. + +**ProSe Direct Discovery:** A procedure employed by a ProSe-enabled UE to discover other ProSe-enabled UEs in its vicinity based on direct radio transmissions between the two UEs with NR technology. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----------|---------------| +| | | +|----------|---------------| + +## 3.3 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]. + +| | | +|----------|----------------------------------------------| +| 5G DDNMF | 5G Direct Discovery Name Management Function | +| 5G ProSe | 5G Proximity-based Services | +| RPAUID | Restricted ProSe Application User ID | +| PDUID | ProSe Discovery UE ID | + +# --- 4 Overview + +The 5G Direct Discovery Name Management Function (5G DDNMF) is the network entity in the 5G Core Network (5GC) supporting Direct Discovery Services. Within the 5GC, the 5G DDNMF in HPLMN invokes services provided by the 5G DDNMF in Local PLMN and/or in VPLMN via the N5g-ddnmf service based interface (see 3GPP TS 23.304 [4]). + +Figure 4-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the 5G DDNMF: + +![Figure 4-1: Reference model – 5G DDNMF. The diagram shows the network architecture involving a UE, ProSe Application Server, 5G DDNMF, PCF, and UDM across Local PLMN, HPLMN, and VPLMN domains. The UE is connected to the ProSe Application Server via PC1 and PC3a. The ProSe Application Server is connected to the 5G DDNMF in the HPLMN via Npc2 and Naf. The 5G DDNMF in the HPLMN is connected to the 5G DDNMF in the Local PLMN via Npc6 and N5g-ddnmf. The 5G DDNMF in the HPLMN is also connected to the PCF via Npc8 and to the UDM via Npc4. The 5G DDNMF in the VPLMN is connected to the 5G DDNMF in the HPLMN via Npc7 and N5g-ddnmf.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +Figure 4-1: Reference model – 5G DDNMF. The diagram shows the network architecture involving a UE, ProSe Application Server, 5G DDNMF, PCF, and UDM across Local PLMN, HPLMN, and VPLMN domains. The UE is connected to the ProSe Application Server via PC1 and PC3a. The ProSe Application Server is connected to the 5G DDNMF in the HPLMN via Npc2 and Naf. The 5G DDNMF in the HPLMN is connected to the 5G DDNMF in the Local PLMN via Npc6 and N5g-ddnmf. The 5G DDNMF in the HPLMN is also connected to the PCF via Npc8 and to the UDM via Npc4. The 5G DDNMF in the VPLMN is connected to the 5G DDNMF in the HPLMN via Npc7 and N5g-ddnmf. + +Figure 4-1: Reference model – 5G DDNMF + +The functionalities supported by the 5G DDNMF are listed in clause 4.3.2 of 3GPP TS 23.304 [4]. + +NOTE: Only service based interfaces between 5G DDNMFs will be covered in this TS, other interfaces won't be covered for the time being. + +# 5 Services offered by the 5G DDNMF + +## 5.1 Introduction + +The table 5.1-1 shows the 5G DDNMF Services and 5G DDNMF Service Operations: + +Table 5.1-1: List of 5G DDNMF Services + +| Service Name | Service Operations | Operation Semantics | Example Consumer(s) | +|---------------------|---------------------|---------------------|---------------------| +| N5g-ddnmf_Discovery | AnnounceAuthorize | Request/Response | 5G DDNMF | +| | AnnounceUpdate | Request/Response | 5G DDNMF | +| | MonitorAuthorize | Request/Response | 5G DDNMF | +| | MonitorUpdate | Request/Response | 5G DDNMF | +| | MonitorUpdateResult | Notify | 5G DDNMF | +| | DiscoveryAuthorize | Request/Response | 5G DDNMF | +| | MatchReport | Request/Response | 5G DDNMF | +| | MatchInformation | Notify | 5G DDNMF | + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +Table 5.1-2: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------|--------|-----------------------------|----------------------------------|---------------|-------| +| N5g-ddnmf_Discovery | 6.1 | N5g-ddnmf Discovery Service | TS29555_N5g-ddnmf_Discovery.yaml | n5gddnmf-disc | A.2 | + +## 5.2 N5g-ddnmf\_Discovery Service + +### 5.2.1 Service Description + +The N5g-ddnmf\_Discovery service enables an NF or SCP to manage inter-PLMN ProSe Direct Discovery operations for a target UE. The following are the key functionalities of this NF service. + +- Allow the consumer NF to obtain the authorization from the 5G DDNMF for announcing in the PLMN. +- Allow the consumer NF to update or revoke the authorization from the 5G DDNMF for announcing in the PLMN. +- Allow the consumer NF to obtain the authorization from the 5G DDNMF for monitoring in the PLMN. +- Allow the consumer NF to update or revoke the authorization for the indicated UE to monitor in the PLMN. +- Allow the consumer NF to inform the 5G DDNMF of the monitoring revocation results. +- Allow the consumer NF to obtain the authorization from the 5G DDNMF for a discoverer UE in the PLMN to operate Model B restricted discovery. +- Allow the consumer NF to obtain the information about the indicated discovery code from the 5G DDNMF. +- Allow the consumer NF to receive from the 5G DDNMF of a matching result, and the information can be used for charging purpose. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +This clause introduces the service operations defined for the N5g-ddnmf\_Discovery services as follows: + +- AnnounceAuthorize +- AnnounceUpdate +- MonitorAuthorize +- MonitorUpdate +- MonitorUpdateResult +- DiscoveryAuthorize +- MatchReport +- MatchInformation + +#### 5.2.2.2 AnnounceAuthorize + +##### 5.2.2.2.1 General + +The AnnounceAuthorize service operation shall be used by the NF Service consumer to obtain the authorization to announce for a UE from the 5G DDNMF in the PLMN. The following procedures are supported using the AnnounceAuthorize service operation: + +- Discovery Request procedures (see 3GPP TS 23.304 [4], clause 6.3.1.4) +- Announcing Alert Procedures for restricted discovery (see 3GPP TS 23.304 [4], clause 6.3.1.6) +- Direct Discovery Update Procedures (see 3GPP TS 23.304 [4], clause 6.3.1.7) + +##### 5.2.2.2.2 Obtain the authorization to announce for a UE + +The AnnounceAuthorize service operation is invoked by a NF Service Consumer, e.g. HPLMN 5G DDNMF, towards the 5G DDNMF (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) to request to obtain the authorization from + +the 5G DDNMF for announcing for a target UE. See Figure 5.2.2.2.2-1. The request contains the UE's identity (`/{ueId}`) which shall be a SUPI or GPSI and the discovery Entry ID (`/{discEntryId}`) which is used to identify the discovery entry related to this request. + +![Sequence diagram for Figure 5.2.2.2.2-1: Obtain the authorization to announce for a UE. The diagram shows an NF Service Consumer sending a PUT request to a 5G DDNMF. The request is '1. PUT .../{ueId}/announce-authorize/{discEntryId} (AnnounceAuthData)'. The 5G DDNMF responds with '2a. 201 Created', '2b. 204 No Content', or '2c. 4xx/5xx (ProblemDetails) Or 3xx'.](d26959f4514c26ca19c3d6f00da85956_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G DDNMF + Note right of NF Service Consumer: 1. PUT .../{ueId}/announce-authorize/{discEntryId} +(AnnounceAuthData) + NF Service Consumer->>5G DDNMF: Request + Note right of 5G DDNMF: 2a. 201 Created +2b. 204 No Content +2c. 4xx/5xx (ProblemDetails) Or 3xx + 5G DDNMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for Figure 5.2.2.2.2-1: Obtain the authorization to announce for a UE. The diagram shows an NF Service Consumer sending a PUT request to a 5G DDNMF. The request is '1. PUT .../{ueId}/announce-authorize/{discEntryId} (AnnounceAuthData)'. The 5G DDNMF responds with '2a. 201 Created', '2b. 204 No Content', or '2c. 4xx/5xx (ProblemDetails) Or 3xx'. + +Figure 5.2.2.2.2-1: Obtain the authorization to announce for a UE + +1. The NF Service Consumer shall send an HTTP PUT request to the resource representing the authorization to announce for a UE to obtain the authorization to announce for this UE. The request shall include the Discovery Type, if the Discovery Type is OPEN the Announce Authorisation Data for open discovery shall be included, and if the Discovery Type is RESTRICTED the Announce Authorisation Data for restricted discovery shall be included in the HTTP PUT request body. +- 2a. If the context indicated by the discEntryId doesn't exist, the 5G DDNMF shall create the new resource, and upon success of creation of the resource, "201 created" shall be returned. +- 2b. If the context indicated by the discEntryId already exists, the 5G DDNMF shall replace the stored data using the received data, and upon success of the update of the resource, "204 No Content" shall be returned. +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.3.1-3. + +#### 5.2.2.3 AnnounceUpdate + +##### 5.2.2.3.1 General + +The AnnounceUpdate service operation shall be used by the NF Service consumer to update or revoke the authorization from the 5G DDNMF for announcing in the PLMN. The following procedures are supported using the AnnounceUpdate service operation: + +- Direct Discovery Update Procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.7) + +##### 5.2.2.3.2 Update the authorization for announcing for a UE + +The AnnounceUpdate service operation is invoked by a NF Service Consumer, e.g. HPLMN 5G DDNMF, towards the 5G DDNMF (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) to request to update the authorization for announcing in the PLMN from the 5G DDNMF for a target UE. See Figure 5.2.2.3.2-1. The request contains the UE's identity (`/{ueId}`) which shall be a SUPI or GPSI and the discovery Entry ID (`/{discEntryId}`) which is used to identify the discovery entry related to this request. + +![Sequence diagram for Figure 5.2.2.3.2-1: Update the authorization for announcing for a UE. The diagram shows an NF Service Consumer sending a PATCH request to a 5G DDNMF. The request is '1. PATCH .../{ueId}/announce-authorize/{discEntryId} (AnnounceUpdateData)'. The 5G DDNMF responds with '2a. 204 No Content' or '2b. 4xx/5xx (ProblemDetails) Or 3xx'.](f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G DDNMF + Note right of NF Service Consumer: 1. PATCH .../{ueId}/announce-authorize/{discEntryId} +(AnnounceUpdateData) + NF Service Consumer->>5G DDNMF: Request + Note right of 5G DDNMF: 2a. 204 No Content +2b. 4xx/5xx (ProblemDetails) Or 3xx + 5G DDNMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for Figure 5.2.2.3.2-1: Update the authorization for announcing for a UE. The diagram shows an NF Service Consumer sending a PATCH request to a 5G DDNMF. The request is '1. PATCH .../{ueId}/announce-authorize/{discEntryId} (AnnounceUpdateData)'. The 5G DDNMF responds with '2a. 204 No Content' or '2b. 4xx/5xx (ProblemDetails) Or 3xx'. + +Figure 5.2.2.3.2-1: Update the authorization for announcing for a UE + +1. The NF Service Consumer shall send an HTTP PATCH request to the resource representing the authorization to announce for a UE to update or revoke the authorization from the 5G DDNMF for announcing in the PLMN. The request shall include Discovery Type, the Validity Timer, and the ProSe Application Code if the ProSe Application Code is changed in the HTTP PATCH request body. If the Validity Timer sets to a full zero, it indicates to revoke the authorization for the announcing in the PLMN. +- 2a. On success, "204 No Content" shall be returned. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.2-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.3.2-3. + +#### 5.2.2.4 MonitorAuthorize + +##### 5.2.2.4.1 General + +The MonitorAuthorize service operation shall be used by the NF Service consumer to obtain the authorization from the 5G DDNMF for monitoring for an UE in the PLMN. The following procedures are supported using the MonitorAuthorize service operation: + +- Discovery Request procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.4). + +##### 5.2.2.4.2 Obtain the authorization to monitor for a UE + +The MonitorAuthorize service operation is invoked by a NF Service Consumer, e.g. HPLMN 5G DDNMF, towards the 5G DDNMF (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) to request to obtain the authorization from the 5G DDNMF for monitoring for a target UE. See Figure 5.2.2.4.2-1. The request contains the UE's identity (/{ueId}) which shall be a SUPI or GPSI and the discovery Entry ID (/{discEntryId}) which is used to identify the discovery entry related to this request. + +![Sequence diagram showing the interaction between an NF Service Consumer and a 5G DDNMF to obtain authorization to monitor for a UE. The consumer sends a PUT request to .../{ueId}/monitor-authorize/{discEntryId} with MonitorAuthReqData. The DDNMF responds with 201 Created (MonitorAuthRespData), 204 No Content, or a 4xx/5xx (ProblemDetails) or 3xx status code.](af6be343f0c0a8f155f965dcf337b8af_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G DDNMF + Note right of NF Service Consumer: 1. PUT .../{ueId}/monitor-authorize/{discEntryId} +(MonitorAuthReqData) + NF Service Consumer->>5G DDNMF: Request + Note left of 5G DDNMF: 2a. 201 Created (MonitorAuthRespData) +2b. 204 No Content +2c. 4xx/5xx (ProblemDetails) Or 3xx + 5G DDNMF-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a 5G DDNMF to obtain authorization to monitor for a UE. The consumer sends a PUT request to .../{ueId}/monitor-authorize/{discEntryId} with MonitorAuthReqData. The DDNMF responds with 201 Created (MonitorAuthRespData), 204 No Content, or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.2.2.4.2-1: Obtain the authorization to monitor for a UE** + +1. The NF Service Consumer shall send an HTTP PUT request to the resource representing the authorization to monitor for a UE to obtain the authorization to monitor for this UE. The request shall include the Discovery Type, if the Discovery Type is OPEN the Monitor Authorisation Data for open discovery shall be included, and if the Discovery Type is RESTRICTED the Monitor Authorisation Data for restricted discovery shall be included in the HTTP PUT request body. +- 2a. If the context indicated by the discEntryId doesn't exist, the 5G DDNMF shall create the new resource, and upon success of creation of the resource, "201 created" shall be returned. The response body shall contain the parameters related to the determined authorization data to monitor for the UE. +- 2b. If the context indicated by the discEntryId already exists, the 5G DDNMF shall replace the stored data using the received data, and upon success of the update of the resource, "204 No Content" shall be returned. +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.3.3.1-3. + +#### 5.2.2.5 MonitorUpdate + +##### 5.2.2.5.1 General + +The MonitorUpdate service operation shall be used by the NF Service consumer to update or revoke the authorization for the indicated UE to monitor in the PLMN. The following procedures are supported using the MonitorUpdate service operation: + +- Direct Discovery Update Procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.7). + +##### 5.2.2.5.2 Update the authorization for monitoring for a UE + +The MonitorUpdate service operation is invoked by a NF Service Consumer, e.g. HPLMN 5G DDNMF, towards the 5G DDNMF (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) to request to update the authorization for monitoring in the PLMN from the 5G DDNMF for a target UE. See Figure 5.2.2.5.2-1. The request contains the UE's identity (/{ueId}) which shall be a SUPI or GPSI and the discovery Entry ID (/{discEntryId}) which is used to identify the discovery entry related to this request. + +![Sequence diagram showing the interaction between an NF Service Consumer and a 5G DDNMF for updating authorization. The consumer sends a PATCH request to .../{ueId}/monitor-authorize/{discEntryId} with MonitorUpdateData. The DDNMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection).](e9d825d87c5f85c8dba0664eace96ef4_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G DDNMF + Note right of NF Service Consumer: 1. PATCH .../{ueId}/monitor-authorize/{discEntryId} +(MonitorUpdateData) + NF Service Consumer->>5G DDNMF: Request + Note left of 5G DDNMF: 2a. 204 No Content +2b. 4xx/5xx (ProblemDetails) Or 3xx + 5G DDNMF-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a 5G DDNMF for updating authorization. The consumer sends a PATCH request to .../{ueId}/monitor-authorize/{discEntryId} with MonitorUpdateData. The DDNMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection). + +**Figure 5.2.2.5.2-1: Update the authorization for monitoring for a UE** + +1. The NF Service Consumer shall send an HTTP PATCH request to the resource representing the authorization to monitor for a UE to update or revoke the authorization for the indicated UE to monitor in the PLMN. The request shall include Discovery Type, if the Discovery Type indicates "RESTRICTED", the ProSe Application ID Name, and the TTL shall be included in the HTTP PATCH request body. And if the value of TTL in the request sets to zero, it indicates to revoke the previously authorized monitoring to the given Discovery Entry ID, if the Discovery Type indicates "OPEN", ProSe Restricted Code, Application ID, Banned RPAUID, and Banned PDUID shall be included in the HTTP PATCH request body, and monitorUpdateResultCallbackRef may be included in the request body if the NF Service Consumer expects to receive the monitoring revocation results +- 2a. On success, "204 No Content" shall be returned. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.2-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.3.2-3. + +#### 5.2.2.6 MonitorUpdateResult + +##### 5.2.2.6.1 General + +The MonitorUpdateResult service operation shall be used by the 5G DDNMF to notify the NF Service consumer of the monitoring revocation results. The following procedures are supported using the MonitorUpdateResult service operation: + +- Direct Discovery Update Procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.7). + +##### 5.2.2.6.2 Monitor Update Result Notification + +The MonitorUpdateResult service operation notifies the NF service consumer (e.g. HPLMN 5G DDNMF) serving the user about the monitoring revocation results for the user. The request contains the monitorUpdateResultCallbackRef URI. See Figure 5.2.2.6.2-1. + +![Sequence diagram for Figure 5.2.2.6.2-1: Monitor Update Result Notification. The diagram shows two lifelines: 'NF service consumer' on the left and '5G DDNMF' on the right. The interaction consists of three steps: 1. A POST request from 5G DDNMF to NF service consumer with the body {monitorUpdateResultCallbackRef} (MonitorUpdateResult). 2a. A 204 No Content response from NF service consumer to 5G DDNMF. 2b. A 4xx/5xx (ProblemDetails) or 3xx response from NF service consumer to 5G DDNMF.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +sequenceDiagram + participant 5G DDNMF + participant NF service consumer + Note right of 5G DDNMF: 1. POST {monitorUpdateResultCallbackRef} +(MonitorUpdateResult) + 5G DDNMF->>NF service consumer: 1. POST {monitorUpdateResultCallbackRef} +(MonitorUpdateResult) + Note left of NF service consumer: 2a. 204 No Content + NF service consumer-->>5G DDNMF: 2a. 204 No Content + Note left of NF service consumer: 2b. 4xx/5xx (ProblemDetails) Or 3xx + NF service consumer-->>5G DDNMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram for Figure 5.2.2.6.2-1: Monitor Update Result Notification. The diagram shows two lifelines: 'NF service consumer' on the left and '5G DDNMF' on the right. The interaction consists of three steps: 1. A POST request from 5G DDNMF to NF service consumer with the body {monitorUpdateResultCallbackRef} (MonitorUpdateResult). 2a. A 204 No Content response from NF service consumer to 5G DDNMF. 2b. A 4xx/5xx (ProblemDetails) or 3xx response from NF service consumer to 5G DDNMF. + +**Figure 5.2.2.6.2-1: Monitor Update Result Notification** + +1. The 5G DDNMF sends a POST request to the monitorUpdateResultCallbackRef to notify the NF service consumer about the monitoring revocation results for the user. The request shall the Discovery Type, the ProSe Restricted Code, the Application ID, the Banned RPAUID, the Banned PDUID, and the monitoring revocation results. +- 2a. On success, the NF service consumer responds with "204 No Content". +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.2.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.5.2.3.1-3. + +#### 5.2.2.7 DiscoveryAuthorize + +##### 5.2.2.7.1 General + +The DiscoveryAuthorize service operation shall be used by the NF Service consumer to obtain the authorization from the 5G DDNMF for a discoverer UE in the PLMN to operate Model B restricted discovery. The following procedures are supported using the DiscoveryAuthorize service operation: + +- Discovery Request procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.4). + +##### 5.2.2.7.2 Obtain the authorization for a discoverer UE to operate Model B restricted discovery + +The DiscoveryAuthorize service operation is invoked by a NF Service Consumer, e.g. HPLMN 5G DDNMF, towards the 5G DDNMF (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) to request to obtain the authorization from the 5G DDNMF for a discoverer UE in the PLMN to operate Model B restricted discovery. See Figure 5.2.2.7.2-1. The request contains the UE's identity (/ueId) which shall be a SUPI or GPSI and the discovery Entry ID (/discEntryId) which is used to identify the discovery entry related to this request. + +![Sequence diagram for Figure 5.2.2.7.2-1: Obtain the authorization for a discoverer UE to operate Model B restricted discovery. The diagram shows two lifelines: 'NF Service Consumer' on the left and '5G DDNMF' on the right. The interaction consists of three steps: 1. A PUT request from NF Service Consumer to 5G DDNMF with the body {ueId}/discovery-authorize/{discEntryId} (DiscoveryAuthReqData). 2a. A 201 Created (DiscoveryAuthRespData) response from 5G DDNMF to NF Service Consumer. 2b. A 204 No Content response from 5G DDNMF to NF Service Consumer. 2c. A 4xx/5xx (ProblemDetails) or 3xx response from 5G DDNMF to NF Service Consumer.](66c2bf11a8f117cddf67eff92d4c736c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G DDNMF + Note right of NF Service Consumer: 1. PUT .../{ueId}/discovery-authorize/{discEntryId} +(DiscoveryAuthReqData) + NF Service Consumer->>5G DDNMF: 1. PUT .../{ueId}/discovery-authorize/{discEntryId} +(DiscoveryAuthReqData) + Note left of 5G DDNMF: 2a. 201 Created (DiscoveryAuthRespData) + 5G DDNMF-->>NF Service Consumer: 2a. 201 Created (DiscoveryAuthRespData) + Note left of 5G DDNMF: 2b. 204 No Content + 5G DDNMF-->>NF Service Consumer: 2b. 204 No Content + Note left of 5G DDNMF: 2c. 4xx/5xx (ProblemDetails) Or 3xx + 5G DDNMF-->>NF Service Consumer: 2c. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram for Figure 5.2.2.7.2-1: Obtain the authorization for a discoverer UE to operate Model B restricted discovery. The diagram shows two lifelines: 'NF Service Consumer' on the left and '5G DDNMF' on the right. The interaction consists of three steps: 1. A PUT request from NF Service Consumer to 5G DDNMF with the body {ueId}/discovery-authorize/{discEntryId} (DiscoveryAuthReqData). 2a. A 201 Created (DiscoveryAuthRespData) response from 5G DDNMF to NF Service Consumer. 2b. A 204 No Content response from 5G DDNMF to NF Service Consumer. 2c. A 4xx/5xx (ProblemDetails) or 3xx response from 5G DDNMF to NF Service Consumer. + +**Figure 5.2.2.7.2-1: Obtain the authorization for a discoverer UE to operate Model B restricted discovery** + +1. The NF Service Consumer shall send an HTTP PUT request to the resource representing the authorization for a discoverer UE to obtain the authorization for a discoverer UE to operate Model B restricted discovery. The request shall include the Discovery Type, authorisation data for restricted discovery in the HTTP PUT request body. +- 2a. If the context indicated by the discEntryId doesn't exist, the 5G DDNMF shall create the new resource, and upon success of creation of the resource, "201 created" shall be returned. The response body shall contain the + +parameters related to the determined authorization data for the discoverer UE to operate Model B restricted discovery. + +- 2b. If the context indicated by the discEntryId already exists, the 5G DDNMF shall replace the stored data using the received data, and upon success of the update of the resource, "204 No Content" shall be returned. +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.4.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.4.3.1-3. + +#### 5.2.2.8 MatchReport + +##### 5.2.2.8.1 General + +The MatchReport service operation shall be used by the NF Service consumer to obtain the information about the indicated discovery code from the 5G DDNMF. The following procedures are supported using the MatchReport service operation: + +- Discovery Reporting procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.5). + +##### 5.2.2.8.2 Obtain the information about the indicated discovery code + +The MatchReport service operation is invoked by a NF Service Consumer, e.g. HPLMN 5G DDNMF, towards the 5G DDNMF (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) to request to obtain the information about the indicated discovery code from the 5G DDNMF. See Figure 5.2.2.8.2-1. The request contains the UE's identity (/ueId) which shall be a SUPI or GPSI, the type of request (/match-report). + +![Sequence diagram showing the interaction between an NF Service Consumer and a 5G DDNMF to obtain information about a discovery code. The consumer sends a POST request to /ueId/match-report, and the DDNMF responds with either a 200 OK (MatchReportRespData) or a 4xx/5xx (ProblemDetails) or 3xx status code.](3f1987804d7d78bc3b3bc560e974280a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G DDNMF + Note left of NF Service Consumer: Request discovery info + NF Service Consumer->>5G DDNMF: 1. POST .../ueId/match-report + Note right of 5G DDNMF: Response + 5G DDNMF-->>NF Service Consumer: 2a. 200 OK (MatchReportRespData) + Note right of 5G DDNMF: Failure/Redirection + 5G DDNMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a 5G DDNMF to obtain information about a discovery code. The consumer sends a POST request to /ueId/match-report, and the DDNMF responds with either a 200 OK (MatchReportRespData) or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.2.2.8.2-1: Obtain the information about the indicated discovery code** + +1. The NF Service Consumer shall send an HTTP POST request to the resource representing the information about the indicated discovery code to obtain the information about the indicated discovery code. The request shall include the Discovery Type, the ProSe Application Codes if the discovery type is OPEN in the HTTP POST request body, and optionally includes Monitored PLMN ID in the HTTP POST request body. +- 2a. On success, "200 OK" shall be returned. The response body shall contain the parameters related to the information about the indicated discovery code. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.5.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.5.3.1-3. + +#### 5.2.2.9 MatchInformation + +##### 5.2.2.9.1 General + +The MatchInformation service operation shall be used by the 5G DDNMF to notify the NF Service consumer of a matching result, and the information that can be used for charging purpose. The following procedures are supported using the MatchInformation service operation: + +- Discovery Reporting procedures (see 3GPP 3GPP TS 23.304 [4], clause 6.3.1.5) + +##### 5.2.2.9.2 Match Information Notification + +The MatchInformation service operation notifies the NF service consumer (e.g. VPLMN 5G DDNMF or Local PLMN 5G DDNMF) about match information including a matching result, and the information can be used for charging purpose. The request contains the matchInfoCallbackRef URI. See Figure 5.2.2.9.2-1. + +![Sequence diagram illustrating the Match Information Notification. The NF service consumer sends a POST request to the 5G DDNMF. The 5G DDNMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response.](a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant 5G DDNMF + Note left of NF service consumer: POST {matchInfoCallbackRef} (MatchInformation) + NF service consumer->>5G DDNMF: 1. POST {matchInfoCallbackRef} (MatchInformation) + Note right of 5G DDNMF: 2a. 204 No Content + Note right of 5G DDNMF: 2b. 4xx/5xx (ProblemDetails) Or 3xx + 5G DDNMF-->>NF service consumer: 2a. 204 No Content + 5G DDNMF-->>NF service consumer: 2b. 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram illustrating the Match Information Notification. The NF service consumer sends a POST request to the 5G DDNMF. The 5G DDNMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response. + +Figure 5.2.2.9.2-1: Match Information Notification + +1. The 5G DDNMF sends a POST request to the matchInfoCallbackRef URI to notify the NF service consumer about match information including a matching result, and the information can be used for charging purpose. The request shall include the Discovery Type, match report information for open discovery type if match report information for open discovery type is OPEN, and match report information for restricted discovery type if match report information for open discovery type is RESTRICTED +- 2a. On success, the NF service consumer responds with "204 No Content". +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.3.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.5.3.3.1-3. + +# 6 API Definitions + +## 6.1 N5g-ddnmf\_Discovery Service API + +### 6.1.1 Introduction + +The N5g-ddnmf\_Discovery shall use the N5g-ddnmf\_Discovery API. + +The API URI of the N5g-ddnmf\_Discovery API shall be: + +**{apiRoot}** + +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 [6], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "n5g-ddnmf-disc". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +The OpenAPI [7] specification of HTTP messages and content bodies for the n5g-ddnmf-disc API is contained in Annex A.2. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [9], 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 [5]. 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 9457 [10]. + +JSON Merge Patch, as defined in IETF RFC 7396 [15], signalled by the content type "application/merge-patch+json". + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [5] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 depicts the resource URIs structure for the N5g-ddnmf\_Discovery API. + +![Figure 6.1.3.1-1: Resource URI structure of the N5g-ddnmf_Discovery API. The diagram shows a hierarchical tree of URI paths. The root is {apiRoot}/n5g-ddnmf-disc/. It branches into /{ueId}, which further branches into /announce-authorize, /monitor-authorize, /discovery-authorize, and /match-report. The first three branches further branch into /{discEntryId}. The /match-report branch is shown with a dashed box.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` + +graph TD + Root["{apiRoot}/n5g-ddnmf-disc/"] --> ueId["/{ueId}"] + ueId --> announce["/announce-authorize"] + ueId --> monitor["/monitor-authorize"] + ueId --> discovery["/discovery-authorize"] + ueId --> match["/match-report"] + announce --> discEntryId1["/{discEntryId}"] + monitor --> discEntryId2["/{discEntryId}"] + discovery --> discEntryId3["/{discEntryId}"] + match -.-> matchDashed["[ ]"] + +``` + +Figure 6.1.3.1-1: Resource URI structure of the N5g-ddnmf\_Discovery API. The diagram shows a hierarchical tree of URI paths. The root is {apiRoot}/n5g-ddnmf-disc/. It branches into /{ueId}, which further branches into /announce-authorize, /monitor-authorize, /discovery-authorize, and /match-report. The first three branches further branch into /{discEntryId}. The /match-report branch is shown with a dashed box. + +**Figure 6.1.3.1-1: Resource URI structure of the N5g-ddnmf\_Discovery API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------|-------------------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------| +| AnnounceData | /{ueId}/announce-authorize/{discEntryId} | PUT | Obtain the authorization to announce for a UE from the 5G DDNMF in the PLMN. | +| | | PATCH | Update or revoke the authorization from the 5G DDNMF for announcing in the PLMN. | +| MonitorData | /{ueId}/monitor-authorize/{discEntryId} | PUT | Obtain the authorization from the 5G DDNMF for monitoring for an UE in the PLMN. | +| | | PATCH | Update or revoke the authorization for the indicated UE to monitor in the PLMN. | +| DiscoveryData | /{ueId}/discovery-authorize/{discEntryId} | PUT | Obtain the authorization from the 5G DDNMF for a discoverer UE in the PLMN to operate Model B restricted discovery. | +| UeData | /{ueId}/match-report | match-report (POST) | Obtain the information about the indicated discovery code from the 5G DDNMF. | + +#### 6.1.3.2 Resource: AnnounceData + +##### 6.1.3.2.1 Description + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/n5g-ddnmf-disc//{ueId}/announce-authorize/{discEntryId} + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [16] | +| discEntryId | DiscoveryEntryId | Represents Discovery Entry Id. | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|----------------------------------------------------------------------------------------------| +| AnnounceAuthData | M | 1 | Contains the Announce Authorization Data for the indicated UE and indicated discovery entry. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AnnounceAuthData | | | 201 Created | Upon success of creation of the resource, a response body shall be returned.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| n/a | | | 204 No Content | Upon success of the update of the resource, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- PROSE_SERVICE_UNAUTHORIZED

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +**Table 6.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}/n5g-ddnmf-disc>///announce-authorize/{discEntryId} | + +**Table 6.1.3.2.3.1-5: 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 on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-6: 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 on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.2.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.1.3.2.3.2-1. + +**Table 6.1.3.2.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.2-2 and the response data structures and response codes specified in table 6.1.3.2.3.2-3. + +**Table 6.1.3.2.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| AnnounceUpdate Data | M | 1 | Contains the Announce Authorization Data to update for the indicated UE and indicated discovery entry. | + +**Table 6.1.3.2.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 3) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 422 Unprocessable Entity | The "cause" attribute may be used to indicate one of the following application errors:
- UNPROCESSABLE REQUEST | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +NOTE 3: If all the modification instructions in the PATCH request have been implemented, the 5G DDNMF shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the 5G DDNMF shall respond with PatchResult. + +**Table 6.1.3.2.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 on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.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 on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.3 Resource: MonitorData + +##### 6.1.3.3.1 Description + +This resource represents the Monitor data. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/n5g-ddnmf-disc//{ueId}/monitor-authorize/{discEntryId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [16] | +| discEntryId | DiscoveryEntryId | Represents Discovery Entry Id. | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|---------------------------------------------------------------------------------------------| +| MonitorAuthReqData | M | 1 | Contains the Monitor Authorization Data for the indicated UE and indicated discovery entry. | + +Table 6.1.3.3.1-3: Data structures supported by the PUT Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MonitorAuthResp Data | M | 1 | 201 Created | Upon success of creation of the resource, a response body containing a representation of the authorized data to monitor for the UE shall be returned.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| n/a | | | 204 No Content | Upon success of the update of the resource, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- PROSE_SERVICE_UNAUTHORIZED

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- APPLICATION_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +Table 6.1.3.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}/n5g-ddnmf-disc/{/ueId}/monitor-authorize/{discEntryId} | + +Table 6.1.3.3.1-5: 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 on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.1-6: 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 on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.3.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------| +| MonitorUpdateData | M | 1 | Contains the Monitor Authorization Data to update for the indicated UE and indicated discovery entry. | + +**Table 6.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 3) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 422 Unprocessable Entity | The "cause" attribute may be used to indicate one of the following application errors:
- UNPROCESSABLE REQUEST | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +NOTE 3: If all the modification instructions in the PATCH request have been implemented, the 5G DDNMF shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the 5G DDNMF shall respond with PatchResult. + +**Table 6.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 on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.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 on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.4 Resource: DiscoveryData + +##### 6.1.3.4.1 Description + +This resource represents the Discovery Data. + +##### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/n5g-ddnmf-disc//{ueId}/discovery-authorize/{discEntryId} + +This resource shall support the resource URI variables defined in table 6.1.3.4.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [16] | +| discEntryId | DiscoveryEntryId | Represents Discovery Entry Id. | + +##### 6.1.3.4.3 Resource Standard Methods + +###### 6.1.3.4.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.4.3.1-1. + +**Table 6.1.3.4.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3. + +**Table 6.1.3.4.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------| +| DiscoveryAuthReq Data | M | 1 | Contains the Discovery Authorization Data for the indicated discoverer UE and indicated discovery entry. | + +**Table 6.1.3.4.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DiscoveryAuthRespData | M | 1 | 201 Created | Upon success of creation of the resource, a response body containing a representation of the authorized data for the discoverer UE in the PLMN to operate Model B restricted discovery shall be returned.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| n/a | | | 204 No Content | Upon success of the update of the resource, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- PROSE_SERVICE_UNAUTHORIZED
- ANNOUNCING_UNAUTHORIZED_IN_PLMN

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- APPLICATION_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +**Table 6.1.3.4.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}/n5g-ddnmf-disc>///discovery - authorize/} | + +**Table 6.1.3.4.3.1-5: 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 on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.4.3.1-6: 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 on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.5 Resource: UeData (Custom operation) + +##### 6.1.3.5.1 Description + +This resource represents the UE Data. + +##### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/n5g-ddnmf-disc//{ueId} + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [16] | + +##### 6.1.3.5.3 Resource Standard Methods + +##### 6.1.3.5.4 Resource Custom Operations + +No Standard Methods are supported for this resource. + +###### 6.1.3.5.4.1 Overview + +**Table 6.1.3.5.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|------------------------------------------------------------------------------| +| match-report | /{ueid}/match-report | POST | Obtain the information about the indicated discovery code from the 5G DDNMF. | + +###### 6.1.3.5.4.2 Operation: match-report + +###### 6.1.3.5.4.2.1 Description + +This operation is used to request the 5G DDNMF to resolve a matched ProSe Discovery Code(s) (ProSe Application Code for open discovery) and obtain the corresponding ProSe Application ID Name(s) and additional information, e.g. metadata. + +###### 6.1.3.5.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.5.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.5.4.2.2-2. + +**Table 6.1.3.5.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|----------------------------------------| +| MatchReportReqData | M | 1 | Contains the Match Report information. | + +**Table 6.1.3.5.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MatchReportRespData | M | 1 | 200 OK | Upon success, a response body containing a representation of the Match Report Acknowledgement shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- PROSE_SERVICE_UNAUTHORIZED
- ANNOUNCING_UNAUTHORIZED_IN_PLMN
- INVALID_APPLICATION_CODE

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +**Table 6.1.3.5.4.2.2-3: 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 on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.5.4.2.2-4: 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 on an alternative service instance within the same 5G DDNMF or 5G DDNMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the N5g-ddnmf\_Discovery Service. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [5] and clause 4.6.2.3 of 3GPP TS 29.501 [6]. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------|----------------------------------|---------------------------------|-------------------------------------------------------------| +| MonitorUpdateResult | {monitorUpdateResultCallbackRef} | POST | Report the monitoring revocation results. | +| MatchInformation | {matchInfoCallbackRef} | POST | Report an observed matching result to a NF service consumer | + +#### 6.1.5.2 MonitorUpdateResult + +##### 6.1.5.2.1 Description + +The MonitorUpdateResult is used by the 5G DDNMF to report the monitoring revocation results (e.g. 5G DDNMF) + +##### 6.1.5.2.2 Target URI + +The Callback URI "{monitorUpdateResultCallbackRef}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Callback URI variables** + +| Name | Definition | +|--------------------------------|-----------------------------------------------| +| monitorUpdateResultCallbackRef | String formatted as URI with the Callback Uri | + +##### 6.1.5.2.3 Standard Methods + +###### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-1. + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|--------------------------------------------------------------------------| +| MonitorUpdateResult | M | 1 | The MonitorUpdateResult shall contain the monitoring revocation results. | + +**Table 6.1.5.2.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +**Table 6.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 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.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 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.5.3 MatchInformation + +##### 6.1.5.3.1 Description + +The POST method is used by the 5G DDNMF to report an observed matching result to a NF service consumer (e.g. 5G DDNMF). + +##### 6.1.5.3.2 Target URI + +The Callback URI "{matchInfoCallbackRef}" shall be used with the callback URI variables defined in table 6.1.5.3.2-1. + +**Table 6.1.5.3.2-1: Callback URI variables** + +| Name | Definition | +|----------------------|-----------------------------------------------| +| matchInfoCallbackRef | String formatted as URI with the Callback Uri | + +##### 6.1.5.3.3 Standard Methods + +###### 6.1.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.3.3.1-1 and the response data structures and response codes specified in table 6.1.5.3.3.1-1. + +**Table 6.1.5.3.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------| +| MatchInformation | M | 1 | The MatchInformation shall contain a matching result of the corresponding operation. | + +**Table 6.1.5.3.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of these errors. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +**Table 6.1.5.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the N5g-ddnmf service based interface protocol. + +Table 6.1.6.1-1: N5g-ddnmf specific Data Types + +| Data type | Clause defined | Description | Applicability | +|--------------------------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| AnnounceAuthData | 6.1.6.2.2 | Represents Data used to request the authorization to announce for a UE | | +| AnnounceDiscDataForOpen | 6.1.6.2.4 | Represents Data for open discovery used to request the authorization to announce for a UE | | +| AnnounceDiscDataForRestricted | 6.1.6.2.5 | Represents Data for restricted discovery used to request the authorization to announce for a UE | | +| AnnounceUpdateData | 6.1.6.2.6 | Represents Announce Authorize Data to update. | | +| MonitorAuthReqData | 6.1.6.2.7 | Represents Data used to request the authorization to monitor for a UE | | +| MonitorAuthRespData | 6.1.6.2.8 | Represents the obtained Monitor Authorize Data for a UE | | +| MonitorDiscDataForOpen | 6.1.6.2.9 | Represents Data for open discovery used to request the authorization to monitor for a UE | | +| MonitorDiscDataForRestricted | 6.1.6.2.10 | Represents Data for restricted discovery used to request the authorization to monitor for a UE | | +| MonitorAuthDataForOpen | 6.1.6.2.11 | Represents the obtained Announce Authorize Data for open discovery for a UE | | +| MonitorAuthDataForRestricted | 6.1.6.2.12 | Represents the obtained Announce Authorize Data for restricted discovery for a UE | | +| MonitorUpdateData | 6.1.6.2.13 | Represents Monitor Authorize Data to update. | | +| DiscoveryAuthReqData | 6.1.6.2.14 | Represents Data used to request the authorization for a discoverer UE | | +| DiscoveryAuthRespData | 6.1.6.2.15 | Represents the obtained authorization Data for a discoverer UE. | | +| DiscDataForRestricted | 6.1.6.2.16 | Represents Data for restricted discovery used to request the authorization for a discoverer UE | | +| AuthDataForRestricted | 6.1.6.2.17 | Represents obtained authorization Data for restricted discovery for a discoverer UE | | +| MatchReportReqData | 6.1.6.2.18 | Represents the Match Report information | | +| MatchReportRespData | 6.1.6.2.19 | Represents Match Report Acknowledgement | | +| MonitorUpdateResult | 6.1.6.2.20 | Represents the monitoring revocation results. | | +| MatchInformation | 6.1.6.2.21 | Represents a report including a matching result, and the information that can be used for charging purpose | | +| MatchInfoForOpen | 6.1.6.2.22 | Represents a report including a matching result, and the information that can be used for charging purpose for the open discovery type. | | +| MatchInfoForRestricted | 6.1.6.2.23 | Represents a report including a matching result, and the information that can be used for charging purpose for the restricted discovery type. | | +| RestrictedCodeSuffixPool | 6.1.6.2.24 | Contains the Restricted Code Suffix Pool. | | +| RestrictedCodeSuffixRange | 6.1.6.2.25 | Contains a range of the Restricted Code Suffixes which are consecutive. | | +| ProseApplicationCodeSuffixPool | 6.1.6.2.26 | Contains the Prose Application Code Suffix Pool. | | +| ProseAppCodeSuffixRange | 6.1.6.2.27 | Contains a range of the Prose Application Code Suffixes which are | | + +| | | | | +|--------------------------------|------------|---------------------------------------------------------------------|--| +| | | consecutive. | | +| MonitorUpdateDataForOpen | 6.1.6.2.28 | Represents Monitor Update Data for the Discovery Type "OPEN" | | +| MonitorUpdateDataForRestricted | 6.1.6.2.29 | Represents Monitor Update Data for the Discovery Type "RESTRICTED". | | +| DiscoveryType | 6.1.6.3.3 | Represents Discovery Type for ProSe Service | | +| AuthorizationResult | 6.1.6.3.4 | Represents Authorization Result Type for ProSe Service | | +| RevocationResult | 6.1.6.3.5 | Represents the monitoring Revocation Result for ProSe Service | | + +Table 6.1.6.1-2 specifies data types re-used by the N5g-ddnmf 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 N service based interface. + +**Table 6.1.6.1-2: N5g-ddnmf re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------|---------------------|-------------------------------------|---------------| +| VarUeld | 3GPP TS 29.571 [16] | String represents the SUPI or GPSI. | | +| DateTime | 3GPP TS 29.571 [16] | DateTime | | +| PlmnId | 3GPP TS 29.571 [16] | Plmn ID | | +| Supi | 3GPP TS 29.571 [16] | SUPI | | +| Uri | 3GPP TS 29.571 [16] | URI | | +| ProblemDetails | 3GPP TS 29.571 [16] | | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: AnnounceAuthData + +**Table 6.1.6.2.2-1: Definition of type AnnounceAuthData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service. | | +| openDiscData | AnnounceDiscDataForOpen | C | 0..1 | This IE shall contain the input data of announce authorisation for open discovery when present.

If the value of discType is "OPEN", this IE shall be present. | | +| restrictedDiscData | AnnounceDiscDataForRestricted | C | 0..1 | This IE shall contain the input data of announce authorisation for restricted discovery when present.

If the value of discType is "RESTRICTED", this IE shall be present. | | + +6.1.6.2.3 Void + +6.1.6.2.4 Type: AnnounceDiscDataForOpen + +**Table 6.1.6.2.4-1: Definition of type AnnounceDiscDataForOpen** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|--------------------------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| proseAppId | ProseApplicationId | M | 1 | This IE shall contain the ProSe Application ID. | | +| validityTime | DateTime | M | 1 | This IE shall contain validity timer up to which the ProSe Application Code is going to expire. | | +| proseAppCode | ProseApplicationCode | C | 0..1 | When present, this IE shall contain the ProSe Application Code.
(NOTE) | | +| proseAppCodePrefix | ProseApplicationPrefix | C | 0..1 | When present, this IE shall contain the ProSe Application Code Prefix.
(NOTE) | | +| proseAppCodeSuffixPool | ProseApplicationCodeSuffixPool | O | 0..1 | This IE shall contain the ProSe Application Code Suffix pool when present. | | +| metaData | MetaData | O | 0..1 | This IE shall contain the metadata when present. | | + +NOTE: Either attribute proseAppCode or attribute proseAppCodePrefix shall be present. + +6.1.6.2.5 Type: AnnounceDiscDataForRestricted + +**Table 6.1.6.2.5-1: Definition of type AnnounceDiscDataForRestricted** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|--------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| rpauid | Rpauid | M | 1 | This IE shall contain the RPAUID. | | +| appId | ApplicationId | M | 1 | This IE shall contain the Application ID | | +| validityTime | DateTime | M | 1 | This IE shall contain validity timer up to which the ProSe Restricted Code is going to expire.

If the value sets to a full zero (i.e., 0000-00-00T00:00:00), it indicates to removes the resources indicated by the Discovery Entry ID for the UE. | | +| proseRestrictedCode | ProseRestrictedCode | C | 0..1 | This IE shall contain the ProSe Restricted Code when present.
(NOTE) | | +| proseRestrictedPrefix | ProseRestrictedPrefix | C | 0..1 | This IE shall contain the ProSe Restricted Code Prefix when present.
(NOTE) | | +| codeSuffixPool | RestrictedCodeSuffixPool | O | 0..1 | This IE shall contain the Restricted Code Suffix pool when present. | | + +NOTE: Either attribute proseRestrictedCode or attribute proseRestrictedPrefix shall be present. + +##### 6.1.6.2.6 Type: AnnounceUpdateData + +Table 6.1.6.2.6-1: Definition of type AnnounceUpdateData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service, only value "OPEN" is allowed. | | +| validityTime | DateTime | M | 1 | This IE shall contain validity timer up to which the ProSe Application Code is going to expire.
If the value sets to a full zero (i.e., 0000-00-00T00:00:00), it indicates to revoke the authorization for the announcing in the PLMN. | | +| proseAppCode | ProseApplicationCode | C | 0..1 | This IE shall contain the ProSe Application Code when present.
If the ProSe Application Code is changed, this IE shall be present.
If the value of attribute is a full zero, this IE shall be absent. | | + +##### 6.1.6.2.7 Type: MonitorAuthReqData + +Table 6.1.6.2.7-1: Definition of type MonitorAuthReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service. | | +| openDiscData | MonitorDiscDataForOpen | C | 0..1 | This IE shall contain the input data of monitor authorisation for open discovery when present.

If the value of discType is "OPEN", this IE shall be present. | | +| restrictedDiscData | MonitorDiscDataForRestricted | C | 0..1 | This IE shall contain the input data of monitor authorisation for restricted discovery when present.

If the value of discType is "RESTRICTED", this IE shall be present. | | + +##### 6.1.6.2.8 Type: MonitorAuthRespData + +Table 6.1.6.2.8-1: Definition of type MonitorAuthRespData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| authDataOpen | MonitorAuthDataForOpen | C | 0..1 | This IE shall contain a list of the ProSe Application Codes when present.

If the discovery type is "OPEN", this IE shall be present. | | +| authDataRestricted | MonitorAuthDataForRestricted | C | 0..1 | This IE shall contain the Prose Application Prefix when present.

If the discovery type in request is "RESTRICTED", this IE shall be present. | | + +##### 6.1.6.2.9 Type: MonitorDiscDataForOpen + +Table 6.1.6.2.9-1: Definition of type MonitorDiscDataForOpen + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------------------|---|-------------|-------------------------------------------------------------|---------------| +| proseAppIdNames | array(ProseApplicationIdName) | M | 1..N | This IE shall contain a list of ProSe Application ID names. | | + +##### 6.1.6.2.10 Type: MonitorDiscDataForRestricted + +Table 6.1.6.2.10-1: Definition of type MonitorDiscDataForRestricted + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|------------------------------------------|---------------| +| rpauid | Rpauid | M | 1 | This IE shall contain the RPAUID. | | +| targetPduid | Pduid | M | 1 | This IE shall contain the Target PDUID. | | +| appid | ApplicationId | M | 1 | This IE shall contain the Application ID | | +| targetRpauid | Rpauid | M | 1 | This IE shall contain the Target RPAUID. | | + +##### 6.1.6.2.11 Type: MonitorAuthDataForOpen + +Table 6.1.6.2.11-1: Definition of type MonitorAuthDataForOpen + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------| +| proseAppCodes | array(ProseApplicationCode) | C | 1..N | This IE shall contain a list of the ProSe Application Codes.
(NOTE) | | +| proseAppPrefix | ProseApplicationPrefix | C | 0..1 | This IE shall contain the Prose Application Prefix.
(NOTE) | | +| proseAppMasks | array(ProseApplicationMask) | M | 1..N | This IE shall contain a list of the ProSe Application Masks. | | +| ttl | integer | M | 1 | This IE shall contain the TTL.
If the value sets to zero, it indicates to revoke the authorization for the monitoring in the PLMN. | | + +NOTE: Either attribute proseAppCodes or proseAppPrefix proseRestrictedPrefix shall be present if the discovery type is open. + +##### 6.1.6.2.12 Type: MonitorAuthDataForRestricted + +Table 6.1.6.2.12-1: Definition of type MonitorAuthDataForRestricted + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| proseRestrictedCode | ProseRestrictedCode | M | 1 | This IE shall contain the ProSe Restricted Code. | | +| validityTime | DateTime | M | 1 | This IE shall contain validity timer up to which the ProSe Application Code is going to expire. | | + +##### 6.1.6.2.13 Type: MonitorUpdateData + +Table 6.1.6.2.13-1: Definition of type MonitorUpdateData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service. | | +| openUpdateData | MonitorUpdateDataForOpen | C | 0..1 | This IE shall contain the Monitor Update Data for open discovery when present.

If the value of discType is "OPEN", this IE shall be present. | | +| restrictedUpdateData | MonitorUpdateDataForRestricted | C | 0..1 | This IE shall contain the Monitor Update Data for restricted discovery when present.

If the value of discType is "RESTRICTED", this IE shall be present. | | + +##### 6.1.6.2.14 Type: DiscoveryAuthReqData + +Table 6.1.6.2.14-1: Definition of type DiscoveryAuthReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service.
Only value "RESTRICTED" is allowed. | | +| restrictedDiscData | DiscDataForRestricted | C | 0..1 | This IE shall contain the input data of authorisation for restricted discovery when present.

If the value of discType is "RESTRICTED", this IE shall be present. | | + +##### 6.1.6.2.15 Type: DiscoveryAuthRespData + +Table 6.1.6.2.15-1: Definition of type DiscoveryAuthRespData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| authDataRestricted | AuthDataForRestricted | C | 0..1 | This IE shall contain the authorized data for restricted discovery when present.

If the discovery type in request is "RESTRICTED", this IE shall be present. | | + +##### 6.1.6.2.16 Type: DiscDataForRestricted + +Table 6.1.6.2.16-1: Definition of type DiscDataForRestricted + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|------------------------------------------|---------------| +| rpauid | Rpauid | M | 1 | This IE shall contain the RPAUID. | | +| targetPduid | Pduid | M | 1 | This IE shall contain the Target PDUID. | | +| appld | ApplicationId | M | 1 | This IE shall contain the Application ID | | +| targetRpauid | Rpauid | M | 1 | This IE shall contain the Target RPAUID. | | + +##### 6.1.6.2.17 Type: AuthDataForRestricted + +Table 6.1.6.2.17-1: Definition of type AuthDataForRestricted + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| proseQueryCodes | array(ProseQueryCode) | M | 1..N | This IE shall contain a list of the authorised ProSe Restricted Code. | | +| proseRespCode | ProseResponse Code | M | 1 | This IE shall contain the authorised ProSe Respond Code. | | +| validityTime | DateTime | M | 1 | This IE shall contain validity timer up to which the ProSe Application Code is going to expire. | | + +##### 6.1.6.2.18 Type: MatchReportReqData + +Table 6.1.6.2.18-1: Definition of type MatchReportReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service.
Only value "OPEN" is allowed. | | +| proseAppCodes | array(ProseApplicationCode) | C | 1..N | This IE shall contain a list of the ProSe Application Codes when present.

If the value of DiscoveryType is "OPEN", this IE shall be present. | | +| monitoredPlmnId | PlmnId | C | 0..1 | This IE shall contain the Monitored PLMN ID when present. | | + +##### 6.1.6.2.19 Type: MatchReportRespData + +Table 6.1.6.2.19-1: Definition of type MatchReportRespData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| proseAppIdNames | array(ProseApplicationIdName) | C | 1..N | This IE shall contain a list of ProSe Application ID names when present.

If the discovery type in the request is "OPEN", this IE shall be present. | | +| validityTime | DateTime | C | 0..1 | This IE shall contain validity timer up to which the ProSe Application Code is going to expire when present.

If the discovery type in the request is "OPEN", this IE shall be present. | | +| metaData | MetaData | O | 0..1 | This IE shall contain the metadata when present. | | +| metaDataIndexMasks | array(MetaDataIndexMask) | O | 1..N | This IE shall contain a list of the Meta Data Index Masks when present. | | + +6.1.6.2.20 Type: MonitorUpdateResult + +**Table 6.1.6.2.20-1: Definition of type MonitorUpdateResult** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service.
Only value "RESTRICTED" is allowed. | | +| proseRestrictedCode | ProseRestrictedCode | M | 1 | This IE shall contain the ProSe Restricted Code. | | +| appId | ApplicationId | M | 1 | This IE shall contain the Application ID | | +| bannedRpauid | Rpauid | M | 1 | This IE shall contain the Banned RPAUID. | | +| bannedPduid | Pduid | M | 1 | This IE shall contain the Banned PDUID. | | +| revocationResult | RevocationResult | M | 1 | This IE shall contain the monitoring revocation results. | | + +6.1.6.2.21 Type: MatchInformation + +**Table 6.1.6.2.21-1: Definition of type MatchInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| discType | DiscoveryType | M | 1 | This IE shall contain the discovery type for ProSe Service. | | +| openMatchInfoForOpen | MatchInfoForOpen | C | 0..1 | This IE shall contain the match report information for open discovery type when present.

If the value of discType is "OPEN", this IE shall be present. | | +| restrictedMatchInfo | MatchInfoForRestricted | C | 0..1 | This IE shall contain the match report information for restricted discovery when present.

If the value of discType is "RESTRICTED", this IE shall be present. | | + +6.1.6.2.22 Type: MatchInfoForOpen + +**Table 6.1.6.2.22-1: Definition of type MatchInfoForOpen** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|------------------------------------------------------|---------------| +| supi | Supi | M | 1 | This IE shall contain the SUPI of UE. | | +| appId | array(ApplicationId) | M | 1 | This IE shall contain a list of the Application IDs. | | + +##### 6.1.6.2.23 Type: MatchInfoForRestricted + +Table 6.1.6.2.23-1: Definition of type MatchInfoForRestricted + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|--------------------------------------------------|---------------| +| supi | Supi | M | 1 | This IE shall contain the SUPI of UE. | | +| rpauid | Rpauid | M | 1 | This IE shall contain the RPAUID. | | +| targetRpauid | Rpauid | M | 1 | This IE shall contain the Target RPAUID. | | +| proseRestrictedCode | ProseRestrictedCode | M | 1 | This IE shall contain the ProSe Restricted Code. | | + +##### 6.1.6.2.24 Type: RestrictedCodeSuffixPool + +Table 6.1.6.2.24-1: Definition of type RestrictedCodeSuffixPool + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------|----------------------------------|---|-------------|-----------------------------------------------------------------------|---------------| +| codeSuffixList | array(RestrictedCodeSuffix) | C | 1..N | This IE shall contain a list of the Restricted Code Suffixes | | +| codeSuffixRangeList | array(RestrictedCodeSuffixRange) | C | 1..N | This IE shall contain a list of ranges of the Restricted Code Suffix. | | +| NOTE: At least one of attributes codeSuffixList and codeSuffixRangeList shall be present. | | | | | | + +##### 6.1.6.2.25 Type: RestrictedCodeSuffixRange + +Table 6.1.6.2.25-1: Definition of type RestrictedCodeSuffixRange + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------|---------------| +| beginningSuffix | RestrictedCodeSuffix | M | 1 | This IE shall contain the lowest ProSe Restricted Code Suffix in a consecutive sequence of ProSe Restricted Code suffixes. | | +| endingSuffix | RestrictedCodeSuffix | M | 1 | This IE shall contain the highest ProSe Restricted Code Suffix in a consecutive sequence of ProSe Restricted Code suffixes. | | + +##### 6.1.6.2.26 Type: ProseApplicationCodeSuffixPool + +Table 6.1.6.2.26-1: Definition of type ProseApplicationCodeSuffixPool + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------|-------------------------|---|-------------|-----------------------------------------------------------------------|---------------| +| codeSuffix | ProseAppCodeSuffix | C | 0..1 | This IE shall contain the ProSe Application Code Suffix. | | +| codeSuffixRange | ProseAppCodeSuffixRange | C | 0..1 | This IE shall contain the range of the ProSe Application Code Suffix. | | +| NOTE: At least one of attributes codeSuffix and codeSuffixRange shall be present. | | | | | | + +6.1.6.2.27 Type: ProseAppCodeSuffixRange + +**Table 6.1.6.2.27-1: Definition of type ProseAppCodeSuffixRange** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------|---------------| +| beginningSuffix | ProseAppCode Suffix | M | 1 | This IE shall contain the lowest ProSe Restricted Code Suffix in a consecutive sequence of ProSe Restricted Code suffixes. | | +| endingSuffix | ProseAppCode Suffix | M | 1 | This IE shall contain the highest ProSe Restricted Code Suffix in a consecutive sequence of ProSe Restricted Code suffixes. | | + +6.1.6.2.28 Type: MonitorUpdateDataForOpen + +**Table 6.1.6.2.28-1: Definition of type MonitorUpdateDataForOpen** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| proseAppIdName | ProseApplicationIdName | M | 1 | This IE shall contain the ProSe Application ID Name. | | +| ttl | integer | M | 1 | This IE shall contain the TTL.

If it sets to zero, it indicates to revoke the previously authorized monitoring. | | + +6.1.6.2.29 Type: MonitorUpdateDataForRestricted + +**Table 6.1.6.2.29-1: Definition of type MonitorUpdateDataForRestricted** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| proseRestrictedCode | ProseRestricted Code | M | 1 | This IE shall contain the ProSe Restricted Code. | | +| appId | ApplicationId | M | 1 | This IE shall contain the Application ID | | +| bannedRpauid | Rpauid | M | 1 | This IE shall contain the Banned RPAUID. | | +| bannedPduid | Pduid | M | 1 | This IE shall contain the Banned PDUID. | | +| monitorUpdateResultCallbackRef | Uri | O | 0..1 | A URI provided by 5G DDNMF to receive (implicitly subscribed) notifications on the monitoring revocation results. | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.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. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|------------------------|-----------------|--------------------------------------------------------------------------------------------------------------|---------------| +| DiscoveryEntryId | string | Discovery Entry ID | | +| ProseApplicationId | string | ProSe Application ID, the format of ProSe Application ID is defined in 3GPP TS 23.003 [17] | | +| ProseApplicationCode | string | ProSe Application Code, the format of ProSe Application Code is defined in 3GPP TS 23.003 [17] | | +| RpauId | string | RPAUID | | +| ApplicationId | string | Application ID | | +| ProseRestrictedCode | string | ProSe Restricted Code, the format of ProSe Restricted Code is defined in 3GPP TS 23.003 [17] | | +| ProseRestrictedPrefix | string | ProSe Restricted Code Prefix, the format of ProSe Restricted Code Prefix is defined in 3GPP TS 23.003 [17] | | +| MetaData | string | metadata | | +| ProseApplicationIdName | string | ProSe Application ID name, the format of ProSe Application ID name is defined in 3GPP TS 23.003 [17] | | +| PduId | string | PDUID | | +| ProseApplicationPrefix | string | Prose Application Code Prefix, the format of Prose Application Code Prefix is defined in 3GPP TS 23.003 [17] | | +| ProseApplicationMask | string | Prose Application Mask | | +| ProseQueryCode | string | ProSe Query Code, the format of ProSe Query Code is defined in 3GPP TS 23.003 [17] | | +| ProseResponseCode | string | ProSe Response Code, the format of ProSe Response Code is defined in 3GPP TS 23.003 [17] | | +| MetaDataIndexMask | string | Meta Data Index Mask | | +| RestrictedCodeSuffix | string | ProSe Restricted Code Suffix, the format of ProSe Restricted Code Suffix is defined in 3GPP TS 23.003 [17] | | +| ProseAppCodeSuffix | string | ProSe Application Code Suffix, the format of ProSe Restricted Code Suffix is defined in 3GPP TS 23.003 [17] | | + +##### 6.1.6.3.3 Enumeration: DiscoveryType + +The enumeration DiscoveryType represents Discovery Type for ProSe Service. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration DiscoveryType** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------|---------------| +| "OPEN" | Discovery type is "open". | | +| "RESTRICTED" | Discovery type is "restricted". | | + +##### 6.1.6.3.4 Void + +##### 6.1.6.3.5 Enumeration: RevocationResult + +The enumeration RevocationResult represents the monitoring Revocation Result for ProSe Service. It shall comply with the provisions defined in table 6.1.6.3.5-1. + +**Table 6.1.6.3.5-1: Enumeration RevocationResult** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------|---------------| +| "SUCCESSFUL" | The Monitoring Revocation is successful. | | +| "FAILED" | The Monitoring Revocation is failed. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +None. + +#### 6.1.6.5 Binary data + +None. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the N5g-ddnmf\_Discovery API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] 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 [5]. + +In addition, the requirements in the following clauses are applicable for the N5g-ddnmf\_Discovery API. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [5]. + +#### 6.1.7.3 Application Errors + +The application errors defined for the N5g-ddnmf\_Discovery service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PROSE_SERVICE_UNAUTHORIZED | 403 Forbidden | It is used when the requested ProSe service is not authorized for this UE Identity. | +| ANNOUNCING_UNAUTHORIZED_IN_PLMN | 403 Forbidden | It is used when the ProSe Application Code received is not authorized to be announced in the indicated monitored/announcing PLMN for the specified PC5 radio technology | +| INVALID_APPLICATION_CODE | 403 Forbidden | It is used when none of the requested ProSe Application Code(s) is valid | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used when no corresponding context exists. | +| APPLICATION_NOT_FOUND | 404 Not Found | It is used when the requested ProSe Application doesn't exist | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the N5g-ddnmf\_Discovery API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [5]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | PatchReport | If some of the modifications included in the PATCH request are not successfully implemented, the 5G DDNMF reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [5]. | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [11] and 3GPP TS 29.500 [5], the access to the N5g-ddnmf\_Discovery API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [12]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the N5g-ddnmf\_Discovery API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [13], 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 N5g-ddnmf\_Discovery service. + +The N5g-ddnmf\_Discovery API defines the following scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [11]: + +**Table 6.1.9-1: OAuth2 scopes defined in N5g-ddnmf\_Discovery API** + +| Scope | Description | +|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| "n5g-ddnmf-disc" | Access to the Npanf_ProseKey API. | +| "n5g-ddnmf-disc:announce-authorize:modify" | Access to modify the authorization to announce for a UE in the PLMN. | +| "n5g-ddnmf-disc:monitor-authorize:modify" | Access to modify the authorization for monitoring for an UE in the PLMN | +| "n5g-ddnmf-disc:discovery-authorize:modify" | Access to modify the authorization from the 5G DDNMF for a discoverer UE in the PLMN to operate Model B restricted discovery | +| "n5g-ddnmf-disc:match-report:invoke" | Access to invoke the information about the indicated discovery code | + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different 5G DDNMF service instance, within the same 5G DDNMF or a different 5G DDNMF of an 5G DDNMF set, e.g. when an 5G DDNMF service instance is part of an 5G DDNMF (service) set or when using indirect communications (see 3GPP TS 29.500 [5]). + +An SCP that reselects a different 5G DDNMF producer instance will return the NF Instance ID of the new 5G DDNMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [5]. + +If an 5G DDNMF within an 5G DDNMF set redirects a service request to a different 5G DDNMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new 5G DDNMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [6] and clause 5B of 3GPP TR 21.900 [14]). + +## A.2 N5g-ddnmf\_Discovery API + +``` +openapi: 3.0.0 + +info: + title: N5g-ddnmf_Discovery API + version: '1.1.0-alpha.3' + description: | + N5g-ddnmf_Discovery Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.555 V18.4.0; 5G System; 5G Direct Discovery Name Management Services; + Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.555/ + +servers: + - url: '{apiRoot}/n5g-ddnmf-disc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + +paths: + /{ueId}/announce-authorize/{discEntryId}: + put: + summary: Obtain the authorization to announce for a UE + operationId: ObtainAnnounceAuth + tags: + - Obtain the authorization to announce for a UE + security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - n5g-ddnmf-disc:announce-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +``` + +``` + +- name: discEntryId + in: path + description: Discovery Entry Id + required: true + schema: + $ref: '#/components/schemas/DiscoveryEntryId' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnnounceAuthData' + required: true +responses: + '201': + description: Successful creation of the resource + content: + application/json: + schema: + $ref: '#/components/schemas/AnnounceAuthData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/n5g-ddnmf-disc>/{apiVersion>}/{ueId}/announce-authorize/{discEntryId} + required: true + schema: + type: string + '204': + description: Successful update of the resource. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +patch: + summary: Update the authorization for announcing for a UE + operationId: UpdateAnnounceAuth + tags: + - Update the authorization for announcing for a UE + security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - n5g-ddnmf-disc:announce-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: discEntryId + in: path + +``` + +``` + description: Discovery Entry Id + required: true + schema: + $ref: '#/components/schemas/DiscoveryEntryId' + requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AnnounceUpdateData' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Expected response to a valid request + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/monitor-authorize/{discEntryId}: + put: + summary: Obtain the authorization to monitor for a UE + operationId: ObtainMonitorAuth + tags: + - Obtain the authorization to monitor for a UE + security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - n5g-ddnmf-disc:monitor-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: discEntryId + in: path + description: Discovery Entry Id + required: true +``` + +``` + schema: + $ref: '#/components/schemas/DiscoveryEntryId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MonitorAuthReqData' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/MonitorAuthRespData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/n5g-ddnmf-disc>///monitor-authorize/{discEntryId} + required: true + schema: + type: string + '204': + description: Successful update of the resource. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +patch: + summary: Update the authorization for monitoring for a UE + operationId: UpdateMonitorAuth + tags: + - Update the authorization for monitoring for a UE + security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - n5g-ddnmf-disc:monitor-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: discEntryId + in: path + description: Discovery Entry Id + required: true + schema: + $ref: '#/components/schemas/DiscoveryEntryId' +``` + +``` +requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/MonitorUpdateData' + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Expected response to a valid request + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +callbacks: + onMonitorUpdateResult: + '{request.body#/monitorUpdateResultCallbackRef}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MonitorUpdateResult' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +``` + +``` + + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +onMatchInformation: + '{request.body#/matchInfoCallbackRef}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MatchInformation' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/discovery-authorize/{discEntryId}: + put: + summary: Obtain the authorization from the 5G DDNMF for a discoverer UE in the PLMN to operate +Model B restricted discovery + operationId: ObtainDiscAuth + tags: + - Obtain the authorization for a discoverer UE + security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - n5g-ddnmf-disc:discovery-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: discEntryId + in: path + description: Discovery Entry Id + +``` + +``` + required: true + schema: + $ref: '#/components/schemas/DiscoveryEntryId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DiscoveryAuthReqData' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/DiscoveryAuthRespData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/n5g-ddnmf-disc>///discovery-authorize/ + required: true + schema: + type: string + '204': + description: Successful update of the resource. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + onMatchInformation: + '{request.body#/matchInfoCallbackRef}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MatchInformation' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/match-report: + post: + summary: Obtain the information about the indicated discovery code from the 5G DDNMF + operationId: MatchReport + tags: + - Obtain the information about the indicated discovery code + security: + - {} + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - oAuth2ClientCredentials: + - n5g-ddnmf-disc + - n5g-ddnmf-disc:match-report:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MatchReportReqData' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/MatchReportRespData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: +``` + +``` + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oAuth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + n5g-ddnmf-disc: Access to the N5g-ddnmf_Discovery API + n5g-ddnmf-disc:announce-authorize:modify: Access to modify the authorization to announce +for a UE in the PLMN + n5g-ddnmf-disc:monitor-authorize:modify: Access to modify the authorization for +monitoring for an UE in the PLMN + n5g-ddnmf-disc:discovery-authorize:modify: Access to modify the authorization from the +5G DDNMF for a discoverer UE in the PLMN to operate Model B restricted discovery + n5g-ddnmf-disc:match-report:invoke: Access to invoke the information about the indicated +discovery code + +schemas: + +# COMPLEX TYPES: + +AnnounceAuthData: + type: object + description: Represents Data used to request the authorization to announce for a UE + required: + - discType + properties: + discType: + $ref: '#/components/schemas/DiscoveryType' + openDiscData: + $ref: '#/components/schemas/AnnounceDiscDataForOpen' + restrictedDiscData: + $ref: '#/components/schemas/AnnounceDiscDataForRestricted' + +AnnounceDiscDataForOpen: + type: object + description: Represents Data for open discovery used to request the authorization to announce +for a UE + required: + - proseAppId + - validityTime + properties: + proseAppId: + $ref: '#/components/schemas/ProseApplicationId' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + proseAppCode: + $ref: '#/components/schemas/ProseApplicationCode' + proseAppCodePrefix: + $ref: '#/components/schemas/ProseApplicationPrefix' + proseAppCodeSuffixPool: + $ref: '#/components/schemas/ProseApplicationCodeSuffixPool' + metaData: + $ref: '#/components/schemas/MetaData' + +AnnounceDiscDataForRestricted: + type: object + description: Represents Data for restricted discovery used to request the authorization to +announce for a UE + required: + - rpauid + - appId + - validityTime + properties: + rpauid: + $ref: '#/components/schemas/Rpauid' + appId: + $ref: '#/components/schemas/ApplicationId' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + proseRestrictedCode: + $ref: '#/components/schemas/ProseRestrictedCode' + proseRestrictedPrefix: + $ref: '#/components/schemas/ProseRestrictedPrefix' + codeSuffixPool: +``` + +``` +$ref: '#/components/schemas/RestrictedCodeSuffixPool' + +AnnounceUpdateData: + type: object + description: Represents Announce Authorize Data to update + required: + - discType + - validityTime + properties: + discType: + $ref: '#/components/schemas/DiscoveryType' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + proseAppCode: + $ref: '#/components/schemas/ProseApplicationCode' + +MonitorAuthReqData: + type: object + description: Represents Data used to request the authorization to monitor for a UE + required: + - discType + properties: + discType: + $ref: '#/components/schemas/DiscoveryType' + openDiscData: + $ref: '#/components/schemas/MonitorDiscDataForOpen' + restrictedDiscData: + $ref: '#/components/schemas/MonitorDiscDataForRestricted' + +MonitorAuthRespData: + type: object + description: Represents the obtained Monitor Authorize Data for a UE + properties: + authDataOpen: + $ref: '#/components/schemas/MonitorAuthDataForOpen' + authDataRestricted: + $ref: '#/components/schemas/MonitorAuthDataForRestricted' + +MonitorDiscDataForOpen: + type: object + description: Represents Data for open discovery used to request the authorization to monitor +for a UE + required: + - proseAppIdNames + properties: + proseAppIdNames: + type: array + items: + $ref: '#/components/schemas/ProseApplicationIdName' + minItems: 1 + +MonitorDiscDataForRestricted: + type: object + description: Represents Data for restricted discovery used to request the authorization to +monitor for a UE + required: + - rpauid + - targetPduid + - appId + - targetRpauid + properties: + rpauid: + $ref: '#/components/schemas/Rpauid' + targetPduid: + $ref: '#/components/schemas/Pduid' + appId: + $ref: '#/components/schemas/ApplicationId' + targetRpauid: + $ref: '#/components/schemas/Rpauid' + +MonitorAuthDataForOpen: + type: object + description: Represents the obtained Announce Authorize Data for open discovery for a UE + required: + - proseAppMasks + - ttl + properties: + proseAppCodes: +``` + +``` + type: array + items: + $ref: '#/components/schemas/ProseApplicationCode' + minItems: 1 + proseAppPrefix: + $ref: '#/components/schemas/ProseApplicationPrefix' + proseAppMasks: + type: array + items: + $ref: '#/components/schemas/ProseApplicationMask' + minItems: 1 + ttl: + type: integer + +MonitorAuthDataForRestricted: + type: object + description: Represents the obtained Announce Authorize Data for restricted discovery for a UE + required: + - proseRestrictedCode + - validityTime + properties: + proseRestrictedCode: + $ref: '#/components/schemas/ProseRestrictedCode' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +MonitorUpdateData: + type: object + description: Represents Monitor Authorize Data to update. + required: + - discType + properties: + discType: + $ref: '#/components/schemas/DiscoveryType' + openUpdateData: + $ref: '#/components/schemas/MonitorUpdateDataForOpen' + restrictedUpdateData: + $ref: '#/components/schemas/MonitorUpdateDataForRestricted' + +DiscoveryAuthReqData: + type: object + description: Represents Data used to request the authorization for a discoverer UE. + required: + - discType + properties: + discType: + $ref: '#/components/schemas/DiscoveryType' + restrictedDiscData: + $ref: '#/components/schemas/DiscDataForRestricted' + +DiscoveryAuthRespData: + type: object + description: Represents the obtained authorization Data for a discoverer UE + properties: + authDataRestricted: + $ref: '#/components/schemas/AuthDataForRestricted' + +DiscDataForRestricted: + type: object + description: Represents Data for restricted discovery used to request the authorization for a discoverer UE + required: + - rpauid + - targetPduid + - appId + - targetRpauid + properties: + rpauid: + $ref: '#/components/schemas/Rpauid' + targetPduid: + $ref: '#/components/schemas/Pduid' + appId: + $ref: '#/components/schemas/ApplicationId' + targetRpauid: + $ref: '#/components/schemas/Rpauid' + +AuthDataForRestricted: + type: object +``` + +UE + +description: Represents obtained authorization Data for restricted discovery for a discoverer + +required: + +- proseQueryCodes +- proseRespCode +- validityTime + +properties: + +- proseQueryCodes: + - items: + - \$ref: '#/components/schemas/ProseQueryCode' + - minItems: 1 +- proseRespCode: + - \$ref: '#/components/schemas/ProseResponseCode' +- validityTime: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/DateTime' + +MatchReportReqData: + +type: object + +description: Represents the Match Report information + +required: + +- discType + +properties: + +- discType: + - \$ref: '#/components/schemas/DiscoveryType' +- proseAppCodes: + - items: + - \$ref: '#/components/schemas/ProseApplicationCode' + - minItems: 1 +- moniteredPlmnId: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnId' + +MatchReportRespData: + +type: object + +description: Represents Match Report Acknowledgement + +properties: + +- proseAppIdNames: + - items: + - \$ref: '#/components/schemas/ProseApplicationIdName' + - minItems: 1 +- validityTime: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/DateTime' +- metaData: + - \$ref: '#/components/schemas/MetaData' +- metaDataIndexMasks: + - items: + - \$ref: '#/components/schemas/MetaDataIndexMask' + - minItems: 1 + +MonitorUpdateResult: + +type: object + +description: Represents the monitoring revocation results. + +required: + +- discType +- proseRestrictedCode +- appId +- bannedRpauid +- bannedPduid +- revocationResult + +properties: + +- discType: + - \$ref: '#/components/schemas/DiscoveryType' +- proseRestrictedCode: + - \$ref: '#/components/schemas/ProseRestrictedCode' +- appId: + - \$ref: '#/components/schemas/ApplicationId' +- bannedRpauid: + - \$ref: '#/components/schemas/Rpauid' +- bannedPduid: + - \$ref: '#/components/schemas/Pduid' +- revocationResult: + - \$ref: '#/components/schemas/RevocationResult' + +MatchInformation: + +type: object + +description: > + +Represents a report including a matching result, and the information that can be used for charging purpose. + +required: + +``` + - discType +properties: + discType: + $ref: '#/components/schemas/DiscoveryType' + openMatchInfoForOpen: + $ref: '#/components/schemas/MatchInfoForOpen' + restrictedMatchInfo: + $ref: '#/components/schemas/MatchInfoForRestricted' + +MatchInfoForOpen: + type: object + description: > + Represents a report including a matching result, and the information that + can be used for charging purpose for the open discovery type. + required: + - supi + - appId + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + appId: + items: + $ref: '#/components/schemas/ApplicationId' + minItems: 1 + +MatchInfoForRestricted: + type: object + description: > + Represents a report including a matching result, and the information that + can be used for charging purpose for the restricted discovery type. + required: + - supi + - rpauid + - targetRpauid + - proseRestrictedCode + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + rpauid: + $ref: '#/components/schemas/Rpauid' + targetRpauid: + $ref: '#/components/schemas/Rpauid' + proseRestrictedCode: + $ref: '#/components/schemas/ProseRestrictedCode' + +RestrictedCodeSuffixPool: + type: object + description: Contains the Restricted Code Suffix Pool. + anyOf: + - required: [ codeSuffixList ] + - required: [ codeSuffixRangeList ] + properties: + codeSuffixList: + type: array + items: + $ref: '#/components/schemas/RestrictedCodeSuffix' + minItems: 1 + codeSuffixRangeList: + type: array + items: + $ref: '#/components/schemas/RestrictedCodeSuffixRange' + minItems: 1 + +RestrictedCodeSuffixRange: + type: object + description: Contains a range of the Restricted Code Suffixes which are consecutive. + required: + - beginningSuffix + - endingSuffix + properties: + beginningSuffix: + $ref: '#/components/schemas/RestrictedCodeSuffix' + endingSuffix: + $ref: '#/components/schemas/RestrictedCodeSuffix' + +ProseApplicationCodeSuffixPool: + type: object + description: Contains the Prose Application Code Suffix Pool. +``` + +``` +anyOf: + - required: [ codeSuffix ] + - required: [ codeSuffixRange ] +properties: + codeSuffix: + $ref: '#/components/schemas/ProseAppCodeSuffix' + codeSuffixRange: + $ref: '#/components/schemas/ProseAppCodeSuffixRange' + +ProseAppCodeSuffixRange: + type: object + description: Contains a range of the Prose Application Code Suffixes which are consecutive. + required: + - beginningSuffix + - endingSuffix + properties: + beginningSuffix: + $ref: '#/components/schemas/ProseAppCodeSuffix' + endingSuffix: + $ref: '#/components/schemas/ProseAppCodeSuffix' + +MonitorUpdateDataForOpen: + type: object + description: Represents Monitor Update Data for the Discovery Type "OPEN". + required: + - proseAppIdName + - ttl + properties: + proseAppIdName: + $ref: '#/components/schemas/ProseApplicationIdName' + ttl: + type: integer + minimum: 0 + +MonitorUpdateDataForRestricted: + type: object + description: Represents Monitor Update Data for the Discovery Type "RESTRICTED". + required: + - proseRestrictedCode + - appId + - bannedRpauid + - bannedPduid + properties: + proseRestrictedCode: + $ref: '#/components/schemas/ProseRestrictedCode' + appId: + $ref: '#/components/schemas/ApplicationId' + bannedRpauid: + $ref: '#/components/schemas/Rpauid' + bannedPduid: + $ref: '#/components/schemas/Pduid' + monitorUpdateResultCallbackRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + +# SIMPLE TYPES: +DiscoveryEntryId: + description: Contains the Discovery Entry ID. + type: string + +ProseApplicationId: + description: Contains the ProSe Application ID. + type: string + +ProseApplicationCode: + description: Contains the ProSe Application Code. + type: string + +Rpauid: + description: Contains the RPAUID. + type: string + +ApplicationId: + description: Contains the Application ID. + type: string + +ProseRestrictedCode: +``` + +description: Contains the ProSe Restricted Code. +type: string + +ProseRestrictedPrefix: +description: Contains the ProSe Restricted Code Prefix. +type: string + +MetaData: +description: Contains the metadata. +type: string + +ProseApplicationIdName: +description: Contains the ProSe Application ID name. +type: string + +Pduid: +description: Contains the PDUID. +type: string + +ProseApplicationPrefix: +description: Contains the Prose Application Code Prefix. +type: string + +ProseApplicationMask: +description: Contains the Prose Application Mask. +type: string + +ProseQueryCode: +description: Contains the ProSe Query Code. +type: string + +ProseResponseCode: +description: Contains the ProSe Response Code. +type: string + +MetaDataIndexMask: +description: Contains the Meta Data Index Mask. +type: string + +RestrictedCodeSuffix: +description: Contains the ProSe Restricted Code Suffix. +type: string + +ProseAppCodeSuffix: +description: Contains the ProSe Application Code Suffix. +type: string + +###### # ENUMS: + +DiscoveryType: +anyOf: +- type: string +enum: +- OPEN +- RESTRICTED +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. +description: > +Possible values are +- OPEN: Discovery type is "open". +- RESTRICTED: Discovery type is "restricted". + +RevocationResult: +anyOf: +- type: string +enum: +- SUCCESSFUL +- FAILED +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. +description: > + +Possible values are + +- SUCCESSFUL: The Monitoring Revocation is successful. +- FAILED: The Monitoring Revocation is failed. + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2021-04 | C4#103-e | C4-212597 | | | | Implementation of pCRs agreed in CT4 # 103-e including C4-212149, C4-212151, C4-212455. | | 0.1.0 | +| 2021-06 | C4#104-e | C4-213528 | | | | Implementation of pCRs agreed in CT4#104-e including C4-213188, C4-213207, C4-213338, C4-213340, C4-213341, C4-213342, C4-213455, C4-213457, C4-213463. | | 0.2.0 | +| 2021-09 | C4#105-e | C4-214757 | | | | Implementation of pCRs agreed in CT4#105-e including C4-214266, C4-214267, C4-214268, C4-214269, C4-214433, C4-214435, C4-214436, C4-214437, C4-214438, C4-214439, C4-214441, C4-214442, C4-214604, C4-214605, C4-214830, C4-214832. | | 0.3.0 | +| 2021-10 | C4#105-e | C4-215521 | | | | Implementation of pCRs agreed in CT4#106-e including C4-215097, C4-215353, C4-215448, C4-215449. | | 0.4.0 | +| 2021-12 | CT#94e | CP-213159 | | | | V1.0.0 presented for information | | 1.0.0 | +| 2022-01 | CT4#107-bis-e | C4-220455 | | | | Implementation of pCRs agreed in CT4#107-bis-e including C4-220281 | | 1.1.0 | +| 2022-03 | CT4#108-e | C4-221593 | | | | Implementation of pCRs agreed in CT4#108-e including C4-221337, C4-221349 | | 1.2.0 | +| 2022-03 | CT#95e | CP-220108 | | | | TS presented for information | | 2.0.0 | +| 2022-03 | CT#95e | | | | | TS approved | | 17.0.0 | +| 2022-06 | CT#96 | CP-221043 | 0001 | 1 | F | Correction on the description of RevocationResult | | 17.1.0 | +| 2022-06 | CT#96 | CP-221029 | 0002 | 1 | F | Remove the apiVersion placeholder from the resource URI variables table | | 17.1.0 | +| 2022-06 | CT#96 | CP-221299 | 0003 | 1 | F | 29.555 0003 Rel-17 API version and External doc update | | 17.1.0 | +| 2022-12 | CT#98-e | CP-223028 | 0005 | 1 | F | Missing Mandatory Status Codes in OpenAPI | | 18.0.0 | +| 2022-12 | CT#98-e | CP-223033 | 0006 | - | F | 29.555 Rel-18 API version and External doc update | | 18.0.0 | +| 2023-03 | CT#99 | CP-230067 | 0008 | - | F | Patch Report feature in 5G DDNMF | | 18.1.0 | +| 2023-06 | CT#100 | CP-231026 | 0007 | 3 | F | Location header description | | 18.2.0 | +| 2023-06 | CT#100 | CP-231026 | 0010 | - | B | OAuth2 scopes in the N5g-ddnmf_Discovery API | | 18.2.0 | +| 2023-06 | CT#100 | CP-231070 | 0011 | - | F | 29.555 Rel-18 API version and External doc update | | 18.2.0 | +| 2023-09 | CT#101 | CP-232058 | 0012 | - | F | validityTimer attribute correction | | 18.3.0 | +| 2023-12 | CT#102 | CP-233028 | 0013 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9113 | | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0015 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | | 18.4.0 | +| 2023-12 | CT#102 | CP-233062 | 0017 | 1 | A | Corrections on Announce Auth | | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 0018 | - | F | 29.555 Rel-18 API version and External doc update | | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29562/raw.md b/raw/rel-18/29_series/29562/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..cc5cca5cafbce98e88960ee08aa1145340a6295a --- /dev/null +++ b/raw/rel-18/29_series/29562/raw.md @@ -0,0 +1,15165 @@ + + +# 3GPP TS 29.562 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Home Subscriber Server (HSS) Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font with a red signal wave icon below the 'P', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------|----| +| Foreword..... | 12 | +| 1 Scope..... | 13 | +| 2 References..... | 13 | +| 3 Definitions of terms, symbols and abbreviations..... | 15 | +| 3.1 Terms..... | 15 | +| 3.2 Symbols..... | 16 | +| 3.3 Abbreviations..... | 16 | +| 4 Overview..... | 16 | +| 4.1 Introduction..... | 16 | +| 5 Services offered by the HSS..... | 17 | +| 5.1 Introduction..... | 17 | +| 5.2 Nhss_imsUEContextManagement Service..... | 18 | +| 5.2.1 Service Description..... | 18 | +| 5.2.2 Service Operations..... | 18 | +| 5.2.2.1 Introduction..... | 18 | +| 5.2.2.2 Registration..... | 19 | +| 5.2.2.2.1 General..... | 19 | +| 5.2.2.2.2 S-CSCF Registration..... | 19 | +| 5.2.2.3 DeregistrationNotification..... | 20 | +| 5.2.2.3.1 General..... | 20 | +| 5.2.2.3.2 HSS initiated Deregistration..... | 20 | +| 5.2.2.4 Deregistration..... | 21 | +| 5.2.2.4.1 General..... | 21 | +| 5.2.2.4.2 S-CSCF deregistration..... | 21 | +| 5.2.2.5 Authorize..... | 21 | +| 5.2.2.5.1 General..... | 21 | +| 5.2.2.5.2 Authorization request..... | 22 | +| 5.2.2.6 RestorationInfoGet..... | 22 | +| 5.2.2.6.1 General..... | 22 | +| 5.2.2.6.2 Restoration Information Retrieval..... | 22 | +| 5.2.2.7 RestorationInfoUpdate..... | 23 | +| 5.2.2.7.1 General..... | 23 | +| 5.2.2.7.2 Restoration Information Update..... | 23 | +| 5.2.2.8 RestorationInfoDelete..... | 24 | +| 5.2.2.8.1 General..... | 24 | +| 5.2.2.8.2 Restoration Information Delete..... | 24 | +| 5.3 Nhss_imsSubscriberDataManagement Service..... | 25 | +| 5.3.1 Service Description..... | 25 | +| 5.3.2 Service Operations..... | 25 | +| 5.3.2.1 Introduction..... | 25 | +| 5.3.2.2 Get..... | 26 | +| 5.3.2.2.1 General..... | 26 | +| 5.3.2.2.2 Identity Data..... | 26 | +| 5.3.2.2.3 IMS Location Data and Status..... | 29 | +| 5.3.2.2.4 IMS Profile Data..... | 31 | +| 5.3.2.2.5 Access Data..... | 34 | +| 5.3.2.2.6 SRVCC Data..... | 38 | +| 5.3.2.2.7 Service Data..... | 38 | +| 5.3.2.2.8 Repository Data..... | 40 | +| 5.3.2.2.9 Shared Subscription Data..... | 41 | +| 5.3.2.3 Subscribe..... | 42 | +| 5.3.2.3.1 General..... | 42 | +| 5.3.2.3.2 Subscription to notifications of data change..... | 42 | +| 5.3.2.3.3 Subscription to notifications of shared data change..... | 43 | +| 5.3.2.3.4 Subscriptions to notification of UE Reachability for IP..... | 43 | + +| | | | +|-----------|----------------------------------------------------------------------------|----| +| 5.3.2.4 | Unsubscribe..... | 44 | +| 5.3.2.4.1 | General..... | 44 | +| 5.3.2.4.2 | Unsubscribe to notifications of data change..... | 44 | +| 5.3.2.4.3 | Unsubscribe to notifications of shared data change..... | 45 | +| 5.3.2.4.4 | Unsubscribe to notification of UE Reachability for IP..... | 46 | +| 5.3.2.5 | ModifySubscription..... | 46 | +| 5.3.2.5.1 | General..... | 46 | +| 5.3.2.5.2 | Modification of a subscription to notifications of data change..... | 46 | +| 5.3.2.5.3 | Modification of a subscription to notifications of shared data change..... | 47 | +| 5.3.2.5.4 | Modification of a subscription to notifications of data change..... | 48 | +| 5.3.2.6 | Notification..... | 48 | +| 5.3.2.6.1 | General..... | 48 | +| 5.3.2.6.2 | Data Change Notification To NF..... | 48 | +| 5.3.2.6.3 | UE Reachability for IP Notification to NF..... | 49 | +| 5.3.2.7 | Update..... | 49 | +| 5.3.2.7.1 | General..... | 49 | +| 5.3.2.7.2 | Repository Data Creation or Update..... | 50 | +| 5.3.2.7.3 | Repository Data Deletion..... | 50 | +| 5.3.2.7.4 | STN-SR update..... | 51 | +| 5.3.2.7.5 | PSI activation state update..... | 52 | +| 5.3.2.7.6 | SMS Registration Information Creation or Update..... | 52 | +| 5.3.2.7.7 | SMS Registration Information Deletion..... | 53 | +| 5.3.2.7.8 | DSAI tag activation state update..... | 53 | +| 5.4 | Nhss_imsUEAuthentication Service..... | 54 | +| 5.4.1 | Service Description..... | 54 | +| 5.4.2 | Service Operations..... | 54 | +| 5.4.2.1 | Introduction..... | 54 | +| 5.4.2.2 | Get..... | 54 | +| 5.4.2.2.1 | General..... | 54 | +| 5.4.2.2.2 | Authentication Information Retrieval..... | 55 | +| 5.5 | Nhss_gbaSubscriberDataManagement Service..... | 55 | +| 5.5.1 | Service Description..... | 55 | +| 5.5.2 | Service Operations..... | 55 | +| 5.5.2.1 | Introduction..... | 55 | +| 5.5.2.2 | Get..... | 56 | +| 5.5.2.2.1 | General..... | 56 | +| 5.5.2.2.2 | Retrieval of GBA subscriber data..... | 56 | +| 5.5.2.3 | Subscribe..... | 56 | +| 5.5.2.3.1 | General..... | 56 | +| 5.5.2.3.2 | Subscription to changes on the GBA subscriber data..... | 56 | +| 5.5.2.4 | Unsubscribe..... | 57 | +| 5.5.2.4.1 | General..... | 57 | +| 5.5.2.4.2 | Unsubscribe to changes on the GBA subscriber data..... | 57 | +| 5.5.2.5 | Modification of Subscription..... | 58 | +| 5.5.2.5.1 | General..... | 58 | +| 5.5.2.5.2 | Modification of Subscription to changes on the GBA subscriber data..... | 58 | +| 5.5.2.5 | Notify..... | 59 | +| 5.5.2.5.1 | General..... | 59 | +| 5.5.2.5.2 | Notification of changes on the GBA subscriber data..... | 59 | +| 5.6 | Nhss_gbaUEAuthentication Service..... | 59 | +| 5.6.1 | Service Description..... | 59 | +| 5.6.2 | Service Operations..... | 59 | +| 5.6.2.1 | Introduction..... | 59 | +| 5.6.2.2 | Get..... | 60 | +| 5.6.2.2.1 | General..... | 60 | +| 5.6.2.2.2 | Request UE authentication data..... | 60 | +| 6 | API Definitions..... | 60 | +| 6.1 | Nhss_imsUEContextManagement Service API..... | 60 | +| 6.1.1 | Introduction..... | 60 | +| 6.1.2 | Usage of HTTP..... | 61 | +| 6.1.2.1 | General..... | 61 | + +| | | | +|------------|---------------------------------------------------------------------------------|----| +| 6.1.2.2 | HTTP standard headers..... | 61 | +| 6.1.2.2.1 | General..... | 61 | +| 6.1.2.2.2 | Content type..... | 61 | +| 6.1.2.3 | HTTP custom headers..... | 61 | +| 6.1.2.3.1 | General..... | 61 | +| 6.1.3 | Resources..... | 62 | +| 6.1.3.1 | Overview..... | 62 | +| 6.1.3.2 | Resource: Scscf Registration..... | 62 | +| 6.1.3.2.1 | Description..... | 62 | +| 6.1.3.2.2 | Resource Definition..... | 62 | +| 6.1.3.2.3 | Resource Standard Methods..... | 63 | +| 6.1.3.2.4 | Resource Custom Operations..... | 64 | +| 6.1.3.3 | Resource: Scscf Restoration Information..... | 64 | +| 6.1.3.3.1 | Description..... | 64 | +| 6.1.3.3.2 | Resource Definition..... | 64 | +| 6.1.3.3.3 | Resource Standard Methods..... | 65 | +| 6.1.4 | Custom Operations without associated resources..... | 68 | +| 6.1.4.1 | Overview..... | 68 | +| 6.1.4.2 | Operation: Authorize..... | 68 | +| 6.1.4.2.1 | Description..... | 68 | +| 6.1.4.2.2 | Operation Definition..... | 68 | +| 6.1.5 | Notifications..... | 69 | +| 6.1.5.1 | General..... | 69 | +| 6.1.5.2 | Deregistration Notification..... | 69 | +| 6.1.6 | Data Model..... | 70 | +| 6.1.6.1 | General..... | 70 | +| 6.1.6.2 | Structured data types..... | 71 | +| 6.1.6.2.1 | Introduction..... | 71 | +| 6.1.6.2.2 | Type: AuthorizationRequest..... | 72 | +| 6.1.6.2.3 | Type: AuthorizationResponse..... | 72 | +| 6.1.6.2.4 | Type: ScscfRestorationInfo..... | 72 | +| 6.1.6.2.5 | Type: ScscfRestorationInfoRequest..... | 73 | +| 6.1.6.2.6 | Type: ScscfRestorationInfoResponse..... | 73 | +| 6.1.6.2.7 | Type: RestorationInfo..... | 73 | +| 6.1.6.2.8 | Type: UeSubscriptionInfo..... | 73 | +| 6.1.6.2.9 | Type: PscsfSubscriptionInfo..... | 74 | +| 6.1.6.2.10 | Type: ScscfRegistration..... | 75 | +| 6.1.6.2.11 | Type: ExtendedProblemDetails..... | 77 | +| 6.1.6.2.12 | Type: AdditionalInfo..... | 77 | +| 6.1.6.2.13 | Type: DeregistrationData..... | 78 | +| 6.1.6.2.14 | Type: DeregistrationReason..... | 78 | +| 6.1.6.2.15 | Type: EmergencyRegisteredIdentity..... | 78 | +| 6.1.6.3 | Simple data types and enumerations..... | 78 | +| 6.1.6.3.1 | Introduction..... | 78 | +| 6.1.6.3.2 | Simple data types..... | 78 | +| 6.1.6.3.3 | Enumeration: AuthorizationType..... | 79 | +| 6.1.6.3.4 | Enumeration: AuthorizationResult..... | 79 | +| 6.1.6.3.5 | Enumeration: ImsRegistrationType..... | 79 | +| 6.1.6.3.6 | Enumeration: LooseRouteIndication..... | 79 | +| 6.1.6.3.7 | Enumeration: DeregistrationReasonCode..... | 80 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types..... | 80 | +| 6.1.7 | Error Handling..... | 81 | +| 6.1.7.1 | General..... | 81 | +| 6.1.7.2 | Protocol Errors..... | 81 | +| 6.1.7.3 | Application Errors..... | 81 | +| 6.1.8 | Feature negotiation..... | 81 | +| 6.1.9 | Security..... | 81 | +| 6.1.10 | HTTP redirection..... | 82 | +| 6.2 | Nhss_imsSubscriberDataManagement Service API..... | 82 | +| 6.2.1 | API URI..... | 82 | +| 6.2.2 | Usage of HTTP..... | 82 | + +| | | | +|------------|----------------------------------------------------|-----| +| 6.2.2.1 | General..... | 82 | +| 6.2.2.2 | HTTP standard headers..... | 82 | +| 6.2.2.2.1 | General..... | 82 | +| 6.2.2.2.2 | Content type..... | 82 | +| 6.2.2.3 | HTTP custom headers..... | 83 | +| 6.2.2.3.1 | General..... | 83 | +| 6.2.3 | Resources..... | 84 | +| 6.2.3.1 | Overview..... | 84 | +| 6.2.3.2 | Resource: IMS Associated Identities..... | 87 | +| 6.2.3.2.1 | Description..... | 87 | +| 6.2.3.2.2 | Resource Definition..... | 88 | +| 6.2.3.2.3 | Resource Standard Methods..... | 88 | +| 6.2.3.3 | Resource: MSISDNS..... | 89 | +| 6.2.3.3.1 | Description..... | 89 | +| 6.2.3.3.2 | Resource Definition..... | 89 | +| 6.2.3.3.3 | Resource Standard Methods..... | 89 | +| 6.2.3.4 | Resource: S-CSCF Capabilities..... | 90 | +| 6.2.3.4.1 | Description..... | 90 | +| 6.2.3.4.2 | Resource Definition..... | 91 | +| 6.2.3.4.3 | Resource Standard Methods..... | 91 | +| 6.2.3.5 | Resource: IMS Profile Data..... | 92 | +| 6.2.3.5.1 | Description..... | 92 | +| 6.2.3.5.2 | Resource Definition..... | 92 | +| 6.2.3.5.3 | Resource Standard Methods..... | 92 | +| 6.2.3.6 | Resource: Subscriptions..... | 94 | +| 6.2.3.6.1 | Description..... | 94 | +| 6.2.3.6.2 | Resource Definition..... | 94 | +| 6.2.3.6.3 | Resource Standard Methods..... | 94 | +| 6.2.3.7 | Resource: Individual subscription..... | 95 | +| 6.2.3.7.1 | Description..... | 95 | +| 6.2.3.7.2 | Resource Definition..... | 96 | +| 6.2.3.7.3 | Resource Standard Methods..... | 96 | +| 6.2.3.8 | Resource: SharedDataSubscriptions..... | 98 | +| 6.2.3.8.1 | Description..... | 98 | +| 6.2.3.8.2 | Resource Definition..... | 98 | +| 6.2.3.8.3 | Resource Standard Methods..... | 99 | +| 6.2.3.9 | Resource: Shared Data Individual subscription..... | 100 | +| 6.2.3.9.1 | Description..... | 100 | +| 6.2.3.9.2 | Resource Definition..... | 100 | +| 6.2.3.9.3 | Resource Standard Methods..... | 100 | +| 6.2.3.10 | Resource: IMS Registration Status..... | 102 | +| 6.2.3.10.1 | Description..... | 102 | +| 6.2.3.10.2 | Resource Definition..... | 103 | +| 6.2.3.10.3 | Resource Standard Methods..... | 103 | +| 6.2.3.11 | Resource: Service Priority Information..... | 104 | +| 6.2.3.11.1 | Description..... | 104 | +| 6.2.3.11.2 | Resource Definition..... | 104 | +| 6.2.3.11.3 | Resource Standard Methods..... | 104 | +| 6.2.3.12 | Resource: Initial Filter Criteria..... | 105 | +| 6.2.3.12.1 | Description..... | 105 | +| 6.2.3.12.2 | Resource Definition..... | 105 | +| 6.2.3.12.3 | Resource Standard Methods..... | 106 | +| 6.2.3.13 | Resource: IMS Location Data..... | 107 | +| 6.2.3.13.1 | Description..... | 107 | +| 6.2.3.13.2 | Resource Definition..... | 107 | +| 6.2.3.13.3 | Resource Standard Methods..... | 107 | +| 6.2.3.14 | Resource: Service Level Trace Information..... | 108 | +| 6.2.3.14.1 | Description..... | 108 | +| 6.2.3.14.2 | Resource Definition..... | 108 | +| 6.2.3.14.3 | Resource Standard Methods..... | 109 | +| 6.2.3.15 | Resource: PS location Information..... | 110 | + +| | | | +|------------|--------------------------------------------------------|-----| +| 6.2.3.15.1 | Description..... | 110 | +| 6.2.3.15.2 | Resource Definition..... | 110 | +| 6.2.3.15.3 | Resource Standard Methods..... | 110 | +| 6.2.3.16 | Resource: CS location Information..... | 112 | +| 6.2.3.16.1 | Description..... | 112 | +| 6.2.3.16.2 | Resource Definition..... | 112 | +| 6.2.3.16.3 | Resource Standard Methods..... | 113 | +| 6.2.3.17 | Resource: SRVCC data..... | 114 | +| 6.2.3.17.1 | Description..... | 114 | +| 6.2.3.17.2 | Resource Definition..... | 114 | +| 6.2.3.17.3 | Resource Standard Methods..... | 115 | +| 6.2.3.18 | Resource: PSI activation state..... | 117 | +| 6.2.3.18.1 | Description..... | 117 | +| 6.2.3.18.2 | Resource Definition..... | 118 | +| 6.2.3.18.3 | Resource Standard Methods..... | 118 | +| 6.2.3.19 | Resource: Repository Data..... | 120 | +| 6.2.3.19.1 | Description..... | 120 | +| 6.2.3.19.2 | Resource Definition..... | 120 | +| 6.2.3.19.3 | Resource Standard Methods..... | 121 | +| 6.2.3.20 | Resource: SharedData..... | 125 | +| 6.2.3.20.1 | Description..... | 125 | +| 6.2.3.20.2 | Resource Definition..... | 125 | +| 6.2.3.20.3 | Resource Standard Methods..... | 125 | +| 6.2.3.21 | Resource: ImeiSvInformation..... | 126 | +| 6.2.3.21.1 | Description..... | 126 | +| 6.2.3.21.2 | Resource Definition..... | 126 | +| 6.2.3.21.3 | Resource Standard Methods..... | 126 | +| 6.2.3.22 | Resource: IP Address..... | 128 | +| 6.2.3.22.1 | Description..... | 128 | +| 6.2.3.22.2 | Resource Definition..... | 128 | +| 6.2.3.22.3 | Resource Standard Methods..... | 128 | +| 6.2.3.23 | Resource: T-ADS Info..... | 129 | +| 6.2.3.23.1 | Description..... | 129 | +| 6.2.3.23.2 | Resource Definition..... | 129 | +| 6.2.3.23.3 | Resource Standard Methods..... | 130 | +| 6.2.3.24 | Resource: UeReachabilitySubscriptions..... | 131 | +| 6.2.3.24 | Description..... | 131 | +| 6.2.3.24.2 | Resource Definition..... | 131 | +| 6.2.3.24.3 | Resource Standard Methods..... | 131 | +| 6.2.3.25 | Resource: UE reachability Individual subscription..... | 133 | +| 6.2.3.25.1 | Description..... | 133 | +| 6.2.3.25.2 | Resource Definition..... | 133 | +| 6.2.3.25.3 | Resource Standard Methods..... | 133 | +| 6.2.3.26 | Resource: PS User State..... | 136 | +| 6.2.3.26.1 | Description..... | 136 | +| 6.2.3.26.2 | Resource Definition..... | 136 | +| 6.2.3.26.3 | Resource Standard Methods..... | 136 | +| 6.2.3.27 | Resource: CS User State..... | 137 | +| 6.2.3.27.1 | Description..... | 137 | +| 6.2.3.27.2 | Resource Definition..... | 137 | +| 6.2.3.27.3 | Resource Standard Methods..... | 138 | +| 6.2.3.28 | Resource: Csrn..... | 139 | +| 6.2.3.28.1 | Description..... | 139 | +| 6.2.3.28.2 | Resource Definition..... | 139 | +| 6.2.3.28.3 | Resource Standard Methods..... | 139 | +| 6.2.3.29 | Resource: ReferenceAccessLocation..... | 141 | +| 6.2.3.29.1 | Description..... | 141 | +| 6.2.3.29.2 | Resource Definition..... | 141 | +| 6.2.3.29.3 | Resource Standard Methods..... | 141 | +| 6.2.3.30 | Resource: SMSRegistrationInfo..... | 143 | +| 6.2.3.30.1 | Description..... | 143 | + +| | | | +|------------|--------------------------------------------------------|-----| +| 6.2.3.30.2 | Resource Definition..... | 143 | +| 6.2.3.30.3 | Resource Standard Methods..... | 143 | +| 6.2.3.31 | Resource: Dsai..... | 147 | +| 6.2.3.31.1 | Description..... | 147 | +| 6.2.3.31.2 | Resource Definition..... | 147 | +| 6.2.3.31.3 | Resource Standard Methods..... | 148 | +| 6.2.3.32 | Resource: Private Identities..... | 150 | +| 6.2.3.32.1 | Description..... | 150 | +| 6.2.3.32.2 | Resource Definition..... | 150 | +| 6.2.3.32.3 | Resource Standard Methods..... | 151 | +| 6.2.3.33 | Resource: S-CSCF Selection Assistance Information..... | 152 | +| 6.2.3.33.1 | Description..... | 152 | +| 6.2.3.33.2 | Resource Definition..... | 152 | +| 6.2.3.33.3 | Resource Standard Methods..... | 152 | +| 6.2.3.34 | Resource: Charging Information..... | 153 | +| 6.2.3.34.1 | Description..... | 153 | +| 6.2.3.34.2 | Resource Definition..... | 153 | +| 6.2.3.34.3 | Resource Standard Methods..... | 154 | +| 6.2.3.35 | Resource: Repository Data List..... | 154 | +| 6.2.3.35.1 | Description..... | 154 | +| 6.2.3.35.2 | Resource Definition..... | 154 | +| 6.2.3.35.3 | Resource Standard Methods..... | 155 | +| 6.2.5 | Notifications..... | 156 | +| 6.2.5.1 | General..... | 156 | +| 6.2.5.2 | Data Change Notification..... | 156 | +| 6.2.6 | Data Model..... | 157 | +| 6.2.6.1 | General..... | 157 | +| 6.2.6.2 | Structured data types..... | 160 | +| 6.2.6.2.1 | Introduction..... | 160 | +| 6.2.6.2.2 | Type: ScscfCapabilityList..... | 160 | +| 6.2.6.2.3 | Type: Capabilities..... | 161 | +| 6.2.6.2.4 | Type: ImsProfileData..... | 161 | +| 6.2.6.2.5 | Type: SharedData..... | 161 | +| 6.2.6.2.6 | Type: ImsDataSets..... | 161 | +| 6.2.6.2.7 | Type: RepositoryData..... | 161 | +| 6.2.6.2.8 | Type: MsisdnList..... | 162 | +| 6.2.6.2.9 | Type: PublicIdentities..... | 162 | +| 6.2.6.2.10 | Type: PublicIdentity..... | 162 | +| 6.2.6.2.11 | Type: ImsSdmSubscription..... | 162 | +| 6.2.6.2.12 | Type: ImsRegistrationStatus..... | 163 | +| 6.2.6.2.13 | Type: PriorityLevels..... | 163 | +| 6.2.6.2.14 | Type: Ifcs..... | 163 | +| 6.2.6.2.15 | Type: Ifc..... | 163 | +| 6.2.6.2.16 | Type: TriggerPoint..... | 164 | +| 6.2.6.2.17 | Type: Spt..... | 164 | +| 6.2.6.2.18 | Type: HeaderSipRequest..... | 165 | +| 6.2.6.2.19 | Type: SdpDescription..... | 165 | +| 6.2.6.2.20 | Type: ApplicationServer..... | 165 | +| 6.2.6.2.21 | Type: ImsLocationData..... | 165 | +| 6.2.6.2.22 | Type: ServiceLevelTraceInformation..... | 166 | +| 6.2.6.2.23 | Type: PsLocation..... | 166 | +| 6.2.6.2.24 | Type: SgsnLocationData..... | 166 | +| 6.2.6.2.25 | Type: MmeLocationData..... | 166 | +| 6.2.6.2.26 | Type: AmfLocationData..... | 167 | +| 6.2.6.2.27 | Type: TwanLocationData..... | 167 | +| 6.2.6.2.28 | Type: CsLocation..... | 167 | +| 6.2.6.2.29 | Type: CsgInformation..... | 168 | +| 6.2.6.2.30 | Type: SrvccData..... | 168 | +| 6.2.6.2.31 | Type: PsiActivationState..... | 168 | +| 6.2.6.2.32 | Type: ImsServiceProfile..... | 168 | +| 6.2.6.2.33 | Type: PublicIdentifier..... | 169 | + +| | | | +|------------|------------------------------------------------|-----| +| 6.2.6.2.34 | Type: ImeiSvInformation..... | 169 | +| 6.2.6.2.35 | Void..... | 169 | +| 6.2.6.2.36 | Type: TadsInformation..... | 169 | +| 6.2.6.2.37 | Type: UeReachabilitySubscription..... | 169 | +| 6.2.6.2.38 | Type: UeReachabilityNotification..... | 170 | +| 6.2.6.2.39 | Type: PsUserState..... | 170 | +| 6.2.6.2.40 | Type: CsUserState..... | 170 | +| 6.2.6.2.41 | Type: Csrn..... | 170 | +| 6.2.6.2.42 | Type: ReferenceLocationInformation..... | 170 | +| 6.2.6.2.43 | Type: SmsRegistrationInfo..... | 171 | +| 6.2.6.2.44 | Type: IpSmGwAddress..... | 171 | +| 6.2.6.2.45 | Type: ImsAssociatedIdentities..... | 171 | +| 6.2.6.2.46 | Type: DsaiTagInformation..... | 171 | +| 6.2.6.2.47 | Type: DsaiTagStatus..... | 171 | +| 6.2.6.2.48 | Type: CreatedUeReachabilitySubscription..... | 172 | +| 6.2.6.2.49 | Type: PrivateIdentities..... | 172 | +| 6.2.6.2.50 | Type: PrivateIdentity..... | 172 | +| 6.2.6.2.51 | Type: SscfSelectionAssistanceInformation..... | 172 | +| 6.2.6.2.52 | Type: ChargingInfo..... | 172 | +| 6.2.6.2.53 | Type: RepositoryDataList..... | 173 | +| 6.2.6.2.54 | Type: CoreNetworkServiceAuthorization..... | 173 | +| 6.2.6.3 | Simple data types and enumerations..... | 173 | +| 6.2.6.3.1 | Introduction..... | 173 | +| 6.2.6.3.2 | Simple data types..... | 173 | +| 6.2.6.3.3 | Enumeration: DataSetName..... | 174 | +| 6.2.6.3.4 | Enumeration: IdentityType..... | 174 | +| 6.2.6.3.5 | Enumeration: ImsRegistrationState..... | 175 | +| 6.2.6.3.6 | Enumeration: TypeOfCondition..... | 175 | +| 6.2.6.3.7 | Enumeration: RegistrationType..... | 175 | +| 6.2.6.3.8 | Enumeration: RequestDirection..... | 175 | +| 6.2.6.3.9 | Enumeration: ServiceInformation..... | 176 | +| 6.2.6.3.10 | Enumeration: RequestedNode..... | 176 | +| 6.2.6.3.11 | Enumeration: SrvccCapability..... | 176 | +| 6.2.6.3.12 | Enumeration: ActivationState..... | 176 | +| 6.2.6.3.13 | Enumeration: ImsVoiceOverPsSessionSupport..... | 177 | +| 6.2.6.3.14 | Enumeration: AccessType..... | 177 | +| 6.2.6.3.15 | Enumeration: UserStatePs..... | 177 | +| 6.2.6.3.16 | Enumeration: UserStateCs..... | 177 | +| 6.2.6.3.17 | Enumeration: PrivateIdentityType..... | 178 | +| 6.2.7 | Error Handling..... | 178 | +| 6.2.7.1 | General..... | 178 | +| 6.2.7.2 | Protocol Errors..... | 178 | +| 6.2.7.3 | Application Errors..... | 178 | +| 6.2.8 | Feature negotiation..... | 178 | +| 6.2.9 | Security..... | 179 | +| 6.2.10 | HTTP redirection..... | 180 | +| 6.3 | Nhss_imsUEAuthentication Service API..... | 181 | +| 6.3.1 | API URI..... | 181 | +| 6.3.2 | Usage of HTTP..... | 181 | +| 6.3.2.1 | General..... | 181 | +| 6.3.2.2 | HTTP standard headers..... | 181 | +| 6.3.2.2.1 | General..... | 181 | +| 6.3.2.2.2 | Content type..... | 181 | +| 6.3.2.3 | HTTP custom headers..... | 181 | +| 6.3.2.3.1 | General..... | 181 | +| 6.3.3 | Resources..... | 182 | +| 6.3.3.1 | Overview..... | 182 | +| 6.3.3.2 | Resource: SecurityInformation..... | 182 | +| 6.3.3.2.1 | Description..... | 182 | +| 6.3.3.2.2 | Resource Definition..... | 182 | +| 6.3.3.2.3 | Resource Standard Methods..... | 183 | + +| | | | +|-----------|-----------------------------------------------------|-----| +| 6.3.3.2.4 | Resource Custom Operations..... | 183 | +| 6.3.4 | Custom Operations without associated resources..... | 184 | +| 6.3.5 | Notifications..... | 184 | +| 6.3.6 | Data Model..... | 184 | +| 6.3.6.1 | General..... | 184 | +| 6.3.6.2 | Structured data types..... | 185 | +| 6.3.6.2.1 | Introduction..... | 185 | +| 6.3.6.2.2 | Type: SipAuthenticationInfoRequest..... | 185 | +| 6.3.6.2.3 | Type: SipAuthenticationInfoResult..... | 185 | +| 6.3.6.2.4 | Type: ResynchronizationInfo..... | 186 | +| 6.3.6.2.5 | Type: 3GAkaAv..... | 186 | +| 6.3.6.2.6 | Type: DigestAuthentication..... | 186 | +| 6.3.6.2.7 | Void..... | 186 | +| 6.3.6.3 | Simple data types and enumerations..... | 186 | +| 6.3.6.3.1 | Introduction..... | 186 | +| 6.3.6.3.2 | Simple data types..... | 186 | +| 6.3.6.3.3 | Enumeration: SipAuthenticationScheme..... | 186 | +| 6.3.6.3.4 | Enumeration: SipDigestAlgorithm..... | 187 | +| 6.3.6.3.5 | Enumeration: SipDigestQop..... | 187 | +| 6.3.7 | Error Handling..... | 187 | +| 6.3.7.1 | General..... | 187 | +| 6.3.7.2 | Protocol Errors..... | 187 | +| 6.3.7.3 | Application Errors..... | 187 | +| 6.3.8 | Feature Negotiation..... | 188 | +| 6.3.9 | Security..... | 188 | +| 6.3.10 | HTTP redirection..... | 188 | +| 6.4 | Nhss_gbaSubscriberDataManagement Service API..... | 188 | +| 6.4.1 | API URI..... | 188 | +| 6.4.2 | Usage of HTTP..... | 188 | +| 6.4.2.1 | General..... | 188 | +| 6.4.2.2 | HTTP standard headers..... | 189 | +| 6.4.2.2.1 | General..... | 189 | +| 6.4.2.2.2 | Content type..... | 189 | +| 6.4.2.3 | HTTP custom headers..... | 189 | +| 6.4.2.3.1 | General..... | 189 | +| 6.4.3 | Resources..... | 189 | +| 6.4.3.1 | Overview..... | 189 | +| 6.4.3.2 | Resource: GBA Subscriber Data..... | 190 | +| 6.4.3.2.1 | Description..... | 190 | +| 6.4.3.2.2 | Resource Definition..... | 190 | +| 6.4.3.2.3 | Resource Standard Methods..... | 190 | +| 6.4.3.3 | Resource: Subscriptions..... | 191 | +| 6.4.3.3.1 | Description..... | 191 | +| 6.4.3.3.2 | Resource Definition..... | 191 | +| 6.4.3.3.3 | Resource Standard Methods..... | 192 | +| 6.4.3.4 | Resource: Individual subscription..... | 193 | +| 6.4.3.4.1 | Description..... | 193 | +| 6.4.3.4.2 | Resource Definition..... | 193 | +| 6.4.3.4.3 | Resource Standard Methods..... | 193 | +| 6.4.4 | Custom Operations without associated resources..... | 195 | +| 6.4.5 | Notifications..... | 195 | +| 6.4.5.1 | General..... | 195 | +| 6.4.5.2 | Data Change Notification..... | 196 | +| 6.4.6 | Data Model..... | 197 | +| 6.4.6.1 | General..... | 197 | +| 6.4.6.2 | Structured data types..... | 197 | +| 6.4.6.2.1 | Introduction..... | 197 | +| 6.4.6.2.2 | Type: GbaSubscriberData..... | 197 | +| 6.4.6.2.3 | Type: Guss..... | 197 | +| 6.4.6.2.4 | Type: BsfInfo..... | 198 | +| 6.4.6.2.5 | Type: GbaSdmSubscription..... | 198 | + +| | | | +|-----------|-------------------------------------------------------|-----| +| 6.4.6.3 | Simple data types and enumerations..... | 198 | +| 6.4.6.3.1 | Introduction..... | 198 | +| 6.4.6.3.2 | Simple data types..... | 198 | +| 6.4.6.3.3 | Enumeration: UiccType..... | 198 | +| 6.4.7 | Error Handling..... | 199 | +| 6.4.7.1 | General..... | 199 | +| 6.4.7.2 | Protocol Errors..... | 199 | +| 6.4.7.3 | Application Errors..... | 199 | +| 6.4.8 | Feature Negotiation..... | 199 | +| 6.4.9 | Security..... | 199 | +| 6.4.10 | HTTP redirection..... | 200 | +| 6.5 | Nhss_gbaUEAuthentication Service API..... | 200 | +| 6.5.1 | API URI..... | 200 | +| 6.5.2 | Usage of HTTP..... | 200 | +| 6.5.2.1 | General..... | 200 | +| 6.5.2.2 | HTTP standard headers..... | 200 | +| 6.5.2.2.1 | General..... | 200 | +| 6.5.2.2.2 | Content type..... | 200 | +| 6.5.2.3 | HTTP custom headers..... | 200 | +| 6.5.2.3.1 | General..... | 200 | +| 6.5.3 | Resources..... | 201 | +| 6.5.3.1 | Overview..... | 201 | +| 6.5.3.2 | Resource: SecurityInformation (Custom Operation)..... | 201 | +| 6.5.3.2.1 | Description..... | 201 | +| 6.5.3.2.2 | Resource Definition..... | 201 | +| 6.5.3.2.3 | Resource Standard Methods..... | 201 | +| 6.5.3.2.3 | Resource Custom Operations..... | 202 | +| 6.5.5 | Notifications..... | 203 | +| 6.5.6 | Data Model..... | 203 | +| 6.5.6.1 | General..... | 203 | +| 6.5.6.2 | Structured data types..... | 203 | +| 6.5.6.2.1 | Introduction..... | 203 | +| 6.5.6.2.2 | Type: AuthenticationInfoRequest..... | 204 | +| 6.5.6.2.3 | Type: AuthenticationInfoResult..... | 204 | +| 6.5.6.2.4 | Void..... | 204 | +| 6.5.6.2.5 | Void..... | 204 | +| 6.5.6.2.6 | Type: DigestAuthentication..... | 204 | +| 6.5.6.3 | Simple data types and enumerations..... | 204 | +| 6.5.6.3.1 | Introduction..... | 204 | +| 6.5.6.3.2 | Simple data types..... | 204 | +| 6.5.6.3.3 | Enumeration: AuthenticationScheme..... | 204 | +| 6.5.6.3.4 | Enumeration: DigestAlgorithm..... | 205 | +| 6.5.6.3.5 | Enumeration: DigestQop..... | 205 | +| 6.5.7 | Error Handling..... | 205 | +| 6.5.7.1 | General..... | 205 | +| 6.5.7.2 | Protocol Errors..... | 205 | +| 6.5.7.3 | Application Errors..... | 205 | +| 6.5.8 | Feature Negotiation..... | 205 | +| 6.5.9 | Security..... | 206 | +| 6.5.10 | HTTP redirection..... | 206 | + +| | | | +|-------------------------------|------------------------------------|------------| +| Annex A (normative): | OpenAPI specification..... | 207 | +| A.1 | General..... | 207 | +| A.2 | Nhss_imsUECM API..... | 207 | +| A.3 | Nhss_imsSDM API..... | 216 | +| A.4 | Nhss_imsUEAU API..... | 270 | +| A.5 | Nhss_gbaSDM API..... | 273 | +| A.6 | Nhss_gbaUEAU API..... | 279 | +| Annex B (informative): | Withdrawn API versions..... | 282 | +| B.1 | General..... | 282 | +| Annex C (informative): | Change history..... | 283 | + +## Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the stage 3 protocol, including message flows and API specification details, for the Nhss services, as part of the 5G Service-Based Architecture, offered by the HSS. + +The HSS services specified in the present document include: + +- Services for interworking with the IP Multimedia Subsystem (IMS) +- Services for interworking with the Generic Bootstrapping Architecture (GBA) + +NOTE: The HSS services for Interworking with the Unified Data Management (UDM) Network Function are specified in 3GPP TS 29.563 [39]. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The IP Multimedia Subsystem (IMS) stage 2 architecture and procedures are specified in 3GPP TS 23.228 [6]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +The stage 2 architecture and procedures of SBA-enabled GBA is specified in 3GPP TS 33.220 [40] and 3GPP TS 33.223 [41]. + +--- + +## 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [7] 3GPP TS 29.335: "User Data Repository Access Protocol over the Ud interface; Stage 3". + +- [8] IETF RFC 9113: "HTTP/2". +- [9] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", . +- [10] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [11] IETF RFC 9457: "Problem Details for HTTP APIs". +- [12] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [13] 3GPP TS 23.003: "Numbering, addressing and identification". +- [14] 3GPP TS 33.203: "Access security for IP-based services". +- [15] 3GPP TS 29.503: "Unified Data Management Services; Stage 3". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [17] IETF RFC 4740: "Diameter Session Initiation Protocol (SIP) Application". +- [18] 3GPP TS 24.229: "IP multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [19] IETF RFC 4412: "Communications Resource Priority for the Session Initiation Protocol". +- [20] 3GPP TS 29.228: "IP Multimedia (IM) Subsystem Cx and Dx interfaces; Signalling flows and message contents". +- [21] 3GPP TS 29.218: "IP Multimedia (IM) session handling; IM call model; Stage 2". +- [22] IETF RFC 3261: "SIP: Session Initiation Protocol". +- [23] IETF RFC 8497: "Marking SIP messages to be logged". +- [24] 3GPP TS 24.323: "3GPP IP Multimedia Subsystem (IMS) service level tracing Management Object (MO)". +- [25] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [26] 3GPP TS 29.273: "Evolved Packet System (EPS); 3GPP EPS AAA interfaces". +- [27] IETF RFC 4776: "Dynamic Host Configuration Protocol (DHCPv4 and DHCPv6) Option for Civic Addresses Configuration Information". +- [28] IETF RFC 2045: "Multipart Internet Mail Extensions(MIME) Part One: Format of Internet Message Bodies". +- [29] ETSI ES 283 034: "Network Attachment Sub-System (NASS); e4 interface based on the DIAMETER protocol". +- [30] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [31] 3GPP TS 23.078: "Customised Applications for Mobile network Enhanced Logic (CAMEL) Phase 3 - Stage 2". +- [32] 3GPP TS 29.272: "Evolved Packet System; MME and SGSN Related Interfaces Based on Diameter Protocol". +- [33] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [34] 3GPP TR 21.900: "Technical Specification Group working methods". +- [35] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [36] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [37] 3GPP TS 23.380: "IP Multimedia Subsystem (IMS); IMS Restoration Procedures". + +- [38] 3GPP TS 29.328: "IP Multimedia (IM) Subsystem Sh interface; Signalling flows and message contents". +- [39] 3GPP TS 29.563: "Home Subscriber Server (HSS) services for interworking with Unified Data Management (UDM); Stage 3". +- [40] 3GPP TS 33.220: "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture (GBA)". +- [41] 3GPP TS 33.223: "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture (GBA) Push function". +- [42] 3GPP TS 29.309: "Bootstrapping Server Function (GBA BSF) Services; Stage 3". +- [43] 3GPP TS 23.218: "IP Multimedia (IM) session handling; IM call model; Stage 2". + +--- + +## 3 Definitions of terms, symbols and abbreviations + +### 3.1 Terms + +The following terms and definitions given in TS 23.003 [13] apply: + +**Distinct Public Service Identity** + +**Distinct Public User Identity** + +**Public Service Identity** + +**Public User Identity** + +**Wildcarded Public Service Identity** + +**Wildcarded Public User Identity** + +In the present document, the following terms and definitions apply. + +**Common Part** (of a user profile): Contains Initial Filter Criteria instances that should be evaluated both for registered and unregistered Public User Identities, or for unregistered Public Service Identities in the S-CSCF. + +**Complete user profile**: Contains the Initial Filter Criteria instances of all three different user profile parts; registered part, unregistered part and common part. + +**IP Multimedia session**: IP Multimedia session and IP Multimedia call are treated as equivalent in this specification. + +**Authentication pending flag**: A flag that indicates that the authentication of a Public User Identity - Private User Identity pair is pending and waiting for confirmation. + +**Implicitly registered Public User Identity set**: A set of Public User Identities, which are registered and de-registered simultaneously when any of the Public User Identities belonging to that set is registered or de-registered. + +**Not Registered State**: Public Identity is not Registered and has no S-CSCF assigned. + +**Private Identity**: Either a Private User Identity or a Private Service Identity. + +**Public Identity**: Either a Public User Identity or a Public Service Identity. + +**Registered State**: Public User Identity is Registered at the request of the user and has an S-CSCF assigned. + +**Unregistered State**: Public Identity is not Registered but has a serving S-CSCF assigned to execute Unregistered state services as a consequence of a terminating request, or an originating request from an AS on behalf of a user, or there is an S-CSCF keeping the user profile stored. + +**User information**: The user related data that the S-CSCF requests from the HSS or HSS pushes to the S-CSCF, e.g. user profile, charging information, allowed WAF and/or WWSF identities and authentication information. + +**User profile:** Data that is sent in the resource associated to the complete user's subscription data. + +**IP Multimedia session:** IP Multimedia session and IP Multimedia call are treated as equivalent in this specification. + +**Transparent data:** Data that is understood syntactically but not semantically by the HSS. It is data that an AS may store in the HSS to support its service logic. One example is data that an AS stores in the HSS, using it as a repository. + +**Non-transparent data:** Data that is understood both syntactically and semantically by the HSS. + +**AS (Application Server):** a term used to denote either of a SIP Application Server or an OSA Service Capability Server. + +## 3.2 Symbols + +Void + +## 3.3 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]. + +| | | +|--------|------------------------------------------------| +| 5GC | 5G Core Network | +| AS | Application Server | +| AMF | Access and Mobility Management Function | +| CSCF | Call Session Control Function | +| CSG | Closed Subscriber Group | +| DCSF | Data Channel Signalling Function | +| FQDN | Fully Qualified Domain Name | +| GIBA | GPRS-IMS-Bundled-Authentication | +| GPSI | Generic Public Subscription Identifier | +| HSS | Home Subscriber Server | +| IMS | IP Multimedia Subsystem | +| I-CSCF | Interrogating CSCF | +| JSON | Javascript Object Notation | +| MPS | Multimedia Priority Service | +| NAI | Network Access Identifier | +| NRF | Network Repository Function | +| NSSAI | Network Slice Selection Assistance Information | +| NWDAF | Network Data Analytics Function | +| P-CSCF | Proxy CSCF | +| SBI | Service Based Interface | +| SIP | Session Initiation Protocol | +| SPT | Service Point Trigger | +| S-CSCF | Serving CSCF | +| UDR | Unified Data Repository | + +--- + +## 4 Overview + +### 4.1 Introduction + +Within the 5GC, the HSS offers services to the S-CSCF, I-CSCF, IMS-AS and DCSF (on the IP Multimedia Subsystem) and GBA BSF via the Nhss service based interface (see 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]). + +Figure 4.1-1 provides the reference model in service-based interface representation with focus on the HSS. + +![Figure 4.1-1: Reference model – HSS. The diagram shows an IMS (IP Multimedia Subsystem) box containing S-CSCF, I-CSCF, IMS-AS, and DCSF. Below the IMS box is a GBA BSF. All these components are connected to a central HSS (Home Subscriber Server) box via a common interface labeled 'Nhss'.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +Figure 4.1-1: Reference model – HSS. The diagram shows an IMS (IP Multimedia Subsystem) box containing S-CSCF, I-CSCF, IMS-AS, and DCSF. Below the IMS box is a GBA BSF. All these components are connected to a central HSS (Home Subscriber Server) box via a common interface labeled 'Nhss'. + +Figure 4.1-1: Reference model – HSS + +## 5 Services offered by the HSS + +### 5.1 Introduction + +The SBI capable HSS offers the following services via the Nhss\_ims interface: + +- Nhss\_imsUEContextManagement Service +- Nhss\_imsSubscriberDataManagement Service +- Nhss\_imsUEAuthentication Service +- Nhss\_gbaSubscriberDataManagement Service +- Nhss\_gbaUEAuthentication Service + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|----------------------------------|--------|-------------------------------------------------|----------------------------|---------------|-------| +| Nhss_imsUEContextManagement | 6.1 | Nhss UE Context Management Service for IMS | TS29562_Nhss_imsUECM.yaml | nhss-ims-uecm | A.2 | +| Nhss_imsSubscriberDataManagement | 6.2 | Nhss Subscriber Data Management Service for IMS | TS29562_Nhss_imsSDM.yaml | nhss-ims-sdm | A.3 | +| Nhss_imsUEAuthentication | 6.3 | Nhss UE Authentication Service for IMS | TS29562_Nhss_imsUEAU.yaml | nhss-ims-ueau | A.4 | +| Nhss_gbaSubscriberDataManagement | 6.4 | Nhss Subscriber Data Management Service for GBA | TS29562_Nhss_gbaSDM.yaml | nhss-gba-sdm | A.5 | +| Nhss_gbaUEAuthentication | 6.5 | Nhss UE Authentication Service for GBA | TS29562_Nhss_gbaUEAU.yaml | nhss-gba-ueau | A.6 | + +All scenarios shown in the following clauses assume that the SBI capable HSS is stateful and stores information in local memory. However, the SBI capable HSS may be stateless and store information externally in the UDR. If so, the stateless SBI capable HSS may use Ud interface as specified in 3GPP TS 29.335 [7] to retrieve required data from the UDR and store them locally before processing an incoming request. Processing the incoming request may then include updating data in the UDR. After processing the incoming request, the SBI capable HSS may delete the locally stored data. When data stored in UDR is then shared among the different SBI capable HSS instances of the same group, as identified by HSS Group ID (see 3GPP TS 23.501 [2], clause 6.2.6), bulk subscriptions, as described in clause 4.15.3.2.4 of 3GPP TS 23.502 [3], are not applicable, i.e. an NF consumer (e.g. IMS-AS) only subscribes towards one of the SBI capable HSS instances within the group. + +**Editor's Note:** It is FFS if an informative Annex needs to be included to show how an IMS-AS/I-CSCF/S-CSCF can interact with a group of stateless SBI capable HSS instances. + +## 5.2 Nhss\_imsUEContextManagement Service + +### 5.2.1 Service Description + +See 3GPP TS 23.228 [6], clause AA.2.1.2. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nhss\_imsUEContextManagement service the following service operations are defined: + +- Registration +- DeregistrationNotification +- Deregistration +- Authorize +- Update +- RestorationInfoGet +- RestorationInfoUpdate +- RestorationInfoDelete + +IMS restoration procedures are specified in 3GPP TS 23.380 [37]. + +The Nhss\_imsUEContextManagement Service is used by Consumer NFs (I-CSCF/S-CSCF) to: + +- register at the HSS by means of the Registration service operation (S-CSCF) +- get notified by means of the DeregistrationNotification service operation when HSS decides to deregister the registered consumer NF (S-CSCF) +- deregister from the HSS by means of the Deregistration service operation (S-CSCF) +- request registration authorization from HSS by means of the Authorize service operation (I-CSCF) +- update registration information stored at the HSS by means of the Update service operation (S-CSCF) +- retrieve Restoration Information stored at the HSS by means of the RestorationInfoGet service operation (S-CSCF) +- update Restoration Information stored at the HSS by means of the RestorationInfoUpdate service operation (S-CSCF) + +- delete Restoration Information stored at the HSS by means of the RestorationInfoDelete service operation (S-CSCF) + +## 5.2.2.2 Registration + +### 5.2.2.2.1 General + +The Registration service operation is invoked by a NF that has been selected to provide service to the UE to store related IMS UE Context Management information in HSS. + +NF Consumer is S-CSCF. + +As part of this procedure, the HSS updates the registration state of the requested IMS Public Identity and IMS Private Identity. The state of the IMS Public Identities in the same Implicit Registration Set is also updated. + +The following procedures using the Registration service operation are supported: + +- S-CSCF registration + +### 5.2.2.2.2 S-CSCF Registration + +Figure 5.2.2.2.2-1 shows a scenario where the S-CSCF sends a request to register at the HSS (see also 3GPP TS 23.228 [6] clause 5.2). The request contains the IMS UE's identity (/imsUeId) which shall be an IMPU, the S-CSCF Registration Information and the Registration Type. + +![Sequence diagram showing S-CSCF registration. The S-CSCF sends a PUT request to the HSS for the resource ^imsUeId/scscf-registration. The HSS responds with one of the following status codes: 2a. 204 No Content, 2b. 201 Created, 2c. 403 Forbidden, or 2d. 3xx Redirect.](5c6787bac31274e2dc992efeca74b303_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note right of HSS: 1. PUT « ^imsUeId/scscf-registration (ScscfRegistration) + S-CSCF->>HSS: Request + Note right of HSS: 2a. 204 No Content +2b. 201 Created +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>S-CSCF: Response + +``` + +Sequence diagram showing S-CSCF registration. The S-CSCF sends a PUT request to the HSS for the resource ^imsUeId/scscf-registration. The HSS responds with one of the following status codes: 2a. 204 No Content, 2b. 201 Created, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +Figure 5.2.2.2.2-1: S-CSCF registration + +1. The S-CSCF sends a PUT request to the resource representing the UE's S-CSCF registration to update or create S-CSCF registration information. The S-CSCF shall check whether there is a reg-id parameter in the Contact header in the SIP REGISTER message. If a reg-id parameter exists, the S-CSCF shall indicate to the HSS that the registration is related to a multiple registration as specified in clause 4.2.3 of 3GPP TS 23.380 [37]. If the S-CSCF received a S-CSCF reselection indicator from the I-CSCF, the S-CSCF shall include that indicator to the HSS. +- 2a. If the resource already exists, and if the S-CSCF registered is the same or if another S-CSCF is registered and S-CSCF reselection indication is received, the HSS updates the scscfRegistration resource by replacing it with the received resource information (e.g. S-CSCF name, state of the related IMS public identity based on the imsRegistrationType received) and responds with "204 No Content" or "200 OK" with the updated resource information and HSS supported features. + +Additionally, if the S-CSCF is reselected, the HSS shall invoke the Deregistration Notification service operation towards the old S-CSCF using the callback URI provided by the old S-CSCF with deregistration reason set to "NEW SERVER ASSIGNED". + +When receiving the "200 OK" response and if a multiple registration indicator has indicated to the HSS, the S-CSCF shall retrieve and update the restoration information as specified in clause 5.2.2.6 and clause 5.2.2.7. + +- 2b. If the resource does not exist (there is no previous S-CSCF information stored in HSS), HSS stores the received S-CSCF registration data and responds with HTTP Status Code "201 created". A response body is included with the created resource and the features supported by HSS. + +- 2c. If the operation is not authorized due to e.g. received IMS identities do not exist or do not match, or a different S-CSCF is registered and S-CSCF reselection is not authorized, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.2.2.3 DeregistrationNotification + +#### 5.2.2.3.1 General + +The following procedure using the DeregistrationNotification service operation is supported: + +- HSS initiated Deregistration + +#### 5.2.2.3.2 HSS initiated Deregistration + +Figure 5.2.2.3.2-1 shows a scenario where the HSS notifies the registered NF about the deregistration of one or more IMS Public Identities (see also 3GPP TS 23.228 [6] clause 5.3.2.2.1). The request contains the callback URI for deregistration notification as received by the HSS during registration, and Deregistration Data. + +![Sequence diagram showing HSS initiated NF Deregistration. The diagram shows two lifelines: NF Consumer and HSS. The HSS sends a POST request to the NF Consumer. The NF Consumer responds with either 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect.](35127fe87029df6f5f0b2ee85f6193f1_img.jpg) + +``` + +sequenceDiagram + participant NF Consumer + participant HSS + Note right of HSS: 1. POST {callbackReference} (DeregistrationData) + HSS->>NF Consumer: 1. POST {callbackReference} (DeregistrationData) + Note left of NF Consumer: 2a. 204 No Content +2b. 4xx/5xx Client or Server Error +2c. 3xx Redirect + NF Consumer-->>HSS: 2a. 204 No Content +2b. 4xx/5xx Client or Server Error +2c. 3xx Redirect + +``` + +Sequence diagram showing HSS initiated NF Deregistration. The diagram shows two lifelines: NF Consumer and HSS. The HSS sends a POST request to the NF Consumer. The NF Consumer responds with either 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect. + +**Figure 5.2.2.3.2-1: HSS initiated NF Deregistration** + +1. The HSS determines the need to deregister one or more public identities and sends a POST request to the callbackReference as provided by the NF service consumer (S-CSCF) during the registration. + +NOTE: The callbackReference identifies a public identity or an IRS or a Wildcarded PSI that shall be deregistered. + +HSS includes DeregistrationData with the Deregistration Reason that triggered the notification and additional information about the public identities that shall be deregistered such as: + +- Private Identity of the public identity to be deregistered, +- if several Private Identities with all associated Public Identities need to be deregistered, the Associated Private Identities. + +- 2a. On success, the NF service consumer responds with "204 No Content" or with "200 OK" including additional information about the deregistration result such as: + +- Associated Private Identities: it contains all Private Identities that have been deregistered together with the one in the Private User Identity received in the request, +- Identities with Emergency Registration: This information element indicates a list of pairs of private and public user identities which have not been de-registered due to emergency registration. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +## 5.2.2.4 Deregistration + +### 5.2.2.4.1 General + +The following procedures using the Deregistration service operation are supported: + +- S-CSCF deregistration + +### 5.2.2.4.2 S-CSCF deregistration + +Figure 5.2.2.4.2-1 shows a scenario where the S-CSCF sends a request to the HSS to deregister a user (see also 3GPP TS 23.228 [6] clause 5.3.1). The request contains the IMS UE's identity (`{imsUeId}`) which shall be an IMPI or an IMPU and the deregistration information. + +![Sequence diagram showing S-CSCF sending a PUT request to HSS for deregistration, with a response box containing 2a. 204 No Content, 2b. 403 Forbidden / 404 Not Found, and 2c. 3xx Redirect.](04dc3838022e96d8d5548bb1b777b38c_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note right of HSS: 2a. 204 No Content +2b. 403 Forbidden / 404 Not Found +2c. 3xx Redirect + S-CSCF->>HSS: 1. PUT « ^imsUeId}/scscf-registration (ScscfRegistration) + HSS-->>S-CSCF: + +``` + +Sequence diagram showing S-CSCF sending a PUT request to HSS for deregistration, with a response box containing 2a. 204 No Content, 2b. 403 Forbidden / 404 Not Found, and 2c. 3xx Redirect. + +**Figure 5.2.2.4.2-1: S-CSCF deregistering** + +1. The S-CSCF sends a PUT request to the resource representing the UE's CSCF registration. +- 2a. The HSS shall check whether the received S-CSCF name matches the stored S-CSCF. If the S-CSCF name is different, the HSS shall check whether the S-CSCF reassignment is allowed (i.e. S-CSCF reassignment pending flag is set). + +If an IMPI is received as ImsUeId, HSS shall deregister all IMPUs associated to that IMPI. + +If an IMPU is received as ImsUeId, HSS shall deregister the IMPU and related IMPUs in the Implicit Registration Set for the related IMPI. + +On success, HSS shall respond "204 No Content" or "200 OK". + +- 2b. Otherwise the HSS responds with "403 Forbidden" (e.g. S-CSCF is not the current S-CSCF assigned) or "404 Not Found" (e.g. IMPU or IMPI do not exist). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.2.2.5 Authorize + +### 5.2.2.5.1 General + +The Authorize service operation is invoked by a NF to request UE authorization to register or establish terminating/originating sessions in the IMS network. + +NF Consumer is I-CSCF for IMS service. + +As part of this procedure, the HSS authorizes or rejects the subscriber to use the IMS service based on the authorization information provided in the request and subscription data (e.g. roaming restrictions, barrings). + +The following procedures using the Authorize service operation are supported: + +- Authorization request + +#### 5.2.2.5.2 Authorization request + +Figure 5.2.2.5.2-1 shows a scenario where the I-CSCF sends a request to the HSS to authorize the UE to register in a given PLMN's P-CSCF or initiate a session for unregistered services (see also 3GPP TS 23.228 [6] clause 5.2.2.3 or 5.12.2). The request contains the IMS UE's identity (`{imsUId}`) which shall be an IMPU, and the `AuthorizationRequest`. + +![Sequence diagram showing the Authorization request procedure between I-CSCF and HSS. The I-CSCF sends a POST request to the HSS. The HSS responds with either 2a. 403 Forbidden, 2b. 200 OK (AuthorizationResponse), or 2c. 3xx Redirect.](6f31cdb576d2f15c35c3f266e5f59211_img.jpg) + +``` + +sequenceDiagram + participant I-CSCF + participant HSS + Note right of HSS: 2a. 403 Forbidden +2b. 200 OK (AuthorizationResponse) +2c. 3xx Redirect + I-CSCF->>HSS: 1. POST « ^imsUId}/authorize (AuthorizationRequest) + HSS-->>I-CSCF: 2a. 403 Forbidden +2b. 200 OK (AuthorizationResponse) +2c. 3xx Redirect + +``` + +Sequence diagram showing the Authorization request procedure between I-CSCF and HSS. The I-CSCF sends a POST request to the HSS. The HSS responds with either 2a. 403 Forbidden, 2b. 200 OK (AuthorizationResponse), or 2c. 3xx Redirect. + +**Figure 5.2.2.5.2-1: Authorization** + +1. The I-CSCF sends a POST request (custom method: authorize) to request for UE's authorization to register or establish an originating/terminating session. +- 2a. If the operation cannot be authorized due to e.g. UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). +- 2b. If successful, HSS responds with HTTP Status Code "200 OK" and may provide the S-CSCF identity which is serving the user, if any. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.2.2.6 RestorationInfoGet + +##### 5.2.2.6.1 General + +The RestorationInfoGet service operation is invoked by a NF to retrieve restoration information in HSS. + +NF Consumer is S-CSCF. + +The following procedures using the RestorationInfoGet service operation are supported: + +- Restoration Information Retrieval + +##### 5.2.2.6.2 Restoration Information Retrieval + +Figure 5.2.2.6.2-1 shows a scenario where the NF service consumer (S-CSCF) sends a request to the HSS to retrieve the information related to a specific registration for a registered user (e.g. during a registration procedure, during an originating request procedure or during a terminating request procedure). The request contains the IMS UE's identity (`{imsUId}`) which shall be an IMPU. + +![Sequence diagram for Restoration Information Retrieval. S-CSCF sends a GET request to HSS for restoration info. HSS responds with 200 OK, 404 Not Found, or 3xx Redirect.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note left of S-CSCF: 1. GET « ^imsUeId}/scscf-registration/scscf-restoration-info + S-CSCF->>HSS: Request + Note right of HSS: 2a. 200 OK (ScscfRestorationInfo) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>S-CSCF: Response + +``` + +Sequence diagram for Restoration Information Retrieval. S-CSCF sends a GET request to HSS for restoration info. HSS responds with 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.2.2.6.2-1: Restoration Information Retrieval** + +1. The NF service consumer (S-CSCF) sends a GET request to the resource representing the UE's S-CSCF restoration information. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's S-CSCF restoration information. The S-CSCF shall send a request to the HSS to retrieve the UE's IMS profile as specified in clause 5.3.2.2.4. +- 2b. If there is no valid restoration data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.2.2.7 RestorationInfoUpdate + +### 5.2.2.7.1 General + +The RestorationInfoUpdate service operation is invoked by a NF to update restoration information in HSS. + +NF Consumer is S-CSCF. + +The following procedures using the RestorationInfoUpdate service operation are supported: + +- Restoration Information Update + +### 5.2.2.7.2 Restoration Information Update + +S-CSCF backup and update of S-CSCF restoration information in HSS is specified in clause 4.6 of 3GPP TS 23.380 [37]. + +Figure 5.2.2.7.2-1 shows a scenario where the S-CSCF sends a request to update restoration information at the HSS (see also 3GPP TS 23.228 [6] clause 4.24). The request contains the IMS UE's identity (/ {imsUeId}) which shall be an IMPU. + +![Sequence diagram for Restoration Information Update. S-CSCF sends a PUT request to HSS to update restoration info. HSS responds with 200 OK / 204 No Content, 201 Created, 403 Forbidden, or 3xx Redirect.](ea49c15f36ffb089d44f1d793f013778_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note left of S-CSCF: 1. PUT « ^imsUeId}/scscf-registration/scscf-restoration-info + S-CSCF->>HSS: Request + Note right of HSS: 2a. 200 OK / 204 No Content +2b. 201 Created +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>S-CSCF: Response + +``` + +Sequence diagram for Restoration Information Update. S-CSCF sends a PUT request to HSS to update restoration info. HSS responds with 200 OK / 204 No Content, 201 Created, 403 Forbidden, or 3xx Redirect. + +**Figure 5.2.2.7.2-1: Restoration Information Update** + +1. The S-CSCF sends a PUT request to the resource representing the UE's S-CSCF restoration information to update or create S-CSCF restoration information. +- 2a. If there are S-CSCF restoration information related to the IMS Public Identity stored in the HSS, the HSS updates the Scscf Restoration Information resource by replacing it with the received restoration information and responds with "200 OK" or "204 No Content". +- 2b. If the resource does not exist (there is no previous S-CSCF restoration information stored in HSS for that user), HSS stores the received S-CSCF restoration data and responds with HTTP Status Code "201 created". +- 2c. If the request can't be accepted (e.g. the S-CSCF is not allowed to create/update the restoration information), HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.2.2.8 RestorationInfoDelete + +### 5.2.2.8.1 General + +The RestorationInfoDelete service operation is invoked by a NF to delete restoration information in HSS. + +NF Consumer is S-CSCF. + +The S-CSCF consumes the RestorationInfoDelete service operation as a consequence of subscriber deregistration (TIMEOUT\_DEREGISTRATION, USER\_DEREGISTRATION, ADMINISTRATIVE\_DEREGISTRATION). In restoration scenarios, the new S-CSCF after successful retrieval of restoration data, consumes the RestorationInfoDelete service operation to delete the restoration data stored by the old S-CSCF. + +The following procedures using the RestorationInfoDelete service operation are supported: + +- Restoration Information Delete + +### 5.2.2.8.2 Restoration Information Delete + +Figure 5.2.2.Z.2-1 shows a scenario where the S-CSCF sends a request to delete restoration information at the HSS. The request contains the IMS UE's identity (/imsUeId) which shall be an IMPU. + +![Sequence diagram showing the Restoration Information Delete procedure between S-CSCF and HSS. The S-CSCF sends a DELETE request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 403 Forbidden, 2c. 404 Not Found, or 2d. 3xx Redirect.](88a6d9692a52989caa6b208a1ba70dc0_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note right of HSS: 2a. 204 No Content +2b. 403 Forbidden +2c. 404 Not Found +2d. 3xx Redirect + S-CSCF->>HSS: 1. DELETE « ^imsUeId}/scscf-registration/scscf-restoration-info + HSS-->>S-CSCF: Response (2a-2d) + +``` + +Sequence diagram showing the Restoration Information Delete procedure between S-CSCF and HSS. The S-CSCF sends a DELETE request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 403 Forbidden, 2c. 404 Not Found, or 2d. 3xx Redirect. + +**Figure 5.2.2.8.2-1: Restoration Information Delete** + +1. The S-CSCF sends a DELETE request to the resource representing the UE's S-CSCF restoration information to delete S-CSCF restoration information. +- 2a. If there are S-CSCF restoration information related to the IMS Public Identity stored in the HSS, the HSS deletes the Scscf Restoration Information resource by replacing it with the received restoration information and responds with "204 No Content". + +- 2b. If the request can't be accepted (e.g. the S-CSCF is not allowed to delete the restoration information), HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If there is no valid S-CSCF restoration information, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.3 Nhss\_imsSubscriberDataManagement Service + +### 5.3.1 Service Description + +See 3GPP TS 23.228 [6], clause AA.2.1.3. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +For the Nhss\_imsSubscriberDataManagement service the following service operations are defined: + +- Get +- Subscribe to notification of data changes and UE reachability for IP +- Unsubscribe to notification of data changes and UE reachability for IP +- Notification of data changes and UE reachability for IP +- Update + +The Nhss\_imsSubscriberDataManagement Service is used by Consumer NFs (S-CSCF, IMS-AS and DCSF) to retrieve the UE's individual subscription data relevant to the consumer NF, or by I-CSCF to retrieve S-CSCF capabilities or the assigned S-CSCF, from the SBI capable HSS by means of the Get service operation. If the consumer NF supports the feature "sharedData", the retrieved individual subscription data for the UE may contain shared data identifier identifying additional parts of subscription data shared by several UEs. If so, the Nhss\_imsSubscriberDataManagement Service is also used by Consumer NFs to: + +- retrieve shared subscription data from the HSS by means of the Get service operation. + +The Nhss\_imsSubscriberDataManagement Service is also used by Consumer NFs to: + +- subscribe to notifications of data change by means of the Subscribe service operation. If the consumer NF supports the feature "sharedData", the consumer NF may also subscribe to notifications of shared data change by means of the Subscribe service operation. +- to unsubscribe from notifications of data changes by means of the Unsubscribe service operation. If the feature "sharedData" is supported, it may also be used to unsubscribe from notifications of shared data changes by means of the Unsubscribe service operation. +- get notified by means of the Notification service operation when HSS decides to modify the subscribed data. If the feature "sharedData" is supported by the consumer NF and the consumer NF has previously subscribed to notifications of shared data change, it is also used by the consumer NF to get notified by means of the Notification service operation when the HSS decides to modify the subscribed shared data. + +It is also used by Consumer NFs to: + +- provide the information about the status of the subscription data management procedures. + +- update information (e.g. transparent data) associated to the subscription data management. + +## 5.3.2.2 Get + +### 5.3.2.2.1 General + +The following procedures using the Get service operation are supported: + +- Repository Data Retrieval +- IMS Identity Data (e.g. IMS associated identities including Implicit Registration Set and Alias Group) Retrieval +- IMS Profile Data (e.g. IFCs) Retrieval +- IMS Location Data Retrieval +- IMS Registration Status Data Retrieval +- Access Data (e.g. T-ADS) Retrieval +- SRVCC Data (e.g. STN-SR) Retrieval +- Service Data (e.g. DSAI) Retrieval +- Retrieval Of Multiple Data Sets +- Shared Subscription Data Retrieval +- Trace Data Retrieval +- PSI Activation State Retrieval +- DSAI information Retrieval +- S-CSCF Selection Assistance Information Retrieval + +When the feature SharedData is supported and the retrieved UE-individual data (i.e. data other than Shared Subscription Data) contain SharedDataIds, the NF service consumer shall also retrieve the shared data identified by the received shared data Ids unless the identified shared data are already available at the NF service consumer. The order of sequence of sharedDataIds within UE-individual data is significant: Individual data take precedence over shared data; shared data "SharedDataX" identified by a sharedDataId X takes precedence over shared data "SharedDataY" identified by a sharedDataId Y if X appears before Y within the list of SharedDataIds in the UE-individual data. + +### 5.3.2.2.2 Identity Data + +#### 5.3.2.2.2.1 IMS Identity Data Retrieval + +Figure 5.3.2.2.2.1-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE's IMS Identity Data for the IMS associated Identities (IRS and Alias group information). The request contains the UE's identity (/{imsUeId}), the type of the requested information (/identities/ims-associated-identities) and query parameters (e.g. supported-features). + +![Sequence diagram for IMS Identity Data Retrieval. The diagram shows a request from IMS-AS to HSS and a response from HSS to IMS-AS. The request is a GET request to the resource ^imsUeld}/identities/ims-associated-identities. The response can be 200 OK, 404 Not Found, or 3xx Redirect.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` + +sequenceDiagram + participant IMS-AS + participant HSS + Note right of HSS: 1. GET « ^imsUeld}/identities/ims-associated-identities + HSS-->>IMS-AS: 2a. 200 OK (ImplicitRegistrationSet, AliasGroupInformation) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + +``` + +Sequence diagram for IMS Identity Data Retrieval. The diagram shows a request from IMS-AS to HSS and a response from HSS to IMS-AS. The request is a GET request to the resource ^imsUeld}/identities/ims-associated-identities. The response can be 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.2.1-1: IMS Identity Data Retrieval** + +1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE's Identity Data for the IMS associated identities with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Implicit Registration Set (if any) and the Alias Group information (if any) which the UE's identity belongs to as relevant for the requesting NF service consumer. Additional information (e.g. distinct or wildcarded type of identity, registration state of the IRS) is also included in the response. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.2.2 MSISDN(s) Retrieval + +Figure 5.3.2.2.2.2-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE's MSISDN(s). The request contains the UE's identity (/imsUeld}), the type of the requested information (/identities/msisdns) and query parameters (e.g. supported-features). + +![Sequence diagram for MSISDN(s) Retrieval. The diagram shows a request from IMS-AS to HSS and a response from HSS to IMS-AS. The request is a GET request to the resource ^imsUeld}/identities/msisdns. The response can be 200 OK, 404 Not Found, or 3xx Redirect.](7a02de7ed198501f7a4f6ca37c3f28c5_img.jpg) + +``` + +sequenceDiagram + participant IMS-AS + participant HSS + Note right of HSS: 1. GET « ^imsUeld}/identities/msisdns + HSS-->>IMS-AS: 2a. 200 OK (MsisdnList) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + +``` + +Sequence diagram for MSISDN(s) Retrieval. The diagram shows a request from IMS-AS to HSS and a response from HSS to IMS-AS. The request is a GET request to the resource ^imsUeld}/identities/msisdns. The response can be 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.2.2-1: MSISDN(s) Retrieval** + +1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE's MSISDN(s) with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's MSISDN(s) as relevant for the requesting NF service consumer. The type of MSISDN (basic/C-MSISDN or additional MSISDN) is included in the response. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.2.3 Private Identities Retrieval + +Figure 5.3.2.2.2.3-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE's Private Identities (IMS Private User Identity, IMSI). The request contains the UE's identity (/{imsUId}), the type of the requested information (/identities/private-identities) and query parameters (e.g. supported-features). + +![Sequence diagram for Private Identities Retrieval. The IMS-AS sends a GET request to the HSS. The HSS responds with 200 OK (PrivateIdentities), 404 Not Found, or 3xx Redirect.](f0a97d0d3818a253c1d2a009966081b1_img.jpg) + +``` + +sequenceDiagram + participant IMS-AS + participant HSS + Note left of IMS-AS: 1. GET « ^imsUId}/identities/private-identities + IMS-AS->>HSS: Request + Note right of HSS: 2a. 200 OK (PrivateIdentities) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>IMS-AS: Response + +``` + +Sequence diagram for Private Identities Retrieval. The IMS-AS sends a GET request to the HSS. The HSS responds with 200 OK (PrivateIdentities), 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.2.3-1: Private Identities Retrieval** + +1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE's Private Identities with query optional parameters indicating the supported-features and/or impi. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Private Identities as relevant for the requesting NF service consumer. The type of Private Identity (e.g. IMPI, IMSI) is included in the response. If an impi was provided as query parameter in the GET request, only the Private Identity of type IMSI that is associated with the provided impi shall be returned. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.2.4 IMEI(SV) Retrieval + +Figure 5.3.2.2.2.4-1 shows a scenario where the NF service consumer (e.g. IMS AS) sends a request to the HSS to receive the IMEI(SV) for the UE. The request contains the UE's identity (/{imsUId}), the type of the requested information (/identities/imeisv) and query parameters (e.g. supported-features). + +![Sequence diagram for IMEI(SV) Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK (ImeiSvInformation), 404 Not Found, or 3xx Redirect.](745261f385368efa3f2259c8681874e9_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUId}/identities/imeisv + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (ImeiSvInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for IMEI(SV) Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK (ImeiSvInformation), 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.2.4-1: IMEI(SV) Retrieval** + +1. The NF service consumer (e.g. IMS AS) sends a GET request to the resource representing the UE's IMEI(SV) information with query parameters indicating the supported-features. + +- 2a. On success, the HSS responds with "200 OK" with the message body containing the last known IMEI(SV) associated to the UE. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.2.3 IMS Location Data and Status + +#### 5.3.2.2.3.1 S-CSCF Capabilities Retrieval + +Figure 5.3.2.2.3.1-1 shows a scenario where the NF service consumer (I-CSCF), after authorization information has been performed without obtaining an S-CSCF name, sends a request to the HSS to receive the UE's S-CSCF capabilities (mandatory and/or optional). The request contains the UE's identity (/{imsUeId}), the type of the requested information (/ims-data/location-data/scscf-capabilities) and query parameters (e.g. supported-features). + +![Sequence diagram for S-CSCF Capabilities Retrieval. The diagram shows two participants: I-CSCF and HSS. A dashed vertical line extends from each participant. 1. A solid horizontal arrow points from the I-CSCF line to the HSS line, labeled '1. GET « ^imsUeId}/ims-data/location-data/scscf-capabilities'. 2. A return arrow points from the HSS line back to the I-CSCF line. This return path is represented by a dashed line leading to a light gray rectangular box. Inside the box, the text '2a. 200 OK (ScscfCapabilityList)', '2b. 404 Not Found', and '2c. 3xx Redirect' are listed vertically. From the bottom of this box, a solid horizontal arrow points back to the I-CSCF line.](7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg) + +``` +sequenceDiagram + participant I-CSCF + participant HSS + Note right of HSS: 2a. 200 OK (ScscfCapabilityList) +2b. 404 Not Found +2c. 3xx Redirect + I-CSCF->>HSS: 1. GET « ^imsUeId}/ims-data/location-data/scscf-capabilities + HSS-->>I-CSCF: 2a. 200 OK (ScscfCapabilityList) +2b. 404 Not Found +2c. 3xx Redirect +``` + +Sequence diagram for S-CSCF Capabilities Retrieval. The diagram shows two participants: I-CSCF and HSS. A dashed vertical line extends from each participant. 1. A solid horizontal arrow points from the I-CSCF line to the HSS line, labeled '1. GET « ^imsUeId}/ims-data/location-data/scscf-capabilities'. 2. A return arrow points from the HSS line back to the I-CSCF line. This return path is represented by a dashed line leading to a light gray rectangular box. Inside the box, the text '2a. 200 OK (ScscfCapabilityList)', '2b. 404 Not Found', and '2c. 3xx Redirect' are listed vertically. From the bottom of this box, a solid horizontal arrow points back to the I-CSCF line. + +**Figure 5.3.2.2.3.1-1: S-CSCF Capabilities Retrieval** + +1. The NF service consumer (I-CSCF) sends a GET request to the resource representing the UE's S-CSCF capabilities with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's S-CSCF capabilities relevant for the requesting NF service consumer. The type of S-CSCF capabilities (mandatory and/or optional) is included in the response. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.3.2 Server Name Retrieval + +Figure 5.3.2.2.3.2-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the Server Name (S-CSCF name) associated to the UE. The request contains the UE's identity (/{imsUeId}), the type of the requested information (ims-data/location-data/server-name) and query parameters (e.g. supported-features). + +![Sequence diagram for Server Name Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (ImLocationData), 2b. 404 Not Found, or 2c. 3xx Redirect.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/location-data/server-name + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (ImLocationData) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for Server Name Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (ImLocationData), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.3.2-1: Server Name Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's IMS location information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the IMS location information (S-CSCF name) as relevant for the service consumer. +- 2b. If there is no valid data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.2.3.3 IMS Registration Status Retrieval + +Figure 5.3.2.2.3.3-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to IMS registration status of a user. The request contains the UE's identity (/{imsUeId}), the type of the requested information (ims-data/registration-status) and query parameters (e.g. supported-features). + +![Sequence diagram for IMS Registration Status Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (ImRegistrationStatus), 2b. 404 Not Found, or 2c. 3xx Redirect.](f64e1e0997695248c0cd4122c5b1a170_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/registration-status + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (ImRegistrationStatus) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for IMS Registration Status Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (ImRegistrationStatus), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.3.3-1: IMS Registration Status Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's IMS registration status with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the IMS registration status (e.g. unregistered) as relevant for the service consumer. +- 2b. If there is no valid data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.3.4 S-CSCF Selection Assistance Information Retrieval + +Figure 5.3.2.2.3.4-1 shows a scenario where the NF service consumer (I-CSCF), sends a request to the HSS to receive the UE's S-CSCF Selection Assistance Information. The request contains the UE's identity (`{imsUId}`), the type of the requested information (`/ims-data/location-data/scscf-selection-assistance-info`) and query parameters (e.g. supported-features). + +![Sequence diagram for S-CSCF Selection Assistance Information Retrieval. The diagram shows two lifelines: I-CSCF and HSS. The I-CSCF sends a GET request to the HSS for the resource ^imsUId}/ims-data/location-data/scscf-selection-assistance-info. The HSS responds with one of three possible status codes: 2a. 200 OK (containing SscfSelectionAssistanceInformation), 2b. 404 Not Found, or 2c. 3xx Redirect.](933ecd14c858bf3fc919222d8e357bc8_img.jpg) + +``` + +sequenceDiagram + participant I-CSCF + participant HSS + Note right of I-CSCF: 1. GET « ^imsUId}/ims-data/location-data/scscf-selection-assistance-info + I-CSCF->>HSS: Request + Note right of HSS: 2a. 200 OK (SscfSelectionAssistanceInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>I-CSCF: Response + +``` + +Sequence diagram for S-CSCF Selection Assistance Information Retrieval. The diagram shows two lifelines: I-CSCF and HSS. The I-CSCF sends a GET request to the HSS for the resource ^imsUId}/ims-data/location-data/scscf-selection-assistance-info. The HSS responds with one of three possible status codes: 2a. 200 OK (containing SscfSelectionAssistanceInformation), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**5.3.2.2.3.4-1: S-CSCF Selection assistance Information Retrieval** + +1. The NF service consumer (I-CSCF) sends a GET request to the resource representing the UE's S-CSCF Selection Assistance Information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's S-CSCF Selection Assistance Information. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.4 IMS Profile Data + +##### 5.3.2.2.4.1 IMS User Profile Retrieval + +Figure 5.3.2.2.4.1-1 shows a scenario where the NF service consumer (S-CSCF) sends a request to the HSS to receive the UE's IMS profile data. The request contains the UE's identity (`{imsUId}`), the type of the requested information (`/ims-data/profile-data`) and query parameters (e.g. supported-features). + +![Sequence diagram for IMS User Profile Retrieval. The diagram shows two lifelines: NF Service Consumer and HSS. The NF Service Consumer sends a GET request to the HSS for the resource ^imsUId}/ims-data/profile-data. The HSS responds with one of three possible status codes: 2a. 200 OK (containing ImsProfileData), 2b. 404 Not Found, or 2c. 3xx Redirect.](0977b81510f7649846289ee785d20e74_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1. GET « ^imsUId}/ims-data/profile-data + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (ImsProfileData) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for IMS User Profile Retrieval. The diagram shows two lifelines: NF Service Consumer and HSS. The NF Service Consumer sends a GET request to the HSS for the resource ^imsUId}/ims-data/profile-data. The HSS responds with one of three possible status codes: 2a. 200 OK (containing ImsProfileData), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.4.1-1: IMS User Profile Retrieval** + +1. The NF service consumer (S-CSCF) sends a GET request to the resource representing the UE's IMS profile with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Profile Data as relevant for the requesting NF service consumer. The Initial Filter Criteria (IFC) is included in the response. + +Additional information (e.g. service priority information, chargingInfo, serviceLevelTraceInfo, maxAllowedSimulReg), if any, may also be included. + +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.4.2 Service Priority Level Information Retrieval + +Figure 5.3.2.2.4.2-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the Service Priority levels allowed for the UE. The request contains the UE's identity (/imsUeId), the type of the requested information (ims-data/profile-data/priority-levels) and query parameters (e.g. supported-features). + +![Sequence diagram for Service Priority Level Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (PriorityLevels), 2b. 404 Not Found, or 2c. 3xx Redirect.](dfaa8b98082261913dac00eae86b2889_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/profile-data/priority-levels + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (PriorityLevels) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for Service Priority Level Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (PriorityLevels), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.4.2-1: Service Priority Level Information Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's Service Priority Level with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the Namespaces and priority levels allowed for the user. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.4.3 Initial Filter Criteria Retrieval + +Figure 5.3.2.2.4.3-1 shows a scenario where the NF service consumer (e.g. AS, S-CSCF) sends a request to the HSS to receive the UE's Initial Filter Criteria. The request contains the UE's identity (/imsUeId), the type of the requested information (ims-data/profile-data/ifcs) and query parameters (e.g. supported-features). + +![Sequence diagram for Initial Filter Criteria Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (Ifcs), 2b. 404 Not Found, or 2c. 3xx Redirect.](05eb72d372e4bf78e3d6a64949d77bcc_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/profile-data/ifcs » + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (Ifcs) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for Initial Filter Criteria Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (Ifcs), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.4.3-1: Initial Filter Criteria Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's IMS profile with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Initial Filter Criteria (possibly containing S-CSCF-Specific IFC Set Identifiers, if supported and configured in S-CSCF) as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.4.4 Service Trace Level Information Retrieval + +Figure 5.3.2.2.4.4-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the UE's IMS service level trace information associated to the UE. The request contains the UE's identity (/{imsUeId}), the type of the requested information (ims-data/profile-data/ service-level-trace-info) and query parameters (e.g. supported-features). + +![Sequence diagram for Service Trace Level Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (ServiceLevelTraceInformation), 2b. 404 Not Found, or 2c. 3xx Redirect.](f732d3320afe06d979aabbd366184254_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/profile-data/service-level-trace-info » + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (ServiceLevelTraceInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for Service Trace Level Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (ServiceLevelTraceInformation), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.4.4-1: Service Trace Level Information Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's IMS service level trace information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the IMS service level trace information (see 3GPP TS 24.323 [24]) so that the service consumer performs logging at IMS service level as described in IETF RFC 8497 [23]. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.4.5 Charging Information Retrieval + +Figure 5.3.2.2.4.5-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the UE's charging information. The request contains the UE's identity (`/{imsUeId}`), the type of the requested information (`ims-data/profile-data/charging-info`) and query parameters (e.g. `supported-features`). + +![Sequence diagram for Charging Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK (ChargingInfo), 404 Not Found, or 3xx Redirect.](a5b9392ecb96e6b5e0b4ee0664210f72_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/profile-data/charging-info + NF Service Consumer->>HSS: Request + Note left of HSS: 2a. 200 OK (ChargingInfo) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for Charging Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK (ChargingInfo), 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.4.5-1: Charging Information Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's charging information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the ChargingInfo. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5 Access Data + +##### 5.3.2.2.5.1 Location Information Retrieval for CS/PS Domains + +Figure 5.3.2.2.5.1-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the Location Information associated to the UE. The request contains the UE's identity (`/{imsUeId}`), the type of the requested information, the domain (`cs-domain` or `ps-domain`) requested (e.g. `ims-data/access-data/ps-domain/location-data`) and query parameters (e.g. `supported-features`, `requested-nodes`). + +![Sequence diagram for Location Information Retrieval for CS/PS Domains. The NF Service Consumer sends two possible GET requests to the HSS. The HSS responds with 200 OK (PsLocation), 200 OK (CsLocation), 404 Not Found, or 3xx Redirect.](10d81b2cc455e3563e3e562a7f451124_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1a. GET « ^imsUeId}/access-data/ps-domain/location-data +1b. GET « ^imsUeId}/access-data/cs-domain/location-data + NF Service Consumer->>HSS: Request + Note left of HSS: 2a. 200 OK (PsLocation) +2b. 200 OK (CsLocation) +2c. 404 Not Found +2d. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for Location Information Retrieval for CS/PS Domains. The NF Service Consumer sends two possible GET requests to the HSS. The HSS responds with 200 OK (PsLocation), 200 OK (CsLocation), 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.5.1-1: Location Information Retrieval for CS/PS Domains** + +- 1a. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's location information at PS domain with query parameters indicating the supported-features and optionally the requested nodes (e.g. MME, AMF) +- 1b. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's location information at CS domain with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the location information for the requested domain (PS) and the requested nodes or all nodes (if no requested nodes were present in the request) +- 2b. On success, the HSS responds with "200 OK" with the message body containing the location information for the requested domain (CS). +- 2c. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.2 IP Address Information Retrieval + +Figure 5.3.2.2.5.2-1 shows a scenario where the NF service consumer (e.g. SCC-AS) sends a request to the HSS to receive the IP Address of the UE. The request contains the UE's identity (`{imsUeId}`), the type of the requested information (`/access-data/ps-domain/ip-address`) and query parameters (e.g. supported-features). + +![Sequence diagram for IP Address Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (IpAddress), 2b. 404 Not Found, or 2c. 3xx Redirect.](409498e57b1f988b2b604d12cd997002_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/access-data/ps-domain/ip-address + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (IpAddress) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for IP Address Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (IpAddress), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.5.2-1: IP Address Information Retrieval** + +1. The NF service consumer (e.g. SCC-AS) sends a GET request to the resource representing the UE's IP address information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing either an IPv4 address, IPv6 address or IPv6 prefix and/or IPv6 interface identifier. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.3 T-ADS Information Retrieval + +Figure 5.3.2.2.5.3-1 shows a scenario where the NF service consumer (e.g. SCC-AS) sends a request to the HSS to receive the T-ADS information for the UE. The request contains the UE's identity (`{imsUeId}`), the type of the requested information (`/access-data/ps-domain/tads-info`) and query parameters (e.g. supported-features). + +![Sequence diagram for T-ADS Information Retrieval. An NF Service Consumer sends a GET request to an HSS. The HSS responds with one of three options: 2a. 200 OK (TadsInformation), 2b. 404 Not Found, or 2c. 3xx Redirect.](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUId}/access-data/ps-domain/tads-info + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (TadsInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for T-ADS Information Retrieval. An NF Service Consumer sends a GET request to an HSS. The HSS responds with one of three options: 2a. 200 OK (TadsInformation), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.5.3-1: T-ADS Information Retrieval** + +1. The NF service consumer (e.g. SCC-AS) sends a GET request to the resource representing the UE's T-ADS information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the most recent IMS Voice over PS Sessions support indication as indicated by the serving nodes for the user. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.4 User State Retrieval for CS/PS Domains + +Figure 5.3.2.2.5.4-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the User State associated to the UE. The request contains the UE's identity (`{imsUId}`), the type of the requested information, the domain (cs-domain or ps-domain) requested (e.g. `ims-data/access-data/ps-domain/user-state`) and query parameters (e.g. supported-features, requested-nodes). + +![Sequence diagram for User State Retrieval for CS/PS Domains. An NF Service Consumer sends two possible GET requests to an HSS. The HSS responds with one of four options: 2a. 200 OK (PsUserState), 2b. 200 OK (CsUserState), 2c. 404 Not Found, or 2d. 3xx Redirect.](02d0c8a07c481d880b73a25d02050fad_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1a. GET « ^imsUId}/access-data/ps-domain/user-state +1b. GET « ^imsUId}/access-data/cs-domain/user-state + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (PsUserState) +2b. 200 OK (CsUserState) +2c. 404 Not Found +2d. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for User State Retrieval for CS/PS Domains. An NF Service Consumer sends two possible GET requests to an HSS. The HSS responds with one of four options: 2a. 200 OK (PsUserState), 2b. 200 OK (CsUserState), 2c. 404 Not Found, or 2d. 3xx Redirect. + +**Figure 5.3.2.2.5.4-1: User State Retrieval for CS/PS Domains** + +- 1a. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's user state information at PS domain with query parameters indicating the supported-features and optionally the requested nodes (e.g. MME, AMF) +- 1b. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's User State information at CS domain with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the User State information for the requested domain (PS) and the requested nodes or all nodes (if no requested nodes were present in the request) +- 2b. On success, the HSS responds with "200 OK" with the message body containing the User State information for the requested domain (CS). + +- 2c. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.5 CSRN Retrieval + +Figure 5.3.2.2.5.5-1 shows a scenario where the NF service consumer (e.g. SCC-AS) sends a request to the HSS to receive a CS Domain Routing Number (CSRN, see 3GPP TS 23.003 [13]) for the UE. The request contains the UE's identity (/{imsUeId}), the type of the requested information (/access-data/cs-domain/csrn) and query parameters (e.g. supported-features, pre-paging). + +![Sequence diagram for CSRN Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (Csrn), 2b. 404 Not Found, or 2c. 3xx Redirect.](d8698aacaeead6dfed9a1e448670a2e4_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/access-data/cs-domain/csrn + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (Csrn) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + HSS-->>NF Service Consumer: Response +``` + +Sequence diagram for CSRN Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (Csrn), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.5.5-1: T-ADS Information Retrieval** + +1. The NF service consumer (e.g. SCC-AS) sends a GET request to the resource representing the UE's CSRN information with query parameters indicating the supported-features and/or pre-paging indication. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the CSRN as provided by the MSC/VLR. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.6 Reference Location Information Retrieval + +Figure 5.3.2.2.5.6-1 shows a scenario where the NF service consumer (e.g. IMS-AS) sends a request to the HSS to receive the reference location information for the UE. The request contains the UE's identity (/{imsUeId}), the type of the requested information (/access-data/wireline-domain/reference-location) and query parameters (e.g. supported-features). + +![Sequence diagram for Reference Location Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK, 404 Not Found, or 3xx Redirect.](9f6dec4d4e9fde40bce018861ef1278e_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1. GET « ^imsUeId}/access-data/wireline-domain/reference-location + NF Service Consumer->>HSS: 1. GET + Note right of HSS: 2a. 200 OK (ReferenceLocationInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: 2a/2b/2c + +``` + +Sequence diagram for Reference Location Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.5.6-1: Reference Location Information Retrieval** + +1. The NF service consumer (e.g. IMS-AS) sends a GET request to the resource representing the UE's reference location information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the access type and/or the access info and associated value (line identifier in fixed access networks). +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.3.2.2.6 SRVCC Data + +### 5.3.2.2.6.1 SRVCC Data Retrieval + +Figure 5.3.2.2.6.1-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to retrieve the SRVCC data for the UE. The request contains the UE's identity (/imsUeId), the type of the requested information (/srvcc-data) and query parameters (e.g. supported-features). + +![Sequence diagram for SRVCC Data Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK, 404 Not Found, or 3xx Redirect.](f10dc32e3673e1392029a49e958a9d6c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1. GET « ^imsUeId}/srvcc-data + NF Service Consumer->>HSS: 1. GET + Note right of HSS: 2a. 200 OK (SrvccData) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: 2a/2b/2c + +``` + +Sequence diagram for SRVCC Data Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.6.2-1: SRVCC Data Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's SRVCC data information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the STN-SR and the UE SRVCC capability for the user. +- 2b. If there is no valid SRVCC data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.2.7 Service Data + +#### 5.3.2.2.7.1 PSI Activation State Retrieval + +Figure 5.3.2.2.7.1-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to retrieve the PSI activation state. The request contains the Public Service Identity (/{imsUeId}), the type of the requested information (/service-data/psi-status) and query parameters (e.g. supported-features). + +![Sequence diagram for PSI Activation State Retrieval](26e334e61dd059cff029338a2a604d8d_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 1. GET « ^imsUeId}/service-data/psi-status + HSS->>NF Service Consumer: 2a. 200 OK (PsiActivationState) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect +``` + +The diagram illustrates the interaction for PSI Activation State Retrieval. It starts with the NF Service Consumer sending a GET request to the HSS for the resource ^imsUeId}/service-data/psi-status. The HSS responds with one of three possible outcomes: 2a. 200 OK (PsiActivationState), 2b. 404 Not Found, or 2c. 3xx Redirect. + +Sequence diagram for PSI Activation State Retrieval + +**Figure 5.3.2.2.7.1-1: PSI Activation State Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the PSI activation state with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the PSI activation state (active or inactive). +- 2b. If there is no valid activation state for the PSI, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.7.2 SMS Registration Information retrieval + +Figure 5.3.2.2.7.2-1 shows a scenario where the NF service consumer (e.g. IP-SM-GW) sends a request to the HSS to retrieve the SMS registration information associated to a UE. The request contains the UE identity (/{imsUeId}), the type of the requested information (/service-data/sms-registration-info) and query parameters (e.g. supported-features). + +![Sequence diagram for SMS Registration Information Retrieval](8a8517bfa4f6191c52c47697716255a9_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 1. GET « ^imsUeId}/service-data/sms-registration-info + HSS->>NF Service Consumer: 2a. 200 OK (SmsRegistrationInfo) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect +``` + +The diagram illustrates the interaction for SMS Registration Information Retrieval. It starts with the NF Service Consumer sending a GET request to the HSS for the resource ^imsUeId}/service-data/sms-registration-info. The HSS responds with one of three possible outcomes: 2a. 200 OK (SmsRegistrationInfo), 2b. 404 Not Found, or 2c. 3xx Redirect. + +Sequence diagram for SMS Registration Information Retrieval + +**Figure 5.3.2.2.7.2-1: SMS Registration Information Retrieval** + +1. The NF service consumer (e.g. IP-SM-GW) sends a GET request to the resource representing the SMS registration information with query parameters indicating the supported-features. + +- 2a. On success, the HSS responds with "200 OK" with the message body containing the IP-SM-GW number and optionally the SC address. +- 2b. If there is no valid SMS registration information, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.7.3 DSAI Information retrieval + +Figure 5.3.2.2.7.3-1 shows a scenario where the NF service consumer (e.g. IMS-AS) sends a request to the HSS to retrieve the DSAI information associated to an Application Server. The request contains the UE identity (/{imsUeId}), the type of the requested information (/service-data/dsai) and query parameters (e.g. Application Server Name). + +![Sequence diagram for DSAI Information Retrieval. The diagram shows two participants: NF Service Consumer and HSS. The NF Service Consumer sends a GET request to the HSS with the path ^imsUeId/service-data/dsai. The HSS responds with one of three possible status codes: 2a. 200 OK (DsaiTagInformation), 2b. 404 Not Found, or 2c. 3xx Redirect.](4669a2ca9d019b9c2de9a9d9a0c4e644_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId/service-data/dsai » + NF Service Consumer->>HSS: 1. GET « ^imsUeId/service-data/dsai » + Note right of HSS: 2a. 200 OK (DsaiTagInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: 2a. 200 OK (DsaiTagInformation) +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram for DSAI Information Retrieval. The diagram shows two participants: NF Service Consumer and HSS. The NF Service Consumer sends a GET request to the HSS with the path ^imsUeId/service-data/dsai. The HSS responds with one of three possible status codes: 2a. 200 OK (DsaiTagInformation), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.7.3-1: DSAI Information Retrieval** + +1. The NF service consumer (e.g. IMS-AS) sends a GET request to the resource representing the DSAI information with query parameter indicating the Application Server Name. Additional query parameters (e.g. supported-features) may be included. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the DSAI tags and their respective status associated to the received Application Server Name. +- 2b. If there are no DSAI tags for the Application Server, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.8 Repository Data + +##### 5.3.2.2.8.1 Repository Data Retrieval + +Figure 5.3.2.2.8.1-1 shows a scenario where the NF service consumer (IMS-AS or DCSF) sends a request to the HSS to receive the UE's Repository Data for a given Service Indication. The request contains the UE's identity (/{imsUeId}), the type of the requested information (/repository-data/{serviceIndication}) and query parameters (e.g. supported-features). + +![Sequence diagram for Repository Data Retrieval](9252ccfbbe9e34cb108f0060f2b563f1_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 1. GET « /{imsUeId}/repository-data/{serviceIndication} » + HSS->>NF Service Consumer: 2a. 200 OK (RepositoryData) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect +``` + +The diagram illustrates a sequence of interactions between an NF Service Consumer and an HSS. The consumer sends a GET request to the HSS for repository data. The HSS responds with one of three possible outcomes: a 200 OK with the data, a 404 Not Found error, or a 3xx Redirect. + +Sequence diagram for Repository Data Retrieval + +**Figure 5.3.2.2.8.1-1: Repository Data Retrieval** + +1. The NF service consumer sends a GET request to the resource representing the UE's Repository Data for a given Service Indication, with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Repository Data for the requested Service Indication as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data or Repository Data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.8.2 + +#### Repository Data Retrieval for multiple service indications + +Figure 5.3.2.2.8.2-1 shows a scenario where the NF service consumer (IMS-AS or DCSF) sends a request to the HSS to receive the UE's Repository Data for multiple Service Indications. The request contains the UE's identity (/{imsUeId}), the type of the requested information (/repository-data) and query parameters (e.g. list of service indications, supported-features). + +![Sequence diagram for Repository Data Retrieval for multiple service indications](4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 1. GET « /{imsUeId}/repository-data ?service-indications » + HSS->>NF Service Consumer: 2a. 200 OK (RepositoryDataList) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect +``` + +The diagram illustrates a sequence of interactions between an NF Service Consumer and an HSS. The consumer sends a GET request to the HSS for repository data for multiple service indications. The HSS responds with one of three possible outcomes: a 200 OK with a list of repository data, a 404 Not Found error, or a 3xx Redirect. + +Sequence diagram for Repository Data Retrieval for multiple service indications + +**Figure 5.3.2.2.8.2-1: Repository Data Retrieval for multiple service indications** + +1. The NF service consumer sends a GET request to the resource representing the UE's Repository Data, with query parameters indicating the supported-features and list of service indications. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Repository Data for the requested Service Indications as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data or Repository Data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.2.9 Shared Subscription Data + +#### 5.3.2.2.9.1 Shared Subscription Data Retrieval + +Figure 5.3.2.2.9.1-1 shows a scenario where the NF service consumer (e.g. S-CSCF) sends a request to the HSS to receive the shared subscription data. The request contains the type of the requested information (/shared-data) and query parameters (supportedFeatures, shared-data-id). + +![Sequence diagram for Shared Subscription Data Retrieval. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. A solid arrow labeled '1. GET « shared-data?shared-data-id=, ' points from the consumer to the UDM. A return arrow points from the UDM back to the consumer, with a box containing three possible response options: '2a. 200 OK (SharedData)', '2b. 404 Not Found', and '2c. 3xx Redirect'.](3b00a61116faef21d3a6009fd350b46a_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note right of UDM: 2a. 200 OK (SharedData) +2b. 404 Not Found +2c. 3xx Redirect + NF service consumer->>UDM: 1. GET « shared-data?shared-data-id=, + UDM-->>NF service consumer: 2a. 200 OK (SharedData) +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram for Shared Subscription Data Retrieval. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. A solid arrow labeled '1. GET « shared-data?shared-data-id=, ' points from the consumer to the UDM. A return arrow points from the UDM back to the consumer, with a box containing three possible response options: '2a. 200 OK (SharedData)', '2b. 404 Not Found', and '2c. 3xx Redirect'. + +**Figure 5.3.2.2.9.1-1: Shared Subscription Data Retrieval** + +1. The NF service consumer (e.g. S-CSCF) sends a GET request to the resource representing the SharedData, with query parameters indicating the supportedFeatures and shared-data-id. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the SharedData. +- 2b. If there is no valid shared data for one or more of the shared-data-ids, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.3 Subscribe + +#### 5.3.2.3.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscription to notification of data change +- Subscription to notification of UE reachability for IP + +#### 5.3.2.3.2 Subscription to notifications of data change + +Figure 5.3.2.3.2-1 shows a scenario where the NF service consumer (e.g. S-CSCF) sends a request to the HSS to subscribe to notifications of data change. The request contains a callback URI and the URI of the monitored resource. + +![Sequence diagram showing the NF service consumer subscribing to notifications. The consumer sends a POST request to the HSS. The HSS responds with one of the following: 2a. 201 Created (ImsSdmSubscription), 2b. 404 Not Found, 2c. 501 Not Implemented, or 2d. 3xx Redirect.](32ff77da4286b58c4778033acaa10836_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + NF service consumer->>HSS: 1. POST « ^{imsUeId}/subscriptions (ImsSdmSubscription) + HSS-->>NF service consumer: 2a. 201 Created (ImsSdmSubscription) + HSS-->>NF service consumer: 2b. 404 Not Found + HSS-->>NF service consumer: 2c. 501 Not Implemented + HSS-->>NF service consumer: 2d. 3xx Redirect + +``` + +Sequence diagram showing the NF service consumer subscribing to notifications. The consumer sends a POST request to the HSS. The HSS responds with one of the following: 2a. 201 Created (ImsSdmSubscription), 2b. 404 Not Found, 2c. 501 Not Implemented, or 2d. 3xx Redirect. + +**Figure 5.3.2.3.2-1: NF service consumer subscribes to notifications** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (.../{imsUeId}/sdm-subscriptions), to create a subscription as present in message body. +- 2a. On success, the HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the UE subscription data exist, but the requested subscription to data change notification cannot be created (e.g. due to an invalid/unsupported data reference to be monitored, contained in the ImsSdmSubscription parameter), HTTP status code "501 Not Implemented" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.3.3 Subscription to notifications of shared data change + +Figure 5.3.2.3.3-1 shows a scenario where the NF service consumer sends a request to the HSS to subscribe to notifications of shared data change. The request contains a callback URI and the URI of the monitored resource. + +![Sequence diagram showing the NF service consumer subscribing to notifications of shared data change. The consumer sends a POST request to the HSS. The HSS responds with one of the following: 2a. 201 Created (ImsSdmSubscription), 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect.](8d8c758885b4f754ff071bf3b572ab3c_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + NF service consumer->>HSS: 1. POST « shared-data-subscriptions (ImsSdmSubscription) + HSS-->>NF service consumer: 2a. 201 Created (ImsSdmSubscription) + HSS-->>NF service consumer: 2b. 4xx/5xx Client or Server Error + HSS-->>NF service consumer: 2c. 3xx Redirect + +``` + +Sequence diagram showing the NF service consumer subscribing to notifications of shared data change. The consumer sends a POST request to the HSS. The HSS responds with one of the following: 2a. 201 Created (ImsSdmSubscription), 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect. + +**Figure 5.3.2.3.3-1: NF service consumer subscribes to notifications of shared data change** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (.../shared-data-subscriptions), to create a subscription as present in message body. +- 2a. On success, the HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.3.4 Subscriptions to notification of UE Reachability for IP + +Figure 5.3.2.3.4-1 shows a scenario where the NF service consumer (e.g. IP-SM-GW) sends a request to the HSS to subscribe to UE reachability for IP. The request contains the UE's identity (/{imsUeId}), the resource to be monitored (/access-data/ps-domain/ue-reach-subscriptions), an expiry time, a callback URI and query parameters (e.g. supported-features). + +Subscriptions to notification on UE Reachability for IP are requests for a one-time notification, i.e. after notification the subscription becomes invalid. + +![Sequence diagram showing the subscription process between an NF Service Consumer and an HSS. The consumer sends a POST request to the HSS. The HSS responds with either a 201 Created status (with subscription details), a 404 Not Found status, or a 3xx Redirect status.](1e8c50ad4fca7f315a407347dd5091cc_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. POST « ^imsUeId}/access-data/ps-domain/ue-reach-subscriptions (UeReachabilitySubscription) + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 201 Created (UeReachabilitySubscription) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the subscription process between an NF Service Consumer and an HSS. The consumer sends a POST request to the HSS. The HSS responds with either a 201 Created status (with subscription details), a 404 Not Found status, or a 3xx Redirect status. + +**Figure 5.3.2.3.4-1: Subscription to notification of UE reachability for IP** + +1. The NF service consumer (e.g. IP-SM-GW) sends a POST request to the parent resource (collection of UE reachability subscriptions) (.../{ueIdentity}/ue-reach-subscriptions), to create a subscription to UE reachability for IP. The request contains an expiry time, suggested by the NF Service Consumer, representing the time upto which the subscription is desired to be kept active and the time after which the UE reachability event shall not generate a notification. +- 2a. On success, the HSS sets the URRP flag for the relevant serving nodes and may contact UDM (see 3GPP TS 23.632, clause 5.4.5). The HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. + +The response contains the expiry time, as determined by the HSS (possible based on operator policy) after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the HSS. The NF Service Producer shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. + +- 2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.4 Unsubscribe + +#### 5.3.2.4.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscribe to notification of data change +- Unsubscribe to notification of UE reachability for IP + +#### 5.3.2.4.2 Unsubscribe to notifications of data change + +Figure 5.3.2.4.2-1 shows a scenario where the NF service consumer (e.g. S-CSCF) sends a request to the HSS to unsubscribe from notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram for Figure 5.3.2.4.2-1: NF service consumer unsubscribes to notifications. The diagram shows a DELETE request from the NF service consumer to the HSS, and the HSS responding with 204 No Content, 404 Not Found, or 3xx Redirect.](b44f89b176c971c7dd264c07bfef2c2a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant HSS + Note right of HSS: 1. DELETE « ^imsUeId}/subscriptions/{subscriptionId} + HSS-->>NF service consumer: 2a. 204 No Content + HSS-->>NF service consumer: 2b. 404 Not Found + HSS-->>NF service consumer: 2c. 3xx Redirect +``` + +Sequence diagram for Figure 5.3.2.4.2-1: NF service consumer unsubscribes to notifications. The diagram shows a DELETE request from the NF service consumer to the HSS, and the HSS responding with 204 No Content, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.4.2-1: NF service consumer unsubscribes to notifications** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.4.3 Unsubscribe to notifications of shared data change + +Figure 5.3.2.4.3-1 shows a scenario where the NF service consumer sends a request to the HSS to unsubscribe from notifications of shared data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram for Figure 5.3.2.4.3-1: NF service consumer unsubscribes to notifications for shared data. The diagram shows a DELETE request from the NF service consumer to the HSS, and the HSS responding with 204 No Content, 404 Not Found, or 3xx Redirect.](4767b6e106f34fe8b63a6838810bf913_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant HSS + Note right of HSS: 1. DELETE « shared-data-subscriptions/{subscriptionId} + HSS-->>NF service consumer: 2a. 204 No Content + HSS-->>NF service consumer: 2b. 404 Not Found + HSS-->>NF service consumer: 2c. 3xx Redirect +``` + +Sequence diagram for Figure 5.3.2.4.3-1: NF service consumer unsubscribes to notifications for shared data. The diagram shows a DELETE request from the NF service consumer to the HSS, and the HSS responding with 204 No Content, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.4.3-1: NF service consumer unsubscribes to notifications for shared data** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.4.4 Unsubscribe to notification of UE Reachability for IP + +Figure 5.3.2.4.4-1 shows a scenario where the NF service consumer (e.g. IP-SM-GW) sends a request to the HSS to unsubscribe from notifications of UE Reachability for IP. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the Unsubscribe to notification of UE reachability for IP process. The NF service consumer sends a DELETE request to the HSS. The HSS responds with one of three options: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect.](052543d8c9c0643b05b3ce45c6decca1_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note right of NF service consumer: 1. DELETE ^imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId} + NF service consumer->>HSS: 1. DELETE request + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF service consumer: 2. Response + +``` + +Sequence diagram showing the Unsubscribe to notification of UE reachability for IP process. The NF service consumer sends a DELETE request to the HSS. The HSS responds with one of three options: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.4.4-1: Unsubscription to notification of UE reachability for IP** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.5 ModifySubscription + +##### 5.3.2.5.1 General + +The following procedures using the ModifySubscription service operation are supported: + +- Modification of a Subscription to notification of data change (for UE individual data) +- Modification of a Subscription to notification of shared data change +- Modification of a Subscription to notification of UE Reachability for IP + +The ModifySubscription service operation can be used for the following purpose: + +- Extend the expiry time of ImsSdmSubscription; +- Extend the expiry time of UeReachabilitySubscription; +- Modify the resource URIs to be monitored, e.g. add/remove resource URIs to/from the monitored resource URI list. + +### 5.3.2.5.2 Modification of a subscription to notifications of data change + +Figure 5.3.2.5.2-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram for Figure 5.3.2.5.2-1: NF service consumer modifies a subscription to notifications. The diagram shows a PATCH request from the NF service consumer to the HSS, and the corresponding response options.](73b28b0f5e3be628bb5a3d6bd1d79d21_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note right of HSS: 1. PATCH « ^imsUeld}/subscriptions/{subscriptionId} ([PatchItems]) + HSS->>NF: 2a. 200 OK (PatchResult) / 204 No Content + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + +``` + +Sequence diagram for Figure 5.3.2.5.2-1: NF service consumer modifies a subscription to notifications. The diagram shows a PATCH request from the NF service consumer to the HSS, and the corresponding response options. + +**Figure 5.3.2.5.2-1: NF service consumer modifies a subscription to notifications** + +1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation. + +The NF service consumer may include "monitoredResourceUris" to replace the existing monitored resource URIs, e.g. to add/remove specific resource URIs from the monitored resource URI list. + +- 2a. On success, the HSS responds with "200 OK" or "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.5.3 Modification of a subscription to notifications of shared data change + +Figure 5.3.2.5.3-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of shared data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram for Figure 5.3.2.5.3-1: NF service consumer modifies a subscription to notifications for shared data. The diagram shows a PATCH request from the NF service consumer to the HSS, and the corresponding response options.](ca1fca41d037482ce500c69cf727b8aa_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note right of HSS: 1. PATCH « shared-data-subscriptions/{subscriptionId} ([PatchItems]) + HSS->>NF: 2a. 200 OK (PatchResult) / 204 No Content + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + +``` + +Sequence diagram for Figure 5.3.2.5.3-1: NF service consumer modifies a subscription to notifications for shared data. The diagram shows a PATCH request from the NF service consumer to the HSS, and the corresponding response options. + +**Figure 5.3.2.5.3-1: NF service consumer modifies a subscription to notifications for shared data** + +1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation. + +The NF service consumer may include "monitoredResourceUris" to replace the existing monitored resource URIs, e.g. for the purposes to add/remove specific resource URIs from the monitored resource URI list. + +- 2a. On success, the HSS responds with "200 OK" or "204 No Content". + +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.5.4 Modification of a subscription to notifications of data change + +Figure 5.3.2.5.4-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for modifying a subscription. The consumer sends a PATCH request to a specific URI. The HSS responds with one of three possible status codes: 200 OK, 204 No Content, 404 Not Found, or a 3xx Redirect.](772cc583a60eeb058cc19de48269ad22_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note right of NF service consumer: 1. PATCH< ^imsUeId>/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId} ([PatchItems]) + NF service consumer->>HSS: Request + Note left of HSS: 2a. 200 OK (PatchResult) / 204 No Content +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for modifying a subscription. The consumer sends a PATCH request to a specific URI. The HSS responds with one of three possible status codes: 200 OK, 204 No Content, 404 Not Found, or a 3xx Redirect. + +**Figure 5.3.2.5.4-1: NF service consumer modifies a subscription to notifications** + +1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation. + +The NF service consumer includes a new expiry time, e.g. to extend the monitoring time of the event. + +- 2a. On success, the HSS responds with "200 OK" or "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.6 Notification + +##### 5.3.2.6.1 General + +The following procedures using the Notification service operation are supported: + +- Data change notification to NF; +- UE Reachability for IP notification to NF. + +##### 5.3.2.6.2 Data Change Notification To NF + +Figure 5.3.2.6.2-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change. The request contains the callbackReference URI as previously received in the ImsSdmSubscription. + +![Sequence diagram for Subscription Data Change Notification. The HSS sends a POST {callbackReference} (Notification) to the NF service consumer. The NF service consumer responds with 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect.](3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg) + +``` + +sequenceDiagram + participant HSS + participant NF as NF service consumer + Note right of HSS: 1. POST {callbackReference} (Notification) + HSS->>NF: 1. POST {callbackReference} (Notification) + Note left of NF: 2a. 204 No Content +2b. 4xx/5xx Client or Server Error +2c. 3xx Redirect + NF-->>HSS: 2a. 204 No Content + +``` + +Sequence diagram for Subscription Data Change Notification. The HSS sends a POST {callbackReference} (Notification) to the NF service consumer. The NF service consumer responds with 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect. + +**Figure 5.3.2.6.2-1: Subscription Data Change Notification** + +1. The HSS sends a POST request to the callbackReference as provided by the NF service consumer during the subscription. +2. The NF service consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +### 5.3.2.6.3 UE Reachability for IP Notification to NF + +Figure 5.3.2.6.3-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change. The request contains the callbackReference URI as previously received in the UeReachabilitySubscription. + +![Sequence diagram for UE Reachability for IP Notification. The HSS sends a POST {callbackReference} (UeReachabilityNotification) to the NF service consumer. The NF service consumer responds with 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect.](042af54276c75e7b7b48a3af1f0a84e5_img.jpg) + +``` + +sequenceDiagram + participant HSS + participant NF as NF service consumer + Note right of HSS: 1. POST {callbackReference} (UeReachabilityNotification) + HSS->>NF: 1. POST {callbackReference} (UeReachabilityNotification) + Note left of NF: 2a. 204 No Content +2b. 4xx/5xx Client or Server Error +2c. 3xx Redirect + NF-->>HSS: 2a. 204 No Content + +``` + +Sequence diagram for UE Reachability for IP Notification. The HSS sends a POST {callbackReference} (UeReachabilityNotification) to the NF service consumer. The NF service consumer responds with 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect. + +**Figure 5.3.2.6.3-1: UE Reachability for IP Notification** + +1. The HSS sends a POST request to the callbackReference as provided by the NF service consumer during the subscription. The notification includes information about UE reachability for IP event detected. +2. The NF service consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +## 5.3.2.7 Update + +### 5.3.2.7.1 General + +The following procedures using the Update service operation are supported: + +- Repository Data Create/Update/Delete + +- STN-SR update +- SMS registration information Create/Update/Delete +- PSI activation state Update +- DSAI-tag activation state Update + +### 5.3.2.7.2 Repository Data Creation or Update + +Figure 5.3.2.7.2-1 shows a scenario where the NF service consumer (IMS AS or DCSF) sends a request to the HSS to create or update the repository data for a given service indication. The request contains the UE's identity (/{imsUeId}) which shall be an IMS Public Identity, the service indication and repository data with the associated version (sequence number). + +![Sequence diagram showing the interaction between an NF Service Consumer and an HSS for repository data creation or update. The consumer sends a PUT request to the HSS, and the HSS responds with various HTTP status codes.](753e6cc5dcad1a478caa2c7ec3a6c0a3_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1. PUT «/{ueId}/repository-data/{serviceIndication} (RepositoryData)» + NF Service Consumer->>HSS: Request + Note left of HSS: 2a. 200 OK / 204 No Content +2b. 201 Created +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an HSS for repository data creation or update. The consumer sends a PUT request to the HSS, and the HSS responds with various HTTP status codes. + +**Figure 5.3.2.7.2-1: Creating or updating repository data** + +1. The NF service consumer sends a PUT request to the resource representing the UE's Repository Data for a requested Service Indication. + +The NF service consumer may request the creation of the Repository Data (sequence number equal to zero) or may request the update of the Repository Data (sequence number greater than zero) + +- 2a. On success, the HSS updates the RepositoryData resource by replacing it with the received resource information, and responds with "200 OK" or "204 No Content". +- 2b. If the resource does not exist (there is no repository data associated to the requested service indication), HSS stores the received Repository Data and responds with HTTP Status Code "201 created". A response body may be included to convey additional information to the NF consumer (e.g., features supported by HSS). +- 2c. If the operation is not authorized due to e.g the NF service consumer does not have the required permissions for the service indication and the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.7.3 Repository Data Deletion + +Figure 5.3.2.7.3-1 shows a scenario where the NF service consumer sends a request to the HSS to delete the repository data for a given service indication. The request contains the UE's identity (/{imsUeId}) which shall be an IMS Public Identity and the service indication. + +![Sequence diagram for deleting repository data. An NF Service Consumer sends a DELETE request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 1. DELETE « /{ueId}/repository-data/{serviceIndication} » + NF Service Consumer->>HSS: 1. DELETE request + Note left of NF Service Consumer: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for deleting repository data. An NF Service Consumer sends a DELETE request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.3.2.7.3-1: Deleting repository data** + +1. The NF service consumer sends a DELETE request to the resource representing the UE's Repository Data for a requested Service Indication. +- 2a. On success, the HSS deletes the resource and responds with "204 No Content". +- 2b. If the repository data does not exist in the HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation is not authorized due to e.g the NF service consumer does not have the required permissions for the service indication and operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.7.4 STN-SR update + +Figure 5.3.2.7.4-1 shows a scenario where the IMS-AS sends a request to the HSS to update the STN-SR. The request contains the UE's identity (`/{imsUeId}`) which shall be an IMS Public Identity or a Private Identity and an instruction to modify the STN-SR. + +![Sequence diagram for IMS AS updating STN-SR. An IMS AS sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](ddfa5b18550d1a022a941e3c31843814_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of HSS: 1. PATCH « ^imsUeId}/srvcc-data (Modification instruction) » + IMS AS->>HSS: 1. PATCH request + Note left of IMS AS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>IMS AS: Response + +``` + +Sequence diagram for IMS AS updating STN-SR. An IMS AS sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.3.2.7.4-1: IMS AS updating STN-SR** + +1. The IMS AS sends a PATCH request to the resource representing the UE's SRVCC Data. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If the resource does not exist (i.e. the user is not subscribed to SRVCC), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.7.5 PSI activation state update + +Figure 5.3.2.7.5-1 shows a scenario where the IMS-AS sends a request to the HSS to update the PSI activation state. The request contains the Public Service Identity (/{imsUeId}) and an instruction to modify the activation state. + +![Sequence diagram for PSI activation state update. IMS AS sends a PATCH request to HSS. HSS responds with 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](c5a20f7bae219fc4c31f7376b7eb11e1_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of IMS AS: 1. PATCH « ^ ueld}/service-data/psi-state (Modification instruction) » + IMS AS->>HSS: 1. PATCH request + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>IMS AS: Response + +``` + +Sequence diagram for PSI activation state update. IMS AS sends a PATCH request to HSS. HSS responds with 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.3.2.7.5-1: IMS AS updating a PSI activation state** + +1. The IMS AS sends a PATCH request to the resource representing the PSI activation state. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If the resource does not exist (i.e. the service does not exist), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.7.6 SMS Registration Information Creation or Update + +Figure 5.3.2.7.6-1 shows a scenario where the IMS-AS sends a request to the HSS to create or update the SMS registration information. The request contains the UE's identity (/{imsUeId}) which shall be an IMS Public Identity and the SMS registration information (IP-SM-GW number). + +![Sequence diagram for SMS Registration Information Creation or Update. IMS AS sends a PUT request to HSS. HSS responds with 2a. 200 OK / 204 No Content, 2b. 201 Created, 2c. 403 Forbidden, or 2d. 3xx Redirect.](34e9ca4d52796527c375f4bc187080f8_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of IMS AS: 1. PUT « ^ ueld}/service-data/sms-registration-info (lpSmGwAddress) » + IMS AS->>HSS: 1. PUT request + Note right of HSS: 2a. 200 OK / 204 No Content +2b. 201 Created +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>IMS AS: Response + +``` + +Sequence diagram for SMS Registration Information Creation or Update. IMS AS sends a PUT request to HSS. HSS responds with 2a. 200 OK / 204 No Content, 2b. 201 Created, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.3.2.7.6-1: IMS AS creating or updating the SMS registration information** + +1. The IMS AS sends a PUT request to the resource representing the UE's SMS registration information. The request contains the IP-SM-GW number and, if s6c is supported, the Diameter Identity and Diameter Realm of the IP-SM-GW. + +If the IP-SM-GW supports SBI-based MT SM transmit, the "SBI support indication" of the IP-SM-GW shall be included in the SMS Registration Information. + +- 2a. On success, the HSS updates the SMS registration information resource by replacing it with the received resource information and responds with "200 OK" or "204 No Content". +- 2b. If the resource does not exist (there is no IP-SM-GW number associated to the user), HSS stores the received SMS registration information and responds with HTTP Status Code "201 created". A response body may be included to convey additional information to the NF consumer (e.g., features supported by HSS). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions or the IP-SM-GW number is pre-configured and cannot be overwritten, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.7.7 SMS Registration Information Deletion + +Figure 5.3.2.7.7-1 shows a scenario where the IMS-AS sends a request to the HSS to delete the SMS registration information. The request contains the UE's identity (/{imsUeId}) which shall be an IMS Public Identity. + +![Sequence diagram showing the IMS AS sending a DELETE request to the HSS for SMS registration information. The request is labeled '1. DELETE « ^ ueld}/service-data/sms-registration-info'. The HSS responds with a list of possible status codes: '2a. 204 No Content', '2b. 404 Not Found', '2c. 403 Forbidden', and '2d. 3xx Redirect'.](e3eebf9854831ba50eca8b26c468f65e_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + IMS AS->>HSS: 1. DELETE « ^ ueld}/service-data/sms-registration-info + HSS-->>IMS AS: Response + +``` + +Sequence diagram showing the IMS AS sending a DELETE request to the HSS for SMS registration information. The request is labeled '1. DELETE « ^ ueld}/service-data/sms-registration-info'. The HSS responds with a list of possible status codes: '2a. 204 No Content', '2b. 404 Not Found', '2c. 403 Forbidden', and '2d. 3xx Redirect'. + +**Figure 5.3.2.7.7-1: IMS AS deleting SMS registration information** + +1. The IMS AS sends a DELETE request to the resource representing the UE's SMS registration information. +- 2a. On success, the HSS deletes the resource and responds with "204 No Content". +- 2b. If the SMS registration information does not exist in the HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions or the IP-SM-GW number is pre-configured and cannot be deleted, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.7.8 DSAI tag activation state update + +Figure 5.3.2.7.8-1 shows a scenario where the IMS-AS sends a request to the HSS to update the DSAI tag activation state. The request contains the Public Service Identity (/{imsUeId}) and an instruction to modify the activation state of DSAI tag. + +![Sequence diagram showing IMS AS sending a PATCH request to HSS for DSAI tag activation state update, and HSS responding with various HTTP status codes.](9e8ebf03cae78f4f81b697548c2d7250_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of IMS AS: 1. PATCH « ^ueld}/service-data/dsai +(Modification instruction) + IMS AS->>HSS: 1. PATCH request + Note left of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>IMS AS: Response + +``` + +Sequence diagram showing IMS AS sending a PATCH request to HSS for DSAI tag activation state update, and HSS responding with various HTTP status codes. + +**Figure 5.3.2.7.8-1: IMS AS updating DSAI tag activation state** + +1. The IMS AS sends a PATCH request to the resource representing the DSAI tag activation state. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If the resource does not exist (i.e. the service does not exist), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.4 Nhss\_imsUEAuthentication Service + +### 5.4.1 Service Description + +See 3GPP TS 23.228 [6], clause AA.2.1.4. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +For the Nhss\_imsUEAuthentication service the following service operation is defined: + +- Get + +The Nhss\_imsUEAuthentication Service is used by the S-CSCF to request the SBI capable HSS to select an authentication method, calculate a fresh authentication vector (AV) if required for the selected method, and provide it to the S-CSCF by means of the Get service operation. + +#### 5.4.2.2 Get + +##### 5.4.2.2.1 General + +The following procedures using the Get service operation are supported: + +- Authentication Information Retrieval + +#### 5.4.2.2.2 Authentication Information Retrieval + +Figure 5.4.2.2.2-1 shows a scenario where the NF service consumer (S-CSCF) retrieves authentication information for the UE from the HSS. The request contains the UE's identity (IMS Private Identity) and the SIP authentication scheme and may contain resynchronization info. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for authentication information retrieval. The consumer sends a POST request to the HSS, and the HSS responds with a 200 OK, 403 Forbidden, or 3xx Redirect.](cc6f9dbfc36aa5821d9749ca84861f93_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note right of NF service consumer: 1. POST « {impi}/security-information/generate-sip-auth-data (SipAuthenticationInfoRequest) » + NF service consumer->>HSS: 1. POST « {impi}/security-information/generate-sip-auth-data (SipAuthenticationInfoRequest) » + Note left of HSS: 2a. 200 OK (SipAuthenticationInfoResult) +2b. 403 Forbidden +2c. 3xx Redirect + HSS-->>NF service consumer: 2a. 200 OK (SipAuthenticationInfoResult) +2b. 403 Forbidden +2c. 3xx Redirect + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for authentication information retrieval. The consumer sends a POST request to the HSS, and the HSS responds with a 200 OK, 403 Forbidden, or 3xx Redirect. + +**Figure 5.4.2.2.2-1: NF service consumer requesting authentication information** + +1. The NF service consumer sends a POST request (custom method: generate-sip-auth-data) to the resource representing the UE's security information. The content shall contain the S-CSCF name, SIP authentication scheme and the resynchronization info. +- 2a. The HSS responds with "200 OK" with the message body containing the authentication data information. +- 2b. If the operation cannot be authorized due to e.g UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.5 Nhss\_gbaSubscriberDataManagement Service + +#### 5.5.1 Service Description + +See 3GPP TS 33.220 [6], clause X.2.1.2. + +#### 5.5.2 Service Operations + +##### 5.5.2.1 Introduction + +For the Nhss\_gbaSubscriberDataManagement service the following service operations are defined: + +- Get +- Subscribe +- Unsubscribe +- Modification of subscription +- Notification + +The Nhss\_gbaSubscriberDataManagement Service is used by Consumer NFs (GBA BSF) to: + +- fetch the GBA subscriber data for the UE + +- subscribe/unsubscribe, and to be notified, when data previously requested have changed + +## 5.5.2.2 Get + +### 5.5.2.2.1 General + +The following procedures using the Get service operation are supported: + +- Retrieval of GBA subscriber data + +### 5.5.2.2.2 Retrieval of GBA subscriber data + +Figure 5.5.2.2.2-1 shows a scenario where the GBA BSF sends a request to the HSS to retrieve the GBA subscriber data. The request contains the UE's identity (`/{ueId}`) which shall be one of IMSI, MSISDN, IMPI, IMPU. + +![Sequence diagram showing the retrieval of GBA subscriber data. The GBA BSF sends a GET request to the HSS. The HSS responds with one of the following: 2a. 200 OK (GbaSubscriberData), 2b. 403 Forbidden, 2c. 404 Not Found, or 2d. 3xx Redirect.](42c65f5cb106938992fc73c05c8713d2_img.jpg) + +``` + +sequenceDiagram + participant GBA BSF + participant HSS + Note right of HSS: 2a. 200 OK (GbaSubscriberData) +2b. 403 Forbidden +2c. 404 Not Found +2d. 3xx Redirect + GBA BSF->>HSS: 1. GET « ^ueId}/gba-subscriber-data + HSS-->>GBA BSF: 2a. 200 OK (GbaSubscriberData) +2b. 403 Forbidden +2c. 404 Not Found +2d. 3xx Redirect + +``` + +Sequence diagram showing the retrieval of GBA subscriber data. The GBA BSF sends a GET request to the HSS. The HSS responds with one of the following: 2a. 200 OK (GbaSubscriberData), 2b. 403 Forbidden, 2c. 404 Not Found, or 2d. 3xx Redirect. + +**Figure 5.5.2.2.2-1: Retrieval of GBA subscriber data** + +1. The GBA BSF sends a GET request to the resource representing the UE's GBA subscriber data. +- 2a. Upon success, the HSS responds with "200 OK" with the GBA subscriber data (containing, e.g. the GBA User Security Settings, GUSS) in the response body, and HSS supported features. +- 2b. If the operation is not authorized due to, e.g. received UE identity not being allowed for GBA services, or the requesting node not being authorized to fetch the requested data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). +- 2c. If the UE identity is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.5.2.3 Subscribe + +### 5.5.2.3.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscription to changes on the GBA subscriber data + +### 5.5.2.3.2 Subscription to changes on the GBA subscriber data + +Figure 5.5.2.3.2-1 shows a scenario where the GBA BSF sends a request to the HSS to subscribe to changes on a previously retrieved GBA subscriber data. The request contains the UE's identity (`/{ueId}`) which shall be one of IMSI, MSISDN, IMPI, IMPU. + +![Sequence diagram for Figure 5.5.2.3.2-1: Subscription to changes on the GBA subscriber data. The diagram shows a GBA BSF sending a POST request to an HSS. The request is '1. POST « ^{ueId}/subscriptions (GbaSdmSubscription)'. The HSS responds with a list of possible status codes: '2a. 200 OK (GbaSdmSubscription)', '2b. 403 Forbidden', '2c. 404 Not Found', and '2d. 3xx Redirect'.](3337af75dfee8af7687b4f49914d6c93_img.jpg) + +``` + +sequenceDiagram + participant GBA BSF + participant HSS + GBA BSF->>HSS: 1. POST « ^{ueId}/subscriptions (GbaSdmSubscription) + Note over GBA BSF, HSS: 2a. 200 OK (GbaSdmSubscription) +2b. 403 Forbidden +2c. 404 Not Found +2d. 3xx Redirect + HSS-->>GBA BSF: + +``` + +Sequence diagram for Figure 5.5.2.3.2-1: Subscription to changes on the GBA subscriber data. The diagram shows a GBA BSF sending a POST request to an HSS. The request is '1. POST « ^{ueId}/subscriptions (GbaSdmSubscription)'. The HSS responds with a list of possible status codes: '2a. 200 OK (GbaSdmSubscription)', '2b. 403 Forbidden', '2c. 404 Not Found', and '2d. 3xx Redirect'. + +**Figure 5.5.2.3.2-1: Subscription to changes on the GBA subscriber data** + +1. The GBA BSF sends a POST request to the collection resource representing the subscriptions to changes on the UE's GBA subscriber data. The request body contains a URI where subsequent notification shall be sent by HSS. +- 2a. Upon success, the HSS responds with "200 OK" with the GBA SDM subscription data in the response body, and HSS supported features. +- 2b. If the operation is not authorized due to, e.g. received UE identity not being allowed for GBA services, or the requesting node not being authorized to subscribe to changes on GBA subscriber data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). +- 2c. If the UE identity is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.5.2.4 Unsubscribe + +### 5.5.2.4.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscribe to changes on the GBA subscriber data + +### 5.5.2.4.2 Unsubscribe to changes on the GBA subscriber data + +Figure 5.5.2.4.2-1 shows a scenario where the GBA BSF sends a request to the HSS to unsubscribe to changes on a previously retrieved GBA subscriber data. The request contains the UE's identity (/ {ueId}) which shall be one of IMSI, MSISDN, IMPI, IMPU. + +![Sequence diagram for Figure 5.5.2.4.2-1: Deletion of a subscription to changes on the GBA subscriber data. The diagram shows a GBA BSF sending a DELETE request to an HSS. The request is '1. DELETE « ^{ueId}/subscriptions/{subscriptionId}'. The HSS responds with a list of possible status codes: '2a. 204 No Content', '2b. 403 Forbidden', '2c. 404 Not Found', and '2d. 3xx Redirect'.](818a57b74294582a480f23f82d95815f_img.jpg) + +``` + +sequenceDiagram + participant GBA BSF + participant HSS + GBA BSF->>HSS: 1. DELETE « ^{ueId}/subscriptions/{subscriptionId} + Note over GBA BSF, HSS: 2a. 204 No Content +2b. 403 Forbidden +2c. 404 Not Found +2d. 3xx Redirect + HSS-->>GBA BSF: + +``` + +Sequence diagram for Figure 5.5.2.4.2-1: Deletion of a subscription to changes on the GBA subscriber data. The diagram shows a GBA BSF sending a DELETE request to an HSS. The request is '1. DELETE « ^{ueId}/subscriptions/{subscriptionId}'. The HSS responds with a list of possible status codes: '2a. 204 No Content', '2b. 403 Forbidden', '2c. 404 Not Found', and '2d. 3xx Redirect'. + +**Figure 5.5.2.4.2-1: Deletion of a subscription to changes on the GBA subscriber data** + +1. The GBA BSF sends a DELETE request to the resource representing the individual subscription (subscriptionID) to changes on the UE's GBA subscriber data. +- 2a. Upon success, the HSS responds with "204 No Content". + +- 2b. If the operation is not authorized due to, e.g. received UE identity not being allowed for GBA services, or the requesting node not being authorized to subscribe/unsubscribe to changes on GBA subscriber data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). +- 2c. If the UE identity is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.5.2.5 Modification of Subscription + +### 5.5.2.5.1 General + +The following procedures using the Modification of Subscription service operation are supported: + +- Modification of Subscription to changes on the GBA subscriber data + +### 5.5.2.5.2 Modification of Subscription to changes on the GBA subscriber data + +Figure 5.5.2.5.2-1 shows a scenario where the GBA BSF sends a request to the HSS to modify a subscription to changes (e.g. to extend its expiration lifetime) on a previously retrieved GBA subscriber data. The request contains the UE's identity (/ {ueId}) which shall be one of IMSI, MSISDN, IMPI, IMPU. + +![Sequence diagram showing the interaction between GBA BSF and HSS for modifying a subscription. The GBA BSF sends a PATCH request to the HSS. The HSS responds with one of the following status codes: 2a. 200 OK, 2b. 204 No Content, 2c. 403 Forbidden, 2d. 404 Not Found, or 2e. 3xx Redirect.](d4ed35f72863013455b8f015e0f2e47e_img.jpg) + +``` + +sequenceDiagram + participant GBA BSF + participant HSS + Note right of HSS: 2a. 200 OK +2b. 204 No Content +2c. 403 Forbidden +2d. 404 Not Found +2e. 3xx Redirect + GBA BSF->>HSS: 1. PATCH « ^ ueId}/subscriptions/{subscriptionId} + HSS-->>GBA BSF: Response + +``` + +Sequence diagram showing the interaction between GBA BSF and HSS for modifying a subscription. The GBA BSF sends a PATCH request to the HSS. The HSS responds with one of the following status codes: 2a. 200 OK, 2b. 204 No Content, 2c. 403 Forbidden, 2d. 404 Not Found, or 2e. 3xx Redirect. + +**Figure 5.5.2.5.2-1: Modification of Subscription to changes on the GBA subscriber data** + +1. The GBA BSF sends a PATCH request to the resource representing the individual subscription to changes on the UE's GBA subscriber data (identified by its subscriptionID). +- 2a. Upon success, if some of the changes, but not all, have been accepted, the HSS responds with "200 OK" with the new GBA SDM subscription data in the response body. +- 2b. Upon success, if all the changes have been accepted, the HSS responds with "204 No Content". +- 2c. If the operation is not authorized due to the requesting node not being authorized to modify the subscription to changes on GBA subscriber data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). +- 2d. If the subscriptionId is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.5.2.5 Notify + +### 5.5.2.5.1 General + +The following procedures using the Notify service operation are supported: + +- Notification of changes on the GBA subscriber data + +### 5.5.2.5.2 Notification of changes on the GBA subscriber data + +Figure 5.5.2.5.2-1 shows a scenario where the HSS sends a notification to the GBA BSF to inform of changes on a previously retrieved GBA subscriber data. + +![Sequence diagram showing the notification process between GBA BSF and HSS. The GBA BSF sends a POST request to the HSS. The HSS responds with one of three options: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect.](b5987d63203a5fa601921039922ac520_img.jpg) + +``` + +sequenceDiagram + participant GBA BSF + participant HSS + Note right of HSS: 1. POST {notificationUri} (ModificationNotification) + HSS->>GBA BSF: 2a. 204 No Content + Note right of GBA BSF: 2b. 404 Not Found + Note right of GBA BSF: 2c. 3xx Redirect + +``` + +Sequence diagram showing the notification process between GBA BSF and HSS. The GBA BSF sends a POST request to the HSS. The HSS responds with one of three options: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.5.2.5.2-1: Subscription to changes on of GBA User Security data** + +1. The GBA BSF sends a POST request to the notification URI previously provided by the GBA BSF during the subscription request (see clause 5.5.2.3.1). +- 2a. Upon success, the HSS responds with "204 No Content". +- 2b. If the UE identity contained in the NotificationData is not found in GBA BSF, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). + +In the case of redirection, the GBA BSF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another GBA BSF instance capable of handling the notification request. + +## 5.6 Nhss\_gbaUEAuthentication Service + +### 5.6.1 Service Description + +See 3GPP TS 33.220 [6], clause X.2.1.3. + +### 5.6.2 Service Operations + +#### 5.6.2.1 Introduction + +For the Nhss\_gbaUEAuthentication service the following service operations are defined: + +- Get + +The Nhss\_gbaUEAuthentication Service is used by Consumer NFs (GBA BSF) to: + +- request the authentication data of the UE + +## 5.6.2.2 Get + +### 5.6.2.2.1 General + +The following procedures using the Get service operation are supported: + +- Request UE authentication data + +### 5.6.2.2.2 Request UE authentication data + +Figure 5.6.2.2.2-1 shows a scenario where the GBA BSF sends a request to the HSS to retrieve UE authentication data (authentication vectors) for GBA. The request contains the UE's identity (`{ueId}`) which shall be one of IMSI, MSISDN, IMPI, IMPU. + +![Sequence diagram showing the request for UE authentication data. The GBA BSF sends a POST request to the HSS. The HSS responds with a 200 OK, 403 Forbidden, 404 Not Found, or 3xx Redirect.](8afb16b644b2fe89d5c34251c3e6bf0c_img.jpg) + +``` + +sequenceDiagram + participant GBA BSF + participant HSS + Note right of GBA BSF: 1. POST « ^ueId}/security-information/generate-auth-data +(AuthenticationInfoRequest) + GBA BSF->>HSS: 1. POST request + Note left of HSS: 2a. 200 OK (AuthenticationInfoResult) +2b. 403 Forbidden +2c. 404 Not Found +2d. 3xx Redirect + HSS-->>GBA BSF: Response + +``` + +Sequence diagram showing the request for UE authentication data. The GBA BSF sends a POST request to the HSS. The HSS responds with a 200 OK, 403 Forbidden, 404 Not Found, or 3xx Redirect. + +**Figure 5.6.2.2.2-1: Request UE authentication data** + +1. The GBA BSF sends a POST request (custom method: generate-auth-data) to the HSS. +- 2a. Upon success, the HSS responds with "200 OK" with the AuthenticationInfoResult data structure (containing authentication vectors) in the response body, and HSS supported features. +- 2b. If the operation is not authorized due to, e.g. received UE identity not being allowed for GBA services, or the requesting node not being authorized to fetch the requested data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). +- 2c. If the UE identity is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure). + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 6 API Definitions + +### 6.1 Nhss\_imsUEContextManagement Service API + +#### 6.1.1 Introduction + +URIs of this API shall have the following root: + +`{apiRoot}/{apiName}/{apiVersion}/` + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-ims-uecm" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +## 6.1.2 Usage of HTTP + +### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [8], 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]. + +HTTP messages and bodies for the Nhss\_imsUECM service shall comply with the OpenAPI [9] specification contained in Annex A.2. + +### 6.1.2.2 HTTP standard headers + +#### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [10], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [11]) signalled by the content type "application/problem+json". +- JSON Patch, as defined in IETF RFC 6902 [12], signalled by the content type "application/json-patch+json". + +### 6.1.2.3 HTTP custom headers + +#### 6.1.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.1.3 Resources + +### 6.1.3.1 Overview + +![Figure 6.1.3.1-1: Resource URI structure of the Nhss_imsUECM API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nhss-ims-uecm/v1. It branches into two main paths: one starting with /{imsUeId} which further branches into /scscf-registration and then /scscf-restoration-info; the other starting with /{impu} which branches into /authorize. The /authorize box is dashed.](4cd9eeaee1deb05bf88a8abf02ff7d7f_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-ims-uecm/v1"] --> imsUeId["/{imsUeId}"] + Root --> impu["/{impu}"] + imsUeId --> scscfRegistration["/scscf-registration"] + scscfRegistration --> scscfRestorationInfo["/scscf-restoration-info"] + impu --> authorize["/authorize"] + style authorize stroke-dasharray: 5 5 + +``` + +Figure 6.1.3.1-1: Resource URI structure of the Nhss\_imsUECM API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nhss-ims-uecm/v1. It branches into two main paths: one starting with /{imsUeId} which further branches into /scscf-registration and then /scscf-restoration-info; the other starting with /{impu} which branches into /authorize. The /authorize box is dashed. + +**Figure 6.1.3.1-1: Resource URI structure of the Nhss\_imsUECM API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|-----------------------------------------|------------------------------------------------------|---------------------------------|----------------------------------------------------------| +| SscfRegistration (Document) | /{imsUeId}/scscf-registration | PUT | Create or update the S-CSCF registration state of the UE | +| Authorize (Custom operation) | /{impu}/authorize | authorize (POST) | Authorize the requested operation for the UE | +| Sscf Restoration Information (Document) | /{imsUeId}/scscf-registration/scscf-restoration-info | GET | Retrieve the S-CSCF restoration information. | +| | | PUT | Update the S-CSCF restoration information. | +| | | DELETE | Delete the S-CSCF restoration information. | + +### 6.1.3.2 Resource: Sscf Registration + +#### 6.1.3.2.1 Description + +This resource represents the registered S-CSCF. + +#### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-uecm/{apiVersion}/{imsUeId}/scscf-registration + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| imsUeId | Represents the IMS Subscription Identifier, either the IMS Public Identity (i.e. IMPU or Public PSI) or the Private Identity (i.e. IMPI or PSI). See 3GPP TS 23.228 [6] clause 4.3).
IMS Public Identity is used with the PUT method;
IMS Public Identity or IMS Private Identity is used with the PATCH methods.

Pattern: "^(impu-sip:\{[a-zA-Z0-9 \-\.!~*()&=+\$\,:?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\+\. \+)[a-z]{2,} impu-tel:\+\{0-9\}{5,15} impi-\+\. \+)\$" | + +### 6.1.3.2.3 Resource Standard Methods + +#### 6.1.3.2.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| ScscfRegistration | M | 1 | S-CSCF registration for indicated IMS Public Identity is updated with the received information. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScscfRegistration | M | 1 | 201 Created | A response body containing a representation of the created individual scscfRegistration resource for the received IMS Public Identity shall be returned. | +| ScscfRegistration | M | 1 | 200 OK | A response body containing a representation of the updated individual scscfRegistration resource for the received IMS Public Identity shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ExtendedProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- IDENTITY_ALREADY_REGISTERED In this case include invalidParams with cscfServerName as param and with value of the currently assigned S-CSCF name in the AdditionalInfo
- IDENTITIES_DO_NOT_MATCH
- ERROR_IN_REGISTRATION_TYPE | + +**Table 6.1.3.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 of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.3.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 of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.3.2.3.1-6: 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}/nhss-ims-uecm/{apiVersion}/{imsUeId}/scscf-registration | + +#### 6.1.3.2.4 Resource Custom Operations + +There are no custom operations associated to resources. + +### 6.1.3.3 Resource: Scscf Restoration Information + +#### 6.1.3.3.1 Description + +This resource represents the IMS restoration information. It is queried by the service consumer (S-CSCF) to retrieve the information required for an S-CSCF to handle the requests for a user. + +#### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-uecm/{apiVersion}/{imsUeId}/scscf-registration/scscf-restoration-info + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: " ^ (impu-sip:\{([a-zA-Z0-9_-!~*()&=+;\$,;?V +])@([A-Za-z0-9]+([A-Za-z0-9-]+\.[a-z]{2,} impu-tel:\{[0-9]{5,15} impi-.\{+\})\$" | + +### 6.1.3.3.3 Resource Standard Methods + +#### 6.1.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.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 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScscfRestorationInfoResponse | M | 1 | 200 OK | A response body containing information for the S-CSCF to handle the requests for a user. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that there is no restoration info stored under the scscf-registration resource. | + +**Table 6.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.1.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| SscfRestorationInfoRequest | M | 1 | S-CSCF restoration information for indicated IMS Public Identity is updated with the received information. | + +**Table 6.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SscfRestorationInfoResponse | M | 1 | 201 Created | Upon success, a response body containing a representation of the created individual SscfRestorationInfo resource for the received IMS Public Identity shall be returned. | +| SscfRestorationInfoResponse | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated individual SscfRestorationInfo resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED

NOTE: OPERATION_NOT_ALLOWED indicates the S-CSCF is not allowed to create/update the restoration information. | + +**Table 6.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.3.3.3.2-6: 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}/nhss-ims-uecm/{apiVersion}/{imsUeId}/scscf-registration/scscf-restoration-info | + +### 6.1.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.3.3.3-1. + +**Table 6.1.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.3-2 and the response data structures and response codes specified in table 6.1.3.3.3.3-3. + +**Table 6.1.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | M | 1 | The request body shall be empty. | + +**Table 6.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 | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED

NOTE: OPERATION_NOT_ALLOWED indicates the S-CSCF is not allowed to delete the restoration information stored in the HSS. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that there is no restoration info stored under the scscf-registration resource. | + +**Table 6.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.1.4 Custom Operations without associated resources + +### 6.1.4.1 Overview + +**Table 6.1.4.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|----------------------|--------------------|----------------------------------------------| +| /{impu}/authorize | POST | Authorize the requested operation for the UE | + +### 6.1.4.2 Operation: Authorize + +#### 6.1.4.2.1 Description + +This resource represents the information that is needed to authorize a UE to register or establish sessions in the IMS domain. See 3GPP TS 23.228 [6]. + +#### 6.1.4.2.2 Operation Definition + +This resource shall support the resource URI variables defined in table 6.1.4.2.2-1. + +**Table 6.1.4.2.2-1: URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| impu | Represents the IMS Public Identity (i.e. IMPU or Public PSI). See 3GPP TS 23.228 [6] clause 4.3). | + +This operation shall support the request data structures specified in table 6.1.4.2.2-1 and the response data structure and response codes specified in table 6.1.4.2.2-2. + +**Table 6.1.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| AuthorizationRequest | M | 1 | Contains input for authorization, such as the authorization type or the visited network identifier. | + +**Table 6.1.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| AuthorizationResponse | M | 1 | 200 OK | A response body containing result information or the registered S-CSCF shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- IDENTITY_NOT_REGISTERED | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHORIZATION_REJECTED
- IDENTITIES_DONT_MATCH | + +**Table 6.1.4.2.2-3: 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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.4.2.2-4: 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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.1.5 Notifications + +### 6.1.5.1 General + +### 6.1.5.2 Deregistration Notification + +The POST method shall be used for Deregistration Notifications and the URI shall be as provided during the registration procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.1.5.2-1. + +**Table 6.1.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.1.5.2-2 and of response data structures and response codes is specified in table 6.1.5.2-3. + +**Table 6.1.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|------------------------------------------------------------------| +| DeregistrationData | M | 1 | Includes Deregistration Reason and identities to be deregistered | + +**Table 6.1.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| DeregistrationData | | | 200 OK | Upon success or partial success, DeregistrationData shall be returned including additional information about the result of the procedure. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- CONTEXT_NOT_FOUND | + +**Table 6.1.5.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 notification endpoint of the subscribing NF Service Consumer. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.5.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 notification endpoint of the subscribing NF Service Consumer. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.1.6 Data Model + +### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nhss\_imsUECM service-based interface protocol. + +**Table 6.1.6.1-1: Nhss\_imsUECM specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------------------|----------------|----------------------------------------------------------------------------------------------------------|---------------| +| AuthorizationRequest | 6.1.6.2.2 | Information for the type of authorization requested and the visited PLMN-ID | | +| AuthorizationResponse | 6.1.6.2.3 | Result of the authorization requested for registration. | | +| ScscfRestorationInfo | 6.1.6.2.4 | Information required for an S-CSCF to handle the requests for a user. | | +| ScscfRestorationInfoRequest | 6.1.6.2.5 | Scscf restoration information request. | | +| ScscfRestorationInfoResponse | 6.1.6.2.6 | Result of the scscf restoration information request. | | +| RestorationInfo | 6.1.6.2.7 | Information related to a specific registration required for an S-CSCF to handle the requests for a user. | | +| UeSubscriptionInfo | 6.1.6.2.8 | UE's subscription information. | | +| PscsfSubscriptionInfo | 6.1.6.2.9 | P-CSCF's subscription information. | | +| ScscfRegistration | 6.1.6.2.10 | Registration information of the S-CSCF for the registered UE. | | +| ExtendedProblemDetails | 6.1.6.2.11 | | | +| AdditionalInfo | 6.1.6.2.12 | | | +| DeregistrationData | 6.1.6.2.13 | | | +| DeregistrationReason | 6.1.6.2.14 | | | +| EmergencyRegisteredIdentity | 6.1.6.2.15 | | | + +Table 6.1.6.1-2 specifies data types re-used by the Nhss\_imsUECM 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 Nhss\_imsUECM service-based interface. + +**Table 6.1.6.1-2: Nhss\_imsUECM re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------------------------|---------------------|-----------------------------------------------------------------------------|---------------| +| Uri | 3GPP TS 29.571 [16] | Uniform Resource Identifier | | +| SupportedFeatures | 3GPP TS 29.571 [16] | see 3GPP TS 29.500 [4] clause 6.6 | | +| DateTime | 3GPP TS 29.571 [16] | String with format "date-time" as defined in OpenAPI Specification [9] | | +| ProblemDetails | 3GPP TS 29.571 [16] | Response body of error response messages. | | +| RedirectResponse | 3GPP TS 29.571 [16] | Response body of redirect response messages. | | +| ScscfSelectionAssistanceInformation | 6.2.6.2.51 | This information shall be used by the I-CSCF to select an S-CSCF for the UE | | + +## 6.1.6.2 Structured data types + +### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 6.1.6.2.2 Type: AuthorizationRequest + +**Table 6.1.6.2.2-1: Definition of type AuthorizationRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| authorizationType | AuthorizationType | M | 1 | Contains the type of the authorization requested | | +| impi | Impi | O | 1 | Contains an IMS Private User Identity. It shall be present when the authorization requested is for a registration or de-registration. | | +| visitedNetworkIdentifier | string | O | 1 | Contains the identifier of the visited network where the P-CSCF is located. It shall be present when the authorization requested is for a registration or de-registration. | | + +### 6.1.6.2.3 Type: AuthorizationResponse + +**Table 6.1.6.2.3-1: Definition of type AuthorizationResponse** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| authorizationResult | AuthorizationResult | M | 1 | Contains the details of the granted authorization. | | +| cscfServerName | string | C | 0..1 | Contains the stored S-CSCF name in SIP URI format. It shall be present if there is a S-CSCF name stored for the associated IMS subscription. | | +| sccfSelectionAssistanceInfo | SccfSelectionAssistanceInformation | C | 0..1 | Contains information needed by the I-CSCF to select an S-CSCF for the UE. Shall be present if cscfServerName is absent. | | + +### 6.1.6.2.4 Type: SccfRestorationInfo + +**Table 6.1.6.2.4-1: Definition of type SccfRestorationInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| userName | Uri | O | 0..1 | Registered Private Identity of the user for whom the data is required. If the userName is NULL, it means that an S-CSCF request all registrations for all the private identities registered in the S-CSCF. | | +| restorationInfo | array(RestorationInfo) | O | 0..N | This IE shall contain the information related to a specific registration required for an S-CSCF to handle the requests for a user. | | +| registrationTimeout | DateTime | O | 1 | This IE indicates the point of time at which the UE's registration expires. | | +| sipAuthenticationScheme | SipAuthenticationScheme | O | 1 | This IE indicates the authentication scheme to be used in the authentication of SIP requests. | | + +## 6.1.6.2.5 Type: ScscfRestorationInfoRequest + +**Table 6.1.6.2.5-1: Definition of type ScscfRestorationInfoRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------| +| scscfRestorationInfoRequest | ScscfRestorationInfo | M | 1 | This IE shall contain the information related to a specific registration required for an S-CSCF to handle the requests for the users. | | + +## 6.1.6.2.6 Type: ScscfRestorationInfoResponse + +**Table 6.1.6.2.6-1: Definition of type ScscfRestorationInfoResponse** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| scscfRestorationInfoResponse | array(ScscfRestorationInfo) | M | 1..N | This IE shall contain the response information related to a specific or all registrations required for an S-CSCF. | | + +## 6.1.6.2.7 Type: RestorationInfo + +**Table 6.1.6.2.7-1: Definition of type RestorationInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------|---------------| +| path | string | M | 1 | This IE shall contain a comma separated list of SIP proxies in the Path header. | | +| contact | string | M | 1 | This IE shall contain the Contact Addresses and Parameters in the Contact header. | | +| initialCSeqSequenceNumber | Uint32 | O | 1 | This IE contains the sequence number of the CSeq header field contained in the initial successful REGISTER request. | | +| callIdSipHeader | string | O | 1 | This IE contains the information in the Call-ID header. | | +| uesubscriptionInfo | UeSubscriptionInfo | O | 1 | This IE contains the UE's subscription information. | | +| pcscfSubscriptionInfo | PcscfSubscriptionInfo | O | 1 | This IE contains the P-CSCF's subscription information. | | +| imsSdmSubscriptions | map(ImsSdmSubscription) | O | 1..N | A map (list of key-value pairs where subscriptionId serves as key) of imsSdmSubscriptions. | | + +## 6.1.6.2.8 Type: UeSubscriptionInfo + +**Table 6.1.6.2.8-1: Definition of type UeSubscriptionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| callIdSipHeader | string | M | 1 | This IE contains the information in the Call-ID header. | | +| fromSipHeader | string | M | 1 | This IE shall contain the information in the From header. | | +| toSipHeader | string | M | 1 | This IE shall contain the information in the To header. | | +| recordRoute | string | M | 1 | This IE shall contain a comma separated list of Record Route header(s). | | +| contact | string | M | 1 | This IE shall contain the Contact Addresses and Parameters in the Contact header. | | + +## 6.1.6.2.9 Type: PscfSubscriptionInfo + +**Table 6.1.6.2.9-1: Definition of type PscfSubscriptionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| callIdSipHeader | string | M | 1 | This IE contains the information in the Call-ID header. | | +| fromSipHeader | string | M | 1 | This IE shall contain the information in the From header. | | +| toSipHeader | string | M | 1 | This IE shall contain the information in the To header. | | +| contact | string | M | 1 | This IE shall contain the Contact Addresses and Parameters in the Contact header. | | + +6.1.6.2.10 Type: ScscfRegistration + +**Table 6.1.6.2.10-1: Definition of type ScscfRegistration** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| imsRegistrationType | ImsRegistrationType | M | 1 | Contains the type of the registration/deregistration requested. | | +| impi | Impi | C | 1 | Contains an IMS Private Identity. It may be absent during the originating or terminating request to an unregistered Public Identity (imsRegistrationType shall contain the value UNREGISTERED_USER) | | +| cscfServerName | String | M | 1 | Contains the S-CSCF name in SIP URI format. | | +| cscfInstanceId | NfInstanceId | M | 1 | The NF instance id of the S-CSCF. | | +| deregCallbackUri | Uri | C | 1 |

A URI provided by the S-CSCF to receive (implicitly subscribed) notifications on deregistration. The deregistration callback URI shall have unique information within S-CSCF set to identify the IMS Public Identity to be deregistered.

If there are implicitly identities registered (i.e. the identity belongs to an IRS) in the response, the deregistration callback URI identifies the IRS to be deregistered.

If there is a wildcarded PSI unregistered received in the response, the deregistration callback URI identifies the wildcarded PSI to be deregistered.

| | +| associatedImpis | array(Impi) | O | 1..N | Associated IMS private identities in the subscription. If the IMS subscription contains only single Private Identity this attribute shall not be present.
(NOTE) | | +| associatedRegisteredImpis | array(Impi) | O | 1..N | Associated registered IMS private identities in the subscription.
(NOTE) | | +| irsImpus | array(Impu) | O | 1..N | List of non barred IMS Public User Identities (distinct or wildcarded) which are in the Implicit Registration Set. This attribute shall be present when the received public identity belongs to an IRS.
(NOTE) | | +| wildcardedPui | Impu | O | 1 | It shall be present when the Public Identity in the request fell within the range of a Wildcarded Public User Identity present in the IRS.
(NOTE) | | +| wildcardedPsi | Impu | O | 1 |

It shall be present if the Public Identity in the request fell within the range of a Wildcarded Public Service Identity in the HSS whose state is unregistered.

If this element is present, it shall be used by the S-CSCF to identify the identity affected by the request.
(NOTE)

| | +| looseRouteIndicator | LooseRouteIndication | O | 1 | Loose Routing Indicator
(NOTE) | | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.2.8 | | +| multipleRegistrationIndicator | boolean | C | 1 | Contains the multiple registration indication. If included, when it is set to true it indicates multiple registration. | | + +| | | | | | +|----------------------------------------------------------------|---------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| pcscfRestorationIndicator | boolean | C | 0..1 | true: indicates that the P-CSCF-Restoration-mechanism shall be executed by the HSS.
false or absent: P-CSCF-Restoration is not requested.
May be present if imsRegistrationType is "UNREGISTERED_USER" or "ADMINISTRATIVE_DEREGISTRATION"; otherwise shall be absent. | +| scscfReselectionIndicator | boolean | C | 0..1 | true: indicates that the S-CSCF has been selected due to, e.g. failure of the previously assigned S-CSCF.
false or absent: no S-CSCF reselection requested | +| NOTE: Optional attribute applicable in response messages only. | | | | | + +#### 6.1.6.2.11 Type: ExtendedProblemDetails + +**Table 6.1.6.2.11-1: Definition of type ExtendedProblemDetails** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|-------------------------------------------------------------------------------------------------------------| +| problemDetails | ProblemDetails | M | 1 | More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure. | +| additionalInfo | AdditionalInfo | O | 1 | Contains the currently assigned S-CSCF name in SIP URI format. | + +#### 6.1.6.2.12 Type: AdditionalInfo + +**Table 6.1.6.2.12-1: Definition of type AdditionalInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------| +| scscfServerName | String | O | 1 | Current S-CSCF assigned to the user (in SIP URI format). This attribute shall be included when "cause" is IDENTITY_ALREADY_REGISTERED. | + +#### 6.1.6.2.13 Type: DeregistrationData + +**Table 6.1.6.2.13-1: Definition of type DeregistrationData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| deregReason | DeregistrationReason | M | 1 | Indicates the reason for the deregistration. | | +| impi | Impi | M | 1 | Contains the IMS Private User Identity known by the S-CSCF. | | +| associatedImpis | Array(Impi) | O | 0..N | Associated IMS private Identities in the subscription that are deregistered.

This attribute may be present in responses, otherwise, it shall be absent. | | +| emergencyRegisteredIdentities | array(EmergencyRegisteredIdentity) | O | 1..N | A list of pairs of private and public user identities which have not been deregistered due to emergency registration.

This attribute may be present in responses, otherwise, it shall be absent. | | + +#### 6.1.6.2.14 Type: DeregistrationReason + +**Table 6.1.6.2.14-1: Definition of type DeregistrationReason** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|----------------------------------------------------------------------------------------|---------------| +| reasonCode | DeregistrationReasonCode | M | 1 | Defines the reason for the network initiated de-registration | | +| reasonText | string | O | 0..1 | Contains textual information to inform the user about the reason for a de-registration | | + +#### 6.1.6.2.15 Type: EmergencyRegisteredIdentity + +**Table 6.1.6.2.15-1: Definition of type EmergencyRegisteredIdentity** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|---------------------------|---------------| +| impi | Impi | M | 1 | IMS Private User Identity | | +| impu | Impu | M | 1 | IMS Public User Identity | | + +### 6.1.6.3 Simple data types and enumerations + +#### 6.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. + +#### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|---------------------------------------|---------------| +| Impu | string | Contains an IMS Public Identity | | +| Impi | string | Contains an IMS Private User Identity | | + +#### 6.1.6.3.3 Enumeration: AuthorizationType + +The enumeration AuthorizationType represents the type of authorization requested. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration AuthorizationType** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------------------------|---------------| +| "REGISTRATION" | The authorization requested if for a user's IMS registration or re-registration. | | +| "DEREGISTRATION" | The authorization requested if for a user's IMS de-registration. | | + +#### 6.1.6.3.4 Enumeration: AuthorizationResult + +The enumeration AuthorizationResult represents the details of the granted authorization. It shall comply with the provisions defined in table 6.1.6.3.4-1. + +**Table 6.1.6.3.4-1: AuthorizationResult** + +| Enumeration value | Description | +|---------------------------|---------------------------------------------------------------------------------| +| "FIRST_REGISTRATION" | The registration is an initial registration for the IMS Public User Identity | +| "SUBSEQUENT_REGISTRATION" | The registration is an subsequent registration for the IMS Public User Identity | + +#### 6.1.6.3.5 Enumeration: ImsRegistrationType + +The enumeration ImsRegistrationType represents the type of registration associated to the REGISTER request. + +**Table 6.1.6.3.5-1: Enumeration ImsRegistrationType** + +| Enumeration value | Description | Applicability | +|---------------------------------|----------------------------------------------------------------------------------------------------------------|---------------| +| "INITIAL_REGISTRATION" | The request is related to an initial registration | | +| "RE_REGISTRATION" | The request is related to a re-registration | | +| "TIMEOUT_DEREGISTRATION" | The registration timer of an identity has expired. | | +| "USER_DEREGISTRATION" | The S-CSCF has received a user initiated de-registration request | | +| "ADMINISTRATIVE_DEREGISTRATION" | The S-CSCF, due to administrative reasons or network issues, has performed the de-registration of an identity. | | +| "AUTHENTICATION_FAILURE" | The authentication of a user has failed. | | +| "AUTHENTICATION_TIMEOUT" | Authentication timeout has occurred. | | +| "UNREGISTERED_USER" | The request is related to a request for a Public Identity that is not registered. | | + +#### 6.1.6.3.6 Enumeration: LooseRouteIndication + +The enumeration LooseRouteIndication represents whether the "loose routing" mechanism is required, or not, to serve the user. + +**Table 6.1.6.3.6-1: Enumeration LooseRouteIndication** + +| Enumeration value | Description | Applicability | +|----------------------------|------------------------------------------------------------------------|---------------| +| "LOOSE_ROUTE_NOT_REQUIRED" | Indicates that strict routing mechanism is required to serve the user. | | +| "LOOSE_ROUTE_REQUIRED " | Indicates that loose routing mechanism is required to serve the user. | | + +#### 6.1.6.3.7 Enumeration: DeregistrationReasonCode + +The enumeration DeregistrationReasonCode indicates the reason for the network initiated de-registration. + +**Table 6.1.6.3.7-1: Enumeration DeregistrationReasonCode** + +| Enumeration value | Description | Applicability | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "PERMANENT_TERMINATION" | The HSS indicates to the S-CSCF that the S-CSCF will no longer be assigned to the Public Identity and associated implicitly registered/unregistered Public Identities (if any) for the Private Identity(ies) indicated in the request (e.g. due to an IMS subscription cancellation, or modification, or a removal of IP-address secure binding information when GIBA is used). | | +| "NEW_SERVER_ASSIGNED" | The HSS indicates to the S-CSCF that a new S-CSCF has been allocated to the IMS Subscription e.g. because the previous assigned S-CSCF was unavailable during a registration procedure. The S-CSCF shall remove all information for all of the Public Identities indicated in the request. | | +| "SERVER_CHANGE" | The HSS indicates to the S-CSCF that the de-registration is requested to force the selection of new S-CSCF to assign to the IMS Subscription (e.g. when the S-CSCF capabilities are changed in the HSS or when the S-CSCF indicates that it has not enough memory for the updated User Profile). If the S-CSCF does not indicate in the response all the associated Private Identities, the HSS shall repeat this request for each of the remaining Private Identities in the IMS Subscription that are known to the S-CSCF. The S-CSCF should start the network initiated de-registration towards the user, i.e. all registrations within the IMS Subscription are de-registered and the user is asked to re-register to all existing registrations. | | +| "REMOVE_S-CSCF" | The HSS indicates to the S-CSCF that the S-CSCF will no longer be assigned to an unregistered Public Identity(ies) (i.e registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored) for a given IMS Subscription. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There are no alternative data types, neither combinations of data types + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_imsUECM service. The following application errors listed in Table 6.1.7.3-1 are specific for the Nhss\_imsUECM service. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The received IMS UE identity is unknown. | +| CONTEXT_NOT_FOUND | 404 Not Found | The context identified by the callback reference is not found | +| IDENTITIES_DO_NOT_MATCH | 403 Forbidden | A message was received with a public identity and a private identity for a user, and the server determines that the public identity does not correspond to the private identity. | +| ERROR_IN_REGISTRATION_TYPE | 403 Forbidden | The requested registrationType is not allowed or the Public Identity type received in the request is not allowed for the requested registrationType. | +| IDENTITY_ALREADY_REGISTERED | 403 Forbidden | The identity has already a server assigned, and the registration information cannot be overwritten. | + +## 6.1.8 Feature negotiation + +The optional features in Table 6.1.8-1 are defined for the Nhss\_imsUEContextManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.1.9 Security + +As indicated in 3GPP TS 33.501 [5], the access to the Nhss\_imsUECM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [35]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [36]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_imsUECM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [36], 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 Nhss\_imsUECM service. + +The Nhss\_imsUECM API defines the following scopes for OAuth2 authorization: + +**Table 6.1.9-1: OAuth2 scopes defined in Nhss\_imsUECM API** + +| Scope | Description | +|-------------------------------------|----------------------------------------------------------------| +| "nhss-ims-uecm" | Access to the Nhss IMS UE Context Management API | +| "nhss-ims-uecm:authorize:invoke" | Access to invoke the Authorize custom operation | +| "nhss-ims-uecm:registration:create" | Access to create S-CSCF Registration resources | +| "nhss-ims-uecm:restoration:read" | Access to read the S-CSCF Restoration resource | +| "nhss-ims-uecm:restoration:modify" | Access to create/update/delete the S-CSCF Restoration resource | + +## 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# 6.2 Nhss\_imsSubscriberDataManagement Service API + +## 6.2.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion}/ + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-ims-sdm" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +## 6.2.2 Usage of HTTP + +### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [8], 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]. + +HTTP messages and bodies for the Nhss\_imsSubscriberDataManagement service shall comply with the OpenAPI [9] specification contained in Annex A.3. + +### 6.2.2.2 HTTP standard headers + +#### 6.2.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [10], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [11]) signalled by the content type "application/problem+json" +- JSON Patch, as defined in IETF RFC 6902 [12], signalled by the content type "application/json-patch+json" + +### 6.2.2.3 HTTP custom headers + +#### 6.2.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.2.3 Resources + +### 6.2.3.1 Overview + +![A hierarchical tree diagram showing the resource URI structure of the Nhss_imsSDM API. The root is {apiRoot}/nhss-ims-sdm/v1. It branches into /{imsUeld}, /repository-data, /identities, /ims-data, and /subscriptions. /repository-data has a sub-branch /{serviceIndication}. /identities has sub-branches /ims-associated-identities, /msisdns, /private-identities, and /imeiSv. /ims-data has sub-branches /profile-data, /location-data (dashed box), and /registration-status. /profile-data has sub-branches /ifcs, /service-level-trace-info, /priority-levels, and /charging-info. /location-data has sub-branches /server-name, /scscf-capabilities, and /scscf-selection-assistance-info. /subscriptions has a sub-branch /{subscriptionId}.](4a390493f601ce1ac6b9201db4e28b5a_img.jpg) + +``` +graph TD; Root["{apiRoot}/nhss-ims-sdm/v1"] --- IMSUeld["/{imsUeld}"]; Root --- RepositoryData["/repository-data"]; Root --- Identities["/identities"]; Root --- IMSData["/ims-data"]; Root --- Subscriptions["/subscriptions"]; RepositoryData --- ServiceIndication["/{serviceIndication}"]; Identities --- IMSAssociatedIdentities["/ims-associated-identities"]; Identities --- MSISDNs["/msisdns"]; Identities --- PrivateIdentities["/private-identities"]; Identities --- IMEISV["/imeiSv"]; IMSData --- ProfileData["/profile-data"]; IMSData --- LocationData["/location-data"]; IMSData --- RegistrationStatus["/registration-status"]; ProfileData --- IFCS["/ifcs"]; ProfileData --- ServiceLevelTraceInfo["/service-level-trace-info"]; ProfileData --- PriorityLevels["/priority-levels"]; ProfileData --- ChargingInfo["/charging-info"]; LocationData --- ServerName["/server-name"]; LocationData --- SCSCFCapabilities["/scscf-capabilities"]; LocationData --- SCSCFSelectionAssistanceInfo["/scscf-selection-assistance-info"]; Subscriptions --- SubscriptionId["/{subscriptionId}"]; +``` + +A hierarchical tree diagram showing the resource URI structure of the Nhss\_imsSDM API. The root is {apiRoot}/nhss-ims-sdm/v1. It branches into /{imsUeld}, /repository-data, /identities, /ims-data, and /subscriptions. /repository-data has a sub-branch /{serviceIndication}. /identities has sub-branches /ims-associated-identities, /msisdns, /private-identities, and /imeiSv. /ims-data has sub-branches /profile-data, /location-data (dashed box), and /registration-status. /profile-data has sub-branches /ifcs, /service-level-trace-info, /priority-levels, and /charging-info. /location-data has sub-branches /server-name, /scscf-capabilities, and /scscf-selection-assistance-info. /subscriptions has a sub-branch /{subscriptionId}. + +Figure 6.2.3.1-1: Resource URI structure of the Nhss\_imsSDM API + +![A hierarchical tree diagram showing the Resource URI structure of the Nhss_imsSDM API. The root is {apiRoot}/nhss-ims-sdm/v1. It branches into /{imsUeId}, /shared-data, /shared-data-subscriptions, /access-data, /srvcc-data, and /service-data. /{imsUeId} further branches into /ps-domain, /cs-domain, /wireline-domain, /srvcc-data, and /service-data. /ps-domain branches into /user-state, /location-data, /tads-info, /ip-address, and /ue-reach-subscriptions. /ue-reach-subscriptions branches into /{subscriptionId}. /cs-domain branches into /user-state, /location-data, and /csrn. /wireline-domain branches into /reference-location. /shared-data branches into /{sharedDataId}. /shared-data-subscriptions branches into /{subscriptionId}. /service-data branches into /psi-status, /dsai, and /sms-registration-info.](c07e21a8d65991db04263322f859c94f_img.jpg) + +``` +graph TD; Root["{apiRoot}/nhss-ims-sdm/v1"]; Root --- IMS["/{imsUeId}"]; Root --- SharedData["/shared-data"]; Root --- SharedDataSubscriptions["/shared-data-subscriptions"]; Root --- AccessData["/access-data"]; Root --- SrvccData["/srvcc-data"]; Root --- ServiceData["/service-data"]; IMS --- PS["/ps-domain"]; IMS --- CS["/cs-domain"]; IMS --- Wireline["/wireline-domain"]; IMS --- SrvccData2["/srvcc-data"]; IMS --- ServiceData2["/service-data"]; PS --- PS_US["/user-state"]; PS --- PS_LD["/location-data"]; PS --- PS_TI["/tads-info"]; PS --- PS_IP["/ip-address"]; PS --- PS_URS["/ue-reach-subscriptions"]; PS_URS --- PS_URS_S["/{subscriptionId}"]; CS --- CS_US["/user-state"]; CS --- CS_LD["/location-data"]; CS --- CS_C["/csrn"]; Wireline --- Wireline_RL["/reference-location"]; SharedData --- SD_S["/{sharedDataId}"]; SharedDataSubscriptions --- SDS_S["/{subscriptionId}"]; ServiceData --- SDAT_P["/psi-status"]; ServiceData --- SDAT_D["/dsai"]; ServiceData --- SDAT_S["/sms-registration-info"]; +``` + +A hierarchical tree diagram showing the Resource URI structure of the Nhss\_imsSDM API. The root is {apiRoot}/nhss-ims-sdm/v1. It branches into /{imsUeId}, /shared-data, /shared-data-subscriptions, /access-data, /srvcc-data, and /service-data. /{imsUeId} further branches into /ps-domain, /cs-domain, /wireline-domain, /srvcc-data, and /service-data. /ps-domain branches into /user-state, /location-data, /tads-info, /ip-address, and /ue-reach-subscriptions. /ue-reach-subscriptions branches into /{subscriptionId}. /cs-domain branches into /user-state, /location-data, and /csrn. /wireline-domain branches into /reference-location. /shared-data branches into /{sharedDataId}. /shared-data-subscriptions branches into /{subscriptionId}. /service-data branches into /psi-status, /dsai, and /sms-registration-info. + +Figure 6.2.3.1-2: Resource URI structure of the Nhss\_imsSDM API + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name
(Archetype) | Resource URI | HTTP method or
custom operation | Description | +|-------------------------------------------------------|------------------------------------------------------------------|------------------------------------|--------------------------------------------------------------------------| +| Repository Data
(Document) | /{imsUId}/repository-data/
{serviceIndication} | GET | Retrieve repository data for a service indication | +| | | DELETE | Delete repository data for a service indication | +| | | PUT | Update repository data for a service indication | +| Repository Data List
(Document) | /{imsUId}/repository-data | GET | Retrieve multiple repository data for a list of service indications | +| IMS Associated Identities
(Document) | /{imsUId}/identities/ims-associated-identities | GET | Retrieve the UE's IMS associated identities (implicit and alias) | +| MSISDNs
(Document) | /{imsUId}/identities/msisdns | GET | Retrieve the UE's MSISDNs (basic and additional) | +| PrivateIdentities
(Document) | /{imsUId}/identities/private-identities | GET | Retrieve the UE's Private Identities (IMPI and IMSI) | +| ImeiSvnInformation
(Document) | /{imsUId}/identities/imeisv | GET | Retrieve the UE's IMEISV | +| IMS Profile Data
(Document) | /{imsUId}/ims-data/profile-data | GET | Retrieve the UE's subscribed Profile | +| Initial Filter Criteria
(Document) | /{imsUId}/ims-data/profile-data/ifcs | GET | Retrieve the UE's subscribed Initial Filter Criteria | +| Service Level Trace Information
(Document) | /{imsUId}/ims-data/profile-data/service-level-trace-info | GET | Retrieve the UE's subscribed Service Level Trace Information | +| Service Priority Information
(Document) | /{imsUId}/ims-data/profile-data/priority-levels | GET | Retrieve the UE's subscribed Service Priority Levels | +| Charging Information
(Document) | /{imsUId}/ims-data/profile-data/chargingInfo | GET | Retrieve the UE's subscribed Charging Information | +| IMS Location Data
(Document) | /{imsUId}/ims-data/location-data/server-name | GET | Retrieve the UE's S-CSCF name | +| S-CSCF Capabilities
(Document) | /{imsUId}/ims-data/location-data/scscf-capabilities | GET | Retrieve the UE's S-CSCF capabilities (mandatory and/or optional) | +| S-CSCF Selection Assistance Information
(Document) | /{imsUId}/ims-data/location-data/scscf-selection-assistance-info | GET | Retrieve the UE's S-CSCF Selection Assistance Information | +| IMS Registration Status
(Document) | /{imsUId}/ims-data/registration-status | GET | Retrieve the UE's IMS registration status. | +| Subscriptions
(Collection) | /{imsUId}/subscriptions | POST | Create a subscription | +| Individual subscription
(Document) | /{imsUId}/subscriptions/
{subscriptionId} | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | +| | | PATCH | Modify the sdm-subscription identified by {subscriptionId} | + +| | | | | +|---------------------------------------------------|-------------------------------------------------------------------------|--------|----------------------------------------------------------------------------------------------------| +| PS Location Information(Document) | /{imsUId}/access-data/ps-domain/location-data | GET | Retrieve the UE's location in PS domain | +| CS Location Information(Document) | /{imsUId}/access-data/cs-domain/location-data | GET | Retrieve the UE's location in CS domain | +| PsUserState(Document) | /{imsUId}/access-data/ps-domain/user-state | GET | Retrieve the UE's state in PS domain | +| CsUserState(Document) | /{imsUId}/access-data/cs-domain/user-state | GET | Retrieve the UE's state in CS domain | +| TadsInfo(Document) | /{imsUId}/access-data/ps-domain/tads-info | GET | Retrieve the UE's T-ADS information | +| UeReachabilityIpSubscriptions(Collection) | /{imsUId}/access-data/ps-domain/ue-reach-subscriptions | POST | Create a subscription to UE Reachability for IP | +| UE reachability individual subscription(Document) | /{imsUId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId} | DELETE | Delete the subscription to UE reachability for IP identified by {subscriptionId}, i.e. unsubscribe | +| | | PATCH | Modify the subscription to UE reachability for IP identified by {subscriptionId} | +| IpAddress(Document) | /{imsUId}/access-data/ps-domain/ip-address | GET | Retrieve the UE's stored IP Address Secure Binding Information | +| Csrn(Document) | /{imsUId}/access-data/cs-domain/csrn | GET | Retrieve a CSRN for the UE | +| ReferenceAccessLocation(Document) | /{imsUId}/access-data/wireline-domain/reference-location | GET | Retrieve the UE's subscribed Reference Access Location | +| SRVCC Data(Document) | /{imsUId}/srvcc-data | GET | Retrieve the UE's STN-SR and SRVCC capability | +| | | PATCH | Update the UE's STN-SR. | +| PSI Activation State(Document) | /{imsUId}/service-data/psi-status | GET | Retrieve a PSI activation status | +| | | PATCH | Update a PSI activation status | +| Dsai(Document) | /{imsUId}/service-data/dsai | GET | Retrieve DSAI data (i.e. DSAI tags and status) associated to an Application Server | +| | | PATCH | Update DSAI data associated to an Application Server | +| SMSRegistrationInfo(Document) | /{imsUId}/service-data/sms-registration-info | GET | Retrieve the SMS Registration Information (e.g. IP-SM-GW address) | +| | | PUT | Creates or updates the SMS Registration Information (e.g. IP-SM-GW address) | +| | | DELETE | Deletes the SMS Registration Information (e.g. IP-SM-GW address) | +| SharedData(Collection) | /shared-data | GET | Retrieve shared data | +| SharedDataSubscriptions(Collection) | /shared-data-subscriptions | POST | Create a subscription | +| Shared Data Individual Subscription(Document) | /shared-data-subscriptions/{subscriptionId} | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | +| | | PATCH | Modify the subscription identified by {subscriptionId} | + +### 6.2.3.2 Resource: IMS Associated Identities + +#### 6.2.3.2.1 Description + +This resource represents the IMS associated identities. It is queried by the service consumer (IMS-AS) to retrieve the list of identities in the same Implicit Registration Set, together with the Alias Group Information and additional information (e.g. identity type) + +### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/identities/ims-associated-identities + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: " ^(impu-sip:\{[a-zA-Z0-9\_\.!~*()&=+\$,;?V]+\})\@([A-Za-z0-9]+\{[-A-Za-z0-9]+\})\.\.[a-z]{2,}\ impu-tel:\.\+[0-9]{5,15}\ impi-\.\+\.\+\)" | + +### 6.2.3.2.3 Resource Standard Methods + +#### 6.2.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ImAssociatedIdentities | M | 1 | 200 OK | A response body containing the list of identities belonging to the same Implicit Registration Set shall be returned, together with the related information (Alias Group, if any, identity type, IRS default identity, registration state of the IRS). | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.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 of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.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 of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.3 Resource: MSISDNS + +### 6.2.3.3.1 Description + +This resource represents the MSISDNs associated to the UE. It is queried by the service consumer (IMS-AS) to retrieve the list of MSISDNs (basic and additional). If the UE is shared among multiple IMS Private Identities and the consumer queries for the basic MSISDN (C-MSISDN), the URI query parameter Private Identity (IMPI) shall be included. + +### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/identities/msisdns + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: "^(impu-sip:\{[a-zA-Z0-9 \-\.!~*()\&=+\$,;:?\V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impn-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} impn-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} )" | + +### 6.2.3.3.3 Resource Standard Methods + +#### 6.2.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-id | PrivateId | O | 0..1 | IMS Private Identity (IMPI) of the UE. It shall be included if there are multiple Private Identities associated to the Public Identity received and the basic MSISDN (C-MSISDN) is requested. | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.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 6.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MsisdnList | M | 1 | 200 OK | A response body containing the list of MSISDNs associated to the UE and all Private Identities shall be returned. If the response is for a basic MSISDN (C-MSISDN) query (query parameter IMPI was present), only one MSISDN shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.4 Resource: S-CSCF Capabilities + +### 6.2.3.4.1 Description + +This resource represents the S-CSCF capabilities. It is queried by the service consumer (I-CSCF) to retrieve S-CSCF capabilities associated to the UE (mandatory capabilities and/or optional capabilities). + +#### 6.2.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/location-data/scscf-capabilities + +This resource shall support the resource URI variables defined in table 6.2.3.4.2-1. + +**Table 6.2.3.4.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:([a-zA-Z0-9_\-\.!~*()&=+\$,:;?V]+)@([A-Za-z0-9]+([-A-Za-z0-9+]+\.)+)[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$" | + +#### 6.2.3.4.3 Resource Standard Methods + +**6.2.3.4.3.1 GET** + +This method shall support the URI query parameters specified in table 6.2.3.4.3.1-1. + +**Table 6.2.3.4.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.4.3.1-2 and the response data structures and response codes specified in table 6.2.3.4.3.1-3. + +**Table 6.2.3.4.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.4.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScscfCapabilityList | M | 1 | 200 OK | A response body containing the list mandatory and/or optional capabilities shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found |

The "cause" attribute may be used to indicate one of the following application errors:

  • - USER_NOT_FOUND
  • - DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that any S-CSCF can be selected, e.g. based on I-CSCF local policy.

| +| ProblemDetails | O | 0..1 | 403 Forbidden |

The "cause" attribute may be used to indicate the following application error:

  • - OPERATION_NOT_ALLOWED
| + +**Table 6.2.3.4.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.4.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.5 Resource: IMS Profile Data + +#### 6.2.3.5.1 Description + +This resource represents the IMS Profile Data. It is queried by the service consumer (S-CSCF) to retrieve the user's IMS profile data, containing the required information to handle the multimedia sessions (e.g. Initial Filter Criteria) + +### 6.2.3.5.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data** + +This resource shall support the resource URI variables defined in table 6.2.3.5.2-1. + +**Table 6.2.3.5.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-\.\!~*'( )&=+\$,;?V/]+)@([A-Za-z0-9]+([-A-Za-z0-9]+\.)+[a-z]{2,}) impu-tel\:\+[0-9]{5,15} impi-.* .+)\$"

| + +### 6.2.3.5.3 Resource Standard Methods + +#### 6.2.3.5.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.5.3.1-1. + +NOTE: The retrieval of these data sets can also be achieved by sending individual GET requests to the corresponding sub-resources under the {imsUeId} resource. When multiple data sets need to be retrieved by the NF Service consumer, it is recommended to use a single GET request with query parameters rather than issuing multiple GET requests. + +**Table 6.2.3.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|-----------------------------------| +| dataset-names | array(DataSetName) | O | 1..N | Datasets to be retrieved | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.5.3.1-2 and the response data structures and response codes specified in table 6.2.3.5.3.1-3. + +**Table 6.2.3.5.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.5.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------| +| lmsProfileData | M | 1 | 200 OK | Upon success, a response body containing the User's Profile Data shall be included. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.5.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.5.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.6 Resource: Subscriptions + +#### 6.2.3.6.1 Description + +This resource is used to represent subscriptions to notifications of data change. + +#### 6.2.3.6.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/subscriptions** + +This resource shall support the resource URI variables defined in table 6.2.3.6.2-1. + +**Table 6.2.3.6.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-\.!~*()&=+\$,;?V]+)\@([A-Za-z0-9]+\-[A-Za-z0-9]+\.)+[a-z]{2,} impu-tel\:\+[0-9]{5,15} impi\-.+)\$"

| + +#### 6.2.3.6.3 Resource Standard Methods + +##### 6.2.3.6.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.6.3.1-1. + +**Table 6.2.3.6.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.6.3.1-2 and the response data structures and response codes specified in table 6.2.3.6.3.1-3. + +**Table 6.2.3.6.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------| +| ImsSdmSubscription | M | 1 | The subscription that is to be created. | + +**Table 6.2.3.6.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lmsSdmSubscription | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate the following application error:
- UNSUPPORTED_RESOURCE_URI

This response shall not be cached. | + +**Table 6.2.3.6.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.6.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.6.3.1-6: 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}/nhss-im-sdm//imsUeId/subscription s/{subscriptionId} | + +## 6.2.3.7 Resource: Individual subscription + +### 6.2.3.7.1 Description + +This resource is used to represent an individual subscription to notifications of data change. + +### 6.2.3.7.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.7.2-1. + +**Table 6.2.3.7.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[.+\+])\$" | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications. | + +### 6.2.3.7.3 Resource Standard Methods + +#### 6.2.3.7.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.7.3.1-1. + +**Table 6.2.3.7.3.1-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 6.2.3.7.3.1-2 and the response data structures and response codes specified in table 6.2.3.7.3.1-3. + +**Table 6.2.3.7.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.7.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.2.3.7.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.7.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.7.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.7.3.2-1. + +**Table 6.2.3.7.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.7.3.2-2 and the response data structures and response codes specified in table 6.2.3.7.3.2-3. + +**Table 6.2.3.7.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12]. | + +**Table 6.2.3.7.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with no content is returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate the following application error:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.7.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.7.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.8 Resource: SharedDataSubscriptions + +### 6.2.3.8.1 Description + +This resource is used to represent subscriptions to notifications for shared data. + +### 6.2.3.8.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/shared-data-subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.8.2-1. + +**Table 6.2.3.8.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | + +### 6.2.3.8.3 Resource Standard Methods + +#### 6.2.3.8.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.8.3.1-1. + +**Table 6.2.3.8.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.8.3.1-2 and the response data structures and response codes specified in table 6.2.3.8.3.1-3. + +**Table 6.2.3.8.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------| +| lmsSdmSubscription | M | 1 | The subscription that is to be created. | + +**Table 6.2.3.8.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lmsSdmSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate the following application error:
- UNSUPPORTED_RESOURCE_URI

This response shall not be cached. | + +**Table 6.2.3.8.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.8.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.8.3.1-6: 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}/nhss-ims-sdm//shared-data-subscriptions/{subscriptionId} | + +## 6.2.3.9 Resource: Shared Data Individual subscription + +### 6.2.3.9.1 Description + +This resource is used to represent an individual subscription to notifications for shared data. + +### 6.2.3.9.2 Resource Definition + +Resource URI: {apiRoot}/nhss-sdm/{apiVersion}/shared-data-subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.9.2-1. + +**Table 6.2.3.9.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|----------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications. | + +### 6.2.3.9.3 Resource Standard Methods + +#### 6.2.3.9.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.9.3.1-1. + +**Table 6.2.3.9.3.1-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 6.2.3.zz.3.1-2 and the response data structures and response codes specified in table 6.2.3.zz.3.1-3. + +**Table 6.2.3.9.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.9.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The resource corresponding to the SubscriptionId can't be found.

The "cause" attribute may be used to indicate the following application error:
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.2.3.9.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.9.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.9.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.9.3.2-1. + +**Table 6.2.3.9.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.9.3.2-2 and the response data structures and response codes specified in table 6.2.3.9.3.2-3. + +**Table 6.2.3.9.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12]. | + +**Table 6.2.3.9.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with no content is returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The resource corresponding to the SubscriptionId can't be found.

The "cause" attribute may be used to indicate the following application error:
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate the following application error:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.9.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.9.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.10 Resource: IMS Registration Status + +### 6.2.3.10.1 Description + +This resource represents the IMS Registration Status. It is queried by the service consumer (e.g. AS) to retrieve the IMS registration status of the user. + +### 6.2.3.10.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/registration-status + +This resource shall support the resource URI variables defined in table 6.2.3.10.2-1. + +**Table 6.2.3.10.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: "^(impu-sip:\{[a-zA-Z0-9\_\.!~*()&=+\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\{+[0-9]{5,15} impi-\.[.]+\})\$" | + +### 6.2.3.10.3 Resource Standard Methods + +#### 6.2.3.10.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.10.3.1-1. + +**Table 6.2.3.10.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.10.3.1-2 and the response data structure and response codes specified in table 6.2.3.10.3.1-3. + +**Table 6.2.3.10.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.10.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ImRegistrationStatus | M | 1 | 200 OK | A response body containing the IMS registration status of the user. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates the user has not performed yet any IMS registration. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.10.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.10.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.11 Resource: Service Priority Information + +#### 6.2.3.11.1 Description + +This resource represents the Service Priority Levels. It is queried by the service consumer (e.g. AS) to retrieve the Namespaces and priority levels allowed for the user. + +### 6.2.3.11.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data/priority-levels** + +This resource shall support the resource URI variables defined in table 6.2.3.11.2-1. + +**Table 6.2.3.11.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-\.\!~*'()&=+\$,;?V/]+)@([A-Za-z0-9]+([-A-Za-z0-9]+\.)+[a-z]{2,} impu-tel\:\+[0-9]{5,15} impi-.+) .+)\$"

| + +### 6.2.3.11.3 Resource Standard Methods + +#### 6.2.3.11.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.11.3.1-1. + +**Table 6.2.3.11.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.11.3.1-2 and the response data structures and response codes specified in table 6.2.3.11.3.1-3. + +**Table 6.2.3.11.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 6.2.3.11.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PriorityLevels | M | 1 | 200 OK | A response body containing the service priority information (priority namespaces and associated levels) allowed for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user does not have priority service. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.11.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.11.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.12 Resource: Initial Filter Criteria + +### 6.2.3.12.1 Description + +This resource represents the Initial Filter Criteria (IFCs). It is queried by the service consumer (e.g. S-CSCF, AS) to retrieve the list of IFCs associated to the UE (including Shared IFC Set Identifiers, if provisioned). + +### 6.2.3.12.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data/ifcs + +This resource shall support the resource URI variables defined in table 6.2.3.12.2-1. + +**Table 6.2.3.12.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: " ^ (impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\}@([A-Za-z0-9]+([-A-Za-z0-9]+\.)+[a-z]{2,} impu-tel:\{+[0-9]{5,15}impi-\.+\})\$" | + +## 6.2.3.12.3 Resource Standard Methods + +### 6.2.3.12.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.12.3.1-1. + +**Table 6.2.3.12.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-------------------|---|-------------|------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| application-server-name | SipServerName | O | 0..1 | This information element indicates application server's SIP URI. | | + +This method shall support the request data structures specified in table 6.2.3.12.3.1-2 and the response data structures and response codes specified in table 6.2.3.12.3.1-3. + +**Table 6.2.3.12.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.12.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lfcs | M | 1 | 200 OK | A response body containing the list of complete IFCs and/or shared IFC set identifiers shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that there is no Initial Filter Criteria associated to the user (i.e. no AS is triggered by S-CSCF for the user) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.12.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.12.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.13 Resource: IMS Location Data + +### 6.2.3.13.1 Description + +This resource represents the IMS location data. It is queried by the service consumer (e.g. AS) to retrieve the S-CSCF name stored for the user. + +### 6.2.3.13.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/location-data/server-name** + +This resource shall support the resource URI variables defined in table 6.2.3.13.2-1. + +**Table 6.2.3.13.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^ (impu-sip :([a-zA-Z0-9_\-.!~*'()&=+\$,;?V]+)@([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel :\+[0-9]{5,15} impi-.+)\$" | + +### 6.2.3.13.3 Resource Standard Methods + +### 6.2.3.13.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.13.3.1-1. + +**Table 6.2.3.13.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.13.3.1-2 and the response data structure and response codes specified in table 6.2.3.13.3.1-3. + +**Table 6.2.3.13.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 6.2.3.13.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ImsLocationData | M | 1 | 200 OK | A response body containing the S-CSCF name stored for the user. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates the user has not performed yet any IMS registration. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.13.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.13.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.14 Resource: Service Level Trace Information + +### 6.2.3.14.1 Description + +This resource represents the Service Level Trace Information. It is queried by the service consumer (e.g. AS) to retrieve the Trace Level information so that the consumer can perform logging for the user as described in IETF RFC 8497 [23]. + +### 6.2.3.14.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data/service-trace-level-information + +This resource shall support the resource URI variables defined in table 6.2.3.14.2-1. + +**Table 6.2.3.14.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^ (impu-sip:([a-zA-Z0-9_\-.!~*()&=+\$;,?V]+)@([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$" | + +### 6.2.3.14.3 Resource Standard Methods + +#### 6.2.3.14.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.14.3.1-1. + +**Table 6.2.3.14.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.14.3.1-2 and the response data structures and response codes specified in table 6.2.3.14.3.1-3. + +**Table 6.2.3.14.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.14.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceLevelTraceInformation | M | 1 | 200 OK | A response body containing the IMS service level trace information shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the service level tracing is disabled for the user. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.14.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.14.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.15 Resource: PS location Information + +### 6.2.3.15.1 Description + +This resource represents the Location Information in PS domain. It is queried by the service consumer (e.g. AS) to retrieve the location information in PS domain as retrieved from the serving node(s). The service consumer may indicate the requested nodes for which the request is applicable (e.g. AMF only) + +### 6.2.3.15.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/location-data + +This resource shall support the resource URI variables defined in table 6.2.3.15.2-1. + +**Table 6.2.3.15.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} impi-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,}))"\$ | + +### 6.2.3.15.3 Resource Standard Methods + +#### 6.2.3.15.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.15.3.1-1. + +**Table 6.2.3.15.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| requested-nodes | array(RequestedNode) | O | 1..N | Indicates the serving node(s) for which the request is applicable. | +| serving-node | boolean | O | 0..1 | Indicates that only the stored NF id/address of the serving node(s) requested and PLMN identity are required, that is, other location data (e.g. Global Cell ID) is not required.

It shall be absent if current-location is present with value true.

true: only the requested node(s) address(es) are requested
false or absent: location data as retrieved from the requested node(s) is requested. | +| local-time | boolean | O | 0..1 | Indicates that only the Local Time Zone information (Time Zone and Daylight Saving Time) and the PLMN identity of the location in the visited network where the UE is attached is requested, that is, other location data (e.g. Global Cell ID) is not required.

true: only the local time is requested
false or absent: location data as retrieved from the requested node(s) is requested. | +| current-location | boolean | O | 0..1 | Indicates whether an active location retrieval has to be initiated by the requested node(s).

true: active location retrieval is requested
false or absent: active location retrieval is not requested | +| rat-type | boolean | O | 0..1 | Indicates whether retrieval of RAT type is requested.
true: requested
false: not requested | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeld variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +If "requested-nodes" is not included, HSS shall return location information as retrieved from all the nodes (AMF, MME and SGSN) + +This method shall support the request data structures specified in table 6.2.3.15.3.1-2 and the response data structures and response codes specified in table 6.2.3.15.3.1-3. + +**Table 6.2.3.15.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.15.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PsLocation | M | 1 | 200 OK | A response body containing the PS location information as requested shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the location information is unknown or unavailable. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.15.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.15.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.16 Resource: CS location Information + +### 6.2.3.16.1 Description + +This resource represents the Location Information in CS domain. It is queried by the service consumer (e.g. AS) to retrieve the location information in CS domain as retrieved from the MSC/VLR. + +### 6.2.3.16.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/cs-domain/location-data + +This resource shall support the resource URI variables defined in table 6.2.3.16.2-1. + +**Table 6.2.3.16.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\}@([A-Za-z0-9]+\{[-A-Za-z0-9]+\}\.)+[a-z]{2,} impu-tel:\{+[0-9]{5,15} impi-\{+\}\.+\})\$" | + +## 6.2.3.16.3 Resource Standard Methods + +### 6.2.3.16.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.16.3.1-1. + +**Table 6.2.3.16.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| serving-node | boolean | O | 0..1 | Indicates that only the MSC/VLR address and PLMN identity are required, that is, other location data (e.g. Global Cell ID) is not required.

It shall be absent if current-location is present.

true: only the MSC/VLR number requested
false or absent: location data as retrieved from the MSC/VLR is requested. | +| local-time | boolean | O | 0..1 | Indicates that only the Local Time Zone information (Time Zone and Daylight Saving Time) and the PLMN identity of the location in the visited network where the UE is attached is requested, that is, other location data (e.g. Global Cell ID) is not required.

It shall be absent if current-location is present. | +| current-location | boolean | O | 0..1 | Indicates whether an active location retrieval has to be initiated by the MSC/VLR. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +If "serving-node" is not included, HSS shall return the location data as retrieved from the MSC/VLR. + +If "local-time" is not included, HSS shall return the location data as retrieved from the MSC/VLR. + +This method shall support the request data structures specified in table 6.2.3.16.3.1-2 and the response data structures and response codes specified in table 6.2.3.16.3.1-3. + +**Table 6.2.3.16.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.16.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CsLocation | M | 1 | 200 OK | A response body containing the CS location information as requested shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the location information is unknown or unavailable. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.16.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.16.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.17 Resource: SRVCC data + +### 6.2.3.17.1 Description + +This resource represents the SRVCC data. It is queried by the service consumer (e.g. AS) to retrieve the UE SRVCC capability and the STN-SR for the user. + +### 6.2.3.17.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/srvcc-data + +This resource shall support the resource URI variables defined in table 6.2.3.17.2-1. + +**Table 6.2.3.17.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:([a-zA-Z0-9_\-\.\!~*()&=+\$,;?V]+)@([A-Za-z0-9]+([\-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$" | + +**6.2.3.17.3 Resource Standard Methods** + +**6.2.3.17.3.1 GET** + +This method shall support the URI query parameters specified in table 6.2.3.17.3.1-1. + +**Table 6.2.3.17.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | + +This method shall support the request data structures specified in table 6.2.3.17.3.1-2 and the response data structures and response codes specified in table 6.2.3.17.3.1-3. + +**Table 6.2.3.17.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.17.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SrvccData | M | 1 | 200 OK | A response body containing the STN-SR and the UE SRVCC capabilities for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user is not subscribed to SRVCC. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.17.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.17.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.17.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.17.3.2-1. + +**Table 6.2.3.17.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.17.3.2-2 and the response data structures and response codes specified in table 6.2.3.17.3.2-3. + +**Table 6.2.3.17.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the SRVCC data.
Modification are not applicable to UE SRVCC capabilities. | + +**Table 6.2.3.17.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user is not subscribed to SRVCC. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see GPP TS 29.500 [4] table 5.2.7.2-1.
- OPERATION_NOT_ALLOWED | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.17.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.17.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.18 Resource: PSI activation state + +### 6.2.3.18.1 Description + +This resource represents the PSI activation state. It is queried by the service consumer (e.g. AS) to retrieve the activation state for the IMS Public Service Identity. + +### 6.2.3.18.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/psi-status + +This resource shall support the resource URI variables defined in table 6.2.3.18.2-1. + +**Table 6.2.3.18.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Service Identity
pattern: "^(impu-sip:\{[a-zA-Z0-9\_\.!~*()&=+\\$;:?,;?V]+\})@([A-Za-z0-9]+\{[A-Za-z0-9]+\})\.[a-z]{2,} impu-tel:\{+[0-9]{5,15} impi\.[+\-\.]+\})\$" | + +### 6.2.3.18.3 Resource Standard Methods + +#### 6.2.3.18.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.18.3.1-1. + +**Table 6.2.3.18.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.18.3.1-2 and the response data structures and response codes specified in table 6.2.3.18.3.1-3. + +**Table 6.2.3.18.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.18.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------| +| PsiActivationState | M | 1 | 200 OK | A response body containing the PSI activation state shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- SERVICE_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.18.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.18.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.18.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.18.3.2-1. + +**Table 6.2.3.18.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| Supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.18.3.2-2 and the response data structures and response codes specified in table 6.2.3.18.3.2-3. + +**Table 6.2.3.18.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|---------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the PSI activation state. | + +**Table 6.2.3.18.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- SERVICE_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see GPP TS 29.500 [4] table 5.2.7.2-1.
- OPERATION_NOT_ALLOWED | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.18.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.18.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.19 Resource: Repository Data + +### 6.2.3.19.1 Description + +This resource represents the Repository Data. It is used by the service consumer (e.g. IMS-AS) to create, retrieve, update or delete the repository data for a given service indication. + +### 6.2.3.19.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/repository-data/{serviceIndication} + +This resource shall support the resource URI variables defined in table 6.2.3.19.2-1. + +**Table 6.2.3.19.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: " ^ (impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\}@([A-Za-z0-9]+([-A-Za-z0-9]+\.)+[a-z]{2,} impu-tel:\{+[0-9]{5,15} impi-\{+\.+\})\$" | +| serviceIndication | Represents the identifier of a service related data. | + +## 6.2.3.19.3 Resource Standard Methods + +### 6.2.3.19.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.19.3.1-1. + +**Table 6.2.3.19.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.19.3.1-2 and the response data structures and response codes specified in table 6.2.3.19.3.1-3. + +**Table 6.2.3.19.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.19.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| RepositoryData | M | 1 | 200 OK | A response body containing the Repository Data for the requested Service Indication. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.19.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.19.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.19.3.2 PUT + +This method shall support the URI query parameters specified in table 6.2.3.19.3.2-1. + +**Table 6.2.3.19.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 6.2.3.19.3.2-2 and the response data structures and response codes specified in table 6.2.3.19.3.2-3. + +**Table 6.2.3.19.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|------------------------------------------------| +| RepositoryData | M | 1 | The Repository Data to be created or replaced. | + +**Table 6.2.3.19.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| RepositoryData | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual RepositoryData resource shall be returned. | +| RepositoryData | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual RepositoryData resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 409 Conflict | The "cause" attribute may be used to indicate the following application error:
- OUT_OF_SYNC | +| ProblemDetails | O | 0..1 | 413
Content Too Large | The "cause" attribute may be used to indicate the following application error:
- TOO_MUCH_DATA | + +**Table 6.2.3.19.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.19.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.19.3.2-6: 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}/nhss-ims-sdm//{imsUeId}/repository-data/{serviceIndication} | + +### 6.2.3.19.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.19.3.3-1. + +**Table 6.2.3.19.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 6.2.3.19.3.3-2 and the response data structures and response codes specified in table 6.2.3.19.3.3-3. + +**Table 6.2.3.19.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.19.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 | Upon success, an empty response body shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no repository data exists for the requested service indication. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.19.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.19.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.20 Resource: SharedData + +### 6.2.3.20.1 Description + +This resource represents the collection of data that can be shared by multiple UEs. + +### 6.2.3.20.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm//shared-data + +This resource shall support the resource URI variables defined in table 6.2.3.20.2-1. + +**Table 6.2.3.20.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | + +### 6.2.3.20.3 Resource Standard Methods + +#### 6.2.3.20.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.20.3.1-1. + +**Table 6.2.3.20.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|---------------------|---|-------------|-------------| +| shared-data-ids | array(SharedDataId) | M | 1..N | | + +This method shall support the request data structures specified in table 6.2.3.20.3.1-2 and the response data structures and response codes specified in table 6.2.3.20.3.1-3. + +**Table 6.2.3.20.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.20.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------| +| array(SharedData) | M | 1..N | 200 OK | Upon success, a response body containing a list of SharedData shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- DATA_NOT_FOUND | + +**Table 6.2.3.20.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.20.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.21 Resource: ImeiSvInformation + +### 6.2.3.21.1 Description + +This resource represents the IMEI(SV) information. It is queried by the service consumer (e.g. IMS AS) to retrieve the IMEI(SV) for the user. + +### 6.2.3.21.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/identities/imeisv + +This resource shall support the resource URI variables defined in table 6.2.3.21.2-1. + +**Table 6.2.3.21.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impnu-tel:\+[0-9]{5,15} impi-\.[a-z]{2,} impi-\.[0-9]{5,15} impi-\.[a-z]{2,} impi-\.[0-9]{5,15}))\$" | + +### 6.2.3.21.3 Resource Standard Methods + +#### 6.2.3.21.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.21.3.1-1. + +**Table 6.2.3.21.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeld variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | + +This method shall support the request data structures specified in table 6.2.3.21.3.1-2 and the response data structures and response codes specified in table 6.2.3.21.3.1-3. + +**Table 6.2.3.21.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.21.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| ImeiSvInformation | M | 1 | 200 OK | A response body containing the IMEI(SV) information for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.21.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.21.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.22 Resource: IP Address + +### 6.2.3.22.1 Description + +This resource represents the IP Address Information. It is queried by the service consumer (e.g. SCC-AS) to retrieve the IP Address Information for the user. + +### 6.2.3.22.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/ip-address + +This resource shall support the resource URI variables defined in table 6.2.3.22.2-1. + +**Table 6.2.3.22.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. non-shared IMS Public User identity) or the IMS Private Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[.]+\+))\$" | + +### 6.2.3.22.3 Resource Standard Methods + +#### 6.2.3.22.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.22.3.1-1. + +**Table 6.2.3.22.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.22.3.1-2 and the response data structures and response codes specified in table 6.2.3.22.3.1-3. + +**Table 6.2.3.22.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.22.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IpAddr | M | 1 | 200 OK | A response body containing the IP address (IPv4, IPv6, IPv6 prefix and/or IPv6 interface identifier) for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no IP Address is currently allocated for the user. | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.22.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.22.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.23 Resource: T-ADS Info + +### 6.2.3.23.1 Description + +This resource represents the T-ADS Information. It is queried by the service consumer (e.g. SCC-AS) to retrieve the T-ADS Information for the user. + +### 6.2.3.23.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/tads-info + +This resource shall support the resource URI variables defined in table 6.2.3.23.2-1. + +**Table 6.2.3.23.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeld | Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeld represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+,\$;:V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} impi-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,}))"\$" | + +### 6.2.3.23.3 Resource Standard Methods + +#### 6.2.3.23.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.23.3.1-1. + +**Table 6.2.3.23.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeld variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | + +This method shall support the request data structures specified in table 6.2.3.23.3.1-2 and the response data structures and response codes specified in table 6.2.3.23.3.1-3. + +**Table 6.2.3.23.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.23.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------| +| TadsInformation | M | 1 | 200 OK | A response body containing the T-ADS information (most recent VoPS support) for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.23.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.23.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.24 Resource: UeReachabilitySubscriptions + +### 6.2.3.24 Description + +This resource is used to represent subscriptions to notifications of UE Reachability for IP. + +#### 6.2.3.24.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.24.2-1. + +**Table 6.2.3.24.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+;\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.)+[a-z]{2,} impu-tel:\{[0-9]{5,15} impi-\+\.+\})\$" | + +#### 6.2.3.24.3 Resource Standard Methods + +##### 6.2.3.24.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.24.3.1-1. + +**Table 6.2.3.24.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.24.3.1-2 and the response data structures and response codes specified in table 6.2.3.24.3.1-3. + +**Table 6.2.3.24.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|-------------------------------------------------------------------| +| UeReachabilitySubscription | M | 1 | The subscription to UE reachability for IP that is to be created. | + +**Table 6.2.3.24.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedUeReachabilitySubscription | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | + +**Table 6.2.3.24.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.24.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.24.3.1-6: 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}/nhss-ims-sdm//imsUeId/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId} | + +#### 6.2.3.25 Resource: UE reachability Individual subscription + +#### 6.2.3.25.1 Description + +This resource is used to represent an individual subscription to notification of UE reachability for IP. + +#### 6.2.3.25.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId}** + +This resource shall support the resource URI variables defined in table 6.2.3.25.2-1. + +**Table 6.2.3.25.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:([a-zA-Z0-9_\-.!~*'()&=+\$,;?%\/]+)@([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+)\$" | +| subscriptionId | The subscriptionId identifies an individual subscription to notification of UE reachability for IP. | + +#### 6.2.3.25.3 Resource Standard Methods + +#### 6.2.3.25.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.25.3.1-1. + +**Table 6.2.3.25.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.25.3.1-2 and the response data structures and response codes specified in table 6.2.3.7.3.1-3. + +**Table 6.2.3.25.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.25.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.2.3.25.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.25.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.25.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.25.3.2-1. + +**Table 6.2.3.25.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUld variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.25.3.2-2 and the response data structures and response codes specified in table 6.2.3.25.3.2-3. + +**Table 6.2.3.25.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12]. | + +**Table 6.2.3.25.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with no content is returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate the following application error:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.25.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.25.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.26 Resource: PS User State + +### 6.2.3.26.1 Description + +This resource represents the User State information in PS domain. It is queried by the service consumer (e.g. AS) to retrieve the User State information in PS domain as retrieved from the serving node(s). The service consumer may indicate the requested nodes for which the request is applicable (e.g. AMF only) + +### 6.2.3.26.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/user-state** + +This resource shall support the resource URI variables defined in table 6.2.3.26.2-1. + +**Table 6.2.3.26.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. IMS Public User Identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(imp sip):([a-zA-Z0-9_\-\.~!\*\'\(\);&=\+\\$,;\?]+)@([A-Za-z0-9]+([\-A-Za-z0-9]+)\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$"

| + +### 6.2.3.26.3 Resource Standard Methods + +#### 6.2.3.26.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.26.3.1-1. + +**Table 6.2.3.26.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| requested-nodes | array(RequestedNode) | O | 1..N | Indicates the serving node(s) for which the request is applicable. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +If "requested-nodes" is not included, HSS shall return the user state as retrieved from all the nodes (AMF, MME and SGSN) + +This method shall support the request data structures specified in table 6.2.3.26.3.1-2 and the response data structures and response codes specified in table 6.2.3.26.3.1-3. + +**Table 6.2.3.26.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.26.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PsUserState | M | 1 | 200 OK | A response body containing the PS user state information as requested shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user state information is unknown or unavailable. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.26.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.26.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.27 Resource: CS User State + +### 6.2.3.27.1 Description + +This resource represents the User State information in CS domain. It is queried by the service consumer (e.g. AS) to retrieve the User State information in CS domain as retrieved from the MSC/VLR. + +### 6.2.3.27.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/cs-domain/user-state + +This resource shall support the resource URI variables defined in table 6.2.3.27.2-1. + +**Table 6.2.3.27.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\}@([A-Za-z0-9]+\{[-A-Za-z0-9]+\}\.)+[a-z]{2,} impu-tel:\{+[0-9]{5,15} impi-\{+\}\.+\})\$" | + +### 6.2.3.27.3 Resource Standard Methods + +#### 6.2.3.27.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.27.3.1-1. + +**Table 6.2.3.27.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.27.3.1-2 and the response data structures and response codes specified in table 6.2.3.27.3.1-3. + +**Table 6.2.3.27.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.27.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------| +| CsUserState | M | 1 | 200 OK | A response body containing the CS user state information as requested shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.27.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.27.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.28 Resource: Csrn + +#### 6.2.3.28.1 Description + +This resource represents the CSRN. It is queried by the service consumer (e.g. SCC-AS) to retrieve a CSRN for the user. + +#### 6.2.3.28.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/cs-domain/csrn** + +This resource shall support the resource URI variables defined in table 6.2.3.28.2-1. + +**Table 6.2.3.28.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:([a-zA-Z0-9_\-.!~*()&=+\$,;?V/]+)@([A-Za-z0-9]+([-A-Za-z0-9]+)+\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+)\$"

| + +#### 6.2.3.28.3 Resource Standard Methods + +##### 6.2.3.28.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.28.3.1-1. + +**Table 6.2.3.28.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| pre-paging | PrePaging | O | 0..1 | Indicates if pre-paging is supported

true: pre-paging is supported
false or absent: pre-paging is not supported | | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity.
Shall be present if the imsUId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | +| call-reference-info | CallReferenceInfo | O | 0..1 | Contains a Call Reference Number and the AS-Number. It allows a later retry of the call setup in the context of MTRR.
See 3GPP TS 29.328 [38] | | + +This method shall support the request data structures specified in table 6.2.3.28.3.1-2 and the response data structures and response codes specified in table 6.2.3.28.3.1-3. + +**Table 6.2.3.28.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.28.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Csrn | M | 1 | 200 OK | A response body containing the CSRN for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that CSRN retrieval from MSC/VLR failed. | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.28.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.28.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.29 Resource: ReferenceAccessLocation + +### 6.2.3.29.1 Description + +This resource represents the Reference Location Information. It is queried by the service consumer (e.g. IMS-AS) to retrieve the reference location information for the user (e.g. line identifier in fixed access networks). + +### 6.2.3.29.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/wireline-domain/reference-location + +This resource shall support the resource URI variables defined in table 6.2.3.29.2-1. + +**Table 6.2.3.29.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip\:[(a-zA-Z0-9_-\.!~*()&=+\$,;?V +)]@([A-Za-z0-9]+(-[A-Za-z0-9]+)\.)+[a-z]{2,} impu-tel\:[+0-9]{5,15} impi\-[+\.]+\+)\$" | + +### 6.2.3.29.3 Resource Standard Methods + +#### 6.2.3.29.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.29.3.1-1. + +**Table 6.2.3.29.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeld variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | + +This method shall support the request data structures specified in table 6.2.3.29.3.1-2 and the response data structures and response codes specified in table 6.2.3.29.3.1-3. + +**Table 6.2.3.29.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.29.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ReferenceLocationInformation | M | 1 | 200 OK | A response body containing the reference location information (e.g. access type, line identifier) for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no reference location information exist for the user. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.29.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.29.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.30 Resource: SMSRegistrationInfo + +### 6.2.3.30.1 Description + +This resource represents the SMS registration information. It is used by the service consumer (e.g. IP-SM-GW) to create, retrieve, update or delete the SMS registration information. + +### 6.2.3.30.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/service-data/sms-registration-info + +This resource shall support the resource URI variables defined in table 6.2.3.30.2-1. + +**Table 6.2.3.30.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_\-\.!~*()\&=+\\$;:,?V]+\}@\{[A-Za-z0-9]+\+\-\{[A-Za-z0-9]+\+\-\{[a-z]{2,}\}impn-tel:\{[0-9]{5,15}\}impi-\+\-\{[a-z]{2,}\})\$" | + +### 6.2.3.30.3 Resource Standard Methods + +#### 6.2.3.30.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.30.3.1-1. + +**Table 6.2.3.30.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.30.3.1-2 and the response data structures and response codes specified in table 6.2.3.30.3.1-3. + +**Table 6.2.3.30.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.30.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmsRegistrationInfo | M | 1 | 200 OK | A response body containing the SMS registration information. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no IP-SM-GW number is preconfigured or created previously for the user. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.30.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.30.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.30.3.2 PUT + +This method shall support the URI query parameters specified in table 6.2.3.30.3.2-1. + +**Table 6.2.3.30.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.30.3.2-2 and the response data structures and response codes specified in table 6.2.3.30.3.2-3. + +**Table 6.2.3.30.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-------------------------------------------------------------| +| lpSmGwAddress | M | 1 | The SMS Registration Information to be created or replaced. | + +**Table 6.2.3.30.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| SmsRegistrationInfo | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual RepositoryData resource shall be returned. | +| SmsRegistrationInfo | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual RepositoryData resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 409 Conflict | The "cause" attribute may be used to indicate the following application error:
- IP_SM_GW_CANNOT_BE_MODIFIED | + +**Table 6.2.3.30.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.30.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.30.3.2-6: 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}/nhss-ims-sdm/{apiVersion}/{imsUId}/service-data/sms-registration-info | + +## 6.2.3.30.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.30.3.3-1. + +**Table 6.2.3.30.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-identity | PrivatedId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.30.3.3-2 and the response data structures and response codes specified in table 6.2.3.30.3.3-3. + +**Table 6.2.3.30.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.30.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 | Upon success, an empty response body shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no SMS registration information exists for the user. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 409 Conflict | The "cause" attribute may be used to indicate the following application error:
- IP_SM_GW_CANNOT_BE_MODIFIED | + +**Table 6.2.3.30.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.30.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.31 Resource: Dsai + +### 6.2.3.31.1 Description + +This resource represents the DSAI Tag Information for the requested Application Server Name. It is used by the service consumer (e.g. IMS-AS) to retrieve or update the DSAI Tag Status. + +### 6.2.3.31.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/service-data/dsai + +This resource shall support the resource URI variables defined in table 6.2.3.31.2-1. + +**Table 6.2.3.31.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. non-shared IMS Public User identity) or the IMS private Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9\-\-!~*()&=+\$;,?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.)+\-[a-z]{2,}\-impu-tel:\+\[0-9]{5,15}\-impi\-\+\+\+\\$)" | + +### 6.2.3.31.3 Resource Standard Methods + +#### 6.2.3.31.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.31.3.1-1. + +**Table 6.2.3.31.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| application-server-name | SipServerName | M | 1 | The requested Application Server Name. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| dsai-tag | string | O | 0..1 | This information element identify the requested instance of Dynamic Service Activation Info (DSAI). | + +This method shall support the request data structures specified in table 6.2.3.31.3.1-2 and the response data structures and response codes specified in table 6.2.3.31.3.1-3. + +**Table 6.2.3.31.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.31.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DsaiTagInformation | M | 1 | 200 OK | A response body containing the DSAI information for the requested Application Server. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no DSAI Tag was found for the requested Application Server. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.31.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.31.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.31.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.31.3.2-1. + +**Table 6.2.3.31.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| Supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.31.3.2-2 and the response data structures and response codes specified in table 6.2.3.31.3.2-3. + +**Table 6.2.3.31.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the DSAI tag(s) activation state. | + +**Table 6.2.3.31.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- DSAI_TAG_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see GPP TS 29.500 [4] table 5.2.7.2-1.
- OPERATION_NOT_ALLOWED | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.31.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.31.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.32 Resource: Private Identities + +### 6.2.3.32.1 Description + +This resource represents the private identities. It is queried by the service consumer (IMS-AS) to retrieve the list of private identities. + +### 6.2.3.32.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/identities/private-identities + +This resource shall support the resource URI variables defined in table 6.2.3.32.2-1. + +**Table 6.2.3.32.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: " ^ (impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} impi-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} impi-tel:\+[0-9]{5,15}))\$" | + +## 6.2.3.32.3 Resource Standard Methods + +### 6.2.3.32.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.32.3.1-1. + +**Table 6.2.3.32.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| impi | PrivateId | O | 0..1 | Private Identity of type IMPI | | + +This method shall support the request data structures specified in table 6.2.3.32.3.1-2 and the response data structures and response codes specified in table 6.2.3.32.3.1-3. + +**Table 6.2.3.32.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.32.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------| +| PrivateIdentities | M | 1 | 200 OK | A response body containing the list of private identities belonging to the IMS UE. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.32.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.32.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.33 Resource: S-CSCF Selection Assistance Information + +### 6.2.3.33.1 Description + +This resource represents the S-CSCF selection assistance information. It is queried by the service consumer (I-CSCF) before S-CSCF selection. + +### 6.2.3.33.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/location-data/scscf-selection-assistance-info** + +This resource shall support the resource URI variables defined in table 6.2.3.33.2-1. + +**Table 6.2.3.33.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^ (impu-sip sip):([a-zA-Z0-9_\-.!~*'()&=+\$,;?V]+)@([A-Za-z0-9]+([\-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$" | + +### 6.2.3.33.3 Resource Standard Methods + +#### 6.2.3.33.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.33.3.1-1. + +**Table 6.2.3.33.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.33.3.1-2 and the response data structures and response codes specified in table 6.2.3.33.3.1-3. + +**Table 6.2.3.33.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 6.2.3.33.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScscfSelectionAssistanceInformation | M | 1 | 200 OK | A response body containing the S-CSCF Selection Assistance Information. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that any S-CSCF can be selected, e.g. based on I-CSCF local policy. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.33.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.33.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.34 Resource: Charging Information + +### 6.2.3.34.1 Description + +This resource represents the Charging Information. It is queried by the service consumer (e.g. AS) to retrieve the Diameter addresses Charging Functions for the user. + +### 6.2.3.34.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data/charging-info + +This resource shall support the resource URI variables defined in table 6.2.3.34.2-1. + +**Table 6.2.3.34.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:([a-zA-Z0-9_\.!~*()&=+\$;,?/]+)@([A-Za-z0-9]+([-A-Za-z0-9]+\.)+[a-z]{2,}) impu-tel:\+[0-9]{5,15} impi-.+ .+)\$" | + +### 6.2.3.34.3 Resource Standard Methods + +**6.2.3.34.3.1 GET** + +This method shall support the URI query parameters specified in table 6.2.3.34.3.1-1. + +**Table 6.2.3.34.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.34.3.1-2 and the response data structures and response codes specified in table 6.2.3.34.3.1-3. + +**Table 6.2.3.34.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.34.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| ChargingInfo | M | 1 | 200 OK | A response body containing the Charging Information for the user shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +#### 6.2.3.35 Resource: Repository Data List + +#### 6.2.3.35.1 Description + +This resource represents the Repository Data. It is used by the service consumer (e.g. IMS-AS) to retrieve multiple repository data for a given list of service indications. + +#### 6.2.3.35.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/repository-data** + +This resource shall support the resource URI variables defined in table 6.2.3.19.2-1. + +**Table 6.2.3.35.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: "^(impu-sip:\{[a-zA-Z0-9 \-\.!~*()&=+\$,;?V]+\}@([A-Za-z0-9]+([-A-Za-z0-9]+\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\+\.+\+)\$" | + +## 6.2.3.35.3 Resource Standard Methods + +### 6.2.3.35.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.35.3.1-1. + +**Table 6.2.3.35.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------------|--------------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| service-indications | array(ServiceIndication) | M | 1..N | | + +This method shall support the request data structures specified in table 6.2.3.35.3.1-2 and the response data structures and response codes specified in table 6.2.3.35.3.1-3. + +**Table 6.2.3.35.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.35.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| RepositoryDataList | M | 1 | 200 OK | A response body containing the Repository Data List for the requested Service Indications. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.35.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.35.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.5 Notifications + +### 6.2.5.1 General + +This clause specifies the use of notifications and corresponding protocol details. + +### 6.2.5.2 Data Change Notification + +The POST method shall be used for Data Change Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.2.5.2-1. + +**Table 6.2.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.2.5.2-2 and of response data structures and response codes is specified in table 6.2.5.2-3. + +**Table 6.2.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-------------| +| ModificationNotification | M | 1 | | + +**Table 6.2.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- CONTEXT_NOT_FOUND

See table 6.2.7.3-1 for the description of this error. | + +**Table 6.2.5.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 notification endpoint of the subscribing NF. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.5.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 notification endpoint of the subscribing NF. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.6 Data Model + +### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nhss\_imsSDM service API. + +**Table 6.2.6.1-1: Nhss\_imsSDM specific Data Types** + +| Data type | Clause defined | Description | +|-----------------------------------|----------------|--------------------------------------------------------------------------------------------------------------------------| +| ScscfCapabilityList | 6.2.6.2.2 | Information about mandatory and optional S-CSCF capabilities | +| ImsProfileData | 6.2.6.2.4 | User's IMS profile data | +| RepositoryData | 6.2.6.2.7 | Repository Data for the requested Service Indication | +| MsisdnList | 6.2.6.2.8 | List of MSISDNs associated to the IMS public Identity | +| PublicIdentities | 6.2.6.2.9 | IMS Public Identities which belong to the same Implicit Registration Set (if any) as the requested IMS Public Identity | +| PublicIdentity | 6.2.6.2.10 | IMS Public Identity and the related data (Alias Group Id, IRS default indication, Identity Type) | +| ImsSdmSubscription | 6.2.6.2.11 | A subscription to notifications of data change | +| ImsRegistrationStatus | 6.2.6.2.12 | Registration status of the user. | +| PriorityLevels | 6.2.6.2.13 | Namespaces and priority levels allowed for the IMS public Identity. | +| Ifcs | 6.2.6.2.14 | List of IFCs associated to the IMS public Identity | +| Ifc | 6.2.6.2.15 | Data associated to an individual IFC (Initial Filter Criteria) | +| TriggerPoint | 6.2.6.2.16 | Contains the conditions that should be checked in order to find out if an Application Server should be contacted or not | +| Spt | 6.2.6.2.17 | Contains the data of a Service Point Trigger | +| HeaderSipRequest | 6.2.6.2.18 | Contains a header (and optionally value of the header) in the SIP request | +| SdpDescription | 6.2.6.2.19 | Contains a SDP line (and optionally the value in the line) within the body (if any) of a SIP request | +| ApplicationServer | 6.2.6.2.20 | Application Server which shall be triggered if the conditions of a certain IFC are met, and its associated data | +| ImsLocationData | 6.2.6.2.21 | IMS Location Data (S-CSCF name) | +| ServiceLevelTraceInformation | 6.2.6.2.22 | IMS Service Level Trace Information | +| PsLocation | 6.2.6.2.23 | Location data in PS domain. | +| SgsnLocationData | 6.2.6.2.24 | Location information as retrieved from the SGSN serving node | +| MmeLocationData | 6.2.6.2.25 | Location information as retrieved from the MME serving node | +| AmfLocationData | 6.2.6.2.26 | Location information as retrieved from the AMF serving node | +| TwanLocationData | 6.2.6.2.27 | Location information of the 3GPP AAA Server for Trusted W-LAN Access | +| CsLocation | 6.2.6.2.28 | Location data in CS domain. | +| CsgInformation | 6.2.6.2.29 | Information about a Closed Subscriber Group (CSG) | +| SrvccData | 6.2.6.2.30 | UE SRVCC capability (if available) and STN-SR (if subscribed) | +| PsiActivationState | 6.2.6.2.31 | Public Service Identity activation state | +| ImeiSvInformation | 6.2.6.2.34 | IMEI(SV) information | +| TadsInformation | 6.2.6.2.36 | T-ADS Information | +| UeReachabilitySubscription | 6.2.6.2.37 | A subscription to notifications of UE reachability for IP. | +| UeReachabilityNotification | 6.2.6.2.38 | A notification of UE reachability for IP. | +| PsUserState | 6.2.6.2.39 | User state in PS domain | +| CsUserState | 6.2.6.2.40 | User state in CS domain | +| Csrn | 6.2.6.2.41 | CS domain routeing number | +| ReferenceLocationInformation | 6.2.6.2.42 | Reference Location Information for the user in fixed access networks. | +| SmsRegistrationInfo | 6.2.6.2.43 | SMS Registration Information (IP-SM-GW number and SC address) | +| IpSmGwAddress | 6.2.6.2.44 | IP-SM-GW number and diameter URI/realm | +| ImsAssociatedIdentities | 6.2.6.2.45 | A list of identities belonging to the same Implicit Registration Set (IRS), along with the registration state of the IRS | +| DsaiTagInformation | 6.2.6.2.46 | DSAI tag information (list of DSAI tags activation state for an Application Server) | +| DsaiTagStatus | 6.2.6.2.47 | DSAI tag status (DSAI tag and activation state) | +| CreatedUeReachabilitySubscription | 6.2.6.2.48 | A subscription to notifications of UE reachability for IP. | +| PrivateIdentities | 6.2.6.2.49 | IMS Private Identities | + +| | | | +|-------------------------------------|------------|----------------------------------------------------------------| +| PrivateIdentity | 6.3.6.2.50 | IMS Private Identity and the related data (e.g. Identity Type) | +| ScscfSelectionAssistanceInformation | 6.2.6.2.51 | Information used by the I-CSCF to select an S-CSCF for the UE | +| ChargingInfo | 6.2.6.2.52 | Diameter addresses of the charging function | +| RepositoryDataList | 6.2.6.2.53 | List of Repository Data for the requested Service Indications | +| CoreNetworkServiceAuthorization | 6.2.6.2.54 | Core Network Service Authorization | + +Table 6.2.6.1-2 specifies data types re-used by the Nhss\_imsSDM service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_imsSDM. + +**Table 6.2.6.1-2: Nhss\_imsSDM re-used Data Types** + +| Data type | Reference | Comments | +|--------------------------|---------------------|---------------------------------------------------------| +| Uri | 3GPP TS 29.571 [16] | Uniform Resource Identifier | +| SupportedFeatures | 3GPP TS 29.571 [16] | see 3GPP TS 29.500 [4] clause 6.6 | +| ModificationNotification | 3GPP TS 29.503 [15] | Content of the notification after a data change | +| EutraLocation | 3GPP TS 29.571 [16] | E-UTRAN user location | +| NrLocation | 3GPP TS 29.571 [16] | NR user location | +| PlmnId | 3GPP TS 29.571 [16] | PLMN Identity | +| TimeZone | 3GPP TS 29.571 [16] | Time Zone and Daylight Saving Time | +| UtraLocation | 3GPP TS 29.571 [16] | UTRAN user location | +| GeraLocation | 3GPP TS 29.571 [16] | GERAN user location | +| DiameterIdentity | 3GPP TS 29.571 [16] | Diameter URI | +| NfInstanceId | 3GPP TS 29.571 [16] | String uniquely identifying a NF instance | +| RatType | 3GPP TS 29.571 [16] | RAT type | +| StnSr | 3GPP TS 29.571 [16] | Session Transfer Number for SRVCC | +| PatchItem | 3GPP TS 29.571 [16] | Patch Item | +| PatchResult | 3GPP TS 29.571 [16] | Patch Result | +| IpAddr | 3GPP TS 29.571 [16] | IP address (IPv4 address, IPv6 address, or IPv6 Prefix) | +| DateTime | 3GPP TS 29.571 [16] | UTC time | +| AccessType | 3GPP TS 29.571 [16] | Type of access | +| ProblemDetails | 3GPP TS 29.571 [16] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [16] | Response body of redirect response messages. | +| Ecgi | 3GPP TS 29.571 [16] | E-UTRAN Cell Global Identity | +| Tai | 3GPP TS 29.571 [16] | Tracking Area Identity | + +## 6.2.6.2 Structured data types + +### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 6.2.6.2.2 Type: ScscfCapabilityList + +**Table 6.2.6.2.2-1: Definition of type ScscfCapabilityList** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mandatoryCapabilityList | Capabilities | O | 1 | List of S-CSCF capabilities which are mandatory to be supported by the S-CSCF allocated to the subscription the user belongs to. | +| optionalCapabilityList | Capabilities | O | 1 | List of S-CSCF capabilities which are optional or preferred (but not mandatory) to be supported by the S-CSCF allocated to the subscription the user belongs to. | + +NOTE 1: At least one of mandatory or optional capabilities shall be present. + +## 6.2.6.2.3 Type: Capabilities + +Table 6.2.6.2.3-1: Definition of type Capabilities + +| Type Name | Type Definition | Description | +|--------------|-------------------|-----------------------------------------| +| Capabilities | array(Capability) | This IE contains a list of capabilities | + +## 6.2.6.2.4 Type: ImsProfileData + +Table 6.2.6.2.4-1: Definition of type ImsProfileData + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------| +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.2.8 | +| imsServiceProfiles | array(ImsServiceProfile) | M | 1..N | IMS service profile shared by several public identities when they belong to an IRS. | +| chargingInfo | ChargingInfo | O | 0..1 | A response body containing the Charging Information for the user. | +| serviceLevelTraceInfo | ServiceLevelTraceInformation | O | 0..1 | IMS Service Level Trace information. Syntax described in 3GPP TS 24.323 [24]. | +| servicePriorityLevelList | array(NameSpacePriority) | O | 1..N | List of namespaces and their associated priorities allowed for the user. | +| maxAllowedSimulReg | integer | O | 0..1 | Maximum number of allowed simultaneous registrations for the Public User Identity. | +| servicePriorityLevel | integer | O | 0..1 | Possible values:
0 (Highest priority)
1
2
3
4 (Lowest priority) | + +## 6.2.6.2.5 Type: SharedData + +Table 6.2.6.2.5-1: SharedData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|--------------|---|-------------|-------------------------------| +| sharedDataId | SharedDataId | M | 1 | Identifier of the shared data | +| sharedImsIfcData | Ifcs | O | 0..1 | Shared IFC Subscription Data | + +NOTE 1: The attribute sharedImsIfcData shall not contain sharedDataIds. +NOTE 2: When shared data clash with individual data, individual data shall take precedence. + +## 6.2.6.2.6 Type: ImsDataSets + +Table 6.2.6.2.6-1: ImsDataSets + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| ifcData | IfcData | O | 0..1 | IFC Data | + +## 6.2.6.2.7 Type: RepositoryData + +Table 6.2.6.2.7-1: Definition of type RepositoryData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|---------------------------------------------------------------------------| +| serviceData | string | M | 1 | The Repository Data for the requested Service Indication. Base64 encoded. | +| sequenceNumber | SequenceNumber | M | 1 | The sequence number associated to the current version of Repository Data. | + +## 6.2.6.2.8 Type: MsisdnList + +**Table 6.2.6.2.8-1: Definition of type MsisdnList** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------| +| basicMsisdn | Msisdn | M | 1 | The basic (or correlation) MSISDN associated to the IMS Public Identity for the IMS Private Identity indicated (if any) | +| additionalMsisdns | array(Msisdn) | O | 1..N | Additional MSISDNs | + +## 6.2.6.2.9 Type: PublicIdentities + +**Table 6.2.6.2.9-1: Definition of type PublicIdentities** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------------------|---|-------------|------------------------------------------| +| publicIdentities | array(PublicIdentity) | M | 1..N | List of IMS Public Identities associated | + +## 6.2.6.2.10 Type: PublicIdentity + +**Table 6.2.6.2.10-1: Definition of type PublicIdentity** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| imsPublicId | ImsPublicId | M | 1 | IMS Public Identity (distinct or wildcarded) | +| identityType | IdentityType | M | 1 | Type of IMS Public Identity (e.g. Wildcarded Public Service Identity type) | +| irIsDefault | boolean | O | 0..1 | Indicates whether the IMS Public Identity is the default within the Implicit Registration Set. Absence and false indicates "non-default".
Only one identity in SIP URI format and one identity in TEL URI format (if any) shall have value True for this attribute. | +| aliasGroupId | string | O | 0..1 | Indicates the Alias Public User Identity Group to which the Public User Identity belongs. Absence indicates that the identity does not belong to any Alias Group | + +## 6.2.6.2.11 Type: ImsSdmSubscription + +**Table 6.2.6.2.11-1: ImsSdmSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nflInstanceId | NflInstanceId | M | 1 | Identity of the NF Instance creating the subscription. | +| callbackReference | Uri | M | 1 | URI provided by the NF service consumer to receive notifications | +| monitoredResourceUris | array(Uri) | M | 1..N | A set of URIs that identify the resources for which a change triggers a notification.
The URI shall take the form of either an absolute URI or an absolute-path reference as defined in IETF RFC 3986 [31].
See NOTE. | +| expires | DateTime | C | 0..1 | If present, indicates the point in time at which the subscription expires.
Within a POST request the proposed expiry time is conveyed whereas in a POST response or PATCH response the confirmed expiry time is returned. | + +NOTE: The HSS should handle only the relative-path part (apiSpecificResourceUriPart, see 3GPP TS 29.501 [5] clause 4.4.1) and ignore possible inconsistencies in the base URI part. + +## 6.2.6.2.12 Type: ImsRegistrationStatus + +**Table 6.2.6.2.12-1: Definition of type ImsRegistrationStatus** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------| +| imsUserStatus | ImsRegistrationState | M | 1 | It contains the registration state of the user or the IRS, as described in 3GPP TS 29.328 [38], clause 7.6.3. | + +## 6.2.6.2.13 Type: PriorityLevels + +**Table 6.2.6.2.13-1: Definition of type PriorityLevels** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|--------------------------|---|-------------|--------------------------------------------------------------------------------| +| servicePriorityLevelList | array(NameSpacePriority) | M | 1..N | List of namespaces and their associated priorities allowed for the user. | +| servicePriorityLevel | integer | O | 0..1 | Possible values:
0 (Highest priority)
1
2
3
4 (Lowest priority) | + +## 6.2.6.2.14 Type: Ifcs + +**Table 6.2.6.2.14-1: Definition of type Ifcs** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------|------------------------|---|-------------|---------------------------------------------------------| +| ifcList | array(Ifc) | C | 1..N | List of complete IFCs which are associated to the user. | +| cscfFilterSetIdList | array(cscfFilterSetId) | C | 1..N | List of S-CSCF specific filter set identifiers. | +| NOTE: At least one of IfcList or cscfFilterSetIdList shall be present. | | | | | + +## 6.2.6.2.15 Type: Ifc + +**Table 6.2.6.2.15-1: Definition of type Ifc** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| priority | integer | M | 1 | Contains the priority of the IFC. The higher the Priority Number the lower the priority of the Filter Criteria is.
Minimum: 1 | +| trigger | TriggerPoint | O | 1 | Contains the conditions that should be checked in order to find out if the indicated Application Server should be contacted or not. The absence of this attribute will indicate an unconditional triggering to Application Server. | +| appServer | ApplicationServer | M | 1 | Contains the Application Server which shall be triggered if the conditions are met and its associated data (e.g. default handling) | +| NOTE : See 3GPP TS 29.228 [20], Annex B.2.2 for more details on the terms and concepts associated to Initial Filter Criteria. The ProfilePartIndicator attribute described in Annex B.2.2 is removed and it shall be derived from the SessionCase attribute described in Annex B.2.3. | | | | | + +## 6.2.6.2.16 Type: TriggerPoint + +Table 6.2.6.2.16-1: Definition of type TriggerPoint + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | TypeOfCondition | M | 1 | Indicates how the set of SPTs are expressed, i.e. either an Ored set of ANDed sets of SPT statements or an ANDed set of Ored sets of statements. These combinations are termed, respectively, Disjunctive Normal Form (DNF) and Conjunctive Normal Form (CNF) for the SPT (see 3GPP TS 29.228 [20], Annex C). | +| sptList | array(Spt) | M | 1..N | Contains the list of Service Point Triggers | + +## 6.2.6.2.17 Type: Spt + +Table 6.2.6.2.17-1: Definition of type Spt + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionNegated | boolean | M | 1 | Indicates if the Service Point Trigger instance is negated (i.e. NOT logical expression) | +| sptGroup | array(SptGroupId) | M | 1..N | Contains the SPT group or list of SPT groups assigned to the SPT. | +| regType | array(RegistrationType) | O | 1..2 | Indicates the type of registration. If included, it shall contain the values that define whether the SPT matches to REGISTER messages that are related to initial registrations, re-registrations, and/or de-registrations. This attribute shall be included only if the SPT is for SIP method with a value "REGISTER" and only if it does not apply to all types of registration; otherwise, it shall be absent (i.e. the SIP Method SPT matches to all REGISTER messages).
The attribute regType shall be discarded if it is present in an SPT other than SIP Method with value "REGISTER". | +| requestURI | string | C | 1 | Contains the request-URI of the SIP request (NOTE 2) | +| sipMethod | string | C | 1 | Contains the method of the SIP request (NOTE 2) | +| sipHeader | HeaderSipRequest | C | 1 | Contains a header (and optionally value of the header) in the SIP request (NOTE 2) | +| sessionCase | RequestDirection | O | 1 | Contains the direction of the SIP request as evaluated by the S-CSCF. | +| sessionDescription | SdpDescription | C | 1 | Contains a SDP line (and optionally the value in the line) within the body (if any) of a SIP request (NOTE 2) | + +NOTE 1: See 3GPP TS 29.228 [20], Annex B.2.3 for more details on the terms and concepts associated to Service Point Trigger. The ProfilePartIndicator attribute described in Annex B.2.2 is removed and it shall be derived from the SessionCase attribute described in Annex B.2.3. + +NOTE 2: Exactly one of requestURI, method, header and sessionDescription shall be present. See TS 29.228 [20], Annex F for the definition of these attributes. + +## 6.2.6.2.18 Type: HeaderSipRequest + +Table 6.2.6.2.18-1: Definition of type HeaderSipRequest + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| header | string | M | 1 | Contains a SIP header | +| content | string | O | 1 | Contains the content of the SIP header. If this attribute is absent, it shall indicate that the SPT is the presence (if conditionNegated="FALSE") or absence (if conditionNegated="TRUE") of the SIP header. | + +## 6.2.6.2.19 Type: SdpDescription + +**Table 6.2.6.2.19-1: Definition of type SdpDescription** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| line | string | M | 1 | Contains a line in the session description | +| content | string | O | 1 | Contains the content of the SDP line. If this attribute is absent, it shall indicate that the SPT is the presence (if conditionNegated="FALSE") or absence (if conditionNegated="TRUE") of the SDP line. | + +## 6.2.6.2.20 Type: ApplicationServer + +**Table 6.2.6.2.20-1: Definition of type ApplicationServer** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|---------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| asUri | string | M | 1 | Contains the Application Server SIP URI, as described in IETF RFC 3261 [22] or 3GPP TS 23.003 [13]. | +| sessionContinue | boolean | O | 1 | This IE indicates whether the SIP dialog shall be continued or released if the Application Server could not be reached.

true: indicates that the session shall be continued

false or absent: indicates that the session shall be released | +| serviceInfoList | array(ServiceInformation) | O | 1..N | Indicates a list of service information that shall be sent to the Application Server. | + +## 6.2.6.2.21 Type: ImsLocationData + +**Table 6.2.6.2.21-1: Definition of type ImsLocationData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------| +| scscfName | string | M | 1 | S-CSCF name assigned to the IMS subscription the UE belongs to in the form of a SIP URI, as defined in IETF RFC 3261 [22]. | + +## 6.2.6.2.22 Type: ServiceLevelTraceInformation + +**Table 6.2.6.2.22-1: Definition of type ServiceLevelTraceInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------| +| serviceLevelTraceInfo | string | M | 1 | IMS Service Level Trace information. Syntax described in 3GPP TS 24.323 [24] | + +## 6.2.6.2.23 Type: PsLocation + +**Table 6.2.6.2.23-1: Definition of type PsLocation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|------------------------------------------------| +| sgsnLocation | SgsnLocationData | O | 0..1 | Location information as retrieved from SGSN | +| mmeLocation | MmeLocationData | O | 0..1 | Location information as retrieved from MME | +| amfLocation | AmfLocationData | O | 0..1 | Location information as retrieved from AMF | +| twanLocation | TwanLocationData | O | 0..1 | 3GPP AAA Server for TWAN Location information. | + +NOTE: At least one of the "sgsnLocation", "mmeLocation", "amfLocation" or "twanLocation" shall be included. + +## 6.2.6.2.24 Type: SgsnLocationData + +**Table 6.2.6.2.24-1: Definition of type SgsnLocationData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| sgsnNumber | string | M | 1 | SGSN number. See 3GPP TS 23.003 [13] clause 5.1. | +| plmnId | PlmnId | M | 1 | PLMN identity | +| sgsnLocation | UltraLocation | O | 0..1 | User location as retrieved from SGSN. | +| csgInformation | CsgInformation | O | 0..1 | Closed Subscriber Group Information. See 3GPP TS 23.060 [25]. | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| ratType | RatType | O | 0..1 | RAT type | + +## 6.2.6.2.25 Type: MmeLocationData + +**Table 6.2.6.2.25-1: Definition of type MmeLocationData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| mmeAddress | DiameterIdentity | M | 1 | MME diameter identity | +| plmnId | PlmnId | M | 1 | PLMN identity | +| mmeLocation | EutraLocation | O | 0..1 | User location as retrieved from MME. | +| csgInformation | CsgInformation | O | 0..1 | Closed Subscriber Group Information. See 3GPP TS 23.060 [25]. | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| ratType | RatType | O | 0..1 | RAT type | + +## 6.2.6.2.26 Type: AmfLocationData + +**Table 6.2.6.2.26-1: Definition of type AmfLocationData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| amfAddress | NfInstanceId | M | 1 | AMF identity. | +| plmnId | PlmnId | M | 1 | PLMN identity | +| amfLocation | NrLocation | O | 0..1 | User location as retrieved from AMF. | +| smsfAddress | NfInstanceId | O | 0..1 | SMSF identity | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| ratType | RatType | O | 0..1 | RAT type | + +## 6.2.6.2.27 Type: TwanLocationData + +Table 6.2.6.2.27-1: Definition of type TwanLocationData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| twanSsid | string | M | 1 | TWAN SSID, as defined in 3GPP TS 29.273 [26]. | +| plmnId | PlmnId | M | 1 | PLMN identity of the TWAN | +| twanBssid | string | O | 0..1 | TWAN BSSID, as defined in 3GPP TS 29.273 [26]. | +| civicAddress | string | O | 0..1 | Defined in clause 3.4 of IETF RFC 4776 [27] excluding the first 3 octets. Base64 encoded, according to IETF RFC 2045 [28]. | +| twanOperatorName | string | O | 0..1 | TWAN Operator Name, as defined in clause 19.8 of 3GPP TS 23.003 [13]. | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| logicalAccessId | string | O | 0..1 | Logical Access ID, as defined in ETSI ES 283 034 [29]. | + +## 6.2.6.2.28 Type: CsLocation + +Table 6.2.6.2.28-1: Definition of type CsLocation + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| mscNumber | string | M | 0..1 | MSC number. See 3GPP TS 23.003 [13] clause 5.1. | +| vlrNumber | string | M | 0..1 | VLR number. See 3GPP TS 23.003 [13] clause 5.1. | +| plmnId | PlmnId | M | 0..1 | PLMN identity | +| vlrLocation | GeraLocation | O | 0..1 | User location as retrieved from MSC/VLR. | +| csgInformation | CsgInformation | O | 0..1 | Closed Subscriber Group Information. See 3GPP TS 23.060 [25]. | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| eUtranCgi | Ecgi | O | 0..1 | E-UTRAN Cell Global Identity | +| tai | Tai | O | 0..1 | Tracking Area ID | + +## 6.2.6.2.29 Type: CsgInformation + +Table 6.2.6.2.29-1: Definition of type CsgInformation + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| csgId | string | M | 1 | CSG Identity. Syntax described in 3GPP TS 29.002 [30] i.e. 5 octets BER encoded value of 27-bit BIT STRING (Base64 encoded according to IETF RFC 2045 [28]). Length = 8. | +| accessMode | string | O | 0..1 | CSG Access Mode. Syntax described in 3GPP TS 29.002 [30] (Base64 encoded according to IETF RFC 2045 [28]). Length = 4. | +| cMi | boolean | O | 0..1 | CSG Membership Indication
0: CSG membership
1: non CSG membership | + +## 6.2.6.2.30 Type: SrvccData + +Table 6.2.6.2.30-1: Definition of type SrvccData + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| stnSr | StnSr | M | 1 | Indicates the STN-SR (Session Transfer Number for SRVCC) of the UE. | +| ueSrvccCapabilities | array(SrvccCapability) | O | 1..N | List of accesses supported by UE SRVCC capability (e.g. 4G, 5G).
Absence of this attribute indicates that UE is not SRVCC capable. | + +## 6.2.6.2.31 Type: PsiActivationState + +Table 6.2.6.2.31-1: Definition of type PsiActivationState + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------|---|-------------|-------------------------------------------------| +| activationState | ActivationState | M | 1 | Indicates whether the PSI is active or inactive | + +## 6.2.6.2.32 Type: ImsServiceProfile + +Table 6.2.6.2.32-1: Definition of type ImsServiceProfile + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|---------------------------------|---|-------------|------------------------------------------------------------------------------------| +| publicIdentifierList | array(PublicIdentifier) | M | 1..N | List of public identities sharing the same service profile and its individual data | +| ifcs | Ifcs | O | 1 | List of IFCs and/or shared IFC set identifiers | +| cnServiceAuthorization | CoreNetworkServiceAuthorization | O | 0..1 | Core Network Service Authorization | + +## 6.2.6.2.33 Type: PublicIdentifier + +Table 6.2.6.2.33-1: Definition of type PublicIdentifier + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| publicIdentity | PublicIdentity | M | 1 | Public identity information | +| displayName | string | O | 1 | Name associated with the public identity | +| imsServicePriority | PriorityLevels | O | 1 | Multimedia service priority | +| serviceLevelTraceInfo | ServiceLevelTraceInfo | O | 1 | Service Level Tracing Information | +| barringIndicator | boolean | O | 1 | Indicates whether the identity is barred, i.e. it can not be used in any IMS communication except registrations, re-registrations and de-registrations.

true: identity is barred
false or absent: identity is not barred | +| wildcardedImpu | String | O | 1 | When identityType is wildcarded IMPU it contains the wildcard id as stored by HSS | + +## 6.2.6.2.34 Type: ImeiSvInformation + +Table 6.2.6.2.34-1: Definition of type ImeiSvInformation + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------|-----------|---|-------------|----------------------| +| imei | Imei | C | 1 | Indicates the IMEI | +| imeiSv | ImeiSv | C | 1 | Indicates the IMEISV | +| NOTE: Either imei or imeiSv shall be present. | | | | | + +6.2.6.2.35 Void + +6.2.6.2.36 Type: TadsInformation + +**Table 6.2.6.2.36-1: Definition of type TadsInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|------------------------------|---|-------------|-----------------------------------------------------------| +| voiceOverPsSessionSupport | ImsVoiceOverPsSessionSupport | M | 1 | Indicates the support for Voice over PS | +| accessType | AccessType | O | 0..1 | Indicates the type of access | +| ratType | RatType | O | 0..1 | Indicates the RAT Type | +| lastUeActivityTime | DateTime | O | 0..1 | Indicates the time of the last radio contact with the UE. | + +6.2.6.2.37 Type: UeReachabilitySubscription + +**Table 6.2.6.2.37-1: Definition of type UeReachabilitySubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| expiry | DateTime | M | 1 | Indicates the suggested time at which monitoring should cease and the subscription should become invalid. | +| callbackReference | Uri | M | 1 | Callback URI provided by the subscribing NF service consumer. | + +6.2.6.2.38 Type: UeReachabilityNotification + +**Table 6.2.6.2.38-1: Definition of type UeReachabilityNotification** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| reachabilityIndicator | boolean | M | 1 | Indicates that the UE has been detected reachable for IP. | +| detectingNode | DetectingNode | M | 1 | Indicates the serving node which detected the UE reachability for IP. | +| accessType | AccessType | C | 1 | Indicates the access type (e.g. non 3GPP) where the reachability was detected. It shall be present when the serving node is AMF. | + +6.2.6.2.39 Type: PsUserState + +**Table 6.2.6.2.39-1: Definition of type PsUserState** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------|-------------|---|-------------|-----------------------------------| +| sgsnUserState | UserStatePs | C | 0..1 | User state as retrieved from SGSN | +| mmeUserState | UserStatePs | C | 0..1 | User state as retrieved from MME | +| amfUserState | UserStatePs | C | 0..1 | User state as retrieved from AMF | +| NOTE: At least one of the "sgsnUserState", "mmeUserState" or "amfUserState" shall be included. | | | | | + +6.2.6.2.40 Type: CsUserState + +**Table 6.2.6.2.40-1: Definition of type PsUserState** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-------------|---|-------------|--------------------------------------| +| mscVlrUserState | UserStateCs | M | 1 | User state as retrieved from MSC/VLR | + +## 6.2.6.2.41 Type: Csrn + +**Table 6.2.6.2.41-1: Definition of type CsrnInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------| +| csrn | Msisdn | M | 1 | Contains a CS domain routeing number as retrieved from MSC/VLR | + +## 6.2.6.2.42 Type: ReferenceLocationInformation + +**Table 6.2.6.2.42-1: Definition of type ReferenceLocationInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------| +| accessType | string | C | 1 | Indicates the type of access for which the reference location of the user is defined (e.g. ADSL). | +| accessInfo | string | C | 1 | Indicates the type of the access information defined for the reference location of the user (e.g. dsl-location). | +| accessValue | string | C | 1 | It contains the location information (e.g. line identifier in fixed access networks) as configured by the operator. | + +NOTE 1: At least one of accessType or accessInfo or accessValue shall be present. +NOTE 2: The syntax of accessType, accessInfo and accessValue is as described in 3GPP TS 24.229 [18] for P-Access-Network-Info header fields: accessType corresponds to the "access-type" field whereas accessInfo and accessValue correspond to the type and associated value defined for the "access-info" field. + +## 6.2.6.2.43 Type: SmsRegistrationInfo + +**Table 6.2.6.2.43-1: Definition of type SmsRegistrationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------| +| ipSmGwNumber | Msisdn | M | 1 | IP-SM-GW number | +| scAddress | Msisdn | O | 0..1 | Short Message Service Centre Address | + +## 6.2.6.2.44 Type: IpSmGwAddress + +**Table 6.2.6.2.44-1: Definition of type IpSmGwAddress** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipSmGwNumber | Msisdn | M | 1 | IP-SM-GW number | +| ipSmGwDiaUri | DiameterIdentity | O | 0..1 | IP-SM-GW Diameter Uri. It shall be present if s6c is supported. | +| ipSmGwDiaRealm | DiameterIdentity | O | 0..1 | IP-SM-GW Diameter Realm. It shall be present if s6c is supported. | +| ipSmGwSbiSupInd | boolean | C | 0..1 | SBI Support Indication of the IP-SM-GW. it shall be present if provided in SMS Registration Information Creation or Update procedure (see clauses 5.3.2.7.6)
Contains the indication on whether or not the IP-SM-GW is expecting to support SBI-based MT SM transmit.
- true: the IP-SM-GW supports SBI for MT SM transmit.
- false, or absence of this attribute: the IP-SM-GW do not support SBI for MT SM transmit. | + +## 6.2.6.2.45 Type: ImsAssociatedIdentities + +**Table 6.2.6.2.45-1: Definition of type ImsAssociatedIdentities** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|----------------------|---|-------------|----------------------------------------------------------------------| +| irsState | ImsRegistrationState | M | 1 | It contains the registration state of the Implicit Registration Set. | +| publicIdentities | PublicIdentities | M | 1 | List of IMS Public Identities associated. | + +## 6.2.6.2.46 Type: DsaiTagInformation + +**Table 6.2.6.2.46-1: Definition of type DsaiTagInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|----------------------|---|-------------|--------------------------------------------------------------| +| dsaiTagStatusList | array(DsaiTagStatus) | M | 1..N | List of DSAI Tags associated to the Application Server Name. | + +## 6.2.6.2.47 Type: DsaiTagStatus + +**Table 6.2.6.2.47-1: Definition of type DsaiTagStatus** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|-----------------------------------------------------| +| dsaiTag | string | M | 1 | DSAI tag associated to the Application Server Name. | +| dsaiStatus | ActivationState | M | 1 | Status of DSAI tag | + +## 6.2.6.2.48 Type: CreatedUeReachabilitySubscription + +**Table 6.2.6.2.48-1: Definition of type CreatedUeReachabilitySubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| expiry | DateTime | M | 1 | Indicates the granted time at which monitoring will cease and the subscription becomes invalid. | + +## 6.2.6.2.49 Type: PrivateIdentities + +**Table 6.2.6.2.49-1: Definition of type PrivateIdentities** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------------|---|-------------|--------------------------------------------| +| privateIdentities | array(PrivateIdentity) | M | 1..N | List of IMS Private Identities associated. | + +## 6.2.6.2.50 Type: PrivateIdentity + +**Table 6.2.6.2.50-1: Definition of type PrivateIdentity** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|---------------------------------------------------| +| privateIdentity | PrivateId | M | 1 | IMS Private Identity. | +| privateIdentityType | PrivateIdentityType | M | 1 | Type of IMS Private Identity (e.g. IMPI or IMSI). | + +#### 6.2.6.2.51 Type: ScscfSelectionAssistanceInformation + +**Table 6.2.6.2.51-1: Definition of type ScscfSelectionAssistanceInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| scscfCapabilityList | ScscfCapabilityList | C | 0..1 | Information about mandatory and optional S-CSCF capabilities.
Shall be present if scscfNames is absent; may be present otherwise. | +| scscfNames | array(string) | C | 1..N | a list of S-CSCF names the UE can be steered to. Each strings shall contain a SIP-URL as defined in IETF RFC 3261 [22] to identify a SIP server (S-CSCF)
Shall be present if scscfCapabilityList is absent; may be present otherwise. | + +#### 6.2.6.2.52 Type: ChargingInfo + +**Table 6.2.6.2.52-1: Definition of type ChargingInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------|------------------|---|-------------|--------------------| +| primaryEventChargingFunctionName | DiameterIdentity | C | 0..1 | See 3GPP TS 29.328 | +| secondaryEventChargingFunctionName | DiameterIdentity | O | 0..1 | See 3GPP TS 29.328 | +| primaryChargingCollectionFunctionName | DiameterIdentity | C | 0..1 | See 3GPP TS 29.328 | +| secondaryChargingCollectionFunctionName | DiameterIdentity | O | 0..1 | See 3GPP TS 29.328 | + +NOTE: At least primaryEventChargingFunctionName or primaryChargingCollectionFunctionName shall be present + +#### 6.2.6.2.53 Type: RepositoryDataList + +**Table 6.2.6.2.53-1: Definition of type RepositoryDataList** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------| +| repositoryDataMap | map(RepositoryData) | M | 1..N | A map (list of key-value pairs where ServiceIndication serves as key) of RepositoryData. | + +#### 6.2.6.2.54 Type: CoreNetworkServiceAuthorization + +**Table 6.2.6.2.54-1: Definition of type CoreNetworkServiceAuthorization** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-----------|---|-------------|-----------------------------| +| subscribedMediaProfileId | integer | O | 0..1 | Subscribed Media Profile ID | + +### 6.2.6.3 Simple data types and enumerations + +#### 6.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. + +#### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Capability | integer | S-CSCF capability | +| SequenceNumber | integer | Unsigned integer containing the sequence number associated to the current version of Repository Data | +| ServiceIndication | string | String containing the Service Indication or Service Identifier | +| Msisdn | string | String containing an additional or basic MSISDN
Pattern: "[0-9]{5,15}\$" | +| PrivateId | string | String containing a Private User Identity or a Private Service Identity. | +| ImsPublicId | string | String containing an IMS Public Identity in SIP URI format or TEL URI format, as specified 3GPP TS 23.003 [13]
Pattern: "^(sip:\{[a-zA-Z0-9_\-\.!~*()&=+\$;,?:V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,})tel:\{[0-9]{5,15}\})\$" | +| NameSpacePriority | string | String containing the namespace and priority. It shall be formatted as "r-value" parameter described in IETF RFC 4412 [19]. See also 3GPP TS 24.229 [18].
Pattern: "[0-9a-zA-Z-!%]* \+\`~\]+\.[0-9a-zA-Z-!%]* \+\`~\]+\-\$" | +| CscfFilterSetId | integer | Contains the identifier of a specific filter set in the S-CSCF.
Minimum=0 | +| SptGroupId | integer | Contains the identifier of the Group of SPTs.
Minimum=0 | +| SharedDataId | string | Identifies globally and uniquely a piece of subscription data shared by multiple UEs. The value shall start with the HPLMN id (MCC/MNC) followed by a hyphen followed by a local Id as allocated by the home network operator.
Pattern: "[0-9]{5,6}\-\-\.+" | +| PrePaging | boolean | Indicates the support of pre-paging. | +| SipServerName | string | Server Name (e.g. AS name, CSCF name) in SIP URI format
Pattern: "^(sip:\{[a-zA-Z0-9_\-\.!~*()&=+\$;,?:V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,})\$" | + +### 6.2.6.3.3 Enumeration: DataSetName + +The enumeration DataSetName represents a Set of Data within the IMS User Profile. It shall comply with the provisions defined in table 6.2.6.3.3-1. + +**Table 6.2.6.3.3-1: Enumeration DataSetName** + +| Enumeration value | Description | +|-------------------|-------------------------------------| +| "CHARGING_DATA" | Charging Information Data | +| "IFC_DATA" | Initial Filter Criteria Data | +| "TRACE_DATA" | IMS service level trace information | +| "PRIORITY_DATA" | Service Priority Levels | + +### 6.2.6.3.4 Enumeration: IdentityType + +The enumeration IdentityType represents the type of IMS Public Identity. It shall comply with the provisions defined in table 6.2.6.3.4-1. + +**Table 6.2.6.3.4-1: Enumeration IdentityType** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------------------| +| "DISTINCT_IMPU" | The identity is an IMS Public User Identity | +| "DISTINCT_PSI" | The identity is an IMS Public Service Identity | +| "WILDCARDED_IMPU" | The identity is an IMS Wildcarded Public User Identity | +| "WILDCARDED_PSI" | The identity is an IMS Wildcarded Public Service Identity | + +#### 6.2.6.3.5 Enumeration: ImsRegistrationState + +The enumeration ImsRegistrationState represents the IMS status of the user or Public Identity or the IRS. It shall comply with the provisions defined in table 6.2.6.3.5-1 + +**Table 6.2.6.3.5-1: Enumeration ImsRegistrationState** + +| Enumeration value | Description | +|-----------------------------|---------------------------------------------------------------------------------------------------------------| +| "REGISTERED" | The identity is explicitly registered by the user. | +| "NOT_REGISTERED" | The identity is not registered. | +| "AUTHENTICATION_PENDING" | The identity initiated a registration and its authentication is ongoing (authentication pending flag is set). | +| "REGISTERED_UNREG_SERVICES" | The identity is not registered but has an S-CSCF assigned. | +| NOTE: | See clause 3.1 for more details on the IMS registration states and terms. | + +#### 6.2.6.3.6 Enumeration: TypeOfCondition + +The enumeration TypeOfCondition represents the type of condition to be applied to the logical expression of SPT groups and SPTs. See 3GPP TS 29.228 [20], Annex C. + +**Table 6.2.6.3.6-1: Enumeration TypeOfCondition** + +| Enumeration value | Description | Applicability | +|-------------------|------------------|---------------| +| "CNF" | Conjunctive form | | +| "DNF" | Disjunctive form | | + +#### 6.2.6.3.7 Enumeration: RegistrationType + +The enumeration RegistrationType represents the type of registration associated to the REGISTER request. + +**Table 6.2.6.3.7-1: Enumeration RegistrationType** + +| Enumeration value | Description | Applicability | +|------------------------|---------------------------------------------------|---------------| +| "INITIAL_REGISTRATION" | The request is related to an initial registration | | +| "RE_REGISTRATION" | The request is related to a re-registration | | +| "DE_REGISTRATION" | The request is related to a de-registration | | + +#### 6.2.6.3.8 Enumeration: RequestDirection + +The enumeration RequestDirection represents the direction of the request in combination with the registration status of the user as evaluated in the S-CSCF. + +**Table 6.2.6.3.8-1: Enumeration RequestDirection** + +| Enumeration value | Description | Applicability | +|----------------------------|--------------------------------------------------------------------------------------------------------------------------------|---------------| +| "ORIGINATING_REGISTERED" | The request is originated by an explicitly registered user. | | +| "ORIGINATING_UNREGISTERED" | The request is originated by a non-registered user. | | +| "ORIGINATING_CDIV " | The REGISTER request is related to an originating request after call diversion service (regardless of the registration state). | | +| "TERMINATING_REGISTERED" | The request is targeted to an explicitly registered user. | | +| "TERMINATING_UNREGISTERED" | The request is targeted to a non-registered user. | | + +#### 6.2.6.3.9 Enumeration: ServiceInformation + +The enumeration ServiceInformation indicates the type of additional information to be included in the body of the SIP request towards the Application Server. + +**Table 6.2.6.3.9-1: Enumeration ServiceInformation** + +| Enumeration value | Description | Applicability | +|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "INCLUDE_REGISTER_REQUEST" | Indicates to the S-CSCF that the incoming SIP REGISTER request is to be transferred to the Application Server. | | +| "INCLUDE_REGISTER_RESPONSE" | Indicates to the S-CSCF that the final SIP response to the incoming SIP REGISTER request is to be transferred to the Application Server. | | +| NOTE: See 3GPP TS 23.218 [43] for the use of this information. | | | + +#### 6.2.6.3.10 Enumeration: RequestedNode + +The enumeration RequestedNode represents serving node requested. It shall comply with the provisions defined in table 6.2.6.3.10-1. + +**Table 6.2.6.3.10-1: Enumeration RequestedNode** + +| Enumeration value | Description | Applicability | +|------------------------|--------------------------------------------|---------------| +| "SGSN" | The requested node is SGSN. | | +| "MME" | The requested node is MME. | | +| "AMF" | The requested node is AMF. | | +| "3GPP_AAA_SERVER_TWAN" | The requested node is 3GPP-AAA-SERVER-TWAN | | + +#### 6.2.6.3.11 Enumeration: SrvccCapability + +The enumeration SrvccCapability represents the type of UE support for SRVCC. It shall comply with the provisions defined in table 6.2.6.3.11-1. + +**Table 6.2.6.3.11-1: Enumeration IdentityType** + +| Enumeration value | Description | +|-----------------------|------------------------| +| "UE_4G_SRVCC_CAPABLE" | UE is 4G SRVCC capable | +| "UE_5G_SRVCC_CAPABLE" | UE is 5G SRVCC capable | + +#### 6.2.6.3.12 Enumeration: ActivationState + +The enumeration ActivationState represents the activation state of a PSI or DSAI tag. It shall comply with the provisions defined in table 6.2.6.3.12-1. + +**Table 6.2.6.3.12-1: Enumeration ActivationState** + +| Enumeration value | Description | +|-------------------|-------------| +| "ACTIVE" | | +| "INACTIVE" | | + +#### 6.2.6.3.13 Enumeration: ImsVoiceOverPsSessionSupport + +The enumeration ImsVoiceOverPsSessionSupport represents the support for Voice over PS associated to the UE. + +**Table 6.2.6.3.13-1: Enumeration ImsVoiceOverPsSessionSupport** + +| Enumeration value | Description | Applicability | +|-------------------------------------|---------------------------------------------|---------------| +| "IMS VOICE OVER PS NOT_SUPPORTED" | Voice over PS is supported for the UE | | +| "IMS VOICE OVER PS_SUPPORTED" | Voice over PS is not supported for the UE | | +| "IMS_VOICE_OVER_PS_SUPPORT_UNKNOWN" | Voice over PS support for the UE is unknown | | + +#### 6.2.6.3.14 Enumeration: AccessType + +The enumeration AccessType represents the type of access. It shall comply with the provisions defined in table 6.2.6.3.14-1. + +**Table 6.2.6.3.14-1: Enumeration AccessType** + +| Enumeration value | Description | Applicability | +|-------------------|-------------|---------------| +| "3GPP_ACCESS" | | | +| "NON_3GPP_ACCESS" | | | + +#### 6.2.6.3.15 Enumeration: UserStatePs + +The enumeration UserStatePs represents the user state in PS domain. + +**Table 6.2.6.3.15-1: Enumeration ImsVoiceOverPsSessionSupport** + +| Enumeration value | Description | Applicability | +|----------------------------------------------------------------------------------------------------|-------------|---------------| +| "DETACHED" | | | +| "ATTACHED_NOT_REACHABLE_FOR_PAGING" | | | +| "ATTACHED_REACHABLE_FOR_PAGING" | | | +| "CONNECTED_NOT_REACHABLE_FOR_PAGING" | | | +| "CONNECTED_REACHABLE_FOR_PAGING" | | | +| "NOT_PROVIDED_FROM_SGSN_OR_MME_OR_AMF" | | | +| "NETWORK_DETERMINED_NOT_REACHABLE" | | | +| NOTE: See 3GPP TS 29.272 [32] for PS/EPS User State and 3GPP TS 29.518 [33] for the 5GS User State | | | + +#### 6.2.6.3.16 Enumeration: UserStateCs + +The enumeration UserStateCs represents the user state in CS domain. + +**Table 6.2.6.3.16-1: Enumeration ImsVoiceOverPsSessionSupport** + +| Enumeration value | Description | Applicability | +|-------------------------------------------------------|-------------|---------------| +| "CAMEL_BUSY" | | | +| "NETWORK_DETERMINED_NOT_REACHABLE" | | | +| "ASSUMED_IDLE" | | | +| "NOT_PROVIDED_FROM_VLR" | | | +| NOTE: See 3GPP TS 23.078 [31] for CS Subscriber State | | | + +### 6.2.6.3.17 Enumeration: PrivateIdentityType + +The enumeration PrivateIdentityType represents the type of IMS Private Identity. It shall comply with the provisions defined in table 6.2.6.3.17-1. + +**Table 6.2.6.3.17-1: Enumeration PrivateIdentityType** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------| +| "IMPI" | The identity is an IMS Private User Identity. | +| "IMSI" | The identity is an IMSI. | + +## 6.2.7 Error Handling + +### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.2.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.2.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_imsSDM service. The following application errors listed in Table 6.2.7.3-1 are specific for the Nhss\_imsSDM service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | +| SERVICE_NOT_FOUND | 404 Not Found | The service (PSI) does not exist in the HPLMN | +| DATA_NOT_FOUND | 404 Not Found | The requested data is not found/does not exist. Additional information (if any) about this application error is indicated for each specific resource. | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used during the modification of an existing subscription when no corresponding context exists. | +| OPERATION_NOT_ALLOWED | 403 Forbidden | The requested data is not allowed to be accessed by the service consumer, e.g. the IMS-AS does not have permissions for the requested resource and/or HTTP method. | +| OUT_OF_SYNC | 409 Conflict | The request could not be completed due to a conflict with the current state of the target resource (wrong version or sequence number) | +| TOO_MUCH_DATA | 413 Content Too Large | The request could not be completed due to large amount of data (e.g. size of repository data is too large). This response may be due to constraints applied by the service producer, e.g. based on local policy. | + +## 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the Nhss\_imsSDM API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | SharedData | When receiving a Nhss_ismSDM_Get service operation request to retrieve a UE's IMS profile data, and the request does not contain a supported-features query parameter indicating support of this feature, the HSS shall not include Shared Data Ids in the response. Instead the HSS may – based on operator policy – take no further action (i.e. allow the UE to get services based on only the UE's individual IMS profile data), or send the shared data as individual data (this may result in notifications of individual subscription data change – if so subscribed – when shared data, which are sent as individual data, are modified, and/or when the UE's Shared Data IDs are modified). | +| 2 | PatchReport | If some of the modifications included in the PATCH request are not successfully implemented, the HSS reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [4]. | + +## 6.2.9 Security + +As indicated in 3GPP TS 33.501 [5], the access to the Nhss\_imsSDM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [35]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [36]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_imsSDM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [36], 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 Nhss\_imsSDM service. + +The Nhss\_imsSDM API defines the following scopes for OAuth2 authorization: + +**Table 6.2.9-1: Oauth2 scopes defined in Nhss\_imsSDM API** + +| Scope | Description | +|--------------------------------------------------------|---------------------------------------------------------------------------| +| "nhss-ims-sdm" | Access to the Nhss IMS Subscription Data Management API | +| "nhss-ims-sdm:registration-status:read" | Access to read the Registration Status resource | +| "nhss-ims-sdm:profile-data:read" | Access to read the Profile Data resource | +| "nhss-ims-sdm:priority-levels:read" | Access to read the Priority Levels resource | +| "nhss-ims-sdm:ifcs:read" | Access to read the Initial Filter Criteria resource | +| "nhss-ims-sdm:service-level-trace-information:read" | Access to read the Service Level Trace Information resource | +| "nhss-ims-sdm:server-name:read" | Access to read the Server Name resource | +| "nhss-ims-sdm:scscf-capabilities:read" | Access to read the S-CSCF Capabilities resource | +| "nhss-ims-sdm:ps-domain:location-data:read" | Access to read the PS-Domain Location Data resource | +| "nhss-ims-sdm:ps-domain:ip-address:read" | Access to read the PS-Domain IP Address resource | +| "nhss-ims-sdm:ps-domain:tads-info:read" | Access to read the PS-Domain TADS Info resource | +| "nhss-ims-sdm:ps-domain:ue-reach-subscriptions:create" | Access to create PS-Domain UE Reachability Subscriptions resources | +| "nhss-ims-sdm:ps-domain:ue-reach-subscriptions:modify" | Access to update/delete a PS-Domain UE Reachability Subscription resource | +| "nhss-ims-sdm:ps-domain:user-state:read" | Access to read the PS-Domain User State resource | +| "nhss-ims-sdm:cs-domain:location-data:read" | Access to read the CS-Domain Location Data resource | +| "nhss-ims-sdm:cs-domain:user-state:read" | Access to read the CS-Domain User State resource | +| "nhss-ims-sdm:cs-domain:csrn:read" | Access to read the CS-Domain CSRN resource | +| "nshh-ims-sdm:wireline-domain:reference-location:read" | Access to read the Wireline-Domain Reference Location resource | +| "nhss-ims-sdm:repository-data:modify" | Access to create/update/delete the Repository Data resource | +| "nhss-ims-sdm:repository-data:read" | Access to read the Repository Data resource | +| "nhss-ims-sdm:identities:read" | Access to read the Identities resource | +| "nhss-ims-sdm:srvcc:read" | Access to read the SRVCC resource | +| "nhss-ims-sdm:srvcc:modify" | Access to update the SRVCC resource | +| "nhss-ims-sdm:psi-status:read" | Access to read the PSI Status resource | +| "nhss-ims-sdm:psi-status:modify" | Access to update the PSI Status resource | +| "nhss-ims-sdm:dsai:read" | Access to read the DSAI resource | +| "nhss-ims-sdm:dsai:modify" | Access to update the DSAI resource | +| "nhss-ims-sdm:sms-registration-info:read" | Access to read the SMS Registration Info resource | +| "nhss-ims-sdm:sms-registration-info:modify" | Access to create/update/delete the SMS Registration Info resource | +| "nhss-ims-sdm:subscriptions:create" | Access to create Subscriptions resources | +| "nhss-ims-sdm:subscription:modify" | Access to update/delete a Subscription resource | +| "nhss-ims-sdm:shared-subscriptions:create" | Access to create a Shared-Data Subscriptions resource | +| "nhss-ims-sdm:shared-subscriptions:modify" | Access to update/delete a Shared-Data Subscription resource | +| "nhss-ims-sdm:shared-subscriptions:read" | Access to read the Shared-Data resource | +| "nhss-ims-sdm:charging-info:read" | Access to read the Charging-Information resource | + +## 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.3 Nhss\_imsUEAuthentication Service API + +### 6.3.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion}/ + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-ims-ueau" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +### 6.3.2 Usage of HTTP + +#### 6.3.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [8], 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]. + +HTTP messages and bodies for the Nhss\_imsUEAU service shall comply with the OpenAPI [9] specification contained in Annex A.3. + +#### 6.3.2.2 HTTP standard headers + +##### 6.3.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.3.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [10], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [11]) signalled by the content type "application/problem+json" +- JSON Patch, as defined in IETF RFC 6902 [12], signalled by the content type "application/json-patch+json" + +#### 6.3.2.3 HTTP custom headers + +##### 6.3.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.3.3 Resources + +### 6.3.3.1 Overview + +![Figure 6.3.3.1-1: Resource URI structure of the Nhss_imSUEAU API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-ims-ueau/v1. It branches to /{impi}, which further branches to /security-information.](9af97997b7d3fbca90b8ddba0ea39c6c_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-ims-ueau/v1"] --> Impi["/{impi}"] + Impi --> SecurityInformation["/security-information"] + +``` + +Figure 6.3.3.1-1: Resource URI structure of the Nhss\_imSUEAU API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-ims-ueau/v1. It branches to /{impi}, which further branches to /security-information. + +**Figure 6.3.3.1-1: Resource URI structure of the Nhss\_imSUEAU API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.3.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|----------------------------------------|---------------------------------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SecurityInformation (Custom operation) | /{impi}/security-information/
generate-sip-auth-data | generate-sip-auth-data (POST) | The HSS takes the variable {impi} and, if applicable, fetches the corresponding SUPI. The HSS calculates a fresh authentication vector based on the received information and the stored security information, if IMS-AKA is selected. Otherwise, the HSS provides the corresponding authentication information. | + +### 6.3.3.2 Resource: SecurityInformation + +#### 6.3.3.2.1 Description + +This resource represents the information that is needed together with the SIP authentication scheme to calculate a fresh authentication vector. + +#### 6.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-ueau/v1/{impi}/security-information + +This resource shall support the resource URI variables defined in table 6.3.3.2.2-1. + +**Table 6.3.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|--------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.3.1 | +| impi | Represents the IMS Private Identity (see 3GPP TS 23.003 [13] clause 13.3.
Pattern: "^(impi-\.+\+\.+\+)\$" | + +### 6.3.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +### 6.3.3.2.4 Resource Custom Operations + +#### 6.3.3.2.4.1 Overview + +**Table 6.3.3.2.4.1-1: Custom operations** + +| Custom operation URI | Mapped HTTP method | Description | +|-------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| /generate-sip-auth-data | POST | Select the authentication method and calculate a fresh AV if IMS-AKA is selected or provides corresponding authentication information. | + +#### 6.3.3.2.4.2 Operation: generate-sip-auth-data + +##### 6.3.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (S-CSCF) to request authentication information data for the IMPI from the HSS. The HSS calculates an authentication vector taking into account the information received from the NF service consumer (S-CSCF) and the current representation of this resource if IMS AKA is selected. For details see 3GPP TS 33.203 [14]. + +##### 6.3.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.3.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.3.3.2.4.2.2-2. + +**Table 6.3.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------| +| SipAuthenticationInfoRequest | M | 1 | Contains the SIP Authentication Scheme, the number of authentication items and Resynchronization Information | + +**Table 6.3.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| SipAuthenticationInfoResult | M | 1 | 200 OK | Upon success, a response body containing the selected authentication method and an authentication vector if IMS AKA has been selected shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION_REJECTED
- UNSUPPORTED_SIP_AUTH_SCHEME | + +**Table 6.3.3.2.4.2.2-3: 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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.3.3.2.4.2.2-4: 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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.3.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nhss\_imsUEAuthentication Service. + +## 6.3.5 Notifications + +In this release of this specification, no notifications are defined for the Nhss\_imsUEAuthentication Service. + +## 6.3.6 Data Model + +### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.1-1 specifies the structured data types defined for the Nhss\_imsUEAU service API. + +**Table 6.3.6.1-1: Nhss\_imsUEAU specific Data Types** + +| Data type | Clause defined | Description | +|------------------------------|----------------|--------------------------------------------------------------------------------------------| +| SipAuthenticationInfoRequest | 6.3.6.2.2 | Contains SIP Authentication Schema, Authentication Items and Resynchronization Information | +| SipAuthenticationInfoResult | 6.3.6.2.3 | Contains authentication information (e.g. authentication vectors, line id) | +| ResynchronizationInfo | 6.3.6.2.4 | Contains RAND and AUTS | +| 3GAkaAv | 6.3.6.2.5 | Contains RAND, XRES, AUTN, CK, and IK | + +Table 6.3.6.1-2 specifies data types re-used by the Nhss\_imsUEAU service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_imsUEAU. + +**Table 6.3.6.1-2: Nhss\_imsUEAU re-used Data Types** + +| Data type | Reference | Comments | +|--------------------|---------------------|---------------------------------------------------------------------------| +| ProblemDetails | 3GPP TS 29.571 [16] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [16] | Response body of redirect response messages. | +| IpAddr | 3GPP TS 29.571 [16] | IP Address (either IPv4 address, IPv6 address or IPv6 prefix) | +| Autn | 3GPP TS 29.503 [15] | AUTN component of the Authentication Vector | +| Auts | 3GPP TS 29.503 [15] | AUTS component of the Resynchronization Info | +| Rand | 3GPP TS 29.503 [15] | RAND component of the Authentication Vector or the Resynchronization Info | +| Xres | 3GPP TS 29.503 [15] | XRES component of the Authentication Vector | +| ConfidentialityKey | 3GPP TS 29.503 [15] | CK component of the Authentication Vector | +| IntegrityKey | 3GPP TS 29.503 [15] | IK component of the Authentication Vector | + +### 6.3.6.2 Structured data types + +#### 6.3.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 6.3.6.2.2 Type: SipAuthenticationInfoRequest + +**Table 6.3.6.2.3-1: Definition of type AuthenticationInfoRequest** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cscfServerName | string | M | 1 | S-CSCF name in SIP URI format | +| sipAuthenticationScheme | SipAuthenticationScheme | M | 1 | SIP Authentication Scheme requested by service consumer (S-CSCF) | +| sipNumberAuthItems | SipNumberAuthItems | O | 0..1 | Number of authentication items (AVs). Absence indicates that only one AV is requested. This attribute shall be absent for authentication schemes other than IMS AKA. | +| resynchronizationInfo | ResynchronizationInfo | O | 0..1 | Contains RAND and AUTS; see 3GPP TS 33.203 [14]. This attribute shall be included only if a resynchronization procedure needs to be triggered. This attribute shall be absent for authentication schemes other than IMS AKA. | + +#### 6.3.6.2.3 Type: SipAuthenticationInfoResult + +**Table 6.3.6.2.3-1: Definition of type AuthenticationInfoResult** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------| +| sipAuthenticationScheme | SipAuthenticationScheme | M | 1 | SIP Authentication Scheme used by service producer (HSS) | +| 3gAkaAvs | array(3GAkaAv) | O | 1..N | If IMS AKA is requested, it shall be present and will contain Authentication Vectors. | +| digestAuth | DigestAuthentication | O | 0..1 | If SIP Digest is used, it shall be present and shall contain the digest realm, algorithm, QoP and HA1. | +| lineIdentifierList | array(LineIdentifier) | O | 0..N | If NBA is used, it shall be present and shall contain a list of fixed broadband access line identifiers associated to the user. | +| ipAddress | IpAddr | O | 0..1 | If GIBA is used, it shall be present and shall contain an IP address (IPv4, or IPv6, or IPv6 prefix) | + +#### 6.3.6.2.4 Type: ResynchronizationInfo + +**Table 6.3.6.2.4-1: Definition of type ResynchronizationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| rand | Rand | M | 1 | | +| auts | Auts | M | 1 | | + +#### 6.3.6.2.5 Type: 3GAkaAv + +**Table 6.3.6.2.5-1: Definition of type 3gAkaAv** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------|---|-------------|---------------------------------------------| +| rand | Rand | M | 1 | RAND component of the Authentication Vector | +| xres | Xres | M | 1 | XRES component of the Authentication Vector | +| autn | Autn | M | 1 | AUTN component of the Authentication Vector | +| ck | ConfidentialityKey | M | 1 | CK component of the Authentication Vector | +| ik | IntegrityKey | M | 1 | IK component of the Authentication Vector | + +#### 6.3.6.2.6 Type: DigestAuthentication + +**Table 6.3.6.2.6-1: Definition of type DigestAuthentication** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|--------------------|---|-------------|------------------------------------------------| +| digestRealm | string | M | 1 | Digest realm. See IETF RFC 4740 [17]. | +| digestAlgorithm | SipDigestAlgorithm | M | 1 | Digest Algorithm. See IETF RFC 4740 [17]. | +| digestQop | SipDigestQop | M | 1 | Quality of Protection. See IETF RFC 4740 [17]. | +| ha1 | string | M | 1 | Hash H(A1). See IETF RFC 4740 [17]. | + +#### 6.3.6.2.7 Void + +### 6.3.6.3 Simple data types and enumerations + +#### 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.3.6.3.2 Simple data types + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +**Table 6.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|--------------------|-----------------|----------------------------------------------| +| SipNumberAuthItems | integer | Number of authentication items
Minimum: 1 | +| Impi | string | IMS Private User Identity | +| LineIdentifier | string | Line Identifier for the wireline access | + +#### 6.3.6.3.3 Enumeration: SipAuthenticationScheme + +The enumeration SipAuthenticationScheme represents an IMS authentication scheme. It shall comply with the provisions defined in table 6.3.6.3.3-1. + +**Table 6.3.6.3.3-1: Enumeration SipAuthenticationScheme** + +| Enumeration value | Description | +|--------------------|---------------------------------------------------------------------| +| "DIGEST-AKAV1-MD5" | IMS-AKA authentication scheme | +| "DIGEST-HTTP" | SIP Digest authentication scheme | +| "NBA" | NASS Bundled authentication scheme | +| "GIBA" | GPRS-IMS-Bundled authentication scheme | +| "UNKNOWN" | Authentication scheme to be used is unknown by the service consumer | + +#### 6.3.6.3.4 Enumeration: SipDigestAlgorithm + +The enumeration SipDigestAlgorithm represents the algorithm for SIP Digest scheme. It shall comply with the provisions defined in table 6.3.6.3.4-1. + +**Table 6.3.6.3.4-1: Enumeration SipDigestAlgorithm** + +| Enumeration value | Description | +|-------------------|-------------| +| "MD5" | | +| "MD5_SESS" | | + +#### 6.3.6.3.5 Enumeration: SipDigestQop + +The enumeration SipDigestQop represents the quality of protection for SIP Digest scheme. It shall comply with the provisions defined in table 6.3.6.3.5-1. + +**Table 6.3.6.3.5-1: Enumeration SipDigestQop** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------| +| "AUTH" | Indicates authentication | +| "AUTH_INT" | Indicates authentication with integrity protection | + +### 6.3.7 Error Handling + +#### 6.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.3.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.3.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_imsUEAuthentication service. The following application errors listed in Table 6.3.7.3-1 are specific for the Nhss\_imsUEAuthentication service. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------|---------------------|------------------------------------------------------------------| +| AUTHENTICATION_REJECTED | 403 Forbidden | The user cannot be authenticated with this authentication method | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | +| UNSUPPORTED_SIP_AUTHENTICATION_SCHEME | 501 Not implemented | The received SIP authentication scheme is not supported by HPLMN | + +### 6.3.8 Feature Negotiation + +### 6.3.9 Security + +As indicated in 3GPP TS 33.501 [5], the access to the Nhss\_imsUEAU API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [35]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [36]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_imsUEAU API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [36], 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 Nhss\_imsUEAU service. + +The Nhss\_imsUEAU API defines the following scopes for OAuth2 authorization: + +**Table 6.3.9-1: OAuth2 scopes defined in Nhss\_imsUEAU API** + +| Scope | Description | +|-----------------------------------------------|-----------------------------------------------------------| +| "nhss-ims-ueau" | Access to the Nhss IMS UE Context Management API | +| "nhss-ims-ueau:generate-sip-auth-data:invoke" | Access to invoke the Generate SIP Auth Data custom method | + +### 6.3.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.4 Nhss\_gbaSubscriberDataManagement Service API + +### 6.4.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion} + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-gba-sdm" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +### 6.4.2 Usage of HTTP + +#### 6.4.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [8], 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]. + +HTTP messages and bodies for the Nhss\_gbaSubscriberDataManagement service shall comply with the OpenAPI [9] specification contained in Annex A.5. + +#### 6.4.2.2 HTTP standard headers + +##### 6.4.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.4.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [10], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [11]) signalled by the content type "application/problem+json" +- JSON Patch, as defined in IETF RFC 6902 [12], signalled by the content type "application/json-patch+json" + +#### 6.4.2.3 HTTP custom headers + +##### 6.4.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.4.3 Resources + +#### 6.4.3.1 Overview + +![Figure 6.4.3.1-1: Resource URI structure of the Nhss_gbaSDM API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nhss-gba-sdm/v1. A vertical line descends from the root to a box containing /{ueId}. From this box, a horizontal line extends to the right, with two vertical branches leading to boxes containing /gba-subscriber-data and /subscriptions. From the /subscriptions box, another vertical line descends to a box containing /{subscriptionId}.](92171b3c1fa1c46db587486e1a4a260f_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-gba-sdm/v1"] --> ueId["/{ueId}"] + ueId --> gbaData["/gba-subscriber-data"] + ueId --> subscriptions["/subscriptions"] + subscriptions --> subscriptionId["/{subscriptionId}"] + +``` + +Figure 6.4.3.1-1: Resource URI structure of the Nhss\_gbaSDM API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nhss-gba-sdm/v1. A vertical line descends from the root to a box containing /{ueId}. From this box, a horizontal line extends to the right, with two vertical branches leading to boxes containing /gba-subscriber-data and /subscriptions. From the /subscriptions box, another vertical line descends to a box containing /{subscriptionId}. + +**Figure 6.4.3.1-1: Resource URI structure of the Nhss\_gbaSDM API** + +Table 6.4.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.4.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------|----------------------------------------|---------------------------------|-------------| +| GBA Subscriber Data (Document) | /{ueId}/gba-subscriber-data | GET | | +| GBA SDM Subscriptions (Collection) | /{ueId}/subscriptions | POST | | +| GBA SDM Individual Subscription (Document) | /{ueId}/subscriptions/{subscriptionId} | PATCH | | +| | | DELETE | | + +## 6.4.3.2 Resource: GBA Subscriber Data + +### 6.4.3.2.1 Description + +This resource represents the subscriber data of the UE for GBA, including the GBA User Security Settings (GUSS). + +### 6.4.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-gba-sdm/v1/{ueId}/gba-subscriber-data + +This resource shall support the resource URI variables defined in table 6.4.3.2.2-1. + +**Table 6.4.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| ueId | Represents the UE Identity. See clause 6.4.6.3.2. | + +### 6.4.3.2.3 Resource Standard Methods + +#### 6.4.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.4.3.2.3.1-1. + +**Table 6.4.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.4.3.2.3.1-2 and the response data structures and response codes specified in table 6.4.3.2.3.1-3. + +**Table 6.4.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.4.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------| +| GbaSubscriberData | M | 1 | 200 OK | A response body containing the GBA subscriber data of the UE; it includes the GBA User Security Settings (GUSS) data. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | + +**Table 6.4.3.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 of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.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 of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.4.3.3 Resource: Subscriptions + +#### 6.4.3.3.1 Description + +This resource is used to represent subscriptions to notifications of data change. + +#### 6.4.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nhss-gba-sdm/{apiVersion}/{ueId}/subscriptions + +This resource shall support the resource URI variables defined in table 6.4.3.3.2-1. + +**Table 6.4.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| apiVersion | See clause 6.4.1 | +| ueId | Represents the UE Identity. See clause 6.4.6.3.2. | + +### 6.4.3.3.3 Resource Standard Methods + +#### 6.4.3.3.3.1 POST + +This method shall support the URI query parameters specified in table 6.4.3.3.3.1-1. + +**Table 6.4.3.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.4.3.3.3.1-2 and the response data structures and response codes specified in table 6.4.3.3.3.1-3. + +**Table 6.4.3.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------| +| GbaSdmSubscription | M | 1 | The subscription that is to be created. | + +**Table 6.4.3.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| GbaSdmSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate the following application error:
- UNSUPPORTED_RESOURCE_URI

This response shall not be cached. | + +**Table 6.4.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.3.3.1-6: 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}/nhss-gba-sdm///subscriptions/ | + +### 6.4.3.4 Resource: Individual subscription + +#### 6.4.3.4.1 Description + +This resource is used to represent an individual subscription to notifications of data change. + +#### 6.4.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nhss-gba-sdm/{apiVersion}/{ueId}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.4.3.4.2-1. + +**Table 6.4.3.4.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|----------------------------------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| apiVersion | See clause 6.4.1 | +| ueId | Represents the UE Identity. See clause 6.4.6.3.2. | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications. | + +#### 6.4.3.4.3 Resource Standard Methods + +##### 6.4.3.4.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.4.3.4.3.1-1. + +**Table 6.4.3.4.3.1-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 6.4.3.4.3.1-2 and the response data structures and response codes specified in table 6.4.3.4.3.1-3. + +**Table 6.4.3.4.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.4.3.4.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.4.3.4.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.4.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.4.3.4.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.4.3.4.3.2-1. + +**Table 6.4.3.4.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.4.3.4.3.2-2 and the response data structures and response codes specified in table 6.4.3.4.3.2-3. + +**Table 6.4.3.4.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12]. | + +**Table 6.4.3.4.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with no content is returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate the following application error:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.4.3.4.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.4.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.4.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nhss\_gbaSDM Service. + +## 6.4.5 Notifications + +### 6.4.5.1 General + +This clause specifies the use of notifications and corresponding protocol details. + +## 6.4.5.2 Data Change Notification + +The POST method shall be used for Data Change Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.4.5.2-1. + +**Table 6.4.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.4.5.2-2 and of response data structures and response codes is specified in table 6.4.5.2-3. + +**Table 6.4.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-------------| +| ModificationNotification | M | 1 | | + +**Table 6.4.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- CONTEXT_NOT_FOUND

See table 6.4.7.3-1 for the description of this error. | + +**Table 6.4.5.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 notification endpoint of the subscribing NF. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.5.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 notification endpoint of the subscribing NF. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.4.6 Data Model + +### 6.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.6.1-1 specifies the structured data types defined for the Nhss\_gbaSDM service API. + +**Table 6.4.6.1-1: Nhss\_gbaSDM specific Data Types** + +| Data type | Clause defined | Description | +|--------------------|----------------|-------------| +| GbaSubscriberData | 6.4.6.2.2 | | +| Guss | 6.4.6.2.3 | | +| BsfInfo | 6.4.6.2.4 | | +| GbaSdmSubscription | 6.4.6.2.5 | | +| Ueld | 6.4.6.3.2 | | + +Table 6.4.6.1-2 specifies data types re-used by the Nhss\_gbaSDM service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_gbaSDM. + +**Table 6.4.6.1-2: Nhss\_gbaSDM re-used Data Types** + +| Data type | Reference | Comments | +|--------------------------|---------------------|----------------------------------------------| +| UssListItem | 3GPP TS 29.309 [42] | | +| SecFeature | 3GPP TS 29.309 [42] | | +| ModificationNotification | 3GPP TS 29.503 [15] | | +| NfInstanceId | 3GPP TS 29.571 [16] | | +| Uri | 3GPP TS 29.571 [16] | | +| DateTime | 3GPP TS 29.571 [16] | | +| DurationSec | 3GPP TS 29.571 [16] | | +| ProblemDetails | 3GPP TS 29.571 [16] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [16] | Response body of redirect response messages. | +| ImSUId | 3GPP TS 29.562 | IMS UE ID (IMPU or IMPI) | + +### 6.4.6.2 Structured data types + +#### 6.4.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 6.4.6.2.2 Type: GbaSubscriberData + +**Table 6.4.6.2.2-1: Definition of type GbaSubscriberData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| guss | Guss | M | 1 | | + +#### 6.4.6.2.3 Type: Guss + +**Table 6.4.6.2.3-1: Definition of type Guss** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------|---|-------------|---------------------------| +| bsfInfo | BsfInfo | O | 0..1 | BSF-specific information. | +| ussList | array(UssListItem) | O | 1..N | | + +#### 6.4.6.2.4 Type: BsflInfo + +**Table 6.4.6.2.4-1: Definition of type BsflInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| uiccType | UiccType | O | 0..1 | It indicates whether GBA or GBA_U is to be used; default value is GBA. | +| lifeTime | DurationSec | O | 0..1 | It indicates a user-specific key lifetime (duration in seconds). If the lifeTime element is missing the default value in the BSF is used. | +| securityFeatures | array(SecFeature) | O | 1..N | It indicates a user-specific security feature list that the UE supports. If the securityFeature element is missing, then the security features are not defined. Standard security features are defined in 3GPP TS 29.309 [42], clause 6.1.6.3.5. | + +#### 6.4.6.2.5 Type: GbaSdmSubscription + +**Table 6.4.6.2.5-1: Definition of type GbaSdmSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|---------------|---|-------------|-------------| +| nflInstanceId | NflInstanceId | M | 1 | | +| callbackReference | Uri | M | 1 | | +| monitoredResourceUris | array(Uri) | M | 1..N | | +| expires | DateTime | O | 0..1 | | + +### 6.4.6.3 Simple data types and enumerations + +#### 6.4.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.4.6.3.2 Simple data types + +The simple data types defined in table 6.4.6.3.2-1 shall be supported. + +**Table 6.4.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|--------------------------------------------|----------------------------------------------------------------------| +| Ueld | string | Identity of the UE. It can be an MSISDN, an IMSI an IMPI or an IMPU. | +| Msisdn | string
pattern: '^msisdn-[0-9]{5,15}\$' | MS-ISDN of the UE. | +| Imsi | string
pattern: '^imsi-[0-9]{5,15}\$' | IMSI of the UE. | + +#### 6.4.6.3.3 Enumeration: UiccType + +The enumeration UiccType represents whether GBA or GBA\_U is to be used. It shall comply with the provisions defined in table 6.4.6.3.4-1. + +**Table 6.4.6.3.4-1: Enumeration UiccType** + +| Enumeration value | Description | +|-------------------|---------------------------------------------------------------| +| "GBA" | GBA: Basic GBA case (no generation of Ks_int_NAF at the BSF). | +| "GBA_U" | GBA_U: Generation of Ks_int_NAF is required at the BSF. | + +## 6.4.7 Error Handling + +### 6.4.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.4.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.4.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_gbaSDM service. The following application errors listed in Table 6.4.7.3-1 are specific for the Nhss\_gbaSDM service. + +**Table 6.4.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | +| CONTEXT_NOT_FOUND | 404 Not Found | The service consumer has received a notification from a service producer for a subscription that is unknown to the service consumer. | + +## 6.4.8 Feature Negotiation + +The optional features in table 6.4.8-1 are defined for the Nhss\_gbaSDM API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.4.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.4.9 Security + +As indicated in 3GPP TS 33.501 [5], the access to the Nhss\_gbaSDM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [35]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [36]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_gbaSDM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [36], 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 Nhss\_gbaSDM service. + +The Nhss\_gbaSDM API defines the following scopes for OAuth2 authorization: + +**Table 6.4.9-1: OAuth2 scopes defined in Nhss\_gbaSDM API** + +| Scope | Description | +|-----------------------------------------|-------------------------------------------------| +| "nhss-gba-sdm" | Access to the Nhss_gbaSDM API | +| "nhss-gba-sdm:gba-subscriber-data:read" | Access to read the GBA Subscriber Data resource | + +## 6.4.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# 6.5 Nhss\_gbaUEAuthentication Service API + +## 6.5.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion} + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-gba-ueau" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +## 6.5.2 Usage of HTTP + +### 6.5.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [8], 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]. + +HTTP messages and bodies for the Nhss\_gbaUEAuthentication service shall comply with the OpenAPI [9] specification contained in Annex A.6. + +### 6.5.2.2 HTTP standard headers + +#### 6.5.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.5.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [10], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [11]) signalled by the content type "application/problem+json" + +### 6.5.2.3 HTTP custom headers + +#### 6.5.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.5.3 Resources + +### 6.5.3.1 Overview + +![Figure 6.5.3.1-1: Resource URI structure of the Nhss_gbaUEAU API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-gba-ueau/v1. A line branches down to a box containing {/ueId}. From this box, a line branches down to a box containing /security-information. From this box, a line branches down to a dashed box containing /generate-auth-data.](5bd8085079508bb158cfc55b1007a459_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-gba-ueau/v1"] --> ueId["{/ueId}"] + ueId --> security["/security-information"] + security --> authData["/generate-auth-data"] + style authData stroke-dasharray: 5 5 + +``` + +Figure 6.5.3.1-1: Resource URI structure of the Nhss\_gbaUEAU API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-gba-ueau/v1. A line branches down to a box containing {/ueId}. From this box, a line branches down to a box containing /security-information. From this box, a line branches down to a dashed box containing /generate-auth-data. + +**Figure 6.5.3.1-1: Resource URI structure of the Nhss\_gbaUEAU API** + +Table 6.5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.5.3.1-1: Resources and methods overview** + +| Resource name
(Archetype) | Resource URI | HTTP
method
or
custom
operation | Description | +|-------------------------------------------|-----------------------------------------------------|---------------------------------------------|-------------| +| SecurityInformation
(Custom operation) | /{ueId}/security-information/
generate-auth-data | generate-
auth-data
(POST) | | + +### 6.5.3.2 Resource: SecurityInformation (Custom Operation) + +#### 6.5.3.2.1 Description + +This resource represents the information that is needed to calculate a fresh authentication vector for GBA. + +#### 6.5.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-gba-ueau/v1/{ueId}/security-information + +This resource shall support the resource URI variables defined in table 6.5.3.2.2-1. + +**Table 6.5.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------------------------------------------------------------------| +| apiRoot | See clause 6.5.1 | +| ueId | Represents the UE Identity. It can be an MSISDN, an IMSI an IMPI or an IMPU. | + +#### 6.5.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +### 6.5.3.2.3 Resource Custom Operations + +#### 6.5.3.2.4.1 Overview + +**Table 6.5.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|--------------------|----------------------|--------------------|-------------| +| generate-auth-data | /generate-auth-data | POST | | + +#### 6.5.3.2.4.2 Operation: generate-auth-data + +##### 6.5.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (BSF) to request authentication information data for the UE from the HSS. + +##### 6.5.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.5.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.5.3.2.4.2.2-2. + +**Table 6.5.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|-------------| +| AuthenticationInfo Request | M | 1 | | + +**Table 6.5.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------| +| AuthenticationInfoResult | M | 1 | 200 OK | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | + +**Table 6.5.3.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 of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.5.3.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 of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.5.5 Notifications + +In this release of this specification, no notifications are defined for the Nhss\_gbaUEAuthentication Service. + +## 6.5.6 Data Model + +### 6.5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.5.6.1-1 specifies the structured data types defined for the Nhss\_gbaUEAU service API. + +**Table 6.5.6.1-1: Nhss\_gbaUEAU specific Data Types** + +| Data type | Clause defined | Description | +|---------------------------|----------------|-------------| +| AuthenticationInfoRequest | 6.5.6.2.2 | | +| AuthenticationInfoResult | 6.5.6.2.3 | | +| DigestAuthentication | 6.5.6.2.6 | | +| Impi | 6.5.6.3.2 | | +| AuthenticationScheme | 6.5.6.3.3 | | +| DigestAlgorithm | 6.5.6.3.4 | | +| DigestQop | 6.5.6.3.5 | | + +Table 6.5.6.1-2 specifies data types re-used by the Nhss\_gbaUEAU service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_gbaUEAU. + +**Table 6.5.6.1-2: Nhss\_gbaUEAU re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------|---------------------|----------------------------------------------| +| Autn | 3GPP TS 29.503 [15] | | +| Auts | 3GPP TS 29.503 [15] | | +| Rand | 3GPP TS 29.503 [15] | | +| Xres | 3GPP TS 29.503 [15] | | +| ProblemDetails | 3GPP TS 29.571 [16] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [16] | Response body of redirect response messages. | +| SupportedFeatures | 3GPP TS 29.571 [16] | | +| ResynchronizationInfo | 3GPP TS 29.562 | Clause 6.3.6.2.4 | +| 3GAkaAv | 3GPP TS 29.562 | Clause 6.3.6.2.5 | +| Ueld | 3GPP TS 29.562 | Clause 6.4.6.3.2 | + +### 6.5.6.2 Structured data types + +#### 6.5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 6.5.6.2.2 Type: AuthenticationInfoRequest + +**Table 6.5.6.2.2-1: Definition of type AuthenticationInfoRequest** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------------|---|-------------|-------------| +| authenticationScheme | AuthenticationScheme | M | 1 | | +| resynchronizationInfo | ResynchronizationInfo | O | 0..1 | | +| supportedFeatures | SupportedFeatures | O | 0..1 | | + +## 6.5.6.2.3 Type: AuthenticationInfoResult + +**Table 6.5.6.2.3-1: Definition of type AuthenticationInfoResult** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|----------------------|---|-------------|-------------| +| impi | Impi | O | 0..1 | | +| 3gAkaAv | 3gAkaAv | O | 0..1 | | +| digestAuth | DigestAuthentication | O | 0..1 | | +| supportedFeatures | SupportedFeatures | O | 0..1 | | + +## 6.5.6.2.4 Void + +## 6.5.6.2.5 Void + +## 6.5.6.2.6 Type: DigestAuthentication + +**Table 6.5.6.2.6-1: Definition of type DigestAuthentication** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------|---|-------------|-------------| +| digestRealm | string | M | 1 | | +| digestAlgorithm | DigestAlgorithm | M | 1 | | +| digestQop | DigestQop | M | 1 | | +| ha1 | string | M | 1 | | + +## 6.5.6.3 Simple data types and enumerations + +## 6.5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.5.6.3.2 Simple data types + +The simple data types defined in table 6.5.6.3.2-1 shall be supported. + +**Table 6.5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------------------------| +| Impi | string | IMS Private User Identity | +| Ck | string | pattern: "^[A-Fa-f0-9]{32}\$" | +| lk | string | pattern: "^[A-Fa-f0-9]{32}\$" | + +## 6.5.6.3.3 Enumeration: AuthenticationScheme + +The enumeration AuthenticationScheme represents the authentication scheme used in GBA. It shall comply with the provisions defined in table 6.5.6.3.3-1. + +**Table 6.5.6.3.3-1: Enumeration AuthenticationScheme** + +| Enumeration value | Description | +|--------------------|-------------------------------| +| "DIGEST_AKAV1_MD5" | IMS-AKA authentication scheme | +| "DIGEST_HTTP" | Digest authentication scheme | + +#### 6.5.6.3.4 Enumeration: DigestAlgorithm + +The enumeration DigestAlgorithm represents the algorithm for the Digest scheme. It shall comply with the provisions defined in table 6.5.6.3.4-1. + +**Table 6.5.6.3.4-1: Enumeration DigestAlgorithm** + +| Enumeration value | Description | +|-------------------|---------------------------------------------| +| "MD5" | MD5 digest algorithm | +| "MD5_SESS" | Session variant of the MD5 digest algorithm | + +#### 6.5.6.3.5 Enumeration: DigestQop + +The enumeration DigestQop represents the quality of protection for the Digest scheme. It shall comply with the provisions defined in table 6.5.6.3.5-1. + +**Table 6.5.6.3.5-1: Enumeration DigestQop** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------| +| "AUTH" | Indicates authentication | +| "AUTH_INT" | Indicates authentication with integrity protection | + +### 6.5.7 Error Handling + +#### 6.5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.5.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.5.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_gbaUEAU service. The following application errors listed in Table 6.5.7.3-1 are specific for the Nhss\_gbaUEAU service. + +**Table 6.5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------|------------------|--------------------------------------------------------------------------------------| +| OPERATION_NOT_ALLOWED | 403 Forbidden | The NF Service Consumer is not authorized to invoke the requested service operation. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN. | + +### 6.5.8 Feature Negotiation + +The optional features in table 6.5.8-1 are defined for the Nhss\_gbaUEAU API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.5.9 Security + +As indicated in 3GPP TS 33.501 [5], the access to the Nhss\_gbaUEAU API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [35]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [36]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_gbaUEAU API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [36], 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 Nhss\_gbaUEAU service. + +The Nhss\_gbaUEAU API defines the following scopes for OAuth2 authorization: + +**Table 6.5.9-1: OAuth2 scopes defined in Nhss\_gbaUEAU API** + +| Scope | Description | +|-------------------------------------------|---------------------------------------------------| +| "nhss-gba-ueau" | Access to the Nhss_gbaUEAU API | +| "nhss-gba-ueau:generate-auth-data:invoke" | Access to invoke the Generate Auth Data operation | + +## 6.5.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nhss IMS API(s). It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [34] clause 5B). + +## A.2 Nhss\_imsUECM API + +``` +openapi: 3.0.0 + +info: + version: '1.2.0-alpha.2' + title: 'Nhss_imsUECM' + description: | + Nhss UE Context Management Service for IMS. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 18.2.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' + +servers: + - url: '{apiRoot}/nhss-ims-uecm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + +paths: + + /{impu}/authorize: + post: + summary: > + Authorize IMS Identities to register in the network or establish multimedia sessions + and return CSCF location if it is stored + operationId: Authorize + tags: + - Authorize (Custom Operation) + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:authorize:invoke + parameters: + - name: impu + in: path +``` + +``` + description: Public identity of the user. + required: true + schema: + $ref: '#/components/schemas/Impu' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationRequest' + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + deregistrationNotification: + '{request.body#/deregCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeregistrationData' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +``` + +``` + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/scscf-registration: + put: + summary: SCSCF registration information + operationId: SCSCF registration + tags: + - S-CSCF Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:registration:create + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRegistration' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRegistration' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-uecm/v1/{imsUeId}/scscf-registration + required: true + schema: + type: string + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRegistration' + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtendedProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +``` + +``` + + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/scscf-registration/scscf-restoration-info: + put: + summary: Update the S-CSCF restoration information of the UE + operationId: UpdateScscfRestorationInfo + tags: + - S-CSCF Restoration Information (Document) + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:restoration:modify + parameters: + - name: imsUeId + in: path + description: IMS Identity. + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRestorationInfoRequest' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRestorationInfoResponse' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-uecm/v1/{imsUeId}/scscf-registration/scscf-restoration-info + required: true + schema: + type: string + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRestorationInfoResponse' + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + +``` + +``` +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve the S-CSCF restoration information of the UE + operationId: GetScscfRestorationInfo + tags: + - S-CSCF Restoration Information (Document) + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:restoration:read + parameters: + - name: impu + in: path + description: Public identity of the user. + required: true + schema: + $ref: '#/components/schemas/Impu' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRestorationInfoResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete the S-CSCF restoration information of the UE + operationId: DeleteScscfRestorationInfo + tags: + - S-CSCF Restoration Information (Document) + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:restoration:modify + parameters: + - name: impu +``` + +``` + + in: path + description: Public identity of the user. + required: true + schema: + $ref: '#/components/schemas/Impu' + responses: + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ims-uecm: Access to the Nhss IMS UE Context Management API + nhss-ims-uecm:authorize:invoke: Access to invoke the Authorize custom operation + nhss-ims-uecm:registration:create: Access to create the S-CSCF Registration resource + nhss-ims-uecm:restoration:read: Access to read the S-CSCF Restoration resource + nhss-ims-uecm:restoration:modify: >- + Access to create/update/delete the S-CSCF Restoration resource + +schemas: + +# +# COMPLEX TYPES: +# + + AuthorizationRequest: + description: Ims authorization request data + type: object + required: + - authorizationType + properties: + impi: + $ref: '#/components/schemas/Impi' + authorizationType: + $ref: '#/components/schemas/AuthorizationType' + visitedNetworkIdentifier: + type: string + emergencyIndicator: + type: boolean + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + AuthorizationResponse: + description: Ims Registration authorization information result + type: object + properties: + authorizationResult: + $ref: '#/components/schemas/AuthorizationResult' + cscfServerName: + type: string + +``` + +``` + scscfSelectionAssistanceInfo: + $ref: 'TS29562_Nhss_imsSDM.yaml#/components/schemas/ScscfSelectionAssistanceInformation' + required: + - authorizationResult + oneOf: + - required: + - cscfServerName + - required: + - scscfSelectionAssistanceInfo + +ScscfRegistration: + description: Scscf Registration + type: object + required: + - imsRegistrationType + - cscfServerName + properties: + impi: + $ref: '#/components/schemas/Impi' + imsRegistrationType: + $ref: '#/components/schemas/ImsRegistrationType' + cscfServerName: + type: string + scscfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + deregCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + associatedImpis: + type: array + items: + $ref: '#/components/schemas/Impi' + associatedRegisteredImpis: + type: array + items: + $ref: '#/components/schemas/Impi' + irsImpus: + type: array + items: + $ref: '#/components/schemas/Impu' + minItems: 1 + uniqueItems: true + wildcardedPui: + $ref: '#/components/schemas/Impu' + looseRouteIndicator: + $ref: '#/components/schemas/LooseRouteIndication' + wildcardedPsi: + $ref: '#/components/schemas/Impu' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + multipleRegistrationIndicator: + type: boolean + pscfRestorationIndicator: + type: boolean + default: false + scscfReselectionIndicator: + type: boolean + default: false + +ExtendedProblemDetails: + description: > + Extension of the ProblemDetails data type, to include additional information + in an error response message + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionalInfo' + +AdditionalInfo: + description: > + Additional information to be sent on error response messages, along with the + common content in ProblemDetails + type: object + properties: + scscfServerName: + type: string + +ScscfRestorationInfo: + description: S-CSCF restoration information + type: object +``` + +``` +properties: + userName: + $ref: '#/components/schemas/Impi' + restorationInfo: + type: array + items: + $ref: '#/components/schemas/RestorationInfo' + registrationTimeout: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + sipAuthenticationScheme: + $ref: 'TS29562_Nhss_imsUEAU.yaml#/components/schemas/SipAuthenticationScheme' + +ScscfRestorationInfoRequest: + description: S-CSCF restoration information request + type: object + properties: + scscfRestorationInfoRequest: + $ref: '#/components/schemas/ScscfRestorationInfo' + +ScscfRestorationInfoResponse: + description: S-CSCF restoration information response + type: object + properties: + scscfRestorationInfoResponse: + type: array + items: + $ref: '#/components/schemas/ScscfRestorationInfo' + +RestorationInfo: + description: > + The information relevant to a specific registration required for an S-CSCF + to handle the requests for a user + type: object + required: + - path + - contact + properties: + path: + type: string + contact: + type: string + initialCSeqSequenceNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + callIdSipHeader: + type: string + ueSubscriptionInfo: + $ref: '#/components/schemas/UeSubscriptionInfo' + pcscfSubscriptionInfo: + $ref: '#/components/schemas/PcscfSubscriptionInfo' + imsSdmSubscriptions: + description: > + A map (list of key-value pairs where subscriptionId serves as key) of ImsSdmSubscription + type: object + additionalProperties: + $ref: 'TS29562_Nhss_imsSDM.yaml#/components/schemas/ImsSdmSubscription' + +UeSubscriptionInfo: + description: Subscription information of the UE for the SIP Registration State event + type: object + required: + - callIdSipHeader + - fromSipHeader + - toSipHeader + - recordRoute + - contact + properties: + callIdSipHeader: + type: string + fromSipHeader: + type: string + toSipHeader: + type: string + recordRoute: + type: string + contact: + type: string + +PcscfSubscriptionInfo: +``` + +``` + +description: Subscription information of the P-CSCF for the SIP Registration State event +type: object +required: +- callIdSipHeader +- fromSipHeader +- toSipHeader +- contact +properties: +callIdSipHeader: +type: string +fromSipHeader: +type: string +toSipHeader: +type: string +contact: +type: string + +DeregistrationData: +description: Data related to the de-registration information of a S-CSCF in HSS +type: object +required: +- deregReason +- impi +properties: +deregReason: +$ref: '#/components/schemas/DeregistrationReason' +impi: +$ref: '#/components/schemas/Impi' +associatedImpis: +type: array +items: +$ref: '#/components/schemas/Impi' +emergencyRegisteredIdentities: +type: array +items: +$ref: '#/components/schemas/EmergencyRegisteredIdentity' +minItems: 1 + +EmergencyRegisteredIdentity: +description: > +A pair of private and public user identities which have not been de-registered +due to emergency registration +type: object +required: +- impi +- impu +properties: +impi: +$ref: '#/components/schemas/Impi' +impu: +$ref: '#/components/schemas/Impu' + +DeregistrationReason: +description: > +Contains the reason for the network initiated de-registration (including a reason code, +and a human-readable reason text) +type: object +required: +- reasonCode +- reasonText +properties: +reasonCode: +$ref: '#/components/schemas/DeregistrationReasonCode' +reasonText: +type: string + +# +# SIMPLE TYPES +# + +ImsUEId: +description: IMS UE Identity (IMPU or IMPI) +type: string +pattern: '^([impusip\:\([a-zA-Z0-9_\-\.\!~*()\&=+$,;\?\/]+\)\@[([A-Za-z0-9]+\-[A-Za-z0-9]+\)\.\])+[a-z]{2,}\|imputel\:\+[0-9]{5,15}\|impi\-\.\+\.\+\$)' + +Impu: +description: IMS Public Identity of the UE (sip URI or tel URI) + +``` + +``` + + type: string + pattern: '^((sip\:(\[a-zA-Z0-9_\-\.\!~*()\&=+\$,\;?\/\]+\)\@(\[A-Za-z0-9]+\-\[A-Za-z0-9]+\)\.\)\+\[a-z]{2,}\| +tel\:\+\[0-9]{5,15}\}$' + + Impi: + description: IMS Private Identity of the UE + type: string + +# +# ENUMS: +# + + AuthorizationType: + description: Represents the type of authorization requested by the UE + anyOf: + - type: string + enum: + - REGISTRATION + - DEREGISTRATION + - type: string + + AuthorizationResult: + description: Represents the details of the granted authorization to the UE + anyOf: + - type: string + enum: + - FIRST_REGISTRATION + - SUBSEQUENT_REGISTRATION + - type: string + + ImsRegistrationType: + description: Represents the type of registration associated to the REGISTER request + anyOf: + - type: string + enum: + - INITIAL_REGISTRATION + - RE_REGISTRATION + - TIMEOUT_DEREGISTRATION + - USER_DEREGISTRATION + - ADMINISTRATIVE_DEREGISTRATION + - AUTHENTICATION_FAILURE + - AUTHENTICATION_TIMEOUT + - UNREGISTERED_USER + - type: string + + LooseRouteIndication: + description: Indicates whether the loose routing mechanism is required to serve the user + anyOf: + - type: string + enum: + - LOOSE_ROUTE_NOT_REQUIRED + - LOOSE_ROUTE_REQUIRED + - type: string + + DeregistrationReasonCode: + description: Indicates the reason for the network-initiated deregistration + anyOf: + - type: string + enum: + - PERMANENT_TERMINATION + - NEW_SERVER_ASSIGNED + - REMOVE_S-CSCF + - SERVER_CHANGE + - type: string + +``` + +## A.3 Nhss\_imsSDM API + +openapi: 3.0.0 + +``` + +info: + version: '1.2.0-alpha.1' + title: 'Nhss_imsSDM' + description: | + Nhss Subscriber Data Management Service for IMS. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + +``` + +All rights reserved. + +``` +externalDocs: + description: 3GPP TS 29.562 HSS Services for interworking with IMS, version 18.0.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' + +servers: + - url: '{apiRoot}/nhss-ims-sdm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + +paths: + /{imsUeId}/ims-data/registration-status: + get: + summary: Retrieve the registration status of a user + operationId: GetRegistrationStatus + tags: + - Registration Status retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:registration-status:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsRegistrationStatus' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/profile-data: + get: + summary: > + Retrieve the complete IMS profile for a given IMS public identity + (and public identities in the same IRS) + operationId: GetProfileData + tags: + - IMS Profile Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:profile-data:read + parameters: + - name: imsUeId + in: path + description: IMS Identity. In this case it shall be an IMS public identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: dataset-names + in: query + description: Datasets to be retrieved + schema: + $ref: '#/components/schemas/DataSetNames' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsProfileData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/profile-data/priority-levels: + get: + summary: Retrieve the service priority levels associated to the user + operationId: GetPriorityInfo + tags: + - Priority Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:priority-levels:read + +``` + +``` +parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PriorityLevels' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/profile-data/ifcs: + get: + summary: Retrieve the Initial Filter Criteria for the associated IMS subscription + operationId: GetIfcs + tags: + - IFCs Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ifcs:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: application-server-name + in: query + description: SIP URI of the Application Server Name + schema: + $ref: '#/components/schemas/SipServerName' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/Ifcs' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/profile-data/service-level-trace-information: + get: + summary: Retrieve the IMS service level trace information for the associated user + operationId: GetServiceTraceInfo + tags: + - Service Trace Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:service-level-trace-information:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceLevelTraceInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +``` + +``` + + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/profile-data/charging-info: + get: + summary: Retrieve the charging information for to the user + operationId: GetChargingInfo + tags: + - Charging Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:charging-info:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/location-data/server-name: + get: + +``` + +``` +summary: Retrieve the server name for the associated user +operationId: GetServerName +tags: + - Server Name retrieval +security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:server-name:read +parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsLocationData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/location-data/scscf-capabilities: +get: + summary: Retrieve the S-CSCF capabilities for the associated IMS subscription + operationId: GetScscfCapabilities + tags: + - Retrieval of the S-CSCF capabilities for the IMS subscription + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:scscf-capabilities:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: +``` + +``` + + $ref: '#/components/schemas/ImsUeId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfCapabilityList' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/location-data/scscf-selection-assistance-info: + get: + summary: Retrieve the S-CSCF selection assistance info + operationId: GetScscfSelectionAssistanceInfo + tags: + - Retrieval of the S-CSCF selection assistance information for the IMS subscription + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:scscf-selection-assistance-info:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfSelectionAssistanceInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + +``` + +``` +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/ps-domain/location-data: + get: + summary: Retrieve the location data in PS domain + operationId: GetLocPsDomain + tags: + - PS location retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:location-data:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: requested-nodes + in: query + description: Indicates the serving node(s) for which the request is applicable. + style: form + explode: false + schema: + type: array + items: + $ref: '#/components/schemas/RequestedNode' + - name: serving-node + in: query + description: > + Indicates that only the stored NF id/address of the serving node(s) is required + schema: + type: boolean + - name: local-time + in: query + description: > + Indicates that only the Local Time Zone information of the location in the visited + network where the UE is attached is requested + schema: + type: boolean + - name: current-location + in: query + description: > + Indicates whether an active location retrieval has to be initiated by the requested node + schema: + type: boolean + - name: rat-type + in: query + description: Indicates whether RAT Type retrieval is requested + schema: + type: boolean + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' +``` + +``` + +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PsLocation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/cs-domain/location-data: + get: + summary: Retrieve the location data in CS domain + operationId: GetLocCsDomain + tags: + - CS location retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:cs-domain:location-data:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: serving-node + in: query + description: > + Indicates that only the stored NF id/address of the serving node(s) is required + schema: + type: boolean + - name: local-time + in: query + description: > + Indicates that only the Local Time Zone information of the location in the visited + network where the UE is attached is requested + schema: + type: boolean + - name: current-location + in: query + description: > + Indicates whether an active location retrieval has to be initiated by the requested node + schema: + type: boolean + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +``` + +``` + +- name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CsLocation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/repository-data/{serviceIndication}: + put: + summary: Update the repository data associated to an IMPU and service indication + operationId: UpdateRepositoryDataServInd + tags: + - Update repository data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:repository-data:modify + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: serviceIndication + in: path + description: Identifier of a service related data + required: true + schema: + $ref: '#/components/schemas/ServiceIndication' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryData' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryData' + +``` + +``` +headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-sdm/v1/{imsUeId}/repository-data/{serviceIndication} + required: true + schema: + type: string +'200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryData' +'204': + description: No content +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +delete: + summary: delete the Repository Data for a Service Indication + operationId: DeleteRepositoryDataServInd + tags: + - Delete repository data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:repository-data:modify + parameters: + - name: imsUeId + in: path + description: Identifier of the UE + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: serviceIndication + in: path + description: Identifier of a service related data + required: true + schema: + $ref: '#/components/schemas/ServiceIndication' + responses: + '204': + description: Expected response to a valid request + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +``` + +``` +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +get: + summary: Retrieve the repository data associated to an IMPU and service indication + operationId: GetRepositoryDataServInd + tags: + - Repository data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:repository-data:read + parameters: + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: serviceIndication + in: path + description: Identifier of a service related data + required: true + schema: + $ref: '#/components/schemas/ServiceIndication' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/identities/msisdns: + get: + summary: retrieve the Msisdns associated to requested identity + operationId: GetMsisdns + tags: + - Retrieval of the associated Msisdns + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:identities:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-id + in: query + description: Private identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/MsisdnList' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/identities/ims-associated-identities: + get: + summary: > + Retrieve the associated identities to the IMS public identity included + in the service request + operationId: GetImAssocIds + tags: + - Retrieval of associated IMS public identities + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:identities:read +``` + +``` + +parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsAssociatedIdentities' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/identities/private-identities: + get: + summary: > + Retrieve the associated private identities to the IMS public identity included + in the service request + operationId: GetImsPrivateIds + tags: + - Retrieval of associated IMS private identities + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:identities:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: impi + in: query + description: Private Identity of type IMPI + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + +``` + +``` + + schema: + $ref: '#/components/schemas/PrivateIdentities' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/srvcc-data: + get: + summary: Retrieve the srvcc data + operationId: GetSrvccData + tags: + - Retrieval of UE SRVCC capability and STN-SR + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:srvcc:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity or IMS Private Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SrvccData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + +``` + +``` + + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Patch + operationId: UpdateSrvccData + tags: + - Update SRVCC data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:srvcc:modify + parameters: + - name: imsUeId + in: path + description: IMS Public Identity or IMS Private Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + +``` + +``` +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{imsUeId}/service-data/psi-status: + get: + summary: Retrieve the PSI activation state data + operationId: GetPsiState + tags: + - Retrieval of PSI activation state + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:psi-status:read + parameters: + - name: imsUeId + in: path + description: IMS Private Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PsiActivationState' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + patch: + summary: Patch + operationId: UpdatePsiState + tags: + - Update PSI state data + security: + - {} + - oAuth2ClientCredentials: +``` + +``` + + - nhss-ims-sdm + - OAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:psi-status:modify +parameters: + - name: imsUeId + in: path + description: IMS Public Service Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{imsUeId}/service-data/dsai: + get: + summary: Retrieve the DSAI information associated to an Application Server + operationId: GetDsaiInfo + tags: + - DSAI registration information + security: + - {} + - OAuth2ClientCredentials: + - nhss-ims-sdm + - OAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:dsai:read + parameters: + - name: imsUeId + +``` + +``` +in: path +description: IMS Identity +required: true +schema: + $ref: '#/components/schemas/ImsUeId' +- name: application-server-name +in: query +description: SIP URI of the Application Server Name +required: true +schema: + $ref: '#/components/schemas/SipServerName' +- name: dsai-tag +in: query +description: The requested instance of Dynamic Service Activation Info +schema: + type: string +- name: supported-features +in: query +description: Supported Features +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/DsaiTagInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Patch + operationId: UpdateDsaiState + tags: + - Update Dsai State + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:dsai:modify + parameters: + - name: imsUeId + in: path + description: IMS Public Service Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{imsUeId}/service-data/sms-registration-info: + put: + summary: Update the SMS registration information associated to a user + operationId: UpdateSmsRegistrationInfo + tags: + - Update SMS registration info + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:sms-registration-info:modify + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IpSmGwAddress' + +``` + +``` + + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/SmsRegistrationInfo' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-sdm/v1/{imsUeId}/service-data/sms-registration-info + required: true + schema: + type: string + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SmsRegistrationInfo' + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + delete: + summary: delete the SMS registration information + operationId: DeleteSmsRegistrationInfo + tags: + - Delete SMS registration information + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:sms-registration-info:modify + parameters: + - name: imsUeId + in: path + description: Identifier of the UE + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + +``` + +``` +responses: + '204': + description: Expected response to a valid request + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +get: + summary: Retrieve the SMS registration information associated to a user + operationId: GetSmsRegistrationInfo + tags: + - SMS registration information + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:sms-registration-info:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmsRegistrationInfo' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +``` + +``` + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/identities/imeiSv: + get: + summary: Retrieve the IMEISV information + operationId: GetIMEISVInfo + tags: + - IMEISV Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:identities:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImeiSvInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/ps-domain/ip-address: + get: + summary: Retrieve the IP address information + operationId: GetIpAddressInfo + tags: + - IP address Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm +``` + +``` + - nhss-ims-sdm:ps-domain:ip-address:read +parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/ps-domain/tads-info: + get: + summary: Retrieve the T-ADS information + operationId: GetTadsInfo + tags: + - TADS Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:tads-info:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/TadsInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +``` + +``` + + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions: + post: + summary: subscribe to notifications of UE reachability + operationId: UeReachIpSubscribe + tags: + - UE IP reachability Subscription Creation + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:ue-reach-subscriptions:create + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UeReachabilitySubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedUeReachabilitySubscription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-sdm/v1/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions/ + {subscriptionId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + +``` + +``` + + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + ueReachabilityNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UeReachabilityNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications to UE reachability + operationId: UeReachUnsubscribe + tags: + - Reachability Subscription Deletion + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + +``` + +``` +- oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:ue-reach-subscriptions:modify +parameters: +- name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' +- name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string +- name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' +responses: +'204': + description: Successful response +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +patch: + summary: modify the subscription + operationId: UeReachSubsModify + tags: + - Reachability Subscription Modification + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:ue-reach-subscriptions:modify + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + - name: supported-features + in: query +``` + +``` + +description: Supported Features +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful modification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{imsUeId}/access-data/ps-domain/user-state: + get: + summary: Retrieve the user state information in PS domain + operationId: GetPsUserInfo + tags: + - PS User State Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:user-state:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: requested-nodes + in: query + description: Indicates the serving node(s) for which the request is applicable. + style: form + explode: false + schema: + type: array + items: + +``` + +``` + + $ref: '#/components/schemas/RequestedNode' + minItems: 1 +- name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PsUserState' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/cs-domain/user-state: + get: + summary: Retrieve the user state information in CS domain + operationId: GetCsUserStateInfo + tags: + - CS User State Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:cs-domain:user-state:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CsUserState' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': +$ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': +$ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': +$ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': +$ref: 'TS29571_CommonData.yaml#/components/responses/404' +'405': +$ref: 'TS29571_CommonData.yaml#/components/responses/405' +'406': +$ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': +$ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': +$ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': +$ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': +$ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': +$ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: +$ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/cs-domain/csrn: +get: +summary: Retrieve the routing number in CS domain +operationId: GetCsrn +tags: +- CSRN retrieval +security: +- {} +- oAuth2ClientCredentials: +- nhss-ims-sdm +- oAuth2ClientCredentials: +- nhss-ims-sdm +- nhss-ims-sdm:cs-domain:csrnrn:read +parameters: +- name: imsUeId +in: path +description: IMS Public Identity +required: true +schema: +$ref: '#/components/schemas/ImsUeId' +- name: pre-paging +in: query +description: Indicates pre-paging support +schema: +$ref: '#/components/schemas/PrePaging' +- name: supported-features +in: query +description: Supported Features +schema: +$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: private-identity +in: query +description: IMS Private Identity +schema: +$ref: '#/components/schemas/PrivateId' +- name: call-reference-info +in: query +description: Indicates Call-Reference Number and AS-Number +content: +application/json: +schema: +$ref: '#/components/schemas/CallReferenceInfo' +responses: +'200': +description: Expected response to a valid request +content: +application/json: +schema: +$ref: '#/components/schemas/Csrn' +'307': +$ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/wireline-domain/reference-location: + get: + summary: Retrieve the reference location information + operationId: GetReferenceLocationInfo + tags: + - Reference Location Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:wireline-domain:reference-location:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ReferenceLocationInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/subscriptions: + post: + summary: subscribe to notifications + operationId: ImsSdmSubscribe + tags: + - SDM Subscription Creation + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:subscriptions:create + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-sdm/v1/{imsUeId}/subscriptions/{subscriptionId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + datachangeNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/imsUeId/subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications + operationId: ImsSdmUnsubscribe + tags: + - SDM Subscription Deletion + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:subscription:modify + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + +``` + +``` +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: modify the subscription + operationId: ImsSdmSubsModify + tags: + - SDM Subscription Modification + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:subscription:modify + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful modification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +``` + +``` +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/shared-data-subscriptions: + post: + summary: subscribe to notifications for shared data + operationId: SubscribeToSharedData + tags: + - Subscription Creation for shared data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:shared-subscriptions:create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ims-sdm/v1/shared-data-subscriptions/{subscriptionId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + datachangeNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/shared-data-subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications for shared data + operationId: UnsubscribeForSharedData + tags: + - Subscription Deletion for shared data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:shared-subscription:modify + parameters: + - name: subscriptionId + in: path + description: Id of the Shared data Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + +``` + +``` +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: modify the subscription + operationId: ModifySharedDataSubs + tags: + - Subscription Modification + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:shared-subscription:modify + parameters: + - name: subscriptionId + in: path + description: Id of the SDM Subscription + required: true + schema: + type: string + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful modification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +``` + +``` + + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/shared-data: + get: + summary: retrieve shared data + operationId: GetSharedData + tags: + - Retrieval of shared data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:shared-data:read + parameters: + - name: shared-data-ids + in: query + description: List of shared data ids + required: true + style: form + explode: false + schema: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SharedData' + minItems: 1 + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/repository-data: + get: + summary: Retrieve the repository data associated to an IMPU and service indication list + operationId: GetRepositoryDataServIndList + tags: + - Repository data list + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:repository-data:read + parameters: + +``` + +``` + +- name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: service-indications + in: query + description: Identifiers of a services related data + required: true + style: form + explode: false + schema: + type: array + items: + $ref: '#/components/schemas/ServiceIndication' + minItems: 1 +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryDataList' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + +securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ims-sdm: Access to the Nhss IMS Subscription Data Management API + nhss-ims-sdm:registration-status:read: Access to read the Registration Status resource + nhss-ims-sdm:profile-data:read: Access to read the Profile Data resource + nhss-ims-sdm:priority-levels:read: Access to read the Priority Levels resource + nhss-ims-sdm:ifcs:read: Access to read the Initial Filter Criteria resource + nhss-ims-sdm:service-level-trace-information:read: >- + Access to read the Service Level Trace Information resource + nhss-ims-sdm:server-name:read: Access to read the Server Name resource + nhss-ims-sdm:scscf-capabilities:read: Access to read the S-CSCF Capabilities resource + nhss-ims-sdm:ps-domain:location-data:read: >- + Access to read the PS-Domain Location Data resource + nhss-ims-sdm:ps-domain:ip-address:read: Access to read the PS-Domain IP Address resource + nhss-ims-sdm:ps-domain:tads-info:read: Access to read the PS-Domain TADS Info resource + +``` + +``` + +nhss-ims-sdm:ps-domain:ue-reach-subscriptions:create: >- + Access to create PS-Domain UE Reachability Subscriptions resources +nhss-ims-sdm:ps-domain:ue-reach-subscriptions:modify: >- + Access to update/delete a PS-Domain UE Reachability Subscription resource +nhss-ims-sdm:ps-domain:user-state:read: Access to read the PS-Domain User State resource +nhss-ims-sdm:cs-domain:location-data:read: >- + Access to read the CS-Domain Location Data resource +nhss-ims-sdm:cs-domain:user-state:read: Access to read the CS-Domain User State resource +nhss-ims-sdm:cs-domain:csrnr:read: Access to read the CS-Domain CSRNR resource +nhss-ims-sdm:wireline-domain:reference-location:read: >- + Access to read the Wireline-Domain Reference Location resource +nhss-ims-sdm:repository-data:modify: >- + Access to create/update/delete the Repository Data resource +nhss-ims-sdm:repository-data:read: Access to read the Repository Data resource +nhss-ims-sdm:identities:read: Access to read the Identities resource +nhss-ims-sdm:srvcc:read: Access to read the SRVCC resource +nhss-ims-sdm:srvcc:modify: Access to update the SRVCC resource +nhss-ims-sdm:psi-status:read: Access to read the PSI Status resource +nhss-ims-sdm:psi-status:modify: Access to update the PSI Status resource +nhss-ims-sdm:dsai:read: Access to read the DSAI resource +nhss-ims-sdm:dsai:modify: Access to update the DSAI resource +nhss-ims-sdm:sms-registration-info:read: >- + Access to read the SMS Registration Info resource +nhss-ims-sdm:sms-registration-info:modify: >- + Access to create/update/delete the SMS Registration Info resource +nhss-ims-sdm:subscriptions:create: Access to create Subscriptions resources +nhss-ims-sdm:subscription:modify: Access to update/delete a Subscription resource +nhss-ims-sdm:shared-subscriptions:create: >- + Access to create a Shared-Data Subscriptions resource +nhss-ims-sdm:shared-subscription:modify: >- + Access to update/delete a Shared-Data Subscription resource +nhss-ims-sdm:shared-data:read: Access to read the Shared-Data resource +nhss-ims-sdm:charging-info:read: Access to read the ChargingInfo resource + +``` + +schemas: + +``` + +# +# COMPLEX TYPES: +# + +``` + +``` + +SscfCapabilityList: + description: Information about mandatory and optional S-CSCF capabilities + type: object + properties: + mandatoryCapabilityList: + $ref: '#/components/schemas/Capabilities' + optionalCapabilityList: + $ref: '#/components/schemas/Capabilities' + anyOf: + - required: [mandatoryCapabilityList] + - required: [optionalCapabilityList] + +Capabilities: + description: A list of capabilities of the S-CSCF + type: array + items: + $ref: '#/components/schemas/Capability' + minItems: 1 + uniqueItems: true + +RepositoryData: + description: Repository Data for the requested Service Indication + type: object + required: + - serviceData + - sequenceNumber + properties: + sequenceNumber: + $ref: '#/components/schemas/SequenceNumber' + serviceData: + type: string + format: byte + +MsisdnList: + description: List of MSISDNs associated to the IMS public Identity + type: object + required: + - basicMsisdn + +``` + +``` +properties: + basicMsisdn: + $ref: '#/components/schemas/Msisdn' + additionalMsisdns: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/Msisdn' + +PublicIdentities: + description: > + IMS Public Identities which belong to the same Implicit Registration Set (if any) + as the requested IMS Public Identity + type: object + required: + - publicIdentities + properties: + publicIdentities: + type: array + items: + $ref: '#/components/schemas/PublicIdentity' + minItems: 1 + uniqueItems: true + +PrivateIdentities: + description: A list of IMS Private Identities + type: object + required: + - privateIdentities + properties: + privateIdentities: + type: array + items: + $ref: '#/components/schemas/PrivateIdentity' + minItems: 1 + uniqueItems: true + +PublicIdentity: + description: > + IMS Public Identity and related data (Alias Group Id, IRS default indication, + Identity Type) + type: object + required: + - imsPublicId + - identityType + properties: + imsPublicId: + $ref: '#/components/schemas/ImSPublicId' + identityType: + $ref: '#/components/schemas/IdentityType' + irsIsDefault: + type: boolean + aliasGroupId: + type: string + +PrivateIdentity: + description: IMS Private Identity and its identity type (IMPI or IMSI) + type: object + required: + - privateIdentity + - privateIdentityType + properties: + privateIdentity: + $ref: '#/components/schemas/PrivateId' + privateIdentityType: + $ref: '#/components/schemas/PrivateIdentityType' + +ImsAssociatedIdentities: + description: > + A list of identities belonging to the same Implicit Registration Set (IRS), + along with the registration state of the IRS + type: object + required: + - irsState + - publicIdentities + properties: + irsState: + $ref: '#/components/schemas/ImRegistrationState' +``` + +``` + publicIdentities: + $ref: '#/components/schemas/PublicIdentities' + +ImsSdmSubscription: + description: A subscription to notifications of data change + type: object + required: + - nfInstanceId + - callbackReference + - monitoredResourceUris + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + expires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +ImsRegistrationStatus: + description: Registration status of the user + type: object + required: + - imsUserStatus + properties: + imsUserStatus: + $ref: '#/components/schemas/ImsRegistrationState' + +PriorityLevels: + description: Namespaces and priority levels allowed for the IMS public Identity + type: object + required: + - servicePriorityLevelList + properties: + servicePriorityLevelList: + type: array + items: + $ref: '#/components/schemas/NameSpacePriority' + minItems: 1 + uniqueItems: true + servicePriorityLevel: + type: integer + minimum: 0 + maximum: 4 + +Ifcs: + description: List of IFCs associated to the IMS public Identity + type: object + properties: + ifcList: + type: array + items: + $ref: '#/components/schemas/Ifc' + minItems: 1 + cscfFilterSetIdList: + type: array + items: + $ref: '#/components/schemas/CscfFilterSetId' + minItems: 1 + anyOf: + - required: [ ifcList ] + - required: [ cscfFilterSetIdList ] + +Ifc: + description: Data associated to an individual IFC (Initial Filter Criteria) + type: object + required: + - priority + - appServer + properties: + priority: + type: integer + minimum: 1 + trigger: +``` + +``` +$ref: '#/components/schemas/TriggerPoint' +appServer: + $ref: '#/components/schemas/ApplicationServer' + +TriggerPoint: + description: > + Contains the conditions that should be checked in order to find out if an + Application Server should be contacted or not + type: object + required: + - conditionType + - sptList + properties: + conditionType: + $ref: '#/components/schemas/TypeOfCondition' + sptList: + type: array + items: + $ref: '#/components/schemas/Spt' + minItems: 1 + +Spt: + description: Contains the data of a Service Point Trigger + type: object + required: + - conditionNegated + - sptGroup + properties: + conditionNegated: + type: boolean + sptGroup: + type: array + items: + $ref: '#/components/schemas/SptGroupId' + minItems: 1 + regType: + items: + $ref: '#/components/schemas/RegistrationType' + minItems: 1 + maxItems: 2 + requestUri: + type: string + sipMethod: + type: string + sipHeader: + $ref: '#/components/schemas/HeaderSipRequest' + sessionCase: + $ref: '#/components/schemas/RequestDirection' + sessionDescription: + $ref: '#/components/schemas/SdpDescription' + +HeaderSipRequest: + description: Contains a header (and optionally value of the header) in the SIP request + type: object + required: + - header + properties: + header: + type: string + content: + type: string + +SdpDescription: + description: > + Contains a SDP line (and optionally the value in the line) within the body (if any) + of a SIP request + type: object + required: + - line + properties: + line: + type: string + content: + type: string + +ApplicationServer: + description: > + Application Server which shall be triggered if the conditions of a certain IFC are met, +``` + +``` + and its associated data + type: object + required: + - asUri + properties: + asUri: + type: string + sessionContinue: + type: boolean + serviceInfoList: + type: array + items: + $ref: '#/components/schemas/ServiceInformation' + minItems: 1 + +ImsLocationData: + description: IMS Location Data (S-CSCF name) + type: object + required: + - scscfName + properties: + scscfName: + type: string + +PsLocation: + description: Location data in PS domain + type: object + oneOf: + - required: + - sgsnLocationData + - required: + - mmeLocationData + - required: + - amfLocationData + - required: + - twanLocationData + properties: + sgsnLocationData: + $ref: '#/components/schemas/SgsnLocationData' + mmeLocationData: + $ref: '#/components/schemas/MmeLocationData' + amfLocationData: + $ref: '#/components/schemas/AmfLocationData' + twanLocationData: + $ref: '#/components/schemas/TwanLocationData' + +SgsnLocationData: + description: Location information as retrieved from the SGSN serving node + type: object + required: + - sgsnNumber + - plmnId + properties: + sgsnNumber: + type: string + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + sgsnLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UtraLocation' + csgInformation: + $ref: '#/components/schemas/CsgInformation' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + +MmeLocationData: + description: Location information as retrieved from the MME serving node + type: object + required: + - mmeAddress + - plmnId + properties: + mmeAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + mmeLocation: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/EutraLocation' + csgInformation: + $ref: '#/components/schemas/CsgInformation' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + +AmfLocationData: + description: Location information as retrieved from the AMF serving node + type: object + required: + - amfAddress + - plmnId + properties: + amfAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + amfLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NrLocation' + smsfAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + +TwanLocationData: + description: Location information of the 3GPP AAA Server for Trusted W-LAN Access + type: object + required: + - twanSsid + - plmnId + properties: + twanSsid: + type: string + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + twanBssid: + type: string + civicAddress: + type: string + format: byte + twanOperatorName: + type: string + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + logicalAccessId: + type: string + +CsLocation: + description: Location data in CS domain + type: object + required: + - mscNumber + - vlrNumber + - plmnId + properties: + mscNumber: + type: string + vlrNumber: + type: string + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + vlrLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GeraLocation' + csgInformation: + $ref: '#/components/schemas/CsgInformation' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + eUtranCgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + +CsgInformation: + description: Information about a Closed Subscriber Group (CSG) +``` + +``` +type: object +required: +- csgId +properties: + csgId: + type: string + format: byte + accessMode: + type: string + format: byte + cMi: + type: boolean + +SrvccData: + description: UE SRVCC capability (if available) and STN-SR (if subscribed) + type: object + required: + - stnSr + properties: + stnSr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StnSr' + ueSrvccCapabilities: + type: array + items: + $ref: '#/components/schemas/SrvccCapability' + minItems: 1 + uniqueItems: true + +PsiActivationState: + description: Public Service Identity activation state + type: object + required: + - activationState + properties: + activationState: + $ref: '#/components/schemas/ActivationState' + +SharedData: + description: Represents a part of the IMS Profile data shared by several UEs + type: object + required: + - sharedDataId + properties: + sharedDataId: + $ref: '#/components/schemas/SharedDataId' + sharedImsiIfcData: + $ref: '#/components/schemas/Ifcs' + minProperties: 1 + +ImsProfileData: + description: User's IMS profile data + type: object + required: + - imsServiceProfiles + properties: + imsServiceProfiles: + type: array + items: + $ref: '#/components/schemas/ImsServiceProfile' + chargingInfo: + $ref: '#/components/schemas/ChargingInfo' + serviceLevelTraceInfo: + $ref: '#/components/schemas/ServiceLevelTraceInformation' + servicePriorityLevelList: + type: array + items: + $ref: '#/components/schemas/NameSpacePriority' + minItems: 1 + uniqueItems: true + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + maxAllowedSimulReg: + type: integer + servicePriorityLevel: + type: integer + minimum: 0 + maximum: 4 +``` + +``` +ImsServiceProfile: + description: > + IMS Service Profile of the UE, containing the list of Public Identifiers and + optionally a list of IFCs + type: object + required: + - publicIdentifierList + properties: + publicIdentifierList: + type: array + items: + $ref: '#/components/schemas/PublicIdentifier' + ifcs: + $ref: '#/components/schemas/Ifcs' + cnServiceAuthorization: + $ref: '#/components/schemas/CoreNetworkServiceAuthorization' + +CoreNetworkServiceAuthorization: + description: > + Core Network Service Authorization + type: object + properties: + subscribedMediaProfileId: + type: integer + +PublicIdentifier: + description: > + Distinct or wildcarded public identity and its associated priority, trace and + barring information + type: object + required: + - publicIdentity + properties: + publicIdentity: + $ref: '#/components/schemas/PublicIdentity' + displayName: + type: string + imsServicePriority: + $ref: '#/components/schemas/PriorityLevels' + serviceLevelTraceInfo: + $ref: '#/components/schemas/ServiceLevelTraceInformation' + barringIndicator: + type: boolean + wildcardedImpu: + type: string + +ServiceLevelTraceInformation: + description: IMS Service Level Trace Information + type: object + properties: + serviceLevelTraceInfo: + type: string + +ImeiSvInformation: + description: IMEI(SV) information + type: object + oneOf: + - required: + - imei + - required: + - imeiSv + properties: + imei: + $ref: '#/components/schemas/Imei' + imeiSv: + $ref: '#/components/schemas/ImeiSv' + +TadsInformation: + description: T-ADS Information + type: object + required: + - voiceOverPsSessionSupport + properties: + voiceOverPsSessionSupport: + $ref: '#/components/schemas/ImsVoiceOverPsSessionSupport' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +lastUeActivityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +UeReachabilitySubscription: + description: > + Contains the request parameters received by the HSS for a subscription to + notifications of UE reachability for IP + type: object + required: + - expiry + - callbackReference + properties: + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + +CreatedUeReachabilitySubscription: + description: > + Contains the response data returned by HSS after the subscription to + notifications of UE reachability for IP was created + type: object + required: + - expiry + properties: + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +UeReachabilityNotification: + description: > + Represents the contents of a notification of UE reachability for IP sent by the HSS + type: object + required: + - reachabilityIndicator + - detectingNode + - accessType + properties: + reachabilityIndicator: + type: boolean + detectingNode: + $ref: '#/components/schemas/DetectingNode' + accessType: + $ref: '#/components/schemas/AccessType' + +PsUserState: + description: User state in PS domain + type: object + oneOf: + - required: + - sgsnUserState + - required: + - mmeUserState + - required: + - amfUserState + properties: + sgsnUserState: + $ref: '#/components/schemas/UserStatePs' + mmeUserState: + $ref: '#/components/schemas/UserStatePs' + amfUserState: + $ref: '#/components/schemas/UserStatePs' + +CsUserState: + description: User state in CS domain + type: object + required: + - mscVlrUserState + properties: + mscVlrUserState: + $ref: '#/components/schemas/UserStateCs' + +Csrn: + description: CS domain routeing number + type: object + required: + - csrn + properties: +``` + +``` +csrn: + $ref: '#/components/schemas/Msisdn' + +ReferenceLocationInformation: + description: Reference Location Information for the user in fixed access networks + type: object + properties: + accessType: + type: string + accessInfo: + type: string + accessValue: + type: string + anyOf: + - required: [accessType] + - required: [accessInfo] + - required: [accessValue] + +SmsRegistrationInfo: + description: SMS Registration Information (IP-SM-GW number and SC address) + type: object + required: + - ipSmGwNumber + properties: + ipSmGwNumber: + $ref: '#/components/schemas/Msisdn' + scAddress: + $ref: '#/components/schemas/Msisdn' + +IpSmGwAddress: + description: IP-SM-GW number and diameter URI/realm + type: object + required: + - ipSmGwNumber + properties: + ipSmGwNumber: + $ref: '#/components/schemas/Msisdn' + ipSmGwDiaUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + ipSmGwDiaRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + ipSmGwSbiSupInd: + type: boolean + default: false + +DsaiTagInformation: + description: > + DSAI tag information (list of DSAI tags activation state for an Application Server) + type: object + required: + - dsaiTagStatusList + properties: + dsaiTagStatusList: + type: array + items: + $ref: '#/components/schemas/DsaiTagStatus' + minItems: 1 + uniqueItems: true + +DsaiTagStatus: + description: DSAI tag status (DSAI tag and activation state) + type: object + required: + - dsaiTag + - dsaiState + properties: + dsaiTag: + type: string + dsaiState: + $ref: '#/components/schemas/ActivationState' + +ScscfSelectionAssistanceInformation: + description: Information used by the I-CSCF to select an S-CSCF for the UE + type: object + properties: + scscfCapabilityList: + $ref: '#/components/schemas/ScscfCapabilityList' + scscfNames: +``` + +``` + type: array + items: + type: string + minItems: 1 + anyOf: + - required: [scscfCapabilityList] + - required: [scscfNames] + +ChargingInfo: + description: Diameter addresses of the charging function + type: object + anyOf: + - required: + - primaryEventChargingFunctionName + - required: + - primaryChargingCollectionFunctionName + properties: + primaryEventChargingFunctionName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + secondaryEventChargingFunctionName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + primaryChargingCollectionFunctionName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + secondaryChargingCollectionFunctionName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + +CallReferenceInfo: + description: > + Contains a Call Reference Number and the AS-Number; it allows a later retry of the call + setup in the context of MTRR + type: object + required: + - callRefNumber + - asNumber + properties: + callRefNumber: + type: string + format: byte + description: > + The content is according to CallReferenceNumber type described in 3GPP TS 29.002 [30]. + Base64 encoded according to IETF RFC 2045 [28] + asNumber: + type: string + format: byte + description: > + The content is according to ISDN-AddressString type described in 3GPP TS 29.002 [30]. + Base64 encoded according to IETF RFC 2045 [28] + +DataSetNames: + description: Contains the data sets to be retrieved from the IMS User Profile + type: array + items: + $ref: '#/components/schemas/DataSetName' + minItems: 1 + uniqueItems: true + +RepositoryDataList: + description: List of Repository Data for the requested Service Indications + type: object + required: + - repositoryDataMap + properties: + repositoryDataMap: + description: > + A map (list of key-value pairs where ServiceIndication serves as key) of RepositoryData + type: object + additionalProperties: + $ref: '#/components/schemas/RepositoryData' + +# +# SIMPLE TYPES: +# + +Capability: + description: S-CSCF capability + type: integer + +ImsUeId: +``` + +``` + + description: > + Represents the IMS Public Identity (i.e. IMS Public User identity or + Public Service Identity) + type: string + pattern: '^(impu-sip:(([a-zA-Z0-9_\-.!~*()&=+$,;?/]+)@(([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,})|impu-tel:\+[0-9]{5,15}|impi-.+.+)$' + + SequenceNumber: + description: > + Unsigned integer containing the sequence number associated to the current version + of Repository Data + type: integer + minimum: 0 + + ServiceIndication: + description: String containing the Service Indication or Service Identifier + type: string + + Msisdn: + description: String containing an additional or basic MSISDN + type: string + pattern: '^[0-9]{5,15}$' + + PrivateId: + description: String containing a Private User Identity or a Private Service Identity + type: string + + ImsPublicId: + description: String containing an IMS Public Identity in SIP URI format or TEL URI format + type: string + pattern: '^(sip:(([a-zA-Z0-9_\-.!~*()&=+$,;?/]+)@(([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,})|tel:\+[0-9]{5,15}))$' + + NameSpacePriority: + description: > + String containing the namespace and priority formatted as "r-value" parameter + described in IETF RFC 4412 + type: string + pattern: '^[0-9a-zA-Z-\!%\*_\+\‘\‘~]+\.[0-9a-zA-Z-\!%\*_\+\‘\‘~]+$' + + CscfFilterSetId: + description: Contains the identifier of a specific filter set in the S-CSCF + type: integer + minimum: 0 + + SptGroupId: + description: Contains the identifier of the Group of SPTs + type: integer + minimum: 0 + + SharedDataId: + description: > + Identifies globally and uniquely a piece of subscription data shared by multiple UEs; + the value shall start with the HPLMN id (MCC/MNC) followed by a hyphen followed by a + local Id as allocated by the home network operator + type: string + pattern: '^[0-9]{5,6}-.+$' + + Imei: + description: IMEI of the UE + type: string + pattern: '^[0-9]{15}$' + + ImeiSv: + description: IMEISV of the UE + type: string + pattern: '^[0-9]{16}$' + + PrePaging: + description: Indicates the support of pre-paging + type: boolean + + SipServerName: + description: Server Name (e.g. AS name, CSCF name) in SIP URI format + type: string + pattern: '^(sip:(([a-zA-Z0-9_\-.!~*()&=+$,;?/]+)@(([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,}))$ + +``` + +``` +# +# ENUMS: +# + +IdentityType: + description: Represents the type of IMS Public Identity + anyOf: + - type: string + enum: + - DISTINCT_IMPU + - DISTINCT_PSI + - WILDCARDED_IMPU + - WILDCARDED_PSI + - type: string + +PrivateIdentityType: + description: Represents the type of IMS Private Identity (IMPI or IMSI) + anyOf: + - type: string + enum: + - IMPI + - IMSI + - type: string + +ImsRegistrationState: + description: Represents the IMS status of the user or Public Identity or the IRS + anyOf: + - type: string + enum: + - REGISTERED + - NOT_REGISTERED + - AUTHENTICATION_PENDING + - REGISTERED_UNREG_SERVICES + - type: string + +TypeOfCondition: + description: > + Represents the type of condition to be applied to the logical expression of SPT groups + and SPTs (Conjunctive Normal Form, or Disjunctive Normal Form) + anyOf: + - type: string + enum: + - CNF + - DNF + - type: string + +RegistrationType: + description: Represents the type of registration associated to the REGISTER request + anyOf: + - type: string + enum: + - INITIAL_REGISTRATION + - RE_REGISTRATION + - DE_REGISTRATION + - type: string + +RequestDirection: + description: > + Represents the direction of the request in combination with the registration status + of the user as evaluated in the S-CSCF + anyOf: + - type: string + enum: + - ORIGINATING_REGISTERED + - ORIGINATING_UNREGISTERED + - ORIGINATING_CDIV + - TERMINATING_REGISTERED + - TERMINATING_UNREGISTERED + - type: string + +ServiceInformation: + description: > + Indicates the type of additional information to be included in the body of the SIP request + towards the Application Server + anyOf: + - type: string + enum: + - INCLUDE_REGISTER_REQUEST +``` + +``` + - INCLUDE_REGISTER_RESPONSE + - type: string + +RequestedNode: + description: Represents the type of serving node for which certain data is requested + anyOf: + - type: string + enum: + - SGSN + - MME + - AMF + - 3GPP_AAA_SERVER_TWAN + - type: string + +SrvccCapability: + description: Represents the type of SRVCC support of the UE + anyOf: + - type: string + enum: + - UE_4G_SRVCC_CAPABLE + - UE_5G_SRVCC_CAPABLE + - type: string + +ActivationState: + description: Represents the activation state of a PSI or DSAI tag + anyOf: + - type: string + enum: + - ACTIVE + - INACTIVE + - type: string + +ImsVoiceOverPsSessionSupport: + description: Represents the support for Voice-over-PS of the UE + anyOf: + - type: string + enum: + - IMS_VOICE_OVER_PS_NOT_SUPPORTED + - IMS_VOICE_OVER_PS_SUPPORTED + - IMS_VOICE_OVER_PS_SUPPORT_UNKNOWN + - type: string + +DetectingNode: + description: Represents the type of serving node that detected the reachability of the UE + anyOf: + - type: string + enum: + - SGSN + - MME + - AMF + - type: string + +AccessType: + description: Represents the type of access (3GPP or non-3GPP) + anyOf: + - type: string + enum: + - 3GPP_ACCESS + - NON_3GPP_ACCESS + - type: string + +UserStatePs: + description: Represents the user state in PS domain + anyOf: + - type: string + enum: + - DETACHED + - ATTACHED_NOT_REACHABLE_FOR_PAGING + - ATTACHED_REACHABLE_FOR_PAGING + - CONNECTED_NOT_REACHABLE_FOR_PAGING + - CONNECTED_REACHABLE_FOR_PAGING + - NOT_PROVIDED_FROM_SGSN_OR_MME_OR_AMF + - NETWORK_DETERMINED_NOT_REACHABLE + - type: string + +UserStateCs: + description: Represents the user state in CS domain + anyOf: +``` + +``` + +- type: string +enum: +- CAMEL_BUSY +- NETWORK_DETERMINED_NOT_REACHABLE +- ASSUMED_IDLE +- NOT_PROVIDED_FROM_VLR +- type: string + +DataSetName: +description: A set of data within the IMS User Profile +anyOf: +- type: string +enum: +- CHARGING_DATA +- IFC_DATA +- TRACE_DATA +- PRIORITY_DATA +- type: string + +``` + +## A.4 Nhss\_imsUEAU API + +``` + +openapi: 3.0.0 + +info: + version: '1.2.0-alpha.1' + title: 'Nhss_imsUEAU' + description: | + Nhss UE Authentication Service for IMS. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 18.0.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' + +servers: +- url: '{apiRoot}/nhss-ims-ueau/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: +- {} +- oAuth2ClientCredentials: +- nhss-ims-ueau + +paths: + + /{impi}/security-information/generate-sip-auth-data: + post: + summary: Generate authentication data for the UE based on the Auth-Scheme provided + operationId: GenerateSipAuthData + tags: + - Generate SIP Auth Data (Custom Operation) + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-ueau + - oAuth2ClientCredentials: + - nhss-ims-ueau + - nhss-ims-ueau:generate-sip-auth-data:invoke + parameters: + - name: impi + in: path + description: IMS Private Identity for the UE (IMPI) + required: true + schema: + $ref: '#/components/schemas/Impi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SipAuthenticationInfoRequest' + +``` + +``` + + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SipAuthenticationInfoResult' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ims-ueau: Access to the Nhss IMS UE Authentication API + nhss-ims-ueau:generate-sip-auth-data:invoke: > + Access to invoke the Generate SIP Auth Data custom operation + + schemas: + +# +# COMPLEX TYPES: +# + + SipAuthenticationInfoRequest: + description: > + Contains input data to the SIP authentication request message (e.g. SIP authentication + scheme, requested number of authentication items, resynchronization information) + type: object + required: + - cscfServerName + - sipAuthenticationScheme + properties: + cscfServerName: + type: string + sipAuthenticationScheme: + $ref: '#/components/schemas/SipAuthenticationScheme' + sipNumberAuthItems: + $ref: '#/components/schemas/SipNumberAuthItems' + resynchronizationInfo: + +``` + +``` +$ref: '#/components/schemas/ResynchronizationInfo' + +ResynchronizationInfo: + description: Contains RAND and AUTS + type: object + required: + - rand + - auts + properties: + rand: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Rand' + auts: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Auts' + +SipAuthenticationInfoResult: + description: > + Contains authentication information returned in the SIP authentication response message + (e.g. authentication vectors, digest authentication parameters, line identifiers) + type: object + required: + - impi + properties: + impi: + $ref: '#/components/schemas/Impi' + 3gAkaAvs: + type: array + items: + $ref: '#/components/schemas/3GAkaAv' + minItems: 1 + digestAuth: + $ref: '#/components/schemas/DigestAuthentication' + lineIdentifierList: + type: array + items: + $ref: '#/components/schemas/LineIdentifier' + minItems: 1 + ipAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + +3GAkaAv: + description: Contains RAND, XRES, AUTN, CK, and IK + type: object + required: + - rand + - xres + - autn + - ck + - ik + properties: + rand: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Rand' + xres: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Xres' + autn: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Autn' + ck: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ConfidentialityKey' + ik: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/IntegrityKey' + +DigestAuthentication: + description: Parameters used for the Digest authentication scheme + type: object + required: + - digestRealm + - digestAlgorithm + - digestQop + - hal + properties: + digestRealm: + type: string + digestAlgorithm: + $ref: '#/components/schemas/SipDigestAlgorithm' + digestQop: + $ref: '#/components/schemas/SipDigestQop' + hal: + type: string +``` + +``` + +# +# SIMPLE TYPES: +# + +SipNumberAuthItems: + description: Indicates the number of requested SIP authentication items + type: integer + minimum: 1 + +Impi: + description: IMS Private Identity of the UE + type: string + +LineIdentifier: + description: Line Identifier for the wireline access + type: string + +# +# ENUMS: +# + +SipAuthenticationScheme: + description: Authentication scheme to be used in the SIP authentication request message + anyOf: + - type: string + enum: + - DIGEST-AKAV1-MD5 + - DIGEST-HTTP + - NBA + - GIBA + - UNKNOWN + - type: string + +SipDigestAlgorithm: + description: Algorithm used for the SIP Digest authentication scheme + anyOf: + - type: string + enum: + - MD5 + - MD5_SESS + - type: string + +SipDigestQop: + description: Quality of Protection for the SIP Digest authentication scheme + anyOf: + - type: string + enum: + - AUTH + - AUTH_INT + - type: string + +``` + +## A.5 Nhss\_gbaSDM API + +``` + +openapi: 3.0.0 + +info: + version: '1.1.0-alpha.1' + title: 'Nhss_gbaSDM' + description: | + Nhss Subscriber Data Management Service for GBA. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 18.0.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' + +servers: + - url: '{apiRoot}/nhss-gba-sdm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + +``` + +``` +- {} +- oAuth2ClientCredentials: + - nhss-gba-sdm + +paths: + /{ueId}/subscriber-data: + get: + summary: Retrieve the subscriber data of a user + operationId: GetSubscriberData + tags: + - Subscriber Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nhss-gba-sdm + - oAuth2ClientCredentials: + - nhss-gba-sdm + - nhss-gba-sdm:subscriber-data:read + parameters: + - name: ueId + in: path + description: UE Identity + required: true + schema: + $ref: '#/components/schemas/UeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/GbaSubscriberData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /{ueId}/subscriptions: + post: + summary: Subscribe to notifications + operationId: GbaSdmSubscribe + tags: + - GBA SDM Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nhss-gba-sdm + - oAuth2ClientCredentials: + - nhss-gba-sdm + - nhss-gba-sdm:subscriptions:create + parameters: +``` + +``` + +- name: ueId + in: path + description: UE Identity + required: true + schema: + $ref: '#/components/schemas/UEId' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GbaSdmSubscription' + required: true +responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/GbaSdmSubscription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-gba-sdm/{apiVersion}/{ueId}/subscriptions/{subscriptionId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + datachangeNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + +``` + +``` + + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{ueId}/subscriptions/{subscriptionId}: + delete: + summary: Unsubscribe from notifications + operationId: GbaSdmUnsubscribe + tags: + - GBA SDM Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nhss-gba-sdm + - oAuth2ClientCredentials: + - nhss-gba-sdm + - nhss-gba-sdm:subscription:modify + parameters: + - name: ueId + in: path + description: UE Identity + required: true + schema: + $ref: '#/components/schemas/UeId' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + patch: + summary: Modify the subscription + operationId: GbaSdmSubsModify + tags: + - GBA SDM Subscription (Document) + +``` + +``` +security: +- {} +- oAuth2ClientCredentials: +- nhss-gba-sdm +- oAuth2ClientCredentials: +- nhss-gba-sdm +- nhss-gba-sdm:subscription:modify +parameters: +- name: ueId + in: path + description: UE Identity + required: true + schema: + $ref: '#/components/schemas/UEId' +- name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: +content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true +responses: +'200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' +'204': + description: Successful modification +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + +securitySchemes: +oAuth2ClientCredentials: +type: oauth2 +flows: +``` + +``` + +clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-gba-sdm: Access to the Nhss GBA Subscription Data Management API + nhss-gba-sdm:subscriber-data:read: Access to read the GBA Subscriber Data resource + nhss-gba-sdm:subscriptions:create: Access to create Subscriptions resources + nhss-gba-sdm:subscription:modify: Access to update/delete a Subscription resource + +schemas: + +# +# COMPLEX TYPES: +# + +GbaSubscriberData: + description: > + GBA subscriber data of the UE; it includes the GBA User Security Settings (GUSS) data + type: object + properties: + guss: + $ref: '#/components/schemas/Guss' + +Guss: + description: > + GBA User Security Settings of the UE; it includes information about the BSF, + and a list of User Security Settings + type: object + properties: + bsfInfo: + $ref: '#/components/schemas/BsfInfo' + ussList: + type: array + items: + $ref: 'TS29309_Nbsp_GBA.yaml#/components/schemas/UssListItem' + minItems: 1 + +BsfInfo: + description: > + Information about the BSF; it includes an indication of whether GBA or GBA_U is to be used, + the key lifetime and a user-specific list of security features + type: object + properties: + uiccType: + $ref: '#/components/schemas/UiccType' + lifeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + securityFeatures: + type: array + items: + $ref: 'TS29309_Nbsp_GBA.yaml#/components/schemas/SecFeature' + minItems: 1 + +GbaSdmSubscription: + description: > + Information about a subscription created in the HSS, so the consumer (e.g. BSF) can be + notified when there are changes on the monitored data + type: object + required: + - nfInstanceId + - callbackReference + - monitoredResourceUris + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + expires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +# +# SIMPLE TYPES: +# + +``` + +``` + +UeId: + description: UE ID can be MSISDN, IMSI, IMPI or IMPU + anyOf: + - $ref: '#/components/schemas/Msisdn' + - $ref: '#/components/schemas/Imsi' + - $ref: 'TS29562_Nhss_imsSDM.yaml#/components/schemas/ImsUEId' + +Msisdn: + description: MS-ISDN of the UE + type: string + pattern: '^msisdn-[0-9]{5,15}$' + +Imsi: + description: IMSI of the UE + type: string + pattern: '^imsi-[0-9]{5,15}$' + +# +# ENUMS: +# + +UiccType: + description: Indicates whether GBA or GBA_U is to be used + anyOf: + - type: string + enum: + - GBA + - GBA_U + - type: string + +``` + +## A.6 Nhss\_gbaUEAU API + +``` + +openapi: 3.0.0 + +info: + version: '1.1.0-alpha.1' + title: 'Nhss_gbaUEAU' + description: | + Nhss UE Authentication Service for GBA. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.562 Home Subscriber Server (HSS) Services, version 18.0.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' + +servers: + - url: '{apiRoot}/nhss-gba-ueau/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nhss-gba-ueau + - {} + +paths: + /{ueId}/security-information/generate-auth-data: + post: + summary: Generate GBA authentication data for the UE + operationId: GenerateAuthData + tags: + - Generate Auth Data (Custom Operation) + security: + - {} + - oAuth2ClientCredentials: + - nhss-gba-ueau + - oAuth2ClientCredentials: + - nhss-gba-ueau + - nhss-gba-ueau:generate-auth-data:invoke + parameters: + - name: ueId + in: path + +``` + +``` + description: UE identity of the user + required: true + schema: + $ref: '#/components/schemas/UEId' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticationInfoRequest' + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticationInfoResult' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-gba-ueau: Access to the nhss-gba-ueau API + nhss-gba-ueau:generate-auth-data:invoke: > + Access to invoke the Generate Auth Data custom operation + +schemas: + +# +# COMPLEX TYPES: +# + +AuthenticationInfoRequest: + description: > + Contains input data to the authentication request message (e.g. authentication + scheme, resynchronization information) + type: object + properties: + authenticationScheme: + $ref: '#/components/schemas/AuthenticationScheme' + resynchronizationInfo: + $ref: 'TS29562_Nhss_imsUEAU.yaml#/components/schemas/ResynchronizationInfo' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` +AuthenticationInfoResult: + description: > + Contains authentication information returned in the authentication response message + (e.g. authentication vector, digest authentication parameters) + type: object + properties: + impi: + $ref: '#/components/schemas/Impi' + 3gAkaAv: + $ref: 'TS29562_Nhss_imsUEAU.yaml#/components/schemas/3GAkaAv' + digestAuth: + $ref: '#/components/schemas/DigestAuthentication' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +DigestAuthentication: + description: Parameters used for the Digest authentication scheme + type: object + required: + - digestRealm + - digestAlgorithm + - digestQop + - hal + properties: + digestRealm: + type: string + digestAlgorithm: + $ref: '#/components/schemas/DigestAlgorithm' + digestQop: + $ref: '#/components/schemas/DigestQop' + hal: + type: string + +# +# SIMPLE TYPES: +# + +UeId: + $ref: 'TS29562_Nhss_gbaSDM.yaml#/components/schemas/UeId' + +Impi: + description: IMS Private Identity of the UE + type: string + +# +# ENUMS: +# + +AuthenticationScheme: + description: Authentication scheme to be used in the authentication request message + anyOf: + - type: string + enum: + - DIGEST_AKAV1_MD5 + - DIGEST_HTTP + - type: string + +DigestAlgorithm: + description: Algorithm used for the Digest authentication scheme + anyOf: + - type: string + enum: + - MD5 + - MD5_SESS + - type: string + +DigestQop: + description: Quality of Protection for the Digest authentication scheme + anyOf: + - type: string + enum: + - AUTH + - AUTH_INT + - type: string +``` + +--- + +## Annex B (informative): Withdrawn API versions + +### B.1 General + +This Annex lists withdrawn API versions of the APIs defined in the present specification. 3GPP TS 29.501 [5] clause 4.3.1.6 describes the withdrawal of API versions. + +--- + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-09 | CT4#93 | C4-193851 | | | | Initial Draft (C4-193264) and incorporation of agreed pCRs at CT4#93: C4-193576, C4-193272, C4-193273, C4-193579, C4-193706, C4-193838. | 0.1.0 | +| 2019-10 | CT4#94 | C4-194525 | | | | Incorporation of agreed pCRs at CT4#94: C4-194361, C4-194362, C4-194364, C4-194365, C4-194556 | 0.2.0 | +| 2019-11 | CT4#95 | C4-195640 | | | | Incorporation of agreed pCRs at CT4#95: C4-195468, C4-195469, C4-195475, C4-195478, C4-195583, C4-195650 | 0.3.0 | +| 2020-03 | CT4#96 | C4-201270 | | | | Incorporation of agreed pCRs at CT4#96: C4-200572, C4-200578, C4-200582, C4-200803, C4-200804, C4-200927, C4-200929, C4-200963, C4-200977, C4-201098, C4-201104, C4-201105, C4-201106, C4-201107, C4-201108, C4-201109, C4-201110, C4-201111, C4-201112, C4-201113, C4-201114, C4-201115, C4-201116 | 0.4.0 | +| 2020-03 | CT#87 | CP-200064 | | | | TS presented for information and approval | 1.0.0 | +| 2020-03 | CT#87 | | | | | Approved at CT#87 | 16.0.0 | +| 2020-07 | CT#88 | CP-201038 | 0001 | - | B | IMEISV retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0002 | - | B | IP address retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0003 | - | B | T-ADS info retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0004 | - | B | UE Reachability subscription | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0005 | - | B | User State retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0006 | - | B | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0007 | - | B | Resource-Level Authorization | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0008 | - | F | Common data structures in the response body | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0009 | - | B | CSRN retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0010 | 1 | B | Wireline domain info retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0011 | - | B | SDM SMS Registration Info | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0012 | 1 | F | Miscellaneous corrections | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0013 | 1 | F | IMS restoration amendments | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0014 | 1 | F | Support of Multiple Registration | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0015 | 2 | F | IMS Identity Data Retrieval amendments | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0016 | - | F | SDM Wireline-domain Line-Id Removal | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0017 | 1 | B | SDM - DSAI handling | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0018 | 1 | F | Cleanup of TS | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0019 | - | F | Miscellaneous Corrections | 16.1.0 | +| 2020-07 | CT#88 | CP-201073 | 0020 | - | F | 29.562 Rel-16 API version and External doc update | 16.1.0 | +| 2020-09 | CT#89 | CP-202118 | 0021 | - | F | P-CSCF Restoration | 16.2.0 | +| 2020-09 | CT#89 | CP-202118 | 0022 | - | F | Missing Resource Scopes | 16.2.0 | +| 2020-09 | CT#89 | CP-202118 | 0023 | 1 | F | IMS restoration amendments II | 16.2.0 | +| 2020-09 | CT#89 | CP-202118 | 0024 | - | F | Miscellaneous Corrections | 16.2.0 | +| 2020-09 | CT#89 | CP-202096 | 0025 | - | F | 29.562 Rel-16 API version and External doc update | 16.2.0 | +| 2020-12 | | | | | | Corrupted figures fixed | 16.2.1 | +| 2020-12 | CT#90 | CP-203053 | 0027 | - | F | Storage of YAML files in 3GPP Forge | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0028 | - | F | RAT type retrieval | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0029 | - | F | Resource ImsServerNameAndCapabilities | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0030 | - | F | S-CSCF Restoration | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0031 | 1 | F | S-CSCF Selection | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0032 | - | F | S-CSCF name | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0033 | - | F | Text alignment with yaml definitions | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0034 | - | F | Type name alignments | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0035 | - | F | UE-Reachability subscription | 16.3.0 | +| 2020-12 | CT#90 | CP-203066 | 0039 | 1 | F | Private identities | 16.3.0 | +| 2020-12 | CT#90 | CP-203067 | 0040 | 1 | F | Authorization Response | 16.3.0 | +| 2020-12 | CT#90 | CP-203036 | 0041 | - | F | 29.562 Rel-16 API version and External doc update | 16.3.0 | +| 2021-03 | CT#91 | CP-210038 | 0044 | - | F | Authorization Response | 16.4.0 | +| 2021-03 | CT#91 | CP-210054 | 0047 | - | F | 29.562 Rel-16 API version and External doc update | 16.4.0 | +| 2021-03 | CT#91 | CP-210023 | 0045 | - | F | Title and Scope of TS 29.562 | 17.0.0 | +| 2021-06 | CT#92 | CP-211060 | 0049 | 1 | A | Alias Group Id | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0051 | 2 | A | IMSI retrieval | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0054 | 1 | A | Charging Information retrieval | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0056 | - | A | Shared IMPU | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0057 | - | F | OpenAPI Reference | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0059 | - | A | S-CSCF reselection in eIMS | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0061 | - | A | CSRN retrieval | 17.1.0 | +| 2021-06 | CT#92 | CP-211059 | 0063 | - | A | Redirect Responses | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0064 | 1 | A | Correction to schema of requested-nodes | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0065 | - | A | DSAI resource query parameters | 17.1.0 | +| 2021-06 | CT#92 | CP-211060 | 0066 | - | A | Initial Filter Criteria resource query parameter | 17.1.0 | +| 2021-06 | CT#92 | CP-211170 | 0067 | 1 | A | Correction to IMS User Profile | 17.1.0 | +| 2021-06 | CT#92 | CP-211050 | 0073 | - | F | 29.562 Rel-17 API version and External doc update | 17.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------|--------| +| 2021-09 | CT#93 | CP-212066 | 0053 | 1 | A | Query parameter name alignment | 17.2.0 | +| 2021-09 | CT#93 | CP-212066 | 0078 | - | A | imsUeld pattern | 17.2.0 | +| 2021-09 | CT#93 | CP-212026 | 0079 | 1 | F | Patch alignment | 17.2.0 | +| 2021-09 | CT#93 | CP-212183 | 0080 | 2 | F | Retrieval of multiple Repository Data | 17.2.0 | +| 2021-09 | CT#93 | CP-212066 | 0082 | - | A | RequestedNodes data type definition | 17.2.0 | +| 2021-09 | CT#93 | CP-212066 | 0084 | 1 | F | S-CSCF Restoration Information Retrieval | 17.2.0 | +| 2021-09 | CT#93 | CP-212059 | 0086 | - | F | 29.562 Rel-17 API version and External doc update | 17.2.0 | +| 2021-09 | CT#93 | CP-212066 | 0088 | 1 | A | Correction to shared IMPU | 17.2.0 | +| 2021-12 | CT#94 | CP-213091 | 0090 | 3 | B | HSS GBA SBI Services Definition | 17.3.0 | +| 2021-12 | CT#94 | CP-213132 | 0092 | - | A | Monitored resource URI | 17.3.0 | +| 2021-12 | CT#94 | CP-213132 | 0094 | - | A | Supported Feature | 17.3.0 | +| 2021-12 | CT#94 | CP-213091 | 0095 | 1 | B | HSS GBA SDM API Definition | 17.3.0 | +| 2021-12 | CT#94 | CP-213091 | 0096 | 1 | B | HSS GBA UEAU API Definition | 17.3.0 | +| 2021-12 | CT#94 | CP-213121 | 0097 | - | F | 29.562 Rel-17 API version and External doc update | 17.3.0 | +| 2022-03 | CT#95 | CP-220023 | 0099 | - | F | Wrong Oauth2 scope name | 17.4.0 | +| 2022-03 | CT#95 | CP-220029 | 0100 | 1 | F | User Identifier Pattern | 17.4.0 | +| 2022-03 | CT#95 | CP-220066 | 0101 | - | F | 29.562 Rel-17 API version and External doc update | 17.4.0 | +| 2022-06 | CT#96 | CP-221094 | 0103 | 1 | F | Missing Description Fields and Additional Corrections | 17.5.0 | +| 2022-06 | CT#96 | CP-221058 | 0104 | - | F | Corrections to the Nhss_imsUEAU API | 17.5.0 | +| 2022-06 | CT#96 | CP-221058 | 0105 | 1 | F | Corrections to the Nhss_imsUECM API | 17.5.0 | +| 2022-06 | CT#96 | CP-221028 | 0106 | - | F | RestorationInfoDelete clarification | 17.5.0 | +| 2022-06 | CT#96 | CP-221029 | 0107 | 1 | F | Corrections Nhss_imsSDM API | 17.5.0 | +| 2022-06 | CT#96 | CP-221051 | 0108 | - | F | 29.562 Rel-17 API version and External doc update | 17.5.0 | +| 2022-09 | CT#97 | CP-222027 | 0109 | 1 | B | Add SBI support Indication for IP-SM-GW in HSS | 17.6.0 | +| 2022-09 | CT#97 | CP-222060 | 0111 | - | A | Obvious yaml error correction | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0112 | - | F | Charging Info retrieval | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0113 | - | F | Core Network Service Authorization | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0114 | - | F | IMS User Profile Retrieval | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0116 | - | F | ImsProfileData | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0117 | - | F | IMS ServicePriority Level | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0118 | - | F | 403 Forbidden | 17.6.0 | +| 2022-09 | CT#97 | CP-222060 | 0120 | - | A | CsLocation | 17.6.0 | +| 2022-09 | CT#97 | CP-222060 | 0122 | - | A | CallReferenceInfo | 17.6.0 | +| 2022-09 | CT#97 | CP-222058 | 0123 | - | F | 29.562 Rel-17 API version and External doc update | 17.6.0 | +| 2022-12 | CT#98 | CP-223028 | 0125 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0127 | - | F | 29.562 Rel-18 API version and External doc update | 18.0.0 | +| 2023-06 | CT#100 | CP-231027 | 0128 | 4 | F | Location header and missing Redirection clause | 18.1.0 | +| 2023-09 | CT#101 | CP-232045 | 0130 | - | B | Add DCSF as service consumer | 18.2.0 | +| 2023-09 | CT#101 | CP-232063 | 0132 | - | A | Add Location description for 201 response | 18.2.0 | +| 2023-09 | CT#101 | CP-232063 | 0134 | 1 | A | Update OpenAPI for Scscf Registration and Scscf Restoration Information Resource URI | 18.2.0 | +| 2023-09 | CT#101 | CP-232060 | 0135 | - | F | 29.562 Rel-18 API version and External doc update | 18.2.0 | +| 2023-12 | CT#102 | CP-233029 | 0137 | 1 | B | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.3.0 | +| 2023-12 | CT#102 | CP-233029 | 0138 | 1 | B | ProblemDetails RFC 7807 obsoleted by 9457 | 18.3.0 | +| 2023-12 | CT#102 | CP-233048 | 0139 | 1 | B | Update the procedure to support DCSF get and update the repository data | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29563/raw.md b/raw/rel-18/29_series/29563/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..cf2ad524d46f3d9b4f2844b54860d9488b862103 --- /dev/null +++ b/raw/rel-18/29_series/29563/raw.md @@ -0,0 +1,4417 @@ + + +# 3GPP TS 29.563 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Home Subscriber Server (HSS) services for interworking with Unified Data Management (UDM); Stage 3; (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------|----| +| Foreword ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions of terms, symbols and abbreviations..... | 10 | +| 3.1 Terms..... | 10 | +| 3.2 Symbols..... | 10 | +| 3.3 Abbreviations ..... | 10 | +| 4 Overview..... | 10 | +| 4.1 Introduction ..... | 10 | +| 5 Services offered by the HSS ..... | 11 | +| 5.1 Introduction ..... | 11 | +| 5.2 Nhss_UEAuthentication Service..... | 11 | +| 5.2.1 Service Description ..... | 11 | +| 5.2.2 Service Operations..... | 11 | +| 5.2.2.1 Introduction..... | 11 | +| 5.2.2.2 Get..... | 12 | +| 5.2.2.2.1 General ..... | 12 | +| 5.2.2.2.2 Authentication Vector Retrieval..... | 12 | +| 5.3 Nhss_SubscriberDataManagement Service ..... | 12 | +| 5.3.1 Service Description ..... | 12 | +| 5.3.2 Service Operations..... | 13 | +| 5.3.2.1 Introduction..... | 13 | +| 5.3.2.2 Get..... | 13 | +| 5.3.2.2.1 General ..... | 13 | +| 5.3.2.2.2 UE Context In PGW Data Retrieval ..... | 13 | +| 5.3.2.3 Subscribe..... | 14 | +| 5.3.2.3.1 General ..... | 14 | +| 5.3.2.3.2 Subscription to notifications of data change ..... | 14 | +| 5.3.2.4 Unsubscribe ..... | 15 | +| 5.3.2.4.1 General ..... | 15 | +| 5.3.2.4.2 Unsubscribe to notifications of data change ..... | 15 | +| 5.3.2.5 Notification ..... | 15 | +| 5.3.2.5.1 General ..... | 15 | +| 5.3.2.5.2 Data Change Notification To NF ..... | 15 | +| 5.3.2.6 ModifySubscription ..... | 16 | +| 5.3.2.6.1 General ..... | 16 | +| 5.3.2.6.2 Modification of a subscription to notifications of data change..... | 16 | +| 5.4 Nhss_UEContextManagement Service..... | 17 | +| 5.4.1 Service Description ..... | 17 | +| 5.4.2 Service Operations..... | 17 | +| 5.4.2.1 Introduction..... | 17 | +| 5.4.2.2 SnDeregistration ..... | 17 | +| 5.4.2.2.1 General ..... | 17 | +| 5.4.2.2.2 SN Deregistration..... | 17 | +| 5.4.2.3 IMEI Update ..... | 18 | +| 5.4.2.4 Roaming Status Update ..... | 19 | +| 5.5 Nhss_EventExposure Service ..... | 19 | +| 5.5.1 Service Description ..... | 19 | +| 5.5.2 Service Operations..... | 19 | +| 5.5.2.1 Introduction..... | 19 | +| 5.5.2.2 Subscribe..... | 20 | +| 5.5.2.2.1 General ..... | 20 | +| 5.5.2.2.2 Subscription to Notification of event occurrence..... | 20 | +| 5.5.2.3 Unsubscribe ..... | 21 | + +| | | | +|-----------|--------------------------------------------------------|----| +| 5.5.2.3.1 | General ..... | 21 | +| 5.5.2.3.2 | Unsubscribe to notifications of event occurrence ..... | 21 | +| 5.5.2.4 | Notify ..... | 22 | +| 5.5.2.4.1 | General ..... | 22 | +| 5.5.2.4.2 | Event Occurrence Notification..... | 22 | +| 5.5.2.5 | ModifySubscription ..... | 22 | +| 5.5.2.5.1 | General ..... | 22 | +| 5.5.2.5.2 | Modification of a subscription ..... | 22 | +| 6 | API Definitions ..... | 23 | +| 6.1 | Nhss_UEAuthentication Service API ..... | 23 | +| 6.1.1 | Introduction ..... | 23 | +| 6.1.2 | Usage of HTTP..... | 24 | +| 6.1.2.1 | General..... | 24 | +| 6.1.2.2 | HTTP standard headers..... | 24 | +| 6.1.2.2.1 | General ..... | 24 | +| 6.1.2.2.2 | Content type ..... | 24 | +| 6.1.2.3 | HTTP custom headers..... | 24 | +| 6.1.2.3.1 | General ..... | 24 | +| 6.1.3 | Resources..... | 24 | +| 6.1.3.1 | Overview..... | 24 | +| 6.1.4 | Custom Operations without associated resources ..... | 25 | +| 6.1.4.1 | Overview..... | 25 | +| 6.1.4.2 | Operation: Generate AV ..... | 25 | +| 6.1.4.2.1 | Description ..... | 25 | +| 6.1.4.2.2 | Operation Definition ..... | 25 | +| 6.1.5 | Notifications ..... | 26 | +| 6.1.6 | Data Model ..... | 26 | +| 6.1.6.1 | General..... | 26 | +| 6.1.6.2 | Structured data types..... | 27 | +| 6.1.6.2.1 | Introduction ..... | 27 | +| 6.1.6.2.2 | Type: AvGenerationRequest..... | 27 | +| 6.1.6.2.3 | Type: AvGenerationResponse..... | 27 | +| 6.1.6.3 | Simple data types and enumerations..... | 27 | +| 6.1.6.3.1 | Introduction ..... | 27 | +| 6.1.6.3.2 | Simple data types ..... | 27 | +| 6.1.7 | Error Handling ..... | 27 | +| 6.1.7.1 | General..... | 27 | +| 6.1.7.2 | Protocol Errors ..... | 27 | +| 6.1.7.3 | Application Errors..... | 28 | +| 6.1.8 | Feature negotiation ..... | 28 | +| 6.1.9 | Security..... | 28 | +| 6.1.10 | HTTP redirection..... | 28 | +| 6.2 | Nhss_SubscriberDataManagement Service API..... | 28 | +| 6.2.1 | API URI..... | 28 | +| 6.2.2 | Usage of HTTP..... | 29 | +| 6.2.2.1 | General..... | 29 | +| 6.2.2.2 | HTTP standard headers..... | 29 | +| 6.2.2.2.1 | General ..... | 29 | +| 6.2.2.2.2 | Content type ..... | 29 | +| 6.2.2.3 | HTTP custom headers..... | 29 | +| 6.2.2.3.1 | General ..... | 29 | +| 6.2.3 | Resources..... | 30 | +| 6.2.3.1 | Overview..... | 30 | +| 6.2.3.2 | Resource: UeContextInPgwData ..... | 30 | +| 6.2.3.2.1 | Description ..... | 30 | +| 6.2.3.2.2 | Resource Definition..... | 30 | +| 6.2.3.2.3 | Resource Standard Methods..... | 31 | +| 6.2.3.3 | Resource: Subscriptions..... | 32 | +| 6.2.3.3.1 | Description ..... | 32 | +| 6.2.3.3.2 | Resource Definition..... | 32 | +| 6.2.3.3.3 | Resource Standard Methods..... | 32 | + +| | | | +|-----------|------------------------------------------------------|----| +| 6.2.3.4 | Resource: Individual subscription ..... | 33 | +| 6.2.3.4.1 | Description ..... | 33 | +| 6.2.3.4.2 | Resource Definition..... | 33 | +| 6.2.3.4.3 | Resource Standard Methods..... | 34 | +| 6.2.4 | Custom Operations without associated resources ..... | 36 | +| 6.2.5 | Notifications ..... | 36 | +| 6.2.5.1 | General..... | 36 | +| 6.2.5.2 | Data Change Notification ..... | 36 | +| 6.2.6 | Data Model ..... | 37 | +| 6.2.6.1 | General..... | 37 | +| 6.2.6.2 | Structured data types..... | 38 | +| 6.2.6.2.1 | Introduction ..... | 38 | +| 6.2.6.2.2 | Type: UeContextInPgwData ..... | 38 | +| 6.2.6.2.3 | Type: SubscriptionData..... | 39 | +| 6.2.6.2.4 | Type: SubscriptionDataSets ..... | 39 | +| 6.2.6.3 | Simple data types and enumerations..... | 39 | +| 6.2.6.3.1 | Introduction ..... | 39 | +| 6.2.6.3.2 | Simple data types ..... | 39 | +| 6.2.7 | Error Handling ..... | 40 | +| 6.2.7.1 | General..... | 40 | +| 6.2.7.2 | Protocol Errors ..... | 40 | +| 6.2.7.3 | Application Errors..... | 40 | +| 6.2.8 | Feature Negotiation ..... | 40 | +| 6.2.9 | Security ..... | 40 | +| 6.2.10 | HTTP redirection..... | 40 | +| 6.3 | Nhss_UEContextManagement Service API..... | 41 | +| 6.3.1 | Introduction ..... | 41 | +| 6.3.2 | Usage of HTTP..... | 41 | +| 6.3.2.1 | General..... | 41 | +| 6.3.2.2 | HTTP standard headers..... | 41 | +| 6.3.2.2.1 | General ..... | 41 | +| 6.3.2.2.2 | Content type ..... | 41 | +| 6.3.2.3 | HTTP custom headers..... | 41 | +| 6.3.2.3.1 | General ..... | 41 | +| 6.3.3 | Resources..... | 42 | +| 6.3.3.1 | Overview..... | 42 | +| 6.3.4 | Custom Operations without associated resources ..... | 42 | +| 6.3.4.1 | Overview..... | 42 | +| 6.3.4.2 | Operation: deregister-sn..... | 42 | +| 6.3.4.2.1 | Description ..... | 42 | +| 6.3.4.2.2 | Operation Definition ..... | 42 | +| 6.3.4.3 | Operation: imei-update ..... | 43 | +| 6.3.4.3.1 | Description ..... | 43 | +| 6.3.4.3.2 | Operation Definition ..... | 43 | +| 6.3.4.4 | Operation: roaming-status-update..... | 44 | +| 6.3.4.4.1 | Description ..... | 44 | +| 6.3.4.4.2 | Operation Definition ..... | 44 | +| 6.3.5 | Notifications ..... | 45 | +| 6.3.6 | Data Model ..... | 45 | +| 6.3.6.1 | General..... | 45 | +| 6.3.6.2 | Structured data types..... | 46 | +| 6.3.6.2.1 | Introduction ..... | 46 | +| 6.3.6.2.2 | Type: DeregistrationRequest..... | 46 | +| 6.3.6.2.3 | Type: ImeiUpdateInfo..... | 46 | +| 6.3.6.2.4 | Type: ImeiUpdateResponse ..... | 47 | +| 6.3.6.2.5 | Type: RoamingStatusUpdateInfo ..... | 47 | +| 6.3.6.3 | Simple data types and enumerations..... | 47 | +| 6.3.6.3.1 | Introduction ..... | 47 | +| 6.3.6.3.2 | Simple data types ..... | 47 | +| 6.3.6.3.3 | Enumeration: DeregistrationReason ..... | 48 | +| 6.3.7 | Error Handling ..... | 48 | +| 6.3.7.1 | General..... | 48 | + +| | | | +|------------|------------------------------------------------------|----| +| 6.3.7.2 | Protocol Errors ..... | 48 | +| 6.3.7.3 | Application Errors..... | 48 | +| 6.3.8 | Feature Negotiation ..... | 48 | +| 6.3.9 | Security ..... | 49 | +| 6.3.10 | HTTP redirection..... | 49 | +| 6.4 | Nhss_EventExposure Service API ..... | 49 | +| 6.4.1 | API URI ..... | 49 | +| 6.4.2 | Usage of HTTP..... | 49 | +| 6.4.2.1 | General ..... | 49 | +| 6.4.2.2 | HTTP standard headers..... | 49 | +| 6.4.2.2.1 | General ..... | 49 | +| 6.4.2.2.2 | Content type ..... | 50 | +| 6.4.2.3 | HTTP custom headers..... | 50 | +| 6.4.2.3.1 | General ..... | 50 | +| 6.4.3 | Resources..... | 50 | +| 6.4.3.1 | Overview..... | 50 | +| 6.4.3.2 | Resource: EeSubscriptions (Collection) ..... | 51 | +| 6.4.3.2.1 | Description ..... | 51 | +| 6.4.3.2.2 | Resource Definition..... | 51 | +| 6.4.3.2.3 | Resource Standard Methods..... | 51 | +| 6.4.3.3 | Resource: Individual subscription (Document) ..... | 52 | +| 6.4.3.3.1 | Resource Definition..... | 52 | +| 6.4.3.3.2 | Resource Standard Methods..... | 53 | +| 6.4.4 | Custom Operations without associated resources ..... | 55 | +| 6.4.5 | Notifications ..... | 55 | +| 6.4.5.1 | General..... | 55 | +| 6.4.5.2 | Event Occurrence Notification ..... | 56 | +| 6.4.6 | Data Model ..... | 57 | +| 6.4.6.1 | General ..... | 57 | +| 6.4.6.2 | Structured data types..... | 57 | +| 6.4.6.2.1 | Introduction ..... | 57 | +| 6.4.6.2.2 | Type: EeSubscription ..... | 58 | +| 6.4.6.2.3 | Type: CreatedEeSubscription..... | 59 | +| 6.4.6.2.4 | Type: MonitoringConfiguration ..... | 60 | +| 6.4.6.2.5 | Type: MonitoringReport ..... | 60 | +| 6.4.6.2.6 | Type: Report..... | 61 | +| 6.4.6.2.7 | Type: ReportingOptions..... | 61 | +| 6.4.6.2.8 | Type: LocationReportingConfiguration ..... | 61 | +| 6.4.6.2.9 | Type: ReachabilityForSmsReport..... | 62 | +| 6.4.6.2.10 | Type: LossConnectivityConfiguration ..... | 62 | +| 6.4.6.2.11 | Type: ReachabilityForDataConfiguration..... | 62 | +| 6.4.6.2.12 | Type: PduSessionStatusCfg ..... | 62 | +| 6.4.6.2.13 | Type: ReachabilityForDataReport ..... | 63 | +| 6.4.6.2.14 | Type: FailedMonitoringConfiguration..... | 63 | +| 6.4.6.2.15 | Type: EeSubscriptionErrorAddInfo ..... | 63 | +| 6.4.6.2.16 | Type: EeSubscriptionError..... | 63 | +| 6.4.6.3 | Simple data types and enumerations..... | 63 | +| 6.4.6.3.1 | Introduction ..... | 63 | +| 6.4.6.3.2 | Simple data types ..... | 63 | +| 6.4.6.3.3 | Enumeration: EventType..... | 64 | +| 6.4.6.3.4 | Enumeration: LocationAccuracy..... | 64 | +| 6.4.6.3.5 | Enumeration: FailedCause ..... | 65 | +| 6.4.7 | Error Handling ..... | 65 | +| 6.4.7.1 | General ..... | 65 | +| 6.4.7.2 | Protocol Errors ..... | 65 | +| 6.4.7.3 | Application Errors..... | 65 | +| 6.4.8 | Feature Negotiation ..... | 65 | +| 6.4.9 | Security ..... | 66 | +| 6.4.10 | HTTP redirection..... | 66 | + +| | | | +|-------------------------------|----------------------------------------|-----------| +| Annex A (normative): | OpenAPI specification ..... | 67 | +| A.1 | General ..... | 67 | +| A.2 | Nhss_UEAuthentication API ..... | 67 | +| A.3 | Nhss_SubscriberDataManagement API..... | 69 | +| A.4 | Nhss_UEContextManagement API ..... | 73 | +| A.5 | Nhss_EE API ..... | 77 | +| Annex B (informative): | Withdrawn API versions ..... | 85 | +| B.1 | General ..... | 85 | +| Annex C (informative): | Change history..... | 86 | + +# Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol, including message flows and API specification details, for the Nhss services, as part of the 5G Service-Based Architecture, offered by the HSS for interworking with the 5G UDM Network Function. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The User Data Interworking, Coexistence and Migration stage 2 architecture and procedures are specified in 3GPP TS 23.632 [8]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 23.335: "User Data Convergence (UDC); Technical realization and information flows". +- [7] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [8] 3GPP TS 23.632: "User Data Interworking, Coexistence and Migration". +- [9] IETF RFC 9113: "HTTP/2". +- [10] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", . +- [11] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [12] IETF RFC 9457: "Problem Details for HTTP APIs". + +- [13] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [14] 3GPP TR 21.900: "Technical Specification Group working methods". +- [15] 3GPP TS 23.003: "Numbering, addressing and identification". +- [16] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3". +- [17] 3GPP TS 29.272: "Evolved Packet System; MME and SGSN Related Interfaces Based on Diameter Protocol". +- [18] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [19] 3GPP TS 29.335: "User Data Convergence (UDC); User Data Repository Access Protocol over the Ud interface". +- [20] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [21] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +Void. + +## 3.2 Symbols + +Void. + +## 3.3 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]. + +| | | +|------|----------------------------| +| 5GC | 5G Core Network | +| HSS | Home Subscriber Server | +| JSON | Javascript Object Notation | +| SBI | Service Based Interface | +| UDM | Unified Data Management | +| UDR | Unified Data Repository | + +# --- 4 Overview + +## 4.1 Introduction + +Within the 5GC, the HSS offers services to the UDM via the Nhss service-based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.632 [8]). + +Figure 4.1-1 provides the reference model in service-based interface representation with focus on the HSS. + +![Figure 4.1-1: Reference model – HSS. A diagram showing a UDM (User Data Management) block connected to an HSS (Home Subscriber Server) block via an interface labeled Nhss. The HSS block is highlighted in green.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +graph LR + UDM[UDM] --- Nhss((Nhss)) + Nhss --- HSS[HSS] + style HSS fill:#90EE90,stroke:#000 + +``` + +Figure 4.1-1: Reference model – HSS. A diagram showing a UDM (User Data Management) block connected to an HSS (Home Subscriber Server) block via an interface labeled Nhss. The HSS block is highlighted in green. + +Figure 4.1-1: Reference model – HSS + +# 5 Services offered by the HSS + +## 5.1 Introduction + +The HSS offers the following services via the Nhss interface: + +- Nhss\_UEAuthentication Service +- Nhss\_SubscriberDataManagement Service +- Nhss\_UEContextManagement service + +All scenarios shown in the following clauses assume that the HSS is stateful and stores information in local memory. However, the HSS may be stateless and stores information externally in the EPS-UDR. If so, the stateless HSS makes use of Ud interface as specified in 3GPP TS 23.335 [6] and 3GPP TS 29.335 [19] to retrieve required data from the EPS-UDR and store them locally before processing an incoming request. Processing the incoming request may then include updating data in the EPS-UDR or subscribing to data change notifications at the EPS-UDR by using the Ud interface. After processing the incoming request, the HSS may delete the locally stored data. + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------------------------|--------|--------------------------------|----------------------------|-----------|-------| +| Nhss_UEAuthentication Service | 6.1 | HSS UE Authentication Service | TS29563_Nhss_UEAU.yaml | nhss-ueau | A.2 | +| Nhss_SubscriberDataManagement Service | 6.2 | HSS Subscriber Data Management | TS29563_Nhss_SDM.yaml | nhss-sdm | A.3 | +| Nhss_UEContextManagement Service | 6.3 | HSS UE Context Management | TS29563_Nhss_UECM.yaml | nhss-uecm | A.4 | +| Nhss_EventExposure | 6.4 | HSS Event Exposure | TS29563_Nhss_EE.yaml | nhss-ee | A.5 | + +## 5.2 Nhss\_UEAuthentication Service + +### 5.2.1 Service Description + +The Nhss\_UEAuthentication service allows a NF consumer (UDM) to request calculation of a fresh Authentication Vector (AV) for 5G\_AKA or EAP\_AKA\_PRIME and provide the calculated AV to the requesting NF. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nhss\_UEAuthentication service the following service operation is defined: + +- Get + +The Nhss\_UEAuthentication service is used by the UDM to request the HSS to, calculate a fresh authentication vector (AV) for authentication the method 5G\_AKA or EAP\_AKA\_PRIME, and provide it to the UDM by means of the Get service operation. See 3GPP TS 23.632 [8] clause 4.2.2. + +#### 5.2.2.2 Get + +##### 5.2.2.2.1 General + +The following procedure using the Get service operation is supported: + +- Authentication Vector Retrieval + +##### 5.2.2.2.2 Authentication Vector Retrieval + +Figure 5.2.2.2.2-1 shows a scenario where the NF service consumer (UDM) retrieves an Authentication Vector for the UE from the HSS (see also 3GPP TS 23.632 [8] clause 4.2.2). The request contains the UE's identity (imsi), the serving network name, the authentication method (5G\_AKA or EAP\_AKA\_PRIME) and may contain resynchronization info. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for Authentication Vector Retrieval. The consumer sends a POST request with (imsi, serving network name, authentication method, resync. info) to the HSS. The HSS responds with 2a. 200 OK (Authentication Vector), 2b. 403 Forbidden, or 2c. 3xx Redirect.](63e0c22852c26699d0bd095a2d796bab_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note right of NF: (imsi, serving network name, authentication method, resync. info) + NF->>HSS: 1. POST .../generate-av + HSS-->>NF: 2a. 200 OK (Authentication Vector) + HSS-->>NF: 2b. 403 Forbidden + HSS-->>NF: 2c. 3xx Redirect + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for Authentication Vector Retrieval. The consumer sends a POST request with (imsi, serving network name, authentication method, resync. info) to the HSS. The HSS responds with 2a. 200 OK (Authentication Vector), 2b. 403 Forbidden, or 2c. 3xx Redirect. + +**Figure 5.2.2.2.2-1: NF service consumer requesting an Authentication Vector** + +1. The NF service consumer sends a POST request (custom method: generate-av) to the HSS. +- 2a. The HSS responds with "200 OK" with the message body containing the authentication vector. +- 2b. If the operation cannot be authorized due to e.g. UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.3 Nhss\_SubscriberDataManagement Service + +### 5.3.1 Service Description + +This service is used to retrieve the subscriber data indicated by the requested data type from HSS. In this release, only the PGW-C+SMF FQDN for S5/S8 interface information is supported as requested data type. See 3GPP TS 23.632 [8], clause 6.1.4. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +For the Nhss\_SubscriberDataManagement service the following service operations are defined: + +- Get +- Subscribe +- ModifySubscription +- Unsubscribe +- Notification + +The Nhss\_SubscriberDataManagement service is used by Consumer NF (UDM) to retrieve the UE data from the HSS due to IRAT mobility by means of the Get service operation. + +It is also used by consumer NFs to subscribe to notifications of data change by means of the Subscribe service operation. + +It is also used by consumer NFs to modify an existing subscription by means of the ModifySubscription service operation. + +It is also used by consumer NFs that have previously subscribed, to unsubscribe from notifications of data changes by means of the Unsubscribe service operation. + +It is also used by Consumer NFs that have previously subscribed, to get notified by means of the Notification service operation. + +#### 5.3.2.2 Get + +##### 5.3.2.2.1 General + +The following procedure using the Get service operation is supported: + +- UE Context In PGW Data Retrieval + +##### 5.3.2.2.2 UE Context In PGW Data Retrieval + +Figure 5.3.2.2.2-1 shows a scenario where the NF service consumer (UDM) sends a request to the HSS to retrieve the UE's Context In PGW data. The request contains the UE's identity (which shall be an IMSI) and the requested information. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for requesting UE context in PGW data.](b978ce2c39dbbcd4c4e087eb265a830b_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note left of NF: + NF->>HSS: 1. GET .../{ueId}/ue-context-in-pgw-data () + Note right of HSS: + HSS-->>NF: 2a. 200 OK (UeContextInPgwData) + Note right of HSS: + HSS-->>NF: 2b. 404 Not Found + Note right of HSS: + HSS-->>NF: 2c. 3xx Redirect +``` + +The diagram illustrates a sequence of interactions between an 'NF service consumer' and an 'HSS'. The consumer sends a 'GET .../{ueId}/ue-context-in-pgw-data ()' request to the HSS. The HSS responds with one of three possible messages: '2a. 200 OK (UeContextInPgwData)', '2b. 404 Not Found', or '2c. 3xx Redirect'. + +Sequence diagram showing the interaction between an NF service consumer and an HSS for requesting UE context in PGW data. + +**Figure 5.3.2.2.2-1: Requesting a UE's Context in PGW Data** + +1. The NF service consumer (e.g. UDM) shall send a GET request to the resource representing the UE's Context In PGW Data. + +2a. On Success, the HSS shall respond with "200 OK" with the message body containing the UE's Context In PGW Data as relevant for the requesting NF service consumer. + +2b. If there is no valid data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.3 Subscribe + +##### 5.3.2.3.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscription to notification of data change + +##### 5.3.2.3.2 Subscription to notifications of data change + +Figure 5.3.2.3.2-1 shows a scenario where the NF service consumer (e.g. UDM) sends a request to the HSS to subscribe to notifications of data change. The request contains a callback URI and the URI of the monitored resource. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for subscription to notifications of data change.](e190b6ddb7c2e64b940749a1c5612256_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note right of HSS: 2a. 201 Created (SubscriptionData) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 501 Not Implemented + Note right of HSS: 2d. 3xx Redirect + NF->>HSS: 1. POST .../{ueId}/subscriptions (SubscriptionData) + HSS-->>NF: 2a. 201 Created (SubscriptionData) + HSS-->>NF: 2b. 404 Not Found + HSS-->>NF: 2c. 501 Not Implemented + HSS-->>NF: 2d. 3xx Redirect +``` + +The diagram illustrates a sequence of messages between an NF service consumer and an HSS. The NF service consumer sends a POST request (1. POST .../{ueId}/subscriptions (SubscriptionData)) to the HSS. The HSS responds with one of four possible status codes: 2a. 201 Created (SubscriptionData), 2b. 404 Not Found, 2c. 501 Not Implemented, or 2d. 3xx Redirect. The responses are shown as dashed lines from the HSS back to the NF service consumer. + +Sequence diagram showing the interaction between an NF service consumer and an HSS for subscription to notifications of data change. + +**Figure 5.3.2.3.2-1: NF service consumer subscribes to notifications** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (.../{ueId}/subscriptions), to create a subscription as present in message body. +- 2a. On success, the HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the UE subscription data exist, but the requested subscription to data change notification cannot be created (e.g. due to an invalid/unsupported data reference to be monitored, contained in the SubscriptionData parameter), HTTP status code "501 Not Implemented" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.4 Unsubscribe + +##### 5.3.2.4.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscribe to notification of data change + +##### 5.3.2.4.2 Unsubscribe to notifications of data change + +Figure 5.3.2.4.2-1 shows a scenario where the NF service consumer sends a request to the HSS to unsubscribe from notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the Unsubscribe process between an NF service consumer and an HSS.](a7c51c18111139f9aca2805114108565_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant HSS + Note left of NF service consumer: 1. DELETE.../{ueId}/subscriptions/{subscriptionId} + NF service consumer->>HSS: 1. DELETE.../{ueId}/subscriptions/{subscriptionId} + Note right of HSS: 2a. 204 No Content + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + HSS-->>NF service consumer: 2a. 204 No Content + HSS-->>NF service consumer: 2b. 404 Not Found + HSS-->>NF service consumer: 2c. 3xx Redirect +``` + +The diagram illustrates the interaction between an NF service consumer and an HSS for unsubscribing. The consumer sends a DELETE request to a specific subscription resource. The HSS responds with one of three possible HTTP status codes: 204 No Content (success), 404 Not Found (if the subscription does not exist), or a 3xx Redirect (if the request needs to be forwarded to another instance). + +Sequence diagram showing the Unsubscribe process between an NF service consumer and an HSS. + +**Figure 5.3.2.4.2-1: NF service consumer unsubscribes to notifications** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.5 Notification + +##### 5.3.2.5.1 General + +The following procedures using the Notification service operation are supported: + +- Data change notification to NF. + +##### 5.3.2.5.2 Data Change Notification To NF + +Figure 5.3.2.5.2-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change. The request contains the callbackReference URI as previously received in the SubscriptionData. + +![Sequence diagram for Subscription Data Change Notification. The NF service consumer sends a POST {callbackReference} (Notification) to the HSS. The HSS responds with 2a. 204 No Content or 2b. 3xx Redirect.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note left of NF service consumer: 1. POST {callbackReference} (Notification) + NF service consumer->>HSS: 1. POST {callbackReference} (Notification) + Note right of HSS: 2a. 204 No Content +2b. 3xx Redirect + HSS-->>NF service consumer: 2a. 204 No Content +2b. 3xx Redirect + +``` + +Sequence diagram for Subscription Data Change Notification. The NF service consumer sends a POST {callbackReference} (Notification) to the HSS. The HSS responds with 2a. 204 No Content or 2b. 3xx Redirect. + +**Figure 5.3.2.5.2-1: Subscription Data Change Notification** + +1. The HSS sends a POST request to the callbackReference as provided by the NF service consumer during the subscription. +- 2a. The NF service consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +#### 5.3.2.6 ModifySubscription + +##### 5.3.2.6.1 General + +The following procedures using the ModifySubscription service operation are supported: + +- Modification of a Subscription to notification of data change + +##### 5.3.2.6.2 Modification of a subscription to notifications of data change + +Figure 5.3.2.6.2-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram for NF service consumer modifies a subscription to notifications. The NF service consumer sends a PATCH.../{ueId}/subscriptions/{subscriptionId} (PatchItems) to the HSS. The HSS responds with 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](69f52512bb7387a5dc9f952279513019_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note left of NF service consumer: 1. PATCH.../{ueId}/subscriptions/{subscriptionId} (PatchItems) + NF service consumer->>HSS: 1. PATCH.../{ueId}/subscriptions/{subscriptionId} (PatchItems) + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>NF service consumer: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + +``` + +Sequence diagram for NF service consumer modifies a subscription to notifications. The NF service consumer sends a PATCH.../{ueId}/subscriptions/{subscriptionId} (PatchItems) to the HSS. The HSS responds with 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.3.2.6.2-1: NF service consumer modifies a subscription to notifications** + +1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the UDM responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation cannot be authorized, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element) + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.4 Nhss\_UEContextManagement Service + +### 5.4.1 Service Description + +The service allows an NF consumer (UDM) to trigger the cancellation of any previous registered serving node due to IRAT mobility. See 3GPP TS 23.632 [8], clause 6.1.3. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +For the Nhss\_UEContextManagement service the following service operations are defined: + +- SnDeregistration +- ImeiUpdate +- RoamingStatusUpdate + +The Nhss\_UEContextManagement service is used by Consumer NF (UDM) to request HSS to deregister the MME/SGSN via cancel location procedure and to update the IMEI and roaming status of the UE in the HSS. + +#### 5.4.2.2 SnDeregistration + +##### 5.4.2.2.1 General + +The following procedure using the SnDeregistration service operation is supported: + +- SN Deregistration + +##### 5.4.2.2.2 SN Deregistration + +Figure 5.4.2.2.2-1 shows a scenario where the NF service consumer (UDM) requests HSS to initiate Cancel Location procedure towards the MME/SGSN due to IRAT mobility. The request contains the UE's identity which shall be an IMSI. + +![Sequence diagram for SN Deregistration showing the interaction between an NF service consumer and an HSS.](b057cbcc73029e4684d3821b3f303e42_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note left of NF: + NF->>HSS: 1. POST .../deregister-sn (DeregistrationRequest) + Note right of HSS: + HSS-->>NF: 2a. 204 No Content () + Note right of HSS: + HSS-->>NF: 2b. 404 Not Found + Note right of HSS: + HSS-->>NF: 2c. 3xx Redirect +``` + +The diagram illustrates a sequence of interactions between an 'NF service consumer' and an 'HSS'. The consumer sends a '1. POST .../deregister-sn (DeregistrationRequest)' to the HSS. The HSS responds with one of three possible messages: '2a. 204 No Content ()', '2b. 404 Not Found', or '2c. 3xx Redirect'. + +Sequence diagram for SN Deregistration showing the interaction between an NF service consumer and an HSS. + +Figure 5.4.2.2.2-1: SN Deregistration + +1. The NF service consumer sends a POST request (custom method: deregister-sn) to the HSS; the request body contains the UE identity (IMSI) and the deregistration reason. + +The HSS, based on the value indicated in the deregistration reason, initiates a Cancel Location towards the serving node, including a Cancellation Type value (see 3GPP TS 29.272 [17] and 3GPP TS 29.002 [20]) as follows: + +- "UE\_INITIAL\_AND\_SINGLE\_REGISTRATION": S6a/S6d/Gr(S4/Gn/Gp) Cancel Location sent towards MME/SGSN, with a Cancellation-Type set to MME\_UPDATE\_PROCEDURE/SGSN\_UPDATE\_PROCEDURE; the HSS shall delete the stored MME/SGSN address and MME/SGSN number. + +Additionally, a MAP D Cancel Location (IMSI) shall be sent towards MSC/VLR if a VLR number was found in the HSS/HLR for the user; the HSS/HLR shall delete the stored MSC/VLR number. + +- "UE\_INITIAL\_AND\_DUAL\_REGISTRATION": S6d/Gr(S4) Cancel Location sent towards SGSN, with a Cancellation-Type set to SGSN\_UPDATE\_PROCEDURE; the HSS shall delete the stored SGSN address and SGSN number. + +NOTE 1: As described in 3GPP TS 23.502 [3], a UE operating in dual-registration mode indicates that it is moving from EPS, which implies that there is an MME registered in HSS. + +- "EPS\_TO\_5GS\_MOBILITY": S6a Cancel Location sent towards MME, with a Cancellation-Type set to MME\_UPDATE\_PROCEDURE; the HSS shall delete the stored MME address and MME number. + +Additionally, a MAP D Cancel Location (IMSI) shall be sent towards MSC/VLR if a VLR number was found in the HSS/HLR for the user; the HSS/HLR shall delete the stored MSC/VLR number. + +- "EPS\_TO\_5GS\_MOBILITY": S6d/Gr(S4) Cancel Location sent towards SGSN, with a Cancellation-Type set to SGSN\_UPDATE\_PROCEDURE; the HSS shall delete the stored SGSN address and SGSN number. + +NOTE 2: Based on operator policy, and the presence of GUAMI in the DeregistrationRequest, the HSS can decide whether a registered VLR in the VPLMN needs to be cancelled. It should be noted that keeping the VLR registration can impact terminating services (e.g. T-ADS, MT-SMS...) causing failed paging attempts. + +2a. On success, the HSS responds with "204 No Content". If the HSS has a valid subscription for the UE, but the UE is not registered in EPS network, the HSS shall respond with "204 No Content". + +2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.4.2.3 IMEI Update + +Figure 5.4.2.3-1 shows a scenario where the NF service consumer (UDM) requests HSS to update the IMEI of the UE stored in the HSS. The request contains the UE's identity which shall be an IMSI, and the new IMEI of the UE. + +![Sequence diagram for IMEI Update. The NF service consumer sends a POST request to the HSS. The HSS responds with one of three options: 2a. 200 OK or 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect.](0882d90c2036d3612040d0989282678a_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS + Note left of NF: + NF->>HSS: 1. POST .../imei-update (ImeiUpdateInfo) + Note right of HSS: + HSS-->>NF: 2a. 200 OK or 204 No Content () + Note right of HSS: + HSS-->>NF: 2b. 404 Not Found + Note right of HSS: + HSS-->>NF: 2c. 3xx Redirect + +``` + +Sequence diagram for IMEI Update. The NF service consumer sends a POST request to the HSS. The HSS responds with one of three options: 2a. 200 OK or 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect. + +Figure 5.4.2.3-1: IMEI Update + +1. The NF service consumer sends a POST request (custom method: imei-update) to the HSS; the request body contains the UE identity (IMSI) and the new IMEI of the UE. + +- 2a. On success, the HSS responds either with "204 No Content", which indicates that the HSS does not have any stored IMEI(SV) value for the UE, or with a "200 OK", which indicates that the HSS had an IMEI value stored for the UE. In the latter case, the HSS shall update the locally stored IMEI value for the UE, and return in the response body the previous IMEI, so the NF Service Consumer (UDM) can determine whether the HSS contained a different IMEI value than the current one sent to the HSS in this IMEI Update notification. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.4.2.4 Roaming Status Update + +Figure 5.4.2.4-1 shows a scenario where the NF service consumer (UDM) requests HSS to update the Roaming Status of the UE stored in the HSS. The request contains the UE's identity which shall be an IMSI, and the new PLMN-ID where the UE is located. + +![Sequence diagram for Roaming Status Update showing interaction between NF service consumer and HSS.](40f30e4d577a17052f8b1e6dc802a0d8_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant HSS + Note left of NF: 1. POST .../roaming-status-update (RoamingStatusUpdateInfo) + NF->>HSS: Request + Note right of HSS: 2a. 200 OK, 204 No Content + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + HSS-->>NF: Response +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and an HSS. The NF service consumer sends a POST request (step 1) to the HSS. The HSS responds with one of three possible status codes (steps 2a, 2b, or 2c). The request is labeled as '1. POST .../roaming-status-update (RoamingStatusUpdateInfo)'. The responses are labeled as '2a. 200 OK, 204 No Content', '2b. 404 Not Found', and '2c. 3xx Redirect'. + +Sequence diagram for Roaming Status Update showing interaction between NF service consumer and HSS. + +Figure 5.4.2.4-1: Roaming Status Update + +1. The NF service consumer sends a POST request (custom method: roaming-status-update) to the HSS; the request body contains the UE identity (IMSI) and the new PLMN-ID of the UE. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.5 Nhss\_EventExposure Service + +### 5.5.1 Service Description + +See 3GPP TS 23.632 [8]. + +### 5.5.2 Service Operations + +#### 5.5.2.1 Introduction + +For the Nhss\_EventExposure service the following service operations are defined: + +- Subscribe +- Unsubscribe +- Notify +- ModifySubscription + +The Nhss\_EventExposure service is used by consumer NFs (e.g. UDM) to subscribe to notifications of event occurrence by means of the Subscribe service operation. + +The Nhss\_EventExposure service is also used by the consumer NFs (e.g. UDM) that have previously subscribed to notifications, to unsubscribe by means of the Unsubscribe service operation. + +The Nhss\_EventExposure service is also used by the subscribed consumer NFs (e.g. UDM) to modify an existing subscription by means of the ModifySubscription service operation. + +#### 5.5.2.2 Subscribe + +##### 5.5.2.2.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscribe to Notification of event occurrence + +##### 5.5.2.2.2 Subscription to Notification of event occurrence + +Figure 5.5.2.2.2-1 shows a scenario where the NF service consumer sends a request to the HSS to subscribe to notifications of event occurrence. The request contains a callback URI, the type of event that is monitored and additional information e.g. SCEF Id, event filters and reporting options. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for subscription. The consumer sends a POST request to the HSS. The HSS responds with one of several possible status codes: 2a. 201 Created, 2b. 404 Not Found, 2c. 403 Forbidden, 2d. 3xx Redirect, or 2e. 501 Not Implemented.](5c6787bac31274e2dc992efeca74b303_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note left of NF: + NF->>HSS: 1. POST.../{ueId}/ee-subscriptions (EeSubscription) + Note right of HSS: + HSS-->>NF: 2a. 201 Created (CreatedEeSubscription) + Note right of HSS: + HSS-->>NF: 2b. 404 Not Found + Note right of HSS: + HSS-->>NF: 2c. 403 Forbidden + Note right of HSS: + HSS-->>NF: 2d. 3xx Redirect + Note right of HSS: + HSS-->>NF: 2e. 501 Not Implemented + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for subscription. The consumer sends a POST request to the HSS. The HSS responds with one of several possible status codes: 2a. 201 Created, 2b. 404 Not Found, 2c. 403 Forbidden, 2d. 3xx Redirect, or 2e. 501 Not Implemented. + +**Figure 5.5.2.2.2-1: NF service consumer subscribes to notifications** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (.../{ueId}/ee-subscriptions), to create a subscription as present in message body. The request may contain an expiry time, suggested by the NF Service Consumer, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event(s) shall stop generating notifications. Additionally, the request may include an SCEF Id if Common Network Exposure is used (i.e. if combined SCEF+NEF requested the event(s) to be subscribed/monitored in EPC) + +If MTC Provider information is received in the request, the HSS shall check whether the MTC Provider is allowed to perform this operation for the UE; otherwise, the HSS shall skip the MTC provider authorization check. + +- 2a. On success, the HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. + +If immediate reporting is requested and if both HSS and NF consumer has indicated supporting of ERIR feature (see clause 6.4.8), the HSS shall include available immediate event reports, i.e. reports already received from MME, in the response body; otherwise if the HSS and/or the NF consumer cannot support the ERIR feature, the HSS shall send a notification (see clause 5.5.2.4.2) towards the NF consumer including the current status of the events requested for immediate reporting. If immediate reporting is requested but the current status of the event(s) is not available at the time of subscription, the HSS should include the current status not available indication in the response. + +If some of the requested monitoring configurations fails, the response may include the failedMonitoringConfigs to indicate the failed cause of the failed monitoring configurations. + +- 2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If there is no valid subscription data for the UE, i.e. based on the UE's subscription information monitoring of the requested EventType is not allowed, or the requested EventType is not supported, or the MTC Provider is not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2d. In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. +- 2e. If the requested monitoring event types or reporting options are not supported, HTTP status code "501 Not Implemented" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.5.2.3 Unsubscribe + +##### 5.5.2.3.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscribe to Notifications of event occurrence + +##### 5.5.2.3.2 Unsubscribe to notifications of event occurrence + +Figure 5.5.2.3.2-1 shows a scenario where the NF service consumer sends a request to the HSS to unsubscribe from notifications of event occurrence. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the Unsubscribe process between an NF service consumer and an HSS. The consumer sends a DELETE request to the HSS. The HSS responds with one of three possible status codes: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect.](c0e369274e53b2e5364666be6f786c7a_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note left of NF: 1. DELETE.../{ueId}/ee-subscriptions/{subscriptionId} + NF->>HSS: 1. DELETE.../{ueId}/ee-subscriptions/{subscriptionId} + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF: 2a. 204 No Content +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram showing the Unsubscribe process between an NF service consumer and an HSS. The consumer sends a DELETE request to the HSS. The HSS responds with one of three possible status codes: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.5.2.3.2-1: NF service consumer unsubscribes to notifications** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". + +- 2b. If there is no valid subscription available (e.g. due to an unknown SubscriptionId value), HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.5.2.4 Notify + +##### 5.5.2.4.1 General + +The following procedures using the Notify service operation are supported: + +- Event Occurrence Notification + +##### 5.5.2.4.2 Event Occurrence Notification + +Figure 5.5.2.4.2-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about occurrence of an event or the current status of the events requested for immediate reporting if ERIR feature (see clause 6.4.8) is not supported by the HSS and/or the NF consumer. The request contains the Reference IDs as previously received in the EeSubscription. + +![Sequence diagram showing Event Occurrence Notification between NF service consumer and HSS.](421fc75480c21e7ebb25756826652367_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note right of HSS: 1. POST {callbackReference} (MonitoringReport) + HSS->>NF: + Note left of NF: 2a. 204 No Content + Note left of NF: 2b. 3xx Redirect + NF-->>HSS: +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and an HSS. The HSS sends a POST request (step 1) to the NF service consumer's callback reference URI. The NF service consumer responds with either a 204 No Content status (step 2a) or a 3xx Redirect status (step 2b). + +Sequence diagram showing Event Occurrence Notification between NF service consumer and HSS. + +Figure 5.5.2.4.2-1: Event Occurrence Notification + +1. The HSS sends a POST request to the callbackReference URI as provided by the NF service consumer during the subscription. +- 2a. The NF Service Consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +#### 5.5.2.5 ModifySubscription + +##### 5.5.2.5.1 General + +The following procedures using the ModifySubscription service operation are supported: + +- Modification of an EE-Subscription to notification of events + +##### 5.5.2.5.2 Modification of a subscription + +The service operation is invoked by a NF Service Consumer, e.g. UDM, towards the HSS, when it needs to modify an existing subscription previously created by itself at the HSS. + +The NF Service Consumer shall modify the subscription by using HTTP method PATCH with the URI of the individual subscription resource to be modified. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for updating a subscription. The consumer sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](844077b3034f0030b404207db0ad76b4_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + NF service consumer->>HSS: 1. PATCH .../{ueId}/ee-subscriptions/{subscriptionId} + HSS-->>NF service consumer: 2a. 204 No Content () + HSS-->>NF service consumer: 2b. 404 Not Found + HSS-->>NF service consumer: 2c. 403 Forbidden + HSS-->>NF service consumer: 2d. 3xx Redirect + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for updating a subscription. The consumer sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.5.2.5.2-1: NF service consumer updates subscription** + +1. The NF service consumer (e.g. NEF) shall send a PATCH request to the resource representing a subscription. The modification may be for the events subscribed or for updating the event report options. +- 2a. On success, the request is accepted, the HSS shall respond with "204 No Content". +- 2b. If the resource does not exist e.g. the subscriptionId cannot be found, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the modification can't be accepted, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +# 6 API Definitions + +## 6.1 Nhss\_UEAuthentication Service API + +### 6.1.1 Introduction + +The Nhss\_UEAuthentication service shall use the Nhss\_UEAuthentication API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nhss-ueau". +- The shall be "v1". +- The shall be set as described in clause 6.1. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [9], 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]. + +HTTP messages and bodies for the Nhss\_UEAuthentication service shall comply with the OpenAPI [10] specification contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [11], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [12]) signalled by the content type "application/problem+json". + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +In this release of the specification, no specific custom headers are defined for the Nhss\_UEAuthentication service. + +For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Diagram showing the resource URI structure for the nhss-ueau API. The root URI is {apiRoot}/nhss-ueau/. A sub-resource URI /generate-av is shown, enclosed in a dashed box, connected to the root by a line.](109caef02615eec1894dfc07d24deb97_img.jpg) + +``` +graph TD; Root["{apiRoot}/nhss-ueau/"] --- Sub["/generate-av"]; style Sub stroke-dasharray: 5 5; +``` + +Diagram showing the resource URI structure for the nhss-ueau API. The root URI is {apiRoot}/nhss-ueau/. A sub-resource URI /generate-av is shown, enclosed in a dashed box, connected to the root by a line. + +**Figure 6.1.3.1-1: Resource URI structure of the nhss-ueau API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------|--------------|---------------------------------|--------------------------------| +| n/a | generate-av | generate-av (POST) | Generate Authentication Vector | + +### 6.1.4 Custom Operations without associated resources + +#### 6.1.4.1 Overview + +**Table 6.1.4.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|----------------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| {apiRoot}/nhss-ueau//generate-av | POST | The HSS calculates a fresh Authentication Vector taking into account the received information (imsi, serving network name, authentication method) | + +#### 6.1.4.2 Operation: Generate AV + +##### 6.1.4.2.1 Description + +This custom operation is used by the NF service consumer (UDM) to request calculation of an authentication vector for the provided imsi. + +##### 6.1.4.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.2.2-1 and 6.1.4.2.2-2. + +**Table 6.1.4.2.2-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-----------------------------------------------------------------| +| AvGenerationRequest | M | 1 | Contains input parameters for Authentication Vector calculation | + +**Table 6.1.4.2.2-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------| +| AvGenerationResponse | M | 1 | 200 OK | Upon success, a response body containing the generated authentication vector shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION_REJECTED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | + +**Table 6.1.4.2.2-3: 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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.4.2.2-4: 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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.1.5 Notifications + +In this release of this specification, no notifications are defined for the Nhss\_UEAuthentication Service. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nhss service based interface protocol. + +**Table 6.1.6.1-1: Nhss specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------------|----------------|------------------------------------------------------------------------------------|---------------| +| AvGenerationRequest | 6.1.6.2.2 | Contains imsi, authentication method, serving network name, resynchronization info | | +| AvGenerationResponse | 6.1.6.2.3 | Contains the calculated Authentication Vector | | + +Table 6.1.6.1-2 specifies data types re-used by the Nhss 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 Nhss service based interface. + +**Table 6.1.6.1-2: Nhss re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------------------|---------------------|----------------------------------------------|---------------| +| AuthType | 3GPP TS 29.503 [13] | | | +| ServingNetworkName | 3GPP TS 29.503 [13] | | | +| ResynchronizationInfo | 3GPP TS 29.503 [13] | | | +| AvEapAkaPrime | 3GPP TS 29.503 [13] | | | +| Av5GHeAka | 3GPP TS 29.503 [13] | | | +| ProblemDetails | 3GPP TS 29.571 [7] | Response body of error response messages. | | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of redirect response messages. | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: AvGenerationRequest + +**Table 6.1.6.2.2-1: Definition of type AvGenerationRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-----------------------|---|-------------|------------------------------------------------------------------|---------------| +| imsi | string | M | 1 | pattern: "[0-9]{5,15}" | | +| authType | AuthType | M | 1 | Indicates the authentication method; "EAP_AKA_PRIME" or "5G_AKA" | | +| servingNetworkName | ServingNetworkName | M | 1 | | | +| resynchronizationInfo | ResynchronizationInfo | O | 0..1 | | | + +##### 6.1.6.2.3 Type: AvGenerationResponse + +**Table 6.1.6.2.3-1: Definition of type AvGenerationResponse** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------|---------------| +| avEapAkaPrime | AvEapAkaPrime | C | 0..1 | shall be present if av5GHeAka is absent, otherwise shall be absent. | | +| av5GHeAka | Av5GHeAka | C | 0..1 | shall be present if avEapAkaPrime is absent, otherwise shall be absent. | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.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. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nhss\_UEAuthentication service are listed in table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------------|------------------|--------------------------------------| +| AUTHENTICATION_REJECTED | 403 Forbidden | The user cannot be authenticated | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nhss\_UEAuthentication API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nhss\_UEAU API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_UEAU API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], 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 Nhss\_UEAU service. + +The Nhss\_UEAU API defines a single scope "nhss-ueau" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Nhss\_SubscriberDataManagement Service API + +### 6.2.1 API URI + +The Nhss\_SubscriberDataManagement service shall use the Nhss\_SubscriberDataManagement API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +{apiRoot}// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nhss-sdm". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [9], 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]. + +HTTP messages and bodies for the Nhss\_SubscriberDataManagement service shall comply with the OpenAPI [10] specification contained in Annex A. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [11], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [12]) signalled by the content type "application/problem+json". + +#### 6.2.2.3 HTTP custom headers + +##### 6.2.2.3.1 General + +In this release of the specification, no specific custom headers are defined for the Nhss\_SubscriberDataManagement service. + +For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +![Figure 6.2.3.1-1: Resource URI structure of the nhss-sdm API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-sdm/{apiVersion}. A branch labeled '{ueId}' leads to two sub-resources: '/ue-context-in-pgw-data' and '/subscriptions'. The '/subscriptions' resource further branches into '{subscriptionId}'.](7d2d1d3870cd224c4430d19334557716_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-sdm/{apiVersion}"] --> ueId["{ueId}"] + ueId --> ueContext["/ue-context-in-pgw-data"] + ueId --> subscriptions["/subscriptions"] + subscriptions --> subscriptionId["{subscriptionId}"] + +``` + +Figure 6.2.3.1-1: Resource URI structure of the nhss-sdm API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-sdm/{apiVersion}. A branch labeled '{ueId}' leads to two sub-resources: '/ue-context-in-pgw-data' and '/subscriptions'. The '/subscriptions' resource further branches into '{subscriptionId}'. + +**Figure 6.2.3.1-1: Resource URI structure of the nhss-sdm API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|------------------------------------|----------------------------------------|---------------------------------|--------------------------------------------------------------------------| +| UeContextInPgwData (Document) | /{ueId}/ue-context-in-pgw-data | GET | Retrieve the UE's Context in PGW Data | +| Subscriptions (Collection) | /{ueId}/subscriptions | POST | Create a subscription | +| Individual Subscription (Document) | /{ueId}/subscriptions/{subscriptionId} | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | +| | | PATCH | Modify the subscription identified by {subscriptionId} | + +#### 6.2.3.2 Resource: UeContextInPgwData + +##### 6.2.3.2.1 Description + +This resource represents the allocated PGWs for the UE. + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-sdm/{apiVersion}/{ueId}/ue-context-in-pgw-data + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| ueId | Represents the UE identifier with type IMSI.
pattern: "^(imsi-[0-9]{5,15}).+\$" | + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-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 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| UeContextInPgwData | M | 1 | 200 OK | A response body containing the UeContextInPgwData shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.3.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 of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.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 of the resource located on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.3 Resource: Subscriptions + +##### 6.2.3.3.1 Description + +This resource is used to represent subscriptions to notifications. + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nhss-sdm///subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| ueId | Represents the IMSI of the subscriber.
pattern: "^(imsi-[0-9]{5,15})\$" | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------| +| SubscriptionData | M | 1 | The subscription that is to be created. | + +Table 6.2.3.3.3.1-3: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:

- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate one of the following application errors:

- UNSUPPORTED_RESOURCE_URI

This response shall not be cached. | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +Table 6.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 on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +Table 6.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 on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.4 Resource: Individual subscription + +##### 6.2.3.4.1 Description + +This resource is used to represent an individual subscription to notifications. + +##### 6.2.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nhss-sdm/{apiVersion}/{ueId}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.4.2-1. + +**Table 6.2.3.4.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|----------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| ueId | Represents the IMSI of the subscriber
pattern: "^(imsi-[0-9]{5,15})\$" | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications. | + +##### 6.2.3.4.3 Resource Standard Methods + +###### 6.2.3.4.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.4.3.1-1. + +**Table 6.2.3.4.3.1-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 6.2.3.4.3.1-2 and the response data structures and response codes specified in table 6.2.3.4.3.1-3. + +**Table 6.2.3.4.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.4.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:

- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND (see 3GPP TS 29.500 [4] table 5.2.7.2-1) | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.3.4.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 on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.4.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +###### 6.2.3.4.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.4.3.2-1. + +**Table 6.2.3.4.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.4.3.2-2 and the response data structures and response codes specified in table 6.2.3.4.3.2-3. + +**Table 6.2.3.4.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [13]. | + +**Table 6.2.3.4.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with no content is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND (see 3GPP TS 29.500 [4] table 5.2.7.2-1) | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.
The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED (see 3GPP TS 29.500 [4] table 5.2.7.2-1) | +| NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.2.3.4.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.4.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nhss\_SubscriberDataManagement Service. + +### 6.2.5 Notifications + +#### 6.2.5.1 General + +This clause specifies the use of notifications and corresponding protocol details. + +#### 6.2.5.2 Data Change Notification + +The POST method shall be used for Data Change Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.2.5.2-1. + +**Table 6.2.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.2.5.2-2 and of response data structures and response codes is specified in table 6.2.5.2-3. + +**Table 6.2.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-------------| +| ModificationNotification | M | 1 | | + +Table 6.2.5.2-3: Data structures supported by the POST Response Body + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:

- CONTEXT_NOT_FOUND

See table 6.2.7.3-1 for the description of this error. | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +Table 6.2.5.2-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +Table 6.2.5.2-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nhss\_SubscriberDataManagement service API. + +Table 6.2.6.1-1: Nhss\_SubscriberDataManagement specific Data Types + +| Data type | Clause defined | Description | +|----------------------|----------------|---------------------------| +| UeContextInPgwData | 6.2.6.2.2 | | +| SubscriptionData | 6.2.6.2.3 | Subscription Data | +| SubscriptionDataSets | 6.2.6.2.4 | UE Subscription Data Sets | + +Table 6.2.6.1-2 specifies data types re-used by the Nhss\_SubscriberDataManagement service API from other APIs, including a reference and when needed, a short description of their use within the Nhss\_SubscriberDataManagement service API. + +**Table 6.2.6.1-2: Nhss\_SubscriberDataManagement re-used Data Types** + +| Data type | Reference | Comments | +|--------------------------|---------------------|----------------------------------------------| +| PgwInfo | 3GPP TS 29.503 [13] | | +| ModificationNotification | 3GPP TS 29.503 [13] | | +| NfInstanceId | 3GPP TS 29.571 [7] | Network Function Instance Identifier | +| Uri | 3GPP TS 29.571 [7] | Uniform Resource Identifier | +| DateTime | 3GPP TS 29.571 [7] | | +| ProblemDetails | 3GPP TS 29.571 [7] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of redirect response messages. | +| Fqdn | 3GPP TS 29.571 [7] | Fully Qualified Domain Name | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the data structures to be used in resource representations. + +##### 6.2.6.2.2 Type: UeContextInPgwData + +**Table 6.2.6.2.2-1: Definition of type UeContextInPgwData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------------------------------------------------------------| +| pgwInfo | array(PgwInfo) | O | 1..N | Information about the APNs and PGW-C+SMF FQDNs used in interworking with UDM | +| emergencyFqdn | Fqdn | O | 0..1 | PGW-C+SMF FQDN for emergency session | +| emergencyPlmnId | PlmnId | O | 0..1 | PLMN where the PGW-C+SMF for emergency session is located | +| emergencyIpAddr | IpAddress | O | 0..1 | IP address of the PGW-C+SMF for emergency session | +| emergencyRegistrationTime | DateTime | O | 0..1 | Time of PGW-C+SMF for emergency session Registration. | +| Note: | At least one of pgwInfo and emergencyFqdn/emergencyIpAddr shall be present. The format of PGW-C+SMF FQDN is specified in clause 5.12.3.2, 3GPP TS 29.303 [16]. | | | | + +##### 6.2.6.2.3 Type: SubscriptionData + +Table 6.2.6.2.3-1: Definition of type SubscriptionData + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nfInstanceId | NfInstanceId | M | 1 | Identity of the NF Instance creating the subscription. | +| callbackReference | Uri | M | 1 | URI provided by the NF service consumer to receive notifications | +| monitoredResourceUris | array(Uri) | M | 1..N | A set of URIs that identify the resources for which a change triggers a notification.
The URI shall take the form of either an absolute URI or an absolute-path reference as defined in IETF RFC 3986 [31].
See NOTE 1. | +| expires | DateTime | O | 0..1 | If present in a POST request, it indicates the point in time at which the subscription expires.

Within a POST request the proposed expiry time is conveyed whereas in a POST response or PATCH response the confirmed expiry time is returned. | +| immediateReport | boolean | O | 0..1 | This IE indicates whether immediate report is needed or not.

When present, this IE shall be set as following:
- true: immediate report is required
- false (default) immediate report is not required | +| report | SubscriptionDataSets | C | 0..1 | This IE shall be present in Subscribe response, if the immediateReport attribute is set to "true" in Subscribe request.

When present, this IE shall contain the representation of subscription data sets that to be monitored, i.e. listed in monitoredResourceUris attribute. | + +NOTE 1: The HSS should handle only the relative-path part (apiSpecificResourceUriPart, see 3GPP TS 29.501 [5] clause 4.4.1) and ignore possible inconsistencies (caused by e.g. an SCP) in the base URI part. + +##### 6.2.6.2.4 Type: SubscriptionDataSets + +Table 6.2.6.2.4-1: Definition of type SubscriptionDataSets + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|------------------------| +| ueContextInPgwData | UeContextInPgwData | O | 0..1 | UE Context in PGW Data | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.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. + +##### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +Table 6.2.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.2.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.2.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_SubscriberDataManagement service. The following application errors listed in Table 6.2.7.3-1 are specific for the Nhss\_SubscriberDataManagement service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|------------------------------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist. | +| DATA_NOT_FOUND | 404 Not Found | The requested data is not found/does not exist. | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used during the modification of an existing subscription when no corresponding context exists. | + +### 6.2.8 Feature Negotiation + +The optional features in table 6.2.8-1 are defined for the Nhss\_SubscriberDataManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nhss\_SDM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_SDM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], 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 Nhss\_SDM service. + +The Nhss\_SDM API defines a single scope "nhss-sdm" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.3 Nhss\_UEContextManagement Service API + +### 6.3.1 Introduction + +The Nhss\_UEContextManagement service shall use the Nhss\_UEContextManagement API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nhss-uecm". +- The shall be "v1". +- The shall be set as described in clause 6.1. + +### 6.3.2 Usage of HTTP + +#### 6.3.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [9], 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]. + +HTTP messages and bodies for the Nhss\_UEContextManagement service shall comply with the OpenAPI [10] specification contained in Annex A. + +#### 6.3.2.2 HTTP standard headers + +##### 6.3.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.3.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [11], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 9457 [12]) signalled by the content type "application/problem+json". + +#### 6.3.2.3 HTTP custom headers + +##### 6.3.2.3.1 General + +In this release of the specification, no specific custom headers are defined for the Nhss\_UEContextManagement service. + +For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.3.3 Resources + +#### 6.3.3.1 Overview + +![Diagram showing the resource URI structure of the nhss-uecm API. The base path is {apiRoot}/nhss-uecm/. Three sub-resources are listed: /deregister-sn, /imei-update, and /roaming-status-update, each enclosed in a dashed box and connected to the base path by a vertical line with horizontal branches.](e05122559f56af5699789b7118d8fe87_img.jpg) + +{apiRoot}/nhss-uecm/ + +``` + +graph TD + Base["{apiRoot}/nhss-uecm/"] --- Dashed1[["/deregister-sn"]] + Base --- Dashed2[["/imei-update"]] + Base --- Dashed3[["/roaming-status-update"]] + +``` + +Diagram showing the resource URI structure of the nhss-uecm API. The base path is {apiRoot}/nhss-uecm/. Three sub-resources are listed: /deregister-sn, /imei-update, and /roaming-status-update, each enclosed in a dashed box and connected to the base path by a vertical line with horizontal branches. + +**Figure 6.3.3.1-1: Resource URI structure of the nhss-uecm API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.3.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------|-----------------------|---------------------------------|-------------------------------------------------------------------| +| n/a | deregister-sn | deregister-sn (POST) | Requesting MME/SGSN deregistration | +| n/a | imei-update | imei-update (POST) | Requests the update of the IMEI of the UE stored in HSS | +| n/a | roaming-status-update | roaming-status-update (POST) | Requests the update of the roaming status of the UE stored in HSS | + +### 6.3.4 Custom Operations without associated resources + +#### 6.3.4.1 Overview + +**Table 6.3.4.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|------------------------------------------------|--------------------|-------------------------------------| +| {apiRoot}/nhss-uecm//deregister-sn | POST | Requesting MME/SGSN deregistration. | + +#### 6.3.4.2 Operation: deregister-sn + +#### 6.3.4.2.1 Description + +This custom operation is used by the NF service consumer (UDM) to request MME/SGSN deregistration. + +#### 6.3.4.2.2 Operation Definition + +This operation shall support the data structures and response codes specified in tables 6.3.4.2.2-1 and 6.3.4.2.2-2. + +**Table 6.3.4.2.2-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | | +|-----------------------|---|-------------|-------------|--| +| DeregistrationRequest | M | 1 | | | + +**Table 6.3.4.2.2-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | + +**Table 6.3.4.2.2-3: 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 on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.3.4.2.2-4: 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 on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.3.4.3 Operation: imei-update + +#### 6.3.4.3.1 Description + +This custom operation is used by the NF service consumer (UDM) to request the update of the IMEI of the UE. + +#### 6.3.4.3.2 Operation Definition + +This operation shall support the data structures and response codes specified in tables 6.3.4.3.2-1 and 6.3.4.3.2-2. + +**Table 6.3.4.3.2-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | | +|----------------|---|-------------|-------------|--| +| ImeiUpdateInfo | M | 1 | | | + +Table 6.3.4.3.2-2: Data structures supported by the POST Response Body + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| ImeiUpdateResponse | M | 1 | 200 OK | Upon success, a response body containing the IMEI(SV) stored previously in HSS shall be returned. | +| n/a | | | 204 No Content | Upon success, if the HSS does not have any IMEI(SV) values stored for the UE, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- CONTEXT_NOT_FOUND | + +Table 6.3.4.3.2-3: 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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +Table 6.3.4.3.2-4: 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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.3.4.4 Operation: roaming-status-update + +#### 6.3.4.4.1 Description + +This custom operation is used by the NF service consumer (UDM) to request the update of the roaming status of the UE. + +#### 6.3.4.4.2 Operation Definition + +This operation shall support the data structures and response codes specified in tables 6.3.4.4.2-1 and 6.3.4.4.2-2. + +Table 6.3.4.4.2-1: Data structures supported by the POST Request Body + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|-------------| +| RoamingStatusUpdateInfo | M | 1 | | + +Table 6.3.4.4.2-2: Data structures supported by the POST Response Body + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- CONTEXT_NOT_FOUND | + +Table 6.3.4.4.2-3: 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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +Table 6.3.4.4.2-4: 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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.3.5 Notifications + +In this release of this specification, no notifications are defined for the Nhss\_UEContextManagement Service. + +## 6.3.6 Data Model + +### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.1-1 specifies the structured data types defined for the Nhss\_UECM service API. + +Table 6.3.6.1-1: Nhss\_UECM specific Data Types + +| Data type | Clause defined | Description | Applicability | +|-------------------------|----------------|----------------------------------------------|---------------| +| DeregistrationRequest | 6.3.6.2.2 | Contains IMSI, deregistration reason | | +| ImeiUpdateInfo | 6.3.6.2.3 | Contains IMSI, new IMEI(SV) | | +| ImeiUpdateResponse | 6.3.6.2.4 | Contains the previous IMEI(SV) stored in HSS | | +| RoamingStatusUpdateInfo | 6.3.6.2.5 | Contains PLMN-ID where the UE is located | | + +Table 6.3.6.1-2 specifies data types re-used by the Nhss\_UECM service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_UECM service API. + +**Table 6.3.6.1-2: Nhss\_UECM re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|--------------------|----------------------------------------------|---------------| +| Guami | 3GPP TS 29.571 [7] | | | +| ProblemDetails | 3GPP TS 29.571 [7] | Response body of error response messages. | | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of redirect response messages. | | +| PlmnId | 3GPP TS 29.571 [7] | | | + +## 6.3.6.2 Structured data types + +### 6.3.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 6.3.6.2.2 Type: DeregistrationRequest + +**Table 6.3.6.2.2-1: Definition of type DeregistrationRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| imsi | string | M | 1 | pattern: "[0-9]{5,15}\$" | | +| deregReason | DeregistrationReason | M | 1 | String, see clause 6.3.6.3.3 | | +| guami | Guami | O | 0..1 | The GUAMI identifying the AMF where the UE is registered. May be used by the HSS based on operator policy to decide whether a registered VLR shall be cancelled. | | + +### 6.3.6.2.3 Type: ImeiUpdateInfo + +**Table 6.3.6.2.3-1: Definition of type ImeiUpdateInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------| +| imsi | string | M | 1 | IMSI of the subscriber.
pattern: "[0-9]{5,15}\$" | +| imei | string | C | 0..1 | IMEI of the UE as described in 3GPP TS 23.003 [15], clause 6.2.1; it shall not include the Check Digit.
pattern: "[0-9]{14}\$" | +| imeisv | string | C | 0..1 | IMEISV of the UE as described in 3GPP TS 23.003 [15], clause 6.2.2.
pattern: "[0-9]{16}\$" | +| NOTE: Exactly one of attributes "imei" or "imeisv" shall be present. | | | | | + +## 6.3.6.2.4 Type: ImeiUpdateResponse + +Table 6.3.6.2.4-1: Definition of type ImeiUpdateResponse + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| previousImei | string | C | 0..1 | Previous IMEI of the UE as described in 3GPP TS 23.003 [15], clause 6.2.1; it shall not include the Check Digit.

It shall be included if the HSS has an IMEI value stored for the UE.

pattern: "[0-9]{14}\$" | +| previousImeisv | string | C | 0..1 | IMEISV of the UE as described in 3GPP TS 23.003 [15], clause 6.2.2.

It shall be included if the HSS has an IMEISV value stored for the UE.

pattern: "[0-9]{16}\$" | + +NOTE: At least one of attributes "previousImei" or "previousImeisv" shall be present. + +## 6.3.6.2.5 Type: RoamingStatusUpdateInfo + +Table 6.3.6.2.5-1: Definition of type RoamingStatusUpdateInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------| +| imsi | string | M | 1 | IMSI of the subscriber.

pattern: "[0-9]{5,15}\$" | +| plmnId | PlmnId | M | 1 | PLMN-ID where the UE is located. | + +## 6.3.6.3 Simple data types and enumerations + +## 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.3.6.3.2 Simple data types + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +Table 6.3.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +### 6.3.6.3.3 Enumeration: DeregistrationReason + +**Table 6.3.6.3.3-1: Enumeration DeregistrationReason** + +| Enumeration value | Description | +|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "UE_INITIAL_AND_SINGLE_REGISTRATION" | This value is used when the UDM needs to indicate to HSS that the MME/SGSN, if any, shall be cancelled due to an initial registration for single registration. | +| "UE_INITIAL_AND_DUAL_REGISTRATION" | This value is used when the UDM needs to indicate to HSS that an SGSN shall be cancelled (due to initial registration), but the MME shall not be cancelled (due to dual registration). | +| "EPS_TO_5GS_MOBILITY" | This value is used when the UDM needs to indicate to HSS that the MME/SGSN, if any, shall be cancelled due to a mobility event (i.e. for single registration which is not an initial registration). | + +## 6.3.7 Error Handling + +### 6.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.3.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.3.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nudm\_UEContextManagement service. The application errors defined for the Nhss\_UEContextManagement service are listed in Table 6.3.7.3-1. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-----------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist. | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used when no corresponding UE context exists. | + +## 6.3.8 Feature Negotiation + +The optional features in table 6.3.8-1 are defined for the Nhss\_UEContextManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.3.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.3.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nhss\_UECM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_UECM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], 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 Nhss\_UECM service. + +The Nhss\_UECM API defines a single scope "nhss-uecm" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +## 6.3.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-NF-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# 6.4 Nhss\_EventExposure Service API + +## 6.4.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}// + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-ee" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +## 6.4.2 Usage of HTTP + +### 6.4.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [13], 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]. + +HTTP messages and bodies for the Nhss\_EE service shall comply with the OpenAPI [14] specification contained in Annex A5. + +### 6.4.2.2 HTTP standard headers + +#### 6.4.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.4.2.2.2 Content type + +The following content types shall be supported: + +JSON, as defined in IETF RFC 8259 [15], signalled by the content type "application/json". + +The Problem Details JSON Object (IETF RFC 9457 [16]) signalled by the content type "application/problem+json" + +JSON Patch (IETF RFC 6902 [41]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json". + +#### 6.4.2.3 HTTP custom headers + +##### 6.4.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.4.3 Resources + +#### 6.4.3.1 Overview + +![Diagram showing the resource URI structure of the Nhss_EE API. The root is {apiRoot}/nhss-ee/{apiVersion}. A branch from this root leads to /{ueld}. From /{ueld}, a branch leads to /ee-subscriptions. From /ee-subscriptions, a branch leads to /{subscriptionId}.](f9528ea5b0d2cd0192b7242e5a6af969_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-ee/{apiVersion}"] --> Ueld["/{ueld}"] + Ueld --> EeSubscriptions["/ee-subscriptions"] + EeSubscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the resource URI structure of the Nhss\_EE API. The root is {apiRoot}/nhss-ee/{apiVersion}. A branch from this root leads to /{ueld}. From /{ueld}, a branch leads to /ee-subscriptions. From /ee-subscriptions, a branch leads to /{subscriptionId}. + +**Figure 6.4.3.1-1: Resource URI structure of the Nhss\_EE API** + +Table 6.4.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.4.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|------------------------------------|-------------------------------------------|---------------------------------|--------------------------------------------------------------------------| +| EeSubscriptions (Collection) | /{ueld}/ee-subscriptions | POST | Create a subscription | +| Individual subscription (Document) | /{ueld}/ee-subscriptions/{subscriptionId} | PATCH | Update the subscription identified by {subscriptionId} | +| | | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | + +### 6.4.3.2 Resource: EeSubscriptions (Collection) + +#### 6.4.3.2.1 Description + +This resource is used to represent subscriptions to notifications. + +#### 6.4.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ee//{ueId}/ee-subscriptions + +This resource shall support the resource URI variables defined in table 6.4.3.2.2-1. + +**Table 6.4.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| ueId | Represents the identity of the UE in the HSS (IMSI) or the identity of a group of UEs.
  • - If representing a single UE, this parameter shall contain the IMSI of the UE.
    pattern: See type lmsi in clause 6.4.6.3.2 of this document.
  • - If representing a group of UEs, this parameter shall contain the External Group Id.
    pattern: "^extgroupid-[^@]+@[^\@]+\\$"
(NOTE)
NOTE: If the HSS supports GBEE feature, the ueId can contain the External Group Id, or ueId can only contain IMSI of the UE. | + +#### 6.4.3.2.3 Resource Standard Methods + +##### 6.4.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.4.3.2.3.1-1. + +**Table 6.4.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.4.3.2.3.1-2 and the response data structures and response codes specified in table 6.4.3.2.3.1-3. + +**Table 6.4.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|----------------------------------------| +| EeSubscription | M | 1 | The subscription that is to be created | + +Table 6.4.3.2.3.1-3: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedEeSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned, along with event reports that might be immediately available at the HSS.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| EeSubscriptionError | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- MONITORING_NOT_ALLOWED
- MAXIMUM_RESOURCES_EXCEEDED
- MTC_PROVIDER_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| EeSubscriptionError | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate one of the following application errors:
- UNSUPPORTED_MONITORING_EVENT_TYPE
- UNSUPPORTED_MONITORING_REPORT_OPTIONS

This response shall not be cached. | + +Table 6.4.3.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 of the resource located on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +Table 6.4.3.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 of the resource located on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.4.3.3 Resource: Individual subscription (Document) + +#### 6.4.3.3.1 Resource Definition + +Resource URI: {apiRoot}/nhss-ee/{apiVersion}/{ueId}/ee-subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.4.3.3.1-1. + +**Table 6.4.3.3.1-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| ueId | Represents the identity of the UE in the HSS (IMSI) or the identity of a group of UEs.
  • - If representing a single UE, this parameter shall contain the IMSI of the UE.
    pattern: See type lmsi in clause 6.4.6.3.2 of this document.
  • - If representing a group of UEs, this parameter shall contain the External Group Id.
    pattern: "^extgroupid-[^@]+@[^\@]+\+\$"
(NOTE) | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications
The type is string. | + +NOTE: If the HSS supports GBEE feature, the ueId can contain the External Group Id, or ueId can only contain IMSI of the UE. + +### 6.4.3.3.2 Resource Standard Methods + +#### 6.4.3.3.2.1 DELETE + +This method shall support the URI query parameters specified in table 6.4.3.3.2.1-1. + +**Table 6.4.3.3.1.1-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 6.4.3.3.2.1-2 and the response data structures and response codes specified in table 6.4.3.3.2.1-3. + +**Table 6.4.3.3.2.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.4.3.3.2.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.4.3.3.2.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.3.2.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 on an alternative service instance within the same HSS (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.4.3.3.2.2 PATCH + +This method shall support the URI query parameters specified in table 6.4.3.3.2.2-1. + +**Table 6.4.3.3.2.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.4.3.3.2.2-2 and the response data structures and response codes specified in table 6.4.3.3.2.2-3. + +**Table 6.4.3.3.2.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the Event Subscription | + +**Table 6.4.3.3.2.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.4.3.3.2.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 on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.3.2.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 on an alternative service instance within the same HSS (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.4.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nhss\_EventExposure Service. + +## 6.4.5 Notifications + +### 6.4.5.1 General + +This clause will specify the use of notifications and corresponding protocol details if required for the specific service. When notifications are supported by the API, it will include a reference to the general description of notifications support over the 5G SBIs specified in TS 29.500 / TS 29.501. + +### 6.4.5.2 Event Occurrence Notification + +The POST method shall be used for Event Occurrence Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.4.5.2-1. + +**Table 6.4.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.4.5.2-2 and of response data structures and response codes is specified in table 6.4.5.2-3. + +**Table 6.4.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|---------------------------------------------------------------------------------------------| +| array(MonitoringReport) | M | 1..N | A list of MonitoringReports each of which contains information regarding the occurred event | + +**Table 6.4.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT NOT FOUND | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.4.5.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.5.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.4.6 Data Model + +### 6.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.6.1-1 specifies the data types defined for the Nhss\_EE service API. + +**Table 6.4.6.1-1: Nhss\_EE specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------------|----------------|----------------------------------------------------------------------------| +| EeSubscription | 6.4.6.2.2 | A subscription to Notifications | +| CreatedEeSubscription | 6.4.6.2.3 | | +| MonitoringConfiguration | 6.4.6.2.4 | Monitoring Configuration | +| MonitoringReport | 6.4.6.2.5 | Monitoring Report | +| Report | 6.4.6.2.6 | | +| ReportingOptions | 6.4.6.2.7 | | +| LocationReportingConfiguration | 6.4.6.2.8 | | +| ReachabilityForSmsReport | 6.4.6.2.9 | | +| LossConnectivityConfiguration | 6.4.6.2.10 | | +| ReachabilityForDataConfiguration | 6.4.6.2.11 | | +| PduSessionStatusCfg | 6.4.6.2.12 | Reporting configuration for events related to PDN connectivity Status | +| ReachabilityForDataReport | 6.4.6.2.13 | Report of "UE_REACHABILITY FOR DATA" event | +| FailedMonitoringConfiguration | 6.4.6.2.14 | Failed Monitoring Configuration in the EE subscription | +| EeSubscriptionErrorAddInfo | 6.4.6.2.15 | Event Exposure Subscription Error Additional Information | +| EeSubscriptionError | 6.4.6.2.16 | Event Exposure Subscription Error | +| EventType | 6.4.6.3.3 | | +| LocationAccuracy | 6.4.6.3.4 | | +| FailedCause | 6.4.6.3.5 | Failed cause of the failed Monitoring Configuration in the EE subscription | + +Table 6.4.6.1-2 specifies data types re-used by the Nhss\_EE service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_EE service API. + +**Table 6.4.6.1-2: Nhss\_EE re-used Data Types** + +| Data type | Reference | Comments | +|---------------------------|---------------------|------------------------------------------------------------------------------| +| Uri | 3GPP TS 29.571 [7] | Uniform Resource Identifier | +| SupportedFeatures | 3GPP TS 29.571 [7] | See 3GPP TS 29.500 [4] clause 6.6 | +| DateTime | 3GPP TS 29.571 [7] | | +| PatchResult | 3GPP TS 29.571 [7] | | +| DurationSec | 3GPP TS 29.571 [7] | | +| DiameterIdentity | 3GPP TS 29.571 [7] | | +| Dnn | 3GPP TS 29.571 [7] | Data Network Name with Network Identifier only. | +| ProblemDetails | 3GPP TS 29.571 [7] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of redirect response messages. | +| MtcProviderInformation | 3GPP TS 29.571 [7] | MTC Provider Information | +| DiameterIdentity | 3GPP TS 29.571 [7] | Diameter Identity (FQDN) | +| LossConnectivityReport | 3GPP TS 29.503 [13] | Report of "LOSS_OF_CONNECTIVITY" event | +| LocationReport | 3GPP TS 29.503 [13] | Report of "LOCATION_REPORTING" event | +| PdnConnectivityStatReport | 3GPP TS 29.503 [13] | Report of "PDN_CONNECTIVITY_STATUS" event | +| ReferenceId | 3GPP TS 29.503 [13] | Reference ID defined in Nudm_EE API. It shall contain a 64-bit long integer. | + +### 6.4.6.2 Structured data types + +#### 6.4.6.2.1 Introduction + +This clause defines the data structures to be used in resource representations. + +## 6.4.6.2.2 Type: EeSubscription + +Table 6.4.6.2.2-1: Definition of type EeSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| callbackReference | Uri | M | 1 | URI provided by the NF service consumer to receive notifications | +| monitoringConfigurations | map(MonitoringConfiguration) | O | 1..N | A map (list of key-value pairs where referencedId converted from integer to string serves as key) of MonitoringConfigurations | +| scefId | DiameterIdentity | O | 0..1 | Diameter Identity (FQDN) of the SCEF | +| scefDiamRealm | DiameterIdentity | O | 0..1 | When present, It contains the Diameter realm of the SCEF to which the monitored reports may be sent in EPC. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.4.8 | +| reportingOptions | ReportingOptions | O | 0..1 | This IE may be included if the NF service consumer wants to describe how the reports of the event are to be generated.
If this attribute is not present in the request, it means that the NF service consumer does not specify any maximum number of reports or any expiry time for the subscription; still, the NF service producer (HSS) may set an expiry time in the response to the subscription creation (see clause 6.4.6.2.7). | +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | Indicates MTC provider information for Monitoring Configuration authorization. | +| externalIdentifier | string | O | 0..1 | Represents a single external Identifier or a group of external Identifiers:
  • - If representing a single external identifier:
    pattern: "extid-[^@]+@[^\@]+\\$"
  • - If representing a group of external identifiers:
    pattern: "extgroupid-[^@]+@[^\@]+\\$"
| + +## 6.4.6.2.3 Type: CreatedEeSubscription + +Table 6.4.6.2.3-1: Definition of type CreatedEeSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eeSubscription | EeSubscription | M | 1 | This IE shall contain the representation of the created event subscription. | | +| eventReports | array(MonitoringReport) | O | 1..N | This IE may be included when the NF consumer has indicated supporting of ERIR feature in the subscription creation request (see clause 6.4.8).

This IE when present, shall contain the status of events that are requested for immediate reporting as well, if those events are available at the time of subscription. | ERIR | +| failedMonitoringConfigs | map(FailedMonitoringConfiguration) | O | 1..N | A map (list of key-value pairs where ReferenceId converted from integer to string serves as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration; see clause 6.4.6.2.14.

This IE is used to indicate the failed subscriptions of event monitoring configuration and the failed cause for them. | | +| currentStatusNotAvailableList | array(EventType) | O | 1..N | This IE should be present if immediate reporting was requested by the NF consumer, but the current status of at least one of the subscribed events is not available at the time of subscription.

When present, this IE shall list the events for which the current status is not available for immediate reporting. | | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.4.8 | | + +## 6.4.6.2.4 Type: MonitoringConfiguration + +Table 6.4.6.2.4-1: Definition of type MonitoringConfiguration + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------|----------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eventType | EventType | M | 1 | Event type | +| immediateFlag | boolean | O | 0..1 | Indicates if an immediate event report in the subscription response indicating current value / status of the event is required, if available. If the flag is not present, then immediate reporting may be skipped. | +| locationReportingConfiguration | LocationReportingConfiguration | C | 0..1 | Shall be present if eventType is "LOCATION_REPORTING" | +| lossConnectivityConfiguration | LossConnectivityConfiguration | O | 0..1 | May be present if eventType is "LOSS_OF_CONNECTIVITY". | +| reachabilityForDataConfiguration | ReachabilityForDataConfiguration | O | 0..1 | May be present if eventType is "UE_REACHABILITY_FOR_DATA" | +| pduSessionStatusCfg | PduSessionStatusCfg | O | 0..1 | may be present if eventType is "PDN_CONNECTIVITY_STATUS" | +| idleStatusInd | boolean | O | 0..1 | Idle Status Indication request.

May be present if eventType is "UE_REACHABILITY_FOR_DATA" or "AVAILABILITY_AFTER_DDN_FAILURE"

When present, this IE shall be set as following:
- true: Idle status indication is requested
- false (default): Idle status indication is not requested | + +## 6.4.6.2.5 Type: MonitoringReport + +Table 6.4.6.2.5-1: Definition of type MonitoringReport + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| referenceId | ReferenceId | M | 1 | Shall contain the Reference ID which was provided as the key of the associated monitoring configuration in subscription request. The consumer can use this IE to uniquely associate the report with the corresponding event that was requested to be monitored. | +| eventType | EventType | M | 1 | String; see clause 6.4.6.3.3
only the following values are allowed:
"UE_REACHABILITY_FOR_SMS"
"UE_REACHABILITY_FOR_DATA"
"LOSS_OF_CONNECTIVITY"
"LOCATION_REPORTING"
"PDN_CONNECTIVITY_STATUS" | +| timeStamp | DateTime | M | 1 | Point in time at which the event occurred | +| report | Report | O | 0..1 | Shall be present if eventType is
"UE_REACHABILITY_FOR_SMS"
"UE_REACHABILITY_FOR_DATA"
"LOSS_OF_CONNECTIVITY"
"LOCATION_REPORTING"
"PDN_CONNECTIVITY_STATUS" | + +## 6.4.6.2.6 Type: Report + +Table 6.4.6.2.6-1: Definition of type Report + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reachabilityForSmsReport | ReachabilityForSms Report | O | 0..1 | Reports the UE reachability for SMS | +| reachabilityForDataReport | ReachabilityForData Report | O | 0..1 | Reports the UE reachability for Data | +| lossConnectivityReport | LossConnectivityReport | O | 0..1 | Reports the Loss of Connectivity | +| locationReport | LocationReport | O | 0..1 | Reports the UE Location | +| pdnConnectivityStatReport | PdnConnectivityStat Report | O | 0..1 | Reports the PDN Connectivity Status.
Absence of pdnConnectivityStatReport in MonitoringReports with EventType "PDN_CONNECTIVITY_STATUS" indicates that the requested APN is not active. | + +## 6.4.6.2.7 Type: ReportingOptions + +Table 6.4.6.2.7-1: Definition of type ReportingOptions + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| maxNumOfReports | MaxNumOfReports | O | 0..1 | Maximum number of reports. If not present, the NF service consumer does not specify any maximum number of reports to be received.
(NOTE) | +| expiry | DateTime | C | 0..1 | This IE shall be included in an event subscription response, if, based on operator policy, the HSS needs to include an expiry time, and may be included in an event subscription request. When present, this IE shall represent the time at which monitoring shall cease and the subscription becomes invalid. If the maxNumOfReports included in an event subscription response is 1 and if an event report is included in the subscription response then the value of the expiry included in the response shall be an immediate timestamp.
(NOTE) | +| reportPeriod | DurationSec | C | 0..1 | Indicates the interval time between which the event notification is reported, may be present if event type is "LOCATION_REPORTING" | + +NOTE: If parameter "maxNumOfReports" and "expiry" are included at the same time, the subscription will expire as soon as one of the conditions is met. + +## 6.4.6.2.8 Type: LocationReportingConfiguration + +Table 6.4.6.2.8-1: Definition of type LocationReportingConfiguration + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------| +| currentLocation | boolean | M | 1 | true: Indicates that current location is requested.
false: Indicates that last known location is requested. | +| accuracy | LocationAccuracy | C | 0..1 | Indicates whether Cell-level or TA-level accuracy is requested. Shall be present when current location is requested. | + +## 6.4.6.2.9 Type: ReachabilityForSmsReport + +Table 6.4.6.2.9-1: Definition of type ReachabilityForSmsReport + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reachabilitySmsStatus | boolean | M | 1 | true: UE is reachable for SMS
false: UE is not reachable for SMS | +| maxAvailabilityTime | DateTime | O | 0..1 | Indicates the time (in UTC) until which the UE is expected to be reachable.

This information may be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Message to UEs using a power saving mechanism (eDRX, PSM etc.). | + +## 6.4.6.2.10 Type: LossConnectivityConfiguration + +Table 6.4.6.2.10-1: Definition of type LossConnectivityConfiguration + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------|---|-------------|------------------------------------------------------------------| +| maxDetectionTime | DurationSec | O | 0..1 | When present, it indicates the configured Maximum Detection Time | + +## 6.4.6.2.11 Type: ReachabilityForDataConfiguration + +Table 6.4.6.2.11-1: Definition of type ReachabilityForDataConfiguration + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-------------|---|-------------|----------------------------------------------------------------------------------------| +| maximumLatency | DurationSec | O | 0..1 | When present, it indicates the configured Maximum Latency. (NOTE) | +| maximumResponseTime | DurationSec | O | 0..1 | When present, it indicates the configured Maximum Response Time. (NOTE) | +| suggestedPacketNumDI | integer | O | 0..1 | When present, it indicates the configured Suggested number of downlink packets. (NOTE) | + +NOTE: At least one of maximumLatency, maximumResponseTime or suggestedPacketNumDI shall be present + +## 6.4.6.2.12 Type: PduSessionStatusCfg + +Table 6.4.6.2.12-1: Definition of type PduSessionStatusCfg + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------| +| apn | Dnn | O | 0..1 | When present, it indicates the APN for which the event is monitored. Absence indicates that monitoring of the event applies to all APNs. | + +## 6.4.6.2.13 Type: ReachabilityForDataReport + +Table 6.4.6.2.13-1: Definition of type ReachabilityForDataReport + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reachabilityDataStatus | boolean | M | 1 | true: UE is reachable for Data
false: UE is not reachable for Data | +| maxAvailabilityTime | DateTime | O | 0..1 | Indicates the time (in UTC) until which the UE is expected to be reachable.

This information may be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Message to UEs using a power saving mechanism (eDRX, PSM etc.). | + +## 6.4.6.2.14 Type: FailedMonitoringConfiguration + +Table 6.4.6.2.14-1: Definition of type FailedMonitoringConfiguration + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|------------------------------------------------------------------------| +| eventType | EventType | M | 1 | Contains the Event type, see clause 6.4.6.3.3 | +| failedCause | FailedCause | M | 1 | Contains the failed cause of the subscription of the event monitoring. | + +## 6.4.6.2.15 Type: EeSubscriptionErrorAddInfo + +Table 6.4.6.2.15-1: Definition of type EeSubscriptionErrorAddInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| failedMonitoringConfigs | map(FailedMonitoringConfiguration) | O | 1..N | A map (list of key-value pairs where ReferenceId converted from integer to string serves as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration; see clause 6.4.6.2.14.

This IE is used to indicate the failed subscriptions of event monitoring configuration and the failed cause for them. | + +## 6.4.6.2.16 Type: EeSubscriptionError + +Table 6.4.6.2.16-1: Definition of type EeSubscriptionError as a list of to be combined data types + +| Data type | Cardinality | Description | Applicability | +|----------------------------|-------------|----------------------------------------------------------|---------------| +| ProblemDetails | 1 | Detail information of the problem | | +| EeSubscriptionErrorAddInfo | 1 | Additional information to be returned in error response. | | + +## 6.4.6.3 Simple data types and enumerations + +## 6.4.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.4.6.3.2 Simple data types + +The simple data types defined in table 6.4.6.3.2-1 shall be supported. + +**Table 6.4.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------| +| Imsi | string | IMSI
pattern: '^(imsi-[0-9]{5,15})\$' | +| UeIdOrGroupId | string | Contains the UE identifier or the Group Identifier of the UE.
pattern: '^(imsi-[0-9]{5,15} extgroupid-[^@]+@[^@]+ .+)\$' | +| MaxNumOfReports | integer | Maximum number of reports.
Minimum: 1 | + +### 6.4.6.3.3 Enumeration: EventType + +**Table 6.4.6.3.3-1: Enumeration EventType** + +| Enumeration value | Description | +|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "LOSS_OF_CONNECTIVITY" | Loss of connectivity event | +| "UE_REACHABILITY_FOR_DATA" |

UE reachability for Data, implements the "UE Reachability for Data" event as specified in 3GPP TS 23.682 [18].

When this event is subscribed by an NF service consumer, the HSS shall send an Insert Subscriber Data Request message to the MME/SGSN for the UE with the Monitoring-Type AVP set to the value UE_REACHABILITY and the Reachability-Information AVP set to the value REACHABLE_FOR_DATA, see clause 5.2.2.1.3 of 3GPP TS 29.272 [17].

| +| "UE_REACHABILITY_FOR_SMS" |

UE reachability for SMS, implements the "UE Reachability for SMS Delivery" event as specified in 3GPP TS 23.682 [18].

This event only supports One-Time reporting.

| +| "LOCATION_REPORTING" | Location Reporting event | +| "COMMUNICATION_FAILURE" | Communication Failure event | +| "AVAILABILITY_AFTER_DDN_FAILURE" | Availability after DDN failure event | +| "PDN_CONNECTIVITY_STATUS" | PDN Connectivity Status event | + +#### 6.4.6.3.4 Enumeration: LocationAccuracy + +**Table 6.4.6.3.4-1: Enumeration LocationAccuracy** + +| Enumeration value | Description | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "CELL_LEVEL" | Change of cell shall be reported, equivalent to the value "CGI-ECGI (0)" of Accuracy IE of HSS Diameter interface as specified in clause 8.4.17 of 3GPP TS 29.336 [21]. | +| "RAN_NODE_LEVEL" | change of serving RAN node shall be reported, equivalent to the value "eNB (1)" of Accuracy IE of HSS Diameter interface as specified in clause 8.4.17 of 3GPP TS 29.336 [21]. | +| "TA_LEVEL" | Change of TA shall be reported, equivalent to the value " LA-TA-RA (2)" of Accuracy IE of HSS Diameter interface as specified in clause 8.4.17 of 3GPP TS 29.336 [21]. | + +#### 6.4.6.3.5 Enumeration: FailedCause + +**Table 6.4.6.3.5-1: Enumeration FailedCause** + +| Enumeration value | Description | +|-----------------------------------------|-------------------------------------------------------------------------------------------------------| +| "MTC_PROVIDER_NOT_ALLOWED" | MTC Provider is now allowed to perform monitoring for the requested event type. | +| "MONITORING_NOT_ALLOWED" | The subscriber does not have the necessary subscription for monitoring with the requested Event Type. | +| "UNSUPPORTED_MONITORING_EVENT_TYPE" | The required event type is unsupported. | +| "UNSUPPORTED_MONITORING_REPORT_OPTIONS" | The monitoring configuration for the required event type contains unsupported report options. | +| "UNSPECIFIED" | The failed cause is unspecified. | + +### 6.4.7 Error Handling + +#### 6.4.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.4.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.4.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_EventExposure service. The following application errors listed in Table 6.4.7.3-1 are specific for the Nhss\_EventExposure service. + +**Table 6.4.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------| +| MONITORING_NOT_ALLOWED | 403 Forbidden | The subscriber does not have the necessary subscription for monitoring with the requested Event Type. | +| MTC_PROVIDER_NOT_ALLOWED | 403 Forbidden | MTC Provider not authorized to perform monitoring configuration. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used when no corresponding context exists. | +| UNSUPPORTED_MONITORING_EVENT_TYPE | 501 Not Implemented | The monitoring configuration contains unsupported event type. | +| UNSUPPORTED_MONITORING_REPORT_OPTIONS | 501 Not Implemented | The monitoring configuration contains unsupported report options. | + +### 6.4.8 Feature Negotiation + +The optional features in table 6.4.8-1 are defined for the Nhss\_EE API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.4.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ERIR | Event Reports in Response
An NF consumer supporting this feature shall be able to handle the event reports within the Event Subscription Create Response, as specified in clause 5.5.2.2.2. | +| 2 | GBEE | Support of Group-based Event Exposure.
This feature bit indicates whether the Nhss_EventExposure Service support Group-based Event Exposure or not. | + +## 6.4.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nhss\_EE API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_EE API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], 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 Nhss\_EE service. + +The Nhss\_EE API defines a single scope "nhss-ee" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +## 6.4.10 HTTP redirection + +An HTTP request may be redirected to a different HSS service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different HSS producer instance will return the NF Instance ID of the new HSS producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an HSS redirects a service request to a different HSS using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new HSS towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +--- + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nhss Service API(s). It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [14] clause 5B). + +--- + +## A.2 Nhss\_UEAuthentication API + +``` +openapi: 3.0.0 +info: + version: '1.2.0-alpha.2' + title: 'NhssUEAU' + description: | + HSS UE Authentication Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.4.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' + +servers: + - url: '{apiRoot}/nhss-ueau/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nhss-ueau + - {} + +paths: + /generate-av: + post: + summary: Generate authentication vector for the UE + operationId: GenerateAV + tags: + - Generate Auth Vector + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AvGenerationRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AvGenerationResponse' +``` + +``` +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ueau: Access to the nhss-ueau API + +schemas: + +# STRUCTURED TYPES: + +AvGenerationRequest: + description: > + It represents the request body in the Authentication Vector (AV) request sent by UDM to HSS, + containing the IMSI of the UE, authentication type, serving network, etc. + type: object + required: + - imsi + - authType + - servingNetworkName + properties: + imsi: + type: string + pattern: '^[0-9]{5,15}$' + authType: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AuthType' + servingNetworkName: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName' + resynchronizationInfo: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ResynchronizationInfo' + +AvGenerationResponse: + description: > + It represents the response body in the AV response sent by HSS to UDM, containing the 5G-AKA + or EAP-AKA-prime authentication vector + type: object + oneOf: + - required: + - avEapAkaPrime + - required: + - av5GHeAka + properties: +``` + +``` +avEapAkaPrime: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AvEapAkaPrime' +av5GHeAka: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Av5GHeAka' +``` + +``` +# SIMPLE TYPES: +``` + +``` +# ENUMS: +``` + +--- + +## A.3 Nhss\_SubscriberDataManagement API + +``` +openapi: 3.0.0 + +info: + version: '1.2.0-alpha.2' + title: 'Nhss_SDM' + description: | + HSS Subscriber Data Management. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.4.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' + +servers: + - url: '{apiRoot}/nhss-sdm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nhss-sdm + - {} + +paths: + /{ueId}/ue-context-in-pgw-data: + get: + summary: Retrieve the UE Context In PGW + operationId: GetUeCtxInPgwData + tags: + - UE Context In PGW Data Retrieval + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15})$' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextInPgwData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/subscriptions: + post: + summary: subscribe to notifications + operationId: Subscribe + tags: + - Subscription Creation + parameters: + - name: ueId + in: path + description: IMSI of the user + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15})$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-sdm/{apiVersion}/{ueId}/subscriptions/{subscriptionId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: +``` + +``` + +datachangeNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications + operationId: Unsubscribe + tags: + - Subscription Deletion + parameters: + - name: ueId + in: path + description: IMSI of the user + required: true + schema: + type: string + pattern: '^imsi-[0-9]{5,15}$' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + +``` + +``` +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +patch: + summary: modify the subscription + operationId: Modify + tags: + - Subscription Modification + parameters: + - name: ueId + in: path + description: IMSI of the user + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15})$' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '204': + description: Successful modification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-sdm: Access to the nhss-sdm API +``` + +``` + +schemas: + +# STRUCTURED TYPES: + +UeContextInPgwData: + description: > + Contains data about APNs and PGW-C+SMF FQDNs used in interworking with UDM, and the + PGW-C+SMF FQDN to be used for emergency session + type: object + properties: + pgwInfo: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/PgwInfo' + minItems: 1 + emergencyFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + emergencyPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + emergencyIpAddress: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpAddress' + emergencyRegistrationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +SubscriptionData: + description: > + Contains data about a subscription request, to be created by a consumer to an URI of the + HSS_SDM API to be monitored; it also represents the response containing data about the + created subscription + type: object + required: + - nfInstanceId + - callbackReference + - monitoredResourceUris + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + expires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + immediateReport: + type: boolean + default: false + report: + $ref: '#/components/schemas/SubscriptionDataSets' + +SubscriptionDataSets: + description: > + Contains data to be reported as an immediate report in the response to a subscription + creation request + type: object + properties: + ueContextInPgwData: + $ref: '#/components/schemas/UeContextInPgwData' + +# SIMPLE TYPES: + +# ENUMS: + +``` + +## A.4 Nhss\_UEContextManagement API + +openapi: 3.0.0 + +``` + +info: + version: '1.2.0-alpha.2' + title: 'Nhss_UECM' + description: | + +``` + +HSS UE Context Management. +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +externalDocs: +description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.4.0 +url: 'https://www.3gpp.org/ftp/Specs/archive/29\_series/29.563/' + +servers: +- url: '{apiRoot}/nhss-uecm/v1' +variables: +apiRoot: +default: https://example.com +description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: +- oAuth2ClientCredentials: +- nhss-uecm +- {} + +paths: +/deregister-sn: +post: +summary: MME/SGSN Deregistration +operationId: DeregisterSN +tags: +- MME/SGSN Deregistration +requestBody: +content: +application/json: +schema: +\$ref: '#/components/schemas/DeregistrationRequest' +required: true +responses: +'204': +description: No content +'307': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/307' +'308': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/308' +'400': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/400' +'401': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/401' +'403': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/403' +'404': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/404' +'411': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/411' +'413': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/413' +'415': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/415' +'429': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/429' +'500': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/500' +'501': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/501' +'502': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/502' +'503': +\$ref: 'TS29571\_CommonData.yaml#/components/responses/503' +default: +description: Unexpected error + +/imei-update: +post: +summary: IMEI Update +operationId: IMEIUpdate +tags: +- IMEI Update +requestBody: +content: +application/json: +schema: +\$ref: '#/components/schemas/ImeiUpdateInfo' + +``` + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImeiUpdateResponse' + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/roaming-status-update: + post: + summary: Roaming Status Update + operationId: RoamingStatusUpdate + tags: + - Roaming Status Update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingStatusUpdateInfo' + required: true + responses: + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +``` + +``` +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-uecm: Access to the nhss-uecm API + +schemas: + +# STRUCTURED TYPES: + +DeregistrationRequest: + description: > + It represents the request body of the deregistration request sent by UDM to HSS and contains + the IMSI of the UE, the deregistration reason, etc. + type: object + required: + - imsi + - deregReason + properties: + imsi: + type: string + pattern: '^[0-9]{5,15}$' + deregReason: + $ref: '#/components/schemas/DeregistrationReason' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + +ImeiUpdateInfo: + description: > + It represents the request body of the IMEI update request sent by UDM to HSS, + and contains the IMSI of the UE and the new IMEI(SV) + type: object + required: + - imsi + oneOf: + - required: [ imei ] + - required: [ imeisv ] + properties: + imsi: + type: string + pattern: '^[0-9]{5,15}$' + imei: + type: string + pattern: '^[0-9]{14,15}$' + imeisv: + type: string + pattern: '^[0-9]{16}$' + +ImeiUpdateResponse: + description: > + It represents the response body of the IMEI update request sent by UDM to HSS, + and contains the previous IMEI(SV) stored by HSS + type: object + anyOf: + - required: [ previousImei ] + - required: [ previousImeisv ] + properties: + previousImei: + type: string + pattern: '^[0-9]{14,15}$' + previousImeisv: + type: string + pattern: '^[0-9]{16}$' + +RoamingStatusUpdateInfo: +``` + +``` + +description: > + It represents the request body of the Roaming Status Update request sent by UDM to HSS, + and contains the IMSI of the UE and the new PLMN-ID +type: object +required: + - imsi + - plmnId +properties: + imsi: + type: string + pattern: '^[0-9]{5,15}$' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + +``` + +# SIMPLE TYPES: + +# ENUMS: + +``` + +DeregistrationReason: + description: The reason that triggers that the serving node needs to be deregistered by HSS + anyOf: + - type: string + enum: + - UE_INITIAL_AND_SINGLE_REGISTRATION + - UE_INITIAL_AND_DUAL_REGISTRATION + - EPS_TO_5GS_MOBILITY + - type: string + +``` + +## A.5 Nhss\_EE API + +openapi: 3.0.0 + +``` + +info: + version: '1.2.0-alpha.3' + title: 'Nhss_EE' + description: | + HSS Event Exposure. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` + +externalDocs: + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.4.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' + +``` + +``` + +servers: + - url: '{apiRoot}/nhss-ee/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +``` + +``` + +security: + - {} + - oAuth2ClientCredentials: + - nhss-ee + +``` + +``` + +paths: + /{ueId}/ee-subscriptions: + post: + summary: Subscribe + operationId: CreateEeSubscription + tags: + - EE Subscription (Collection) + parameters: + - name: ueId + in: path + description: IMSI of the subscriber or the identity of a group of UEs + required: true + schema: + $ref: '#/components/schemas/UeIdOrGroupId' + requestBody: + content: + application/json: + schema: + +``` + +``` + $ref: '#/components/schemas/EeSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedEeSubscription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ee/v1/{ueId}/ee-subscriptions/{subscriptionId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/EeSubscriptionError' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + description: Not Implemented + content: + application/problem+json: + schema: + $ref: '#/components/schemas/EeSubscriptionError' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + eventOccurrenceNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MonitoringReport' + minItems: 1 + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/ee-subscriptions/{subscriptionId}: + delete: + summary: Unsubscribe + operationId: DeleteEeSubscription + tags: + - Delete EE Subscription + parameters: + - name: ueId + in: path + description: IMSI of the subscriber or the identity of a group of UEs + required: true + schema: + $ref: '#/components/schemas/UeIdOrGroupId' + - name: subscriptionId + in: path + description: Id of the EE Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + + patch: + summary: Patch + operationId: UpdateEeSubscription + tags: + - Update EE Subscription + parameters: + - name: ueId + in: path + description: IMSI of the subscriber or the identity of a group of UEs + required: true + schema: +``` + +``` + + $ref: '#/components/schemas/UEIdOrGroupId' + - name: subscriptionId + in: path + description: Id of the EE Subscription + required: true + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ee: Access to the nhss-ee API + +schemas: + +# STRUCTURED TYPES: + +EeSubscription: + description: > + It represents the request body of the subscription request sent to HSS, containing data + related to the subscription to be created, such as the SCEF, Monitoring Configurations and + reporting options + type: object + required: + - callbackReference + properties: + callbackReference: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +sceId: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' +sceDiamRealm: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' +monitoringConfigurations: + description: > + A map (list of key-value pairs where ReferenceId serves as key) of + MonitoringConfigurations + type: object + additionalProperties: + $ref: '#/components/schemas/MonitoringConfiguration' + minProperties: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + reportingOptions: + $ref: '#/components/schemas/ReportingOptions' + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + externalIdentifier: + type: string + +CreatedEeSubscription: + description: > + It represents the response body of the subscription request, containing data of the created + subscription in the HSS + type: object + required: + - eeSubscription + properties: + eeSubscription: + $ref: '#/components/schemas/EeSubscription' + eventReports: + type: array + items: + $ref: '#/components/schemas/MonitoringReport' + minItems: 1 + failedMonitoringConfigs: + description: > + A map (list of key-value pairs where referenceId converted from integer to string serves + as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration + type: object + additionalProperties: + $ref: '#/components/schemas/FailedMonitoringConfiguration' + minProperties: 1 + currentStatusNotAvailableList: + type: array + items: + $ref: '#/components/schemas/EventType' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +FailedMonitoringConfiguration: + description: > + Contains the event type and failed cause of the failed Monitoring Configuration + in the EE subscription + type: object + required: + - eventType + - failedCause + properties: + eventType: + $ref: '#/components/schemas/EventType' + failedCause: + $ref: '#/components/schemas/FailedCause' + +MonitoringConfiguration: + description: > + Contains data for each Monitoring Configuration (such as event type, etc.) and + the configuration data needed depending on each event type + type: object + required: + - eventType + properties: + eventType: + $ref: '#/components/schemas/EventType' + immediateFlag: +``` + +``` + type: boolean + locationReportingConfiguration: + $ref: '#/components/schemas/LocationReportingConfiguration' + lossConnectivityConfiguration: + $ref: '#/components/schemas/LossConnectivityConfiguration' + reachabilityForDataConfiguration: + $ref: '#/components/schemas/ReachabilityForDataConfiguration' + pduSessionStatusCfg: + $ref: '#/components/schemas/PduSessionStatusCfg' + idleStatusInd: + type: boolean + default: false + +MonitoringReport: + description: Contains data for each Monitoring Event Report sent by the HSS + type: object + required: + - referenceId + - eventType + - timeStamp + properties: + referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + eventType: + $ref: '#/components/schemas/EventType' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + report: + $ref: '#/components/schemas/Report' + +ReportingOptions: + description: > + Contains the different reporting options associated to a given subscription created in HSS + type: object + properties: + maxNumOfReports: + $ref: '#/components/schemas/MaxNumOfReports' + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reportPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +Report: + description: Contains data for a given Monitoring Event Report + type: object + properties: + reachabilityForSmsReport: + $ref: '#/components/schemas/ReachabilityForSmsReport' + reachabilityForDataReport: + $ref: '#/components/schemas/ReachabilityForDataReport' + lossConnectivityReport: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/LossConnectivityReport' + locationReport: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/LocationReport' + pdnConnectivityStatReport: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/PdnConnectivityStatReport' + +ReachabilityForSmsReport: + description: > + Contains data for a Monitoring Event Report, specific to the 'Reachability For SMS' + event type + type: object + required: + - reachabilitySmsStatus + properties: + reachabilitySmsStatus: + type: boolean + maxAvailabilityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +ReachabilityForDataReport: + description: > + Contains data for a Monitoring Event Report, specific to the 'Reachability For Data' + event type + type: object + required: + - reachabilityDataStatus + properties: +``` + +``` +reachabilityDataStatus: + type: boolean + maxAvailabilityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +LossConnectivityConfiguration: + description: > + Contains data needed for a Monitoring Configuration, specific to the 'Loss of Connectivity' + event type + type: object + properties: + maxDetectionTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +LocationReportingConfiguration: + description: > + Contains data needed for a Monitoring Configuration, specific to the 'Location Reporting' + event type + type: object + required: + - currentLocation + properties: + currentLocation: + type: boolean + accuracy: + $ref: '#/components/schemas/LocationAccuracy' + +ReachabilityForDataConfiguration: + description: > + Contains data needed for a Monitoring Configuration, specific to the 'Reachability for Data' + event type + type: object + anyOf: + - required: [ maximumLatency ] + - required: [ maximumResponseTime ] + - required: [ suggestedPacketNumDl ] + properties: + maximumLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + maximumResponseTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + suggestedPacketNumDl: + type: integer + minimum: 1 + +PduSessionStatusCfg: + description: > + Contains data needed for a Monitoring Configuration, specific to the 'PDN Connectivity + Status' event type + type: object + properties: + apn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + +EeSubscriptionErrorAddInfo: + description: Additional Information for EE Subscription Error. + type: object + properties: + failedMonitoringConfigs: + description: > + A map (list of key-value pairs where referenceId converted from integer to string serves + as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration + type: object + additionalProperties: + $ref: '#/components/schemas/FailedMonitoringConfiguration' + minProperties: 1 + +EeSubscriptionError: + description: EE Subscription Error. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/EeSubscriptionErrorAddInfo' + +# SIMPLE TYPES: + +Imsi: + description: IMSI of the UE + type: string +``` + +pattern: '^^(imsi-[0-9]{5,15})\$' + +UeIdOrGroupId: + +description: Contains the UE identifier or the Group Identifier of the UE + +type: string + +pattern: '^^(imsi-[0-9]{5,15}|extgroupid-[^@]+@[^\+]+\+|.+)\$' + +MaxNumOfReports: + +description: Maximum number of events to be reported for events in a given subscription + +type: integer + +minimum: 1 + +# ENUMS: + +EventType: + +description: Type of Monitoring Event + +anyOf: + +- type: string + +enum: + +- LOSS\_OF\_CONNECTIVITY +- UE\_REACHABILITY\_FOR\_DATA +- UE\_REACHABILITY\_FOR\_SMS +- LOCATION\_REPORTING +- COMMUNICATION\_FAILURE +- AVAILABILITY\_AFTER\_DDN\_FAILURE +- PDN\_CONNECTIVITY\_STATUS + +- type: string + +LocationAccuracy: + +description: Location accuracy used in the 'Location Reporting' event type + +anyOf: + +- type: string + +enum: + +- CELL\_LEVEL +- RAN\_NODE\_LEVEL +- TA\_LEVEL + +- type: string + +FailedCause: + +description: > + +Indicates the Failed cause of the failed Monitoring Configuration in the EE subscription + +anyOf: + +- type: string + +enum: + +- MTC\_PROVIDER\_NOT\_ALLOWED +- MONITORING\_NOT\_ALLOWED +- UNSUPPORTED\_MONITORING\_EVENT\_TYPE +- UNSUPPORTED\_MONITORING\_REPORT\_OPTIONS +- UNSPECIFIED + +- type: string + +--- + +## Annex B (informative): Withdrawn API versions + +### B.1 General + +This Annex lists withdrawn API versions of the APIs defined in the present specification. 3GPP TS 29.501 [5] clause 4.3.1.6 describes the withdrawal of API versions. + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-05 | CT4#91 | C4-192407 | | | | Initial Draft. | 0.1.0 | +| 2019-09 | CT4#93 | C4-193847 | | | | Incorporation of pCRs agreed at CT4#93 in C4-193553, C4-193624. | 0.2.0 | +| 2019-10 | CT4#94 | C4-194521 | | | | Incorporation of pCRs agreed at CT4#94 in C4-194346. | 0.3.0 | +| 2019-11 | CT4#95 | C4-195636 | | | | Incorporation of pCRs agreed at CT4#95 in C4-195579. | 0.4.0 | +| 2019-12 | CT#86 | CP-193067 | | | | TS presented for information | 1.0.0 | +| 2020-03 | CT4#96 | C4-201271 | | | | Incorporation of pCRs agreed at CT4#96 in C4-200880, C4-200917, C4-200964, C4-201100. | 1.1.0 | +| 2020-03 | CT#87 | CP-200065 | | | | TS presented for approval | 2.0.0 | +| 2020-03 | CT#87 | | | | | Approved at CT#87 | 16.0.0 | +| 2020-07 | CT#88 | CP-201033 | 0001 | - | B | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-07 | CT#88 | CP-201033 | 0002 | - | F | PGW-C+SMF FQDN for Emergency Session | 16.1.0 | +| 2020-07 | CT#88 | CP-201033 | 0003 | 1 | B | Initial Registration | 16.1.0 | +| 2020-07 | CT#88 | CP-201033 | 0004 | 1 | B | HSS Event Exposure | 16.1.0 | +| 2020-07 | CT#88 | CP-201033 | 0005 | 1 | F | Serving Node Deregistration | 16.1.0 | +| 2020-07 | CT#88 | CP-201073 | 0006 | - | F | 29.563 Rel-16 API version and External doc update | 16.1.0 | +| 2020-09 | CT#89 | CP-202111 | 0007 | - | F | UE Id Correction for EE Subscription | 16.2.0 | +| 2020-09 | CT#89 | CP-202111 | 0008 | 1 | F | Correction of HSS Event Exposure data types | 16.2.0 | +| 2020-09 | CT#89 | CP-202096 | 0009 | - | F | 29.563 Rel-16 API version and External doc update | 16.2.0 | +| 2020-12 | CT#90 | CP-205049 | 0010 | 1 | F | Config APN for PDN connectivity status | 16.3.0 | +| 2020-12 | CT#90 | CP-205049 | 0011 | 1 | F | Definition of SubscriptionData | 16.3.0 | +| 2020-12 | CT#90 | CP-205049 | 0012 | - | F | References and Cardinality errors clean up | 16.3.0 | +| 2020-12 | CT#90 | CP-205048 | 0013 | - | F | Storage of YAML files in GitLab | 16.3.0 | +| 2020-12 | CT#90 | CP-205049 | 0014 | - | F | Reference ID | 16.3.0 | +| 2020-12 | CT#90 | CP-205036 | 0015 | - | F | 29.563 Rel-16 API version and External doc update | 16.3.0 | +| 2021-03 | CT#91 | CP-210042 | 0018 | - | F | GUAMI in Deregistration Request | 16.4.0 | +| 2021-03 | CT#91 | CP-210054 | 0022 | - | F | 29.563 Rel-16 API version and External doc update | 16.4.0 | +| 2021-03 | CT#91 | CP-210042 | 0023 | - | F | Cancellation Type sent to MME/SGSN when UE registers in 5G | 16.4.0 | +| 2021-03 | CT#91 | CP-210042 | 0017 | - | F | Correction of reference | 17.0.0 | +| 2021-06 | CT#92 | CP-211064 | 0025 | - | A | Serving Node Deregistration | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0026 | - | F | OpenAPI Reference | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0027 | 1 | B | Data Type Descriptions | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0028 | - | F | Nhss Services | 17.1.0 | +| 2021-06 | CT#92 | CP-211047 | 0029 | 4 | F | RAN Node Level Location Accuracy | 17.1.0 | +| 2021-06 | CT#92 | CP-211065 | 0031 | 1 | A | Monitored Resource URI | 17.1.0 | +| 2021-06 | CT#92 | CP-211059 | 0033 | - | A | Redirect Responses | 17.1.0 | +| 2021-06 | CT#92 | CP-211064 | 0035 | 1 | A | VLR Cancellation | 17.1.0 | +| 2021-06 | CT#92 | CP-211054 | 0036 | 1 | B | MTC Provider in Nhss_EE | 17.1.0 | +| 2021-06 | CT#92 | CP-211050 | 0037 | - | F | 29.563 Rel-17 API version and External doc update | 17.1.0 | +| 2021-09 | CT#93 | CP-212060 | 0040 | - | A | 3xx description correction for SCP | 17.2.0 | +| 2021-09 | CT#93 | CP-212069 | 0043 | 1 | A | Immediate Report in Response | 17.2.0 | +| 2021-09 | CT#93 | CP-212069 | 0045 | - | A | Missing Event Reports | 17.2.0 | +| 2021-09 | CT#93 | CP-212056 | 0048 | 1 | F | Corrections on EventType | 17.2.0 | +| 2021-09 | CT#93 | CP-212057 | 0049 | 1 | B | Partial success on EE subscription | 17.2.0 | +| 2021-09 | CT#93 | CP-212059 | 0050 | - | F | 29.563 Rel-17 API version and External doc update | 17.2.0 | +| 2021-12 | CT#94 | CP-213085 | 0041 | 2 | F | EE subscription for a group | 17.3.0 | +| 2021-12 | CT#94 | CP-213121 | 0052 | - | F | 29.563 Rel-17 API version and External doc update | 17.3.0 | +| 2022-03 | CT#95 | CP-220023 | 0053 | - | F | 501 Not Implemented | 17.4.0 | +| 2022-03 | CT#95 | CP-220074 | 0055 | - | A | Essential Correction on Monitoring Events | 17.4.0 | +| 2022-03 | CT#95 | CP-220074 | 0057 | - | A | Idle Status Indication | 17.4.0 | +| 2022-03 | CT#95 | CP-220090 | 0058 | - | F | Editorial corrections | 17.4.0 | +| 2022-03 | CT#95 | CP-220066 | 0059 | - | F | 29.563 Rel-17 API version and External doc update | 17.4.0 | +| 2022-06 | CT#96 | CP-221029 | 0061 | 1 | F | Fqdn Data Type Definition | 17.5.0 | +| 2022-06 | CT#96 | CP-221028 | 0062 | 1 | F | UeContextInPgwData for emergency sessions | 17.5.0 | +| 2022-06 | CT#96 | CP-221029 | 0063 | 1 | F | Subscription modification | 17.5.0 | +| 2022-06 | CT#96 | CP-221051 | 0064 | - | F | 29.563 Rel-17 API version and External doc update | 17.5.0 | +| 2022-09 | CT#97 | CP-222057 | 0065 | - | F | IMEI Update | 17.6.0 | +| 2022-09 | CT#97 | CP-222057 | 0066 | - | F | Roaming Status Update | 17.6.0 | +| 2022-09 | CT#97 | CP-222058 | 0067 | - | F | 29.563 Rel-17 API version and External doc update | 17.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------|--------| +| 2022-12 | CT#98 | CP-223028 | 0068 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0069 | - | F | 29.563 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230029 | 0070 | - | F | PDN connectivity status | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0071 | 1 | F | Missing OAuth Security Clauses | 18.1.0 | +| 2023-06 | CT#100 | CP-231027 | 0072 | 4 | F | Location header and missing Redirection clause | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 0074 | - | F | Roaming Status Update | 18.2.0 | +| 2023-06 | CT#100 | CP-231027 | 0075 | 1 | D | Editorial corrections for Roaming Status Update | 18.2.0 | +| 2023-09 | CT#101 | CP-232033 | 0076 | 1 | F | NEF Reference ID | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0077 | 1 | F | Immediate Reporting Handling | 18.3.0 | +| 2023-09 | CT#101 | CP-232060 | 0078 | - | F | 29.563 Rel-18 API version and External doc update | 18.3.0 | +| 2023-12 | CT#102 | CP-233029 | 0079 | 1 | B | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.4.0 | +| 2023-12 | CT#102 | CP-233029 | 0080 | 1 | B | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233027 | 0081 | - | B | Per Monitoring Configuration Failure Cause in Error Response | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0082 | - | F | Editorial and Style Corrections | 18.4.0 | +| 2023-12 | CT#102 | CP-233071 | 0084 | - | A | Group ID on Nhss_EE API | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 0085 | - | F | 29.563 Rel-18 API version and External doc update | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29564/raw.md b/raw/rel-18/29_series/29564/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..4d2b6a8b01e75a0f008df82be9b4e226eee1d074 --- /dev/null +++ b/raw/rel-18/29_series/29564/raw.md @@ -0,0 +1,2781 @@ + + +# 3GPP TS 29.564 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; User Plane Function Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in small capital letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in small capital letters. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 4.1 Introduction ..... | 8 | +| 5 Services offered by the UPF ..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Nupf_EventExposure Service ..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.1.1 Service operations..... | 9 | +| 5.2.1.2 Subscription to UPF events..... | 10 | +| 5.2.1.3 UPF events supported by the Nupf_EventExposure service ..... | 10 | +| 5.2.1.3.1 General ..... | 10 | +| 5.2.1.3.2 QoS Monitoring..... | 11 | +| 5.2.1.3.3 User Data Usage Measures ..... | 12 | +| 5.2.1.3.4 User Data Usage Trends..... | 13 | +| 5.2.1.3.5 TSC Management Information..... | 13 | +| 5.2.2 Service Operations..... | 13 | +| 5.2.2.1 Introduction..... | 13 | +| 5.2.2.2 Subscribe..... | 14 | +| 5.2.2.2.1 General ..... | 14 | +| 5.2.2.2.2 Creation of a subscription ..... | 14 | +| 5.2.2.2.3 Modification of a subscription ..... | 16 | +| 5.2.2.2A Unsubscribe ..... | 17 | +| 5.2.2.2A.1 General ..... | 17 | +| 5.2.2.3 Notify ..... | 17 | +| 5.2.2.3.1 General ..... | 17 | +| 5.2.2.3.2 UPF sends notification on subscribed events..... | 18 | +| 5.3 Nupf_GetPrivateUEIPAddr Service..... | 19 | +| 5.3.1 Service Description ..... | 19 | +| 5.3.2 Service Operations..... | 19 | +| 5.3.2.1 Introduction..... | 19 | +| 5.3.2.2 Get..... | 19 | +| 5.3.2.2.1 General ..... | 19 | +| 6 API Definitions ..... | 20 | +| 6.1 Nupf_EventExposure Service API..... | 20 | +| 6.1.1 API URI..... | 20 | +| 6.1.2 Usage of HTTP..... | 20 | +| 6.1.2.1 General..... | 20 | +| 6.1.2.2 HTTP standard headers..... | 20 | +| 6.1.2.2.1 General ..... | 20 | +| 6.1.2.2.2 Content type ..... | 20 | +| 6.1.2.3 HTTP custom headers..... | 21 | +| 6.1.3 Resources..... | 21 | +| 6.1.3.1 Overview..... | 21 | +| 6.1.3.2 Resource: EventExposureSubscriptions ..... | 21 | +| 6.1.3.2.1 Description ..... | 21 | +| 6.1.3.2.2 Resource Definition..... | 21 | +| 6.1.3.2.3 Resource Standard Methods..... | 22 | + +| | | | +|------------|--------------------------------------------|----| +| 6.1.3.2.4 | Resource Custom Operations ..... | 23 | +| 6.1.3.3 | Resource: Individual subscription ..... | 23 | +| 6.1.3.3.1 | Description ..... | 23 | +| 6.1.3.3.2 | Resource Definition..... | 23 | +| 6.1.3.3.3 | Resource Standard Methods..... | 23 | +| 6.1.3.3.4 | Resource Custom Operations..... | 26 | +| 6.1.4 | void ..... | 26 | +| 6.1.5 | Notifications ..... | 26 | +| 6.1.5.1 | General..... | 26 | +| 6.1.5.2 | Event Notification..... | 26 | +| 6.1.5.2.1 | Description ..... | 26 | +| 6.1.5.2.2 | Target URI..... | 26 | +| 6.1.6 | Data Model ..... | 27 | +| 6.1.6.1 | General..... | 27 | +| 6.1.6.2 | Structured data types..... | 29 | +| 6.1.6.2.1 | Introduction ..... | 29 | +| 6.1.6.2.2 | Type: NotificationData..... | 30 | +| 6.1.6.2.3 | Type: NotificationItem..... | 31 | +| 6.1.6.2.4 | Type: QosMonitoringMeasurement..... | 32 | +| 6.1.6.2.5 | Type: UserDataUsageMeasurements ..... | 35 | +| 6.1.6.2.6 | Type: VolumeMeasurement..... | 36 | +| 6.1.6.2.7 | Type: ThroughputMeasurement..... | 36 | +| 6.1.6.2.8 | Type: ApplicationRelatedInformation ..... | 36 | +| 6.1.6.2.9 | Type: ThroughputStatisticMeasurement..... | 37 | +| 6.1.6.2.10 | Type: DomainInformation..... | 37 | +| 6.1.6.2.11 | Type: UpfEventSubscription..... | 38 | +| 6.1.6.2.12 | Type: UpfEventMode..... | 39 | +| 6.1.6.2.13 | Type: UpfEvent..... | 41 | +| 6.1.6.2.14 | Type: CreateEventSubscription..... | 42 | +| 6.1.6.2.15 | Type: CreatedEventSubscription..... | 42 | +| 6.1.6.2.16 | Type: ReportingSuggestionInformation..... | 42 | +| 6.1.6.2.17 | Type: TscManagementInfo ..... | 42 | +| 6.1.6.3 | Simple data types and enumerations..... | 42 | +| 6.1.6.3.1 | Introduction ..... | 42 | +| 6.1.6.3.2 | Simple data types ..... | 43 | +| 6.1.6.3.3 | Enumeration: EventType..... | 43 | +| 6.1.6.3.4 | Enumeration: UpfEventTrigger..... | 43 | +| 6.1.6.3.5 | Enumeration: MeasurementType ..... | 43 | +| 6.1.6.3.6 | Enumeration: GranularityOfMeasurement..... | 44 | +| 6.1.6.3.7 | Enumeration: DnProtocol..... | 44 | +| 6.1.6.3.8 | Enumeration: ReportingUrgency ..... | 44 | +| 6.1.7 | Error Handling ..... | 44 | +| 6.1.7.1 | General..... | 44 | +| 6.1.7.2 | Protocol Errors ..... | 44 | +| 6.1.7.3 | Application Errors..... | 44 | +| 6.1.8 | Feature negotiation ..... | 45 | +| 6.1.9 | Security ..... | 45 | +| 6.1.10 | HTTP redirection..... | 45 | +| 6.2 | Nupf_GetPrivateUEIPaddr Service API ..... | 46 | +| 6.2.1 | Introduction ..... | 46 | +| 6.2.2 | Usage of HTTP..... | 46 | +| 6.2.2.1 | General..... | 46 | +| 6.2.2.2 | HTTP standard headers..... | 46 | +| 6.2.2.2.1 | General ..... | 46 | +| 6.2.2.2.2 | Content type ..... | 46 | +| 6.2.2.3 | HTTP custom headers..... | 46 | +| 6.2.3 | Resources..... | 47 | +| 6.2.3.1 | Overview..... | 47 | +| 6.2.3.2 | Resource: UE IP Address Info..... | 47 | +| 6.2.3.2.1 | Description ..... | 47 | +| 6.2.3.2.2 | Resource Definition..... | 47 | +| 6.2.3.2.3 | Resource Standard Methods..... | 47 | + +| | | | +|-------------------------------|------------------------------------------------------|-----------| +| 6.2.3.2.4 | Resource Custom Operations ..... | 49 | +| 6.2.4 | Custom Operations without associated resources ..... | 49 | +| 6.2.5 | Notifications ..... | 49 | +| 6.2.5.1 | General ..... | 49 | +| 6.2.6 | Data Model ..... | 49 | +| 6.2.6.1 | General ..... | 49 | +| 6.2.6.2 | Structured data types ..... | 49 | +| 6.2.6.2.1 | Introduction ..... | 49 | +| 6.2.6.2.2 | Type: UeIpInfo ..... | 50 | +| 6.2.6.3 | Simple data types and enumerations ..... | 50 | +| 6.2.6.3.1 | Introduction ..... | 50 | +| 6.2.7 | Error Handling ..... | 50 | +| 6.2.7.1 | General ..... | 50 | +| 6.2.7.2 | Protocol Errors ..... | 50 | +| 6.2.7.3 | Application Errors ..... | 51 | +| 6.2.8 | Feature negotiation ..... | 51 | +| 6.2.9 | Security ..... | 51 | +| 6.2.10 | HTTP redirection ..... | 51 | +| Annex A (normative): | OpenAPI specification ..... | 52 | +| A.1 | General ..... | 52 | +| A.2 | Nupf_EventExposure API ..... | 52 | +| A.3 | Nupf_GetPrivateUEIPaddr API ..... | 61 | +| Annex B (informative): | Change history ..... | 64 | + +# Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +| | | +|-------------------|------------------------------------------------| +| should | indicates a recommendation to do something | +| should not | indicates a recommendation not to do something | +| may | indicates permission to do something | +| need not | indicates permission not to do something | + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +| | | +|---------------|----------------------------------------| +| can | indicates that something is possible | +| cannot | indicates that something is impossible | + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +| | | +|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| will | indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document | +| will not | indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document | +| might | indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document | +| might not | indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document | + +In addition: + +| | | +|---------------|-----------------------------------------------------------------------------------| +| is | (or any other verb in the indicative mood) indicates a statement of fact | +| is not | (or any other negative verb in the indicative mood) indicates a statement of fact | + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nupf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the UPF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.548[14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.548: "5G System Enhancements for Edge Computing; Stage 2". +- [15] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane Nodes; Stage 3". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [17] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [18] 3GPP TS 24.539: "5G System (5GS); Network to TSN translator (TT) protocol aspects; Stage 3". +- [19] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [20] 3GPP TS 29.122: "Technical Specification Group Core Network and Terminals; T8 reference point for Northbound APIs". + +# --- 3 Definitions, symbols 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 Symbols + +None in this release. + +## 3.3 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 | +| DCCF | Data Collection Coordination Function | +| L-UPF | Local User Plane Function | +| L-NEF | Local Network Exposure Function | +| MFAF | Messaging Framework Adaptor Function | +| NEF | Network Exposure Function | +| NWDAF | Network Data Analytics Function | +| UPF | User Plane Function | +| SMF | Session Management Function | +| TSCTSF | Time Sensitive Communication and Time Synchronization Function | +| TSN | Time Sensitive Networking | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the UPF offers services to the NEF, AF, SMF, NWDAF, DCCF, MFAF, TSCTSF and TSN AF via the Nupf service based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3], 3GPP TS 23.288 [17] and 3GPP TS 23.548 [14]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the UPF. + +![Figure 4.1-1: Reference model – UPF. The diagram shows a central green box labeled 'UPF' connected to a central point via a line labeled 'Nupf'. To the left of this central point, eight boxes are arranged in two columns, each with lines connecting to the central point. The left column contains NEF, AF, NWDAF, SMF, TSN AF, and TSCTSF. The right column contains DCCF and MFAF.](7affafe7362a2d2d072e9d4bf515f0bb_img.jpg) + +``` +graph LR; subgraph LeftColumn [ ]; NEF; AF; NWDAF; SMF; TSN_AF[TSN AF]; TSCTSF; end; subgraph RightColumn [ ]; DCCF; MFAF; end; LeftColumn --> Nupf((Nupf)); RightColumn --> Nupf; Nupf --> UPF[UPF]; +``` + +Figure 4.1-1: Reference model – UPF. The diagram shows a central green box labeled 'UPF' connected to a central point via a line labeled 'Nupf'. To the left of this central point, eight boxes are arranged in two columns, each with lines connecting to the central point. The left column contains NEF, AF, NWDAF, SMF, TSN AF, and TSCTSF. The right column contains DCCF and MFAF. + +**Figure 4.1-1: Reference model – UPF** + +The UPF supports the following functionalities which are provided via Service Based Interface: + +- Subscription to notifications of events exposed by the UPF; +- Notification about UPF events; and +- Translation of (NATed) Public UE IP address and port to (5GC) Private UE IP address. + +# 5 Services offered by the UPF + +## 5.1 Introduction + +The UPF offers the following services via the Nupf interface: + +- Nupf\_EventExposure Service +- Nupf\_GetPrivateUEIPaddr Service + +Table 5.1-1 summarizes the SBI services produced by the UPF: + +**Table 5.1-1: NF Services provided by UPF** + +| Service Name | Description | Example Consumers | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| Nupf_EventExposure | This service exposes UPF related information to other NFs | SMF, NWDAF, NEF, AF, TSCTSF, TSN AF, DCCF, MFAF | +| Nupf_GetPrivateUEIPaddr | This service provides the private UE IP address information of a PDU session from the (NATed) public IP address and port number | NEF | + +Table 5.2-1 summarizes the corresponding APIs defined for this specification. + +**Table 5.2-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-------------------------|--------|---------------------------------------|--------------------------------------|------------|-------| +| Nupf_EventExposure | 6.1 | UPF Event Exposure Service | TS29564_Nupf_EventExposure.yaml | nupf-ee | A.2 | +| Nupf_GetPrivateUEIPaddr | 6.2 | UPF Get Private UE IP address Service | TS29564_Nupf_GetPrivateUEIPaddr.yaml | nupf-gueip | A.3 | + +## 5.2 Nupf\_EventExposure Service + +### 5.2.1 Service Description + +#### 5.2.1.1 Service operations + +The Nupf\_EventExposure service enables NF service consumers to subscribe to UPF events and/or the UPF to send notifications about UPF events to NF service consumers. + +The Nupf\_EventExposure service supports the service operations defined in Table 5.2.1.1-1. + +**Table 5.2.1.1-1: Service operations supported by the Nupf\_EventExposure service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|-------------------------------|---------------------|-------------------------------------------| +| Subscribe | Subscribe to UPF events | Subscribe/Notify | NWDAF, SMF, DCCF | +| Unsubscribe | Unsubscribe from UPF events | Subscribe/Notify | NWDAF, SMF, DCCF | +| Notify | Notification about UPF events | Subscribe/Notify | NEF, AF, NWDAF, TSCTSF, TSNAP, DCCF, MFAF | + +#### 5.2.1.2 Subscription to UPF events + +The UPF exposes UPF events via the Nupf\_EventExposure service as defined in Table 5.2.1.2-1. + +**Table 5.2.1.2-1: Subscriptions to UPF events** + +| Subscription | Protocol used for the subscription to UPF | Description | +|----------------------|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Subscription via SMF | PFCP |

The NF service consumer creates the subscription for the event of interest via the SMF. The SMF instructs the UPF to report the events directly to the NF service consumer via the N4 interface as specified in 3GPP TS 29.244 [15].

Upon occurrence of the event of interest, the UPF sends a notification directly to the NF service consumer using the Nupf_EventExposure Notify service operation.

| +| | Nupf_EventExposure Subscribe |

The NF service consumer creates the subscription for the event of interest via the SMF. The SMF subscribes to the UPF using the Nupf_EventExposure Subscribe service operation.

Upon occurrence of the event of interest, the UPF sends a notification directly to the NF Service Consumer using the Nupf_EventExposure Notify service operation.

| +| Subscription to UPF | Nupf_EventExposure Subscribe |

The NF service consumer creates the subscription for the event of interest to the UPF using the Nupf_EventExposure Subscribe service operation.

Upon occurrence of the event of interest, the UPF sends a notification directly to the NF Service Consumer using the Nupf_EventExposure Notify service operation

| + +Clause 5.2.1.3 describes which of the above subscriptions shall be used for each event type supported by the Nupf\_EventExposure service. + +#### 5.2.1.3 UPF events supported by the Nupf\_EventExposure service + +##### 5.2.1.3.1 General + +The Nupf\_EventExposure service supports the events defined in this clause. + +See also clauses 4.15.4.5.1 and 5.2.26.2.1 of 3GPP TS 23.502 [3]. + +##### 5.2.1.3.2 QoS Monitoring + +**Table 5.2.1.3.2-1: QoS Monitoring event** + +| | | +|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description |

This event provides QoS flow performance information, i.e. QoS monitoring results for the QoS parameter(s) to be measured.

The following QoS parameters may be measured and/or reported:

  • - Packet delay monitoring: DL, UL and/or Round-Trip packet delay between UE and PSA UPF of specific QoS flow(s) of the PDU session.
  • - Data rate monitoring: UL and/or DL data rate measurement for a QoS flow.
  • - Congestion information of a QoS flow on the UL and/or DL directions received from the NG-RAN.
| +| Subscription type | Subscription via SMF using PFCP | +| Subscription inputs to UPF |
  • - QFI(s) of a specific PDU session
  • - requested QoS measurements
  • - UPF event consumer notification URI
  • - Notification correlation ID
  • - Reporting suggestion information (i.e. Report urgency, Reporting time information)

See clauses 5.24.4 and 5.24.5 of 3GPP TS 29.244 [15].

| +| Report type |

Continuous (event triggered) Report (for Packet Delay and Congestion Information).

Periodic Report (for Packet Delay)

| + +##### 5.2.1.3.3 User Data Usage Measures + +**Table 5.2.1.3.3-1: User Data Usage Measures event** + +| | | +|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description |

This event provides information of user data usage of a PDU session:

  • - Volume Measurement: measures of data volume exchanged (UL, DL and/or overall) and/or number of packets exchanged (UL, DL and/or overall) with or without application granularity.
  • - Throughput Measurement: measures of data throughput (UL and DL) measures aggregated for the PDU Session or per application.
  • - Application related information: URL(s) and/or Domain name(s) detected in the PDU session for the target traffic.
| +| Subscription type |

Subscription via SMF using Nupf_EventExposure Subscribe, if the target is:

  • - PDU session(s) of a specific UE or a group of UEs; or
  • - PDU session(s) of any UE and the subscription includes at least one of the following parameters: AoI, Traffic filtering, BSSID/SSID, Application ID.

Subscription to the UPF, if the target is PDU session(s) of any UE and the subscription does not need to include any of the following parameters: AoI, Traffic filtering, BSSID/SSID, Application ID.

| +| Subscription inputs to UPF |

Required:

  • - UE IP address or "Any UE"
  • - UPF event consumer notification URI

Optional:

  • - DNN(s)
  • - S-NSSAI(s)
  • - Application ID(s) or Traffic filtering
  • - Type of Measurement (i.e. Volume, Throughput, Application related information)
  • - Granularity of Measurement (i.e. required granularity for the information reported)
  • - Reporting suggestion information (i.e. Report urgency, Reporting time information)
  • - Notification correlation ID
| +| Report type |

One-Time Report

Periodic Report

| + +##### 5.2.1.3.4 User Data Usage Trends + +**Table 5.2.1.3.4-1: User Data Usage Trends event** + +| | | +|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | This event provides statistics related to user data usage of a PDU session:
  • - Throughput Statistics Measurement (average and/or peak throughput) over the measurement period for the PDU Session or per application
| +| Subscription type | Subscription via SMF using Nupf_EventExposure Subscribe, if the target is:
  • - PDU session(s) of a specific UE or a group of UEs; or
  • - PDU session(s) of any UE and the subscription includes at least one of the following parameters: AoI, Traffic filtering, BSSID/SSID, Application ID.
Subscription to the UPF, if the target is PDU session(s) of any UE and the subscription does not need to include any of the following parameters: AoI, Traffic filtering, BSSID/SSID, Application ID. | +| Subscription inputs to UPF | Required:
  • - UE IP address or "Any UE"
  • - UPF event consumer notification URI
Optional:
  • - DNN(s)
  • - S-NSSAI(s)
  • - Application ID(s) or Traffic filtering
  • - Granularity of Measurement (i.e. required granularity for the information reported)
  • - Reporting suggestion information (i.e. Report urgency, Reporting time information)
  • - Notification correlation ID
| +| Report type | One-Time Report
Periodic Report | + +##### 5.2.1.3.5 TSC Management Information + +**Table 5.2.1.3.5-1: TSC Management Information event** + +| | | +|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | This event provides TSC Management Information. | +| Subscription type | Subscription via SMF using PFCP | +| Subscription inputs to UPF |
  • - UPF event consumer notification URI
  • - Notification correlation ID
See clauses 5.26.3.2 of 3GPP TS 29.244 [15] and clauses 6.2.1 and 6.3.1 of 3GPP TS 24.539 [18]. | +| Report type | Continuous (event triggered) Report. | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operations defined for the Nupf\_EventExposure service are as follows: + +- **Subscribe:** It enables an NF service consumer to subscribe to UPF event exposure notifications.. +- **Unsubscribe:** It enables an NF service consumer to unsubscribe from UPF event exposure notifications. +- **Notify:** It allows the UPF to send event notifications directly to NF service consumers. + +**NOTE:** The Subscribe and Unsubscribe service operations only apply to UPF events that can be subscribed using the Nupf service based interface (see clauses 5.2.1.2 and 5.2.1.3). + +#### 5.2.2.2 Subscribe + +##### 5.2.2.2.1 General + +The Subscribe service operation is used by a NF Service Consumer to subscribe to UPF event exposure notifications, e.g. for the purpose of UPF data collection for a specified PDU session or any UE. + +NOTE: NF service consumers can only be SMF, NWDAF or DCCF in this release of the specification. + +##### 5.2.2.2.2 Creation of a subscription + +An NF Service Consumer shall invoke the Subscribe service operation towards the UPF to create a subscription to monitor at least one UPF event. The NF Service Consumer may subscribe to multiple events in a subscription. A subscription may be associated with one UE's PDU session or with any UE. + +The NF Service Consumer shall request to create a new subscription by using the HTTP method POST with the URI of the subscriptions collection, see clause 6.1.3.2. + +![Sequence diagram showing the creation of a subscription. The NF Service Consumer sends a POST request to the UPF. The UPF responds with either a 201 Created status (with an optional event report) or a 4xx/5xx status (ProblemDetails) or a 3xx status (RedirectResponse).](d17f75945bbb3feb84a153ecfedb9b81_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF Service Consumer + participant UPF + Note left of NFSC: + NFSC->>UPF: 1. POST .../ee-subscriptions (CreateEventSubscription) + Note right of UPF: + UPF-->>NFSC: 2a. 201 Created (CreatedEventSubscription (with optional event report)) + Note right of UPF: + UPF-->>NFSC: 2b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) + +``` + +Sequence diagram showing the creation of a subscription. The NF Service Consumer sends a POST request to the UPF. The UPF responds with either a 201 Created status (with an optional event report) or a 4xx/5xx status (ProblemDetails) or a 3xx status (RedirectResponse). + +**Figure 5.2.2.2.2-1 Subscription creation** + +1. The NF Service Consumer shall send a POST request to create a subscription resource in the UPF. The content of the POST request shall contain a representation of the individual subscription resource to be created. + +The NF Service Consumer shall include the following information in the HTTP message body: + +- NF ID, indicating the identity of the network function instance creating the subscription; +- Target of Event Reporting, indicating the target(s) to be monitored, i.e. + - a specific PDU Session of a UE identified with a UE IP address; or + - any UE (identified by the "anyUE" flag); +- List of UPF events requested to be subscribed; +- Event Reporting Mode, indicating how the events shall be reported (One-time Report or Periodic Report); and +- UPF event consumer notification URI, indicating the address where to send the event notifications generated by the subscription. + +The NF Service Consumer may include the following information in the HTTP message body: + +- a SUPI, PEI or GPSI identifying a specific UE; +- one or more S-NSSAI(s) and/or DNN(s) of PDU sessions to which the subscription applies; +- one or more Application ID(s) or traffic filters identifying the traffic to be monitored by the subscription (only applicable to a subscription targeting a specific PDU Session of a UE identified with a UE IP address); +- Type of measurement, for UPF events supporting multiple types of measurement (e.g. UserDataUsageMeasures event) + +- Granularity of Measurement, indicating that the granularity of the required measurements is per PDU Session, per data flow or per application; + - Reporting period, defining the period for periodic reporting; + - Maximum number of reports, defining the maximum number of reports after which the event subscription ceases to exist; + - Expiry time, suggested by the NF Service Consumer representing the time up to which the subscription is desired to be kept active and the time after which the subscribed event(s) shall stop generating report; + - Reporting suggestion information, i.e. Report urgency indicating whether the event report can be delayed (i.e. it is delay-tolerant) and if so, the Reporting time information defining the last valid reporting time for the UPF to report the detected event; + - Deactivate notification flag, indicating that the notification of the available events shall be muted until the event consumer NF (e.g. NWDAF or DCCF) provides the retrieval notification flag to retrieve the events stored; + - Immediate Report Flag per event, indicating an immediate report to be generated with the current event status; and/or + - Notification Correlation ID, indicating the correlation identity to be signaled in the event notifications generated by the subscription. + - Sampling ratio, defining the random subset of PDU sessions among target PDU sessions, and the UPF only report the event(s) related to the selected subset of PDU sessions; + - partitioningCriteria, defining the criteria for partitioning PDU sessions before applying sampling ratio; + - Muting Exception Instructions, which specify instructions to apply to the subscription and the stored events when an exception occurs at the UPF while the event is muted (e.g., the buffer of stored event reports is full, or the number of stored event reports exceeds a certain number), if the EEMM feature is supported (see clause 6.1.8). +- 2a. On success (i.e. if the request is accepted), the UPF shall include a HTTP Location header to provide the location of the newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. + +If the NF Service Consumer has included more than one events in the event subscription and some of the events cannot be subscribed, the UPF shall accept the request and provide the successfully subscribed event(s) in the CreatedEventSubscription. + +If the NF Service Consumer has included the Immediate Report Flag with the value true in the event subscription, and if the current status of the events subscribed are available, the UPF shall include the current status of the events subscribed in the response. Otherwise, the UPF shall generate reports for the events and notify the NF service consumer using the Nupf\_EventExposure\_Notify service operation. If the events with the Immediate Report Flag set to true are subscribed via an SMF, the notification shall be sent to the actual NF service consumer directly, i.e. the current status of the events subscribed shall not be included in the subscription creation response. + +If the NF Service Consumer has set the event reporting option to ONE\_TIME and if the UPF has included the current status of the events subscribed in the response, then the UPF shall not do any subsequent event notification for the corresponding events. + +The response, based on operator policy and taking into account the expiry time included in the request, may contain the expiry time, as determined by the UPF, after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the UPF. The UPF shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +If the sampling ratio ("sampRatio") attribute is included in the subscription without a partitioningCriteria, the UPF shall select a random subset of PDU sessions among target PDU sessions according to the sampling ratio and only report the event(s) related to the selected subset of PDU sessions. If the partitioningCriteria attribute is + +also included along with sampling ratio, the UPF shall apply the sampling ratio on the group of PDU sessions determined according to the partitioning criteria. + +If the "notifFlag" attribute is included and set to "DEACTIVATE" in the request by e.g. the NWDAF or DCCF, the UPF shall mute the event notification and store the available events. Additionally, if the UPF supports the EEMM feature (see clause 6.1.8) and if the NF service consumer includes event muting instructions in the request, the UPF should evaluate the received event muting instructions against local actions (if configured) and, if the subscription creation request is accepted, the UPF may indicate the following information to the NF service consumer in the response: + +- the maximum number of notifications that the UPF expects to be able to store for the subscription; +- an estimate of the duration for which notifications can be buffered. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.3.1-3. + +If the UPF supports the EEMM features (see clause 6.1.8), the NF service consumer sets the "notifFlag" attribute to "DEACTIVATE" and event muting instructions in the request, but the UPF cannot accept the received instructions, the UPF may reject the request with a 403 Forbidden response and the application error "MUTING\_EXC\_INSTR\_NOT\_ACCEPTED". + +##### 5.2.2.2.3 Modification of a subscription + +The service operation is invoked by a NF Service Consumer, towards the UPF, when it needs to modify an existing subscription previously created at the UPF. + +The NF Service Consumer shall modify the subscription by using the HTTP method PATCH with the URI of the individual subscription resource (see clause 6.1.3.3) to be modified. + +![Sequence diagram showing the modification of a subscription. The NF Service Consumer sends a PATCH request to the UPF. The UPF responds with either 2a. 204 No Content, 2b. 200 OK (PatchResult), or 2c. 4xx/5xx (ProblemDetails) or 3xx.](96b0240f56d14453b5da05ec30fd5c6e_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UPF + Note left of NF Service Consumer: 1. PATCH .../ee-subscriptions/{subscriptionId} (PatchData) + NF Service Consumer->>UPF: 1. PATCH .../ee-subscriptions/{subscriptionId} (PatchData) + Note right of UPF: 2a. 204 No Content + UPF-->>NF Service Consumer: 2a. 204 No Content + Note right of UPF: 2b. 200 OK (PatchResult) + UPF-->>NF Service Consumer: 2b. 200 OK (PatchResult) + Note right of UPF: 2c. 4xx/5xx (ProblemDetails) or 3xx + UPF-->>NF Service Consumer: 2c. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the modification of a subscription. The NF Service Consumer sends a PATCH request to the UPF. The UPF responds with either 2a. 204 No Content, 2b. 200 OK (PatchResult), or 2c. 4xx/5xx (ProblemDetails) or 3xx. + +**Figure 5.2.2.2.3-1: Modification of a subscription** + +1. The NF service consumer shall send a PATCH request to the resource representing a subscription. The modification may be for the events subscribed or for updating the event report options, or the NF Id. +- 2a. On success, the request is accepted, and all the modification instructions in the PATCH request have been implemented, the UPF shall respond with "204 No Content". +- 2b. On success, the request is accepted, but some of the modification instructions in the PATCH request have been discarded, the UPF shall respond with "200 OK" including PatchResult to indicate the failed modifications. +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.3.2-3. + +#### 5.2.2.2A Unsubscribe + +##### 5.2.2.2A.1 General + +The Unsubscribe service operation is invoked by a NF Service Consumer towards the UPF to delete an existing subscription previously created at the UPF. + +The NF Service Consumer shall unsubscribe from a subscription by using the HTTP method DELETE with the URI of the individual subscription resource (see clause 6.1.3.3) to be deleted. + +![Sequence diagram showing the Unsubscribe process between an NF Service Consumer and a UPF. The NF Service Consumer sends a DELETE request to the UPF. The UPF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) message.](36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UPF + Note left of NF Service Consumer: 1. DELETE .../subscriptions/{subscriptionId} + NF Service Consumer->>UPF: 1. DELETE .../subscriptions/{subscriptionId} + Note right of UPF: -2a. 204 No Content + UPF-->>NF Service Consumer: -2a. 204 No Content + Note right of UPF: 2b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) + UPF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) + +``` + +Sequence diagram showing the Unsubscribe process between an NF Service Consumer and a UPF. The NF Service Consumer sends a DELETE request to the UPF. The UPF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) message. + +**Figure 5.2.2.2A.1-1 Unsubscribing from UPF events** + +1. The NF Service Consumer shall send a DELETE request to delete an existing subscription resource in the UPF. +- 2a. On success (i.e. if the request is accepted), the UPF shall reply with the status code 204 in the response message to indicate that the resource identified by the subscription ID has been successfully deleted. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.3.1-3. + +#### 5.2.2.3 Notify + +##### 5.2.2.3.1 General + +The Notify service operation is invoked by the UPF, to send a notification, towards the notification URI, when certain event included in the subscription has taken place. + +For the events "USER\_DATA\_USAGE\_MEASURES" and "USER\_DATA\_USAGE\_TRENDS", the UPF shall use the HTTP method POST, using the notification URI received in the subscription creation as specified in clause 5.2.2.2.2, including e.g. the subscription ID, Event ID(s) for which event has happened, notification correlation ID provided by the NF service consumer at the time of event subscription, to send a notification. + +If the subscription is targeting PDU sessions of any UE, i.e. the "anyUe" is set to true, the UPF shall perform the requested measurements per PDU session and send notification(s) with multiple NotificationItem IEs within the NotificationData wherein each NotificationItem shall correspond to a report on one subscribed event per PDU session. See Figure 5.2.2.3.2-1. If the subscription request included a sampling ratio, the notification may include the sampling ratio achieved by the UPF. + +For the events "QOS\_MONITORING" and "TSC\_MNGT\_INFO", the UPF shall use the HTTP method POST, using the notification URI received from the SMF via N4 interface, see clause 5.33.5 of 3GPP TS 29.244 [15]. + +For the event "USER\_DATA\_USAGE\_MEASURES", the event notification may contain following information: + +- Volume Measurement: measures of data volume exchanged (UL, DL and/or overall) and/or number of packets exchanged (UL, DL and/or overall). +- Throughput Measurement: measures of data throughput (UL and DL). +- Application related Information: URLs and/or Domain names and Domain name protocols detected in the traffic identified by the information included in the subscription request, e.g. an application id. + +When the granularity of the measurement is per data flow, the notification includes the packet filter set and the Applications Identifier if available. + +For the event "USER\_DATA\_USAGE\_TRENDS", the event notification may contain following information: + +- Throughput Statistic Measurement (average and/or peak throughput) over the measurement. + +When the granularity of the measurement is per data flow, the notification includes the packet filter set and the Applications Identifier if available. + +For the event "QOS\_MONITORING", this service operation is used by the UPF to send the following kinds of event notification: + +- Periodic notification on the downlink packet delay, uplink packet delay, and/or the round trip packet delay between the UPF (PSA) and UE; +- Event triggered notification on the downlink packet delay, uplink packet delay, and/or the round trip packet delay between the UPF (PSA) and UE, i.e. when the packet delay exceeds a defined threshold; +- Notification on the downlink packet delay, uplink packet delay, and/or the round trip packet delay between the UPF (PSA) and UE when the PDU session is released. +- Event triggered notification of congestion information of the QoS flow on the UL and/or DL directions received from the NG-RAN, upon a change of the congestion information. + +For the event "TSC\_MNGT\_INFO", the event notification may contain the following information: + +- Port Management Information Container(s) for one or more NW-TT ports and/or +- a User Plane Node Management Information Container; + +The event notification shall also contain the following information: + +- the related NW-TT port number(s), if Port Management Information Container(s) is present; and +- the notification correlation ID received from the SMF, if any. + +##### 5.2.2.3.2 UPF sends notification on subscribed events + +![Sequence diagram showing the interaction between an NF Service Consumer and a UPF. The UPF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (redirection) status code.](dc23d430e878eb71b8cd589984113940_img.jpg) + +``` + +sequenceDiagram + participant UPF + participant NFSC as NF Service Consumer + Note right of UPF: 1. POST {eventNotificationUri} (NotificationData) + UPF->>NFSC: 1. POST {eventNotificationUri} (NotificationData) + Note left of NFSC: 2a. 204 No Content () + NFSC-->>UPF: 2a. 204 No Content () + Note left of NFSC: 2b. 4xx/5xx (ProblemDetails) or 3xx + NFSC-->>UPF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a UPF. The UPF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (redirection) status code. + +**Figure 5.2.2.3.2-1: UPF sends notification on subscribed events** + +1. The UPF shall send a POST request to the eventNotificationUri as provided by the SMF during the provisioning of Session Reporting Rule (see clause 7.5.2.9 of 3GPP TS 29.244 [15]) or received in the subscription creation as specified in clause 5.2.2.2.2. +- 2a. Upon success, the NF Service Consumer responds with "204 No Content". +- 2b. On failure or redirection: + - If the NF Service Consumer does not consider the "eventNotificationUri" as a valid notification URI, the NF Service Consumer shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NF service consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NF service consumer endpoint. + +## 5.3 Nupf\_GetPrivateUEIPAddr Service + +### 5.3.1 Service Description + +The Nupf\_GetPrivateUEIPAddr Service enables the UPF to provide the UE IP address information of a PDU session, e.g. to provide the (private) UE IP address when being queried with a NATed UE IP Address, to the NF service consumer, e.g. a NEF. + +Table 5.3.1-1 lists the service operations that are supported by the Nupf\_GetPrivateUEIPAddr service. + +**Table 5.3.1-1: Service operations supported by the Nupf\_GetPrivateUEIPAddr service** + +| Service Operations | Description | Operation Semantics | Example Consumers | +|--------------------|----------------------------------------------------------------------------------------------------------------------------------------|---------------------|-------------------| +| Get | Retrieve the UE IP address information of a PDU session, to get e.g., UE's private IP address and optionally the associated IP domain. | Request / Response | NEF | + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +See Table 5.3.1-1 for an overview of the service operations supported by the Nupf\_GetPrivateUEIPAddr service. + +#### 5.3.2.2 Get + +##### 5.3.2.2.1 General + +The Get service operation is used in the following procedure: + +- AF specific UE ID retrieval as specified in clause 4.15.10 of 3GPP TS 23.502 [3] + +This service operation is consumed by querying the "ue-ip-info" resource. The request is sent to the UPF hosting the IP address in the query. + +![Sequence diagram showing the interaction between an NF Service Consumer and a UPF for retrieving UE IP info. The consumer sends a GET request to the UPF, and the UPF responds with either a 200 OK (UeIpInfo) or an error status code (4xx/5xx or 3xx).](3191384ecc1531d40a00140dd21fd781_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UPF + Note left of NF Service Consumer: + NF Service Consumer->>UPF: 1. GET .../ue-ip-info? + Note right of UPF: + UPF-->>NF Service Consumer: 2a. 200 OK (UeIpInfo) + Note right of UPF: + UPF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a UPF for retrieving UE IP info. The consumer sends a GET request to the UPF, and the UPF responds with either a 200 OK (UeIpInfo) or an error status code (4xx/5xx or 3xx). + +**Figure 5.3.2.2.1-1: Retrieval of UE IP Info for a PDU session** + +1. The NF Service Consumer shall send an HTTP GET request to the resource URI of "ue-ip-info". The input filter criteria for the discovery request shall be included in query parameters, e.g. the UE (public) IP address and Port Number, and optionally DNN and S-NSSAI. +- 2a. On success, "200 OK" shall be returned. The response body shall include a UeIpInfo object which contains relevant attributes matching the query parameters included in the request message. +- 2b. On failure, one of the HTTP status code listed in Table 6.2.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.3.2.3.1-3, where applicable. + +On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE may be included in the content of POST response. + +# --- 6 API Definitions + +## 6.1 Nupf\_EventExposure Service API + +### 6.1.1 API URI + +The Nupf\_EventExposure shall use the Nupf\_EventExposure API. + +The API URI of the Nupf\_EventExposure API shall be: + +**{apiRoot}** + +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}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nupf-ee". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [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 Nupf\_EventExposure API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.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 9457 [13]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +In this release of this specification, no custom headers specific to the Nupf\_EventExposure service are defined. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Diagram showing the hierarchical structure of the nupf-ee API resource URI. The root is {apiRoot}/nupf-ee/, which branches to /ee-subscriptions, which in turn branches to /{subscriptionId}.](75e4b78ee25f885d73120e3066a5253e_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nupf-ee/"] --> Subscriptions["/ee-subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the hierarchical structure of the nupf-ee API resource URI. The root is {apiRoot}/nupf-ee/, which branches to /ee-subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 6.1.3.1-1: Resource URI structure of the nupf-ee API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------------|------------------------------------|---------------------------------|-------------------------------------------------------------| +| EventExposureSubscriptions (Collection) | /ee-subscriptions | POST | Subscribe service operation, creating a new subscription . | +| Individual subscription (Document) | /ee-subscriptions/{subscriptionId} | DELETE | Unsubscribe service operation | +| | | PATCH | Subscribe service operation, modification of a subscription | + +#### 6.1.3.2 Resource: EventExposureSubscriptions + +##### 6.1.3.2.1 Description + +This resource represents a collection of subscriptions created by NF service consumers of Nupf\_EventExposure service. + +This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nupf-ee//ee-subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.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 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|------------------------------------------------------------| +| CreateEventSubscription | M | 1 | Content of the Subscribe request to create a subscription. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedEventSubscription | M | 1 | 201
Created | Represents successful creation of an UPF Event Subscription | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | Indicates the creation of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- PDU_SESSION_NOT_SERVED_BY_UPF
- MUTING_EXC_INSTR_NOT_ACCEPTED | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.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}/nupf-ee//ee-subscriptions/{subscriptionId} | + +**Table 6.1.3.2.3.1-5: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-6: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.2.4 Resource Custom Operations + +None. + +#### 6.1.3.3 Resource: Individual subscription + +##### 6.1.3.3.1 Description + +This resource represents an individual of subscription created by NF service consumers of Nupf\_EventExposure service. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nupf-ee//ee-subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| apiVersion | string | See clause 6.2.1. | +| subscriptionId | string | String identifies an individual subscription to the UPF event exposure service | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-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 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.3.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the Event Subscription | + +**Table 6.1.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 3) | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1.
- MUTING_EXC_INSTR_NOT_ACCEPTED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UPF shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, the UPF shall respond with PatchResult. + +NOTE 3: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.2-4: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. It is implementation specific how the alternative URI is determined. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.2-5: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. It is implementation specific how the alternative URI is determined. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.3.4 Resource Custom Operations + +None. + +### 6.1.4 void + +### 6.1.5 Notifications + +#### 6.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 6.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------| +| Event Notification | {eventNotificationUri} (This URI is either provided by NF service consumer via Nupf interface, or it is provided via N4 interface during the provisioning of Session Reporting Rule) | POST | Notify about the events that UPF exposes and to which the NF service consumer may subscribe to. | + +#### 6.1.5.2 Event Notification + +##### 6.1.5.2.1 Description + +The Event Notification is used by the UPF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications. + +##### 6.1.5.2.2 Target URI + +The POST method shall be used for Event Notification and the URI shall be the Event Notification URI provided by the SMF during the provisioning of Session Reporting Rule, see clause 5.33.5 of 3GPP TS 29.244 [15], or by NF Service Consumer during creation of the subscription as specified in clause 5.2.2.2.2. + +Resource URI: {eventNotificationUri} + +Support of URI query parameters is specified in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Callback URI variables** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.1.5.2.2-2, and support of response data structures and response codes is specified in table 6.1.5.2.2-3. + +**Table 6.1.5.2.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-------------------------------------------| +| NotificationData | M | 1 | Representation of the event notification. | + +**Table 6.1.5.2.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful notification of the event. | +| ProblemDetails | O | 0..1 | 404 Not Found | If the NF Service Consumer considers the "eventNotificationUri" and/or "Notification Correlation ID" is not recognized, the NF Service Consumer shall return "404 Not Found" status code | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.2.2-4: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer instance to which the request should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF instance ID towards which the notification is redirected | + +**Table 6.1.5.2.2-5: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer instance to which the request should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF instance ID towards which the notification is redirected | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nupf\_EventExposure service. + +Table 6.1.6.1-1: Nupf\_EventExposure specific Data Types + +| Data type | Clause defined | Description | Applicability | +|--------------------------------|----------------|---------------------------------------------------------------------|---------------| +| NotificationData | 6.1.6.2.2 | The list of NotificationItems | | +| NotificationItem | 6.1.6.2.3 | Represents a report on one subscribed event | | +| QosMonitoringMeasurement | 6.1.6.2.4 | QoS Monitoring Measurement information | | +| UserDataUsageMeasurements | 6.1.6.2.5 | User Data Usage Measurements | | +| VolumeMeasurement | 6.1.6.2.6 | Volume Measurement | | +| ThroughputMeasurement | 6.1.6.2.7 | Throughput Measurement | | +| ApplicationRelatedInformation | 6.1.6.2.8 | Application Related Information | | +| ThroughputStatisticMeasurement | 6.1.6.2.9 | Throughput Statistic Measurement | | +| DomainInformation | 6.1.6.2.10 | Domain Name and Domain Name Protocol | | +| UpfEventSubscription | 6.1.6.2.11 | Represents an individual event subscription resource on UPF | | +| UpfEventMode | 6.1.6.2.12 | Describes how the reports shall be generated for a subscribed event | | +| UpfEvent | 6.1.6.2.13 | Describes an event to be subscribed | | +| CreateEventSubscription | 6.1.6.2.14 | Data within a create UPF event subscription request | | +| CreatedEventSubscription | 6.1.6.2.15 | Data within a create UPF event subscription response | | +| ReportingSuggestionInformation | 6.1.6.2.16 | Reporting Suggestion Information | | +| TscManagementInfo | 6.1.6.2.17 | TSC Management Information | | +| EventType | 6.1.6.3.3 | Event Type | | +| UpfEventTrigger | 6.1.6.3.4 | Describes how the UPF generates the report for the event | | +| MeasurementType | 6.1.6.3.5 | Type of Measurement | | +| GranularityOfMeasurement | 6.1.6.3.6 | Granularity Of Measurement | | +| DnProtocol | 6.1.6.3.7 | Domain Name Protocol | | +| ReportingUrgency | 6.1.6.3.8 | Reporting Urgency | | + +Table 6.1.6.1-2 specifies data types re-used by the Nupf\_EventExposure service from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nupf\_EventExposure service. + +Table 6.1.6.1-2: Nupf\_EventExposure re-used Data Types + +| Data type | Reference | Comments | Applicability | +|-----------------------------|---------------------|-------------------------------------------------|---------------| +| DateTime | 3GPP TS 29.571 [16] | Date time | | +| Dnn | 3GPP TS 29.571 [16] | DNN | | +| Gpsi | 3GPP TS 29.571 [16] | GPSI | | +| Snssai | 3GPP TS 29.571 [16] | S-NSSAI | | +| Uint32 | 3GPP TS 29.571 [16] | Uint32 | | +| MacAddr48 | 3GPP TS 29.571 [16] | MAC Address | | +| Ipv4Addr | 3GPP TS 29.571 [16] | IPv4 address | | +| Ipv6Prefix | 3GPP TS 29.571 [16] | IPv6 address prefix | | +| Uint64 | 3GPP TS 29.571 [16] | Unsigned 64-bit integer | | +| BitRate | 3GPP TS 29.571 [16] | Bit rate | | +| PacketRate | 3GPP TS 29.571 [16] | Packet rate | | +| TrafficVolume | 3GPP TS 29.571 [16] | Traffic Volume | | +| ApplicationId | 3GPP TS 29.571 [16] | The application identifier. | | +| DurationSec | 3GPP TS 29.571 [16] | | | +| NotificationFlag | 3GPP TS 29.571 [16] | Notification flag. | | +| PartitioningCriteria | 3GPP TS 29.571 [16] | Used to partition UEs before applying sampling. | | +| ProblemDetails | 3GPP TS 29.571 [16] | | | +| SamplingRatio | 3GPP TS 29.571 [16] | Sampling Ratio. | | +| Uri | 3GPP TS 29.571 [16] | | | +| IpAddr | 3GPP TS 29.571 [16] | | | +| SupportedFeatures | 3GPP TS 29.571 [16] | | | +| Supi | 3GPP TS 29.571 [16] | | | +| Pei | 3GPP TS 29.571 [16] | | | +| Uinteger | 3GPP TS 29.571 [16] | Unsigned Integer | | +| PortManagementContainer | 3GPP TS 29.512 [19] | PMIC | | +| BridgeManagementContainer | 3GPP TS 29.512 [19] | UMIC | | +| FlowInformation | 3GPP TS 29.512 [19] | IP or Ethernet Flow Information | | +| PatchItem | 3GPP TS 29.571 [16] | Patch item of JSON PATCH | | +| PatchResult | 3GPP TS 29.571 [16] | Patch result of JSON PATCH | | +| MutingExceptionInstructions | 3GPP TS 29.571 [16] | Muting exception instructions. | | +| MutingNotificationsSettings | 3GPP TS 29.571 [16] | Muting notifications settings. | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: NotificationData + +Table 6.1.6.2.2-1: Definition of type NotificationData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notificationItems | array(NotificationItem) | M | 1..N | The list of NotificationItem, each entry corresponds to a report on one subscribed event per PDU session. | | +| correlationId | string | C | 0..1 | The UPF shall include this attribute in the notification if the "Notification Correlation ID" IE was received via N4 interface (see clause 7.5.2.9 of 3GPP TS 29.244 [15]) | | +| achievedSampRatio | SamplingRatio | O | 0..1 | This IE may be included for an event subscription for any UE to indicate the ratio of the random subset of target PDU sessions achieved by the UPF. | | + +##### 6.1.6.2.3 Type: NotificationItem + +Table 6.1.6.2.3-1: Definition of type NotificationItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------|----------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventType | EventType | M | 1 | The event type of the event for which the notification is generated. | | +| uelpv4Addr | Ipv4Addr | C | 0..1 | IPv4 address of the UE (NOTE 1) | | +| uelpv6Prefix | Ipv6Prefix | C | 0..1 | IPv6 address prefix of the UE (NOTE 1) | | +| ueMacAddr | MacAddr48 | O | 0..1 | MAC address of the UE. (NOTE 2) | | +| dnn | Dnn | O | 0..1 | When present, this attribute indicates the DNN of the PDU session for which the notification is generated. | | +| snssai | Snssai | O | 0..1 | When present, this attribute indicates the S-NSSAI of the PDU session for which the notification is generated. | | +| gpsi | Gpsi | O | 0..1 | When present, this attribute indicates the GPSI of the UE for which the notification is generated. | | +| supi | Supi | O | 0..1 | Subscription Permanent Identifier | | +| timeStamp | DateTime | M | 1 | The value represents the UTC time when the information in this report was generated. | | +| startTime | DateTime | O | 0..1 | When present, this attribute shall provide the timestamp when the information measured for generating this report was started. | | +| qosMonitoringMeasurement | QosMonitoringMeasurement | C | 0..1 | This attribute shall be present if eventType is set to "QOS_MONITORING". | | +| userDataUsageMeasurements | array(UserDataUsageMeasurements) | C | 1..N | This IE shall be present if eventType is set to "USER_DATA_USAGE_MEASURES" or "USER_DATA_USAGE_TRENDS". | | +| tscMngtInfo | TscManagementInfo | C | 0..1 | This attribute shall be present if eventType is set to "TSC_MNGT_INFO". | | + +NOTE 1: At least one of uelpv4Addr and uelpv6Prefix shall be present if the subscription applies to an IP PDU session. + +NOTE 2: An NF service consumer subscribing to receive QoS Monitoring Measurement report for an ethernet PDU session shall accept the NotificationItem having neither uelpv4Addr nor uelpv6Prefix. + +6.1.6.2.4 Type: QosMonitoringMeasurement + +**Table 6.1.6.2.3-1: Definition of type QosMonitoringMeasurement** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| flowInfos | array(FlowInformation) | C | 1..N | When present, this IE shall contain an array of Ethernet or IP flow packet filter information corresponding to the QoS flow.
(NOTE) | | +| appIds | array(ApplicationId) | C | 1..N | When present, this IE shall contain an array of application identifiers corresponding to the QoS flow.
(NOTE) | | +| dlPacketDelay | Uint32 | O | 0..1 | When present, the value of this attribute is set to the measured downlink packet delay in millisecond (ms). | | +| ulPacketDelay | Uint32 | O | 0..1 | When present, the value of this attribute is set to the measured uplink packet delay in millisecond (ms). | | +| rtrPacketDelay | Uint32 | O | 0..1 | When present, the value of this attribute is set to the measured round trip packet delay in millisecond (ms). | | +| measureFailure | boolean | C | 0..1 | This IE shall be present to report packet delay measurement failure.

When present, it shall be set to true to indicate the report is sent due to packet delay measurement failure. This IE is named as the "PLMF" flag over PFCP interface. See also clauses 5.24.4.3 and 8.2.171 in 3GPP TS 29.244 [15]. | | +| dlAveThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the average data throughput in downlink direction as specified in clause 5.39.3.4 of 3GPP TS 29.244 [15]. | | +| ulAveThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the average data throughput in uplink direction as specified in clause 5.39.3.4 of 3GPP TS 29.244 [15]. | | +| dlCongestion | string | O | 0..1 | When present, this IE shall contain Downlink congestion information. | | +| ulCongestion | string | O | 0..1 | When present, this IE shall contain Uplink congestion information. | | + +| | | | | | +|-----------------------------------------------------------------------------|---------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| defaultQosFlowInd | boolean | C | 0..1 |

The IE shall be present when the SMF has indicated that the QoS Monitoring is for a QoS flow associated with the default QoS rule in the QoS Monitoring per QoS flow Control Information as specified in 3GPP TS 29.244 [15].

When present, this IE shall indicate whether the QoS measurements is for a QoS flow associated with the default QoS rule.

  • - true: Qos Monitoring Measurement is for a QoS flow associated with the default QoS rule;
  • - false(default): Qos Monitoring Measurement is not for a QoS flow associated with the default QoS rule.
| +| NOTE: Either the flowInfos IE or the appIds IE should be present, not both. | | | | | + +Editor's note: the encoding of the dlCongestion and ulCongestion IEs is FFS. + +##### 6.1.6.2.5 Type: UserDataUsageMeasurements + +Table 6.1.6.2.5-1: Definition of type UserDataUsageMeasurements + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| appId | ApplicationId | C | 0..1 | When present, this IE shall contain the application identifier. This IE shall be included if the requested granularity of measurement was set to "PER_APPLICATION".
This IE may be present if the requested granularity of measurement was set to "PER_FLOW".

(NOTE) | +| flowInfo | FlowInformation | C | 0..1 | When present, this IE shall contain the IP or Ethernet data flow information. This IE shall be included if the requested granularity of measurement was set to "PER_FLOW".

(NOTE) | +| volumeMeasurement | VolumeMeasurement | C | 0..1 | This attribute shall be present if eventType is set to "USER_DATA_USAGE_MEASURES" and measurementType is set to "VOLUME_MEASUREMENT". | +| throughputMeasurement | ThroughputMeasurement | C | 0..1 | This attribute shall be present if eventType is set to "USER_DATA_USAGE_MEASURES" and measurementType is set to "THROUGHPUT_MEASUREMENT". | +| applicationRelatedInformation | ApplicationRelatedInformation | C | 0..1 | This attribute shall be present if eventType is set to "USER_DATA_USAGE_MEASURES" and measurementType is set to "APPLICATION_RELATED_INFORMATION". | +| throughputStatisticMeasurements | ThroughputStatisticMeasurement | C | 0..1 | This attribute shall be present if eventType is set to "USER_DATA_USAGE_TRENDS". | +| NOTE: Either the appId or the flowInfo may be present, not both. When neither appId nor flowInfo is present, the measurements (i.e., the volumeMeasurement and/or the throughputMeasurement, and/or the applicationRelatedInformation and/or the throughputStatisticMeasurements) shall correspond to the user plane measurements of the PDU session. When appId is present, the measurements shall correspond to user plane measurements of the application identified by the appId. When flowInfo is present, the measurement shall correspond to user plane measurements for the data flow identified by the flowInfo. | | | | | + +##### 6.1.6.2.6 Type: VolumeMeasurement + +Table 6.1.6.2.6-1: Definition of type VolumeMeasurement + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| totalVolume | TrafficVolume | O | 0..1 | When present, this IE shall indicate the total volume (bytes) of user plane traffic for both the uplink and downlink directions. | +| ulVolume | TrafficVolume | O | 0..1 | When present, this IE shall indicate the volume (bytes) of user plane traffic for the uplink direction. | +| dlVolume | TrafficVolume | O | 0..1 | When present, this IE shall indicate the volume (bytes) of user plane traffic for the downlink direction. | +| totalNbOfPackets | Uint64 | O | 0..1 | When present, this IE shall indicate the total number of user plane packets for both uplink and downlink directions. | +| ulNbOfPackets | Uint64 | O | 0..1 | When present, this IE shall indicate the number of user plane packets for the uplink direction. | +| dlNbOfPackets | Uint64 | O | 0..1 | When present, this IE shall indicate the number of user plane packets for the downlink direction. | + +##### 6.1.6.2.7 Type: ThroughputMeasurement + +Table 6.1.6.2.7-1: Definition of type ThroughputMeasurement + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------|---|-------------|--------------------------------------------------------------------------------------------------| +| ulThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the measurement of data throughput in uplink direction. | +| dlThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the measurement of data throughput in downlink direction. | +| ulPacketThroughput | PacketRate | O | 0..1 | When present, this IE shall indicate the measurement of packet throughput in uplink direction. | +| dlPacketThroughput | PacketRate | O | 0..1 | When present, this IE shall indicate the measurement of packet throughput in downlink direction. | + +##### 6.1.6.2.8 Type: ApplicationRelatedInformation + +Table 6.1.6.2.8-1: Definition of type ApplicationRelatedInformation + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| urls | array(Uri) | O | 1..N | This IE may be present if available. When present, it shall contain a list of URLs detected in the traffic identified by the information included in the subscription request, e.g. an application id. | +| domainInfoList | array(DomainInformation) | O | 1..N | This IE may be present if available. When present, it shall contain a list of Domain information detected in the traffic identified by the information included in the subscription request, e.g. an application id. | + +##### 6.1.6.2.9 Type: ThroughputStatisticMeasurement + +Table 6.1.6.2.9-1: Definition of type ThroughputStatisticMeasurement + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|------------|---|-------------|----------------------------------------------------------------------------------------------------------------| +| ulAverageThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the average throughput in uplink direction over the measurement period. | +| dlAverageThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the average throughput in downlink direction over the measurement period. | +| ulPeakThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the peak throughput in uplink direction over the measurement period. | +| dlPeakThroughput | BitRate | O | 0..1 | When present, this IE shall indicate the peak throughput in downlink direction over the measurement period. | +| ulAveragePacketThroughput | PacketRate | O | 0..1 | When present, this IE shall indicate the average packet throughput in uplink direction. | +| dlAveragePacketThroughput | PacketRate | O | 0..1 | When present, this IE shall indicate the average packet throughput in downlink direction. | +| ulPeakPacketThroughput | PacketRate | O | 0..1 | When present, this IE shall indicate the Peak packet throughput in uplink direction. | +| dlPeakPacketThroughput | PacketRate | O | 0..1 | When present, this IE shall indicate the Peak packet throughput in downlink direction. | + +##### 6.1.6.2.10 Type: DomainInformation + +Table 6.1.6.2.10-1: Definition of type: DomainInformation + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------|---|-------------|-------------------------------------------------------------| +| domainName | Fqdn | M | 1 | This IE shall contain a domain name. | +| domainNameProtocol | DnProtocol | O | 0..1 | This IE may be present to contain the Domain Name Protocol. | + +##### 6.1.6.2.11 Type: UpfEventSubscription + +Table 6.1.6.2.11-1: Definition of type UpfEventSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventList | array(UpfEvent) | M | 1..N | Describes the events to be subscribed in subscription request or the events successfully subscribed for this subscription in subscription response. | | +| eventNotifyUri | Uri | M | 1 | Identifies the recipient of notifications sent by UPF for this subscription | | +| notifyCorrelationId | string | M | 1 | Identifies the notification correlation ID. The UPF shall include this ID in the notifications. The value of this IE shall be unique per subscription for a given NF service consumer. | | +| eventReportingMode | UpfEventMode | M | 1 | This IE shall be included to describe how the reports of the event shall be generated. | | +| nflId | NfInstanceId | M | 1 | Indicates the instance identity of the network function creating the subscription. | | +| uelpAddress | lpAddr | C | 0..1 | The IE shall be present if the event subscription is applicable to one UE. The IE shall indicate the UE's PDU Session IP address.
(NOTE) | | +| supi | Supi | O | 0..1 | Subscription Permanent Identifier | | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier | | +| pei | Pei | O | 0..1 | Permanent Equipment Identifier | | +| anyUe | boolean | C | 0..1 | This IE shall be present if the event subscription is applicable to any UE.

When present, it shall be set as follows:
true: the subscription applies to any UE.
false (default): the subscription applies to a specific UE.
(NOTE) | | +| dnn | Dnn | O | 0..1 | Data Network Name | | +| snssai | Snssai | O | 0..1 | A single Network Slice Selection Assistance Information. | | +| NOTE: Either information about a single UE (i.e. uelpAddress) or anyUe set to true shall be included. | | | | | | + +Editor's Note: Whether one DNN and/or one S-NSSAI shall be present when subscription is for any UE is FFS. The cardinality and description of DNN and S-NSSAI are FFS. + +6.1.6.2.12 Type: UpfEventMode + +**Table 6.1.6.2.12-1: Definition of type UpfEventMode** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| trigger | UpfEventTrigger | M | 1 | Describes how the reports are triggered. | | +| maxReports | integer | C | 0..1 | This IE may be present if the trigger is set to "PERIODIC". When present, this IE shall indicate the maximum number of reports that can be generated by each subscribed event in the subscription.

If the UPF event subscription is for a list of events, this parameter shall be applied to each individual event in the list. | | +| expiry | DateTime | C | 0..1 | This IE shall be included in an event subscription response, if, based on operator policy and taking into account the expiry time included in the request, the UPF needs to include an expiry time.

This IE may be included in an event subscription request.

When present, this IE shall represent the time after which the subscribed event(s) shall stop generating report and the subscription becomes invalid. If the trigger value included in an event subscription response is "ONE_TIME" and if an event report is included in the subscription response then the value of the expiry included in the response shall be an immediate timestamp. | | +| repPeriod | DurationSec | C | 0..1 | This IE shall be present if the trigger is set to "PERIODIC". When present, this IE shall indicate the period time for the event reports.

When the Event Subscription is for "ANY UE", the NF Consumer should set the "repPeriod" to a value which does not lead to a potential overload in the UPF and use sampRatio. | | +| sampRatio | SamplingRatio | O | 0..1 | This IE may be included in an event subscription request for any UE to indicate the ratio of the random subset of target PDU sessions. Event reports only relate to the subset.

If the UPF event subscription is for a list of UPF event, this parameter shall be applied to each individual event. | | +| partitioningCriteria | array(PartitioningCriteria) | O | 1..N | This IE may be included in an event subscription request for any UE if the sampRatio IE is provided.

When present, this IE shall define the criteria for determining the PDU sessions for which the sampling ratio shall apply.
(NOTE) | | +| notifFlag | NotificationFlag | O | 0..1 | Indicates the notification flag, which is used to mute/unmute notifications and to retrieve events stored during a period of muted notifications. | | + +| | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| mutingExcInSTRUCTIONS | MutingExceptionInstructions | O | 0..1 | This IE may be included by NWDAF or DCCF in the event subscription request, if the notifFlag IE is present and set to "DEACTIVATE".
When present, it shall indicate the instructions for the subscription and stored events when an exception (e.g. the buffer of stored event reports is full, or the number of stored event reports exceeds a certain number) occurs at UPF while the events are muted.
See 3GPP TS 23.288 [17], clause 6.2.7.2.
Write-Only: true | EEMM | +| mutingNotSettings | MutingNotificationsSettings | O | 0..1 | This IE may be included in the event subscription response if the event notifications muting is activated.
This IE Indicates the UPF muting notification settings.
See 3GPP TS 23.288 [17], clause 6.2.7.2.
Read-Only: true | EEMM | +| NOTE: In this release of specification, the partitioningCriteria values defined in 3GPP TS 29.571 [16] that apply to UPF Event Exposure are SNSSAI and DNN. | | | | | | + +##### 6.1.6.2.13 Type: UpfEvent + +**Table 6.2.6.2.13-1: Definition of type UpfEvent** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| type | EventType | M | 1 | Describes the UPF event type to be reported | | +| immediateFlag | boolean | O | 0..1 | Indicates if an immediate event report containing the currently available value / status of the event is requested. The report contains the value / status of the event currently available at the UPF at the time of the subscription.

The default value is false. | | +| measurements | array(MeasurementType) | C | 1..N | This IE shall be present if the type IE is set to "USER_DATA_USAGE_MEASURES".

When present, this IE shall indicate the types of requested measurements. | | +| appIds | array(ApplicationId) | O | 1..N | Contains the application identifiers.
(NOTE 1, NOTE 2) | | +| trafficFilters | array(FlowInformation) | O | 1..N | Identifies IP or Ethernet packet filters.
(NOTE 1, NOTE 2) | | +| granularityOfMeasurement | GranularityOfMeasurement | O | 0..1 | Indicates the granularity of measurement.
(NOTE 2) | | +| reportingSuggestionInfo | ReportingSuggestionInformation | C | 0..1 | The IE should be present if the event notification can be delayed, i.e. it is delay tolerant. | | +| NOTE 1: Either the appIds IE or the trafficFilters IE may be present, not both. | | | | | | +| NOTE 2: If the appIds or trafficFilters is provided, the granularityOfMeasurement shall not be set to "PER_SESSION". If neither appIds nor trafficFilters is provided, the granularityOfMeasurement may be set to "PER_SESSION", "PER_APPLICATION" or "PER_FLOW" to request the UPF to provide measurements with the corresponding granularity. | | | | | | + +##### 6.1.6.2.14 Type: CreateEventSubscription + +Table 6.2.6.2.14-1: Definition of type CreateEventSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| subscription | UpfEventSubscription | M | 1 | Represents the UPF Event Subscription resource to be created. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +##### 6.1.6.2.15 Type: CreatedEventSubscription + +Table 6.1.6.2.15-1: Definition of type CreatedEventSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subscription | UpfEventSubscription | M | 1 | Represents the newly created UPF Event Subscription resource. | +| subscriptionId | Uri | M | 1 | Represents the URI of the newly created UPF Event Subscription resource. This shall contain an absolute URI set to the Resource URI specified in clause 6.1.3.3.2. (NOTE) | +| reportList | array(NotificationItem) | O | 1..N | Represents the immediate event reports (i.e. the current value / status of the events subscribed), if available. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +NOTE: 3GPP TS 23.502 [3] specifies this attribute as "Subscription Correlation ID". + +##### 6.1.6.2.16 Type: ReportingSuggestionInformation + +Table 6.1.6.2.16-1: Definition of type ReportingSuggestionInformation + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reportingUrgency | ReportingUrgency | M | 1 | Indicates whether the event report is delay tolerant. | +| reportingTimeInfo | DurationSec | C | 0..1 | This IE shall be present if the Reporting urgency information indicates it is delay tolerant. When present, this IE shall define the latest time for the UPF to report the detected event. | + +##### 6.1.6.2.17 Type: TscManagementInfo + +Table 6.1.6.2.17-1: Definition of type TscManagementInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------|---------------| +| pmics | array(PortManagementContainer) | O | 1..N | When present, this IE shall contain a Port Management Information Container for one or more NW-TT ports. | | +| umic | BridgeManagementContainer | O | 0..1 | When present, this IE shall contain a User Plane Node Management Information Container. | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.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. + +##### 6.1.6.3.2 Simple data types + +No specific simple data types are defined in this release. + +##### 6.1.6.3.3 Enumeration: EventType + +The enumeration EventType represents the type of event to which the NF service consumer may subscribe to and for which the notification is generated. It shall comply with the provisions defined in table 6.1.5.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration EventType** + +| Enumeration value | Description | Applicability | +|----------------------------|---------------------------------------------------|---------------| +| "QOS_MONITORING" | QoS Monitoring Measurement (see clause 5.2.1.3.2) | | +| "USER_DATA_USAGE_MEASURES" | User Data Usage Measures (see clause 5.2.1.3.3) | | +| "USER_DATA_USAGE_TRENDS" | User Data Usage Trends (see clause 5.2.1.3.4) | | +| "TSC_MNGT_INFO" | TSC Management Information | | + +##### 6.1.6.3.4 Enumeration: UpfEventTrigger + +**Table 6.1.6.3.4-1: Enumeration UpfEventTrigger** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "ONE_TIME" | Defines that UPF should generate report for the event only once. After reporting, the subscription to this event is terminated. | +| "PERIODIC" | Defines that UPF should periodically generate reports for the event, until the subscription to this event ends, due to end of report duration or up to the maximum number of reports or the event being unsubscribed explicitly. | + +##### 6.1.6.3.5 Enumeration: MeasurementType + +**Table 6.1.6.3.5-1: Enumeration MeasurementType** + +| Enumeration value | Description | +|-----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| "VOLUME_MEASUREMENT" | Measures of data volume exchanged (UL, DL and/or overall and/or number of packets exchanged (UL, DL and/or overall).
(NOTE) | +| "THROUGHPUT_MEASUREMENT" | Measures of data throughput (UL and DL).
(NOTE) | +| "APPLICATION_RELATED_INFO" | URL/s and/or Domain name/s detected in the traffic identified by the information included in the subscription request, e.g. an application id.
(NOTE) | +| NOTE: This value may be used for the "USER_DATA_USAGE_MEASURES" event type. | | + +##### 6.1.6.3.6 Enumeration: GranularityOfMeasurement + +**Table 6.1.6.3.6-1: Enumeration GranularityOfMeasurement** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------| +| "PER_APPLICATION" | Indicates that the granularity of the requested measurements is per application. | +| "PER_SESSION" | Indicates that the granularity of the requested measurements is per PDU Session. | +| "PER_FLOW" | Indicates that granularity of the requested measurements is per data flow. | + +##### 6.1.6.3.7 Enumeration: DnProtocol + +**Table 6.1.6.3.7-1: Enumeration DnProtocol** + +| Enumeration value | Description | +|-------------------|---------------------------------------------------------------------------| +| "DNS_QNAME" | Identifies the DNS protocol and the question name in DNS query. | +| "TLS_SNI" | Identifies the Server Name Indication in TLS ClientHello message. | +| "TLS_SAN" | Identifies the Subject Alternative Name in TLS ServerCertificate message. | +| "TLS_SCN" | Identifies the Subject Common Name in TLS ServerCertificate message. | + +##### 6.1.6.3.8 Enumeration: ReportingUrgency + +**Table 6.1.6.3.8-1: Enumeration ReportingUrgency** + +| Enumeration value | Description | +|----------------------|-----------------------------------------| +| "DELAY_TOLERANT" | The event report is delay tolerant. | +| "NON_DELAY_TOLERANT" | The event report is not delay tolerant. | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nupf\_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 Nupf\_EventExposure API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nupf\_EventExposure service are specified in this release. + +#### 6.1.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nupf\_EventExposure service, and the following application errors listed in Table 6.1.7.3-1 are specific for the Nupf\_EventExposure service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| PDU_SESSION_NOT_SERVED_BY_UPF | 403 Forbidden | Indicates the creation of a subscription towards a PDU session has failed due to an application error when the PDU session is not served by the UPF. | +| MUTING_EXC_INSTR_NOT_ACCEPTED | 403 Forbidden | Indicates the UPF does not accept the received muting exception instructions. | +| SUBSCRIPTION_NOT_FOUND | 404 Not Found | Indicates the deletion of subscription has failed due to an application error when the subscription is not found in the UPF. | + +### 6.1.8 Feature negotiation + +The optional features listed in table 6.2.8-1 are defined for the Nupf\_EventExposure API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | EEMM | O | Event Exposure Muting Mechanism

An UPF supporting this feature shall support the handling of event muting exception instructions as specified in clause 6.2.7.2 of 3GPP TS 23.288 [17]. | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8], the access to the Nupf\_EventExposure API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nupf\_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 Nupf\_EventExposure service. + +The Nupf\_EventExposure API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [8]; it defines a single scope consisting on the name of the service (i.e., "nupf-ee"), and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different UPF service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different UPF producer instance will return the NF Instance ID of the new UPF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UPF redirects a service request to a different UPF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UPF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Nupf\_GetPrivateUEIPaddr Service API + +### 6.2.1 Introduction + +The Nupf\_GetPrivateUEIPaddr service shall use the Nupf\_GetPrivateUEIPaddr API. + +The API URI of the Nupf\_GetPrivateUEIPaddr Service API shall be: + +**{apiRoot}** + +The request URI 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}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nupf\_gueip". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, IETF RFC 9113 [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 Nupf\_GetPrivateUEIPaddr API is contained in Annex A. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.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 9457 [13]. + +#### 6.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +![Diagram showing the resource URI structure. A vertical line descends from the base URI '{apiRoot}/nupf-gueip/' to a horizontal line that leads to a rounded rectangle containing the path '/ue-ip-info'.](69e5f1993021af230d08c08aac97d9df_img.jpg) + +{apiRoot}/nupf-gueip/ + +``` + +graph TD + A["{apiRoot}/nupf-gueip/"] --> B["/ue-ip-info"] + +``` + +Diagram showing the resource URI structure. A vertical line descends from the base URI '{apiRoot}/nupf-gueip/' to a horizontal line that leads to a rounded rectangle containing the path '/ue-ip-info'. + +**Figure 6.2.3.1-1: Resource URI structure of the Nupf\_GetPrivateUEIPaddr API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------|--------------|---------------------------------|-----------------------------| +| UE IP Address Info | /ue-ip-info | GET | Nupf_GetPrivateUEIPaddr_Get | + +#### 6.2.3.2 Resource: UE IP Address Info + +##### 6.2.3.2.1 Description + +This resource represents the UE IP Address Info of all the PDU sessions served by the UPF. + +This resource is modelled with the Document archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nupf\_gueip//ue-ip-info + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 GET + +This operation retrieves the UE IP Info of a PDU session, which contains the UE's PDU Session (private) IP address, by querying the UPF with the NATed UE's public IP address and an optional Port number. + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------|---|-------------|----------------------------|---------------| +| ue-ipv4-address | Ipv4Addr | O | 0..1 | UE's IPv4 address | | +| ue-ipv6-prefix | Ipv6Prefix | O | 0..1 | UE's IPv6 Prefix | | +| port-number | integer | O | 0..1 | UDP or TCP Port | | +| dnn | Dnn | O | 0..1 | DNN of the PDU session | | +| snssai | Snssai | O | 0..1 | S-NSSAI of the PDU session | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UelpInfo | M | 1 | 200 OK | The response body contains a UelpInfo for a PDU session which contains attributes that are matching the queryparameter. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- NO_MATCHING UE_IP_ADDRESS

See table 6.2.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.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 of the resource located on an alternative service instance. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | + +**Table 6.2.3.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 of the resource located on an alternative service instance. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +##### 6.2.3.2.4 Resource Custom Operations + +None. + +### 6.2.4 Custom Operations without associated resources + +None + +### 6.2.5 Notifications + +#### 6.2.5.1 General + +None. + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nupf\_GetPrivateUEIPaddr service based interface protocol. + +**Table 6.2.6.1-1: Nupf\_GetPrivateUEIPaddr specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-----------|----------------|------------------------------|---------------| +| UelpInfo | 6.1.6.2.2 | A UelpInfo for a PDU session | | + +Table 6.2.6.1-2 specifies data types re-used by the Nupf\_GetPrivateUEIPaddr 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 NNF service based interface. + +**Table 6.2.6.1-2: Nupf\_GetPrivateUEIPaddr re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------|---------------------|---------------------|---------------| +| Dnn | 3GPP TS 29.571 [16] | DNN | | +| Snssai | 3GPP TS 29.571 [16] | S-NSSAI | | +| Ipv4Addr | 3GPP TS 29.571 [16] | IPv4 address | | +| Ipv6Prefix | 3GPP TS 29.571 [16] | IPv6 address prefix | | +| Supi | 3GPP TS 29.571 [16] | SUPI | | +| Gpsi | 3GPP TS 29.571 [16] | GPSI | | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: UelpInfo + +Table 6.2.6.2.2-1: Definition of type UelpInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| privateIpv4Address | Ipv4Address | O | 0..1 | When present, this IE shall contain the Private IPv4 IP address. | +| ipDomain | string | O | 0..1 | When present, this IE contains the IP domain of the private IPv4 address. | +| privateIpv6Prefix | Ipv6Prefix | O | 0..1 | When present, this IE shall contain the Private IPv6 Prefix. | +| publicIpv4Address | Ipv4Address | O | 0..1 | When present, this IE shall contain the public (NATed) IPv4 IP address. | +| publicIpv6Prefix | Ipv6Prefix | O | 0..1 | When present, this IE shall contain the public (NATed) IPv6 Prefix. | +| portNumber | Uint16 | O | 0..1 | When present, this IE shall contain the port number for the source UDP or TCP port when Port Address Translation is used. | +| dnn | Dnn | O | 0..1 | When present, this IE shall contain the DNN of the PDU Session. | +| snssai | Snssai | O | 0..1 | When present, this IE shall contain the S-NSSAI of the PDU Session. | +| hplmnSnssai | Snssai | O | 0..1 | This IE may be included by a V-UPF acting as (local) PSA for a HR-SBO PDU session.
When present, it shall contain the HPLMN S-NSSAI of the PDU session. | +| supi | Supi | O | 0..1 | When present, this IE shall contain the SUPI of the UE. | +| gpsi | Gpsi | O | 0..1 | When present, this IE shall contain the GPSI of the UE. | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.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. + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +For the Nupf\_GetPrivateUEIPaddr 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 Nupf\_GetPrivateUEIPaddr API. + +#### 6.2.7.2 Protocol Errors + +No specific procedures for the Nupf\_GetPrivateUEIPaddr service are specified. + +#### 6.2.7.3 Application Errors + +The application errors defined for the Nupf\_GetPrivateUEIPaddr service are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------|------------------|----------------------------------------------------------| +| NO_UE_IP_INFO_FOUND | 404 Not Found | There is no UE IP address matching the query parameters. | + +### 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the Nupf\_GetPrivateUEIPaddr API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nupf\_GetPrivateUEIPaddr 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 Nupf\_GetPrivateUEIPaddr 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 Nupf\_GetPrivateUEIPaddr service. + +The Nupf\_GetPrivateUEIPaddr API defines a single scope "nupf\_gueip" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different UPF service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different UPF producer instance will return the NF Instance ID of the new UPF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UPF redirects a service request to a different UPF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UPF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## --- A.2 Nupf\_EventExposure API + +``` +openapi: 3.0.0 + +info: + title: 'UPF Event Exposure Service' + version: 1.1.0-alpha.4 + description: | + UPF Event Exposure Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.564 V18.3.0; 5G System; User Plane Function Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.564/ + +servers: + - url: '{apiRoot}/nupf-ee/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nupf-ee + +paths: + /ee-subscriptions: + post: + summary: Nupf_EventExposure Subscribe service Operation + operationId: CreateSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateEventSubscription' + responses: + '201': + description: Successful creation of an UPF Event Subscription + headers: + Location: +``` + +``` + + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nupf-ee//ee-subscriptions/{subscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedEventSubscription' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + eeNotification: + '{eventNotificationUri}': + # The URI in {eventNotificationUri} is provided via N4 interface during provisioning of +Session Reporting Rule or in the Nupf_EventExposure Subscribe request. + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationData' + responses: + '204': + description: No Content, Notification was successfull + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' +NF service consumer' + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' +NF service consumer' + required: true + schema: + type: string + +``` + +``` + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/ee-subscriptions/{subscriptionId}: + patch: + summary: Nupf_EventExposure Subscribe Modify service Operation + operationId: ModifySubscription + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be modified + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +``` + +``` +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Nupf_EventExposure UnSubscribe service Operation + operationId: DeleteSubscription + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be deleted + schema: + type: string + responses: + '204': + description: Subscription deleted successfully + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nupf-ee: Access to the Nupf_EventExposure API + +schemas: + # API specific definitions + +# STRUCTURED DATA TYPES + +NotificationData: + description: the list of NotificationItems + type: object + required: + - notificationItems + properties: + notificationItems: + type: array + items: + $ref: '#/components/schemas/NotificationItem' + minItems: 1 + correlationId: + type: string + achievedSampRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' +``` + +``` +NotificationItem: + description: represents a report on one subscribed event + type: object + required: + - eventType + - timeStamp + anyOf: + - required: [ ueIpv4Addr ] + - required: [ ueIpv6Prefix ] + - required: [ ueMacAddr ] + properties: + eventType: + $ref: '#/components/schemas/EventType' + ueIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + ueMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + qosMonitoringMeasurement: + $ref: '#/components/schemas/QosMonitoringMeasurement' + tscMngtInfo: + $ref: '#/components/schemas/TscManagementInfo' + userDataUsageMeasurements: + type: array + items: + $ref: '#/components/schemas/UserDataUsageMeasurements' + minItems: 1 + +UpfEventSubscription: + description: UPF Event Subscription + type: object + properties: + eventList: + type: array + items: + $ref: '#/components/schemas/UpfEvent' + minItems: 1 + eventNotifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifyCorrelationId: + type: string + eventReportingMode: + $ref: '#/components/schemas/UpfEventMode' + nfid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + ueIpAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + anyUe: + type: boolean + default: false + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - eventList + - eventNotifyUri + - notifyCorrelationId +``` + +- eventReportingMode +- nfId + +UpfEventMode: +description: UPF Event Mode +type: object +properties: + trigger: + \$ref: '#/components/schemas/UpfEventTrigger' + maxReports: + type: integer + expiry: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/DateTime' + repPeriod: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/DurationSec' + sampRatio: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/SamplingRatio' + partitioningCriteria: + type: array + items: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/PartitioningCriteria' + minItems: 1 + notifFlag: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/NotificationFlag' + mutingExcInstructions: + writeOnly: true + allOf: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/MutingExceptionInstructions' + mutingNotSettings: + readOnly: true + allOf: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/MutingNotificationsSettings' +required: + - trigger + +UpfEvent: +description: UPF Event +type: object +properties: + type: + \$ref: '#/components/schemas/EventType' + immediateFlag: + type: boolean + default: false + measurementTypes: + type: array + items: + \$ref: '#/components/schemas/MeasurementType' + minItems: 1 + appIds: + type: array + items: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + trafficFilters: + type: array + items: + \$ref: 'TS29512\_Npcf\_SMPolicyControl.yaml#/components/schemas/FlowInformation' + minItems: 1 + granularityOfMeasurement: + \$ref: '#/components/schemas/GranularityOfMeasurement' + reportingSuggestionInfo: + \$ref: '#/components/schemas/ReportingSuggestionInformation' +required: + - type + +CreateEventSubscription: +description: Data within UPF Create Event Subscription Request +type: object +properties: + subscription: + \$ref: '#/components/schemas/UpfEventSubscription' + supportedFeatures: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/SupportedFeatures' +required: + - subscription + +CreatedEventSubscription: + +``` +description: Data within UPF Create Event Subscription Response +type: object +properties: + subscription: + $ref: '#/components/schemas/UpfEventSubscription' + subscriptionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reportList: + type: array + items: + $ref: '#/components/schemas/NotificationItem' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +required: +- subscription +- subscriptionId +``` + +``` +ReportingSuggestionInformation: +description: Reporting Suggestion Information +type: object +properties: + reportingUrgency: + $ref: '#/components/schemas/ReportingUrgency' + reportingTimeInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +required: +- reportingUrgency +``` + +``` +QosMonitoringMeasurement: +description: QoS Monitoring Measurement information +type: object +properties: + flowInfos: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation' + minItems: 1 + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + dlPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + ulPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + rtrPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + measureFailure: + type: boolean + enum: + - true + dlAveThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulAveThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlCongestion: + type: string + ulCongestion: + type: string + defaultQosFlowInd: + type: boolean + default: false +``` + +# Editor's note: the encoding of the dlCongestion and ulCongestion IEs is FFS + +``` +TscManagementInfo: +description: TSC Management Information +type: object +properties: + pmics: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 + umic: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' +``` + +``` +UserDataUsageMeasurements: + description: > + User Data Usage Measurements either for the PDU session, or the app-id, or the data flow + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + flowInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation' + volumeMeasurement: + $ref: '#/components/schemas/VolumeMeasurement' + throughputMeasurement: + $ref: '#/components/schemas/ThroughputMeasurement' + applicationRelatedInformation: + $ref: '#/components/schemas/ApplicationRelatedInformation' + throughputStatisticsMeasurement: + $ref: '#/components/schemas/ThroughputStatisticsMeasurement' + +VolumeMeasurement: + description: Volume Measurement information + type: object + properties: + totalVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficVolume' + ulVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficVolume' + dlVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficVolume' + totalNbOfPackets: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + ulNbOfPackets: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + dlNbOfPackets: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + +ThroughputMeasurement: + description: Throughput Measurement information + type: object + properties: + ulThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulPacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + dlPacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + +ApplicationRelatedInformation: + description: Application Related Information + type: object + properties: + urls: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + domainInfoList: + type: array + items: + $ref: '#/components/schemas/DomainInformation' + minItems: 1 + +ThroughputStatisticsMeasurement: + description: Throughput Statistics Measurement + type: object + properties: + ulAverageThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlAverageThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulPeakThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlPeakThroughPut: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulAveragePacketThroughput: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + dlAveragePacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + ulPeakPacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + dlPeakPacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + +DomainInformation: + description: Domain Information + type: object + properties: + domainName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + domainNameProtocol: + $ref: '#/components/schemas/DnProtocol' + required: + - domainName + +# ENUMS + +EventType: + description: Event Type + anyOf: + - type: string + enum: + - QOS_MONITORING + - USER_DATA_USAGE_MEASURES + - USER_DATA_USAGE_TRENDS + - TSC_MNGT_INFO + - type: string + +UpfEventTrigger: + description: Upf Event Trigger + anyOf: + - type: string + enum: + - ONE_TIME + - PERIODIC + - type: string + +MeasurementType: + description: Measurement Type + anyOf: + - type: string + enum: + - VOLUME_MEASUREMENT + - THROUGHPUT_MEASUREMENT + - APPLICATION_RELATED_INFO + - type: string + +GranularityOfMeasurement: + description: Granularity Of Measurement + anyOf: + - type: string + enum: + - PER_APPLICATION + - PER_SESSION + - PER_FLOW + - type: string + +DnProtocol: + description: Domain Name Protocol + anyOf: + - type: string + enum: + - DNS_QNAME + - TLS_SNI + - TLS_SAN + - TLS_SCN + - type: string + +ReportingUrgency: + description: Reporting Urgency + anyOf: + - type: string +``` + +``` +enum: + - DELAY_TOLERANT + - NON_DELAY_TOLERANT +- type: string +``` + +``` +# SIMPLE TYPES +``` + +## A.3 Nupf\_GetPrivateUEIPaddr API + +``` +openapi: 3.0.0 +``` + +### ``` info: ``` + +``` + version: '1.0.0-alpha.3' + title: 'UPF GET Private UE IP address Service' + description: | + Nupf_GetPrivateUEIPaddr Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +``` + +### ``` externalDocs: ``` + +``` + description: 3GPP TS 29.564 V18.3.0; 5G System; 5G System; User Plane Function Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.564/' +``` + +### ``` servers: ``` + +``` + - url: '{apiRoot}/nupf-gueip/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +``` + +### ``` security: ``` + +``` + - {} + - oAuth2ClientCredentials: + - nupf-gueip +``` + +### ``` paths: ``` + +### ``` /ue-ip-info: ``` + +### ``` get: ``` + +``` + summary: Search UeIpInfo for a PDU session from the UeIpInfo + operationId: SearchUeIpInfo + tags: + - UE IP Info_Get + parameters: + - name: snssai + in: query + description: Slice of the PDU session + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + - name: dnn + in: query + description: Dnn of the PDU session + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: ue-ipv4-address + in: query + description: IPv4 address of the UE + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + - name: ue-ipv6-prefix + in: query + description: IPv6 prefix of the UE + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + - name: port-number + in: query + description: UDP or TCP port associated with the public address + schema: + type: integer + minimum: 0 + maximum: 65535 + responses: + '200': + description: Successful response + content: + application/json: +``` + +``` + + schema: + $ref: '#/components/schemas/UeIpInfo' + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target UPF + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target UPF + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nupf-gueip: Access to the Nupf_GetPrivateUEIPaddr API + +schemas: + UeIpInfo: + description: a UE IP Address Info for a PDU session + type: object + properties: + privateIpv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipDomain: + type: string + privateIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + publicIpv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + publicIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + portNumber: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' +dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' +hplmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' +supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' +``` + +# --- Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2021-09 | CT4#105e | C4-214754 | | | | Version after CT4#105-e including agreed pCRs:
C4-214464
C4-214465
C4-214559 | 0.1.0 | | +| 2021-10 | CT4#106e | C4-215518 | | | | Version after CT4#106-e including agreed pCRs:
C4-215441
C4-215443
C4-215532
C4-215536 | 0.2.0 | | +| 2021-11 | CT4#107e | C4-216471 | | | | Version after CT4#107-e including agreed pCRs:
C4-216524
C4-216525 | 0.3.0 | | +| 2021-12 | CT#94e | CP-213167 | | | | V1.0.0 presented for information | 1.0.0 | | +| 2022-01 | CT4#107bis-e | C4-220453 | | | | Version after CT4#107bis-e including agreed pCRs:
C4-220146
C4-220147
C4-220148
C4-220149 | 1.1.0 | | +| 2022-02 | CT4#108-e | C4-221591 | | | | Editorial corrections of the rapporteur | 1.2.0 | | +| 2022-03 | CT#95-e | CP-220106 | | | | TS presented for approval | 2.0.0 | | +| 2022-03 | CT#95-e | | | | | TS approved | 17.0.0 | | +| 2022-06 | CT#96-e | CP-221034 | 0001 | 2 | B | Resolving Editor's Note on Notification Information | 17.1.0 | | +| 2022-06 | CT#96-e | CP-221051 | 0003 | | F | 29.564 Rel-17 API version and External doc update | 17.1.0 | | +| 2022-09 | CT#97-e | CP-222029 | 0005 | | F | Description fields | 17.2.0 | | +| 2022-09 | CT#97-e | CP-222029 | 0004 | 1 | F | Reporting Packet Delay Measurement Failure to AF/NEF when direct reporting applies | 17.2.0 | | +| 2022-09 | CT#97-e | CP-222029 | 0006 | 1 | F | Add MAC address information in NotificationItem | 17.2.0 | | +| 2022-09 | CT#97-e | CP-222058 | 0008 | | F | 29.564 Rel-17 API version and External doc update | 17.2.0 | | +| 2023-03 | CT#99 | CP-230034 | 0010 | 1 | B | Service operations of the UPF event exposure service | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0011 | 1 | B | Subscriptions to UPF events | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0012 | 1 | B | UPF events supported by the UPF event exposure service | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0014 | 1 | B | Unsubscribe service operation | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0015 | 1 | B | Resource URI structure of the UPF event exposure API | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0017 | 1 | B | Security of UPF Event Exposure service | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0022 | 1 | B | Service operations of Nupf_EventExposure service | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0019 | 1 | B | Nupf_GetPrivateUEIPaddr service operation and API | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0021 | 1 | B | Resource and data type of Nupf_GetPrivateUEIPaddr service | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0009 | 3 | B | Updates to the Introduction of TS 29.564 | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0013 | 2 | B | Subscribe service operation | 18.0.0 | | +| 2023-03 | CT#99 | CP-230034 | 0023 | 2 | B | Resource for Nupf_EventExposure service | 18.0.0 | | +| 2023-03 | CT#99 | CP-230071 | 0029 | | F | 29.564 Rel-18 API version and External doc update | 18.0.0 | | +| 2023-06 | CT#100 | CP-231027 | 0027 | | 4 | Location header and missing Redirection clause | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0030 | | F | Correction on DNN and S-NSSAI in Nupf_GetPrivateUEIPaddr_Get Operation | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0035 | | B | Support for Data rate monitoring | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0032 | 1 | F | Creation of a Subscription for Nupf_eventexposure | 18.1.0 | | +| 2023-06 | CT#100 | CP-231259 | 0033 | 3 | B | Data types for Nupf_eventexposure service notify operation and openAPI | 18.1.0 | | +| 2023-06 | CT#100 | CP-231260 | 0024 | 3 | B | Data types for Nupf_eventexposure service subscribe operation and openAPI | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0036 | 1 | B | Including SUPI in the response | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0038 | 1 | B | UPF exposure of TSC Management Information | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0039 | 1 | B | NF ID in Nupf_EventExposure_Subscribe Request and Fixing Incorrect References | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0040 | 1 | B | Modification of a subscription for UPF events | 18.1.0 | | +| 2023-06 | CT#100 | CP-231035 | 0041 | 1 | B | Resource and data type of modification of a subscription for UPF events | 18.1.0 | | +| 2023-06 | CT#100 | CP-231057 | 0037 | 1 | B | UPF exposure of congestion information | 18.1.0 | | +| 2023-06 | CT#100 | CP-231070 | 0045 | | F | 29.564 Rel-18 API version and External doc update | 18.1.0 | | +| 2023-09 | CT#101 | CP-232038 | 0046 | | F | Consumers of the UPF Event Exposure service | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0053 | | B | Applicability of the value "CONTINUOUS" for UpfEventTrigger | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0055 | | F | RedirectResponse Description | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0056 | | B | The Immediate Report Flag | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0047 | 1 | F | Subscription type for User Data Usage Measures / Trends | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0054 | 1 | B | Domain Name Protocol | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0058 | 2 | B | The partitioning criteria for the UPF Event Exposure | 18.2.0 | | +| 2023-09 | CT#101 | CP-232038 | 0057 | 2 | B | Multiple PDU Sessions in a NotificationItem | 18.2.0 | | +| 2023-09 | CT#101 | CP-232054 | 0050 | 1 | B | QoS flow description in QoS monitoring report | 18.2.0 | | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232054 | 0048 | 2 | B | Data rate monitoring | 18.2.0 | +| 2023-09 | CT#101 | CP-232054 | 0049 | 3 | B | Exposure of congestion information | 18.2.0 | +| 2023-09 | CT#101 | CP-232060 | 0059 | | F | 29.564 Rel-18 API version and External doc update | 18.2.0 | +| 2023-09 | CT#101 | CP-232067 | 0052 | 1 | A | Support of an Ethernet PDU Session | 18.2.0 | +| 2023-12 | CT#102 | CP-233028 | 0069 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9113 | 18.3.0 | +| 2023-12 | CT#102 | CP-233030 | 0075 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0064 | | F | Miscellaneous corrections | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0066 | | F | List and description of events supported by the Nupf_EventExposure service | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0068 | | B | Reporting Suggestion Information | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0063 | 1 | F | Correction on dnn and reportingUrgency attributes | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0073 | | B | Achieved sampling ratio in Nupf_EventExposure_Notify | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0074 | 1 | B | Indication of QoS Flow associated with the default QoS Rule | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0072 | 1 | B | Nupf_GetPrivateUEIPaddr_Get response with GPSI | 18.3.0 | +| 2023-12 | CT#102 | CP-233038 | 0065 | | B | UPF GetPrivateUEIPaddr service extensions for HR-SBO PDU sessions | 18.3.0 | +| 2023-12 | CT#102 | CP-233045 | 0061 | 2 | B | Muting enhancements | 18.3.0 | +| 2023-12 | CT#102 | CP-233053 | 0071 | 1 | F | Per QoS flow data rate monitoring | 18.3.0 | +| 2023-12 | CT#102 | CP-233060 | 0077 | | F | 29.564 Rel-18 API version and External doc update | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29565/raw.md b/raw/rel-18/29_series/29565/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..cdc53a9fad13c0d4c02fd5fecdab217824424836 --- /dev/null +++ b/raw/rel-18/29_series/29565/raw.md @@ -0,0 +1,7832 @@ + + +# 3GPP TS 29.565 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Time Sensitive Communication and Time Synchronization Function Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller black text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'P' has a red signal wave icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps, black font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------------------------|----| +| Foreword..... | 10 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions, symbols and abbreviations..... | 12 | +| 3.1 Definitions..... | 12 | +| 3.2 Symbols..... | 13 | +| 3.3 Abbreviations..... | 13 | +| 4 Overview..... | 13 | +| 4.1 Introduction..... | 13 | +| 4.2 Service Architecture..... | 13 | +| 5 Services offered by the TSCTSF..... | 14 | +| 5.1 Introduction..... | 14 | +| 5.2 Ntsctsf_TimeSynchronization Service..... | 15 | +| 5.2.1 Service Description..... | 15 | +| 5.2.1.1 Overview..... | 15 | +| 5.2.1.2 Network Functions..... | 16 | +| 5.2.1.2.1 TSCTSF..... | 16 | +| 5.2.1.2.2 NF Service Consumers..... | 16 | +| 5.2.2 Service Operations..... | 16 | +| 5.2.2.1 Introduction..... | 16 | +| 5.2.2.2 Ntsctsf_TimeSynchronization_CapsSubscribe..... | 17 | +| 5.2.2.2.1 General..... | 17 | +| 5.2.2.2.2 Creating a new subscription..... | 17 | +| 5.2.2.2.3 Modifying an existing subscription..... | 20 | +| 5.2.2.3 Ntsctsf_TimeSynchronization_CapsUnsubscribe..... | 21 | +| 5.2.2.3.1 General..... | 21 | +| 5.2.2.3.2 Unsubscription from capability notifications..... | 21 | +| 5.2.2.4 Ntsctsf_TimeSynchronization_CapsNotify..... | 22 | +| 5.2.2.4.1 General..... | 22 | +| 5.2.2.4.2 Notification about the capability of time synchronization service..... | 22 | +| 5.2.2.5 Ntsctsf_TimeSynchronization_ConfigCreate..... | 23 | +| 5.2.2.5.1 General..... | 23 | +| 5.2.2.5.2 Creating a new configuration..... | 23 | +| 5.2.2.6 Ntsctsf_TimeSynchronization_ConfigUpdate..... | 26 | +| 5.2.2.6.1 General..... | 26 | +| 5.2.2.6.2 Updating an existing configuration..... | 26 | +| 5.2.2.7 Ntsctsf_TimeSynchronization_ConfigDelete..... | 29 | +| 5.2.2.7.1 General..... | 29 | +| 5.2.2.7.2 Deleting an existing configuration..... | 29 | +| 5.2.2.8 Ntsctsf_TimeSynchronization_ConfigUpdateNotify..... | 30 | +| 5.2.2.8.1 General..... | 30 | +| 5.2.2.8.2 Notifying the current state of an existing configuration..... | 30 | +| 5.3 Ntsctsf_QoSandTSCAssistance Service..... | 31 | +| 5.3.1 Service Description..... | 31 | +| 5.3.1.1 Overview..... | 31 | +| 5.3.1.2 Network Functions..... | 31 | +| 5.3.1.2.1 TSCTSF..... | 31 | +| 5.3.1.2.2 NF Service Consumers..... | 31 | +| 5.3.2 Service Operations..... | 32 | +| 5.3.2.1 Introduction..... | 32 | +| 5.3.2.2 Ntsctsf_QoSandTSCAssistance_Create..... | 32 | +| 5.3.2.2.1 General..... | 32 | +| 5.3.2.2.2 Initial provisioning of TSC related service information..... | 32 | +| 5.3.2.2.3 Subscriptions to Service Data Flow QoS notification control..... | 35 | +| 5.3.2.2.4 Subscription to Service Data Flow Deactivation..... | 36 | + +| | | | +|------------|-------------------------------------------------------------------------------------------------------------|----| +| 5.3.2.2.5 | Subscription to resources allocation outcome..... | 36 | +| 5.3.2.2.6 | Subscriptions to Service Data Flow QoS Monitoring Information..... | 36 | +| 5.3.2.2.7 | Initial provisioning of sponsored connectivity information..... | 37 | +| 5.3.2.3 | Ntsctsf_QoSandTSCAssistance_Update..... | 39 | +| 5.3.2.3.1 | General..... | 39 | +| 5.3.2.3.2 | Modification of TSC related service information..... | 39 | +| 5.3.2.3.3 | Modification of Subscription to Service Data Flow QoS notification control..... | 42 | +| 5.3.2.3.4 | Modification of Subscription to Service Data Flow Deactivation..... | 42 | +| 5.3.2.3.5 | Modification of subscription to resources allocation outcome..... | 42 | +| 5.3.2.3.6 | Modification of Subscription to Service Data Flow QoS Monitoring Information..... | 43 | +| 5.3.2.3.7 | Modification of sponsored connectivity information..... | 43 | +| 5.3.2.3.9 | Modification of Subscription to BAT offset notification..... | 44 | +| 5.3.2.4 | Ntsctsf_QoSandTSCAssistance_Delete..... | 44 | +| 5.3.2.4.1 | General..... | 44 | +| 5.3.2.4.2 | TSC AF application session context termination..... | 44 | +| 5.3.2.4.3 | Reporting usage for sponsored data connectivity..... | 45 | +| 5.3.2.5 | Ntsctsf_QoSandTSCAssistance_Notify..... | 46 | +| 5.3.2.5.1 | General..... | 46 | +| 5.3.2.5.2 | Notification about TSC application session context event..... | 46 | +| 5.2.2.5.3 | Notification about TSC application session context termination..... | 47 | +| 5.3.2.5.4 | Notification about Service Data Flow QoS notification control..... | 48 | +| 5.3.2.5.5 | Notification about Service Data Flow Deactivation..... | 49 | +| 5.3.2.5.6 | Notification about resources allocation outcome..... | 49 | +| 5.3.2.5.7 | Notification about Service Data Flow QoS Monitoring control..... | 49 | +| 5.3.2.5.8 | Reporting usage for sponsored data connectivity..... | 50 | +| 5.3.2.5.10 | Notification about BAT offset..... | 50 | +| 5.3.2.6 | Ntsctsf_QoSandTSCAssistance_Subscribe..... | 51 | +| 5.3.2.6.1 | General..... | 51 | +| 5.3.2.6.2 | Handling of subscription to events for the existing TSC application session context..... | 51 | +| 5.3.2.6.3 | Subscription to Service Data Flow QoS Monitoring Information..... | 53 | +| 5.3.2.6.4 | Subscription to Usage Monitoring of Sponsored Data Connectivity..... | 53 | +| 5.3.2.7 | Ntsctsf_QoSandTSCAssistance_Unsubscribe..... | 53 | +| 5.3.2.7.1 | General..... | 53 | +| 5.3.2.7.2 | Unsubscription to events..... | 54 | +| 5.4 | Ntsctsf_ASTI Service..... | 54 | +| 5.4.1 | Service Description..... | 54 | +| 5.4.1.1 | Overview..... | 54 | +| 5.4.1.2 | Network Functions..... | 55 | +| 5.4.1.2.1 | TSCTSF..... | 55 | +| 5.4.1.2.2 | NF Service Consumers..... | 55 | +| 5.4.2 | Service Operations..... | 55 | +| 5.4.2.1 | Introduction..... | 55 | +| 5.4.2.2 | Ntsctsf_ASTI_Create..... | 56 | +| 5.4.2.2.1 | General..... | 56 | +| 5.4.2.2.2 | Creating a new configuration..... | 56 | +| 5.4.2.3 | Ntsctsf_ASTI_Update..... | 58 | +| 5.4.2.3.1 | General..... | 58 | +| 5.4.2.3.2 | Updating an existing configuration..... | 59 | +| 5.4.2.4 | Ntsctsf_ASTI_Delete..... | 60 | +| 5.4.2.4.1 | General..... | 60 | +| 5.4.2.4.2 | Delete an existing configuration..... | 60 | +| 5.4.2.5 | Ntsctsf_ASTI_Get..... | 61 | +| 5.4.2.5.1 | General..... | 61 | +| 5.4.2.5.2 | Retrieve the status of access stratum time distribution..... | 61 | +| 5.4.2.6 | Ntsctsf_ASTI_UpdateNotify..... | 62 | +| 5.4.2.6.1 | General..... | 62 | +| 5.4.2.6.2 | Notification about the 5G access stratum time distribution events..... | 63 | +| 5.4.2.6.3 | Notification about ASTI configuration changes due to UE presence in time synchronization coverage area..... | 63 | +| 5.4.2.6.4 | Notification about the 5G access stratum time distribution status information..... | 64 | + +| | | | +|-------------|-----------------------------------------------------------------------|----| +| 6 | API Definitions..... | 64 | +| 6.1 | Ntsctsf_TimeSynchronization Service API..... | 64 | +| 6.1.1 | Introduction..... | 64 | +| 6.1.2 | Usage of HTTP..... | 65 | +| 6.1.2.1 | General..... | 65 | +| 6.1.2.2 | HTTP standard headers..... | 65 | +| 6.1.2.2.1 | General..... | 65 | +| 6.1.2.2.2 | Content type..... | 65 | +| 6.1.2.3 | HTTP custom headers..... | 65 | +| 6.1.3 | Resources..... | 65 | +| 6.1.3.1 | Overview..... | 65 | +| 6.1.3.2 | Resource: Time Synchronization Exposure Subscriptions..... | 67 | +| 6.1.3.2.1 | Description..... | 67 | +| 6.1.3.2.2 | Resource Definition..... | 67 | +| 6.1.3.2.3 | Resource Standard Methods..... | 67 | +| 6.1.3.2.3.1 | POST..... | 67 | +| 6.1.3.2.4 | Resource Custom Operations..... | 68 | +| 6.1.3.3 | Resource: Individual Time Synchronization Exposure Subscription..... | 68 | +| 6.1.3.3.1 | Description..... | 68 | +| 6.1.3.3.2 | Resource Definition..... | 68 | +| 6.1.3.3.3 | Resource Standard Methods..... | 68 | +| 6.1.3.3.3.1 | GET..... | 68 | +| 6.1.3.3.3.2 | DELETE..... | 69 | +| 6.1.3.3.3.3 | PUT..... | 70 | +| 6.1.3.3.4 | Resource Custom Operations..... | 71 | +| 6.1.3.4 | Resource: Time Synchronization Exposure Configurations..... | 72 | +| 6.1.3.4.1 | Description..... | 72 | +| 6.1.3.4.2 | Resource Definition..... | 72 | +| 6.1.3.4.3 | Resource Standard Methods..... | 72 | +| 6.1.3.4.3.1 | POST..... | 72 | +| 6.1.3.4.4 | Resource Custom Operations..... | 73 | +| 6.1.3.5 | Resource: Individual Time Synchronization Exposure Configuration..... | 74 | +| 6.1.3.5.1 | Description..... | 74 | +| 6.1.3.5.2 | Resource Definition..... | 74 | +| 6.1.3.5.3 | Resource Standard Methods..... | 74 | +| 6.1.3.5.3.1 | GET..... | 74 | +| 6.1.3.5.3.2 | PUT..... | 75 | +| 6.1.3.5.3.3 | DELETE..... | 76 | +| 6.1.3.5.4 | Resource Custom Operations..... | 78 | +| 6.1.4 | Custom Operations without associated resources..... | 78 | +| 6.1.5 | Notifications..... | 78 | +| 6.1.5.1 | General..... | 78 | +| 6.1.5.2 | Time Synchronization Capability Notification..... | 78 | +| 6.1.5.2.1 | Description..... | 78 | +| 6.1.5.2.2 | Target URI..... | 78 | +| 6.1.5.2.3 | Standard Methods..... | 78 | +| 6.1.5.3 | Time Synchronization Configuration Notification..... | 79 | +| 6.1.5.3.1 | Description..... | 79 | +| 6.1.5.3.2 | Target URI..... | 79 | +| 6.1.5.3.3 | Standard Methods..... | 80 | +| 6.1.5.3.3.1 | POST..... | 80 | +| 6.1.6 | Data Model..... | 80 | +| 6.1.6.1 | General..... | 80 | +| 6.1.6.2 | Structured data types..... | 83 | +| 6.1.6.2.1 | Introduction..... | 83 | +| 6.1.6.2.2 | Type: TimeSyncExposureSubsc..... | 84 | +| 6.1.6.2.3 | Type: TimeSyncExposureSubsNotif..... | 86 | +| 6.1.6.2.4 | Type: SubsEventNotification..... | 86 | +| 6.1.6.2.5 | Type: TimeSyncCapability..... | 87 | +| 6.1.6.2.6 | Type: PtpCapabilitiesPerUe..... | 87 | +| 6.1.6.2.7 | Type: TimeSyncExposureConfigNotif..... | 88 | + +| | | | +|---------------|-----------------------------------------------------------|-----| +| 6.1.6.2.8 | Type: StateOfConfiguration..... | 88 | +| 6.1.6.2.9 | Type: TimeSyncExposureConfig..... | 89 | +| 6.1.6.2.10 | Type: PtpInstance..... | 90 | +| 6.1.6.2.11 | Type: ConfigForPort..... | 91 | +| 6.1.6.2.12 | Type: StateOfDtt..... | 93 | +| 6.1.6.3 | Simple data types and enumerations..... | 93 | +| 6.1.6.3.1 | Introduction..... | 93 | +| 6.1.6.3.2 | Simple data types..... | 93 | +| 6.1.7 | Error Handling..... | 93 | +| 6.1.7.1 | General..... | 93 | +| 6.1.7.2 | Protocol Errors..... | 94 | +| 6.1.7.3 | Application Errors..... | 94 | +| 6.1.8 | Feature negotiation..... | 94 | +| 6.1.9 | Security..... | 94 | +| 6.2 | Ntsctsf_QoSandTSCAssistance Service API..... | 94 | +| 6.2.1 | Introduction..... | 94 | +| 6.2.2 | Usage of HTTP..... | 95 | +| 6.2.2.1 | General..... | 95 | +| 6.2.2.2 | HTTP standard headers..... | 95 | +| 6.2.2.2.1 | General..... | 95 | +| 6.2.2.2.2 | Content type..... | 95 | +| 6.2.2.3 | HTTP custom headers..... | 95 | +| 6.2.3 | Resources..... | 95 | +| 6.2.3.1 | Overview..... | 95 | +| 6.2.3.2 | Resource: TSC Application Sessions..... | 96 | +| 6.2.3.2.1 | Description..... | 96 | +| 6.2.3.2.2 | Resource Definition..... | 97 | +| 6.2.3.2.3 | Resource Standard Methods..... | 97 | +| 6.2.3.2.3.1 | POST..... | 97 | +| 6.2.3.2.4 | Resource Custom Operations..... | 98 | +| 6.2.3.3 | Resource: Individual TSC Application Session Context..... | 98 | +| 6.2.3.3.1 | Description..... | 98 | +| 6.2.3.3.2 | Resource Definition..... | 98 | +| 6.2.3.3.3 | Resource Standard Methods..... | 98 | +| 6.2.3.3.3.1 | GET..... | 98 | +| 6.2.3.3.3.2 | PATCH..... | 99 | +| 6.2.3.3.4 | Resource Custom Operations..... | 101 | +| 6.2.3.3.4.1 | Overview..... | 101 | +| 6.2.3.3.4.2 | Operation: delete..... | 101 | +| 6.2.3.3.4.2.1 | Description..... | 101 | +| 6.2.3.3.4.2.2 | Operation Definition..... | 101 | +| 6.2.3.4 | Resource: Events Subscription (Document)..... | 102 | +| 6.2.3.4.1 | Description..... | 102 | +| 6.2.3.4.2 | Resource Definition..... | 102 | +| 6.2.3.4.3 | Resource Standard Methods..... | 103 | +| 6.2.3.4.3.1 | PUT..... | 103 | +| 6.2.3.4.3.2 | DELETE..... | 104 | +| 6.2.3.4.4 | Resource Custom Operations..... | 105 | +| 6.2.4 | Custom Operations without associated resources..... | 105 | +| 6.2.5 | Notifications..... | 105 | +| 6.2.5.1 | General..... | 105 | +| 6.2.5.2 | Event Notification..... | 105 | +| 6.2.5.2.1 | Description..... | 105 | +| 6.2.5.2.2 | Target URI..... | 106 | +| 6.2.5.2.3 | Standard Methods..... | 106 | +| 6.2.5.2.3.1 | POST..... | 106 | +| 6.2.5.3 | Termination Request..... | 107 | +| 6.2.5.3.1 | Description..... | 107 | +| 6.2.5.3.2 | Target URI..... | 107 | +| 6.2.5.3.3 | Standard Methods..... | 107 | +| 6.2.5.3.3.1 | POST..... | 107 | + +| | | | +|---------------|---------------------------------------------------------------------------------|-----| +| 6.2.6 | Data Model..... | 108 | +| 6.2.6.1 | General..... | 108 | +| 6.2.6.2 | Structured data types..... | 111 | +| 6.2.6.2.1 | Introduction..... | 111 | +| 6.2.6.2.2 | Type TscAppSessionContextData..... | 112 | +| 6.2.6.2.3 | Type EventsSubscReqData..... | 114 | +| 6.2.6.2.4 | Type TscAppSessionContextUpdateData..... | 115 | +| 6.2.6.2.5 | Type EventsSubscReqDataRm..... | 115 | +| 6.2.6.2.6 | Type EventsNotification..... | 116 | +| 6.2.6.2.7 | Type EventNotification..... | 117 | +| 6.2.6.2.8 | Type AdditionalInfoTscsfQosTscac..... | 117 | +| 6.2.6.3 | Simple data types and enumerations..... | 118 | +| 6.2.6.3.1 | Introduction..... | 118 | +| 6.2.6.3.2 | Simple data types..... | 118 | +| 6.2.6.3.3 | Enumeration: TscEvent..... | 118 | +| 6.2.6.4 | Data types describing alternative data types or combinations of data types..... | 119 | +| 6.2.6.4.1 | Type: ProblemDetailsTscsfQosTscac..... | 119 | +| 6.2.7 | Error Handling..... | 119 | +| 6.2.7.1 | General..... | 119 | +| 6.2.7.2 | Protocol Errors..... | 119 | +| 6.2.7.3 | Application Errors..... | 119 | +| 6.2.8 | Feature negotiation..... | 120 | +| 6.2.9 | Security..... | 120 | +| 6.3 | Ntscsf_ ASTI Service API..... | 120 | +| 6.3.1 | Introduction..... | 120 | +| 6.3.2 | Usage of HTTP..... | 121 | +| 6.3.2.1 | General..... | 121 | +| 6.3.2.2 | HTTP standard headers..... | 121 | +| 6.3.2.2.1 | General..... | 121 | +| 6.3.2.2.2 | Content type..... | 121 | +| 6.3.2.3 | HTTP custom headers..... | 121 | +| 6.3.3 | Resources..... | 121 | +| 6.3.3.1 | Overview..... | 121 | +| 6.3.3.2 | Resource: ASTI Configurations..... | 122 | +| 6.3.3.2.1 | Description..... | 122 | +| 6.3.3.2.2 | Resource Definition..... | 122 | +| 6.3.3.2.3 | Resource Standard Methods..... | 123 | +| 6.3.3.2.3.1 | POST..... | 123 | +| 6.3.3.2.4 | Resource Custom Operations..... | 123 | +| 6.3.3.2.4.1 | Overview..... | 123 | +| 6.3.3.2.4.2 | Operation: retrieve..... | 124 | +| 6.3.3.2.4.2.1 | Description..... | 124 | +| 6.3.3.2.4.2.2 | Operation Definition..... | 124 | +| 6.3.3.3 | Resource: Individual ASTI Configuration..... | 124 | +| 6.3.3.3.1 | Description..... | 124 | +| 6.3.3.3.2 | Resource Definition..... | 124 | +| 6.3.3.3.3 | Resource Standard Methods..... | 124 | +| 6.3.3.3.2 | PUT..... | 124 | +| 6.3.3.3.3 | DELETE..... | 125 | +| 6.3.3.3.4 | Resource Custom Operations..... | 126 | +| 6.3.4 | Custom Operations without associated resources..... | 126 | +| 6.3.5 | Notifications..... | 127 | +| 6.3.5.1 | General..... | 127 | +| 6.3.5.2 | ASTI Notification..... | 127 | +| 6.3.5.2.1 | Description..... | 127 | +| 6.3.5.2.2 | Target URI..... | 127 | +| 6.3.5.2.3 | Standard Methods..... | 127 | +| 6.3.5.2.3.1 | POST..... | 127 | +| 6.3.6 | Data Model..... | 128 | +| 6.3.6.1 | General..... | 128 | +| 6.3.6.2 | Structured data types..... | 130 | + +| | | | +|-----------|-----------------------------------------|-----| +| 6.3.6.2.1 | Introduction..... | 130 | +| 6.3.6.2.2 | Type: AccessTimeDistributionData..... | 130 | +| 6.3.6.2.3 | Type: AsTimeDistributionParam..... | 131 | +| 6.3.6.2.4 | Type: StatusRequestData..... | 131 | +| 6.3.6.2.5 | Type: StatusResponseData..... | 132 | +| 6.3.6.2.6 | Type: ActiveUe..... | 132 | +| 6.3.6.2.7 | Type AstiConfigNotification..... | 132 | +| 6.3.6.2.8 | Type AstiConfigStateNotification..... | 133 | +| 6.3.6.3 | Simple data types and enumerations..... | 133 | +| 6.3.6.3.1 | Introduction..... | 133 | +| 6.3.6.3.2 | Simple data types..... | 133 | +| 6.3.6.3.3 | Enumeration: AstiEvent..... | 133 | +| 6.3.7 | Error Handling..... | 133 | +| 6.3.7.1 | General..... | 133 | +| 6.3.7.2 | Protocol Errors..... | 134 | +| 6.3.7.3 | Application Errors..... | 134 | +| 6.3.8 | Feature negotiation..... | 134 | +| 6.3.9 | Security..... | 134 | + +**Annex A (normative): OpenAPI specification..... 135** + +| | | | +|-----|--------------------------------------|-----| +| A.1 | General..... | 135 | +| A.2 | Ntscstf_TimeSynchronization API..... | 135 | +| A.3 | Ntscstf_QoSandTSCAssistance API..... | 146 | +| A.4 | Ntscstf_ASTI API..... | 157 | + +**Annex B (normative): 3GPP extensions for DetNet integration with 5GS..... 163** + +| | | | +|-------------|----------------------------------------------------------------------------|-----| +| B.1 | 3GPP extensions for DetNet integration with 5GS..... | 163 | +| B.1.1 | Introduction..... | 163 | +| B.1.2 | 3GPP Extension 3gpp-5gs-detnet-node..... | 164 | +| B.1.2.1 | Description..... | 164 | +| B.1.2.2 | Provisioning of 5GS specific traffic characteristics and requirements..... | 164 | +| B.1.2.3 | Report of 5GS DetNet flow(s) status..... | 165 | +| B.1.2.4 | Exposure of 5GS DetNet Node Identification..... | 165 | +| B.2 | YANG Module Definitions..... | 165 | +| B.2.1 | Introduction..... | 165 | +| B.2.1.1 | General..... | 165 | +| B.2.1.2 | Module name..... | 166 | +| B.2.1.3 | Header information..... | 166 | +| B.2.1.3.1 | ..... | 166 | +| B.2.1.3.2 | ..... | 166 | +| B.2.1.3.3 | ..... | 166 | +| B.2.1.4 | Meta-information..... | 166 | +| B.2.1.4.1 | ..... | 166 | +| B.2.1.4.2 | ..... | 167 | +| B.2.1.4.3 | ..... | 167 | +| B.2.1.4.4 | ..... | 167 | +| B.2.1.4.5 | ..... | 167 | +| B.2.1.2 | Formatting rules..... | 168 | +| B.2.2 | 3gpp-5gs-detnet-node Module definition..... | 169 | +| B.2.2.1 | Introduction..... | 169 | +| B.2.2.2 | Data Model..... | 169 | +| B.2.2.2.1 | General..... | 169 | +| B.2.2.2.2 | Structured data types..... | 169 | +| B.2.2.2.2.1 | Introduction..... | 169 | +| B.2.2.2.2.2 | Type: _3gpp-5gs-node-requirements..... | 169 | +| B.2.2.2.2.3 | Type: _3gpp-5gs-node-configuration-outcome..... | 170 | + +| | | | +|-------------------------------|-------------------------------------------------------|------------| +| B.2.2.2.2.4 | Type: _3gpp-5gs-node-identity..... | 170 | +| B.2.2.2.3 | Simple data types and enumerations..... | 171 | +| B.2.2.2.3.1 | Introduction..... | 171 | +| B.2.2.2.3.2 | Simple data types..... | 171 | +| B.2.2.2.3.3 | Enumeration: _3gpp-5gs-node-configuration-status..... | 171 | +| Annex C (normative): | YANG module specification..... | 172 | +| C.1 | General..... | 172 | +| C.2 | YANG module _3gpp-5gs-detnet-node..... | 172 | +| Annex D (informative): | Change history..... | 175 | + +## Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the stage 3 protocol and data model for the Ntsctsf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the TSCTSF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +--- + +## 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 29.534: "5G System; Access and Mobility Policy Authorization Service; Stage 3". + +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [16] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [17] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [18] IEEE Std 802.1Q-2018: "IEEE Standard for Local and metropolitan area networks--Bridges and Bridged Networks". +- [19] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System". +- [20] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [21] 3GPP TS 29.122: "T8 reference point for northbound Application Programming Interfaces (APIs)". +- [22] IETF RFC 7396: "JSON Merge Patch". +- [23] 3GPP TS 29.521: "5G System; Binding Support Management Service; Stage 3". +- [24] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [25] IEEE Std 1588-2019: "IEEE Standard for a Precision Clock Synchronization Protocol for Networked Measurement and Control". +- [26] IEEE Std 802.1AS-2020: "IEEE Standard for Local and metropolitan area networks--Timing and Synchronization for Time-Sensitive Applications". +- [27] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [28] IETF draft-ietf-detnet-yang: "Deterministic Networking (DetNet) YANG Model". + +**Editor's note:** The above document cannot be formally referenced until it is published as an RFC. + +- [29] IETF RFC 6241: "Network Configuration Protocol (NETCONF)". +- [30] IETF RFC 8040: "RESTCONF Protocol". +- [31] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [32] IETF RFC 8939: "Deterministic Networking (DetNet) Data Plane: IP". +- [33] IETF RFC 7950: "The YANG 1.1 Data Modeling Language". +- [34] IETF RFC 8407: "Guidelines for Authors and Reviewers of Documents Containing YANG Data Models". +- [35] IETF RFC 6020: "YANG – A Data Modeling Language for the Network Configuration Protocol (NETCONF)". + +--- + +## 3 Definitions, symbols 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]. + +Void + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +Void + +## 3.3 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]. + +| | | +|--------|----------------------------------------------------------------| +| ASTI | Access Stratum Time distribution | +| BAT | Burst Arrival Time | +| DetNet | Deterministic Networking | +| DS-TT | Device-side TSN translator | +| NW-TT | Network-side TSN translator | +| PTP | Precision Time Protocol | +| TA | Tracking Area | +| TSC | Time Sensitive Communication | +| TSCAI | TSC Assistance Information | +| TSCTSF | Time Sensitive Communication and Time Synchronization function | + +--- + +## 4 Overview + +### 4.1 Introduction + +The Ntscsf services are offered by the TSCTSF to support the Time Sensitive Communications and Time Synchronization. + +The following Ntscsf services are specified: + +- Ntscsf\_TimeSynchronization service; +- Ntscsf\_QoSandTSCAssistance service. +- Ntscsf\_ASTI service. + +To enable the reporting of 5GS DetNet node configuration and the provisioning and configuration data for DetNet flows, the TSCTSF offers RESTCONF (IETF RFC 8040 [30]) and/or NETCONF (IETF RFC 6241 [29]) interfaces to the DetNet controller to access the 3GPP extended Deterministic Networking (DetNet) YANG Model as specified in Annex B. + +### 4.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +The known NF service consumers of the Ntscsf services are the Application Function (AF) within the operator's trust domain and the Network Exposure Function (NEF). + +The Ntscsf services are provided by the TSCTSF and consumed by the NF service consumers (e.g. AF, NEF), as shown in figure 4.2-1 for the SBI representation model and in figure 4.2-2 for the reference point representation model. + +![Ntsctsf services architecture, SBI representation diagram showing TSCTSF (Ntsctsf) connected to a Service Based Interface (SBI) which is accessed by NEF and AF.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +graph TD + TSCTSF[TSCTSF +Ntsctsf] --- SBI(( )) + NEF[NEF] --- SBI + AF[AF] --- SBI + +``` + +Ntsctsf services architecture, SBI representation diagram showing TSCTSF (Ntsctsf) connected to a Service Based Interface (SBI) which is accessed by NEF and AF. + +Figure 4.2-1: Ntsctsf services architecture, SBI representation + +![Ntsctsf services architecture, reference point representation diagram showing TSCTSF connected to NEF via N85 reference point and to AF via N86 reference point.](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +``` + +graph TD + TSCTSF[TSCTSF] ---|N85| NEF[NEF] + TSCTSF ---|N86| AF[AF] + +``` + +Ntsctsf services architecture, reference point representation diagram showing TSCTSF connected to NEF via N85 reference point and to AF via N86 reference point. + +Figure 4.2-2: Ntsctsf services architecture, reference point representation + +The DetNet controller, as specified in clause 4.4.8.4 of 3GPP TS 23.501 [2], is the TSCTSF's consumer that accesses the 3GPP extended DetNet YANG model, as specified in Annex B, clause B.1.1. + +## 5 Services offered by the TSCTSF + +### 5.1 Introduction + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-----------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|-------------------|-------| +| Ntsctsf_TimeSynchronization | 6.1 | Provides the support to subscribe/unsubscribe to the notification about time synchronization capabilities or changes in time synchronization status information. Also allows to activate and | TS29565_Ntsctsf_TimeSynchronization.yaml | ntsctsf-time-sync | A.2 | + +| | | | | | | +|-----------------------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|-------------------|-----| +| | | deactivate the time synchronization configuration. | | | | +| Ntsctsf_QoSandTSCAssistance | 6.2 | Provides the support to request specific QoS and provide assistance for handling traffic characterized by TSC QoS parameters. | TS29565_Ntsctsf_QoSandTSCAssistance.yaml | ntsctsf-qos-tscai | A.3 | +| Ntsctsf_ASTI | 6.3 | Provides support for time synchronization service based on 5G access stratum time distribution method. Allows the NF consumer to configure the 5GC and RAN for 5G access stratum based time synchronization service for the UEs and subscribe to get informed about changes in time synchronization status information. | TS29565_Ntsctsf_ASTI.yaml | ntsctsf-asti | A.4 | + +## 5.2 Ntsctsf\_TimeSynchronization Service + +### 5.2.1 Service Description + +#### 5.2.1.1 Overview + +This service provides: + +- Authorization of NF Service Consumer requests for the subscription to the notification of the capability of time synchronization service. +- Authorization of NF Service Consumer requests to create and update time synchronization configuration, and to activate and deactivate the time synchronization service as described in clause 5.27.1.8 of TS 23.501 [2]. + +NOTE: The AF can use either the procedure specified in bullet2) for configuring the (g)PTP instance in 5GS or the procedure specified in clause 5.4.2.2 for controlling the 5G access stratum time distribution for a particular UE. The procedures are not intended to be used in conjunction with each other by the AF. However, the (g)PTP instance activation, modification, and deactivation can influence the 5G access stratum time distribution for the UEs that are part of the impacted PTP instance. + +- Detection and reporting of time synchronization service status based on gNB and/or UPF/NW-TT timing synchronization status information and reporting status updates. +- Notifications to the NF service consumer about the state and changes of state of time synchronization configuration due to evaluation of e.g. time synchronization coverage area conditions. + +## 5.2.1.2 Network Functions + +### 5.2.1.2.1 TSCTSF + +The TSCTSF supports to: + +- receive the request to create/update the subscription to the notification of the capability of time synchronization service from the NEF or AF and interact with the related PCF; +- receive the request to delete the subscription to the notification of the capability of time synchronization service from the NEF or AF and remove the information from the related PCF; +- receive the notification of the availability of the user plane node information from the PCF and subscribe the notification of user plane node related events at the PCF; +- makes a translation from External/Internal Group Identifier to a list of SUPI by querying UDM; +- retrieve the Time Synchronization Subscription data from UDM for the control of (g)PTP instance(s) and make decision based on received the Time Synchronization Subscription data; +- determine the capability of time synchronization service based on the capability information received from the DS-TT(s) and NW-TT and notify the NEF or AF of the capability; +- receive the request to create or modify the time synchronization configuration from the NEF or AF, configure and initialize the PTP instance(s) by constructing a PMIC to each DS-TT/UE to activate the time synchronization service in DS-TT and PMIC(s) and UMIC to NW-TT to activate the time synchronization service in NW-TT and provision them to the PCF; +- determine whether the UE is inside/outside the requested time synchronization coverage area and enforce the time synchronization service accordingly; +- notify the NEF or AF of the current state of the time synchronization service configuration; +- receive the request of time synchronization deactivation from the NEF or AF and disable the corresponding PTP instance(s) in the DS-TT(s) and NW-TT. +- indicate whether the service is supported or not as per the requested acceptance criteria (e.g., based on the known timing synchronization status attribute thresholds pre-configured at gNB); and +- based on gNB and/or UPF/NW-TT timing synchronization status (degradation/failure/improvement) information and reporting, provide a notification when there is a service status update if the NEF or AF subscribe to service status updates. + +### 5.2.1.2.2 NF Service Consumers + +The NF service consumer supports to: + +- send the request to create/update and delete the subscription to the notification of the capability of time synchronization service to TSCTSF; +- receive the notification of the capability of time synchronization service; +- send the request to create, modify and delete the time synchronization configuration to the TSCTSF; +- provide clock quality reporting control information, consisting of clock quality detail level and clock quality acceptance criteria during activation or modification of time synchronization service; and +- subscribe to time synchronization service status for the target UE(s). + +## 5.2.2 Service Operations + +### 5.2.2.1 Introduction + +Service operations defined for the Ntsctsf\_TimeSynchronization service are shown in table 5.2.2.1-1. + +**Table 5.2.2.1-1: Ntsctsf\_TimeSynchronization Service Operations** + +| Service Operation Name | Description | Initiated by | +|------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| Ntsctsf_TimeSynchronization_CapsSubscribe | Allows the NF service consumer to create or modify a subscription to the notification about the capability of time synchronization service for a list of UEs a group of UEs or any UE using a DNN/S-NSSAI combination. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_TimeSynchronization_CapsUnsubscribe | Allows the NF service consumer to delete the subscription to the notification about capability of time synchronization service for a list of UEs, a group of UEs or any UE using a DNN/S-NSSAI combination. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_TimeSynchronization_CapsNotify | Allows the TSCTSF to notify the NF service consumer of the capability of time synchronization service. | TSCTSF | +| Ntsctsf_TimeSynchronization_ConfigCreate | Allows the NF service consumer to create a time synchronization configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_TimeSynchronization_ConfigUpdate | Allows the NF service consumers to update the time synchronization configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_TimeSynchronization_ConfigDelete | Allows the NF service consumer to delete the time synchronization configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_TimeSynchronization_ConfigUpdateNotify | Allows the TSCTSF to notify the NF service consumer of the state of time synchronization configuration. | TSCTSF | + +NOTE: The NEF and the AF use the Ntsctsf\_TimeSynchronization service in the same way. + +## 5.2.2.2 Ntsctsf\_TimeSynchronization\_CapsSubscribe + +### 5.2.2.2.1 General + +This service operation is used by an NF service consumer to subscribe to notification of capability of time synchronization service for a list of UEs, a group of UEs or any UE using a DNN/S-NSSAI combination. + +The following procedures using the Ntsctsf\_TimeSynchronization\_CapsSubscribe service operation are supported: + +- creating a new subscription; +- modifying an existing subscription. + +### 5.2.2.2.2 Creating a new subscription + +Figure 5.2.2.2.2-1 illustrates the creation of a subscription. + +![Sequence diagram illustrating the creation of a subscription. An NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status.](6f659142d4789aa889184459f884787e_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST ... /subscriptions + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "201 Created" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram illustrating the creation of a subscription. An NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status. + +**Figure 5.2.2.2.2-1: Creation of a subscription** + +To subscribe the notification of the capability of time synchronization service, the NF service consumer shall send an HTTP POST message to the TSCTSF to the URI "{apiRoot}/ntsctsf-time-sync//subscriptions". The HTTP POST message shall include the TimeSyncExposureSubsc data structure as request body. The TimeSyncExposureSubsc data structure shall include: + +- the indication of the UEs to which the time synchronization capabilities is requested via: + - identification of a list of individual UEs within a "supis" attribute; + - identification of a list of individual UEs within a "gpsi" attribute; + - indication of any UE within the "anyUeInd" attribute; or + - identification of a group of UE(s) within the "interGroupId" attribute; or + - identification of a group of UE(s) within the "exterGroupId" attribute. +- subscription to event(s) notification as "subscribedEvents" attribute; +- notification URI within the "subsNotifUri" attribute; +- notification correlation Id within the "subsNotifId" attribute; +- DNN with the "dnn" attribute; and +- S-NSSAI with the "snssai" attribute; + +and may include: + +- the conditions to match for notifying the event within the "eventFilters" attribute; +- notification method within the "notifMethod" attribute +- maximum number of reports within the "maxReportNbr" attribute; +- expiry time within the "expiry" attribute; and +- report period within the "repPeriod" attribute. + +Upon receipt of the HTTP request from the NF service consumer, if the request is authorized, the TSCTSF shall: + +- create a new subscription; +- assign a subscription correlation ID; +- select an expiry time that is equal to or less than the expiry time potentially received in the request; +- store the subscription; +- if the "interGroupId" attribute or "exterGroupId" attribute is received from the NF service consumer, interact with the UDM to retrieve the SUPI list that belong to the group using the Nudm\_SDM service as defined in 3GPP TS 29.503 [24]; +- if the "gpsi" attribute is received from the NF service consumer, interact with the UDM to retrieve the SUPI(s) that correspond to the GPSI(s) using the Nudm\_SDM service as defined in 3GPP TS 29.503 [24]; +- use the parameters received from the NF service consumer (i.e. DNN, S-NSSAI and, if available, the list of UEs or UEs that belong to the group of UEs) and the time synchronization subscription data retrieved from UDM to determine the matching AF-session(s) that are authorized by subscription, and for any such AF-session for which the SUPI interact with the PCF by triggering Npcf\_PolicyAuthorization\_Create/Update request message as defined in 3GPP TS 29.514 [20]. + +NOTE 1: If the PCF determines an existing PDU Session is potentially impacted by time synchronization service (based on local configuration or SM Policy Association), the PCF invokes Npcf\_PolicyAuthorization\_Notify service operation to the TSCTSF as defined in clause 4.2.5.16 of 3GPP TS 29.514 [20] to send the received TSC User Plane Node information. At that time, the TSCTSF retrieves from the BSF the PCF binding information (including the UE Identities as SUPI and if available, GPSI for the notified PDU session), as specified in 3GPP TS 29.521 [23], and can create the AF-session by sending to the PCF the Npcf\_PolicyAuthorization\_Create service operation. + +- send an HTTP "201 Created" response with TimeSyncExposureSubsc data structure as response body and a Location header field containing the URI of the created individual subscription resource, i.e. "{apiRoot}/ntsctsf-time-sync//subscriptions/{subscriptionId}" + +The TSCTSF shall handle the AF session(s) associated with the "Individual Time Synchronization Exposure Subscription" resource as follows: + +- For the association of AF sessions to "Individual Time Synchronization Exposure Subscription" resources: + - Upon PDU Session establishment, i.e. when the TSCTSF receives the Npcf\_PolicyAuthorization\_Notify service operation for the establishment of a new PDU session, the TSCTSF shall retrieve from the BSF, as specified in 3GPP TS 29.521 [23], the PCF binding information to complete the necessary AF-Session information and triggers the Npcf\_PolicyAuthorization\_Create request message to the PCF to create an AF-session to subscribe to TSC user plane node related events. The TSCTSF, shall use the parameters of existing "Individual Time Synchronization Exposure Subscription" resources to determine whether they shall be associated to this newly created AF session. The TSCTSF associates the new AF session to the "Individual Time Synchronization Exposure Subscription" resources for which these parameters match. The TSCTSF shall read time synchronization capabilities from the DS-TT and NW-TT, if not available in the AF session, from the PCF by triggering Npcf\_PolicyAuthorization\_Update request message as defined in 3GPP TS 29.514 [20] and determine the (g)PTP capabilities from the DS-TT and the NW-TT as described in clause K.2.1 of 3GPP TS 23.501 [2]. The TSCTSF shall update the time synchronization service capability for this new DS-TT as defined in clause 5.2.2.4.2. + - Upon AF sessions establishment, i.e. when the TSCTSF receives the AF request for the time synchronization service, the TSCTSF shall retrieve Time Synchronization Subscription data from UDM. The TSCTSF, shall use the parameters of existing "Individual Time Synchronization Exposure Subscription" resources to determine whether they shall be associated to this newly created AF session. The TSCTSF associates the new AF session to the "Individual Time Synchronization Exposure Subscription" resources for which these parameters match if the AF-session (i.e., the SUPI) is authorized by UDM subscription, otherwise the AF-session is excluded. + - Upon "Individual Time Synchronization Exposure Subscription" resource creation, the TSCTSF uses the parameters of the created resource to determine which existing and authorized AF sessions it matches. The TSCTSF associates the new "Individual Time Synchronization Exposure Subscription" resource to the authorized AF sessions for which these parameters match. + - To remove an AF session from the associated ones to the "Individual Time Synchronization Exposure Subscription" resource, when the TSCTSF receives the Npcf\_PolicyAuthorization\_Notify service operation indicating the termination of an existing PDU session, the TSCTSF triggers the Npcf\_PolicyAuthorization\_Delete request message to the PCF and determines if the corresponding AF session is associated with the "Individual Time Synchronization Exposure Subscription" resource. If it is so, the TSCTSF shall remove the AF session from the list of AF session(s) associated with the "Individual Time Synchronization Exposure Subscription" resource. The TSCTSF shall update the time synchronization service capability for this removed DS-TT as defined in clause 5.2.2.4.2. + +NOTE 2: After the TSCTSF retrieves from the BSF the PCF binding information (including the UE Identities for the notified PDU session), as specified in 3GPP TS 29.521 [23], the TSCTSF can store internally the information required to invoke Npcf\_PolicyAuthorization\_Create service operation and delay the Npcf\_PolicyAuthorization\_Create service operation (the creation of the AF session) till the subscription to notification of the capability of time synchronization service is received for the concerned UE. In this case, when the TSCTSF receives the subscription request, the TSCTSF interacts with the PCF by triggering Npcf\_PolicyAuthorization\_Create message as defined in 3GPP TS 29.514 [20]. + +NOTE 3: When the TSCTSF receives the Npcf\_PolicyAuthorization\_Notify service operation indicating the termination of an existing PDU session associated to an AF session that it is not associated with any "Individual Time Synchronization Exposure Subscription" resource, the TSCTSF removes the AF-session and triggers the Npcf\_PolicyAuthorization\_Delete request message to the PCF. + +If the TSCTSF cannot successfully fulfil the received HTTP POST request due to the internal TSCTSF error or due to the error in the HTTP POST request, the TSCTSF shall send the HTTP error response as specified in clause 6.1.7. + +#### 5.2.2.2.3 Modifying an existing subscription + +Figure 5.2.2.2.3-1 illustrates the modification of a subscription. + +![Sequence diagram showing the modification of a subscription. An NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content.](e636d7ccca0ad14c6b95201404324823_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. PUT « /subscriptions/{subscriptionId} » + NF service consumer->>TSCTSF: Request + Note right of TSCTSF: 2a. "200 OK" +2b. "204 No Content" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the modification of a subscription. An NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content. + +Figure 5.2.2.2.3-1: Modification of a subscription + +To modify the subscription to the notification of the capability of time synchronization service, the NF service consumer shall send an HTTP PUT message to the TSCTSF to the URI "{apiRoot}/ntcsetf-time-sync//subscriptions/{subscriptionId}" representing an existing "Individual Time Synchronization Exposure Subscription" resource, as shown in figure 5.2.2.2.3-1, step 1. The HTTP PUT message shall include the TimeSyncExposureSubsc data structure as request body. The TimeSyncExposureSubsc data structure shall include the parameters as defined in clause 5.2.2.2.2. + +Upon receipt of the HTTP request from the NF service consumer, if the request is authorized, the TSCTSF shall: + +- update the existing "Individual Time Synchronization Exposure Subscription" resource; +- identify the affected AF session(s) based on the parameters received from the NF service consumer and interact with the PCF by triggering Npcf\_PolicyAuthorization\_Update request message as defined in 3GPP TS 29.514 [20] for the new added UE(s), by triggering Npcf\_PolicyAuthorization\_Delete request message as defined in 3GPP TS 29.514 [20] for the removed UE(s) or by triggering Npcf\_PolicyAuthorization\_Update request message as defined in 3GPP TS 29.514 [20] for the existing UE(s) if necessary. + +NOTE 1: If the PCF determines an existing PDU Session is potentially impacted by time synchronization service (based on local configuration or SM Policy Association), the PCF invokes Npcf\_PolicyAuthorization\_Notify service operation to the TSCTSF as defined in clause 4.2.5.16 of 3GPP TS 29.514 [20] to send the received TSC User Plane Node information. At that time, the TSCTSF retrieves from the BSF the PCF binding information (including the UE Identities as SUPI and if available, GPSI for the notified PDU session), as specified in 3GPP TS 29.521 [23], and can create the AF-session by sending to the PCF the Npcf\_PolicyAuthorization\_Create service operation. + +NOTE 2: After the TSCTSF retrieves from the BSF the PCF binding information (including the UE Identities for the notified PDU session), as specified in 3GPP TS 29.521 [23], the TSCTSF can store internally the information required to invoke Npcf\_PolicyAuthorization\_Create service operation and delay the Npcf\_PolicyAuthorization\_Create service operation (the creation of the AF-session) till the subscription to notification of the capability of time synchronization service is received for the concerned UE. In this case, when the TSCTSF receives the subscription request, the TSCTSF interacts with the PCF by triggering Npcf\_PolicyAuthorization\_Create message as defined in 3GPP TS 29.514 [20]. + +- update the list of AF sessions that are associated to the "Individual Time Synchronization Exposure Subscription" resource (i.e. add or remove AF sessions as associated to this resource) based on if the parameters of the AF sessions match the updated parameters of the "Individual Time Synchronization Exposure Subscription" resource. +- send a HTTP response including "200 OK" status code with TimeSyncExposureSubsc data structure or "204 No Content" status code, as shown in figure 5.2.2.2.3-1, step 2. + +If the HTTP PUT request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP PUT request the cause for the rejection as specified in clause 6.1.7. + +If the TSCTSF determines the received HTTP PUT request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +### 5.2.2.3 Ntsctsf\_TimeSynchronization\_CapsUnsubscribe + +#### 5.2.2.3.1 General + +This service operation is used by an NF service consumer to unsubscribe from the notifications. + +The following procedure using the Ntsctsf\_TimeSynchronization\_CapsUnsubscribe service operation is supported: + +- unsubscribe from capability notifications. + +#### 5.2.2.3.2 Unsubscription from capability notifications + +Figure 5.2.2.3.2-1 illustrates the unsubscription from event notifications. + +![Sequence diagram showing the unsubscription process from capability notifications between an NF service consumer and a TSCTSF.](c0e369274e53b2e5364666be6f786c7a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. DELETE « /subscriptions/{subscriptionId} » + NF service consumer->>TSCTSF: Request + Note right of TSCTSF: 2. "204 No Content" + TSCTSF-->>NF service consumer: Response +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and a TSCTSF. The first message, labeled '1. DELETE « /subscriptions/{subscriptionId} »', is sent from the NF service consumer to the TSCTSF. The second message, labeled '2. "204 No Content"', is sent from the TSCTSF back to the NF service consumer. + +Sequence diagram showing the unsubscription process from capability notifications between an NF service consumer and a TSCTSF. + +**Figure 5.2.2.3.2-1: Unsubscription from capability notifications** + +To unsubscribe from event notifications, the NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/ntsctsf-time-sync//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the subscription correlation ID of the existing subscription that is to be deleted. + +Upon the reception of the HTTP DELETE request, if the received HTTP request is successfully processed and accepted, the TSCTSF shall: + +- remove the corresponding subscription; +- identify the affected AF session(s) and, for each AF session, interact with the PCF by triggering Npcf\_PolicyAuthorization\_Delete request message as defined in 3GPP TS 29.514 [20]; and +- send an HTTP "204 No Content" response. + +If the HTTP DELETE request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP DELETE request the cause for the rejection as specified in clause 6.1.7. + +If the TSCTSF determines the received HTTP DELETE request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 5.2.2.4 Ntsctsf\_TimeSynchronization\_CapsNotify + +##### 5.2.2.4.1 General + +This service operation is used by the TSCTSF to send notifications to NF service consumers upon the detection of the capability of the time synchronization service for a list of UEs. + +The following procedure using the Ntsctsf\_TimeSynchronization\_CapsNotify service operation is supported: + +- notification about the capability of time synchronization service. + +##### 5.2.2.4.2 Notification about the capability of time synchronization service + +Figure 5.2.2.4.2-1 illustrates the notification about the capability of time synchronization service. + +![Sequence diagram showing the notification about the capability of time synchronization service. The diagram involves two participants: TSCTSF and NF service consumer. The sequence of messages is: 1. POST {subsNotifUri} from NF service consumer to TSCTSF, and 2. '204 No Content' response from TSCTSF to NF service consumer.](2834bdd6eb8540277e609decbb924003_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST {subsNotifUri} + NF service consumer->>TSCTSF: 1. POST {subsNotifUri} + Note left of TSCTSF: 2. "204 No Content" + TSCTSF-->>NF service consumer: 2. "204 No Content" + +``` + +Sequence diagram showing the notification about the capability of time synchronization service. The diagram involves two participants: TSCTSF and NF service consumer. The sequence of messages is: 1. POST {subsNotifUri} from NF service consumer to TSCTSF, and 2. '204 No Content' response from TSCTSF to NF service consumer. + +**Figure 5.2.2.4.2-1: Notification about the capability of time synchronization service** + +The TSCTSF maintains the association between the AF session(s) and the Individual Time Synchronization Exposure Subscription resource as defined in clause 5.2.2.2.2 and detects the capability of time synchronization service (for a list of UEs, a group of UEs or any UE in a DNN and S-NSSAI), by composing the time synchronization capabilities for the DS-TT/UE(s) connected to the NW-TT based on the capability information received from the DS-TT(s) and NW-TT via the PCF. If the NF service consumer includes an Event Filter with one or more of the requested PTP instance type, requested transport protocol for PTP, or requested PTP Profile, the TSCTSF considers only the DS-TT(s) and NW-TT(s) with these capabilities as part of the time synchronization capability set that is reported to the NF service consumer. If necessary, when the list of AF session(s) associated to the Individual Time Synchronization Exposure Subscription resource changes, e.g. upon PDU Session establishment or termination, the TSCTSF may notify the update of the capability of time synchronization service for the DS-TT/UE(s) connected to the NW-TT(s). In order to send the capability of time synchronization service to the NF service consumer, the TSCTSF shall send an HTTP POST request with "{subsNotifUri}", as previously provided by the NF service consumer within the corresponding subscription, as request URI and TimeSyncExposureSubsNotif data structure as request body that shall include: + +- Notification correlation ID provided by the NF service consumer during the subscription within "subsNotifId" attribute; and +- information about the observed event(s) within the "eventNotifs" attribute that shall contain for each observed event an "SubsEventNotification" data structure that shall include: + 1. the detected event within the "event" attribute; + 2. when the event is "AVAILABILITY\_FOR\_TIME\_SYNC\_SERVICE", the capabilities of time synchronization service for one or more user plane nodes with the "timeSyncCapas" attribute. Within each instance of TimeSyncCapability data structure, the TSCTSF shall include the identifier of the applicable NW-TT within the "upNodeId" attribute, the "gmCapables" attribute indicating if the user plane node supports acting as a gPTP and/or PTP grandmaster, the supported 5G clock quality within the "asTimeRes" + +attribute, if applicable, and the PTP capabilities for each UE within the "ptpCapForUes" attribute, when the UEs are identified with a SUPI, or within "ptpCapForGpsi" attribute, when the UEs are identified with a GPSI. + +Upon the reception of an HTTP POST, the NF service consumer shall send an HTTP "204 No Content" response for a successful processing. + +If the HTTP POST request from the TSCTSF is not accepted, the NF service consumer shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.1.7. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.2.2.5 Ntsctsf\_TimeSynchronization\_ConfigCreate + +### 5.2.2.5.1 General + +This service operation is used by an NF service consumer to create a time synchronization configuration and activate the time synchronization service with the configuration. + +The following procedures using the Ntsctsf\_TimeSynchronization\_ConfigCreate service operation are supported: + +- creating a new configuration; and +- creating a subscription for notification for the changes in the time synchronization service configuration. + +### 5.2.2.5.2 Creating a new configuration + +Figure 5.2.2.5.2-1 illustrates the creation of a configuration. + +![Sequence diagram showing the creation of a configuration. The NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status.](414cf5c0e2959c558de57a9fb5c2134a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST « /subscriptions/{subscriptionId}/configurations » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "201 Created" + TSCTSF-->>NF service consumer: Response +``` + +Sequence diagram showing the creation of a configuration. The NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status. + +**Figure 5.2.2.5.2-1: Creation of a configuration** + +To create a configuration, the NF service consumer shall send an HTTP POST message to the TSCTSF to the URI "{apiRoot}/ntsctsf-time-sync//subscriptions/{subscriptionId}/configurations". The HTTP POST message shall include the TimeSyncExposureConfig data structure as request body, as shown in figure 5.2.2.5.2-1, step 1. The TimeSyncExposureConfig data structure shall include: + +- the user plane node Id within the "upNodeId" attribute; +- the requested PTP instance within the "reqPtpIns" attribute; +- the time domain within the "timeDom" attribute; +- the notification URI within the "configNotifUri" attribute; +- the notification correlation Id within the "configNotifId" attribute; + +and may include: + +- the "gmEnable" attribute set to true if the AF requests 5GS to act as a grandmaster for PTP or gPTP; +- the time synchronization error budget within the "timeSyncErrBdgt" attribute; +- the grandmaster priority with the "gmPrio" attribute; +- the temporal validity condition within the "tempValidity" attribute; +- if the "CoverageAreaSupport" feature is supported, the time synchronization coverage area encoded as "covReq" attribute, that contains a list of Tracking Area codes per serving network where the requested PTP instance applies; and +- if the "NetTimeSyncStatus" feature is supported, the clock quality detail level in the "clkQltDetLvl" attribute and the clock quality acceptance criteria for the PTP instance in the "clkQltAcptCri" attribute if applicable, if the NF service consumer to subscribe to receiving network time synchronization status report(s). + +NOTE 1: The AF request for PTP service activation, modification cannot indicate that the clock quality detail level to provide is "metrics", i.e. if the AF includes the clock quality detail level, its value needs to set to "acceptable/not acceptable indication" and accompanied with "clock quality acceptance criteria". The UE/DS-TT retrieves detailed information (timing synchronization metrics) from Announce messages sent for (g)PTP services. + +Upon receipt of the HTTP request from the NF service consumer, if the request is authorized, the TSCTSF shall: + +- create a new resource, which represents a new "Individual Time Synchronization Exposure Configuration" instance, addressed by a URI as defined in clause 6.1.3.5 and containing a TSCTSF created resource identifier; +- send an HTTP "201 Created" response with TimeSyncExposureConfig data structure as response body and a Location header field containing the URI of the created Individual Time Synchronization Exposure Configuration resource, i.e. "{apiRoot}/ntsctsf-time-sync/{apiVersion}/subscriptions/{subscriptionId}/configuration/{configurationId}", as shown in figure 5.2.2.5.2-1, step 2; +- use the {subscriptionId} within the requested URI and user plane node ID within the "upNodeId" attribute in the request to determine the target UEs and corresponding authorized AF sessions, then use the parameters (e.g. requested PTP instance type, transport protocol, and PTP profile) in the request to determine suitable DS-TT(s) and AF session(s) among all the AF session(s) and: + - if the "CoverageAreaSupport" feature is supported and a time synchronization coverage area is provided within the "covReq" attribute, the TSCTSF perform the following operations: + 1. if the UE's Time Synchronization Subscription data from the UDM contains the list of TA(s) that comprise the authorized time synchronization coverage area. If the requested time synchronization coverage area within the "covReq" attribute is within the subscribed time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area is fulfilled, and the UE is authorized for the requested time synchronization service. If the Authorized Time Synchronization Coverage Area is inside of the requested Coverage Area, the TSCTSF uses the Authorized Time Synchronization Coverage Area. If the requested Coverage Area partly overlaps with the Authorized Time Synchronization Coverage Area, the TSCTSF uses the intersection of them. If there is no overlap between them, the TSCTSF shall reject the AF request as described in clause 5.27.1.11 of 3GPP TS 23.501 [2]. + 2. The TSCTSF discovers the list of AMF(s) serving the list of TA(s) that comprise the authorized time synchronization coverage area using the Nnrf\_NFDiscovery service operation as described in 3GPP TS 29.510 [10], if they are not available, and, for each UE with matched AF-sessions, subscribes with the discovered AMF(s) to receive notifications about presence of the UE in an Area of Interest events using the Namf\_EventExposure service as described in 3GPP TS 29.518 [27], where the Area of Interest is the provided time synchronization coverage area. + 3. Based on the outcome provided by the AMF about the UE's presence in the Area of Interest and the authorized time synchronization coverage area, the TSCTSF determines if the time synchronization service is activated or deactivated: + - i. If the UE presence is within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area condition is fulfilled, and the UE is authorized for the activation of the received PTP instance configuration. + +- ii. If the UE presence is not within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area condition is not fulfilled, and the UE is not authorized for the activation of the received PTP instance configuration; + - b If the UE's Time Synchronization Subscription data contains the authorized Uu time synchronization error budget, and the requested time synchronization error budget within the "timeSyncErrBdgt" attribute is within the authorized time synchronization coverage area, the TSCTSF determines that the UE is authorized for the requested time synchronization service. + - c. If the UE's Time Synchronization Subscription data contains the periods of authorized start and stop times, and the requested temporal validity condition within the "tempValidity" attribute is within any of the subscribed periods of authorized start and stop times, the TSCTSF determines that the UE is authorized for the requested time synchronization service. +- for each authorized UE and matched AF-session, contact with the each corresponding PCF for the PDU session to configure and initialize the PTP instance in the DS-TT(s) and NW-TT as defined in 3GPP TS 23.502 [3], clause 4.15.9.3.2, step 5-6; + - for each authorized UE with matched AF-session(s), calculate the Uu time synchronization error budget as specified in clauses 5.27.1.9 and 5.27.1.11 of 3GPP TS 23.501 [2], subscribe to event notifications of newly registered PCF for the UE for the affected UEs by invoking Nbsf\_Management\_Subscribe Service Operation as defined in clause 4.2.6 of 3GPP TS 29.521 [23] if not yet done, and send a request to the PCF for the UE for AM policy authorization by invoking Npcf\_AMPolicyAuthorization\_Create service operation as defined in clause 4.2.2 of 3GPP TS 29.534 [14] providing the appropriate values in the "asTimeDisParam" attribute in order to activate the access stratum time distribution and provide the calculated Uu time synchronization error budget. + - if the "NetTimeSyncStatus" feature is supported and upon the reception of the clock quality acceptance criteria in the "clkQltAcptCri" attribute, then TSCTSF subscribes to UPF/NW-TT time synchronization status reports via UMIC as described in clause 4.2.2.31 of 3GPP TS 29.514 [20], if the UPF/NW-TT is involved in providing time synchronization information to DS-TT. In case NG-RAN is involved in providing time synchronization status information to DS-TT, then TSCTSF sends the time synchronization status reporting control information to the NG-RAN and then initiates the subscription to the NG-RAN time synchronization status via AMF using Namf\_Communication\_NonUeN2InfoSubscribe service operation, if not previously done for the involved NG-RAN node, as described in 3GPP TS 29.518 [27]. + +If the temporal validity condition is provided and if the start-time is in the future, the TSCTSF shall maintain the time synchronization configuration and then proceed as described above when the start-time is reached; otherwise, if the start-time is in the past, the TSCTSF shall proceed as described above immediately. When the stop-time is reached for active time synchronization service configuration, the TSCTSF shall proceed as Ntsetsf\_TimeSynchronization\_ConfigDelete was received as described in clause 5.2.2.7.2 without interacting with the AF. + +The TSCTSF shall associate the affected UEs and matched AF sessions to the "Individual Time Synchronization Exposure Configuration". When the "CoverageAreaSupport" feature is supported, the TSCTSF also associates whether the UE fulfills the time synchronization coverage area condition, if provided. When receiving the Npcf\_PolicyAuthorization\_Notify service operation indicating the termination of an existing PDU session and the corresponding AF session is associated with the "Individual Time Synchronization Exposure Configuration" resource, the TSCTSF shall remove the AF session from the list of AF sessions associated with the "Individual Time Synchronization Exposure Configuration" resource and invoke Npcf\_AMPolicyAuthorization\_Delete service operation as defined in clause 4.2.4 of 3GPP TS 29.534 [14] to remove the access stratum time distribution parameters for the UE if they were provided. + +If for all the affected UEs the provided parameters are not allowed by subscription, the TSCTSF shall indicate in an HTTP "403 Forbidden" response message the "cause" attribute set to "UE\_SERVICE\_NOT\_AUTHORIZED". + +If the HTTP POST request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.1.7. + +If the TSCTSF determines the received HTTP POST request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.2.2.6 Ntsctsf\_TimeSynchronization\_ConfigUpdate + +### 5.2.2.6.1 General + +This service operation is used by an NF service consumer to update a time synchronization configuration. + +The following procedures using the Ntsctsf\_TimeSynchronization\_ConfigUpdate service operation are supported: + +- Updating an existing configuration; +- Creating the subscription for notification for the changes in the time synchronization service configuration in case the subscription was not created before. + +### 5.2.2.6.2 Updating an existing configuration + +Figure 5.2.2.6.2-1 illustrates the updating of an existing configuration. + +![Sequence diagram illustrating the update of a configuration. The NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content.](f1fbb1287d999c7034742de35bdab836_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. PUT « /subscriptions/{subscriptionId}/configurations/{configurationId} » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2a. "200 OK" +2b. "204 No Content" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram illustrating the update of a configuration. The NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content. + +**Figure 5.2.2.6.2-1: Update of a configuration** + +To update a configuration, the NF service consumer shall send an HTTP PUT request to the resource "{apiRoot}/ntsctsf-time-sync//subscriptions/{subscriptionId}/configurations/{configurationId}" representing an existing "Individual Time Synchronization Exposure Configuration" resource, as shown in figure 5.2.2.6.2-1, step 1, to modify the configuration. + +The TimeSyncExposureConfig data structure provided in the request body shall include: + +- the user plane node Id within the "upNodeId" attribute; + +NOTE 1: The user plane node Id cannot be changed during the modification. + +- the requested PTP instance within the "reqPtpIns" attribute; +- the time domain within the "timeDom" attribute; + +NOTE 2: The user plane node Id, the requested PTP instance and the time domain cannot be changed during the modification. + +- the notification URI within the "configNotifUri" attribute; +- the notification correlation Id within the "configNotifId" attribute; + +NOTE 3: If the notification URI or notification correlation Id is not changed the previously value is included. + +and may include: + +- the "gmEnable" attribute set to true if the AF requests 5GS to act as a grandmaster for PTP or gPTP; +- the time synchronization error budget within the "timeSyncErrBdgt" attribute; +- the grandmaster priority with the "gmPrio" attribute; + +- the temporal validity condition within the "tempValidity" attribute; +- if the "CoverageAreaSupport" feature is supported, the spatial validity condition encoded as "covReq" attribute, that contains a list of Tracking Area codes per serving network where the requested PTP instance applies; and +- if the "NetTimeSyncStatus" feature is supported, the clock quality detail level in the "clkQltDetLvl" attribute and the clock quality acceptance criteria for the PTP instance in the "clkQltAcptCri" attribute if applicable. + +Upon receipt of the corresponding HTTP PUT message, if the request is authorized, the TSCTSF shall: + +- update the existing "Individual Time Synchronization Exposure Configuration" resource; +- send a HTTP response including "200 OK" status code with TimeSyncExposureConfig data structure or "204 No Content" status code, as shown in figure 5.2.2.6.2-1, step 2; +- use the {subscriptionId} within the requested URI and user plane node ID within the "upNodeId" attribute in the request to determine the target UEs and corresponding AF-sessions, then use the updated parameters (e.g. requested PTP instance type, transport protocol, and PTP profile) in the request to determine suitable DS-TT(s) and AF session(s) among all AF session: + - If the "CoverageAreaSupport" feature is supported and a requested coverage area is provided or updated within the "covReq" attribute, the TSCTSF perform the following operations: + 1. the TSCTSF, based on the time synchronization coverage area retrieved from UDM determines whether the UE is authorized for the request again as described in clause 5.2.2.5.2. + 2. The TSCTSF discovers the list of AMF(s) serving the list of TA(s) that comprise the authorized time synchronization coverage area using the Nnrf\_NFDiscovery service operation as described in 3GPP TS 29.510 [10], if they are not available, and for each UE with matched AF-sessions, subscribes/updates the subscription, if applicable, with the discovered AMF(s) to receive notifications about presence of the UE in an Area of Interest events using the Namf\_EventExposure service as described in 3GPP TS 29.518 [27], where the Area of Interest is the requested/applicable spatial validity condition. + 3. Based on the outcome provided by the AMF or available in the TSCTSF about the UE's presence in the Area of Interest, the TSCTSF determines if the time synchronization service is activated or deactivated: + - i. If the UE presence is within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the spatial validity condition is fulfilled, and the UE is authorized for the activation of the received PTP instance configuration. + - If the UE presence is within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the spatial validity condition is not fulfilled, and the UE is not authorized for the activation of the received PTP instance configuration; + - b. If the "CoverageAreaSupport" feature is supported and a requested coverage area previously provided is removed, the TSCTSF perform the following operations: + 1. For each UE with matched AF-sessions, the TSCTSF terminates the subscriptions to notifications about presence of the UE in an Area of Interest events using the Namf\_EventExposure service as described in 3GPP TS 29.518 [27]. + 2. For each UE with matched AF-sessions that did not fulfil the removed spatial validity condition, the TSCTSF determines the UE is authorized for the activation of the received PTP instance configuration + - c. If the time synchronization error budget within the "timeSyncErrBdgt" attribute and/or the temporal validity condition within the "tempValidity" attribute from the NF service consumer is provided, updated, or removed, the TSCTSF based on the Time Synchronization Subscription data retrieved from the UDM determines whether the UE is authorized for the request again as described in clause 5.2.2.5.2 +- for each authorized UE and matched AF-session, and contact with each corresponding PCF for the PDU session to configure and initialize the PTP instance in the DS-TT(s) and NW-TT as defined in 3GPP TS 23.502 [3], clause 4.15.9.3.3, step 5-6. The TSCTSF associates the new affected AF session(s) with the "Individual Time Synchronization Exposure Configuration" resource. + +- for each authorized UE with matched AF-session(s), if the time synchronization error budget is provided, updated, or removed, calculate the Uu time synchronization error budget as specified in clause 5.27.1.9 of 3GPP TS 23.501 [2] and send a request to the PCF for the UE for AM policy authorization by invoking Npcf\_AMPolicyAuthorization\_Update service operation as defined in clause 4.2.3 of 3GPP TS 29.534 [14] in order to update the Uu time synchronization error budget. +- if the "NetTimeSyncStatus" feature is supported and upon the reception of the updated clock quality acceptance criteria within the "clkQltAcptCri" attribute, then TSCTSF determines the clock acceptance criteria results as specified in clause 5.2.2.8.2. In case the updated clock quality acceptance criteria within the "clkQltAcptCri" attribute is received and the clock acceptance criteria results is not available, then TSCTSF subscribes to UPF/NW-TT time synchronization status reports via UMIC as described in clause 4.2.3.34 of 3GPP TS 29.514 [20], if the UPF/NW-TT is involved in providing time information to DS-TT. In case NG-RAN is involved in providing time synchronization status information to DS-TT, then TSCTSF sends the updated configuration of time synchronization status reporting to the NG-RAN and then initiates the subscription to the NG-RAN time synchronization status via AMF using Namf\_Communication\_NonUeN2InfoSubscribe service operation, as described in 3GPP TS 29.518 [27] + +If the temporal validity condition was provided but it is removed during the update of time synchronization configuration, the TSCTSF shall perform the time synchronization configuration as described above without considering the temporal validity condition. + +If the temporal validity condition was not provided and the temporal validity condition is provided during the update of configuration, the TSCTSF shall perform as follows: + +- if the start-time is in the future, the TSCTSF shall maintain the time synchronization configuration and then proceeds as described above when the start-time is reached; otherwise, if the start-time is in the past, the TSCTSF shall proceed as described above immediately; +- When the stop-time is reached for active time synchronization service configuration, the TSCTSF shall proceed as Ntscsf\_TimeSynchronization\_ConfigDelete was received as described in clause 5.2.2.7.2 without interacting with the AF. + +If the temporal validity condition was provided and the temporal validity condition is updated during the update of configuration, the TSCTSF shall perform as follows: + +- if the previously provided time configuration is being applied but the new start-time is in the future, the TSCTSF shall proceed as Ntscsf\_TimeSynchronization\_ConfigDelete was received as described in clause 5.2.2.7.2 without interacting with the AF firstly and then proceeds as described above when the new start-time is reached; otherwise if the time synchronization configuration has been created but the new start-time is in the past, the TSCTSF keep the existing configuration; +- when the new stop-time is reached for active time synchronization service configuration, the TSCTSF shall proceed as Ntscsf\_TimeSynchronization\_ConfigDelete was received as described in clause 5.2.2.7.2 without interacting with the AF; +- if the previously provided time configuration is not being applied because the previously provided start-time is in the future, the TSCTSF shall perform as the case that the temporal validity condition was not provided previously. + +The TSCTSF shall associate the affected UEs and matched AF session to the "Individual Time Synchronization Exposure Configuration". When the "CoverageAreaSupport" feature is supported, the TSCTSF also associates whether the UE fulfills the spatial validity condition, if provided. When receiving the Npcf\_PolicyAuthorization\_Notify service operation indicating the termination of an existing PDU session and the corresponding AF session is associated with the "Individual Time Synchronization Exposure Configuration" resource, the TSCTSF shall remove the AF session from the list of AF sessions associated with the "Individual Time Synchronization Exposure Configuration" resource and invoke Npcf\_AMPolicyAuthorization\_Delete service operation as defined in clause 4.2.4 of 3GPP TS 29.534 [14] to remove the access stratum time distribution parameters for the UE if they were provided. + +If for all the affected UEs the provided parameters are not allowed by subscription, the TSCTSF shall indicate in an HTTP "403 Forbidden" response message the "cause" attribute set to "UE\_SERVICE\_NOT\_AUTHORIZED". + +If the HTTP PUT request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP PUT request the cause for the rejection as specified in clause 6.1.7. + +If the TSCTSF determines the received HTTP PUT request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.2.2.7 Ntsctsf\_TimeSynchronization\_ConfigDelete + +### 5.2.2.7.1 General + +This service operation is used by an NF service consumer to delete a time synchronization configuration. + +The following procedures using the Ntsctsf\_TimeSynchronization\_ConfigDelete service operation are supported: + +- Deleting an existing configuration. + +### 5.2.2.7.2 Deleting an existing configuration + +Figure 5.2.2.7.2-1 illustrates the deleting of an existing configuration. + +![Sequence diagram showing the deletion of a configuration. An NF service consumer sends a DELETE request to the TSCTSF, and the TSCTSF responds with a 204 No Content.](1c29dadab94c3fa552d270434db09c81_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. DELETE « /subscriptions/{subscriptionId}/configurations/{configurationId} » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "204 No Content" + TSCTSF-->>NF service consumer: Response +``` + +Sequence diagram showing the deletion of a configuration. An NF service consumer sends a DELETE request to the TSCTSF, and the TSCTSF responds with a 204 No Content. + +Figure 5.2.2.7.2-1: Deletion of a configuration + +To delete a configuration, the NF service consumer shall send an HTTP DELETE request to the resource "{apiRoot}/ntsctsf-time-sync/{apiVersion}/subscriptions/{subscriptionId}/configurations/{configurationId}" representing an existing "Individual Time Synchronization Exposure Configuration" resource, as shown in figure 5.2.2.7.2-1, step 1, to delete the configuration. + +Upon the reception of an HTTP DELETE request and if the HTTP DELETE request is accepted by the TSCTSF, the TSCTSF shall: + +- remove the corresponding configuration and respond with "204 No Content" as shown in figure 5.2.2.7.2-1, step 2; +- use the {configurationId} within the requested URI to identify the time synchronization service configuration and the corresponding AF sessions, and then interact with: + - the PCF(s) for the PDU Session to disable the corresponding PTP instance(s) in the DS-TT(s) and NW-TT as defined in 3GPP TS 23.502 [3], clause 4.15.9.3.4, step 5-6. + - the PCF(s) for the UE to remove the time synchronization error budget by invoking the Npcf\_AMPolicyAuthorization\_Delete service operation as defined in clause 4.2.4 of 3GPP TS 29.534 [14]. + +If the HTTP DELETE request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP DELETE request the cause for the rejection as specified in clause 6.1.7. + +If the TSCTSF determines the received HTTP DELETE request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.2.2.8 Ntsctsf\_TimeSynchronization\_ConfigUpdateNotify + +### 5.2.2.8.1 General + +This service operation is used by an TSCTSF to notify the NF Service Consumer of the current state of the time synchronization configuration. + +The following procedures using the Ntsctsf\_TimeSynchronization\_ConfigUpdateNotify service operation are supported: + +- notification about the current state of the time synchronization configuration. + +### 5.2.2.8.2 Notifying the current state of an existing configuration + +Figure 5.2.2.8.2-1 illustrates the notification about the current state of the time synchronization configuration. + +![Sequence diagram showing the notification process between TSCTSF and NF service consumer.](17a1ba23b641c01871b08f0a4f08ef48_img.jpg) + +``` +sequenceDiagram + participant TSCTSF + participant NF_service_consumer as NF service consumer + Note right of TSCTSF: 1. POST {configNotifUri} + TSCTSF->>NF_service_consumer: Request + Note left of NF_service_consumer: 2. "204 No Content" + NF_service_consumer-->>TSCTSF: Response +``` + +The diagram illustrates a sequence of interactions between a TSCTSF (Time Synchronization Configuration Function) and an NF service consumer. The TSCTSF sends a POST request to the NF service consumer, labeled "1. POST {configNotifUri}". The NF service consumer responds with a "204 No Content" status, labeled "2. '204 No Content'". + +Sequence diagram showing the notification process between TSCTSF and NF service consumer. + +**Figure 5.2.2.8.2-1: Notification about the current state of the time synchronization configuration** + +When the TSCTSF receives the notification of the change in the PTP instance for each DS-TT and/or NW-TT from the PCF as defined in clause 4.2.5.13 of 3GPP TS 29.514 [20] or when the TSCTSF receives the NG-RAN time synchronization status update related to clock quality acceptance criteria via AMF as described in clause 5.2.2.4.2 of 3GPP TS 29.518 [27] and determines the affected PTP instance(s), the TSCTSF shall determine the current state of the time synchronization configuration and sends an HTTP POST request with "{configNotifUri}", as previously provided by the NF service consumer within the corresponding configuration, as URI and the TimeSyncExposureConfigNotif data structure as request body, as shown in figure 5.2.2.8.2-1, step 1. + +The TimeSyncExposureConfigNotif data structure as request body that shall include: + +- Notification correlation ID provided by the NF service consumer during the configuration within the "configNotifId" attribute; +- current states of the time synchronization configuration for the DS-TT port(s) and/or NW-TT port within the "stateOfConfig" attribute; + +and may include: + +- if "NetTimeSyncStatus" feature is supported, the report of whether the time synchronization service status according to the clock quality acceptance criteria result is acceptable or not acceptable within the "stateOfConfig" attribute. + +If the "CoverageAreaSupport" feature is supported and the TSCTSF received time synchronization coverage area as part of the Ntsctsf\_TimeSynchronization\_ConfigCreate/Update service operation as described in clauses 5.2.2.5.2 and 5.2.2.6.2, when the TSCTSF receives a change in the UE presence in Area of Interest notification as described in 3GPP TS 29.518 [27], the TSCTSF checks the activation or deactivation of the time synchronization service and adds/removes the UE/DS-TT port to/from the PTP instance and configures the Grandmaster functionality, as applicable, as specified in clause K.2.1 of 3GPP TS 23.501 [2]. For the added/removed UE/DS-TT port to/from the PTP instance, the TSCTSF triggers the notification to the NF service consumer where the "stateOfDstts" attribute within the "stateOfConfig" attribute shall include the state of the added/removed UE/DS-TT port. + +If the "NetTimeSyncStatus" feature is supported and the TSCTSF received the clock quality detail level and the clock quality acceptance criteria as part of the Ntsctsf\_TimeSynchronization\_ConfigCreate/Update service operation as described in clauses 5.2.2.5.2 and 5.2.2.6.2, when the TSCTSF receives a change corresponding to the time synchronization status as described in clause 5.27.1.12 of 3GPP TS 23.501 [2], the TSCTSF provides the notification for the clock quality acceptance criteria result by including the "clkQltAcptCriResInd" attribute within the "stateOfConfig" attribute (for the result related to the NW-TT port(s)) and/or within the entries of the "stateOfDstts" attribute of the "stateOfConfig" attribute (for the results related to every DS-TT port). + +**Editor's note: Whether it is required the report of the clock quality acceptance criteria for the NW-TTP ports (i.e., whether the clkQltIndOfNwtt attribute is needed) is FFS and requires SA2 clarifications.** + +If the HTTP POST request from the TSCTSF is not accepted, the NF service consumer shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.1.7. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.3 Ntsctsf\_QoSandTSCAssistance Service + +### 5.3.1 Service Description + +#### 5.3.1.1 Overview + +This service provides: + +- Authorization of NF Service Consumer requests for the resource reservation for TSC. +- NF Service Consumer request to reserve or update resources for handling traffic characterized by TSC QoS parameters as described in clause 6.1.3.22 of TS 23.503 [19]. + +#### 5.3.1.2 Network Functions + +##### 5.3.1.2.1 TSCTSF + +The TSCTSF supports to: + +- receive the request to reserve or update a specific QoS or a specific QoS with additional Alternative QoS for an AF session; +- receive the request to delete the AF session with requested QoS or the AF session with requested QoS including Alternative Service Requirements +- receive the request to subscribe or unsubscribe to the event(s) about the AF session with requested QoS or the AF session with requested QoS including Alternative Service Requirements; +- determine the requested PDB and construct the TSC Assistance Container; and +- Notify the NF service consumer of the event(s). + +##### 5.3.1.2.2 NF Service Consumers. + +The NF service consumer supports to: + +- send the request to reserve or update a specific QoS or a specific QoS with additional Alternative QoS for an AF session; +- send the request to delete the AF session with requested QoS or the AF session with requested QoS including Alternative Service Requirements +- send the request to subscribe or unsubscribe to the event(s); and + +- receive the notification of the event(s). + +## 5.3.2 Service Operations + +### 5.3.2.1 Introduction + +Service operations defined for the Ntsctsf\_QoSandTSCAssistance service are shown in table 6.3.2.1-1. + +**Table 5.3.2.1-1: Ntsctsf\_TimeSynchronization Service Operations** + +| Service Operation Name | Description | Initiated by | +|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| Ntsctsf_QoSandTSCAssistance_Create | Allows the NF service consumer to request the network to provide a specific QoS or a specific QoS with additional Alternative QoS for an AF session. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_QoSandTSCAssistance_Update | Allows the NF service consumer to request the network to update the QoS or the QoS with additional Alternative QoS for an AF session | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_QoSandTSCAssistance_Delete | Allows the NF service consumer to request the network to delete the AF session with requested QoS or the AF session with requested QoS including Alternative Service Requirements. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_QoSandTSCAssistance_Notify | Allows the TSCTSF to report the QoS Flow level event(s) to the NF service consumer. | TSCTSF | +| Ntsctsf_QoSandTSCAssistance_Subscribe | Allows the NF service consumer to subscribe to the event(s). | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_QoSandTSCAssistance_Unsubscribe | Allows the NF service consumer to unsubscribe to the event(s). | NF service consumer (e.g. AF, NEF) | + +NOTE: The NEF and the AF use the Ntsctsf\_QoSandTSCAssistance service in the same way. + +### 5.3.2.2 Ntsctsf\_QoSandTSCAssistance\_Create + +#### 5.3.2.2.1 General + +This service operation is used by an NF service consumer to request the network to provide a specific QoS for an AF session. + +The following procedures using the Ntsctsf\_QoSandTSCAssistance\_Create service operation are supported: + +- Initial provisioning of TSC related service information. +- Subscriptions to Service Data Flow QoS notification control. +- Subscription to Service Data Flow Deactivation +- Subscription to resources allocation outcome +- Subscriptions to Service Data Flow QoS Monitoring Information. +- Initial provisioning of sponsored connectivity information. +- Initial provisioning of AF requested QoS for a UE or a group of UE(s) not identified by UE address. +- Subscription to BAT offset notification. + +#### 5.3.2.2.2 Initial provisioning of TSC related service information + +This procedure is used to set up a TSC AF application session context for the service as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.3.2.2.2-1 illustrates the initial provisioning of TSC related service information. + +![Sequence diagram showing the initial provisioning of TSC related service information. The NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status.](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST « /tsc-app-sessions » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "201 Created" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the initial provisioning of TSC related service information. The NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status. + +**Figure 5.3.2.2.2-1: Initial provisioning of TSC related service information** + +When a new TSC AF application session context needs to be established, the NF service consumer shall invoke the Ntsctsf\_QoSAndTSCAssistance\_Create service operation by sending the HTTP POST request to the resource URI representing the "TSC Application Sessions" collection resource of the TSCTSF, as shown in figure 5.3.2.2.2-1, step 1. + +The NF service consumer shall include the "TscAppSessionContextData" data type in the content of the HTTP POST request in order to request the creation of the "Individual TSC Application Session Context" resource. The "Individual TSC Application Session Context" resource and the "Events Subscription" sub-resource are created as described below. + +The NF service consumer shall include in the "TscAppSessionContextData" data structure: + +- the AF identifier within the "afId" attribute; +- when the "GMEC" feature is not supported, either the IP address (IPv4 or IPv6) of the PDU session within the "ueIpAddr" attribute for IP type PDU session or the MAC address of the DS-TT port within the "ueMac" attribute for Ethernet type PDU sessions; +- when the "GMEC" feature is supported, either the targeted UE within the "ueId" attribute or the targeted group of UE(s) within the "externalGroupId" attribute as defined in clause 5.3.2.2.8; +- either the Application Id within the "appId" attribute or the flow information within: + - a. for IP flows, the "flowInfo" attribute; or + - b. for Ethernet flows, either the "ethFlowInfo" attribute or, if the Ethernet\_UL/DL\_Flows feature is supported, the "enEthFlowInfo" attribute; +- the QoS reference within the "qosReference" attribute or the individual QoS parameter set (i.e. requested GBR, requested MBR, requested maximum burst size, requested priority if received and requested 5GS delay if received, and requested packet error rate if received) within the "tscQosReq" attribute; +- the input information to construct the TSC Assistance Container within the "tscaiInputUI" attribute and/or "tscaiInputDI" attribute of the "tscQosReq" attribute and the (g)PTP domain that the AF is located in within the "tscaiTimeDom" attribute of the "tscQosReq" attribute, if available; and +- the URI where the TSCTSF can request to the NF service consumer to delete the "Individual TSC Application Session Context" resource within the "notifUri" attribute; + +and may include: + +- the DNN within the "dnn" attribute; +- the S-NSSAI within the "snssai" attribute; +- the domain identity in the "ipDomain" attribute; +- if the "EnTSCAC" feature is supported, the capability for BAT adaptation in the "capBatAdaptation" attribute; + +- an ordered list of alternative QoS references within the "altQosReferences" attribute if the QoS reference is provided or an ordered list of requested alternative QoS parameters set(s) within the "altQosReqs" attribute if the individual QoS parameter set is provided. When the NF service consumer provides the "altQosReferences" attribute or the "altQosReqs" attribute, the NF service consumer shall also subscribe to receive notifications from the TSCTSF when the resources associated to the corresponding service information have been allocated as described in clause 5.3.2.2.5 and when the GBR QoS targets for one or more service data flows can no longer (or can again) be guaranteed, as described in clause 5.3.2.2.3; + +and + +- the request of the notification of certain user plane events within the "evSubsc" attribute. Within the EventsSubscReqData data structure, the NF service consumer shall include: + - a) the URI where the TSCTSF sends the event notification to the NF service consumer within the "notifUri" attribute; + - b) a Notification Correlation Identifier for the requested notifications within the "notifCorreId" attribute; + - c) the subscribed events within the "events" attribute; + - d) the usage threshold within the "usgThres" attribute if the "USAGE\_REPORT" event is subscribed; and + - e) QoS monitoring information within the "qosMon" attribute if the "QOS\_MONITORING" event is subscribed. + +Upon the reception of this HTTP POST request, the TSCTSF shall: + +- construct the TSC Assistance Container based on information provided by the NF service consumer; +- if the Requested 5GS delay including the requested 5GS delay within the individual QoS parameter set or within the requested alternative QoS parameters set(s) is received from NF service consumer, calculate a Requested PDB by subtracting the UE-DS-TT residence time either provided by the PCF or pre-configured at TSCTSF from the Requested 5GS delay; +- if the time domain information is not received with the Burst Arrival Time or Periodicity within the "tscQosReq" attribute from the NF service consumer, the TSCTSF may indicate Time Domain = "5GS" within the "tscaiTimeDom" attribute within the "tscQosReq" attribute to indicate that the NF service consumer does not provide the time domain information; + +NOTE 1: The Time Domain value corresponding to "5GS" is locally configured in the SMF and in the TSCTSF, and indicates that the AF does not provide a Time Domain and the provided TSCAI input information will be used without adjustments. + +- if the feature EnTSCAC is supported and if the NF service consumer includes the capability for BAT adaptation within the "capBatAdaptation" attribute or a BAT window within the "burstArrivalTimeWnd" attribute within the "tscaiInputUI" attribute and/or "tscaiInputDI" attribute of the "tscQosReq" attribute or the periodicity range in the "periodicityRange" attribute in the request, then the TSCTSF shall subscribe to the notification on BAT offset by using the "EventsSubscReqData" data type including an event within the "events" attribute with the "event" attribute set to "BAT\_OFFSET\_INFO"; +- interact with the PCF for the received UE address: + - a) if the TSCTSF has an AF-session with the PCF for the received UE address, the TSCTSF shall interact with the PCF by triggering a Npcf\_PolicyAuthorization\_Update request to provision the related parameters to the PCF as defined in 3GPP TS 29.514 [20]; or + - b) if the TSCTSF does not have an AF-Session with the PCF for the received UE address, the TSCTSF shall discover the PCF for the PDU session as specified in 3GPP TS 29.521 [23], and shall interact with the PCF by triggering a Npcf\_PolicyAuthorization\_Create to provision the related parameters to the PCF as defined in 3GPP TS 29.514 [20]; and + +NOTE 2: If the PCF determines an existing PDU Session is related with TSC traffic (based on local configuration or SM Policy Association), the PCF invokes Npcf\_PolicyAuthorization\_Notify service operation to the TSCTSF as defined in clause 4.2.5.16 of 3GPP TS 29.514 [20] to send the received TSC User Plane Node information. At that time, the TSCTSF retrieves from the BSF the PCF binding information, as specified in 3GPP TS 29.521 [23], and can create the AF-session by sending to the PCF the Npcf\_PolicyAuthorization\_Create service operation, if TSC related information, as e.g. QoS requirements, and/or subscription to PMIC(s)/UMIC updates need to be provided to the PCF. + +NOTE 3: After the TSCTSF retrieves from the BSF the PCF binding information (including the UE Identities for the notified PDU session), as specified in 3GPP TS 29.521 [23], the TSCTSF can store internally the received information and delay the Npcf\_PolicyAuthorization\_Create service operation (the creation of the AF-session). In this case, when the TSCTSF receives the QoS request, the TSCTSF interacts with the PCF by triggering a Npcf\_PolicyAuthorization\_Create request to provision the related parameters to the PCF as defined in 3GPP TS 29.514 [20]. + +- if receiving a successful response from the PCF, the TSCSTF shall create an "Individual TSC Application Session Context" resource and send to the NF service consumer a "201 Created" response to the HTTP POST request, as shown in figure 5.3.2.2.2-1, step 2. If the "evSubsc" attribute is received, the "Events Subscription" sub-resource shall be created within the "Individual TSC Application Session Context" resource. The TSCTSF shall include in the "201 Created" response: + +- a) a Location header field; and +- b) a "TscAppSessionContextData" data type in the content. + +The Location header field shall contain the URI of the created "Individual TSC Application Session Context" i.e. "{apiRoot}/ntscstf-qos-tscai//tsc-app-sessions/{appSessionId}". + +When "Events Subscription" sub-resource is created in this procedure, the NF service consumer shall build the sub-resource URI by adding the path segment "/events-subscription" at the end of the URI path received in the Location header field. + +If the TSCTSF cannot successfully fulfil the received HTTP POST request due to the internal TSCTSF error or due to the error in the HTTP POST request, the TSCTSF shall send the HTTP error response as specified in clause 6.2.7. + +The TSCTSF may send the following error responses based on failed AF-session creation/update request responses received from the PCF as specified in 3GPP TS 29.514 [20]: + +- a. If the TSCSTSF receives the indication that the PCF failed in executing session binding, the TSCTSF shall reject the HTTP POST request with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "PDU\_SESSION\_NOT\_AVAILABLE". +- b. If the service information provided in the body of the HTTP POST request is rejected by the PCF (e.g. the subscribed guaranteed bandwidth for a particular user is exceeded or the authorized data rate in that slice for a UE is exceeded), the TSCTSF shall indicate in an HTTP "403 Forbidden" response message the cause for the rejection including the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED", as received. +- c. If the service information provided in the body of the HTTP POST request is rejected due to a temporary condition in the network, the TSCTSF may include in the "403 Forbidden" response the "cause" attribute set to "REQUESTED\_SERVICE\_TEMPORARILY\_NOT\_AUTHORIZED". The TSCTSF may also provide a received retry interval within the "Retry-After" HTTP header field. When the NF service consumer receives the retry interval within the "Retry-After" HTTP header field, the NF service consumer shall not send the same service information to the TSCTSF again (for the same application session context) until the retry interval has elapsed. The "Retry-After" HTTP header is described in 3GPP TS 29.500 [4] clause 5.2.2.2. + +The TSCTSF may additionally provide the received acceptable bandwidth within the attribute "acceptableServInfo" included in the "ProblemDetailsTscstfQoS" data structure returned in the rejection response message. + +### 5.3.2.2.3 Subscriptions to Service Data Flow QoS notification control + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 5.3.2.2.2 and shall include in the HTTP POST request message an event within the "evSubsc" attribute with the "event" attribute set to + +"QOS\_GUARANTEED" and an event within the "evSubsc" attribute with the "event" attribute set to "QOS\_NOT\_GUARANTEED". + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2. + +As result of this action, the TSCTSF shall set the appropriate subscription to QoS notification control as described in in 3GPP TS 29.514 [20]. + +#### 5.3.2.2.4 Subscription to Service Data Flow Deactivation + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 5.3.2.2.2 and shall include in the HTTP POST request message an event entry within the "evSubsc" attribute with the "event" attribute set to "FAILED\_RESOURCES\_ALLOCATION". + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2. + +As result of this action, the TSCTSF shall set the appropriate subscription to service data flow deactivation as described in in 3GPP TS 29.514 [20]. + +#### 5.3.2.2.5 Subscription to resources allocation outcome + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 5.3.2.2.2 and shall include in the HTTP POST request message: + +- if the NF service consumer requests the TSCTSF to provide a notification when the resources associated to the service information have been allocated, an event entry within the "events" attribute with the "event" attribute set to "SUCCESSFUL\_RESOURCES\_ALLOCATION"; and/or +- if the NF service consumer requests the TSCTSF to provide a notification when the resources associated to the service information cannot be allocated, an event entry within the "events" attribute with the "event" attribute set to "FAILED\_RESOURCES\_ALLOCATION". + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2. + +As result of this action, the TSCTSF shall set the appropriate subscription to notification of resources allocation outcome as described in in 3GPP TS 29.514 [20]. + +#### 5.3.2.2.6 Subscriptions to Service Data Flow QoS Monitoring Information + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 5.3.2.2.2 and shall include in the HTTP POST request message an event within the "evSubsc" attribute with the "event" attribute set to "QOS\_MONITORING" and include the QoS monitoring information with the "qosMon" attribute. Within the QosMonitoringInformation data structure, the AF shall include: + +- one or more requested QoS Monitoring Parameter(s) within the "reqQosMonParams"; and +- one or more report frequency within the "repFreqs" attribute; and +- when the "repFreqs" attribute includes the value "PERIODIC", the periodic time for reporting and, if the feature "PacketDelayFailureReport" is supported, the maximum period with no QoS measurement results reported within the "repPeriod" attribute; and +- when the "repFreqs" attribute includes the value "EVENT\_TRIGGERED", the AF shall include: + - the minimum waiting time between subsequent reports within the "waitTime" attribute; andfor QoS monitoring for packet delay: + - the delay threshold for downlink with the "repThreshDI" attribute; + - the delay threshold for uplink with the "repThreshUI" attribute; and/or + - the delay threshold for round trip with the "repThreshRp" attribute; and + +- if the feature "PacketDelayFailureReport" is supported, the maximum period with no QoS measurement results reported within the "repPeriod" attribute. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2. + +As result of this action, the TSCTSF shall set the appropriate subscription to service data flow QoS monitoring information as described in in 3GPP TS 29.514 [20]. + +#### 5.3.2.2.7 Initial provisioning of sponsored connectivity information + +The NF service consumer may include in the HTTP POST request message described in clause 5.3.2.2.2 an application service provider identity and a sponsor identity within the "aspId" attribute and "sponId" attribute. Additionally, the NF service consumer may provide an indication to the TSCTSF of sponsored data connectivity not enabled by including the "sponStatus" attribute set to "SPONSOR\_DISABLED". + +To support the usage monitoring of sponsored data connectivity, the NF service consumer may subscribe with the TSCTSF to the notification of usage threshold reached. The NF service consumer may also include the "evSubsc" attribute with: + +- the usage thresholds to apply in the "usgThres" attribute; and +- an entry of the "events" attribute set to "USAGE\_REPORT". + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2. + +As result of this action, the TSCTSF shall provision the sponsored data connectivity information to the PCF as described in 3GPP TS 29.514 [20]. + +The TSCTSF may send the following error responses based on the response to the provisioning of sponsored data connectivity information received from the PCF, as described in 3GPP TS 29.514 [20], as follows: + +- HTTP "403 Forbidden" response message with the "cause" attribute set to "UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY", when received from the PCF. +- HTTP "403 Forbidden" response message the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED", when received from the PCF. + +#### 5.3.2.2.8 Initial provisioning of AF requested QoS for a UE or group of UE(s) not identified by UE address + +When the "GMEC" feature is supported, if the NF service consumer includes in the HTTP POST request message described in clause 5.3.2.2.2 the targeted UE identified by its GPSI, within the "ueId" attribute, or the targeted group of UE(s) identified by its External Group ID, within the "externalGroupId" attribute, the provisions of clause 5.3.2.2.2 shall apply with the following differences: + +- the AF request information may include: + - the Temporal invalidity conditions, within the "tempInvalidity" attribute; + - the traffic characteristics information, within the "evSubsc" attribute; + - the QoS parameters for monitoring, within the "tscQosReq" attribute; + - the QoS parameters, within either the "qosReference" attribute, the "altQosReferences" attribute or the "altQosReqs" attribute; and/or + - the flow description, within either the "flowInfo" attribute or the "enEthFlowInfo" attribute. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2 with the following differences: + +- upon reception of the HTTP request from the NF service consumer, and if the request is authorized, the TSCTSF shall: + - create a new "Individual TSC Application Session Context" resource; + +- if the "externalGroupId" attribute is received from the NF service consumer, interact with the UDM to retrieve the list of SUPI(s) identifying the UE(s) constituting the targeted group of UE(s) using the Nudm\_SDM service as defined in 3GPP TS 29.503 [24]; +- if the "ueId" attribute is received from the NF service consumer, interact with the UDM to retrieve the SUPI that corresponds to the targeted GPSI using the Nudm\_SDM service as defined in 3GPP TS 29.503 [24]; +- use the parameters received from the NF service consumer (i.e., DNN, S-NSSAI and, if available, the identifier of the targeted UE or group of UE(s) to determine the corresponding AF-session(s) (i.e., to which they match); and +- for each matching AF-session interact with the PCF by invoking the Npcf\_PolicyAuthorization\_Create/Update service operation as defined in 3GPP TS 29.514 [20] to create/update the AF session based on the provided requested QoS parameters; and + +NOTE 1: If the PCF determines that an existing PDU Session is potentially impacted by the time synchronization service (based on local configuration or SM Policy Association), the PCF invokes Npcf\_PolicyAuthorization\_Notify service operation towards the TSCTSF as defined in clause 4.2.5.16 of 3GPP TS 29.514 [20] to send the received TSC User Plane Node information. The TSCTSF then retrieves from the BSF the PCF binding information (including the UE Identities for the notified PDU session), as specified in 3GPP TS 29.521 [23], and can create the AF-session by invoking the Npcf\_PolicyAuthorization\_Create service operation towards the PCF. + +- the TSCTSF shall handle the AF session(s) associated with a given "Individual TSC Application Session Context" resource as follows: + - For the association of the AF session(s) at the PCF to the "Individual TSC Application Session Context" resource: + - a. Upon PDU Session establishment, i.e. when the TSCTSF receives a Npcf\_PolicyAuthorization\_Notify service operation following the establishment of a new PDU session, the TSCTSF shall retrieve from the BSF, as specified in 3GPP TS 29.521 [23], the PCF binding information to complete the necessary AF-Session information. The TSCTSF shall then trigger the Npcf\_PolicyAuthorization\_Create service operation towards the PCF to create an AF-session to subscribe to TSC user plane node related events. The TSCTSF shall use the parameters of the existing "Individual TSC Application Session Context" resources to determine whether they shall be associated to this newly created AF session. The TSCTSF associates the new AF session to the "Individual TSC Application Session Context" resource to which these parameters match. + - b. Upon "Individual TSC Application Session Context" resource creation, the TSCTSF uses the parameters of the created resource to determine which existing AF session(s) it matches. The TSCTSF then associates the new "Individual TSC Application Session Context" resource to the corresponding AF session(s). + - To remove an AF session from the list of AF session(s) associated to an "Individual TSC Application Session Context" resource, when the TSCTSF receives the Npcf\_PolicyAuthorization\_Notify service operation from the PCF indicating the termination of the corresponding existing PDU session, the TSCTSF triggers the Npcf\_PolicyAuthorization\_Delete service operation towards the PCF and determines if the corresponding AF session is associated with the "Individual TSC Application Session Context" resource. If it is so, the TSCTSF shall remove the AF session from the list of AF session(s) associated with the "Individual TSC Application Session Context" resource. + +NOTE 2: After the TSCTSF retrieves from the BSF the PCF binding information (including the UE Identities for the notified PDU session), as specified in 3GPP TS 29.521 [23], the TSCTSF can store internally the information required to invoke Npcf\_PolicyAuthorization\_Create service operation and delay the Npcf\_PolicyAuthorization\_Create service operation (the creation of the AF session) till a request is received for the concerned UE (time synchronization capability exposure or QoS provisioning request). In this case, when the TSCTSF receives the request, the TSCTSF interacts with the PCF by triggering Npcf\_PolicyAuthorization\_Create service operation as defined in 3GPP TS 29.514 [20]. + +NOTE 3: When the TSCTSF receives the Npcf\_PolicyAuthorization\_Notify service operation indicating the termination of an existing PDU session associated to an AF session that it is not associated with any "Individual Time Synchronization Exposure Subscription" resource and "Individual TSC Application Session Context resource" resource, the TSCTSF removes the AF-session and triggers the Npcf\_PolicyAuthorization\_Delete service operation towards the PCF. + +#### 5.3.2.2.9 Subscription to BAT offset notification + +When the "EnTSCAC" feature is supported, The NF service consumer shall use the "EventsSubscReqData" data type and shall include in the HTTP POST request message an event entry within the "evSubsc" attribute with the "event" attribute set to "BAT\_OFFSET\_INFO" to subscribe to receive a notification when AF provides the Capability for BAT adaptation or BAT Window as defined in clause 5.3.2.2.2. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.2.2. + +As result of this action, the TSCTSF shall set the appropriate subscription to BAT offset notification as described in 3GPP TS 29.514 [20]. + +#### 5.3.2.3 Ntsctsf\_QoSandTSCAssistance\_Update + +##### 5.3.2.3.1 General + +This service operation is used by an NF service consumer to request the network to update the QoS and/or additional Alternative QoS for an AF session. + +The following procedures using the Ntsctsf\_QoSandTSCAssistance\_Update service operation are supported: + +- Modification of TSC related service information. +- Modification of Subscription to Service Data Flow QoS notification control. +- Modification of Subscription to Service Data Flow Deactivation. +- Modification of subscription to resources allocation outcome. +- Modification of Subscription to Service Data Flow QoS Monitoring Information. +- Modification of sponsored connectivity information. +- Modification of AF the requested QoS for a UE or a group of UE(s) not identified by UE address. +- Modification of subscription to BAT offset notification. + +##### 5.3.2.3.2 Modification of TSC related service information + +This procedure is used to modify an existing TSC application session context as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.3.2.3.2-1 illustrates the modification of TSC related service information using HTTP PATCH method. + +![Sequence diagram showing the modification of TSC related service information using HTTP PATCH. The NF service consumer sends a PATCH request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content.](329c96049bb432e9c2cbda4e224a0c9c_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. PATCH « /tsc-app-sessions/{appSessionId} » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2a. "200 OK" +2b. "204 No Content" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the modification of TSC related service information using HTTP PATCH. The NF service consumer sends a PATCH request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content. + +**Figure 5.3.2.3.2-1: Modification of TSC related service information using HTTP PATCH** + +The NF service consumer may modify the TSC application session context information at any time and invoke the Ntsctsf\_QoSAndTSCAssistance\_Update service operation by sending the HTTP PATCH request message to the resource URI representing the "Individual TSC Application Session Context" resource, as shown in figure 5.3.2.3.2-1, step 1, with the modifications to apply. + +The JSON body within the PATCH request shall include the "TscAppSessionContextUpdateData" data type and shall be encoded according to "JSON Merge Patch", as defined in IETF RFC 7396 [22]. + +The NF service consumer may include in the "TscAppSessionContextUpdateData" data structure: + +- the updated flow information within the "flowInfo" attribute for IP flows or, either the "ethFlowInfo" or, if the Ethernet\_UL/DL\_Flows feature is supported, the "enEthFlowInfo" attribute for Ethernet flows; +- the updated application Id within the "appId" attribute; +- the updated QoS reference within the "qosReference" attribute or the updated individual QoS parameter set within the "tscQosReq" attribute; +- the updated input information to construct the TSC Assistance Container within the "tscaiInputUI" attribute and/or "tscaiInputDI" attribute of the "tscQosReq" attribute, and/or the updated (g)PTP domain that the AF is located in within the "tscaiTimeDom" attribute of the "tscQosReq" attribute; +- if the "EnTSCAC" feature is supported, the capability for BAT adaptation in the "capBatAdaptation" attribute; +- the updated URI where the TSCTSF can request to the NF service consumer to delete the "Individual TSC Application Session Context" resource within the "notifUri". +- the updated ordered list of alternative QoS references within the "altQosReferences" attribute or updated ordered list of requested alternative QoS parameters set(s) within the "altQosReqs" attribute; and +- the updated event subscription information within the "evSubsc" attribute. Within the EventsSubscReqDataRm data structure, the NF service consumer shall include: + - the new complete list of subscribed events within the "events" attribute; + - when the NF service consumer requests to update the additional information related to an event (e.g. the NF service consumer needs to provide new thresholds to the TSCTSF in the "usgThres" attribute related to the "USAGE\_REPORT" event), the additional information within the corresponding attribute(s). + +NOTE 2: Note that when the NF service consumer requests to remove an event, this event is not included in the "events" attribute. + +NOTE 3: When an event is included in the "events" attribute and its related additional information is set to null, the TSCTSF considers the subscription to this event is active, but the related procedures stop applying. + +NOTE 4: When an event is removed from the "events" attribute but its related information is not set to null, the TSCTSF considers the subscription to this event is terminated, the related additional information is removed, and the related procedures stop applying. + +The NF service consumer shall remove existing event subscription information by setting to null the "evSubsc" attribute included in "TscAppSessionContextUpdateData". + +NOTE 5: The "notifiUri" attribute within the EventsSubscReqData data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +Upon the reception of this HTTP PATCH request, the TSCTSF shall + +- if the updated Requested 5GS delay including the requested 5GS delay within the individual QoS parameter set or within the requested alternative QoS parameters set(s) is received from NF service consumer, re-calculate a Requested PDB by subtracting the UE-DS-TT residence time provided by the PCF or pre-configured in the TSCTSF from the Requested 5GS delay; +- update the TSC Assistance Container based on updated information provided by the NF service consumer; +- if the time domain information is not received with the Burst Arrival Time or Periodicity within the "tscQosReq" attribute from the NF service consumer, the TSCTSF may indicate Time Domain = "5GS" within the "tscaiTimeDom" attribute within the "tscQosReq" attribute to indicate that the NF service consumer does not provide the time domain information; + +NOTE 6: The Time Domain value corresponding to "5GS" is locally configured in the SMF and in the TSCTSF, and indicates that the AF does not provide a Time Domain and the provided TSCAI input information will be used without adjustments. + +- if the feature EnTSCAC is supported and if the NF service consumer during the modification includes the capability for BAT adaptation within the "capBatAdaptation" attribute or a BAT window within the "burstArrivalTimeWnd" attribute within the "tscaiInputUI" attribute and/or "tscaiInputDI" attribute of the "tscQosReq" attribute or the periodicity range in the "periodicityRange" attribute in the update request, then the TSCTSF shall subscribe to the notification on BAT offset by using the "EventsSubscReqDataRm" data type including an event within the "events" attribute with the "event" attribute set to "BAT\_OFFSET\_INFO"; +- interact with the PCF by triggering a Npcf\_PolicyAuthorization\_Update request to provision the related parameters to the PCF as defined in 3GPP TS 29.514 [20]; +- if receiving a successful response from the PCF, the TSCTSF shall update the "Individual TSC Application Session Context" resource and send a "200 OK" or "204 No Content" response to the HTTP POST request to the NF service consumer, as shown in figure 5.3.2.3.2-1, step 2. + +If the TSCTSF cannot successfully fulfil the received HTTP PATCH request due to the internal TSCTSF error or due to the error in the HTTP PATCH request, the TSCTSF shall send the HTTP error response as specified in clause 6.2.7. + +The TSCTSF may send the following error responses based on failed AF-session update responses received from the PCF as specified in 3GPP TS 29.514 [20]: + +- a. If the updated service information is not acceptable for the PCF (e.g. the subscribed guaranteed bandwidth for a particular user is exceeded or the authorized data rate in that slice for the UE is exceeded), the TSCTSF shall indicate in an HTTP "403 Forbidden" response message the received cause for the rejection including the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED". +- b. If the service information provided in the body of the HTTP POST request is rejected due to a temporary condition in the network, the TSCTSF may include in the "403 Forbidden" response the "cause" attribute set to "REQUESTED\_SERVICE\_TEMPORARILY\_NOT\_AUTHORIZED". The TSCTSF may also provide a received retry interval within the "Retry-After" HTTP header field. When the NF service consumer receives the retry interval within the "Retry-After" HTTP header field, the NF service consumer shall not send the same service information to the TSCTSF again (for the same application session context) until the retry interval has elapsed. The "Retry-After" HTTP header is described in 3GPP TS 29.500 [4] clause 5.2.2.2. + +The TSCTSF may additionally provide the acceptable bandwidth within the attribute "acceptableServInfo" included in the "ProblemDetailsTsctsfQosTscac" data structure returned in the rejection response message. + +If the TSCTSF determines the received HTTP PATCH request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 5.3.2.3.3 Modification of Subscription to Service Data Flow QoS notification control + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual TSC Application Sessions" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 5.3.2.3.2, the updated event subscription information within the "evSubsc" attribute. Within the EventsSubscReqDataRm data type, the NF service consumer shall include the "events" attribute with the "QOS\_GUARANTEED" and "QOS\_NOT\_GUARANTEED" values to indicate the subscription to QoS notification control or include the "events" but without the "QOS\_GUARANTEED" and "QOS\_NOT\_GUARANTEED" values to indicate the termination of the subscription to QoS notification control. + +As result of this action, the TSCTSF shall set the appropriate subscription to QoS notification control as described in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. + +The TSCTSF may send the following error responses based on the response to the provisioning of sponsored data connectivity information received from the PCF, as described in 3GPP TS 29.514 [20], as follows: + +- HTTP "403 Forbidden" response message with the "cause" attribute set to "UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY", when received from the PCF. +- HTTP "403 Forbidden" response message the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED", when received from the PCF. + +#### 5.3.2.3.4 Modification of Subscription to Service Data Flow Deactivation + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual TSC Application Sessions" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 5.3.2.3.2, the updated event subscription information within the "evSubsc" attribute. Within the EventsSubscReqDataRm data type, the NF service consumer shall include the "events" attribute with the "FAILED\_RESOURCES\_ALLOCATION" values to the subscription to service data flow deactivation or include the "events" but without "FAILED\_RESOURCES\_ALLOCATION" value to indicate the termination of the subscription to Service Data Flow Deactivation. + +As result of this action, the TSCTSF shall set the appropriate subscription to QoS notification control as described in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. + +#### 5.3.2.3.5 Modification of subscription to resources allocation outcome + +The NF service consumer shall use the HTTP PATCH method to modify the "Events Subscription" sub-resource together with the modifications to the "Individual TSC Application Sessions" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 5.3.2.3.2, the updated event subscription information within the "evSubsc" attribute. Within the EventsSubscReqDataRm data type, the NF service consumer shall include the "events" attribute with the "SUCCESSFUL\_RESOURCES\_ALLOCATION" value for the successful resource allocation and/or "FAILED\_RESOURCES\_ALLOCATION" value for the unsuccessful resource allocation to the subscription to resources allocation outcome or include the "events" but without "SUCCESSFUL\_RESOURCES\_ALLOCATION" and/or "FAILED\_RESOURCES\_ALLOCATION" value to indicate the termination of the subscription to resources allocation outcome. + +As result of this action, the TSCTSF shall set the appropriate subscription to resources allocation outcome as described in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. + +#### 5.3.2.3.6 Modification of Subscription to Service Data Flow QoS Monitoring Information + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual TSC Application Sessions" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 5.3.2.3.2, the updated event subscription information within the "evSubsc" attribute. Within the EventsSubscReqDataRm data type, the NF service consumer shall perform as follows: + +- to create a subscription to QoS monitoring information: + - a) include the "events" attribute with the "QOS\_MONITORING" value; and + - b) include the updated QoS monitoring information within the "qosMon" attribute as defined in clause 5.3.2.2.6; +- to remove a subscription to QoS monitoring information: + - a) include the "events" attribute without "QOS\_MONITORING". + +As result of this action, the TSCTSF shall set the appropriate subscription to Service Data Flow QoS Monitoring Information as described in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. + +#### 5.3.2.3.7 Modification of sponsored connectivity information + +The NF service consumer shall use the HTTP PATCH method to modify the sponsored connectivity information. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 5.3.2.3.2, an application service provider identity and a sponsor identity within the "aspId" attribute and "sponId" attribute, and optionally an indication of whether to enable or disable sponsored data connectivity within the "sponStatus" attribute set to the applicable value to provide sponsored connectivity information or to update existing sponsored connectivity information. + +If the NF service consumer requests to enable sponsored data connectivity the NF service consumer shall change the "sponStatus" attribute value to "SPONSOR\_ENABLED". + +If the NF service consumer requests to disable sponsored data connectivity the NF service consumer shall provide an indication to disable sponsored data connectivity to the TSCTSF by setting the "sponStatus" attribute to "SPONSOR\_DISABLED". + +To support the usage monitoring of sponsored data connectivity, the NF service consumer may also include in the HTTP PATCH a new or modified "evSubsc" attribute with: + +- the usage thresholds to apply in the "usgThres" attribute; and +- an entry of the "events" attribute set to "USAGE\_REPORT". + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. + +As result of this action, the TSCTSF shall provision the updated sponsored data connectivity information to the PCF as described in 3GPP TS 29.514 [20]. + +#### 5.3.2.3.8 Modification of AF requested QoS for a UE or group of UE(s) not identified by UE address + +When the "GMEC" feature is supported, the NF service consumer shall use the HTTP PATCH method to modify the requested QoS, traffic characteristics information and/or QoS Monitoring information for a UE or a group of UE(s). + +The NF service consumer shall include in the HTTP PATCH request message the parameters to modify as described in clause 5.3.2.3.2, with the following differences: + +- To support the request the modification of requested QoS, the traffic characteristics and monitoring of performance characteristics for a group, the NF service consumer may modify: + +- the traffic characteristics information, within the "evSubsc" attribute; +- the QoS parameters for monitoring, within the "tscQosReq" attribute; +- the QoS parameters, within either the "qosReference" attribute, the "altQosReferences" attribute or the "altQosReqs" attribute; +- the temporal invalidity conditions, within the "tempInvalidity" attribute; and +- the flow description, within either the "flowInfo" attribute or the "enEthFlowInfo" attribute. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. + +As result of this action, the TSCTSF shall, for the list of matching AF-session(s) associated to the "Individual TSC Application Session Context" resource, provision to the PCF the updated requested QoS, traffic characteristics and/or QoS Monitoring information by the triggering Npcf\_PolicyAuthorization\_Update service operation as defined in 3GPP TS 29.514 [20]. + +### 5.3.2.3.9 Modification of Subscription to BAT offset notification + +When the "EnTSCAC" feature is supported, this procedure is used to modify in the TSCTSF the subscription to the BAT offset information notification. + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the " Individual TSC Application Session" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 5.3.2.3.2, the updated event subscription information within the "evSubsc" attribute. Within the EventsSubscReqDataRm data type, the NF service consumer shall include the "events" attribute with the "BAT\_OFFSET\_INFO" to indicate the subscription to changes of the BAT offset and the optionally adjusted periodicity. + +As result of this action, the TSCTSF shall set the appropriate subscription to resources allocation outcome as described in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.3.2. The TSCTSF shall include the "evsNotif" attribute with an entry in the "evNotifs" array with the "event" attribute set to "BAT\_OFFSET\_INFO" and the "batOffsetInfo" attribute including the offset of the BAT and optionally an adjusted periodicity if the TSCTSF has previously subscribed with the PCF to changes in this information. + +### 5.3.2.4 Ntsctsf\_QoSandTSCAssistance\_Delete + +#### 5.3.2.4.1 General + +This service operation is used by an NF service consumer to request the network to delete the AF session with requested QoS or the AF session with requested QoS including Alternative Service Requirements. + +The following procedures using the Ntsctsf\_QoSandTSCAssistance\_Delete service operation are supported: + +- TSC AF application session context termination. +- Reporting usage for sponsored data connectivity. +- TSC AF application session context termination for a UE or group of UE(s) not identified by UE address. + +#### 5.3.2.4.2 TSC AF application session context termination + +This procedure is used to terminate an AF application session context for the service as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.3.2.4.2-1 illustrates the application session context termination. + +![Sequence diagram showing application session context termination between an NF service consumer and a TSCTSF. Step 1: POST /tsc-app-sessions/{appSessionId}/delete from consumer to TSCTSF. Step 2: Response from TSCTSF to consumer, either 2a. '200 OK' or 2b. '204 No Content'.](8e80de0cac529b2c3775d677c5203133_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST « /tsc-app-sessions/{appSessionId}/delete » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2a. "200 OK" +2b. "204 No Content" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing application session context termination between an NF service consumer and a TSCTSF. Step 1: POST /tsc-app-sessions/{appSessionId}/delete from consumer to TSCTSF. Step 2: Response from TSCTSF to consumer, either 2a. '200 OK' or 2b. '204 No Content'. + +**Figure 5.3.2.4.2-1: Application session context termination** + +When a TSC AF session is terminated, and if the TSC AF application session context was created as described in clause 5.3.2.2, the NF service consumer shall invoke the Ntscsf\_QoSandTSCAssistance\_Delete service operation to the TSCTSF using an HTTP POST request, as shown in figure 5.3.2.4.2-1, step 1. + +The NF service consumer shall set the request URI to + "{apiRoot}/ntscsf-qos-tscai/{apiVersion}/tsc-app-sessions/{appSessionId}/delete". + +The NF service consumer may include in the body of the HTTP POST the "EventsSubscReqData" data type with the "evSubsc" attribute indicating the corresponding list of events to subscribe to. + +When the TSCTSF receives the HTTP POST request from the NF service consumer, indicating the termination of the TSC AF application session context information, the TSCTSF shall acknowledge that request by sending an HTTP response message with the corresponding status code. + +If the HTTP POST request from the NF service consumer is accepted, the TSCTSF shall send to the NF service consumer: + +- if event information is reported, TSCTSF shall defer sending the response to the NF service consumer and shall immediately interact with the PCF to terminate the AF session with the event report, as specified in 3GPP TS 29.514 [20]. After receiving the event information from the PCF, the TSCTSF shall send a "200 OK" response to HTTP POST request, as shown in figure 5.3.2.4.2-1, step 2a, including in the "EventsNotification" to report to the NF service consumer; +- otherwise, the TSCTSF shall send to the NF service consumer a "204 No Content". + +If the TSCTSF cannot successfully fulfil the received HTTP POST request due to the internal TSCTSF error or due to the error in the HTTP POST request, the TSCTSF shall send the HTTP error response as specified in clause 6.2.7. + +If the TSCTSF determines the received HTTP POST request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 5.3.2.4.3 Reporting usage for sponsored data connectivity + +When The NF service consumer indicated to enable sponsored data connectivity and the NF service consumer provided usage thresholds for such sponsor to the TSCTSF, the TSCTSF shall report accumulated usage to the NF service consumer using the response of the Ntscsf\_QoSandTSCAssistance\_Delete service operation. + +This procedure is initiated when: + +- the "Individual TSC Application Session" is deleted by the NF service consumer; or +- the TSCTSF requests the deletion of the "Individual TSC Application Session" to the NF service consumer, as described in clause 5.2.2.5.3, due to PDU session termination, the termination of all the service data flows of the Individual TSC Application Session. + +To report the accumulated usage, the TSCTSF shall immediately configure the PCF to retrieve the accumulated usage as specified in 3GPP TS 29.514 [20]. When the TSCTSF receives the usage information from the PCF, the TSCTSF shall notify the NF service consumer by including the "EventsNotification" data type in the response of the HTTP POST request as described in clause 5.3.2.4.2. + +The TSCTSF shall within an instance of "events" attribute include: + +- "USAGE\_REPORT" within the "event" attribute; +- accumulated usage within the "usgRep" attribute. + +#### 5.3.2.4.4 TSC AF application session context termination for a UE or group of UE(s) not identified by UE address + +When the "GMEC" feature is supported, the NF service consumer shall use the HTTP POST method to terminate the requested QoS, traffic characteristics information and/or QoS Monitoring information for a UE or a group of UE(s) as described in clause 5.3.2.4.2 with the following differences: + +- the TSCTSF shall identify the affected AF session(s) and, for each AF session, interact with the PCF by triggering the Npcf\_PolicyAuthorization\_Delete service operation as defined in 3GPP TS 29.514 [20], if the AF session is not associated with an "Individual Time Synchronization Exposure Subscription" resource. + +#### 5.3.2.5 Ntsctsf\_QoSandTSCAssistance\_Notify + +##### 5.3.2.5.1 General + +The Ntsctsf\_QoSandTSCAssistance\_Notify service operation enables notification to NF service consumers that the previously subscribed event for the existing TSC application session context occurred or that the TSC application session context is no longer valid. + +The following procedures using the Ntsctsf\_QoSandTSCAssistance\_Notify service operation are supported: + +- Notification about TSC application session context event. +- Notification about TSC application session context termination. +- Notification about Service Data Flow QoS notification control. +- Notification about Service Data Flow Deactivation +- Notification about resources allocation outcome. +- Notification about Service Data Flow QoS Monitoring control. +- Reporting usage for sponsored data connectivity. +- Notification about AF requested QoS for a UE or group of UE(s) not identified by UE address. +- Notification about BAT offset. + +##### 5.3.2.5.2 Notification about TSC application session context event + +This procedure is invoked by the TSCTSF to notify the NF service consumer when a certain, previously subscribed, application session context event occurs, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.3.2.5.2-1 illustrates the notification about TSC application session context event. + +![Sequence diagram showing notification about application session context event between NF service consumer and TSCTSF.](be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of TSCTSF: 1. POST « {/notifUri}/notify + TSCTSF->>NF service consumer: 1. POST « {/notifUri}/notify + Note left of NF service consumer: 2. "204 No Content" + NF service consumer-->>TSCTSF: 2. "204 No Content" +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and a TSCTSF. The first message, labeled '1. POST « {/notifUri}/notify', is sent from the TSCTSF to the NF service consumer. The second message, labeled '2. "204 No Content"', is sent from the NF service consumer back to the TSCTSF. + +Sequence diagram showing notification about application session context event between NF service consumer and TSCTSF. + +**Figure 5.3.2.5.2-1: Notification about application session context event** + +When the TSCTSF determines that the event for the existing TSC AF application session context, to which the NF service consumer has subscribed to, occurred e.g. upon reception of an event notification for a PDU session from the PCF as described in 3GPP TS 29.514 [20], the TSCTSF shall invoke the Ntsctsf\_QoSAndTSCAssistance\_Notify service operation by sending the HTTP POST request (as shown in figure 5.3.2.5.2-1, step 1) to the NF service consumer using the notification URI received in the subscription creation (or modification), as specified in clause 5.3.2.2.2, 5.3.2.3.2, and 5.3.2.6, and appending the "notify" segment path at the end of the URI. The TSCTSF shall provide in the body of the HTTP POST request the "EventsNotification" data type including: + +- the notification correlation Id within the "notifCorreId"; and +- the list of the reported events in the "events" attribute. + +The NF service consumer notification of other specific events using the Ntsctsf\_QoSAndTSCAssistance\_Notify request is described in the related clauses. + +Upon the reception of the HTTP POST request from the TSCTSF indicating that the PDU session and/or service related event occurred, the NF service consumer shall acknowledge that request by sending an HTTP response message with the corresponding status code. + +If the HTTP POST request from the TSCTSF is accepted, the NF service consumer shall acknowledge the receipt of the event notification with a "204 No Content" response to HTTP POST request, as shown in figure 5.3.2.5.2-1, step 2. + +If the HTTP POST request from the TSCTSF is not accepted, the NF service consumer shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.2.7. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +### 5.2.2.5.3 Notification about TSC application session context termination + +This procedure is invoked by the TSCTSF to notify the NF service consumer that the TSC application session context is no longer valid, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.2.2.5.3-1 illustrates the notification about application session context termination. + +![Sequence diagram showing the notification about TSC application session context termination between an NF service consumer and a TSCTSF. Step 1: The TSCTSF sends a POST request to the NF service consumer with the URI '{notifUri}/terminate'. Step 2: The NF service consumer responds with a '204 No Content' status code.](a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of TSCTSF: 1. POST « {notifUri}/terminate » + TSCTSF->>NF service consumer: Request + Note left of NF service consumer: 2. "204 No Content" + NF service consumer->>TSCTSF: Response + +``` + +Sequence diagram showing the notification about TSC application session context termination between an NF service consumer and a TSCTSF. Step 1: The TSCTSF sends a POST request to the NF service consumer with the URI '{notifUri}/terminate'. Step 2: The NF service consumer responds with a '204 No Content' status code. + +**Figure 5.2.2.5.3-1: Notification about TSC application session context termination** + +When the TSCTSF determines that the TSC application session context is no longer valid, the TSCTSF shall invoke the Ntscsfsf\_QoSAndTSCAssistance\_Notify service operation by sending the HTTP POST request (as shown in figure 5.2.2.5.3-1, step 1) using the notification URI received in the "Individual TSC Application Session Context" context creation, as specified in clause 5.3.2.2, and appending the "terminate" segment path at the end of the URI, to trigger the NF service consumer to request the TSC application session context termination (see clause 5.3.2.4.2). The TSCTSF shall provide in the body of the HTTP POST request the "TerminationInfo" data type including: + +- the Individual TSC Application Session Context resource identifier related to the termination notification in the "resUri" attribute; and +- the TSC application session context termination cause in the "termCause" attribute. + +Upon the reception of the HTTP POST request from the TSCTSF requesting the TSC application session context termination, the NF service consumer shall acknowledge that request by sending an HTTP response message with the corresponding status code. + +If the HTTP POST request from the TSCTSF is accepted, the NF service consumer shall acknowledge the receipt of the TSC application session context termination request with a "204 No Content" response to HTTP POST request (as shown in figure 5.2.2.5.3-1, step 2) and shall invoke the Ntscsfsf\_QoSAndTSCAssistance\_Delete service operation to the TSCTSF as described in clause 5.3.2.4. + +If the HTTP POST request from the TSCTSF is not accepted, the NF service consumer shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.2.7. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +#### 5.3.2.5.4 Notification about Service Data Flow QoS notification control + +When the TSCTSF receives the notification about Service Data Flow QoS notification control from the PCF as described in 3GPP TS 29.514 [20], the TSCTSF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 5.3.2.2.3 and 5.3.2.3.3. + +The TSCTSF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. + +The TSCTSF shall within an instance of "events" attribute include: + +- "QOS\_GUARANTEED" or "QOS\_NOT\_GUARANTEED" within the "event" attribute; +- the identification of the affected service flows (if not all the flows are affected) encoded in the "flowIds" attribute if applicable; and + +- the reference to the Alternative Service Requirement corresponding alternative QoS parameter set if received from the PCF within the "appliedQosRef" attribute. When the "appliedQosRef" attribute is omitted and the "event" attribute is QOS\_NOT\_GUARANTEED, it indicates that the lowest priority alternative QoS profile could not be fulfilled. + +When the "AltQoSProfilesSupportReport" feature as defined in clause 6.2.8 is supported, and the NF service consumer included the "altQosReferences" attribute for the provided QoS reference, or the "AltQosReqs" attribute for the provided individual QoS parameter set, if the TSCTSF receives from the PCF the indication that the GBR QoS targets cannot be guaranteed and the indication that alternative QoS profiles are not supported in the NG-RAN where the UE is currently located as specified in 3GPP TS 29.514 [20], the TSCTSF may include within the EventNotification data structure the "altQosNotSuppInd" attribute set to true. When the Alternative QoS profiles are supported by the NG-RAN where the UE is currently located, the TSCTSF may omit or set the "altSerReqNotSuppInd" attribute to false, as indicated by the PCF. + +#### 5.3.2.5.5 Notification about Service Data Flow Deactivation + +When the TSCTSF receives the notification about service data flow deactivation from the PCF as described in 3GPP TS 29.514 [20], the TSCTSF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 5.3.2.2.4 and 5.3.2.3.4. + +The TSCTSF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. + +The TSCTSF shall within an instance of "events" attribute include: + +- "FAILED\_RESOURCES\_ALLOCATION" within the "event" attribute; +- the identification of the affected service flows (if not all the flows are affected) encoded in the "flowIds" attribute if applicable. + +#### 5.3.2.5.6 Notification about resources allocation outcome + +When the TSCTSF receives the notification about resources allocation outcome from the PCF as described in 3GPP TS 29.514 [20], the TSCTSF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 5.3.2.2.5 and 5.3.2.3.5. + +The TSCTSF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. + +The TSCTSF shall within an instance of "events" attribute include: + +- "SUCCESSFUL\_RESOURCES\_ALLOCATION" within the "event" attribute if the "SUCCESSFUL\_RESOURCES\_ALLOCATION" event is received from the PCF or "FAILED\_RESOURCES\_ALLOCATION" within the "event" attribute if the "FAILED\_RESOURCES\_ALLOCATION" event is received from the PCF; +- the identification of the affected service flows (if not all the flows are affected) encoded in the "flowIds" attribute if applicable. +- when the event is "SUCCESSFUL\_RESOURCES\_ALLOCATION", the reference to the Alternative Service Requirement corresponding alternative QoS parameter set if received from the PCF within the "appliedQosRef" attribute. + +#### 5.3.2.5.7 Notification about Service Data Flow QoS Monitoring control + +When the TSCTSF receives the notification about Service Data Flow QoS Monitoring control from the PCF as described in 3GPP TS 29.514 [20], the TSCTSF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 5.3.2.2.6 and 5.3.2.3.6. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. + +The TSCTSF shall within an instance of "events" attribute include: + +- "QOS\_MONITORING" within the "event" attribute; +- the identification of the affected service flows (if not all the flows are affected) encoded in the "flowIds" attribute if applicable; and +- the "qosMonReports" array with the monitored QoS information. For QoS monitoring for packet delay: + - a) one or two uplink packet delays within the "ulDelays" attribute; + - b) one or two downlink packet delays within the "dlDelays" attribute; and/or + - c) one or two round trip packet delays within the "rtDelays" attribute; and + - d) if the feature "PacketDelayFailureReport" is supported, the packet delay measurement failure indicator within "pdmf" attribute. + +#### 5.3.2.5.8 Reporting usage for sponsored data connectivity + +When the NF service consumer enabled sponsored data connectivity and the NF service consumer provided usage thresholds for such sponsor to the TSCTSF, the TSCTSF shall report accumulated usage to the NF service consumer using the Npcf\_PolicyAuthorization\_Notify service operation when: + +- the TSCTSF detects that the usage threshold provided by the NF service consumer has been reached; or +- the NF service consumer disables the sponsored data connectivity. + +The TSCTSF shall notify the NF service consumer of the accumulated usage by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. + +The TSCTSF shall within an instance of "events" attribute include: + +- "USAGE\_REPORT" within the "event" attribute; +- accumulated usage within the "usgRep" attribute. + +When the NF service consumer receives the HTTP POST request, it shall acknowledge the request by sending a "204 No Content" response to the TSCTSF. The NF service consumer may terminate the Individual Application Session Context sending an HTTP POST as described in clause 5.3.2.4.2 or update the Individual Application Session Context information by providing a new usage threshold sending an HTTP PATCH request to the TSCTSF as described in clause 5.3.2.3.2 or an HTTP PUT request to the TSCTSF as described in clause 5.3.2.6.2. + +#### 5.3.2.5.9 Notification about AF requested QoS for a UE or group of UE(s) not identified by UE address. + +When the TSCTSF receives a notification about the requested QoS, traffic characteristics information and/or QoS Monitoring information from the PCF as described in 3GPP TS 29.514 [20] for an AF-session associated with an existing "Individual TSC Application Session Context" resource, the TSCTSF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 5.3.2.2.8 and 5.3.2.3.8. + +The TSCTSF shall notify the NF service consumer by including the EventsNotification data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. The TSCTSF notification of the specific events is described in the related clauses of the current specification (e.g. notification about service data flow QoS monitoring when the AF requested QoS for a UE or group of UE(s) as described in clause 5.3.2.5.7). + +#### 5.3.2.5.10 Notification about BAT offset + +When the TSCTSF receives the notification about network provided BAT offset from the PCF as described in 3GPP TS 29.514 [20], the TSCTSF shall inform the NF service consumer accordingly if the NF service consumer included the capability for BAT adaptation or a BAT window or the periodicity range as described in the clauses 5.3.2.2.8 and 5.3.2.3.8. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 5.3.2.5.2. + +The TSCTSF shall include: + +- in the "events" attribute an entry with the "event" attribute set to "BAT\_OFFSET\_INFO"; and +- the "batOffsetInfo" attribute containing the offset of the BAT and the optionally adjusted periodicity. The "BatOffsetInfo" data type shall contain the BAT offset of the arrival time in the "ranBatOffsetNotif" attribute, and the optionally adjusted periodicity of the data bursts encoded in the "adjPeriod" attribute. + +### 5.3.2.6 Ntscsf\_QoSandTSCAssistance\_Subscribe + +#### 5.3.2.6.1 General + +The Ntscsf\_QoSandTSCAssistance\_Subscribe service operation enables NF service consumers handling of subscription to events for the existing TSC application session context. Subscription to events shall be created: + +- within the application session context establishment procedure by invoking the Ntscsf\_QoSandTSCAssistance\_Subscribe service operation, as described in clause 5.3.2.2; or +- within the TSC application session context modification procedure by invoking the Ntscsf\_QoSandTSCAssistance\_Subscribe service operation, as described in clause 5.3.2.3; or +- by invoking the Ntscsf\_QoSandTSCAssistance\_Subscribe service operation for the existing TSC application session context, as described in clause 5.3.2.6.2. + +The following procedures using the Ntscsf\_QoSandTSCAssistance\_Subscribe service operation is supported: + +- Handling of subscription to events for the existing TSC application session context. +- Subscription to Service Data Flow QoS Monitoring Information. +- Subscription to Usage Monitoring of Sponsored Data Connectivity. + +#### 5.3.2.6.2 Handling of subscription to events for the existing TSC application session context + +This procedure is used to create a subscription to events for the existing TSC AF application session context bound to the corresponding PDU session or to modify an existing subscription, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.3.2.6.2-1 illustrates the creation of events subscription information using HTTP PUT method. + +![Sequence diagram showing the creation of events subscription information using HTTP PUT method. The NF service consumer sends a PUT request to the TSCTSF, and the TSCTSF responds with a 201 Created status.](4b8c5ecb492fd759c766fe8950fafe67_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. PUT « /tsc-app-sessions/{appSessionId}/events-subscription » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "201 Created" + TSCTSF-->>NF service consumer: Response +``` + +Sequence diagram showing the creation of events subscription information using HTTP PUT method. The NF service consumer sends a PUT request to the TSCTSF, and the TSCTSF responds with a 201 Created status. + +Figure 5.3.2.6.2-1: Creation of events subscription information using HTTP PUT + +Figure 5.3.2.6.2-2 illustrates the modification of events subscription information using HTTP PUT method. + +![Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 204 No Content or a 200 OK.](40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. PUT « /tsc-app-sessions/{appSessionId}/events-subscription » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2a. "204 No Content" +2b. "200 OK" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 204 No Content or a 200 OK. + +**Figure 5.3.2.6.2-2: Modification of events subscription information using HTTP PUT** + +When the NF service consumer decides to create a subscription to one or more events for the existing TSC application session context or to modify an existing subscription previously created by itself at the TSCTSF, the NF service consumer shall invoke the Ntsetcf\_QoSAndTSCAssistance\_Subscribe service operation by sending the HTTP PUT request to the resource URI representing the "Events Subscription" sub-resource in the TSCTSF, as shown in figure 5.3.2.6.2-1, step 1 and figure 5.3.2.6.2-2, step 1. The NF service consumer shall provide in the "EventsSubscReqData" data type of the body of the HTTP PUT request: + +- the "events" attribute with the list of events to be subscribed; +- the "notifUri" attribute that includes the Notification URI to indicate to the TSCTSF where to send the notification of the subscribed events; +- the notification correlation Id within the "notifCorreId" attribute; and +- the specific event information related to the subscribed event, e.g. QoS monitoring information within the "qosMon" attribute if the "QOS\_MONITORING" event is subscribed. + +NOTE: The "notifUri" attribute within the EventsSubscReqData data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +Upon the reception of the HTTP PUT request from the NF service consumer, the TSCTSF shall decide whether the received HTTP PUT request is accepted. + +If the TSCTSF accepted the HTTP PUT request to create a subscription to events, the TSCTSF shall create the "Events Subscription" sub-resource and shall send the HTTP response message to the NF service consumer as shown in figure 5.3.2.6.2-1, step 2. The TSCTSF shall include in the "201 Created" response: + +- a Location header field that shall contain the URI of the created "Events Subscription" sub-resource i.e. "{apiRoot}/ntsetcf-qos-tscai//tsc-app-sessions/{appSessionId}/events-subscription"; and +- a response body with the "EventsSubscReqData" data type representing the created "Events Subscription" sub-resource. + +If the TSCTSF accepted the HTTP PUT request to modify the events subscription, the TSCTSF shall modify the "Events Subscription" sub-resource and shall send to the NF service consumer: + +- the HTTP "204 No Content" response (as shown in figure 5.3.2.6.2-2, step 2a); or +- the HTTP "200 OK" response (as shown in figure 5.3.2.6.2-2, step 2b) including in the "EventsSubscReqData" data type the updated representation of the "Events Subscription" sub-resource. + +If the HTTP PUT request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.2.7. + +If the TSCTSF determines the received HTTP PUT request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +### 5.3.2.6.3 Subscription to Service Data Flow QoS Monitoring Information + +This procedure is used by NF service consumer to subscribe and/or modify the subscription for notification about service data flow QoS monitoring information. + +The NF service consumer shall include in the HTTP PUT request message the "EventsSubscReqData" data type, which shall contain: + +- to create a subscription to QoS monitoring information: + - the "events" attribute with an entry containing the value "QOS\_MONITORING" to create a subscription to notification about service data flow QoS monitoring information; + - include the updated QoS monitoring information within the "qosMon" attribute as defined in clause 5.3.2.2.6 +- to remove a subscription to QoS monitoring information: + - the "events" attribute containing an array that omits the values "QOS\_MONITORING". + +The NF service consumer shall include other events related information as described in clause 5.3.2.6.1. + +As result of this action, the TSCTSF shall set the appropriate subscription to service data flow QoS monitoring information as described in in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.6.1. + +### 5.3.2.6.4 Subscription to Usage Monitoring of Sponsored Data Connectivity + +This procedure is used by NF service consumer to subscribe and/or modify the subscription for notification about usage monitoring of sponsored data connectivity. + +The NF service consumer shall include in the HTTP PUT request message the "EventsSubscReqData" data type, which shall contain: + +- to create a subscription to usage monitoring of sponsored data connectivity: + - the "events" attribute with an entry containing the value "USAGE\_REPORT" to create a subscription to notification about usage monitoring of sponsored data connectivity; + - include the usage thresholds to apply in the "usgThres" attribute. +- to remove a subscription to usage monitoring of sponsored data connectivity: + - the "events" attribute containing an array that omits the values "USAGE\_REPORT". + +The NF service consumer shall include other events related information as described in clause 5.3.2.6.1. + +As result of this action, the TSCTSF shall set the appropriate subscription to usage monitoring of sponsored data connectivity as described in in 3GPP TS 29.514 [20]. + +The TSCTSF shall reply to the NF service consumer as described in clause 5.3.2.6.1. + +## 5.3.2.7 Ntsctsf\_QoSandTSCAssistance\_Unsubscribe + +### 5.3.2.7.1 General + +The Ntsctsf\_QoSandTSCAssistance\_Unsubscribe service operation enables NF service consumers to remove subscription to all subscribed events for the existing TSC application session context. Subscription to events shall be removed: + +- by invoking the Ntsctsf\_QoSandTSCAssistance\_Unsubscribe service operation for the existing application session context, as described in clause 5.3.2.7.2; or +- within the application session context modification procedure by invoking the Ntsctsf\_QoSandTSCAssistance\_Update service operation, as described in clause 5.3.2.3; or + +- within the TSC application session context termination procedure by invoking the Ntsctsf\_QoSandTSCAssistance\_Delete service operation, as described in clause 5.3.2.4. + +The following procedure using the Ntsctsf\_QoSandTSCAssistance\_Unsubscribe service operation is supported: + +- Unsubscription to events. + +#### 5.3.2.7.2 Unsubscription to events + +This procedure is used to unsubscribe to all subscribed events for the existing TSC AF application session context, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [19]. + +Figure 5.3.2.7.2-1 illustrates the unsubscription to events using the HTTP DELETE method. + +![Sequence diagram showing the removal of events subscription information using HTTP DELETE. The NF service consumer sends a DELETE request to the TSCTSF, and the TSCTSF responds with a 204 No Content.](9e4f582a5d5f6742d1372956db0f8f0b_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note left of NF service consumer: + NF service consumer->>TSCTSF: 1. DELETE « /tsc-app-sessions/{appSessionId}/events-subscription » + Note right of TSCTSF: + TSCTSF-->>NF service consumer: 2. "204 No Content" +``` + +Sequence diagram showing the removal of events subscription information using HTTP DELETE. The NF service consumer sends a DELETE request to the TSCTSF, and the TSCTSF responds with a 204 No Content. + +**Figure 5.3.2.7.2-1: Removal of events subscription information using HTTP DELETE** + +When the NF service consumer decides to unsubscribe to all subscribed events for the existing TSC application session context, the NF service consumer shall invoke the Ntsctsf\_QoSandTSCAssistance\_Unsubscribe service operation by sending the HTTP DELETE request message to the resource URI representing the "Events Subscription" sub-resource in the TSCTSF, as shown in figure 5.3.2.7.2-1, step 1. + +Upon the reception of the HTTP DELETE request message from the NF service consumer, the TSCTSF shall decide whether the received HTTP request message is accepted. + +If the HTTP DELETE request message from the NF service consumer is accepted, the TSCTSF shall delete "Events Subscription" sub-resource and shall send to the NF service consumer a HTTP "204 No Content" response message. The TSCTSF may delete the existing subscription to event notifications for the related PDU session from the PCF as described in 3GPP TS 29.514 [20]. + +If the HTTP DELETE request from the NF service consumer is not accepted, the TSCTSF shall indicate in the response to HTTP DELETE request the cause for the rejection as specified in clause 6.2.7. + +If the TSCTSF determines the received HTTP DELETE request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.4 Ntsctsf\_ASTI Service + +### 5.4.1 Service Description + +#### 5.4.1.1 Overview + +This service provides: + +- Authorization of NF Service Consumer requests for the activation, update, and deactivation of the 5G access stratum time distribution. + +NOTE: The AF can use either the procedure specified in bullet 1) and 2) of clause 5.2.1.1 for configuring the (g)PTP instance in 5GS or the procedure specified in Ntscstf\_ASTI service for controlling the 5G access stratum time distribution for a particular UE. The procedures are not intended to be used in conjunction. + +- Detection and reporting of time synchronization service status based on gNB and/or UPF/NW-TT timing synchronization status information and reporting status updates. +- Detection and reporting of changes of the state of 5G access time distribution configuration based e.g. on evaluation of the time synchronization coverage area conditions. + +## 5.4.1.2 Network Functions + +### 5.4.1.2.1 TSCTSF + +The TSCTSF supports to: + +- receive the request to activate or update the 5G access stratum time distribution configuration from the NEF or AF and provide it for the target UE(s) to the PCF; +- receive the request to delete the 5G access stratum time distribution configuration from the NEF or AF and provide it for the target UE(s) to the PCF; +- receive the request to query the status of the access stratum time distribution from the NEF or AF and respond to the NEF or AF with the status of the access stratum time distribution; +- make a translation from External/Internal Group Identifier to a list of SUPI by querying UDM; +- retrieve the Time Synchronization Subscription data from UDM for the control of 5G access stratum-based time distribution and make decision based on received the Time Synchronization Subscription data; +- determine whether the UE is inside/outside the requested time synchronization coverage area and enforce the 5G access stratum time distribution service accordingly; +- indicate whether the service is supported or not as per the requested acceptance criteria (e.g., based on the known timing synchronization status attribute thresholds pre-configured at gNB); and +- based on gNB and/or UPF/NW-TT timing synchronization status (degradation/failure/improvement) information and reporting, provide a notification when there is a service status update if the NEF or AF subscribe to service status updates. + +### 5.4.1.2.2 NF Service Consumers + +The NF service consumer supports to: + +- send the request to create, modify and delete the 5G access stratum time distribution configuration to the TSCTSF; +- query the status of the access stratum time distribution configuration; +- provide clock quality reporting control information, consisting of clock quality detail level and clock quality acceptance criteria, during activation or modification of time synchronization service; +- subscribe to time synchronization service status for the target UE(s); and +- receive notifications about the state and changes of state of 5G access stratum time distribution configuration. + +## 5.4.2 Service Operations + +### 5.4.2.1 Introduction + +Service operations defined for the Ntscstf\_ASTI service are shown in table 5.4.2.1-1. + +**Table 5.4.2.1-1: Ntsctsf\_ASTI Service Operations** + +| Service Operation Name | Description | Initiated by | +|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| Ntsctsf_ASTI_Create | Allows the NF service consumer to create a 5G access stratum time distribution configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_ASTI_Update | Allows the NF service consumer to update a 5G access stratum time distribution configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_ASTI_Delete | Allows the NF service consumer to delete a 5G access stratum time distribution configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_ASTI_Get | Allows the NF service consumer to query the status of the 5G access stratum time distribution configuration. | NF service consumer (e.g. AF, NEF) | +| Ntsctsf_ASTI_UpdateNotify | Allows the TSCTSF to notify about the status of the 5G access stratum time distribution and/or changes on the state of 5G access stratum time distribution configuration. | TSCTSF | + +NOTE: The NEF and the AF use the Ntsctsf\_ASTI service in the same way. + +## 5.4.2.2 Ntsctsf\_ASTI\_Create + +### 5.4.2.2.1 General + +This service operation is used by an NF service consumer to create a 5G access stratum time distribution configuration. + +The following procedures using the Ntsctsf\_ASTI\_Create service operation are supported: + +- creating a new configuration. + +### 5.4.2.2.2 Creating a new configuration + +Figure 5.4.2.2.2-1 illustrates the creation of a configuration. + +![Sequence diagram showing the creation of a configuration. An NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status.](15906392337ec83a921988b52f102a44_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST « configurations + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "201 Created" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the creation of a configuration. An NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 201 Created status. + +**Figure 5.4.2.2.2-1: Creation of a configuration** + +To create a configuration, the NF service consumer shall send an HTTP POST message to the TSCTSF to the URI "{apiRoot}/ntsctsf-asti//configurations". The HTTP POST message shall include the AccessTimeDistributionData data structure as request body, as shown in figure 5.4.2.2.2-1, step 1. The AccessTimeDistributionData data structure shall include: + +- one of the indication of the UEs to which the 5G access stratum time distribution configuration is requested via: + - identification of a list of individual UEs within the "supis" attribute; or + - identification of a group of UE(s) within the "interGrpId" attribute; + +- identification of a list of individual UEs within the "gpsi" attribute; +- identification of a group of UE(s) within the "exterGrpId" attribute; and +- 5G access stratum time distribution parameters within the "asTimeDisParam" attribute. + +Within the "asTimeDisParam" attribute inside the AccessTimeDistributionData data structure, the NF service consumer: + +- shall include the "asTimeDisEnabled" attribute set to true if the access stratum time distribution via Uu reference point should be activated. Otherwise, if the access stratum time distribution via Uu reference point should be inactive, the "asTimeDisEnabled" attribute may either be omitted or included and set to "false"; +- may include the time synchronization error budget within the "timeSyncErrBdgt" attribute; +- may include the temporal validity condition within the "tempValidity" attribute; and +- may indicate whether and which clock quality information to provide to the UE by including the clock quality detail level in the "clkQltDetLvl" attribute and optionally the clock quality acceptance criteria in the "clkQltAcptCri" attribute, if applicable. + +When the "CoverageAreaSupport" feature is supported, the AccessTimeDistributionData data structure may include the time synchronization coverage area encoded as "covReq" attribute, that contains a list of Tracking Area codes per serving network where the provided access stratum time distribution data applies. + +When the "ASTIConfigReport" feature is supported, to receive notifications about changes in the 5G access stratum time distribution configuration, the NF service consumer shall also provide the notification URI within the "astiNotifUri" attribute and the notification correlation Id within the "astiNotifId" attribute. When the "NetTimeSyncStatus" feature is supported, the NF service consumer may also include the clock quality detail level in the "clkQltDetLvl" attribute and the clock quality acceptance criteria in the "clkQltAcptCri" attribute to indicate the subscription to notification of the status of the access stratum time distribution service. + +Upon receipt of the HTTP request from the NF service consumer, if the request is authorized, the TSCTSF shall: + +- if the 5G access stratum time distribution configuration applies to an internal group of UEs indicated in the "interGrpId" attribute or to an external group of UEs indicated in the "exterGrpId" attribute, interact with the UDM to retrieve the list of individual UEs that belong to the group using the Nudm\_SDM service as defined in 3GPP TS 29.503 [24]; +- if the 5G access stratum time distribution configuration applies to a list of individual UEs within the "gpsi" attribute, interact with the UDM to retrieve the SUPI(s) that corresponds to each of the GPSI(s) using the Nudm\_SDM service as defined in 3GPP TS 29.503 [24]; +- The TSCTSF retrieves the UE's Time Synchronization Subscription data from the UDM for each individual UE. If the UE's Time Synchronization Subscription data contains the authorized Uu time synchronization error budget, and the requested time synchronization error budget within the "timeSyncErrBdgt" attribute is within the authorized time synchronization error budget, the TSCTSF determines that the UE is authorized for the requested time synchronization service. +- if the "CoverageAreaSupport" feature is supported and a time synchronization coverage area is provided within the "covReq" attribute, perform the following operations: + - a. if the Authorized Time Synchronization Coverage Area is inside of the requested Coverage Area, the TSCTSF uses the Authorized Time Synchronization Coverage Area. If the requested Coverage Area partly overlaps with the Authorized Time Synchronization Coverage Area, the TSCTSF uses the intersection of them. If there is no overlap between them, the TSCTSF shall reject the AF request as described in clause 5.27.1.11 of 3GPP TS 23.501 [2]. + - b. the TSCTSF shall discover the list of AMF(s) serving the list of TA(s) that comprise the time synchronization coverage area using the Nnrf\_NFDiscovery service operation as described in 3GPP TS 29.510 [10], if they were not previously retrieved, and: + - c. subscribe with the discovered AMF(s): + +1. for each UE, e.g. when the 5G access stratum time distribution configuration applies to a list of individual UEs, and the UE time synchronization coverage area within the "covReq" attribute is within the authorized time synchronization coverage area; or +2. for the group of UEs, when the 5G access stratum time distribution configuration applies to a group of UEs. + +To receive notifications about presence of the UE in an Area of Interest events using the Namf\_EventExposure service as described in 3GPP TS 29.518 [27], where the Area of Interest is the provided time synchronization coverage area. + +- d. Based on the outcome provided by the AMF about the UE's presence in the Area of Interest and the authorized time synchronization coverage area, the TSCTSF shall determine if the 5G access stratum time distribution configuration is enabled for the UE: + - i. If the UE presence is within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area condition is fulfilled, and the provided 5G access stratum time distribution configuration is enabled for the UE. + - ii. If the UE presence is not within any of the TAs from the time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area condition is not fulfilled, and the provided 5G access stratum time distribution configuration is not enabled for the UE. +- The TSCTSF retrieves the UE's Time Synchronization Subscription data from the UDM for each individual UE. If the UE's Time Synchronization Subscription data contains the periods of authorized start and stop times, and the requested temporal validity condition within the "tempValidity" attribute is within any of the authorized periods of authorized start and stop times, the TSCTSF determines that the UE is authorized for the requested time synchronization service. +- for each authorized UE, subscribe to event notifications of newly registered PCF for the UE by invoking Nbsf\_Management\_Subscribe Service Operation as defined in 3GPP TS 29.521 [23], if not yet subscribed; +- for each authorized UE, if the access stratum time distribution via Uu reference point is being activated (i.e. the "asTimeDisEnabled" attribute within the "asTimeDisParam" attribute was received and set to true), calculate the Uu time synchronization error budget as specified in clauses 5.27.1.9 and 5.27.1.11 of 3GPP TS 23.501 [2]; +- for each authorized UE, if clock quality information was provided, the authorized clock quality detail level within the "clkQltDetLvl" attribute and optionally the clock quality acceptance criteria in the "clkQltAcptCri" attribute, if applicable; +- for each authorized UE, interact with the PCF for a UE to provide the configuration information for each target UE using the Npcf\_AMPolicyAuthorization\_Create service operation as defined in 3GPP TS 29.534 [14]; +- create a new resource, which represents a new "Individual ASTI Configuration" resource, addressed by a URI as defined in clause 6.1.3.7 and containing a TSCTSF created resource identifier; and +- send an HTTP "201 Created" response with AccessTimeDistributionData data structure as response body and a Location header field containing the URI of the created Individual ASTI Configuration resource, i.e. "{apiRoot}/ntscstf-asti//configurations/{configId}", as shown in figure 5.4.2.2.2-1, step 2. + +If for all the affected UEs the provided parameters are not allowed by subscription, the TSCTSF shall indicate in an HTTP "403 Forbidden" response message the "cause" attribute set to "UE\_SERVICE\_NOT\_AUTHORIZED". + +If the TSCTSF cannot successfully fulfil the received HTTP POST request due to the internal TSCTSF error or due to the error in the HTTP POST request, the TSCTSF shall send the HTTP error response as specified in clause 6.3.7. + +### 5.4.2.3 Ntscstf\_ASTI\_Update + +#### 5.4.2.3.1 General + +This service operation is used by an NF service consumer to update a 5G access stratum time distribution configuration. + +The following procedures using the Ntscstf\_ASTI\_Update service operation are supported: + +- Updating an existing configuration. + +### 5.4.2.3.2 Updating an existing configuration + +Figure 5.4.2.3.2-1 illustrates the updating of an existing configuration. + +![Sequence diagram illustrating the update of a configuration. The NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content.](4842f073775fb1e84d101c02fd74e59e_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. PUT « configurations/{configId} » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2a. "200 OK" +2b. "204 No Content" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram illustrating the update of a configuration. The NF service consumer sends a PUT request to the TSCTSF. The TSCTSF responds with either a 200 OK or a 204 No Content. + +**Figure 5.4.2.3.2-1: Update of a configuration** + +To update a configuration, the NF service consumer shall send an HTTP PUT request to the resource "{apiRoot}/ntscsf-asti//configurations/{configId}" representing an existing "Individual ASTI Configuration" resource, as shown in figure 5.4.2.3.2-1, step 1, to modify the configuration. + +The AccessTimeDistributionData data structure provided in the request body shall include an updated representation of the "Individual ASTI Configuration" resource with the updated 5G access stratum time distribution configuration information as defined in clause 5.4.2.2.2. + +When the "CoverageAreaSupport" feature is supported, the AccessTimeDistributionData data structure may include the time synchronization coverage area encoded as "covReq" attribute, that may contain an updated list of Tracking Area codes per serving network where the provided access stratum time distribution data applies. + +When the "ASTIConfigReport" feature is supported, to receive notifications about changes in the 5G access stratum time distribution configuration, the NF service consumer shall also provide the notification URI within the "astiNotifUri" attribute and the notification correlation Id within the "astiNotifId" attribute; and/or, when the "NetTimeSyncStatus" feature is supported, the update of the clock quality detail level in the "clkQltDetLvl" attribute and optionally the clock quality acceptance criteria in the "clkQltAcptCri" attribute indicates an update in the subscription to notification of status of the access stratum time distribution service. + +Upon receipt of the corresponding HTTP PUT message, if the request is authorized, the TSCTSF shall: + +- If the "CoverageAreaSupport" feature is supported and an updated time synchronization coverage area is provided within the "covReq" attribute: + - i. discover the list of AMF(s) serving the list of TA(s) that comprise the time synchronization coverage area using the Nnrf\_NFDiscovery service operation as described in 3GPP TS 29.510 [10], if they were not previously retrieved, and; + - ii. update the subscription with the discovered AMF(s), if applicable: + - a. for each affected UE, e.g. when the 5G access stratum time distribution configuration applies to a list of individual UEs and the UE time synchronization coverage area within the "covReq" attribute is within the subscribed time synchronization coverage area; or + - b. for the group of UEs, when the 5G access stratum time distribution configuration applies to a group of UEs. + +to receive notifications about presence of the UE in an Area of Interest events using the Namf\_EventExposure service as described in 3GPP TS 29.518 [27], where the Area of Interest is the provided time synchronization coverage area. + +- iii. Based on the outcome provided by the AMF or the local available information about the UE's presence in the Area of Interest and the authorized time synchronization coverage area, the TSCTSF shall determine if the 5G access stratum time distribution configuration is enabled for the UE: + - i. If the UE presence is within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area condition is fulfilled, and the provided 5G access stratum time distribution configuration is enabled for the UE. + - ii. If the UE presence is not within any of the TAs from the authorized time synchronization coverage area, the TSCTSF determines that the time synchronization coverage area condition is not fulfilled, and the provided 5G access stratum time distribution configuration is not enabled for the UE. +- if the "CoverageAreaSupport" feature is supported and a time synchronization coverage area previously provided is removed: + - 1. terminate the related subscriptions to notifications about presence of the UE in an Area of Interest events using the Namf\_EventExposure service as described in 3GPP TS 29.518 [27]. + - 2. for each UE that did not fulfil the removed time synchronization coverage area, authorize the UE for the 5GS access stratum time distribution configuration. +- if the time synchronization error budget within the "timeSyncErrBdgt" attribute and/or the temporal validity condition within the "tempValidity" attribute from the NF service consumer is provided, updated, or removed, the TSCTSF based on the Time Synchronization Subscription data retrieved from the UDM determines whether the UE is authorized for the request again as described in clause 5.4.2.2.2. +- for each authorized UE, if the access stratum time distribution via Uu reference point is being activated (i.e. the "asTimeDisEnabled" attribute within the "asTimeDisParam" attribute was received and set to true) or a time synchronization error budget for an active access stratum time distribution is provided or updated by the AF, calculate the Uu time synchronization error budget as specified in clause 5.27.1.9 of 3GPP TS 23.501 [2]; +- for each authorized UE, interact with the PCF for a UE to provide the updated configuration information using the Npcf\_AMPolicyAuthorization\_Update service operation as defined in 3GPP TS 29.534 [14]; and +- update the existing "Individual ASTI Configuration" resource. Then the TSCTSF shall send a HTTP response including "200 OK" status code with AccessTimeDistributionData data structure or "204 No Content" status code, as shown in figure 5.4.2.3.2-1, step 2. + +If for all the affected UEs the provided parameters are not allowed by subscription, the TSCTSF shall indicate in an HTTP "403 Forbidden" response message the "cause" attribute set to "UE\_SERIVCE\_NOT\_AUTHORIZED". + +If the TSCTSF cannot successfully fulfil the received HTTP PUT request due to the internal TSCTSF error or due to the error in the HTTP PUT request, the TSCTSF shall send the HTTP error response as specified in clause 6.3.7. + +If the TSCTSF determines the received HTTP PUT request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 5.4.2.4 Ntsctsf\_ASTI\_Delete + +##### 5.4.2.4.1 General + +This service operation is used by an NF service consumer to delete a 5G access stratum time distribution configuration. + +The following procedures using the Ntsctsf\_ASTI\_Delete service operation are supported: + +- Delete an existing configuration. + +##### 5.4.2.4.2 Delete an existing configuration + +Figure 5.4.2.4.2-1 illustrates the deleting of an existing configuration. + +![Sequence diagram showing the deletion of a configuration. An NF service consumer sends a DELETE request for configurations/{configId} to the TSCTSF, which responds with a 204 No Content.](65e8c0628536d6d4245e9ab46ba070c3_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. DELETE « configurations/{configId} » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "204 No Content" + TSCTSF-->>NF service consumer: Response +``` + +Sequence diagram showing the deletion of a configuration. An NF service consumer sends a DELETE request for configurations/{configId} to the TSCTSF, which responds with a 204 No Content. + +**Figure 5.4.2.4.2-1: Deletion of a configuration** + +To delete a configuration, the NF service consumer shall send an HTTP DELETE request to the resource "{apiRoot}/ntscts-asti//configurations/{configId}" representing an existing "Individual ASTI Configuration" resource, as shown in figure 5.4.2.4.2-1, step 1, to delete the configuration. + +Upon the reception of an HTTP DELETE request from the NF service consumer, if the HTTP DELETE request is authorized, the TSCTSF shall: + +- interact with the PCF for a UE to remove the configuration information in the PCF by using the Npcf\_AMPolicyAuthorization\_Delete service operation as defined in 3GPP TS 29.534 [14]. +- remove the corresponding configuration and respond with "204 No Content" as shown in figure 5.4.2.4.2-1, step 2. + +If the TSCTSF cannot successfully fulfil the received HTTP DELETE request due to the internal TSCTSF error or due to the error in the HTTP DELETE request, the TSCTSF shall send the HTTP error response as specified in clause 6.3.7. + +If the TSCTSF determines the received HTTP DELETE request needs to be redirected, the TSCTSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 5.4.2.5 Ntscts\_asti\_Get + +### 5.4.2.5.1 General + +This service operation is used by an NF service consumer to retrieve the status of the access stratum time distribution for a list of UEs. + +The following procedures using the Ntscts\_asti\_Get service operation are supported: + +- Retrieve the status of access stratum time distribution. + +### 5.4.2.5.2 Retrieve the status of access stratum time distribution + +Figure 5.4.2.5.2-1 illustrates the retrieval of the status of access stratum time distribution. + +![Sequence diagram showing the retrieval of the status of access stratum time distribution. The NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 200 OK.](56a5265d174ce056c1dbe5e7a60839fc_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant TSCTSF + Note right of NF service consumer: 1. POST « configurations/retrieve » + NF service consumer->>TSCTSF: Request + Note left of TSCTSF: 2. "200 OK" + TSCTSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the retrieval of the status of access stratum time distribution. The NF service consumer sends a POST request to the TSCTSF, and the TSCTSF responds with a 200 OK. + +**Figure 5.4.2.5.2-1: Retrieval of the status of access stratum time distribution** + +To retrieve the status of access stratum time distribution, the NF service consumer shall send an HTTP POST request to the resource "{apiRoot}/ntscts-asti//configurations/retrieve". The HTTP POST message shall include the StatusRequestData data structure as request body, as shown in figure 5.4.2.5.2-1, step 1. The StatusRequestData data structure shall include: + +- identification of a list of individual UEs within the "supis" attribute; or +- identification of a list of individual UEs within the "gpsi" attribute; + +Upon the reception of an HTTP POST request and if the HTTP POST request is accepted by the TSCTSF, the TSCTSF determines the status of the access stratum time distribution is active for a UE if there is a 5G access stratum time distribution configuration applicable to the UE, i.e., it applies according to the temporal validity, if present, and the access time distribution via Uu reference point is activated; otherwise, the status of the access stratum time distribution is inactive for the UE. + +The TSCTSF shall send an HTTP "200 OK" response with the StatusResponseData data structure as response body, as shown in figure 5.4.2.5.2-1, step 2 to notify of the status. + +Within the StatusResponseData data structure, TSCTSF may include: + +- a list of SUPI(s) whose status of the access stratum time distribution is inactive within the "inactiveUes" attribute or a list of GPSI(s) whose status of the access stratum time distribution is inactive within the "inactiveGpsi" attribute; +- the "activeUes" attribute containing one or more the ActiveUe instances which includes the UE identifier whose status of the access stratum time distribution is active within the "supi" attribute or "gpsi" attribute and the requested time synchronization error budget, if available, within the "timeSyncErrBdgt" attribute. + +If the TSCTSF cannot successfully fulfil the received HTTP POST request due to the internal TSCTSF error or due to the error in the HTTP POST request, the TSCTSF shall send the HTTP error response as specified in clause 6.3.7. + +## 5.4.2.6 Ntscts\_ ASTI\_UpdateNotify + +### 5.4.2.6.1 General + +This service operation is used by the TSCTSF to report about the change of state of the 5G access stratum time distribution configuration and the 5G access stratum time distribution status information. + +The following procedures using the Ntscts\_ ASTI\_UpdateNotify service operation are supported: + +- Notification about the 5G Access Stratum Time Distribution events +- Notification about ASTI configuration changes due to UE presence in time synchronization coverage area. +- Notification about the 5G access stratum time distribution status information. + +#### 5.4.2.6.2 Notification about the 5G access stratum time distribution events + +Figure 5.4.2.6.2-1 illustrates the notification about the 5G access stratum time distribution events. + +![Sequence diagram showing the notification about the 5G access stratum time distribution event. The TSCTSF sends a POST request to the NF service consumer, and the NF service consumer responds with a 204 No Content.](4cd9eeaee1deb05bf88a8abf02ff7d7f_img.jpg) + +``` +sequenceDiagram + participant TSCTSF + participant NF_service_consumer as NF service consumer + Note right of TSCTSF: 1. POST {astiNotifUri} + TSCTSF->>NF_service_consumer: 1. POST {astiNotifUri} + Note left of NF_service_consumer: 2. "204 No Content" + NF_service_consumer-->>TSCTSF: 2. "204 No Content" +``` + +Sequence diagram showing the notification about the 5G access stratum time distribution event. The TSCTSF sends a POST request to the NF service consumer, and the NF service consumer responds with a 204 No Content. + +**Figure 5.4.2.6.2-1: Notification about the 5G access stratum time distribution event** + +The TSCTSF shall invoke the Ntsctsf\_ASTI\_UpdateNotify to report a 5G access stratum time distribution event by sending an HTTP POST request (as shown in figure 5.4.2.6.2-1, step 1) to the NF service consumer using as request URI the notification URI received in the creation (as specified in clause 5.4.2.2.2) or modification (as specified in clause 5.4.2.3.2) of the Individual ASTI Configuration resource, and the AstiConfigNotification data structure as request body. + +The AstiConfigNotification data structure shall include: + +- the notification correlation ID provided by the NF service consumer during the provisioning of 5G access stratum time distribution configuration within the "astiNotifId" attribute; +- the update of the 5G access stratum configuration for the indicated UE(s) within the "stateConfigs" attribute. Within each entry of the "stateConfigs" attribute, the TSCTSF shall include: + - a. the identification of the individual UE within either the "supi" or the "gpsi" attribute; + - b. information about the observed event within the "event" attribute. For each reported event, the additional event information, if applicable. + +The notification of specific events using the Ntsctsf\_ASTI\_UpdateNotify service operation is described in the related clauses. + +If the HTTP POST request from the TSCTSF is not accepted, the NF service consumer shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 6.3.7. + +If the HTTP POST request from the TSCTSF is accepted, the NF service consumer shall acknowledge the receipt of the event notification with a "204 No Content" response, as shown in figure 5.4.2.6.2-1, step 2. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 5.4.2.6.3 Notification about ASTI configuration changes due to UE presence in time synchronization coverage area + +If the feature "CoverageAreaSupport" is supported and the TSCTSF received time synchronization coverage area as part of the Ntsctsf\_ASTI\_Create/Update service operation as described in clauses 5.4.2.2.2 and 5.4.2.3.2, when the TSCTSF receives a change in the UE presence in Area of Interest notification as described in 3GPP TS 29.518 [27], the TSCTSF shall determine if the re-evaluation of the time synchronization coverage area shall trigger an activation or deactivation of the access stratum time distribution: + +- If the notification of change of UE presence in Area of Interest indicates that the UE is within any TAs from the time synchronization coverage area, then the TSCTSF shall enable access stratum time distribution for + +the UE. The TSCTSF shall provide the 5G access stratum time distribution configuration to the UE using the Npcf\_AMPolicyAuthorization\_Create service operation as defined in 3GPP TS 29.534 [14]. + +- If the notification of change of UE presence in Area of Interest indicates that the UE is not within any TAs from the time synchronization coverage area, then the TSCTSF shall disable access stratum time distribution for the UE. The TSCTSF shall disable the 5G access stratum time distribution to the UE using the Npcf\_AMPolicyAuthorization\_Update service operation as defined in 3GPP TS 29.534 [14]. + +If the feature "ASTIConfigReport" is supported, the TSCTSF shall invoke the Ntsctsf\_ASTI\_UpdateNotify to report the change of 5G access stratum time distribution configuration as specified in clause 5.4.2.6.2. The "stateConfigs" attribute shall include: + +- the "event" attribute set to "ASTI\_ENABLED" to indicate the 5G access stratum time distribution configuration for the UE is active; or +- the "event" attribute set to "ASTI\_DISABLED" to indicate the 5G access stratum time distribution configuration for the UE is inactive. + +The NF service consumer shall acknowledge or redirect the request as described in clause 5.4.2.6.2. + +#### 5.4.2.6.4 Notification about the 5G access stratum time distribution status information + +If the "NetTimeSyncStatus" feature is supported and the TSCTSF received clock quality acceptance criteria as part of the Ntsctsf\_ASTI\_Create/Update service operation as described in clauses 5.4.2.2.2 and 5.4.2.3.2, when the TSCTSF is aware of 5G access stratum time distribution status information, the TSCTSF shall determine if the UE is impacted or not based on the UE presence in Area of Interest notification as described in clause 4.15.9.5.1 of 3GPP TS 23.502 [3]. + +If the "NetTimeSyncStatus" feature is supported and for the affected UEs, the TSCTSF shall invoke the Ntsctsf\_ASTI\_UpdateNotify to report about the 5G access stratum time distribution status as specified in clause 5.4.2.6.2 and shall include the status of the access stratum time distribution for the targeted UE(s) within the "stateConfigs" attribute as follows: + +- the "event" attribute set to "CLOCK\_QUAL\_ACCEPTABLE" to indicate the clock quality for the ASTI service is fulfilling the clock quality acceptance criteria for the UE; or +- the "event" attribute set to "CLOCK\_QUAL\_NON\_ACCEPTABLE" to indicate the clock quality for the ASTI service is not fulfilling the clock quality acceptance criteria for the UE. Based on this notification, the AF decides whether to modify the ASTI service configured for the UE using the Ntsctsf\_ASTI\_Update service as described in clause 5.4.2.3. + +The NF service consumer shall acknowledge or redirect the request as described in clause 5.4.2.6.2. + +--- + +## 6 API Definitions + +### 6.1 Ntsctsf\_TimeSynchronization Service API + +#### 6.1.1 Introduction + +The Ntsctsf\_TimeSynchronization service shall use the Ntsctsf\_TimeSynchronization API. + +The API URI of the Ntsctsf\_TimeSynchronization API shall be: + +**{apiRoot}** + +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}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "ntscts-time-sync". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +## 6.1.2 Usage of HTTP + +### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [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 Ntscts\_TimeSynchronization API is contained in Annex A. + +### 6.1.2.2 HTTP standard headers + +#### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +#### 6.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 9457 [13]. + +### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +In this Release of the specification, no specific custom headers are defined for the Ntscts\_TimeSynchronization API. + +## 6.1.3 Resources + +### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 depicts the resource URIs structure for the Ntscts\_TimeSynchronization API. + +![A hierarchical diagram showing the resource URI structure of the Ntscts_TimeSynchronization API. The root is {apiRoot}/ntscts-time-sync/. It branches to /subscriptions, which branches to /{subscriptionId}, which branches to /configurations, which finally branches to /{configurationId}.](fcc757566216206ceddbd6c775e8db02_img.jpg) + +{apiRoot}/ntscts-time-sync/ + +``` + +graph TD + Root["{apiRoot}/ntscts-time-sync/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + SubscriptionId --> Configurations["/configurations"] + Configurations --> ConfigurationId["/{configurationId}"] + +``` + +A hierarchical diagram showing the resource URI structure of the Ntscts\_TimeSynchronization API. The root is {apiRoot}/ntscts-time-sync/. It branches to /subscriptions, which branches to /{subscriptionId}, which branches to /configurations, which finally branches to /{configurationId}. + +**Figure 6.1.3.1-1: Resource URI structure of the Ntscts\_TimeSynchronization API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------------------|------------------------------------------------------------------|---------------------------------|---------------------------------------------------------------------------------------------| +| Time Synchronization Exposure | /subscriptions | POST | Create a new subscription to notification of capability of time synchronization service. | +| Individual Time Synchronization Exposure Subscription | /subscriptions/{subscriptionId} | GET | Read a subscription to notification of capability of time synchronization service. | +| | | PUT | Modify a subscription to notification of capability of time synchronization service. | +| | | DELETE | Delete a subscription to notification of capability of time synchronization service. | +| Time Synchronization Exposure Configurations | /subscriptions/{subscriptionId}/configurations | POST | Create a new configuration to time synchronization exposure. | +| Individual Time Synchronization Exposure Configuration | /subscriptions/{subscriptionId}/configurations/{configurationId} | GET | Read a configuration to time synchronization exposure. | +| | | PUT | Modify all of the properties of an existing configuration to time synchronization exposure. | +| | | DELETE | Delete a configuration to time synchronization exposure. | + +### 6.1.3.2 Resource: Time Synchronization Exposure Subscriptions + +#### 6.1.3.2.1 Description + +This resource allows a NF service consumer to create a new subscription to notification of the capability for time synchronization service. + +#### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/ntscetf-time-sync//subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +#### 6.1.3.2.3 Resource Standard Methods + +##### 6.1.3.2.3.1 POST + +The POST method creates a new subscription resource to time synchronization exposure subscription. The NF service consumer shall initiate the HTTP POST request message and the TSCTSF shall respond to the message. The TSCTSF shall construct the URI of the created resource. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.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 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------| +| TimeSyncExposureSubsc | M | 1 | Parameters to request a subscription to notification of the capability for time synchronization service. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureSubsc | M | 1 | 201
Created | The subscription was created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| NOTE: The mandatory 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 6.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}/ntsctsf-time-sync/{apiVersion}/subscriptions/{subscriptionId} | + +#### 6.1.3.2.4 Resource Custom Operations + +None. + +#### 6.1.3.3 Resource: Individual Time Synchronization Exposure Subscription + +##### 6.1.3.3.1 Description + +This resource allows a NF service consumer to read, modify or delete an existing subscription to notification of the capability for time synchronization service. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/ntsctsf-time-sync/{apiVersion}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|---------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| subscriptionId | string | Represents a specific subscription. It is the identifier of the Individual Time Synchronization Exposure Subscription resource. | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.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 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureSubsc | M | 1 | 200 OK | An Individual Time Synchronization Exposure Subscription resource is returned successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Individual Time Synchronization Exposure Subscription resource retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Individual Time Synchronization Exposure Subscription resource retrieval.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.1.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The subscription was deleted successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Time Synchronization Exposure Subscription resource deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Time Synchronization Exposure Subscription resource deletion.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.1.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +### 6.1.3.3.3.3 PUT + +This method shall support the URI query parameters specified in table 6.1.3.3.3-1. + +**Table 6.1.3.3.3-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3-2 and the response data structures and response codes specified in table 6.1.3.3.3-3. + +**Table 6.1.3.3.3.3-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|----------------------------------------------------------------| +| TimeSyncExposureSubsc | M | 1 | Modify an existing Time Synchronization Exposure Subscription. | + +**Table 6.1.3.3.3.3-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureSubsc | M | 1 | 200 OK | The subscription was updated successfully. | +| n/a | | | 204 No Content | The subscription was updated successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Time Synchronization Exposure Subscription resource modification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Time Synchronization Exposure Subscription resource modification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.1.3.3.4 Resource Custom Operations + +None. + +### 6.1.3.4 Resource: Time Synchronization Exposure Configurations + +#### 6.1.3.4.1 Description + +This resource allows a NF service consumer to create a new subscription to notification of the capability for time synchronization service. + +#### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/ntscsf-time-sync//subscriptions/{subscriptionId}/configurations + +This resource shall support the resource URI variables defined in table 6.1.3.4.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|---------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| subscriptionId | string | Represents a specific subscription. It is the identifier of the Individual Time Synchronization Exposure Subscription resource. | + +#### 6.1.3.4.3 Resource Standard Methods + +##### 6.1.3.4.3.1 POST + +The POST method creates a new configuration resource to activate time synchronization service. The NF service consumer shall initiate the HTTP POST request message and the TSCTSF shall respond to the message. The TSCTSF shall construct the URI of the created resource. + +This method shall support the URI query parameters specified in table 6.1.3.4.3.1-1. + +**Table 6.1.3.4.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 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3. + +**Table 6.1.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|--------------------------------------------------------------------------------| +| TimeSyncExposureConfig | M | 1 | Parameters to create a configuration to activate time synchronization service. | + +**Table 6.1.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureConfig | M | 1 | 201
Created | The configuration was created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection, during Individual Time Synchronization Exposure Configuration resource creation.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection, during Individual Time Synchronization Exposure Configuration resource creation.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | (NOTE 3) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +NOTE 3: Failure cases are described in clause 6.1.7. + +**Table 6.1.3.4.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}/ntscts-time-sync/{apiVersion}/subscriptions/{subscriptionId}/configuration/{configurationId} | + +**Table 6.1.3.4.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.1.3.4.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.1.3.4.4 Resource Custom Operations + +None. + +### 6.1.3.5 Resource: Individual Time Synchronization Exposure Configuration + +#### 6.1.3.5.1 Description + +This resource allows a NF service consumer to modify/cancel a configuration to modify/deactivate Time Synchronization service with the TSCTSF + +#### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/ntsetsf-time-sync//subscriptions/{subscriptionId}/configurations/{configurationId} + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| subscriptionId | string | Represents a specific subscription. It is the identifier of the Individual Time Synchronization Exposure Subscription resource. | +| configurationId | string | Represents a specific configuration. It is the identifier of the Individual Time Synchronization Exposure Configuration resource. | + +#### 6.1.3.5.3 Resource Standard Methods + +##### 6.1.3.5.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.5.3.1-1. + +**Table 6.1.3.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.1-2 and the response data structures and response codes specified in table 6.1.3.5.3.1-3. + +**Table 6.1.3.5.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.5.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureConfig | M | 1 | 200 OK | The configuration information in the request URI are returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Time Synchronization Exposure Configuration resource retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Time Synchronization Exposure Configuration resource retrieval.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.4.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.1.3.4.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.1.3.5.3.2 PUT + +This method shall support the URI query parameters specified in table 6.1.3.5.3.2-1. + +**Table 6.1.3.5.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.2-2 and the response data structures and response codes specified in table 6.1.3.5.3.2-3. + +**Table 6.1.3.5.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-----------------------------------------------------------------| +| TimeSyncExposureConfig | M | 1 | Modify an existing Time Synchronization Exposure Configuration. | + +**Table 6.1.3.5.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureConfig | M | 1 | 200 OK | The subscription was updated successfully. | +| n/a | | | 204 No Content | The subscription was updated successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Time Synchronization Exposure Configuration resource update.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Time Synchronization Exposure Configuration resource update.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 3) | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +NOTE 3: Failure cases are described in clause 6.1.7. + +**Table 6.1.3.5.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.1.3.5.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.1.3.5.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.5.3.3-1. + +**Table 6.1.3.5.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.3-2 and the response data structures and response codes specified in table 6.1.3.5.3.3-3. + +**Table 6.1.3.5.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 6.1.3.5.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 | The configuration was deleted successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Time Synchronization Exposure Configuration resource deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Time Synchronization Exposure Configuration resource deletion
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.5.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.1.3.5.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.1.3.5.4 Resource Custom Operations + +None. + +#### 6.1.4 Custom Operations without associated resources + +Void + +## 6.1.5 Notifications + +### 6.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 6.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------------------------------------|------------------|---------------------------------|---------------------------------------------------------------------------| +| Time Synchronization Capability Notification | {subsNotifUri} | POST | Time Synchronization Capability Notification for a list of UEs. | +| Time Synchronization Configuration Notification | {configNotifUri} | POST | Current state of Time Synchronization Service configuration Notification. | + +### 6.1.5.2 Time Synchronization Capability Notification + +#### 6.1.5.2.1 Description + +The Time Synchronization Capability Notification is used by the NF service producer to report the capability of the time synchronization service for a list of UEs to a NF service consumer that has subscribed to such Notifications. + +#### 6.1.5.2.2 Target URI + +The Callback URI "{subsNotifUri}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Callback URI variables** + +| Name | Definition | +|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subsNotifUri | String formatted as URI with the Callback Uri.
The Callback Uri is assigned within the Time Synchronization Capability Notification and described within the TimeSyncExposureSubsc type (see table 6.1.6.2.2-1). | + +#### 6.1.5.2.3 Standard Methods + +##### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-2 + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| TimeSyncExposureSubsNotif | M | 1 | Provides the time synchronization capabilities of a list of UEs by the TSCTSF to the NF service consumer. | + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------| +| n/a | | | 204 No Content | The event notification is received successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
(NOTE 2) | + +NOTE 1: 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. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 6.1.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 6.1.5.3 Time Synchronization Configuration Notification + +### 6.1.5.3.1 Description + +The Time Synchronization Configuration Notification is used by the NF service producer to report the current state of configuration of the time synchronization service. + +### 6.1.5.3.2 Target URI + +The Callback URI "{configNotifUri}" shall be used with the callback URI variables defined in table 6.1.5.3.2-1. + +**Table 6.1.5.3.2-1: Callback URI variables** + +| Name | Definition | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| configNotifUri | String formatted as URI with the Callback Uri.
The Callback Uri is assigned within the Time Synchronization Configuration Notification and described within the TimeSyncExposureConfig type (see table 6.1.6.2.9-1). | + +### 6.1.5.3.3 Standard Methods + +#### 6.1.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.3.3.1-1 and the response data structures and response codes specified in table 6.1.5.3.3.1-2. + +**Table 6.1.5.3.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| TimeSyncExposureConfigNotif | M | 1 | Provides the current state of time synchronization configuration by the TSCTSF to the NF service consumer. | + +**Table 6.1.5.3.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------| +| n/a | | | 204 No Content | The event notification is received successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
(NOTE 2) | + +NOTE 1: 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. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.1.5.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 6.1.5.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 6.1.6 Data Model + +### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Ntsctsf\_TimeSynchronization service based interface protocol. + +**Table 6.1.6.1-1: Ntsctsf\_TimeSynchronization specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------------------------|-----------------------|------------------------------------------------------------------------------------------------------------|----------------------| +| ConfigForPort | 6.1.6.2.11 | Contains the configuration for a port. | | +| PtpCapabilitiesPerUe | 6.1.6.2.6 | Contains the PTP capabilities supported by a UE. | | +| PtpInstance | 6.1.6.2.10 | Contains the PTP Instance. | | +| TimeSyncExposureSubsc | 6.1.6.2.2 | Contains the parameters for the subscription to notification of capability of time synchronization service | | +| TimeSyncCapability | 6.1.6.2.5 | Contains the capability of time synchronization service | | +| TimeSyncExposureConfig | 6.1.6.2.9 | Contains the configuration of time synchronization service | | +| TimeSyncExposureConfigNoti
f | 6.1.6.2.7 | Contains the notification of configuration of time synchronization service. | | +| TimeSyncExposureSubsNotif | 6.1.6.2.3 | Contains the notification of time synchronization service. | | +| StateOfConfiguration | 6.1.6.2.8 | Indicates the PTP port states for a NW-TT and DS-TTs. | | +| StateOfDstt | 6.1.6.2.12 | Contains the PTP port state of a DS-TT | | +| SubsEventNotification | 6.1.6.2.4 | Contains the notification of capability of time synchronization for a list of UEs. | | + +Table 6.1.6.1-2 specifies data types re-used by the Ntsctsf\_TimeSynchronization 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 Ntsctsf\_TimeSynchronization service based interface. + +**Table 6.1.6.1-2: Ntsctsf\_TimeSynchronization re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------------------------|---------------------|----------------------------------------------------------------------------------------------------------------|----------------------| +| AcceptanceCriteriaResultIndication | 3GPP TS 29.522 [17] | Contains the acceptable/not acceptable indication of the clock quality acceptance criteria result information. | NetTimeSyncStatus | +| AsTimeResource | 3GPP TS 29.522 [17] | Indicates the supported 5G clock quality. | | +| ClockQualityAcceptanceCriterion | 3GPP TS 29.571 [15] | Identifies clock quality acceptance criteria information. | NetTimeSyncStatus | +| ClockQualityDetailLevel | 3GPP TS 29.571 [15] | Identifies clock quality detail level information. | NetTimeSyncStatus | +| DateTime | 3GPP TS 29.571 [15] | String with format "date-time" as defined in OpenAPI Specification [6]. | | +| DistributionMethod | 3GPP TS 29.522 [17] | Identifies the time synchronization distribution methods supported by 5GS. | | +| Dnn | 3GPP TS 29.571 [15] | The DNN the user is connected to. | | +| DurationSec | 3GPP TS 29.571 [15] | Identifies a period of time in units of seconds. | | +| EventFilter | 3GPP TS 29.522 [17] | Contains the conditions to match for notifying the event. | | +| ExternalGroupId | 3GPP TS 29.571 [15] | Identifies a External Group. | | +| GmCapable | 3GPP TS 29.522 [17] | Indicates separately whether 5GS supports acting as a gPTP or PTP grandmaster. | | +| Gpsi | 3GPP TS 29.571 [15] | The external identification of the user (i.e., an External Id or an MSISDN). | | +| GroupId | 3GPP TS 29.571 [15] | Identifies a group of internal globally unique ID. | | +| ProblemDetails | 3GPP TS 29.571 [15] | Problem Details when returning an error response. | | +| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information. | | +| ServiceAreaCoverageInfo | 3GPP TS 29.534 [14] | It represents a list of Tracking Areas within a serving network. | CoverageAreaSupport | +| Snssai | 3GPP TS 29.571 [15] | Identifies the S-NSSAI. | | +| SubscribedEvent | 3GPP TS 29.522 [17] | Indicates the subscribed event. | | +| Supi | 3GPP TS 29.571 [15] | The identification of the user (i.e. IMSI, NAI). | | +| SupportedFeatures | 3GPP TS 29.571 [15] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | +| TimeSyncExposureConfig | 3GPP TS 29.522 [17] | Contains the parameters of time synchronization configuration. | | +| Uinteger | 3GPP TS 29.571 [15] | Unsigned integer. | | +| Uint64 | 3GPP TS 29.571 [15] | | | +| Uri | 3GPP TS 29.571 [15] | Identifies a referenced resource. | | + +## 6.1.6.2 Structured data types + +### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 6.1.6.2.2 Type: TimeSyncExposureSubsc + +**Table 6.1.6.2.2-1: Definition of type TimeSyncExposureSubsc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supis | array(Supi) | C | 1..N | Subscription Permanent Identifier. (NOTE) | | +| gosis | array(Gpsi) | C | 1..N | Public user identifier. (NOTE) | | +| interGrpId | GroupId | C | 0..1 | The internal Group Id(s). (NOTE) | | +| exterGrpId | ExternalGroupId | C | 0..1 | The external Group Id. (NOTE) | | +| anyUeInd | boolean | C | 0..1 | Identifies whether the AF request applies to any UE (i.e. all UEs). This attribute shall set to "true" if applicable for any UE, otherwise, set to "false". (NOTE) | | +| notifMethod | NotificationMethod | O | 0..1 | If "notifMethod" is not supplied, the default value "ON_EVENT_DETECTION" applies. | | +| dnn | Dnn | M | 1 | Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. | | +| snssai | Snssai | M | 1 | Identifies an S-NSSAI. | | +| subscribedEvents | array(SubscribeEvent) | M | 1..N | Identifies the requirement to be notified of the event(s). | | +| eventFilters | array(EventFilter) | O | 1..N | Contains the filter conditions to match for notifying the event(s) of time synchronization capabilities for a list of UE(s). | | +| subsNotifUri | Uri | M | 1 | Notification URI for time sensitive capability reporting. | | +| subsNotifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| maxReportNbr | UInteger | O | 0..1 | If omitted, there is no limit. | | +| expiry | DateTime | C | 0..1 | This attribute indicates the expiry time of the subscription, after which the NEF shall not send any event notifications and the subscription becomes invalid. It may be included in an event subscription request and may be included in an event subscription response based on operator policies. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. If the expiry time is not included in the response, the NF service consumer shall not associate an expiry time for the subscription. | | +| repPeriod | DurationSec | C | 0..1 | Is supplied for notification Method "periodic". | | +| suppFeat | SupportedFeatures | C | 0..1 | Represents the features supported by the NF service consumer. This parameter | | + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | shall be supplied by the NF service consumer in the POST request and the response that requested the creation of an Individual Time Synchronization Subscription resource. | | +| NOTE: Only one of the properties "supis", "gpps", "anyUeInd", "exterGrpId" or "interGrpId" shall be included. | | | | | | + +#### 6.1.6.2.3 Type: TimeSyncExposureSubsNotif + +**Table 6.1.6.2.3-1: Definition of type TimeSyncExposureSubsNotify** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------------|---|-------------|------------------------------------------------------------------|---------------| +| subsNotifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| eventNotifs | array(SubsEventNotification) | M | 1..N | Notifications about Individual Events | | + +#### 6.1.6.2.4 Type SubsEventNotification + +**Table 6.1.6.2.4-1: Definition of type SubsEventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| event | SubscribedEvent | M | 1 | Subscribed events | | +| timeSyncCapas | array(TimeSyncCapability) | C | 1..N | Contains a list of time synchronization capabilities for the List of User-Plane Node IDs. It shall be provided if the reported event is "AVAILABILITY_FOR_TIME_SYNC_SERVICE". | | + +### 6.1.6.2.5 Type: TimeSyncCapability + +**Table 6.1.6.2.5-1: Definition of type TimeSyncCapability** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| upNodeId | Uint64 | M | 1 | Identifies the applicable NW-TT. Contains a TSC user plane node Id. If integrated with TSN, the user plane node Id is a bridge Id defined in IEEE Std 802.1Q-2018 [18] clause 14.2.5. | | +| gmCapables | array(GmCapable) | C | 1..N | Indicates whether user plane node supports acting as a gPTP and/or PTP grandmaster. (NOTE) | | +| asTimeRes | AsTimeResource | C | 0..1 | Indicates the supported 5G clock quality (i.e. the source of time used by the 5GS). (NOTE) | | +| ptpCapForUes | map(PtpCapabilitiesPerUe) | C | 1..N | Contains the PTP capabilities supported by the list of UE(s). The key of the map is the SUPI. Shall be present if the "gmCapables" attribute is included and the PTP Capabilities are reported per SUPI. | | +| ptpCapForGpsis | map(PtpCapabilitiesPerUe) | C | 1..N | Contains the PTP capabilities supported by the list of UE(s). The key of the map is the GPSI. Shall be present if the "gmCapables" attribute is included and the PTP Capabilities are reported per GPSI. | | + +NOTE: At least one of the "gmCapables" attribute and "asTimeRes" attribute shall be included. + +### 6.1.6.2.6 Type: PtpCapabilitiesPerUe + +**Table 6.1.6.2.6: Definition of type PtpCapabilitiesPerUe** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|--------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies the UE to which the reported PTP instance below apply. (NOTE) | | +| gpsi | Gpsi | C | 0..1 | Identifies the UE to which the reported PTP instance below apply. (NOTE) | | +| ptpCaps | array(EventFilter) | M | 1..N | Contains the reported PTP capabilities for the UE. | | + +NOTE: Either the "supi" or the "gpsi" attribute is included, based on whether the request contained an internal or an external identifier. + +## 6.1.6.2.7 Type: TimeSyncExposureConfigNotif + +Table 6.1.6.2.7-1: Definition of type TimeSyncExposureConfigNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|---------------------------------------------------------------------------|---------------| +| configNotifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| stateOfConfig | StateOfConfiguration | M | 1 | Indicates the current state of time synchronization service configuration | | + +## 6.1.6.2.8 Type: StateOfConfiguration + +Table 6.1.6.2.8-1: Definition of type StateOfConfiguration + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| stateOfNwtt | boolean | O | 0..1 | When any of the PTP port state(s) in NW-TT is Leader, Follower or Passive, it is included and set to true to indicate the current state of the time synchronization configuration for the NW-TT port(s) of the PTP instance is active; when PTP port state is in any other case, it is included and set to false to indicate the state of configuration for the NW-TT port(s) of the PTP instance is inactive. Default value is false. | | +| stateOfDstts | array(StateOfDstt) | O | 1..N | Contains the PTP port states and the clock quality acceptance criteria result of the DS-TT(s). | | + +Editor's note: Whether it is required the report of the clock quality acceptance criteria for the NW-TTP ports (i.e., whether the clkQltIndOfNwtt attribute is needed) is FFS and requires SA2 clarifications. + +## 6.1.6.2.9 Type: TimeSyncExposureConfig + +Table 6.1.6.2.9-1: Definition of type TimeSyncExposureConfig + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| upNodeId | Uint64 | M | 1 | Identifies the applicable NW-TT. Contains a TSC user plane node Id. If integrated with TSN, the user plane node Id is a bridge Id defined in IEEE 802.1Q [41] clause 14.2.5. | | +| reqPtplns | PtpInstance | M | 1 | Identifies the PtP instance configuration and activation requested by the AF. | | +| gmEnable | boolean | O | 0..1 | Indicates that the AF requests 5GS to act as a grandmaster for PTP or gPTP if it is included and set to true. The default value "false" shall apply, if the attribute is not present. | | +| gmPrio | UInteger | O | 0..1 | Indicates a priority used as defaultDS.priority1 when generating Announce message when 5GS acts as (g)PTP GM. It may be present if the "gmEnable" is set to true. | | +| timeDom | UInteger | M | 1 | Indicate the (g)PTP domain that the (TSN)AF is located in. | | +| timeSyncErrBdg
t | UInteger | O | 0..1 | Indicates the time synchronization budget for the time synchronization service in units of nanoseconds. Minimum = 1. | | +| tempValidity | TemporalValidity | O | 0..1 | Indicates the time period when the time synchronization service for a PTP instance is active. | | +| configNotifUri | Uri | M | 1 | Notification URI for configuration state reporting. | | +| configNotifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| covReq | array(ServiceAreaCoverageInfo) | O | 1..N | Identifies a list of Tracking Areas per serving network where the time synchronization service configuration is allowed. | CoverageAreaSupport | +| clkQltDetLvl | ClockQualityDetailLevel | O | 0..1 | Indicates the clock quality detail level. For (g)PTP services, its value, if provided, shall be set to "ACCEPT_INDICATION". | NetTimeSyncStatus | +| clkQltAcptCri | ClockQualityAcceptanceCriterion | C | 0..1 | Indicates the clock quality acceptance criteria, and it is used to determine whether the time synchronization status for the (g)PTP service is acceptable/not acceptable. It shall be present when the "clkQltDetLvl" attribute is present. | NetTimeSyncStatus | + +## 6.1.6.2.10 Type: PtpInstance + +**Table 6.1.6.2.10-1: Definition of type PtpInstance** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|----------------------------------------------------------------------|---------------| +| instanceType | InstanceType | M | 1 | Indicates the PTP instance type. | | +| protocol | Protocol | M | 1 | Indicates the protocol type. | | +| ptpProfile | string | M | 1 | Identifies the PTP profile. | | +| portConfigs | array(ConfigForPort) | O | 1..N | Contains the configurations for the PTP port(s) in the PTP instance. | | + +6.1.6.2.11 Type: ConfigForPort + +**Table 6.1.6.2.11-1: Definition of type ConfigForPort** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies the UE/DS-TT which the parameters below apply.
(NOTE) | | +| gpsi | Gpsi | C | 0..1 | Identifies the UE/ DS-TT which the parameters below apply
(NOTE) | | +| n6Ind | boolean | C | 0..1 | Indicates the N6 termination which the parameters below apply.
(NOTE) | | +| ptpEnable | boolean | O | 0..1 | This is used to set the portDS.portEnable. If omitted, the default value as described in the PTP Profile is used | | +| logSyncInter | integer | O | 0..1 | Specifies the mean time interval between successive Sync messages. This is applicable for IEEE Std 1588-2019 [25] Boundary Clock or IEEE Std 802.1AS-2020 [26] operation. If omitted, the default value as described in the PTP Profile is used. | | +| logSyncInterInd | boolean | O | 0..1 | When set to FALSE, the value of "logSyncInter" attribute is used to set the initialLogSyncInterval as described in IEEE Std 802.1AS-2020 [26]. When set to TRUE, the value of "logSyncInter" attribute is used to set the mgtSettableLogSyncInterval as described in IEEE Std 802.1AS-2020 [26]. If omitted, the default value as described in the IEEE Std 802.1AS-2020 [26] is used. | | +| logAnnouInter | integer | O | 0..1 | Specifies the mean time interval between successive Announce messages. This is applicable for IEEE Std 1588-2019 [25] Boundary Clock or IEEE Std 802.1AS-2020 [26] operation. If omitted, the default value as described in the PTP Profile is used. | | +| logAnnouInterInd | boolean | O | 0..1 | When set to FALSE, the value of "logAnnouInter" attribute is used to set the initialLogAnnounceInterval as described in IEEE 802.1AS-2020 [26]. When set to TRUE, the value of "logAnnouInter" attribute is used to set the mgtSettableLogAnnounceInterval as described in IEEE Std 802.1AS-2020 [26]. If omitted, the default value as described in the IEEE Std 802.1AS-2020 [26] is used. | | + +NOTE: Only one of "supi", "gpsi" or "n6Ind" attribute shall be included. + +## 6.1.6.2.12 Type: StateOfDstt + +**Table 6.1.6.2.12-1: Definition of type StateOfDstt** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| supi | Supi | C | 0..1 | Identifies the UE/DS-TT which the parameters below apply.
(NOTE) | | +| gpsi | Gpsi | C | 0..1 | Identifies the UE/DS-TT which the parameters below apply.
(NOTE) | | +| state | boolean | M | 1 | When the PTP port state is Leader, Follower or Passive, it is included and set to true to indicate the current state of the time synchronization configuration for DS-TT port is active; when PTP port state is in any other case, it is included and set to false to indicate the state of configuration for DS-TT port is inactive. Default value is false. | | +| clkQltIndOfDstts | AcceptanceCriteriaRes
ultIndication | O | 0..1 | Indicates the clock quality acceptance criteria changes ("ACCEPTABLE", "NOT_ACCEPTABLE") for the indicated DS-TT port of the PTP instance. | NetTimeSyncStatus | + +NOTE: Either the "supi" or the "gpsi" attribute is included, based on whether the request contained an internal or an external identifier + +## 6.1.6.3 Simple data types and enumerations + +## 6.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. + +## 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 6.1.7 Error Handling + +## 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [5]. + +For the Ntsctsf\_TimeSynchronization 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 Ntsctsf\_TimeSynchronization API. + +### 6.1.7.2 Protocol Errors + +No specific procedures for the Ntsctsf\_TimeSynchronization service are specified. + +### 6.1.7.3 Application Errors + +The application errors defined for the Ntsctsf\_TimeSynchronization service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------|------------------|------------------------------------------------------------| +| UE_SERVICE_NOT_AUTHORIZED | 403 Forbidden | The requested service for the target UE is not authorized. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Ntsctsf\_TimeSynchronization API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|---------------------|---------------------------------------------------------------------------------------------------------------------------| +| 1 | CoverageAreaSupport | Indicates the support of spatial validity conditions for the activation/deactivation of the time synchronization service. | +| 2 | NetTimeSyncStatus | Indicates the time synchronization service status. | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Ntsctsf\_TimeSynchronization 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 Ntsctsf\_TimeSynchronization 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 Ntsctsf\_TimeSynchronization service. + +The Ntsctsf\_TimeSynchronization API defines a single scope "ntsctsf-time-sync" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 6.2 Ntsctsf\_QoSandTSCAssistance Service API + +### 6.2.1 Introduction + +The Ntsctsf\_QoSandTSCAssistance service shall use the Ntsctsf\_QoSandTSCAssistance API. + +The API URI of the Ntsctsf\_QoSandTSCAssistance API shall be: + +**{apiRoot}/** + +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 [4], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "ntscsf-qos-tscai". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +## 6.2.2 Usage of HTTP + +### 6.2.2.1 General + +HTTP/2, IETF RFC 9113 [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 Ntscsf\_QoSandTSCAssistance API is contained in Annex A. + +### 6.2.2.2 HTTP standard headers + +#### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +#### 6.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". + +JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" and shall be signalled by the content type "application/merge-patch+json", as defined in IETF RFC 7396 [22]. + +"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 9457 [13]. + +### 6.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +In this Release of the specification, no specific custom headers are defined for the Ntscsf\_QoSandTSCAssistance API. + +## 6.2.3 Resources + +### 6.2.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.2.3.1-1 depicts the resource URIs structure for the Ntscsf\_QoSandTSCAssistance API. + +![Figure 6.2.3.1-1: Resource URI structure of the Ntsctsf_QoSandTSCAssistance API. The diagram shows a hierarchical tree structure starting with {apiRoot}/ntsctsf-qos-tscai/{apiVersion}. A line branches down to a box containing /tsc-app-sessions. From this box, a line branches down to a box containing /{appSessionId}. From the /{appSessionId} box, two lines branch out to boxes containing /delete and /events-subscription respectively.](18003425d0e8638dde4acc9c5c468c5c_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ntsctsf-qos-tscai/{apiVersion}"] --> TSC["/tsc-app-sessions"] + TSC --> AppSession["/{appSessionId}"] + AppSession --> Delete["/delete"] + AppSession --> Events["/events-subscription"] + +``` + +Figure 6.2.3.1-1: Resource URI structure of the Ntsctsf\_QoSandTSCAssistance API. The diagram shows a hierarchical tree structure starting with {apiRoot}/ntsctsf-qos-tscai/{apiVersion}. A line branches down to a box containing /tsc-app-sessions. From this box, a line branches down to a box containing /{appSessionId}. From the /{appSessionId} box, two lines branch out to boxes containing /delete and /events-subscription respectively. + +**Figure 6.2.3.1-1: Resource URI structure of the Ntsctsf\_QoSandTSCAssistance API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------|------------------------------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TSC Application Sessions | /tsc-app-sessions | POST | Ntsctsf_QoSandTSCAssistance_Create.
Creates a new Individual TSC Application Session Context resource and may create the child Events Subscription sub-resource. | +| Individual TSC Application Session Context | /tsc-app-sessions/{appSessionId} | PATCH | Ntsctsf_QoSandTSCAssistance_Update.
Updates an existing Individual TSC Application Session Context resource. It can also update an Events Subscription sub-resource. | +| | | GET | Reads an existing Individual TSC Application Session Context resource. | +| | /tsc-app-sessions/{appSessionId}/delete | delete (POST) | Ntsctsf_QoSandTSCAssistance_Delete.
Deletes an existing Individual TSC Application Session Context resource and the child Events Subscription sub-resource. | +| Events Subscription | /tsc-app-sessions/{appSessionId}/events-subscription | PUT | Ntsctsf_QoSandTSCAssistance_Subscribe.
Creates a new Events Subscription sub-resource or modifies an existing Events Subscription sub-resource. | +| | | DELETE | Ntsctsf_QoSandTSCAssistance_Unsubscribe.
Deletes an Events Subscription sub-resource. | + +## 6.2.3.2 Resource: TSC Application Sessions + +### 6.2.3.2.1 Description + +This resource allows a NF service consumer to create a new Individual TSC Application Session Context resource and may create the child Events Subscription sub-resource. + +### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/ntscsf-qos-tscai//tsc-app-sessions + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.2.1 | + +### 6.2.3.2.3 Resource Standard Methods + +#### 6.2.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.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 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| TscAppSessionContextData | M | 1 | Contains the information for the creation of a new Individual TSC Application Session Context resource. | + +**Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| TscAppSessionContextData | M | 1 | 201
Created | The subscription was created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| ProblemDetailsTscsfQosTscac | O | 0..1 | 403
Forbidden | (NOTE 2) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: Failure cases are described in clause 6.2.7. + +**Table 6.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}/ntscsf-qos-tscai//tsc-app-sessions /{appSessionId} | + +**Table 6.2.3.2.3.1-5: Headers supported by the 403 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------|---|-------------|-------------------------------------------------------------------------------------| +| Retry-After | string | M | 1 | Indicates the time the NF service consumer has to wait before making a new request. | + +#### 6.2.3.2.4 Resource Custom Operations + +None. + +#### 6.2.3.3 Resource: Individual TSC Application Session Context + +##### 6.2.3.3.1 Description + +This resource allows a NF service consumer to read, modify or delete an existing Individual TSC Application Session Context resource. + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/ntscsf-qos-tscai//tsc-app-sessions/{appSessionId} + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|-----------|----------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| appSessionId | string | Identifier of an Individual TSC Application Session Context resource | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.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 6.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------| +| TscAppSessionContextData | M | 1 | 200 OK | An Individual TSC Application Session Context resource is returned successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Individual TSC Application Session Context resource retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Individual TSC Application Session Context resource retrieval.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.2.3.3.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.3.3.2-1. + +**Table 6.2.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3. + +**Table 6.2.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|---------------------------------------------------------------------------------------------------| +| TscAppSessionContextUpdateData | M | 1 | Contains the modification(s) to apply to the Individual TSC Application Session Context resource. | + +**Table 6.2.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| TscAppSessionContextData | M | 1 | 200 OK | Successful case.
The Individual TSC Application Session Context resource was modified and a representation of that resource is returned. | +| n/a | | | 204 No Content | Successful case.
The Individual TSC Application Session Context resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Individual TSC Application Session Context resource modification.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Individual TSC Application Session Context resource modification.
(NOTE 3) | +| ProblemDetailsTsctsfQoSTscac | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the PATCH method shall also apply. +NOTE 2: Failure cases are described in clause 6.2.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.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 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.2.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 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.2.3.3.3.2-6: Headers supported by the 403 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------|---|-------------|-------------------------------------------------------------------------------------| +| Retry-After | string | M | 1 | Indicates the time the NF service consumer has to wait before making a new request. | + +### 6.2.3.3.4 Resource Custom Operations + +#### 6.2.3.3.4.1 Overview + +**Table 6.2.3.3.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|-----------------------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| delete | /tsc-app-sessions/{appSessionId}/delete | POST | Ntsctsf_QoSandTSCAssistance_Delete.
Deletes an existing Individual TSC Application Session Context resource and the child Events Subscription sub-resource. | + +#### 6.2.3.3.4.2 Operation: delete + +##### 6.2.3.3.4.2.1 Description + +##### 6.2.3.3.4.2.2 Operation Definition + +This custom operation deletes an existing Individual TSC Application Session Context resource and the child Events Subscription sub-resource in the TSCTSF. + +This operation shall support the request data structures specified in table 6.2.3.3.4.2.2-1 and the response data structure and response codes specified in table 6.2.3.3.4.2.2-2. + +**Table 6.2.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EventsSubscReqData | O | 0..1 | Events subscription information to be sent by the NF service consumer to request event notification when the Individual TSC Application Session Context resource is deleted. | + +**Table 6.2.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case.
The Individual TSC Application Session Context resource was deleted. | +| EventsNotification | M | 1 | 200 OK | Successful case.
Describes information related to the notification of events. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Individual TSC Application Session Context resource deletion.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Individual TSC Application Session Context resource deletion.

(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the POST method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.2.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +## 6.2.3.4 Resource: Events Subscription (Document) + +### 6.2.3.4.1 Description + +The Events Subscription sub-resource represents a subscription to events for a TSC application session context that exists in the Ntscsf\_QoSandTSCAssistance service. + +### 6.2.3.4.2 Resource Definition + +Resource URI: {apiRoot}/ntscsf-qos-tscai//tsc-app-sessions/{appSessionId}/events-subscription + +This resource shall support the resource URI variables defined in table 6.2.3.4.2-1. + +**Table 6.2.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|-----------|-----------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| appSessionId | string | Identifier of an Individual TSC Application Session Context resource. | + +### 6.2.3.4.3 Resource Standard Methods + +#### 6.2.3.4.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.3.4.3.1-1. + +**Table 6.2.3.4.3.1-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 6.2.3.4.3.1-2 and the response data structures and response codes specified in table 6.2.3.4.3.1-3. + +**Table 6.2.3.4.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|------------------------------------------------------------------------------------| +| EventsSubscReqData | M | 1 | Contains information for the modification of the Events Subscription sub-resource. | + +**Table 6.2.3.4.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------| +| EventsSubscReqData | M | 1 | 201 Created | Successful case.
The Events Subscription sub-resource was created. | +| EventsSubscReqData | M | 1 | 200 OK | Successful case.
The Events Subscription sub-resource was modified. | +| n/a | | | 204 No Content | Successful case.
The Events Subscription sub-resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Events Subscription sub-resource creation.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Events Subscription sub-resource creation.

(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the PUT method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.3.4.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}/ntscsf-qos-tscai//tsc-app-sessions/{appSessionId}/events-subscription | + +**Table 6.2.3.4.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.2.3.4.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.2.3.4.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.4.3.2-1. + +**Table 6.2.3.4.3.2-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 6.2.3.4.3.2-2 and the response data structures and response codes specified in table 6.2.3.4.3.2-3. + +**Table 6.2.3.4.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.4.3.2-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 Events Subscription sub-resource was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Events Subscription sub-resource deletion.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Events Subscription sub-resource deletion.

(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the DELETE method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.3.4.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.2.3.4.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.2.3.4.4 Resource Custom Operations + +None. + +### 6.2.4 Custom Operations without associated resources + +None. + +### 6.2.5 Notifications + +#### 6.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 6.2.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------|----------------------|---------------------------------|---------------------------------------------------------------------------| +| Event Notification | {notifUri}/notify | notify (POST) | TSCTSF event notification. | +| Termination Request | {notifUri}/terminate | terminate (POST) | Request for termination of an Individual TSC Application Session Context. | + +#### 6.2.5.2 Event Notification + +##### 6.2.5.2.1 Description + +The Event Notification is used by the TSCTSF to report one or several observed application session context events to the NF service consumer that has subscribed to such notifications via the Events Subscription sub-resource. + +##### 6.2.5.2.2 Target URI + +The Callback URI "{notifUri}/notify " shall be used with the callback URI variables defined in table 6.2.5.2.2-1. + +**Table 6.2.5.2.2-1: Callback URI variables** + +| Name | Definition | +|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | The Notification Uri as assigned within the Events Subscription sub-resource and described within the EventsSubscReqData type (see table 6.2.6.2.3-1) or EventsSubscReqDataRm (see table 6.2.6.2.5-1). | + +##### 6.2.5.2.3 Standard Methods + +###### 6.2.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.2.5.2.3.1-1 and the response data structures and response codes specified in table 6.2.5.2.3.1-2. + +**Table 6.2.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|---------------------------------------------| +| EventsNotification | M | 1 | Provides Information about observed events. | + +**Table 6.2.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------| +| n/a | | | 204 No Content | The event notification is received successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
(NOTE 2) | + +NOTE 1: 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. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 6.2.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 6.2.5.3 Termination Request + +### 6.2.5.3.1 Description + +The Termination Request is used by the TSCTSF to request the NF service consumer the deletion of the Individual TSC Application Session Context resource. + +### 6.2.5.3.2 Target URI + +The Callback URI "{notifUri}/terminate" shall be used with the callback URI variables defined in table 6.2.5.3.2-1. + +**Table 6.2.5.3.2-1: Callback URI variables** + +| Name | Definition | +|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | The Notification Uri as assigned within the Individual TSC Application Session Context resource and described within the TscAppSessionContextData Data type (see table 6.2.6.2.2-1) or TscAppSessionContextUpdateData (see table 6.2.6.2.4-1). | + +### 6.2.5.3.3 Standard Methods + +#### 6.2.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.2.5.3.3.1-1 and the response data structures and response codes specified in table 6.2.5.3.3.1-2. + +**Table 6.2.5.3.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|----------------------------------------------------------| +| TerminationInfo | M | 1 | Provides information about the deletion of the resource. | + +**Table 6.2.5.3.3.1-2: Data structures supported by the POST Response Body** + +| 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.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
(NOTE 2) | + +NOTE 1: 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. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.2.5.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 6.2.5.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 6.2.6 Data Model + +### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Ntsctsf\_QoSandTSCAssistance service based interface protocol. + +**Table 6.2.6.1-1: Ntsctsf\_QoSandTSCAssistance specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------------------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| AdditionalInfoTscsfQoSTscac | 6.2.6.2.8 | Describes additional error information specific for this API. | | +| EventsNotification | 6.2.6.2.6 | Describes the notification(s) about the event(s) occurred within an Individual TSC Application Session Context resource. | | +| EventNotification | 6.2.6.2.7 | Describes the notification for an Event. | | +| EventsSubscReqData | 6.2.6.2.3 | Identifies the events the application subscribes to within an Individual TSC Application Session Context resource | | +| EventsSubscReqDataRm | 6.2.6.2.5 | This data type is defined in the same way as the "EventsSubscReqData" data type, but with the OpenAPI "nullable: true" property. | | +| ProblemDetailsTscsfQoSTscac | 6.2.6.4.1 | Problem details as defined in 3GPP TS 29.571 [15] extended with specific error information for this API, as described in AdditionalInfoTscsfQoSTscac data type. | | +| TemporalInvalidity | 6.2.6.2.9 | Indicates the time interval during which the NF service consumer request shall not to be applied. | GMEC | +| TscAppSessionContextData | 6.2.6.2.2 | Represents the Individual TSC Application Session Context resource data. | | +| TscAppSessionContextUpdateData | 6.2.6.2.4 | Describes the modifications to an Individual TSC Application Session Context resource. | | +| TscEvent | 6.2.6.3.3 | Indicates the subscribed event(s). | | + +Table 6.2.6.1-2 specifies data types re-used by the Ntsctsf\_QoSandTSCAssistance 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 Ntsctsf\_QoSandTSCAssistance service based interface. + +**Table 6.2.6.1-2: Ntsctsf\_QoSAndTSCAssistance re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| AcceptableServiceInfo | 3GPP TS 29.514 [20] | Acceptable maximum requested bandwidth. | | +| AccumulatedUsage | 3GPP TS 29.122 [21] | Accumulated Usage. | | +| AspId | 3GPP TS 29.514 [20] | Contains an identity of an application service provider. | | +| BatOffsetInfo | 3GPP TS 29.514 [20] | Contains the offset of the BAT and the optionally adjusted periodicity. | EnTSCAC | +| DateTime | 3GPP TS 29.571 [15] | Represents a date and a time. | GMEC | +| Dnn | 3GPP TS 29.571 [15] | The DNN the user is connected to. | | +| ExternalGroupId | 3GPP TS 29.571 [15] | Identifies an External Group. | GMEC | +| EthFlowDescription | 3GPP TS 29.514 [20] | Defines a packet filter for an Ethernet flow. | | +| EthFlowInfo | 3GPP TS 29.122 [21] | Contains an UL and/or DL Flow information. | Ethernet_UL/DL_Flows | +| FlowInfo | 3GPP TS 29.122 [21] | Contains the IP data flow information. | | +| Gpsi | 3GPP TS 29.571 [15] | Represents a GPSI. | GMEC | +| IpAddr | 3GPP TS 29.571 [15] | Contains the IP address. | | +| MacAddr48 | 3GPP TS 29.571 [15] | MAC Address. | | +| ProblemDetails | 3GPP TS 29.571 [15] | Problem Details when returning an error response. | | +| QosMonitoringInformation | 3GPP TS 29.122 [21] | Contains Qos Monitoring information. | | +| QosMonitoringInformationRm | 3GPP TS 29.122 [21] | This data type is defined in the same way as the "QosMonitoringInformation" data type, but with the OpenAPI "nullable: true" property. | | +| QosMonitoringReport | 3GPP TS 29.122 [21] | Contains Qos Monitoring Report information. | | +| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information. | | +| Snssai | 3GPP TS 29.571 [15] | Identifies the S-NSSAI. | | +| SponId | 3GPP TS 29.514 [20] | Contains an Identity of a sponsor. | | +| SponsoringStatus | 3GPP TS 29.514 [20] | Represents whether sponsored data connectivity is enabled or disabled/not enabled. | | +| SubscribedEvent | 3GPP TS 29.522 [17] | Indicates the subscribed event. | | +| SupportedFeatures | 3GPP TS 29.571 [15] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | +| TerminationInfo | 3GPP TS 29.514 [20] | Includes information related to the termination of the Individual TSC Application Session Context resource. | | +| TscQosRequirement | 3GPP TS 29.122 [21] | Contains the QoS requirements for time sensitive communication. | | +| TscQosRequirementRm | 3GPP TS 29.122 [21] | This data type is defined in the same way as the "TscQosRequirement" data type, but with removable attributes. | | +| UsageThreshold | 3GPP TS 29.122 [21] | Time period and/or traffic volume in which the QoS is to be applied. | | +| UsageThresholdRm | 3GPP TS 29.122 [21] | This data type is defined in the same way as the "UsageThreshold" data type, but with the OpenAPI "nullable: true" property. | | +| Uri | 3GPP TS 29.571 [15] | Identifies a referenced resource. | | + +## 6.2.6.2 Structured data types + +### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 6.2.6.2.2 Type TscAppSessionContextData + +**Table 6.2.6.2.2-1: Definition of type TscAppSessionContextData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| uelpAddr | IpAddr | C | 0..1 | The address of the UE.
(NOTE 1) (NOTE 5) | | +| ipDomain | string | C | 0..1 | The IPv4 address domain identifier.

The attribute may only be provided if the uelpAddr attribute is present and contains an IPv4 address. | | +| ueMac | MacAddr48 | C | 0..1 | Identifies the MAC address.
(NOTE 1) (NOTE 5) | | +| ueId | Gpsi | C | 0..1 | The identity of the targeted UE.

(NOTE 5) | GMEC | +| externalGroupId | ExternalGroupId | C | 0..1 | Identifies the targeted group of UE(s).

(NOTE 5) | GMEC | +| dnn | Dnn | O | 0..1 | Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. | | +| snssai | Snssai | O | 0..1 | Identifies the S-NSSAI. | | +| notifUri | Uri | M | 1 | Notification URI for Individual TSC Application Session Context termination requests. | | +| appId | string | C | 0..1 | Contains the Application Identifier.
(NOTE 1) | | +| flowInfo | array(FlowInfo) | C | 1..N | Describe the IP data flow which requires QoS.
(NOTE 1) (NOTE 4) | | +| enEthFlowInfo | array(EthFlowInfo) | C | 1..N | Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow identifier and the corresponding UL and/or DL flows.
(NOTE 1) (NOTE 4) | Ethernet_UL/DL_Flows | +| ethFlowInfo | array(EthFlowDescription) | C | 1..N | Identifies Ethernet packet flows.
(NOTE 1) | | +| afId | string | M | 1 | Identifies the AF identifier. | | +| tscQosReq | TscQosRequirement | C | 0..1 | Contains the QoS requirements for time sensitive communication. (NOTE 2) | | +| qosReference | string | C | 0..1 | Identifies a pre-defined QoS information. (NOTE 2) (NOTE 3) | | +| altQosReferences | array(string) | C | 1..N | Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. (NOTE 3) | | +| altQosReqs | array(AlternativeServiceRequirementsData) | C | 1..N | Identifies an ordered list of alternative service requirements that include individual QoS parameter set(s). The lower the index of the array for a given entry, the higher the priority. (NOTE 3) | | +| sponId | SponId | O | 0..1 | Sponsor identity. | | +| aspId | AspId | O | 0..1 | Contains the Application service provider identity. It shall be included if sponsored connectivity is applicable. | | +| sponStatus | SponsoringStatus | O | 0..1 | Indication of whether sponsored connectivity is enabled or disabled/not enabled.

The absence of the attribute indicates that the sponsored connectivity is enabled. | | +| evSubsc | EventsSubscReqData | O | 0..1 | Identifies the events the application subscribes to at creation of an Individual TSC Application Session Context resource. | | +| tempInValidity | TemporalInValidity | O | 0..1 | Indicates the time interval during which the AF request is not to be applied. | GMEC | + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 6.2.8.
It shall be supplied by the NF service consumer in the POST request and response of requests a creation of an Individual TSC Application Session Context resource. | | +| NOTE 1: When the "GMEC" feature is not supported, either the "uelpAddr" attribute or the "ueMac" attribute shall be included. If IP address is provided, IP flow information shall be provided. If ipv4, the domain identifier may be provided. If mac address is provided, Ethernet flow information shall be provided. One of IP flow information, Ethernet flow information or Application Identifier shall be provided. | | | | | | +| NOTE 2: The attributes "reqGbrDI", "reqGbrUI", "reqMbrDI", "reqMbrUI", "maxTscBurstSize", "req5Gsgdelay", "reqPer" (if the ExtQoS feature is supported), and "priority" within the "tscQosReq" attribute may be provided only if the "qosReference" attribute is not provided. At least one of the "tscQosReq" attribute or the "qosReference" attribute shall be included. | | | | | | +| NOTE 3: The attributes "altQoSReferences" and "altQosReqs" are mutually exclusive. The attributes "qosReference" and "altQosReqs" are also mutually exclusive. | | | | | | +| NOTE 4: When the Ethernet flow information is provided and the Ethernet_UL/DL_Flows feature is supported, either the "ethFlowInfo" or the "enEthFlowInfo" shall be provided, but not both simultaneously. | | | | | | +| NOTE 5: When the "GMEC" feature is supported, the "ueld" attribute and the "externalGroupId" attribute are mutually exclusive. If either the "ueld" attribute or the "externalGroupId" attribute are present, then neither the "uelpAddr" attribute nor the "ueMac" attribute shall be present. | | | | | | + +### 6.2.6.2.3 Type EventsSubscReqData + +**Table 6.2.6.2.3-1: Definition of type EventsSubscReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| events | array(TscEvent) | M | 1..N | Subscribed Events. | | +| notifUri | Uri | M | 1 | Notification URI for event notification. | | +| qosMon | QosMonitoringInformation | C | 0..1 | Qos Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed. | | +| usgThres | UsageThreshold | C | 0..1 | Includes the volume and/or time thresholds for sponsored data connectivity. It can be present when the event "USAGE_REPORT" is subscribed. | | +| notifCorrelId | string | M | 1 | It is used to set the value of Notification Correlation ID in the corresponding notification. | | + +#### 6.2.6.2.4 Type TscAppSessionContextUpdateData + +**Table 6.2.6.2.4-1: Definition of type TscAppSessionContextUpdateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| notifUri | Uri | O | 0..1 | Notification URI for Individual TSC Application Session Context termination requests. | | +| appId | string | O | 0..1 | Identifies the external Application Identifier. (NOTE 1) | | +| flowInfo | array(FlowInfo) | O | 1..N | Describe the IP data flow which requires QoS. (NOTE 1) | | +| ethFlowInfo | array(EthFlowDescription) | O | 1..N | Identifies Ethernet packet flows. (NOTE 1) (NOTE 4) | | +| enEthFlowInfo | array(EthFlowInfo) | C | 1..N | Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow identifier and the corresponding UL and/or DL flows. (NOTE 1) (NOTE 4) | Ethernet_UL/DL_Flows | +| tscQosReq | TscQosRequirementRm | C | 0..1 | Contains the QoS requirements for time sensitive communication. (NOTE 2) | | +| qosReference | string | C | 0..1 | Identifies a pre-defined QoS information. (NOTE 2) (NOTE 3) | | +| altQosReferences | array(string) | C | 1..N | Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. (NOTE 3) | | +| altQosReqs | array(AlternativeServiceRequirementsData) | C | 1..N | Identifies an ordered list of alternative service requirements that include individual QoS parameter set(s). The lower the index of the array for a given entry, the higher the priority. (NOTE 3) | | +| evSubsc | EventsSubscReqDataRm | O | 0..1 | Identifies the events the application subscribes to at modification of an Individual TSC Application Session Context resource. | | +| sponId | SponId | O | 0..1 | Sponsor identity. | | +| aspld | Aspld | O | 0..1 | Application service provider identity. It may be included if sponsored connectivity is applicable. | | +| sponStatus | SponsoringStatus | O | 0..1 | Indication of whether sponsored connectivity is enabled or disabled/not enabled.
The absence of the attribute indicates that the sponsored connectivity is enabled. | | +| templnValidity | TemporalInValidity | O | 0..1 | Indicates the time interval during which the AF request is not to be applied. | GMEC | + +NOTE 1: One of IP flow information, Ethernet flow information or Application Identifier may be provided. +NOTE 2: Either "tscQosReq" attribute or "qosReference" attribute may be provided. +NOTE 3: The attributes "altQoSReferences" and "altQosReqs" are mutually exclusive. The attributes "qosReference" and "altQosReqs" are also mutually exclusive. +NOTE 4: When the Ethernet flow information is provided and the Ethernet\_UL/DL\_Flows feature is supported, either the "ethFlowInfo" or the "enEthFlowInfo" may be provided, but not both simultaneously. + +#### 6.2.6.2.5 Type EventsSubscReqDataRm + +This data type is defined in the same way as the "EventsSubscReqData" data type, but: + +- with the OpenAPI "nullable: true" property; and +- the removable attribute "usgThres" is defined with the removable data type "UsageThresholdRm"; and removable attribute "qosMon" is defined with the removable data type "QosMonitoringInformationRm". + +**Table 6.2.6.2.5-1: Definition of type EventsSubscReqDataRm** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| events | array(TscEvent) | M | 1..N | Subscribed Events. | | +| notifUri | Uri | O | 0..1 | Notification URI for event notification. | | +| qosMon | QosMonitoringInformationRm | O | 0..1 | Qos Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed. | | +| usgThres | UsageThresholdRm | C | 0..1 | Includes the volume and/or time thresholds for sponsored data connectivity. It can be present when the notified event is "USAGE_REPORT". | | +| notifCorreId | string | O | 0..1 | It is used to set the value of Notification Correlation ID in the corresponding notification. | | + +#### 6.2.6.2.6 Type EventsNotification + +**Table 6.2.6.2.6-1: Definition of type EventsNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|-----------------------------------------------------------------------------------------------|---------------| +| notifCorreId | string | M | 1 | It is used to set the value of Notification Correlation ID in the corresponding notification. | | +| events | array(EventNotification) | M | 1..N | Contains the reported event(s). | | + +### 6.2.6.2.7 Type EventNotification + +**Table 6.2.6.2.7-1: Definition of type EventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| event | TscEvent | M | 1 | Indicates the event reported by the TSCTSF. | | +| flowIds | array(integer) | O | 1..N | Identifies the flows that were sent during event subscription | | +| qosMonReports | array(QosMonitoringReport) | C | 1..N | QoS Monitoring reporting information. It shall be present when the notified event is "QOS_MONITORING". | | +| appliedQosRef | string | C | 0..1 | The currently applied alternative QoS requirement referring to an alternative QoS reference or a requested alternative QoS parameter set. Applicable for event QOS_NOT_GUARANTEED or SUCCESSFUL_RESOURCES_ALLOCATION.
When it is omitted and the "event" attribute is QOS_NOT_GUARANTEED, the event report indicates that the lowest priority alternative QoS profile could not be fulfilled either. | | +| usgRep | AccumulatedUsage | C | 0..1 | Indicates the measured volume and/or time for sponsored data connectivity. Applicable for event USAGE_REPORT. | | +| altQosNotSupplnd | boolean | O | 0..1 | It may be set to true when the "event" attribute is QOS_NOT_GUARANTEED to indicate that alternative service requirements are not supported by NG-RAN. The default value false shall apply if the attribute is not present. | AltQoSProfiles SupportReport | +| batOffsetInfo | BatOffsetInfo | C | 0..1 | The offset of the BAT and the optionally adjusted periodicity.
It shall be present if available when the notified event is "BAT_OFFSET_INFO". | EnTSCAC | + +### 6.2.6.2.8 Type AdditionalInfoTsctsfQosTscac + +**Table 6.2.6.2.8-1: Definition of type AdditionalInfoTsctsfQosTscac** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| acceptableServInfo | AcceptableServiceInfo | O | 0..1 | Describes information related to the acceptable service information, i.e., the maximum acceptable bandwidth for an AF session and/or for specific media components. | | + +### 6.2.6.2.9 Type TemporalValidity + +**Table 6.2.6.2.9-1: Definition of type TemporalValidity** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| startTime | DateTime | M | 1 | Indicates the time from which the traffic routing requirements cease to apply.

The absence of this attribute indicates that the traffic routing requirements do not end at any time. | | +| stopTime | DateTime | M | 1 | Indicates the time starting from which the traffic routing requirements start to apply.

The absence of this attribute indicates the traffic routing requirements apply immediately. | | + +### 6.2.6.3 Simple data types and enumerations + +#### 6.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. + +#### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|------------------------------------------------------------------|-------------|---------------| +| | | | | + +#### 6.2.6.3.3 Enumeration: TscEvent + +The enumeration TscEvent represents event for TSC. It shall comply with the provisions defined in table 6.2.6.3.3-1. + +**Table 6.2.6.3.3-1: Enumeration TscEvent** + +| Enumeration value | Description | Applicability | +|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| FAILED_RESOURCES_ALLOCATION | Indicates that one or more of the SDFs of an Individual TSC Application Session Context are deactivated. It also indicates that the resources requested for a particular service information cannot be successfully allocated. | | +| SUCCESSFUL_RESOURCES_ALLOCATION | Indicates that the resources requested for particular service information have been successfully allocated. | | +| QOS_GUARANTEED | The QoS targets of one or more SDFs are guaranteed again. | | +| QOS_NOT_GUARANTEED | The QoS targets of one or more SDFs are not being guaranteed. | | +| QOS_MONITORING | Indicates a QoS monitoring event. | | +| USAGE_REPORT | Volume and/or time usage for sponsored data connectivity. | | +| BAT_OFFSET_INFO | Indicates the BAT offset and the optionally adjusted periodicity. | EnTSCAC | + +## 6.2.6.4 Data types describing alternative data types or combinations of data types + +### 6.2.6.4.1 Type: ProblemDetailsTsctsfQosTscac + +**Table 6.2.6.4.1-1: Definition of type ProblemDetailsTsctsfQosTscac as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|------------------------------|-------------|---------------------------------------------------------------------------------------|---------------| +| ProblemDetails | 1 | Problem details when returning an error response as specified in 3GPP TS 29.571 [15]. | | +| AdditionalInfoTsctsfQosTscac | 1 | Describes additional error information specific for this API. | | + +## 6.2.7 Error Handling + +### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +For the Ntsctsf\_QoSandTSCAssistance 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 Ntsctsf\_QoSandTSCAssistance API. + +### 6.2.7.2 Protocol Errors + +No specific procedures for the Ntsctsf\_QoSandTSCAssistance service are specified. + +### 6.2.7.3 Application Errors + +The application errors defined for the Ntsctsf\_QoSandTSCAssistance service are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------|---------------------------|--------------------------------------------------------------------------| +| REQUESTED_SERVICE_NOT_AUTHORIZED | 403 Forbidden | The service information provided in the request is rejected. | +| REQUESTED_SERVICE_TEMPORARILY_NOT_AUTHORIZED | 403 Forbidden | The service information provided in the request is temporarily rejected. | +| UNAUTHORIZED_SPONSORED_DATA_CONNECTIVITY | 403 Forbidden | The request for sponsored data connectivity is not authorized. | +| PDU_SESSION_NOT_AVAILABLE | 500 Internal Server Error | The PDU session is not found for the provided UE address. | + +## 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the Ntsctsf\_QoSandTSCAssistance API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Ethernet_UL/DL_Flows | Indicates the support of the description of the Ethernet flows as the combination of Flow Identifier, and UL and/or DL Ethernet flows. | +| 2 | PacketDelayFailureReport | Indicates the support of packet delay failure report as part of QoS Monitoring procedures. | +| 3 | ExtQoS | Indicates the support of extended QoS parameters. | +| 4 | EnTSCAC | Indicates the support of extensions to TSCAC, e.g. burst arrival time window adaptation, periodicity adjustment, and subsequent BAT offset report. | +| 5 | AltQoSProfilesSupportReport | This feature indicates the support of the report of whether Alternative QoS parameters are supported by NG-RAN. | +| 6 | GMEC | This feature indicates the support of Generic Group Management, Exposure and Communication Enhancements.
The following functionalities are supported:
- AF requested QoS for a UE or a group of UE(s) not identified by UE address. | + +## 6.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Ntsctsf\_QoSandTSCAssistance 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 Ntsctsf\_QoSandTSCAssistance 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 Ntsctsf\_QoSandTSCAssistance service. + +The Ntsctsf\_QoSandTSCAssistance API defines a single scope "ntsctsf-qos-tscai" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 6.3 Ntsctsf\_ASTI Service API + +### 6.3.1 Introduction + +The Ntsctsf\_ASTI service shall use the Ntsctsf\_ASTI API. + +The API URI of the Ntsctsf\_ASTI API shall be: + +**{apiRoot}//** + +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}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "ntsctsf-asti". +- The shall be "v1". +- The shall be set as described in clause 6.3.3. + +## 6.3.2 Usage of HTTP + +### 6.3.2.1 General + +HTTP/2, IETF RFC 9113 [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 Ntsctsf\_ASTI API is contained in Annex A. + +### 6.3.2.2 HTTP standard headers + +#### 6.3.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +#### 6.3.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 9457 [13]. + +### 6.3.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +In this Release of the specification, no specific custom headers are defined for the Ntsctsf\_ASTI API. + +## 6.3.3 Resources + +### 6.3.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.2.3.1-1 depicts the resource URIs structure for the Ntsctsf\_ASTI API. + +![Diagram showing the resource URI structure of the Ntscts-f_ASTI API. The root path is {apiRoot}/ntscts-f-asti/. It branches into /configurations, which further branches into /configId and /retrieve.](da85343976fdbb19f866d9ddbdad0eae_img.jpg) + +{apiRoot}/ntscts-f-asti/ + +``` + +graph TD + Root["{apiRoot}/ntscts-f-asti/"] --> Configurations["/configurations"] + Configurations --> ConfigId["/{configId}"] + Configurations --> Retrieve["/retrieve"] + +``` + +Diagram showing the resource URI structure of the Ntscts-f\_ASTI API. The root path is {apiRoot}/ntscts-f-asti/. It branches into /configurations, which further branches into /configId and /retrieve. + +**Figure 6.3.3.1-1: Resource URI structure of the Ntscts-f\_ASTI API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.3.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------|----------------------------|---------------------------------|-------------------------------------------------------------------------------| +| ASTI Configurations | /configurations | POST | Create a new configuration of the 5G access stratum time distribution. | +| | | retrieve (POST) | Request the status of the access stratum time distribution for a list of UEs. | +| Individual ASTI Configuration | /configurations/{configId} | PUT | Request to update the 5G access stratum time distribution configuration. | +| | | DELETE | Request to delete the 5G access stratum time distribution configuration. | + +**Editor's note:** It is FFS whether a new resource and applicable methods are required to support the subscription to notification of the status of the ASTI time synchronization service. + +### 6.3.3.2 Resource: ASTI Configurations + +#### 6.3.3.2.1 Description + +This resource allows a NF service consumer to create a new Individual ASTI Configuration resource. + +#### 6.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/ntscts-f-asti//configurations + +This resource shall support the resource URI variables defined in table 6.3.3.2.2-1. + +**Table 6.3.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.3.1 | + +### 6.3.3.2.3 Resource Standard Methods + +#### 6.3.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.3.3.2.3.1-1. + +**Table 6.3.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 6.3.3.2.3.1-2 and the response data structures and response codes specified in table 6.3.3.2.3.1-3. + +**Table 6.3.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|--------------------------------------------------------------------------------------------| +| AccessTimeDistributionData | M | 1 | Contains the information for the creation of a new Individual ASTI Configuration resource. | + +**Table 6.3.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AccessTimeDistributionData | M | 1 | 201
Created | The resource was created successfully and a representation of the created resource is returned.

The URI of the created resource shall be returned in the "Location" HTTP header. | +| ProblemDetails | O | 0..1 | 403
Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.3.7. + +**Table 6.3.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}/ntscstf-asti//configurations/{configId} | + +### 6.3.3.2.4 Resource Custom Operations + +#### 6.3.3.2.4.1 Overview + +**Table 6.3.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|--------------------------|--------------------|----------------------------------------------------------------------------------| +| retrieve | /configurations/retrieve | retrieve (POST) | Request the status of the 5G access stratum time distribution for a list of UEs. | + +6.3.3.2.4.2 Operation: retrieve + +6.3.3.2.4.2.1 Description + +6.3.3.2.4.2.2 Operation Definition + +This custom operation retrieves the status of the access stratum time distribution for a list of UEs. + +This operation shall support the request data structures specified in table 6.3.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.3.3.2.4.2.2-2. + +**Table 6.3.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| Status requestData | M | 1 | Parameters to be sent by the NF service consumer when the status of the 5G access stratum time distribution for a list of UEs is requested. | + +**Table 6.3.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------| +| Status Response Data | M | 1 | 200 OK | Status of the 5G access stratum time distribution for a list of UEs is returned. | +| 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] shall also apply. | | | | | + +6.3.3.3 Resource: Individual ASTI Configuration + +6.3.3.3.1 Description + +This resource allows a NF service consumer to read, modify or delete an existing Individual ASTI Configuration resource. + +6.3.3.3.2 Resource Definition + +Resource URI: {apiRoot}/ntscsf-asti//configurations/{configId} + +This resource shall support the resource URI variables defined in table 6.3.3.3.2-1. + +**Table 6.3.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|----------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| configId | string | Identifier of an Individual ASTI Configuration resource. | + +6.3.3.3.3 Resource Standard Methods + +6.3.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 6.3.3.3.3.2-1. + +**Table 6.3.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 6.3.3.3.3.2-2 and the response data structures and response codes specified in table 6.3.3.3.3.2-3. + +**Table 6.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|--------------------------------------------------------------------------------------| +| AccessTimeDistributionData | M | 1 | Contains the modification(s) to apply to the Individual ASTI Configuration resource. | + +**Table 6.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| AccessTimeDistributionData | M | 1 | 200 OK | Successful case. The Individual ASTI Configuration resource was modified and a representation of that resource is returned. | +| n/a | | | 204 No Content | Successful case. The Individual ASTI Configuration resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Individual ASTI Configuration resource modification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Individual ASTI Configuration resource modification.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 3) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the PUT method shall also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +NOTE 3: Failure cases are described in clause 6.3.7. + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.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 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +### 6.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.3.3.3.3-1. + +**Table 6.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 6.3.3.3.3-2 and the response data structures and response codes specified in table 6.3.3.3.3-3. + +**Table 6.3.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.3.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 | The configuration was terminated successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during an Individual ASTI Configuration resource modification deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during an Individual ASTI Configuration resource modification deletion.
(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the DELETE method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.3.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 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +**Table 6.3.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 | Contains an alternative URI of the resource located in an alternative TSCTSF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target TSCTSF (service) instance towards which the request is redirected. | + +#### 6.3.3.3.4 Resource Custom Operations + +None. + +### 6.3.4 Custom Operations without associated resources + +None. + +## 6.3.5 Notifications + +### 6.3.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 6.3.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------|----------------|---------------------------------|---------------------------------| +| ASTI Notification | {astiNotifUri} | POST | ASTI notification. | + +### 6.3.5.2 ASTI Notification + +#### 6.3.5.2.1 Description + +The ASTI Notification is used by the NF service producer to report the changes on the ASTI service. + +#### 6.3.5.2.2 Target URI + +The Callback URI "{astiNotifUri}" shall be used with the callback URI variables defined in table 6.3.5.2.2-1. + +**Table 6.3.5.2.2-1: Callback URI variables** + +| Name | Definition | +|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| astiNotifUri | String formatted as URI with the Callback Uri.
The Callback Uri is assigned within the Individual ASTI Configuration resource and described within the AccessTimeDistributionData data type (see table 6.3.6.2.2-1). | + +#### 6.3.5.2.3 Standard Methods + +##### 6.3.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.3.5.2.3.1-1 and the response data structures and response codes specified in table 6.3.5.2.3.1-1. + +**Table 6.3.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-------------------------------------------------------------------------------| +| AstiConfigNotification | M | 1 | Provides the change in the 5G Access Stratum Time Distribution configuration. | + +**Table 6.3.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------| +| n/a | | | 204 No Content | The event notification is received successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
(NOTE 2) | + +NOTE 1: 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. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 6.3.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 6.3.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 6.3.6 Data Model + +### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.1-1 specifies the data types defined for the Ntsctsf\_ASTI service based interface protocol. + +**Table 6.3.6.1-1: Ntsctsf\_ASTI specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-----------------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------| +| AccessTimeDistributionData | 6.3.6.2.2 | Contains the parameters for the creation of 5G access stratum time distribution configuration. | | +| ActiveUe | 6.3.6.2.6 | Contains the UE identifier whose status of the access stratum time distribution is active and the optional requested time synchronization error budget. | | +| AstiConfigNotification | 6.3.6.2.7 | Contains the report of a change in the 5G Access Stratum Time Distribution parameters applied to the UE(s). | ASTIConfigReport | +| AstiConfigStateNotification | 6.3.6.2.8 | Contains the report about a change in the 5G Access Stratum Time Distribution parameters for a UE. | ASTIConfigReport
NetTimeSyncStatus | +| AstiEvent | 6.3.6.3.3 | ASTI Event. | ASTIConfigReport
NetTimeSyncStatus | +| AsTimeDistributionParam | 6.3.6.2.3 | Contains the 5G access stratum time distribution parameters. | | +| StatusRequestData | 6.3.6.2.4 | Contains the parameters for retrieval of the status of the access stratum time distribution for a list of UEs. | | +| StatusResponseData | 6.3.6.2.5 | Contains the parameters for the status of the access stratum time distribution for a list of UEs. | | + +Table 6.3.6.1-2 specifies data types re-used by the Ntsctsf\_ASTI 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 Ntsctsf\_ASTI service based interface. + +**Table 6.3.6.1-2: Ntsctsf\_ASTI re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|---------------------------------|---------------------|----------------------------------------------------------------------------------------|---------------------------------------| +| ClockQualityAcceptanceCriterion | 3GPP TS 29.571 [15] | Identifies clock quality acceptance criteria information. | NetTimeSyncStatus | +| ClockQualityDetailLevel | 3GPP TS 29.571 [15] | Indicates the clock quality detail level information. | NetTimeSyncStatus | +| ExternalGroupId | 3GPP TS 29.571 [15] | Identifies an External Group. | | +| Gpsi | 3GPP TS 29.571 [15] | The external identification of the user (i.e., an External Id or an MSISDN). | | +| GroupId | 3GPP TS 29.571 [15] | Identifies a group of internal globally unique ID. | | +| ProblemDetails | 3GPP TS 29.571 [15] | Problem Details when returning an error response. | | +| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information. | | +| ServiceAreaCoverageInfo | 3GPP TS 29.534 [14] | It represents a list of Tracking Areas within a serving network. | CoverageAreaSupport | +| Supi | 3GPP TS 29.571 [15] | The identification of the user (i.e. IMSI, NAI). | | +| SupportedFeatures | 3GPP TS 29.571 [15] | Used to negotiate the applicability of the optional features defined in table 6.3.8-1. | | +| TemporalValidity | 3GPP TS 29.514 [20] | TemporalValidity | | +| Uinteger | 3GPP TS 29.571 [15] | Unsigned integer. | | +| Uri | 3GPP TS 29.571 [15] | Identifies a referenced resource. | ASTIConfigReport
NetTimeSyncStatus | + +### 6.3.6.2 Structured data types + +#### 6.3.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 6.3.6.2.2 Type: AccessTimeDistributionData + +**Table 6.3.6.2.2-1: Definition of type AccessTimeDistributionData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| supis | array(Supi) | C | 1..N | Subscription Permanent Identifier(s). (NOTE 1) | | +| gpsi | array(Gpsi) | C | 1..N | Public user Identifier(s). (NOTE 1) | | +| interGrpId | GroupId | C | 0..1 | The internal Group Id(s). (NOTE 1) | | +| exterGrpId | ExternalGroupId | C | 0..1 | The external Group Id(s). (NOTE 1) | | +| asTimeDisParam | AsTimeDistributionParam | M | 1 | 5G access stratum time distribution parameters. (NOTE 2) | | +| covReq | array(ServiceAreaCoverageInfo) | O | 1..N | Identifies a list of Tracking Areas per serving network where the 5GS access stratum time distribution service is allowed. | CoverageAreaSupport | +| astiNotifUri | Uri | C | 0..1 | Notification URI for reporting changes in 5G access stratum time distribution status, and/or reporting the 5G access stratum time distribution information. It shall be provided if the ASTIConfigReport feature is supported and/or the NetTimeSyncStatus feature is supported. | ASTIConfigReport | +| astiNotifId | string | C | 0..1 | Notification Correlation ID assigned by the NF service consumer. It shall be provided if the ASTIConfigReport feature is supported. | ASTIConfigReport | +| suppFeat | SupportedFeatures | C | 0..1 | Represents the features supported by the NF service consumer. This parameter shall be supplied by the NF service consumer in the POST request and the response that requested the creation of an Individual ASTI Configuration resource. | | + +NOTE 1: One of "supis", "gpsi", "exterGroupId" or "interGrpId" attributes shall be provided. + +NOTE 2: If the feature "NetTimeSyncStatus" is supported, the "clkQltDetLvl" and "clkQltAcptCri" attributes within the AsTimeDistributionParam data type shall be present together with the "astiNotifUri" attribute. + +## 6.3.6.2.3 Type: AsTimeDistributionParam + +Table 6.3.6.2.3-1: Definition of type AsTimeDistributionParam + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| asTimeDisEnabled | boolean | O | 0..1 | When this attribute is included and set to true, it indicates that the access stratum time distribution via Uu reference point is activated.
When present it shall be set as follows:
- true: activated.
- false (default): deactivated. | | +| timeSyncErrBdgt | UInteger | O | 0..1 | Indicates the time synchronization error budget in terms of time units of nanoseconds. | | +| tempValidity | TemporalValidity | O | 0..1 | Indicates the time interval during which the AF request is to be applied. | | +| clkQltDetLvl | ClockQualityDetailLevel | O | 0..1 | For ASTI services, its value, if provided, shall be set to "ACCEPT_INDICATION" | NetTimeSyncStatus | +| clkQltAcptCri | ClockQualityAcceptanceCriterion | C | 0..1 | It indicates the acceptable clock quality acceptance criteria for the UE, and it is used to determine whether the time synchronization status for the ASTI service is acceptable/not acceptable. It shall be present when the "clkQltDetLvl" attribute is present. | NetTimeSyncStatus | + +## 6.3.6.2.4 Type: Status requestData + +Table 6.3.6.2.4-1: Definition of type Status requestData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------------|-------------|---|-------------|---------------------------------------|---------------| +| supis | array(Supi) | C | 1..N | Subscription Permanent Identifier(s). | | +| gpsi | array(Gpsi) | C | 1..N | Public User Identifier(s). | | +| NOTE: Either the "supis" or the "gpsi" attribute is included. | | | | | | + +## 6.3.6.2.5 Type: StatusResponseData + +Table 6.3.6.2.5-1: Definition of type StatusResponseData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| inactiveUes | array(Supi) | O | 1..N | Indicate the SUPI(s) whose status of the access stratum time distribution is inactive. (NOTE) | | +| inactiveGpsis | array(Gpsi) | O | 1..N | Indicate the GPSI(s) whose status of the access stratum time distribution is inactive. (NOTE) | | +| activeUes | array(ActiveUe) | O | 1..N | Contains the UE identifier(s) whose status of the access stratum time distribution is active and the optional requested time synchronization error budget. | | + +NOTE: Either the "inactiveUes" or the "inactiveGpsis" attribute is included, based on whether the request contained an internal or an external identifier. + +## 6.3.6.2.6 Type: ActiveUe + +Table 6.3.6.2.6-1: Definition of type ActiveUe + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------|---|-------------|------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Indicate the SUPI whose status of the access stratum time distribution is active. (NOTE) | | +| gpsi | Gpsi | C | 0..1 | Indicate the GPSI whose status of the access stratum time distribution is active. (NOTE) | | +| timeSyncErrBdgt | Uinteger | O | 0..1 | Indicates the time synchronization error budget in terms of time units of nanoseconds. | | + +NOTE: Either the "supi" or the "gpsi" attribute is included, based on whether the request contained an internal or an external identifier. + +## 6.3.6.2.7 Type: AstiConfigNotification + +Table 6.3.6.2.7-1: Definition of type AstiConfigNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------|------------------| +| astiNotifId | string | M | 1 | It is used to set the value of Notification Correlation ID in the corresponding notification. | | +| stateConfigs | array(AstiConfigEventNotification) | O | 1..N | Contains change of state of 5G access stratum time distribution configuration. | ASTIConfigReport | + +### 6.3.6.2.8 Type AstiConfigStateNotification + +**Table 6.3.6.2.8-1: Definition of type AstiConfigStateNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------------------------------------|-----------|---|-------------|----------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies the UE to which the status below apply. | | +| gpsi | Gpsi | C | 0..1 | Identifies the UE to which the status below apply. | | +| event | AstiEvent | M | 1 | Indicates the reported event. | | +| NOTE: Only one of the properties "supi" or "gpsi" shall be included. | | | | | | + +### 6.3.6.3 Simple data types and enumerations + +#### 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.3.6.3.2 Simple data types + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +**Table 6.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 6.3.6.3.3 Enumeration: AstiEvent + +The enumeration AstiEvent represents event for ASTI service. It shall comply with the provisions defined in table 6.3.6.3.3-1. + +**Table 6.3.6.3.3-1: Enumeration AstiEvent** + +| Enumeration value | Description | Applicability | +|---------------------------|--------------------------------------------------------------------------------------------|---------------| +| ASTI_ENABLED | Indicates that the access stratum time distribution via Uu reference point is activated. | | +| ASTI_DISABLED | Indicates that the access stratum time distribution via Uu reference point is deactivated. | | +| CLOCK_QUAL_ACCEPTABLE | Indicates the UE meets the clock quality acceptance criteria. | | +| CLOCK_QUAL_NON_ACCEPTABLE | Indicates the UE does not meet the clock quality acceptance criteria | | + +## 6.3.7 Error Handling + +### 6.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [5]. + +For the Ntscstf\_ASTI 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 Ntsctsf\_ASTI API. + +### 6.3.7.2 Protocol Errors + +No specific procedures for the Ntsctsf\_ASTI service are specified. + +### 6.3.7.3 Application Errors + +The application errors defined for the Ntsctsf\_ASTI service are listed in Table 6.3.7.3-1. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------|------------------|----------------------------------------------------------| +| UE_SERVICE_NOT_AUTHORIZED | 403 Forbidden | The request service for the target UE is not authorized. | + +## 6.3.8 Feature negotiation + +The optional features in table 6.3.8-1 are defined for the Ntsctsf\_ASTI API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.3.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | CoverageAreaSupport | Indicates the support of time synchronization coverage area conditions for the activation/deactivation of the time synchronization service.
It requires the support of ASTIConfigReport feature. | +| 2 | ASTIConfigReport | Indicates the support of the report of ASTI service status information and/or ASTI configuration changes. | +| 3 | NetTimeSyncStatus | Indicates the time synchronization service status | + +## 6.3.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Ntsctsf\_ASTI 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 Ntsctsf\_ASTI 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 Ntsctsf\_ASTI service. + +The Ntsctsf\_ASTI API defines a single scope "ntsctsf-asti" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Ntsctsf\_TimeSynchronization API + +``` +openapi: 3.0.0 + +info: + title: Ntsctsf_TimeSynchronization Service API + version: 1.1.0-alpha.5 + description: | + TSCTSF Time Synchronization Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.565 V18.4.0; 5G System; Time Sensitive Communication and Time Synchronization +Function + Services; Stage 3. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.565/' +servers: + - url: '{apiRoot}/ntsctsf-time-sync/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - ntsctsf-time-sync + +paths: + /subscriptions: + post: + summary: Creates a new subscription to notification of capability of time synchronization + service resource + operationId: TimeSynchronizationExposureSubscriptions + tags: + - Time Synchronization Exposure Subscriptions (Collection) + requestBody: + description: Contains the information for the creation the resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureSubsc' + responses: + '201': + description: Successful creation of the resource. +``` + +``` +content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureSubsc' +headers: + Location: + description: > + Contains the URI of the created individual time synchronization exposure + subscription resource, according to the structure + {apiRoot}/ntsctsf-time-sync/{apiVersion}/subscriptions/{subscriptionId} + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + subsEventNotification: + "{$request.body#/subsNotifUri": + post: + requestBody: + description: Notification of an event occurrence in the TSCTSF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureSubsNotif' +responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + get: + summary: "Reads an existing Individual Time Synchronization Exposure Subscription" + operationId: GetIndividualTimeSynchronizationExposureSubscription + tags: + - Individual Time Synchronization Exposure Subscription (Document) + parameters: + - name: subscriptionId + description: String identifying an Individual Time Synchronization Exposure Subscription + in: path + required: true + schema: + type: string + responses: + '200': + description: A representation of the resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureSubsc' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + put: + operationId: ReplaceIndividualTimeSynchronizationExposureSubscription + summary: Replace an individual Time Synchronization Exposure Subscription + tags: + - IndividualTimeSynchronizationExposureSubscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/TimeSyncExposureSubsc' + parameters: + - name: subscriptionId + description: String identifying an Individual Time Synchronization Exposure Subscription. + in: path + required: true + schema: + type: string + responses: + '200': + description: OK. Resource was successfully modified and representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureSubsc' + '204': + description: No Content. Resource was successfully modified. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + operationId: DeleteIndividualTimeSynchronizationExposureSubscription + summary: Delete an Individual Time Synchronization Exposure Subscription + tags: + - Individual Time Synchronization Exposure Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying an Individual Time Synchronization Exposure Subscription. + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}/configurations: + post: + summary: "Create a new Individual Time Synchronization Exposure Configuration" + operationId: CreateIndividualTimeSynchronizationExposureConfiguration + tags: + - Individual Time Synchronization Exposure Configuration (Document) + parameters: + - name: subscriptionId + description: String identifying an Individual Time Synchronization Exposure Subscription. + in: path + required: true + schema: + type: string + requestBody: + description: Contains the information for the creation the resource. + required: true + content: +``` + +``` + application/json: + schema: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/TimeSyncExposureConfig' +responses: + '201': + description: Successful creation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureConfig' + headers: + Location: + description: > + Contains the URI of the created individual time synchronization exposure + configuration resource, according to the structure + {apiRoot}/ntsctsf-time-sync/{apiVersion}/subscriptions/{subscriptionId} + /configurations/{configurationId} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + configEventNotification: + '{ $request.body#/configNotifUri ': + post: + requestBody: + description: Notification of an event occurrence in the TSCTSF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureConfigNotif' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +``` + +``` + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}/configurations/{configurationId}: + get: + summary: "Reads an existing Individual Time Synchronization Exposure Configuration" + operationId: GetIndividualTimeSynchronizationExposureConfiguration + tags: + - Individual Time Synchronization Exposure Configuration (Document) + parameters: + - name: subscriptionId + description: String identifying an Individual Time Synchronization Exposure Subscription. + in: path + required: true + schema: + type: string + - name: configurationId + description: String identifying an Individual Time Synchronization Exposure Configuration. + in: path + required: true + schema: + type: string + responses: + '200': + description: A representation of the resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureConfig' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + put: + operationId: ReplaceIndividualTimeSynchronizationExposureConfiguration + summary: Replace an individual Time Synchronization Exposure Configuration + tags: + - IndividualTimeSynchronizationExposureConfiguration (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/TimeSyncExposureConfig' + parameters: + - name: subscriptionId + description: String identifying an Individual Time Synchronization Exposure Subscription. + in: path +``` + +``` + required: true + schema: + type: string +- name: configurationId + description: String identifying an Individual Time Synchronization Exposure Configuration. + in: path + required: true + schema: + type: string +responses: + '200': + description: OK. Resource was successfully modified and representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncExposureConfig' + '204': + description: No Content. Resource was successfully modified. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + operationId: DeleteIndividualTimeSynchronizationExposureConfiguration + summary: Delete an Individual Time Synchronization Exposure Configuration + tags: + - Individual Time Synchronization Exposure Configuration (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying an Individual Time Synchronization Exposure Subscription. + required: true + schema: + type: string + - name: configurationId + description: String identifying an Individual Time Synchronization Exposure Configuration. + in: path + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + ntscsf-timesynchronization: Access to the Ntscsf_TimeSynchronization API + +schemas: + TimeSyncExposureSubsc: + description: > + Contains the parameters for the subscription to notification of capability of time + synchronization service. + type: object + properties: + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + interGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + exterGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + anyUeInd: + type: boolean + description: > + Identifies whether the request applies to any UE. This attribute shall set to "true" if + applicable for any UE, otherwise, set to "false". + notifMethod: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/NotificationMethod' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + subscribedEvents: + type: array + items: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/SubscribedEvent' + minItems: 1 + eventFilters: + type: array + items: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/EventFilter' + minItems: 1 + subsNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + subsNotifId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + maxReportNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` + +required: + - subsNotifUri + - subsNotifId + - dnn + - snssai + - subscribedEvents +oneOf: + - required: [supis] + - required: [interGrpId] + - required: [gpsis] + - required: [exterGrpId] + - required: [anyUeInd] + +TimeSyncExposureSubsNotif: + description: Contains the notification of time synchronization service. + type: object + properties: + subsNotifId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + eventNotifs: + type: array + items: + $ref: '#/components/schemas/SubsEventNotification' + minItems: 1 + +SubsEventNotification: + description: > + Contains the notification of capability of time synchronization for a list of UEs. + type: object + properties: + event: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/SubscribedEvent' + timeSyncCapas: + type: array + items: + $ref: '#/components/schemas/TimeSyncCapability' + minItems: 1 + required: + - event + +TimeSyncCapability: + description: Contains the capability of time synchronization service. + type: object + properties: + upNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + gmCapables: + type: array + items: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/GmCapable' + minItems: 1 + asTimeRes: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/AsTimeResource' + ptpCapForUes: + type: object + additionalProperties: + $ref: '#/components/schemas/PtpCapabilitiesPerUe' + minProperties: 1 + description: > + Contains the PTP capabilities supported by each of the SUPI(s). The key of the map is +the + SUPI. + ptpCapForGpsis: + type: object + additionalProperties: + $ref: '#/components/schemas/PtpCapabilitiesPerUe' + minProperties: 1 + description: > + Contains the PTP capabilities supported by each of the GPSI(s). The key of the map is + the GPSI. + required: + - upNodeId + anyOf: + - required: [gmCapables] + - required: [asTimeRes] + +PtpCapabilitiesPerUe: + +``` + +``` +description: Contains the supported PTP capabilities per UE. +type: object +properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + ptpCaps: + type: array + items: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/EventFilter' + minItems: 1 + required: + - ptpCaps + oneOf: + - required: [supi] + - required: [gpsi] + +TimeSyncExposureConfigNotif: + description: Contains the notification of time synchronization service state. + type: object + properties: + configNotifId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + stateOfConfig: + $ref: '#/components/schemas/StateOfConfiguration' + required: + - configNotifId + - stateOfConfig + +StateOfConfiguration: + description: > + Contains the state of the time synchronization configuration and the clock quality + acceptance criteria result. + type: object + properties: + stateNwtt: + type: boolean + description: > + When any of the PTP port state(s) in NW-TT is Leader, Follower or Passive, it is + included and set to true to indicate the current state of the time synchronization + configuration for the NW-TT port(s) of the PTP instance is active; when + PTP port state is in any other case, it is included and set to false to indicate + the state of configuration for the NW-TT port(s) of the PTP instance + is inactive. Default value is false. + stateOfDstts: + description: > + Contains the PTP port states and the clock quality acceptance criteria result of the + DS-TT(s). + type: array + items: + $ref: '#/components/schemas/StateOfDstt' + minItems: 1 + +StateOfDstt: + description: Contains the PTP port state of a DS-TT. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + state: + type: boolean + description: > + When the PTP port state is Leader, Follower or Passive, it is included and set to true + to indicate the state of configuration for DS-TT port is active; when PTP port state is + in any other case, it is included and set to false to indicate the state of + configuration for DS-TT port is inactive. Default value is false. + clkQltIndOfDstts: + $ref: + 'TS29522_TimeSyncExposure.yaml#/components/schemas/AcceptanceCriteriaResultIndication' + required: + - state + oneOf: + - required: [supi] + - required: [gpsi] +``` + +``` +TimeSyncExposureConfig: + description: Contains the Time Synchronization Configuration parameters. + type: object + properties: + upNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + reqPtpIns: + $ref: '#/components/schemas/PtpInstance' + gmEnable: + type: boolean + description: > + Indicates that the AF requests 5GS to act as a grandmaster for PTP or gPTP if it is + included and set to true. + gmPrio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + timeDom: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + timeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + configNotifId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + configNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + tempValidity: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + covReq: + type: array + description: > + Identifies a list of Tracking Areas per serving network where time + synchronization service configuration is allowed. + items: + $ref: 'TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/ServiceAreaCoverageInfo' + minItems: 1 + clkQltDetLvl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityDetailLevel' + clkQltAcptCri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityAcceptanceCriterion' + required: + - upNodeId + - reqPtpIns + - timeDom + - configNotifId + - configNotifUri + +PtpInstance: + description: Contains PTP instance configuration and activation requested by the AF. + type: object + properties: + instanceType: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/InstanceType' + protocol: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/Protocol' + ptpProfile: + type: string + portConfigs: + type: array + items: + $ref: '#/components/schemas/ConfigForPort' + minItems: 1 + required: + - instanceType + - protocol + - ptpProfile + +ConfigForPort: + description: Contains configuration for each port. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + n6Ind: + type: boolean + ptpEnable: +``` + +``` + + type: boolean + logSyncInter: + type: integer + logSyncInterInd: + type: boolean + logAnnouInter: + type: integer + logAnnouInterInd: + type: boolean + oneOf: + - required: [supi] + - required: [gpsi] + - required: [n6Ind] + +``` + +## A.3 Ntsctsf\_QoSandTSCAssistance API + +openapi: 3.0.0 + +``` + +info: + title: Ntsctsf_QoSandTSCAssistance Service API + version: 1.1.0-alpha.4 + description: | + TSCTSF QoS and TSC Assistance Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` + +externalDocs: + description: > + 3GPP TS 29.565 V18.3.0; 5G System; Time Sensitive Communication and Time Synchronization +function + Services; Stage 3. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.565/' + +``` + +``` + +servers: +- url: '{apiRoot}/ntsctsf-qos-tscai/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +``` + +``` + +security: +- {} +- oAuth2ClientCredentials: +- ntsctsf-qos-tscai + +``` + +``` + +paths: + /tsc-app-sessions: + post: + summary: Creates a new Individual TSC Application Session Context resource + operationId: PostTSCAppSessions + tags: + - TSC Application Sessions (Collection) + requestBody: + description: Contains the information for the creation the resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TscAppSessionContextData' + responses: + '201': + description: Successful creation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/TscAppSessionContextData' + headers: + Location: + description: > + Contains the URI of the created individual TSC application session context resource, + according to the structure + {apiRoot}/ntsctsf-qos-tscai//tsc-app-sessions/{appSessionId} or the + URI of the created events subscription sub-resource, according to the structure + {apiRoot}/ntsctsf-qos-tscai//tsc-app-sessions/{appSessionId}/ + events-subscription} + required: true + +``` + +``` + + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsTsctsfQosTscac' + headers: + Retry-After: + description: > + Indicates the time the AF has to wait before making a new request. It can be a + non-negative integer (decimal number) indicating the number of seconds the AF + has to wait before making a new request or an HTTP-date after which the AF can + retry a new request. + schema: + type: string +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + terminationRequest: + '{$request.body#/notifUri}/terminate': + post: + requestBody: + description: > + Request of the termination of the Individual TSC Application Session Context + required: true + content: + application/json: + schema: + $ref: +'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TerminationInfo' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + eventNotification: + '{ $request.body#/evSubsc/notifUri }/notify': + post: + requestBody: + description: Notification of an event occurrence in the TSCTSF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/tsc-app-sessions/{appSessionId}: + get: + summary: Reads an existing Individual TSC Application Session Context + operationId: GetTSCAppSession + tags: + - Individual TSC Application Session Context (Document) + parameters: + - name: appSessionId + description: String identifying the resource. + in: path + required: true + schema: + type: string + responses: + '200': + description: A representation of the resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TscAppSessionContextData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + +``` + +``` + + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Modifies an existing Individual TSC Application Session Context + operationId: ModAppSession + tags: + - Individual TSC Application Session Context (Document) + parameters: + - name: appSessionId + description: String identifying the resource. + in: path + required: true + schema: + type: string + requestBody: + description: Modification of the resource. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/TscAppSessionContextUpdateData' + responses: + '200': + description: > + successful modification of the resource and a representation of that resource is + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TscAppSessionContextData' + '204': + description: The successful modification. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsTsctsfQoSTscac' + headers: + Retry-After: + description: > + Indicates the time the AF has to wait before making a new request. It can be a + non-negative integer (decimal number) indicating the number of seconds the AF + has to wait before making a new request or an HTTP-date after which the AF can + retry a new request. + schema: + type: string + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + eventNotification: + '{ $request.body#/evSubsc/notifUri }/notify': + post: + requestBody: + description: Notification of an event occurrence in the TSCTSF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/tsc-app-sessions/{appSessionId}/delete: + post: + summary: Deletes an existing Individual TSC Application Session Context + operationId: DeleteTSCAppSession + tags: + - Individual TSC Application Session Context (Document) + parameters: + - name: appSessionId + description: String identifying the Individual TSC Application Session Context resource. + in: path + required: true + schema: + type: string + requestBody: + description: > + Deletion of the Individual TSC Application Session Context resource, request notification. + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' + responses: + '200': + description: The deletion of the resource is confirmed and a resource is returned + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + '204': + description: The deletion is confirmed without returning additional data. + '307': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/tsc-app-sessions/{appSessionId}/events-subscription: + put: + summary: Creates or modifies an Events Subscription subresource + operationId: putEventsSubsc + tags: + - Events Subscription (Document) + parameters: + - name: appSessionId + description: String identifying the Events Subscription resource + in: path + required: true + schema: + type: string + requestBody: + description: Creation or modification of an Events Subscription resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' + responses: + '201': + description: > + The creation of the Events Subscription resource is confirmed and its representation is + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' + headers: + Location: + description: > + Contains the URI of the created Events Subscription resource, + according to the structure + {apiRoot}/ntscts-f-qos-tscai//tsc-app-sessions/{appSessionId}/ + events-subscription + required: true + schema: + type: string + '200': + description: > + The modification of the Events Subscription resource is confirmed and its representation + is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' + '204': + description: > + The modification of the Events Subscription subresource is confirmed without returning + additional data. + +``` + +``` + + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + eventNotification: + '{$request.body#/notifyUri}/notify': + post: + requestBody: + description: > + Contains the information for the notification of an event occurrence in the +TSCTSF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Deletes the Events Subscription subresource. + operationId: DeleteEventsSubsc + tags: + - Events Subscription (Document) + parameters: + +``` + +``` + +- name: appSessionId + description: String identifying the Individual TSC Application Session Context resource + in: path + required: true + schema: + type: string +responses: + '204': + description: > + The deletion of the of the Events Subscription sub-resource is confirmed without +returning + additional data. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + ntscts-f-qos-tscai: Access to the Ntscts-f_QoSAndTSCAssistance API + +schemas: + TscAppSessionContextData: + description: Represents an Individual TSC Application Session Context resource. + type: object + required: + - notifUri + - afId + - qosReference + allOf: + - oneOf: + - required: [ueIpAddr] + - required: [ueMac] + - required: [ueId] + - required: [externalGroupId] + - not: + required: [ethFlowInfo, enEthFlowInfo] + - not: + required: [altQosReqs, altQosReferences] + - not: + required: [qosReference, altQosReqs] + properties: + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + ipDomain: + type: string + description: The IPv4 address domain identifier. + ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + externalGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + +``` + +``` + +dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +appId: + type: string + description: Identifies the Application Identifier. +ethFlowInfo: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 +enEthFlowInfo: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/EthFlowInfo' + minItems: 1 + description: > + Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow + identifier and the corresponding UL and/or DL flows. +flowInfo: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 +afId: + type: string + description: Identifies the AF identifier. +tscQosReq: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/TscQosRequirement' +qosReference: + type: string + description: Identifies a pre-defined QoS information. +altQosReferences: + type: array + items: + type: string + minItems: 1 + description: Identifies an ordered list of pre-defined QoS information. +altQosReqs: + type: array + items: + $ref: + 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Identifies an ordered list of alternative service requirements that include individual + QoS parameter sets. The lower the index of the array for a given entry, the higher the + priority. +aspId: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AspId' +sponId: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/SponId' +sponStatus: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/SponsoringStatus' +evSubsc: + $ref: '#/components/schemas/EventsSubscReqData' +tempInValidity: + $ref: '#/components/schemas/TemporalInValidity' +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +TscAppSessionContextUpdateData: + description: > + Describes the authorization data of an Individual TSC Application Session Context created by + the PCF. + type: object + properties: + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + appId: + type: string + description: Identifies the Application Identifier. + ethFlowInfo: + type: array + items: + +``` + +``` + + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + enEthFlowInfo: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/EthFlowInfo' + minItems: 1 + description: > + Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow + identifier and the corresponding UL and/or DL flows. + flowInfo: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + tscQosReq: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/TscQosRequirementRm' + qosReference: + type: string + description: Identifies a pre-defined QoS information. + altQosReferences: + type: array + items: + type: string + minItems: 1 + description: Identifies an ordered list of pre-defined QoS information. + altQosReqs: + type: array + items: + $ref: +'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Identifies an ordered list of alternative service requirements that include individual + QoS parameter sets. The lower the index of the array for a given entry, the higher the + priority. + aspId: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AspId' + sponId: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/SponId' + sponStatus: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/SponsoringStatus' + evSubsc: + $ref: '#/components/schemas/EventsSubscReqDataRm' + tempInvalidity: + $ref: '#/components/schemas/TemporalInvalidity' + allOf: + - not: + required: [ethFlowInfo, enEthFlowInfo] + - not: + required: [altQosReqs, altQosReferences] + - not: + required: [qosReference, altQosReqs] + +EventsSubscReqData: + description: Identifies the events the application subscribes to. + type: object + required: + - events + - notifUri + - notifCorreId + properties: + events: + type: array + items: + $ref: '#/components/schemas/TscEvent' + minItems: 1 + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + qosMon: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/QosMonitoringInformation' + usgThres: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + notifCorreId: + type: string + +EventsSubscReqDataRm: + description: > + +``` + +``` + +This data type is defined in the same way as the EventsSubscReqData data type, but with the +OpenAPI nullable property set to true. +type: object +required: +- events +properties: + events: + type: array + items: + $ref: '#/components/schemas/TscEvent' + minItems: 1 + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + qosMon: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/QosMonitoringInformationRm' + usgThres: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm' + notifCorreId: + type: string +nullable: true + +EventsNotification: + description: Describes the notification of matched events. + type: object + required: + - notifCorreId + - events + properties: + notifCorreId: + type: string + events: + type: array + items: + $ref: '#/components/schemas/EventNotification' + minItems: 1 + +EventNotification: + description: Describes a notification of an matched event. + type: object + required: + - event + properties: + event: + $ref: '#/components/schemas/TscEvent' + flowIds: + type: array + items: + type: integer + minItems: 1 + description: Identifies the IP flows that were sent during event subscription. + qosMonReports: + type: array + items: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/QosMonitoringReport' + minItems: 1 + usgRep: + $ref: 'TS29122_CommonData.yaml#/components/schemas/AccumulatedUsage' + appliedQosRef: + type: string + description: > + The currently applied alternative QoS requirement referring to an alternative QoS + reference or a requested alternative QoS parameter set. Applicable for + event QOS_NOT_GUARANTEED or SUCCESSFUL_RESOURCES_ALLOCATION. + altQosNotSuppInd: + type: boolean + description: > + When present and set to true it indicates that the Alternative QoS profiles are not + supported by NG-RAN. Applicable for + event QOS_NOT_GUARANTEED or SUCCESSFUL_RESOURCES_ALLOCATION. + +AdditionInfoTsctsfQosTscac: + description: Describes additional error information specific for this API. + type: object + properties: + acceptableServInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AcceptableServiceInfo' + batOffsetInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/BatOffsetInfo' + +``` + +``` + +TemporalInvalidity: + description: Indicates the time interval(s) during which the AF request is not to be applied. + type: object + properties: + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + stopTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - startTime + - stopTime + +# +# ENUMERATIONS DATA TYPES +# +TscEvent: + description: Represents an event to notify to the AF. + anyOf: + - type: string + enum: + - FAILED_RESOURCES_ALLOCATION + - QOS_MONITORING + - QOS_GUARANTEED + - QOS_NOT_GUARANTEED + - SUCCESSFUL_RESOURCES_ALLOCATION + - USAGE_REPORT + - BAT_OFFSET_INFO + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +# +# ALTERNATIVE DATA TYPES OR COMBINATIONS OF DATA TYPES +# +ProblemDetailsTsctsfQosTscac: + description: Extends ProblemDetails to also include the acceptable service info. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionInfoTsctsfQosTscac' + +``` + +## A.4 Ntsctsf\_ASTI API + +openapi: 3.0.0 + +``` + +info: + title: Ntsctsf_ASTI Service API + version: 1.1.0-alpha.3 + description: | + TSCTSF Access Stratum time distribution configuration Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.565 V18.4.0; 5G System; Time Sensitive Communication and + Time Synchronization Function Services; Stage 3. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.565/' + +servers: + - url: '{apiRoot}/ntsctsf-asti/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - ntsctsf-asti + +paths: + /configurations: + post: + summary: Creates a new Individual ASTI Configuration resource. + operationId: ASTIConfiguration + +``` + +``` + +tags: + - ASTI Configurations (Collection) +requestBody: + description: Contains the information for the creation the resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTimeDistributionData' +responses: + '201': + description: Successful creation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTimeDistributionData' + headers: + Location: + description: > + Contains the URI of the created individual ASTI Configuration resource, + according to the structure + {apiRoot}/ntscstsf-asti/{apiVersion}/configurations/{configId} + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + astiNotification: + "{$request.body#/astiNotifUri}": + post: + requestBody: + description: Notification of an ASTI configuration change event. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AstiConfigNotification' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/configurations/retrieve: + post: + summary: Request the status of the 5G access stratum time distribution for a list of UEs. + operationId: RequestStatusof5GAccessStratumTimeDistribution + tags: + - ASTI Configurations + requestBody: + description: > + Contains the information for the status of the 5G access stratum time distribution. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Status requestData' + responses: + '200': + description: > + Successful retrieval of the status of the 5G access stratum time distribution. + content: + application/json: + schema: + $ref: '#/components/schemas/StatusResponseData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/configurations/{configId}: + put: + summary: Modifies an existing Individual ASTI Configuration resource. + operationId: ModifyIndividualASTIConfiguration + tags: + - Individual ASTI Configuration (Document) + parameters: + - name: configId + description: String identifying an Individual ASTI Configuration. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + +``` + +``` + application/json: + schema: + $ref: '#/components/schemas/AccessTimeDistributionData' +responses: + '200': + description: OK. Resource was successfully modified and representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTimeDistributionData' + '204': + description: No Content. Resource was successfully modified. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + operationId: DeleteIndividualASTIConfiguration + summary: Delete an Individual ASTI Configuration + tags: + - Individual ASTI Configuration (Document) + parameters: + - name: configId + in: path + description: String identifying an Individual ASTI Configuration. + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +## components: + +``` +securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + ntsctsf-asti: Access to the Ntsctsf_ASTI API +``` + +## schemas: + +``` +AccessTimeDistributionData: + description: > + Contains the parameters for the creation of 5G access stratum time distribution + configuration. + type: object + properties: + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + interGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + exterGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + asTimeDisParam: + $ref: '#/components/schemas/AsTimeDistributionParam' + covReq: + type: array + description: > + Identifies a list of Tracking Areas per serving network where 5GS + Access Stratum Time Distribution parameters are allowed. + items: + $ref: 'TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/ServiceAreaCoverageInfo' + minItems: 1 + astiNotifId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + astiNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - asTimeDisParam + oneOf: + - required: [supis] + - required: [interGrpId] + - required: [gpsis] + - required: [exterGrpId] + +AsTimeDistributionParam: + description: Contains the 5G access stratum time distribution parameters. + type: object + properties: + asTimeDisEnabled: + type: boolean + description: > + When this attribute is included and set to true, it indicates that the access stratum + time distribution via Uu reference point is activated. + timeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + tempValidity: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + clkQltDetLvl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityDetailLevel' + clkQltAcptCri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityAcceptanceCriterion' + +StatusRequestData: + description: > +``` + +``` + Contains the parameters for retrieval of the status of the access stratum time distribution + for a list of UEs. + type: object + properties: + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + oneOf: + - required: [supis] + - required: [gpsis] + +StatusResponseData: + description: > + Contains the parameters for the status of the access stratum time distribution for a list of + UEs. + type: object + properties: + inactiveUes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + inactiveGpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + activeUes: + type: array + items: + $ref: '#/components/schemas/ActiveUe' + minItems: 1 + +ActiveUe: + description: > + Contains the UE identifier whose status of the access stratum time distribution is active + and the optional requested time synchronization error budget. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + timeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + oneOf: + - required: [supi] + - required: [gpsi] + +AstiConfigNotification: + description: > + Contains the report of a change in the 5G Access Stratum Time Distribution + parameters applied to the UE(s). + type: object + properties: + astiNotifId: + type: string + stateConfigs: + type: array + items: + $ref: '#/components/schemas/AstiConfigStateNotification' + minItems: 1 + description: > + It is FFS the parameters of the AstiConfigEventNotification data type. + required: + - astiNotifId + - stateConfigs + +AstiConfigStateNotification: + description: > + Contains the report of a change in the 5G Access Stratum Time Distribution +``` + +``` + + parameters applied to a UE. +type: object +properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + event: + $ref: '#/components/schemas/AstiEvent' +required: + - event +oneOf: + - required: [supi] + - required: [gpsi] +# +# ENUMERATIONS DATA TYPES +# +AstiEvent: + anyOf: + - type: string + enum: + - ASTI_ENABLED + - ASTI_DISABLED + - CLOCK_QUAL_ACCEPTABLE + - CLOCK_QUAL_NON_ACCEPTABLE + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents an ASTI event to notify to the AF/NEF. + Possible values are: + - ASTI_ENABLED: Access stratum time distribution via Uu reference point is activated. + - ASTI_DISABLED: Access stratum time distribution via Uu reference point is deactivated. + - CLOCK_QUAL_ACCEPTABLE: The UE meets the clock quality acceptance criteria. + - CLOCK_QUAL_NON_ACCEPTABLE: The UE does not meet the clock quality acceptance criteria. + +``` + +--- + +## Annex B (normative): 3GPP extensions for DetNet integration with 5GS + +### B.1 3GPP extensions for DetNet integration with 5GS + +#### B.1.1 Introduction + +The 5G System is integrated with the Deterministic Networking as defined in IETF RFC 8655[63] as a logical DetNet transit node as specified in 3GPP TS 23.501 [2], clause 4.4.8.4. + +The support of deterministic networking is achieved by reusing the TSC framework for deterministic QoS and time synchronization services. To enable deterministic networking in 5GS, the DetNet controller collects interface information from the 5GS DetNet node via the TSCTSF using the 5GS DetNet node information reporting procedure described in clause 5.5.12.2 of 3GPP TS 23.513 [31] and provides DetNet Yang configurations for DetNet flow(s) as described in clause 5.5.12.3 of 3GPP TS 23.513 [31]. + +The TSCTSF offers to the DetNet controller RESTCONF (IETF RFC 8040 [30]) and/or NETCONF (IETF RFC 6241 [29]) interfaces and the data schema defined by the 3GPP Extended Deterministic Networking (DetNet) YANG model. The 3GPP Extended DetNet YANG model is based on the DetNet YANG model specified in IETF draft-ietf-detnet-yang [28] and extended by 3GPP Extensions described in table B.1.1-1. + +The 3GPP Extended DetNet YANG Model offered by the TSCTSF is accessed by the DetNet controller as shown in figure B.1.1-1 + +![Diagram showing the access to the 3GPP Extended DetNet YANG Model. A box labeled 'TSCTSF' is connected by a horizontal line to a box labeled 'DetNet controller'. Above the line, text indicates the model is '3GPP Extended DetNet YANG model over RESTCONF/NETCONF'.](27c9c38b326b85de631d54a9ff1e2bd4_img.jpg) + +3GPP Extended DetNet YANG model +over RESTCONF/NETCONF + +``` + +graph LR + TSCTSF[TSCTSF] --- DetNet[DetNet controller] + subgraph Model + direction TB + M1[3GPP Extended DetNet YANG model] + M2[over RESTCONF/NETCONF] + end + Model --- DetNet + +``` + +Diagram showing the access to the 3GPP Extended DetNet YANG Model. A box labeled 'TSCTSF' is connected by a horizontal line to a box labeled 'DetNet controller'. Above the line, text indicates the model is '3GPP Extended DetNet YANG model over RESTCONF/NETCONF'. + +**Figure B.1.1-1: Representation of the access to 3GPP Extended DetNet YANG Model.** + +Table B.1.1-1 summarizes the 3GPP extensions to the DetNet YANG model defined in this specification. + +**Table B.1.1-1: 3GPP Extensions Descriptions** + +| 3GPP Extension | Clause | Description | YANG File | Module Name | Annex | +|----------------------|--------|----------------------------------------------------------------------------------------------------------------------------------|---------------------------|----------------------|-------| +| 3gpp-5gs-detnet-node | B.1.2 | Enables the report of 5GS DetNet node interface information and the provisioning and configuration of data for the DetNet flows. | 3gpp-5gs-detnet-node.yang | 3gpp-5gs-detnet-node | C.2 | + +## B.1.2 3GPP Extension 3gpp-5gs-detnet-node + +### B.1.2.1 Description + +Deterministic Networking parameter provisioning allows a DetNet controller to configure deterministic networking parameters in 5GS and provide time-sensitive features that guarantee almost zero packet loss rates and bounded latency. + +The DetNet controller communicates with the 5GS system through the TSCTSF as specified in 3GPP TS 29.513 [31] to collect 5GS DetNet node interface information and to provide DetNet flow-related parameters to configure the DetNet traffic in 5GS. + +The TSCTSF may receive DetNet YANG configuration for DetNet flows as described in IETF draft-ietf-detnet-yang [28], that describes the traffic characteristics and QoS requirements for the DetNet flows. Additionally, when both, the TSCTSF and the DetNet controller support the 3GPP Extension 3gpp-5gs-detnet-node, the configuration of the DetNet traffic in 5GS also enable that: + +- The DetNet controller may provide the maximum latency and/or maximum loss requirements the 5GS system needs to apply, as specified in clause B.1.2.2. +- The TSCTSF may provide to the DetNet controller 5GS specific status code information on the status of the configuration requested by the DetNet controller for the DetNet flow(s), as specified in clause B.1.2.3. + +To enable the DetNet controller builds up network topology information, the 5GS DetNet node exposes interface information to the DetNet controller through the TSCTSF. When both, the TSCTSF and the DetNet controller support the 3GPP Extension 3gpp-5gs-detnet-node, the TSCTSF may provide to the DetNet controller 5GS DetNet node identification as specified in clause B.1.2.4. + +### B.1.2.2 Provisioning of 5GS specific traffic characteristics and requirements + +When both, the DetNet controller and the TSCTSF support the 3GPP Extension 3gpp-5gs-detnet-node, the DetNet controller may provide the following 5GS specific traffic characteristics and requirements within the "\_3gpp-5gs-node-requirements" YANG container: + +- the maximum latency from 5GS node ingress to 5GS node egress(es) of a DetNet flow by providing the "\_3gpp-5gs-node-max-latency" attribute; and/or + +- the maximum packet loss ratio parameter for the DetNet service between the 5G node ingress and the 5GS node egress(es) by providing the "\_3gpp-5gs-node-max-latency" attribute; and +- a reference to the DetNet flow identification within the "forwarding-sub-layer" attribute. + +When the DetNet controller does not provide the "\_3gpp-5gs-node-max-latency" attribute and/or the "\_3gpp-5gs-node-max-latency" attribute but instead provides the IETF draft-ietf-detnet-yang [28] "max-latency" and/or "max-loss" attributes for the end-to-end flow, the TSCTSF may determine the corresponding maximum latency and/or maximum packet loss values based on a preconfigured mapping and applicable to the 5GS specific deployment. + +NOTE: If the DetNet controller does not include the 5GS specific "\_3gpp-5gs-node-max-latency" nor the end-to-end "max-latency", the TSCTSF can derive the Requested 5GS Delay or, alternatively, the PCF can derive the PDB. Similarly, if the DetNet YANG configuration does not include the 5GS specific "\_3gpp-5gs-node-max-loss" nor the end-to-end "max-loss", the TSCTSF can derive the Requested Packet Error Rate or, alternatively, the PCF can derive the PER. + +### B.1.2.3 Report of 5GS DetNet flow(s) status + +The DetNet controller may be informed about the following 5GS specific events about status change of the configured DetNet flows: + +- Notification about DetNet flow(s) deactivation in 5GS node. To notify the DetNet controller about DetNet flow deactivation in 5GS, the TSCTSF shall subscribe with the PCF to service data flow deactivation as specified in 3GPP TS 29.514 [20]. +- Notification about resource allocation outcome in 5GS node. The TSCTSF shall subscribe with the PCF to notifications about the unsuccessful and/or successful resource allocation outcome as specified in 3GPP TS 29.514 [20]. +- Notification about PDU session release. + +When the TSCTSF receives from the PCF the notification about service data flow deactivation, or the notification about unsuccessful or successful resource allocation, or the notification about PDU session release and both, the DetNet controller and the TSCTSF support the 3GPP Extension 3gpp-5gs-detnet-node, the TSCTSF may notify the DetNet controller by including the following 3GPP 5GS specific failure reason: + +- "3gpp-5gs-node-resource-allocation-failure", to notify about the failed resource allocation in the 5G System; +- "3gpp-5gs-node-resource-allocation-success", to notify about the successful resource allocation in the 5G System; or +- "3gpp-5gs-node-pdu-session-release", to notify about PDU session release. + +When the TSCTSF or the DetNet controller do not support the 3GPP Extension 3gpp-5gs-detnet-node, the TSCTSF provides an IETF draft-ietf-detnet-yang [28] defined failure-reason, e.g. "resource-unavailable". + +### B.1.2.4 Exposure of 5GS DetNet Node Identification + +The TSCTSF collects 5GS DetNet node interface information from the NW-TT/UPF using Time Synchronization procedures as described in 3GPP TS 29.513[31]. When both, the TSCTSF and the DetNet controller support the 3GPP Extension 3gpp-5gs-detnet-node, the TSCTSF may provide to the DetNet controller 5GS DetNet node identification. + +During PDU session establishment, i.e., when the TSCTSF receives the Npcf\_PolicyAuthorization\_Notify service operation defined in clause 4.2.5.16 of 3GPP TS 29.514 [20], the TSCTSF may use the received user-plane node Id to generate an identifier of the 5GS DetNet node and provide it to the DetNet controller within the "5GS-node-id" attribute. + +## B.2 YANG Module Definitions + +### B.2.1 Introduction + +#### B.2.1.1 General + +As specified in IETF RFC 7590 [33], a YANG model is defined in a YANG module and is stored in a file with file extension ".yang". An extension to an existing YANG model is done via the definition of a new YANG module that contains the definitions of the new components. + +A YANG module typically has the following layout: + +``` +module { + // header information + + + + + // linkage statements + + + + // meta-information + + + + + + // revision history + + + // module definitions + +} +``` + +The YANG module with the 3GPP extensions for the DetNet YANG model shall follow the YANG model layout defined in clause 7.1 of IETF RFC 7590 [33] and represented above, where the `linkage` and `module definitions` statements contain the definition of the new components that represent the 5GS specifics. + +#### B.2.1.2 Module name + +``` +module +``` + +To differentiate from other YANG modules, 3GPP extensions to DetNet YANG model module(s) shall start with the "3gpp-5gs-detnet" prefix. + +#### B.2.1.3 Header information + +##### B.2.1.3.1 + +According to IETF RFC 7590 [33], YANG version 1.1 shall be used. + +##### B.2.1.3.2 + +The namespace for a YANG module's namespace shall follow section 4.9 of IETF RFC 8407. + +The 3GPP extensions to DetNet YANG model shall follow the following form: + +``` +urn:3gpp:node:detnet: +``` + +### B.2.1.3.3 + +To ensure uniqueness of the prefix defined in the 3GPP extensions for the DetNet YANG model, the module(s) shall use prefixes ending with "3gppdnet". Prefixes should be short preferably not longer than 10 characters, but 13 characters at most. + +## B.2.1.4 Meta-information + +### B.2.1.4.1 + +The organization statement shall contain the organization developing and maintaining the YANG file with the 3GPP extensions for the DetNet YANG model, i.e. the string "3GPP CT3 Working Group". + +### B.2.1.4.2 + +The contact statement contains contact information for the person or persons to whom technical queries concerning this module should be sent. + +For the 3GPP extensions to YANG DetNet model it shall include a string with the CT3 WG web link. + +``` +contact + "CT3 WG Web: "; +``` + +### B.2.1.4.3 + +The description statement contains human-readable textual description for the module definition. + +In addition, the YANG module with 3GPP extensions to YANG DetNet model shall also include the copyright notice as included in the front page of the present document and a reference to the present document. + +#### EXAMPLE: + +``` +description + "3gpp-5gs-detnet-node module contains an extension of ietf-detnet YANG module with + additional parameters defined for interworking with 3GPP 5GS. + + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + + This version of this YANG module is specified in: + 3GPP TS 29.565 V18.1.0; 5G System; + Time Sensitive Communication and Time Synchronization Function Services. + url: http://www.3gpp.org/ftp/Specs/archive/29\_series/29.565/"; +``` + +### B.2.1.4.4 + +This statement contains a human-readable cross reference to an external document that defines related information or additional information. + +When included, it refers e.g., to other 3GPP Technical Specifications with related information. + +#### EXAMPLE: + +``` +reference + "Additional information to this YANG module is specified in: + 3GPP TS 23.501, System architecture for the 5G System (5GS) + 3GPP TS 23.502, Procedures for the 5G System (5GS) + 3GPP TS 23.503, Policy and charging control framework (5GS) + url: http://www.3gpp.org/ftp/Specs/archive/23\_series/"; +``` + +#### B.2.1.4.5 + +This statement contains the revision history of the module, including the initial revision. A series of *revision* statements detail the changes in the module's definition. The argument is a date string in the format "YYYY-MM-DD" followed by a block of sub-statements with detailed revision information. A module should have at least one *revision* statement. + +For the YANG module(s) with the 3GPP extensions to YANG DetNet model: + +1. For a frozen release, only one revision statement shall be included and shall indicate the last revision of the module for that release version of the TS. +2. A non-frozen release may contain a series of revision statements that represent the list of changes approved in that release. At the freeze of the release, only the last revision statement shall be kept. +3. The date argument of the revision statement(s) shall contain a value corresponding to the CT plenary date that approved the latest changes to the YANG module. +4. To allow the YANG module could be updated with new components in new releases or with corrections in a frozen release, a version control mechanism is enabled. The *description* sub-statement shall be used to contain a string with the YANG module version. Version control for the 3GPP Extensions for the DetNet YANG shall follow the version control rules for SBI APIs specified in 3GPP TS 29.501 [5], clause 4.3. + +EXAMPLE 1: Series of revision published by 3GPP of the 3GPP extension YANG module before the freeze of the Rel-18, with version included. + +``` +revision 2024-012-dd +// optional +{ + description "version: v1.0.0-alpha.3"; +} + +revision 2023-09-dd +// optional +{ + description "version: v1.0.0-alpha.2"; +} + +revision 2023-06-dd +// optional +{ + description "version: v1.0.0-alpha.1"; +} +``` + +EXAMPLE 2: Final revision of the 3GPP extension of the YANG module published by 3GPP, with version included, published at the freeze of Rel-18. + +``` +revision 2024-06-dd +{ + description "version: v1.0.0"; +} +``` + +EXAMPLE 3: The YANG module is evolved during the first plenary cycle corresponding to Rel-19, . + +``` +revision 2024-09-dd +{ + description "version: v1.1.0-alpha.1"; +} +``` + +#### B.2.1.2 Formatting rules + +The following 3GPP specific guidelines should be used when documenting the YANG module for the 3GPP extensions to the DetNet YANG model: + +- The YANG module should be considered a code component. The strings "" and "" are used to identify each code component. + +- The "" tag is followed by a string identifying the file name as specified in section 5.2 of IETF RFC 6020 [35]. +- The YANG data nodes (leaf, leaf-list, container, list) shall be used for data modelling of the new YANG components. +- The style used for the specification of the YANG module shall be "PL" (Programming Language). +- Comments may be added by following the standard YANG 1.1 syntax ("//" or "/\*" and "\*/"). +- Tabs shall not be used (e.g. within description fields). +- "Unbreakable" spaces (UTF-8 'NO-BREAK SPACE' (U+00A0)) shall not be used (e.g. within description fields). Only "normal" spaces (UTF-8 'SPACE' (U+0020)) shall be allowed. +- Trailing spaces (i.e. white spaces at the end of a line) should not be used. + +## B.2.2 3gpp-5gs-detnet-node Module definition + +### B.2.2.1 Introduction + +The 3GPP extension to the IETF draft-ietf-detnet-yang [37] is defined in 3GPP as a YANG module which imports draft-ietf-detnet-yang [37] and adds the 3GPP specific parameters. + +The module name shall be set to "3gpp-5gs-detnet-node". + +The YANG version shall be set to "1.1". + +The namespace for the 3gpp-5gs-detnet-node YANG module shall be set to "urn:3gpp:node:detnet:3gpp-5gs-detnet-node". + +The prefix statement for the 3gpp-5gs-detnet-node YANG module shall be set to "5gs3gppdnet". + +### B.2.2.2 Data Model + +#### B.2.2.2.1 General + +Table B.2.2.2.1-1 specifies the data types defined for the 3gpp-5gs-detnet-node Module. + +**Table B.2.2.2.1-1: 3gpp-5gs-detnet-node Module specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------------------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| _3gpp-5gs-node-configuration-outcome | B.2.2.2.2.3 | It is a container that represents the additional outcome the 5GS may provide to a configuration request. | | +| _3gpp-5gs-node-configuration-status | B.2.2.2.3.3 | It is an enumeration that represents the 3GPP specific configuration status that may be reported by the 5GS node. | | +| _3gpp-5gs-node-identity | B.2.2.2.2.4 | It is a container that represents the user-plane node Id handling the traffic of the reported DetNet flows/PDU session. | | +| _3gpp-5gs-node-requirements | B.2.2.2.2.2 | It is a container that represents the maximum delay and/or the maximum loss the 5GS needs to satisfy for the traffic of the DetNet flows indicated by the forwarding sublayer. | | + +Table B.2.2.2.1-2 specifies data types re-used by the \_3gpp-5gs-detnet-node Module from other YANG modules, including a reference to their respective specifications and when needed, a short description of their use. + +**Table BA.2.2.2.1-2: \_3gpp-5gs-detnet-node Module re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|--------------------------|----------------------------------|--------------------------------------------------------------------------------------------------------|---------------| +| forwarding-sub-layer-ref | IETF draft-ietf-detnet-yang [28] | Contains a reference to the forwarding sublayer as specified in draft-ietf-detnet-yang-17 YANG module. | | + +## B.2.2.2.2 Structured data types + +### B.2.2.2.2.1 Introduction + +This clause defines the YANG structures to be used in 3gpp-5gs-detnet-node YANG Module. + +### B.2.2.2.2.2 Type: \_3gpp-5gs-node-requirements + +The \_3gpp-5gs-node-requirements type is a YANG container that defines the maximum delay and/or the maximum loss the 5GS needs to satisfy for the traffic of the DetNet flows indicated by the forwarding sublayer. + +**Table B.2.2.2.2.2-1: Definition of type \_3gpp-5gs-node-requirements** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------|--------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| _forwarding-sub-layer | forwarding-sub-layer-ref | M | 1 | The _forwarding-sublayer leaf contains a reference to the forwarding sub-layer that the maximum delay and/or the maximum loss applies to. | +| _3gpp-5gs-node-max-latency | uint32 | O | 0..1 | The _3gpp-5gs-node-max-latency leaf contains the maximum latency from 5GS node ingress to 5GS node egress(es) for a single packet of the DetNet flow. It is specified as an integer number of nanoseconds. | +| _3gpp-5gs-node-max-loss | uint32 | O | 0..1 | The _3gpp-5gs-node-max-loss leaf contains the maximum Packet Loss Ratio (PLR) parameter for the DetNet service between the 5GS node ingress and the 5GS node egress(es). | + +### B.2.2.2.2.3 Type: \_3gpp-5gs-node-configuration-outcome + +The \_3gpp-5gs-node-configuration-outcome type is a YANG container that defines the additional outcome the 5GS may provide to a configuration request for the DetNet flows comprised by the forwarding sublayer. + +**Table B.2.2.2.2.3-1: Definition of type \_3gpp-5gs-node-configuration-outcome** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------|-------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| _forwarding-sub-layer | forwarding-sub-layer-ref | M | 1 | The _forwarding-sublayer leaf contains a reference to the forwarding sub-layer that the reported configuration status applies to. | +| _3gpp-5gs-node-configuration-status | _3gpp-5gs-node-configuration-status | O | 0..1 | The _3gpp-5gs-node-configuration-status leaf contains 3GPP specific configuration status codes that may be reported by the 3GPP 5GS node. | + +#### B.2.2.2.2.4 Type: \_3gpp-5gs-node-identity + +The \_3gpp-5gs-node-identity type is a YANG container that defines the 5GS node identity handling the traffic of the DetNet flows comprised by the forwarding sublayer. + +**Table B.2.2.2.2.3-1: Definition of type \_3gpp-5gs-node-configuration-outcome** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|--------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| _forwarding-sub-layer | forwarding-sub-layer-ref | M | 1 | The _forwarding-sublayer leaf contains a reference to the forwarding sub-layer the _3gpp-5gs-node-id applies to. | +| _3gpp-5gs-node-id | string | O | 0..1 | The _3gpp-5gs-node-id leaf contains 3GPP 5GS node identity (DetNet router identity). | + +#### B.2.2.2.3 Simple data types and enumerations + +##### B.2.2.2.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### B.2.2.2.3.2 Simple data types + +The simple data types defined in table B.2.2.2.3.2-1 shall be supported. + +**Table B.2.2.2.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-------------------------|-------------|---------------| +| | | | | + +##### B.2.2.2.3.3 Enumeration: \_3gpp-5gs-node-configuration-status + +The enumeration \_3gpp-5gs-node-configuration-status represents the configuration status that may be reported by the 3GPP 5GS node. It shall comply with the provisions defined in table B.2.2.2.3.3-1. + +**Table B.2.2.2.3.3-1: Enumeration \_3gpp-5gs-node-configuration-status** + +| Enumeration value | Description | Applicability | +|--------------------------------------------|------------------------------------------------------------------------------------------|----------------------| +| _3gpp-5gs-node-resource-allocation-success | Successful resource allocation within 5GS for the requested configuration. | | +| _3gpp-5gs-node-resource-allocation-failure | Failed resource allocation within 5GS for the requested configuration. | | +| _3gpp-5gs-node-port-release | Port release due to the termination of PDU session with the requested 5GS configuration. | | + +## Annex C (normative): YANG module specification + +### C.1 General + +The present Annex contains the YANG file for the `_3gpp-5gs-detnet-node` YANG module, that specifies the 3GPP extensions to support: + +- The indication of the maximum loss and maximumd latency the 5GS system shall apply for the provided DetNet flows. +- 5GS specific status codes with information about the status of the configuration requested by the DetNet controller. +- Exposure of 5GS DetNet node identification. + +### C.2 YANG module `_3gpp-5gs-detnet-node` + +``` + file "_3gpp-5gs-detnet-node.yang" +module _3gpp-5gs-detnet-node { + yang-version 1.1; + namespace "urn:3gpp:node:detnet:_3gpp-5gs-detnet-node"; + prefix _5gs3gppdnet; + + import ietf-detnet { + prefix dnet; + reference + "draft-ietf-detnet-yang-18"; + } + + organization "3GPP CT3 Working Group"; + + contact + "CT3 WG Web: "; + + description + "_3gpp-5gs-detnet-node module contains an extension of ietf-detnet YANG module with + additional parameters defined for interworking with 3GPP 5GS. + + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + + This version of this YANG module is specified in: + 3GPP TS 29.565 V18.4.0; 5G System; + Time Sensitive Communication and Time Synchronization Function Services. + url: https://www.3gpp.org/ftp/Specs/archive/29\_series/29.565/"; + + reference + "Additional information to this YANG module is specified in: + + 3GPP TS 23.501, System architecture for the 5G System (5GS); + url: https://www.3gpp.org/ftp/Specs/archive/23\_series/23.501/ + + 3GPP TS 23.503, Policy and charging control framework (5GS) + url: https://www.3gpp.org/ftp/Specs/archive/23\_series/23.503/ + + 3GPP TS 29.513, Policy and Charging Control signalling flows and QoS parameter mapping + url: https://www.3gpp.org/ftp/Specs/archive/29\_series/29.513/"; + + revision 2023-12-12 { + description "version: v1.0.0-alpha.2"; + } + + revision 2023-06-13 { + description "version: v1.0.0-alpha.1"; + } + + typedef _3gpp-5gs-node-configuration-status { +``` + +``` + +type enumeration { + enum _3gpp-5gs-node-resource-allocation-success { + description + "Successful configuration request. + Successful resource allocation within 5GS for the requested configuration"; + } + enum _3gpp-5gs-node-resource-allocation-failure { + description + "Unsuccessful configuration request. + Failed resource allocation within 5GS for the requested configuration"; + } + enum _3gpp-5gs-node-port-release { + description + "Port release due to the termination of PDU session with the requested + 5GS configuration"; + } + description + "_3gpp-5gs-node-configuration-status type identifies the 3GPP specific configuration + status that may be reported by the 3GPP 5GS node."; +} + +container _3gpp-5gs-node-requirements { + description + "This container defines the maximum delay and/or the maximum loss the 5GS needs to satisfy"; + leaf _forwarding-sub-layer { + type dnet:forwarding-sub-layer-ref; + description + "Reference to the forwarding sub-layer that the maximum delay and/or the maximum loss + applies to"; + } + leaf _3gpp-5gs-node-max-latency { + type uint32; + units "nanoseconds"; + description + "Maximum latency from 5GS node ingress to 5GS node egress(es) for a single packet of the + DetNet flow. It is specified as an integer number of nanoseconds"; + } + leaf _3gpp-5gs-node-max-loss { + type uint32; + description + "Maximum Packet Loss Ration (PLR) parameter for the DetNet service between the 5GS node + ingress and 5GS node egress(es)"; + } +} + +container _3gpp-5gs-node-configuration-outcome { + description + "This container defines the additional outcome the 5GS may provide to a configuration + request"; + leaf _forwarding-sub-layer { + type dnet:forwarding-sub-layer-ref; + description + "Reference to the forwarding sub-layer the outcome to a configuration request applies to"; + } + leaf _3gpp-5gs-node-configuration-status { + type _3gpp-5gs-node-configuration-status; + description "Changes on configuration status reported by the 3GPP 5GS node"; + } +} + +container _3gpp-5gs-node-identity { + description + "This container defines the 5GS Node identity the 5GS provides to the DetNet controller"; + leaf _forwarding-sub-layer { + type dnet:forwarding-sub-layer-ref; + description + "Reference to the forwarding sub-layer that the 5GS node Id applies to"; + } + leaf _3gpp-5gs-node-id { + type string; + description + "5GS node identity. It is the user-plane node Id handling the traffic of the indicated + DetNet flows"; + } +} +} + + +``` + + + +## Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-08 | | | | | | TS skeleton | 0.0.0 | +| 2021-08 | CT3#117e | C3-214576 | | | | Inclusion of documents agreed in CT3#117e:
C3-214145, C3-214149, C3-214154, C3-214466, C3-214467, C3-214468, C3-214469, C3-214505, C3-214506, C3-214507, C3-214508, C3-214509, C3-214510 | 0.1.0 | +| 2021-10 | CT3#118e | C3-215473 | | | | Inclusion of documents agreed in CT3#118e:
C3-215347, C3-215348, C3-215349, C3-215350, C3-215351, C3-215352, C3-215353, C3-215354, C3-215356, C3-215357, C3-215358, C3-215470 | 0.2.0 | +| 2021-11 | CT3#119e | C3-216517 | | | | Inclusion of documents agreed in CT3#119e:
C3-216114, C3-216115, C3-216116, C3-216121, C3-216397, C3-216398, C3-216399, C3-216400, C3-216401, C3-216402, C3-216426, C3-216594, C3-215357, C3-216595 | 0.3.0 | +| 2021-12 | CT#94-e | CP-213208 | | | | Presentation for information | 1.0.0 | +| 2022-01 | CT3#119bis-e | C3-220449 | | | | Inclusion of documents agreed in CT3#119bis-e:
C3-220424, C3-220165, C3-220166, C3-220167, C3-220425, C3-220423, C3-220415, C3-220359, C3-220172 | 1.1.0 | +| 2022-02 | CT3#120e | C3-221512 | | | | Inclusion of documents agreed in CT3#120e:
C3-221181, C3-221184, C3-221185, C3-221186, C3-221187, C3-221189, C3-221190, C3-221191, C3-221192, C3-221237, C3-221445, C3-221446, C3-221469, C3-221552, C3-221606, C3-221650 | 1.2.0 | +| 2022-04 | CT3#121e | C3-222482 | | | | Inclusion of documents agreed in CT3#121e:
C3-222176, C3-222177, C3-222178, C3-222179, C3-222181, C3-222182, C3-222183, C3-222295, C3-222420, C3-222424, C3-222435, C3-222489, C3-222503, C3-222507, C3-222555, C3-222556, C3-222564, | 1.3.0 | +| 2022-05 | CT3#122e | C3-223505 | | | | Inclusion of documents agreed in CT3#122e:
C3-223121, C3-223122, C3-223124, C3-223126, C3-223229, C3-223230, C3-223131, C3-223132, C3-223283, C3-223286, C3-223469, C3-223471, C3-223472, C3-223490, C3-223494, C3-223495, C3-223660, C3-223661, C3-223693, C3-223739, C3-223744, C3-223749, | 1.4.0 | +| 2022-06 | CT#96 | CP-221099 | | | | Presentation to TSG CT for approval | 2.0.0 | +| 2022-06 | CT#96 | CP-221099 | | | | Approved by TSG CT | 17.0.0 | +| 2022-09 | CT#97e | CP-222113 | 0001 | - | F | Add PUT method in table 6.1.3.1-1 | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0002 | 1 | F | Correction to 5G access time distribution | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0003 | 1 | F | Correction to initial provisioning of TSC related service information | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0004 | - | F | Correction to notification about TSC application session context event | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0005 | - | F | Correction to notification about TSC application session context termination | 17.1.0 | +| 2020-09 | CT#97e | CP-222113 | 0006 | 1 | F | Correction to subscription to events for the existing TSC application session context | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0007 | 1 | F | Correction to the procedure of creating a new subscription | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0009 | 1 | F | Corrections to the methods of Ntsctsf_ASTI Service API | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0010 | 1 | F | Corrections to the methods of Ntsctsf_QoSandTSCAssistance API | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0011 | - | F | Corrections to the methods of Ntsctsf_TimeSynchronization API | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0013 | 1 | F | Handling of temporal validity condition | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0018 | - | F | Support of sponsored connectivity | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0019 | 1 | F | Correction to the references | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0020 | 1 | F | Correction to time synchronization capabilities subscription | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0021 | 1 | F | Data Model corrections | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0022 | 1 | F | Correction of the association of Time Sync Exposure subscriptions to AF sessions | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0023 | 1 | F | Correction of the handling of AM policies upon Time Sync configuration | 17.1.0 | +| 2022-09 | CT#97e | CP-222114 | 0024 | 1 | F | TSCTSF API corrections | 17.1.0 | +| 2022-09 | CT#97e | CP-222183 | 0025 | 1 | F | Mapping of GPSIs and Group Identifiers to a SUPI list | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0026 | - | F | Definitions of HTTP "403 Forbidden" response | 17.1.0 | +| 2022-09 | CT#97e | CP-222113 | 0027 | - | F | Initial provisioning of TSC related service information | 17.1.0 | +| 2022-09 | CT#97e | CP-222121 | 0028 | - | F | Update of info and externalDocs fields | 17.1.0 | +| 2022-12 | CT#98 | CP-223181 | 0029 | 1 | F | Corrections in the error budget calculation | 17.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------------------------|--------| +| 2022-12 | CT#98 | CP-223181 | 0030 | - | F | Miscellaneous corrections in the Time Synchronization API | 17.2.0 | +| 2022-12 | CT#98 | CP-223181 | 0033 | - | F | Correction to Ethernet flows | 17.2.0 | +| 2022-12 | CT#98 | CP-223188 | 0034 | - | F | Update of info and externalDocs fields | 17.2.0 | +| 2022-12 | CT#98 | CP-223191 | 0031 | - | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98 | CP-223192 | 0032 | 1 | F | TscEvent enumeration definition in the OpenAPI file | 18.0.0 | +| 2022-12 | CT#98 | CP-223190 | 0035 | - | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230179 | 0036 | 1 | B | Adding PER to TSC QoS inputs | 18.1.0 | +| 2023-03 | CT#99 | CP-230154 | 0038 | 1 | A | Correction to Ntsctsf_TimeSynchronization Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230154 | 0040 | | A | Correction to Ntsctsf_TSCQoSAndAssistance Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230154 | 0042 | | A | Correction to Ntsctsf_ASTI Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0043 | | F | Generalization of QoS monitoring control description | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0044 | 1 | B | Service description – support of network timing synchronization status and reporting | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0045 | 1 | B | Provisioning of coverage area filters for ASTI service | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0046 | 1 | B | Notification of 5G Access Stratum Time Distribution enabled/disabled | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0047 | | B | Provisioning of coverage area and notification of changes of capabilities configuration | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0048 | | B | Specification of application errors for TSC QoS requests | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0049 | 1 | B | Indication of Alternative Service Requirements not supported | 18.1.0 | +| 2023-03 | CT#99 | CP-230154 | 0051 | 1 | A | Correction to QoS notification control | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0053 | 1 | B | Support of BAT window and capability for BAT adaptation | 18.1.0 | +| 2023-03 | CT#99 | CP-230162 | 0055 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231143 | 0057 | 1 | B | Adding PER to QoS service operation description | 18.2.0 | +| 2023-06 | CT#100 | CP-231143 | 0058 | 1 | B | Network determined BAT offset and periodicity adaption | 18.2.0 | +| 2023-06 | CT#100 | CP-231143 | 0059 | 1 | B | The correction on the BAT window and BAT adaptation capability | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0060 | 3 | B | Support for network timing synchronization status and reporting | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0061 | 1 | F | Adding missing presence conditions | 18.2.0 | +| 2023-06 | CT#100 | CP-231149 | 0062 | 3 | B | Support of traffic characteristics and monitoring of performance characteristics | 18.2.0 | +| 2023-06 | CT#100 | CP-231143 | 0065 | 3 | F | Adding description for controlling time synchronization service | 18.2.0 | +| 2023-06 | CT#100 | CP-231180 | 0068 | 1 | A | Correction on setting Packet Delay Failure report Threshold | 18.2.0 | +| 2023-06 | CT#100 | CP-231134 | 0071 | 1 | F | Adding the time domain to procedures for provisioning TSC information | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0072 | | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231151 | 0073 | 1 | B | 3GPP extensions to DetNet YANG model to support 5GS specifics | 18.2.0 | +| 2023-06 | CT#100 | CP-231151 | 0074 | 1 | B | Definition of 3gpp-5gs-detnet-node YANG file | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0075 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232105 | 0077 | 1 | B | TSCTSF handling when it receives the time sync request from AF and subscription from UDM and the data model definition | 18.3.0 | +| 2023-09 | CT#101 | CP-232098 | 0078 | | F | Remove the trailing slash in the relative path after API URI | 18.3.0 | +| 2023-09 | CT#101 | CP-232185 | 0079 | 2 | F | Corrections to the definition of AF requested QoS for a UE or group of UEs | 18.3.0 | +| 2023-09 | CT#101 | CP-232098 | 0080 | | F | Corrections to the redirection mechanism description | 18.3.0 | +| 2023-09 | CT#101 | CP-232098 | 0081 | | F | Update the apiVersion in the QoSAndTSCAssistance Service API | 18.3.0 | +| 2023-09 | CT#101 | CP-232105 | 0082 | 1 | B | Resource and data model for the Ntsctsf_ASTI API | 18.3.0 | +| 2023-09 | CT#101 | CP-232105 | 0083 | 1 | B | Service description for the Ntsctsf_ASTI service | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0084 | - | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233245 | 0086 | 1 | F | Reslove the EN about AF requested QoS for a UE or group of UE(s) | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0087 | | F | HTTP RFCs obsoleted by IETF RFC 9113 | 18.4.0 | +| 2023-12 | CT#102 | CP-233200 | 0088 | 2 | B | Support the status information on ASTI service | 18.4.0 | +| 2023-12 | CT#102 | CP-233248 | 0089 | 1 | B | Clarification on time synchronization service | 18.4.0 | +| 2023-12 | CT#102 | CP-233266 | 0091 | 3 | B | Solving remaining Editor's Note(s) for DetNet | 18.4.0 | +| 2023-12 | CT#102 | CP-233248 | 0092 | 1 | B | Correction to clock quality information | 18.4.0 | +| 2023-12 | CT#102 | CP-233248 | 0094 | 1 | B | Update to the time synchronization status and the report | 18.4.0 | +| 2023-12 | CT#102 | CP-233248 | 0095 | 1 | F | Removal of Editor's Note | 18.4.0 | +| 2023-12 | CT#102 | CP-233229 | 0096 | 1 | F | ProblemDetails RFC 7807 obsoleted by RFC 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233201 | 0097 | 1 | F | Update the time synchronization status parameters | 18.4.0 | +| 2023-12 | CT#102 | CP-233266 | 0098 | 1 | B | Completion of YANG module for 3GPP extensions to IETF DetNet | 18.4.0 | +| 2023-12 | CT#102 | CP-233269 | 0099 | 1 | A | Miscellaneous Corrections | 18.4.0 | +| 2023-12 | CT#102 | CP-233135 | 0100 | 2 | B | Notification of Access Stratum Time Distribution configuration changes | 18.4.0 | +| 2023-12 | CT#102 | CP-233269 | 0101 | 1 | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29573/raw.md b/raw/rel-18/29_series/29573/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..4c542cb3bf39e5226578f4e811a21b63d8a2039b --- /dev/null +++ b/raw/rel-18/29_series/29573/raw.md @@ -0,0 +1,5134 @@ + + +# 3GPP TS 29.573 V18.5.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3 (Release 18)** + +![5G ADVANCED logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a large '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G ADVANCED logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'P', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------------------------------|----| +| Foreword ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions and abbreviations ..... | 10 | +| 3.1 Definitions..... | 10 | +| 3.2 Abbreviations ..... | 10 | +| 4 General Description ..... | 11 | +| 4.1 Introduction ..... | 11 | +| 4.2 N32 Interface..... | 11 | +| 4.2.1 General ..... | 11 | +| 4.2.2 N32-c Interface ..... | 11 | +| 4.2.3 N32-f Interface ..... | 12 | +| 4.3 Protocol Stack ..... | 12 | +| 4.3.1 General ..... | 12 | +| 4.3.2 HTTP/2 Protocol ..... | 13 | +| 4.3.2.1 General..... | 13 | +| 4.3.2.2 HTTP standard headers..... | 13 | +| 4.3.2.3 HTTP custom headers..... | 14 | +| 4.3.2.4 HTTP/2 connection management ..... | 14 | +| 4.3.3 Transport Protocol ..... | 14 | +| 4.3.4 Serialization Protocol ..... | 15 | +| 5 N32 Procedures ..... | 15 | +| 5.1 Introduction ..... | 15 | +| 5.2 N32 Handshake Procedures (N32-c)..... | 15 | +| 5.2.1 General ..... | 15 | +| 5.2.2 Security Capability Negotiation Procedure ..... | 15 | +| 5.2.3 Parameter Exchange Procedure ..... | 18 | +| 5.2.3.1 General..... | 18 | +| 5.2.3.2 Parameter Exchange Procedure for Cipher Suite Negotiation..... | 18 | +| 5.2.3.3 Parameter Exchange Procedure for Protection Policy Exchange ..... | 19 | +| 5.2.3.4 Parameter Exchange Procedure for Security Information list Exchange..... | 21 | +| 5.2.4 N32-f Context Termination Procedure ..... | 22 | +| 5.2.5 N32-f Error Reporting Procedure ..... | 23 | +| 5.3 Message Forwarding Procedure on N32 (N32-f)..... | 24 | +| 5.3.1 Introduction ..... | 24 | +| 5.3.2 Use of Application Layer Security ..... | 24 | +| 5.3.2.1 General..... | 24 | +| 5.3.2.2 Protection Policy Lookup ..... | 25 | +| 5.3.2.3 Message Reformatting ..... | 26 | +| 5.3.2.4 Message Forwarding to Peer SEPP ..... | 28 | +| 5.3.2.5 JOSE Protected Forwarding Options ..... | 29 | +| 5.3.3 Message Forwarding to Peer SEPP when TLS is used ..... | 29 | +| 5.3.4 Void ..... | 30 | +| 5.4 Nsepp_Telescopic_FQDN_Mapping Service..... | 30 | +| 5.4.1 General ..... | 30 | +| 5.4.2 Foreign FQDN to Telescopic FQDN Mapping Procedure..... | 30 | +| 5.4.3 Telescopic FQDN to Foreign FQDN Mapping Procedure..... | 30 | +| 5.5 Support of Roaming Intermediaries ..... | 31 | +| 5.5.1 General ..... | 31 | +| 5.5.2 N32-c connection establishment via Roaming Intermediaries ..... | 31 | +| 5.5.2.1 N32-c connection establishment using HTTP CONNECT ..... | 31 | +| 5.5.2.2 Error messages originated by Roaming Intermediaries over the N32-c interface ..... | 31 | +| 5.5.2.2.1 General ..... | 31 | +| 5.5.2.2.2 N32-c connection establishment rejection by Roaming Intermediaries ..... | 32 | + +| | | | +|------------|----------------------------------------------------------------------------------------------------|----| +| 5.5.3 | N32-f messages forwarding or origination via Roaming Intermediaries ..... | 32 | +| 5.5.3.1 | Error messages originated by (or related to) Roaming Intermediaries over the N32-f interface ..... | 32 | +| 5.5.3.1.1 | General ..... | 32 | +| 5.5.3.2 | N32-f related error determined upon receipt of an N32-f request ..... | 34 | +| 5.5.3.2.1 | Error message originated by Roaming Intermediary via N32-f..... | 34 | +| 5.5.3.2.2 | Error message originated by pSEPP on N32-f (and optionally N32-c) ..... | 35 | +| 5.5.3.3 | N32-f related error determined upon receipt of an N32-f response..... | 36 | +| 5.5.3.3.1 | Error message originated by Roaming Intermediary via N32-f..... | 36 | +| 5.5.3.3.2 | Error message formatting by the Roaming Intermediary ..... | 37 | +| 5.5.3.4 | Applicative (i.e. SBI related) error determined upon receipt of an N32-f request ..... | 38 | +| 5.5.3.4.1 | Applicative error originated by Roaming Intermediary via N32-f ..... | 38 | +| 5.5.3.4.2 | Error message formatting by the Roaming Intermediary ..... | 38 | +| 6 | API Definitions ..... | 39 | +| 6.1 | N32 Handshake API..... | 39 | +| 6.1.1 | API URI..... | 39 | +| 6.1.2 | Usage of HTTP..... | 39 | +| 6.1.2.1 | General..... | 39 | +| 6.1.2.2 | HTTP standard headers..... | 40 | +| 6.1.2.2.1 | General ..... | 40 | +| 6.1.2.2.2 | Content type ..... | 40 | +| 6.1.2.3 | HTTP custom headers..... | 40 | +| 6.1.2.3.1 | General ..... | 40 | +| 6.1.3 | Resources..... | 40 | +| 6.1.3.1 | Overview..... | 40 | +| 6.1.4 | Custom Operations without Associated Resources ..... | 40 | +| 6.1.4.1 | Overview..... | 40 | +| 6.1.4.2 | Operation: Security Capability Negotiation ..... | 40 | +| 6.1.4.2.1 | Description ..... | 40 | +| 6.1.4.2.2 | Operation Definition ..... | 41 | +| 6.1.4.3 | Operation: Parameter Exchange ..... | 41 | +| 6.1.4.3.1 | Description ..... | 41 | +| 6.1.4.3.2 | Operation Definition ..... | 42 | +| 6.1.4.4 | Operation: N32-f Context Terminate..... | 42 | +| 6.1.4.4.1 | Description ..... | 42 | +| 6.1.4.4.2 | Operation Definition ..... | 43 | +| 6.1.4.5 | Operation: N32-f Error Reporting ..... | 43 | +| 6.1.4.5.1 | Description ..... | 43 | +| 6.1.4.5.2 | Operation Definition ..... | 43 | +| 6.1.5 | Data Model ..... | 44 | +| 6.1.5.1 | General..... | 44 | +| 6.1.5.2 | Structured data types..... | 44 | +| 6.1.5.2.1 | Introduction ..... | 44 | +| 6.1.5.2.2 | Type: SecNegotiateReqData ..... | 45 | +| 6.1.5.2.3 | Type: SecNegotiateRspData ..... | 46 | +| 6.1.5.2.4 | Type: SecParamExchReqData ..... | 47 | +| 6.1.5.2.5 | Type: SecParamExchRspData..... | 48 | +| 6.1.5.2.6 | Type: ProtectionPolicy..... | 49 | +| 6.1.5.2.7 | Type: ApiMapping..... | 49 | +| 6.1.5.2.8 | Type: IeInfo..... | 50 | +| 6.1.5.2.9 | Type: ApiSignature ..... | 51 | +| 6.1.5.2.10 | Type: N32fContextInfo ..... | 51 | +| 6.1.5.2.11 | Type: N32fErrorInfo ..... | 52 | +| 6.1.5.2.12 | Type: FailedModificationInfo ..... | 53 | +| 6.1.5.2.13 | Type: N32fErrorDetail ..... | 53 | +| 6.1.5.2.14 | Type: CallbackName..... | 53 | +| 6.1.5.2.15 | Type: IpxProviderSecInfo ..... | 53 | +| 6.1.5.2.16 | Type: IntendedN32Purpose..... | 54 | +| 6.1.5.3 | Simple data types and enumerations..... | 54 | +| 6.1.5.3.1 | Introduction ..... | 54 | +| 6.1.5.3.2 | Simple data types ..... | 54 | +| 6.1.5.3.3 | Enumeration: SecurityCapability ..... | 54 | + +| | | | +|------------|------------------------------------------------------|----| +| 6.1.5.3.4 | Enumeration: HttpMethod..... | 54 | +| 6.1.5.3.5 | Enumeration: IeType..... | 55 | +| 6.1.5.3.6 | Enumeration: IeLocation..... | 55 | +| 6.1.5.3.7 | Enumeration: N32fErrorType ..... | 56 | +| 6.1.5.3.8 | Enumeration: FailureReason ..... | 56 | +| 6.1.5.3.9 | Enumeration: N32Purpose ..... | 57 | +| 6.1.5.4 | Binary data..... | 57 | +| 6.1.6 | Error Handling ..... | 57 | +| 6.1.6.1 | General..... | 57 | +| 6.1.6.2 | Protocol Errors ..... | 57 | +| 6.1.6.3 | Application Errors..... | 57 | +| 6.1.7 | Feature Negotiation ..... | 58 | +| 6.1.8 | HTTP redirection..... | 59 | +| 6.2 | JOSE Protected Message Forwarding API on N32..... | 59 | +| 6.2.1 | API URI..... | 59 | +| 6.2.2 | Usage of HTTP..... | 59 | +| 6.2.2.1 | General..... | 59 | +| 6.2.2.2 | HTTP standard headers..... | 60 | +| 6.2.2.2.1 | General ..... | 60 | +| 6.2.2.2.2 | Content type ..... | 60 | +| 6.2.2.2.3 | Accept-Encoding..... | 60 | +| 6.2.2.3 | HTTP custom headers..... | 60 | +| 6.2.2.3.1 | General ..... | 60 | +| 6.2.3 | Resources..... | 60 | +| 6.2.3.1 | Overview..... | 60 | +| 6.2.4 | Custom Operations without associated resources ..... | 60 | +| 6.2.4.1 | Overview..... | 60 | +| 6.2.4.2 | Operation: JOSE Protected Forwarding ..... | 61 | +| 6.2.4.2.1 | Description ..... | 61 | +| 6.2.4.2.2 | Operation Definition ..... | 61 | +| 6.2.4.3 | Operation: JOSE Protected Forwarding Options ..... | 63 | +| 6.2.4.3.1 | Description ..... | 63 | +| 6.2.4.3.2 | Operation Definition ..... | 63 | +| 6.2.5 | Data Model ..... | 64 | +| 6.2.5.1 | General..... | 64 | +| 6.2.5.2 | Structured data types..... | 65 | +| 6.2.5.2.1 | Introduction ..... | 65 | +| 6.2.5.2.2 | Type: N32fReformattedReqMsg..... | 65 | +| 6.2.5.2.3 | Type: N32fReformattedRspMsg..... | 66 | +| 6.2.5.2.4 | Type: DataToIntegrityProtectAndCipherBlock ..... | 66 | +| 6.2.5.2.5 | Type: DataToIntegrityProtectBlock ..... | 67 | +| 6.2.5.2.6 | Type: RequestLine ..... | 67 | +| 6.2.5.2.7 | Type: HttpHeaders..... | 68 | +| 6.2.5.2.8 | Type: HttpPayload..... | 69 | +| 6.2.5.2.9 | Type: MetaData..... | 70 | +| 6.2.5.2.10 | Type: Modifications ..... | 71 | +| 6.2.5.2.11 | Type: FlatJweJson..... | 72 | +| 6.2.5.2.12 | Type: FlatJwsJson ..... | 73 | +| 6.2.5.2.13 | Type: IndexToEncryptedValue ..... | 73 | +| 6.2.5.2.14 | Type: EncodedHttpHeaderValue ..... | 73 | +| 6.2.5.2.15 | Type: ProblemDetailsMsgForwarding ..... | 73 | +| 6.2.5.2.16 | Type: AdditionInfoMsgForwarding ..... | 74 | +| 6.2.5.3 | Simple data types and enumerations..... | 74 | +| 6.2.5.3.1 | Introduction ..... | 74 | +| 6.2.5.3.2 | Simple data types ..... | 74 | +| 6.2.5.3.3 | Void..... | 74 | +| 6.2.5.3.4 | Void..... | 74 | +| 6.2.6 | Error Handling..... | 74 | +| 6.2.6.1 | General..... | 74 | +| 6.2.6.2 | Protocol Errors ..... | 74 | +| 6.2.6.3 | Application Errors..... | 74 | +| 6.3 | Nsepp_Telescopic_FQDN_Mapping API..... | 75 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| 6.3.1 | API URI..... | 75 | +| 6.3.2 | Usage of HTTP..... | 76 | +| 6.3.2.1 | General..... | 76 | +| 6.3.2.2 | HTTP standard headers..... | 76 | +| 6.3.2.2.1 | General ..... | 76 | +| 6.3.2.2.2 | Content type ..... | 76 | +| 6.3.2.3 | HTTP custom headers..... | 76 | +| 6.3.2.3.1 | General ..... | 76 | +| 6.3.3 | Resources..... | 76 | +| 6.3.3.1 | Overview..... | 76 | +| 6.3.3.2 | Resource: Mapping..... | 77 | +| 6.3.3.2.1 | Description ..... | 77 | +| 6.3.3.2.2 | Resource Defintion..... | 77 | +| 6.3.3.2.3 | Resource Standard Methods..... | 77 | +| 6.3.4 | Data Model ..... | 78 | +| 6.3.4.1 | General..... | 78 | +| 6.3.4.2 | Structured data types..... | 78 | +| 6.3.4.2.1 | Introduction ..... | 78 | +| 6.3.4.2.2 | Type: TelescopicMapping..... | 79 | +| 6.3.4.3 | Simple data types and enumerations..... | 79 | +| 6.3.4.3.1 | Introduction ..... | 79 | +| 6.3.4.3.2 | Simple data types ..... | 79 | +| 6.3.5 | Error Handling ..... | 79 | +| 6.3.5.1 | General..... | 79 | +| 6.3.5.2 | Protocol Errors ..... | 79 | +| 6.3.5.3 | Application Errors..... | 79 | +| 6.3.6 | Feature Negotiation ..... | 80 | +| 6.3.7 | Security..... | 80 | +| 6.3.7.1 | General..... | 80 | +| Annex A (normative): | OpenAPI Specification..... | 80 | +| A.1 | General..... | 80 | +| A.2 | N32 Handshake API..... | 80 | +| A.3 | JOSE Protected Message Forwarding API on N32-f..... | 88 | +| A.4 | SEPP Telescopic FQDN Mapping API ..... | 92 | +| Annex B (informative): | Examples of N32-f Encoding..... | 94 | +| B.1 | General..... | 94 | +| B.2 | Input Message Containing No Binary Part ..... | 94 | +| B.3 | Input Message Containing Multipart Binary Part ..... | 95 | +| Annex C (informative): | End to end call flows when SEPP is on path..... | 98 | +| C.1 | General..... | 98 | +| C.2 | TLS security between SEPPs..... | 98 | +| C.2.1 | When http URI scheme is used..... | 98 | +| C.2.1.1 | General ..... | 98 | +| C.2.1.2 | Without TLS protection between NF and SEPP and with TLS security without the 3gpp-Sbi-Target-apiRoot header used over N32f..... | 98 | +| C.2.1.3 | Without TLS protection between NF and SEPP and with TLS security with the 3gpp-Sbi-Target-apiRoot header used over N32f..... | 101 | +| C.2.2 | When https URI scheme is used..... | 102 | +| C.2.2.1 | General ..... | 102 | +| C.2.2.2 | With TLS protection between NF and SEPP relying on telescopic FQDN, and TLS security without the 3gpp-Sbi-Target-apiRoot header used over N32f..... | 102 | +| C.2.2.3 | With TLS protection between NF and SEPP relying on 3gpp-Sbi-Target-apiRoot header, and TLS security without the 3gpp-Sbi-Target-apiRoot header used over N32f..... | 106 | + +| | | | +|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| C.2.2.4 | With TLS protection between NF and SEPP relying on telescopic FQDN, and TLS security with the 3gpp-Sbi-Target-apiRoot header used over N32f ..... | 109 | +| C.2.2.5 | With TLS protection between NF and SEPP relying on 3gpp-Sbi-Target-apiRoot header, and TLS security with the 3gpp-Sbi-Target-apiRoot header used over N32f..... | 112 | +| C.3 | Application Layer Security between SEPPs ..... | 114 | +| C.3.1 | When http URI scheme is used ..... | 114 | +| C.3.2 | When https URI scheme is used..... | 116 | +| C.3.2.1 | General ..... | 116 | +| C.3.2.2 | With TLS protection between NF and SEPP relying on telescopic FQDN ..... | 117 | +| C.3.2.3 | With TLS protection between NF and SEPP relying on 3gpp-Sbi-Target-apiRoot header ..... | 120 | +| Annex D (informative): | Withdrawn API versions ..... | 124 | +| D.1 | General ..... | 124 | +| D.2 | N32 Handshake API..... | 124 | +| Annex E (informative): | Change history ..... | 126 | + +# Foreword + +This Technical Specification has been produced by the 3rd 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. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the PLMN and/or SNPN interconnection Interface. It provides stage 3 protocol definitions and message flows, and specifies the APIs for the procedures on the PLMN interconnection interface (i.e N32). + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +The stage 2 level N32 procedures are specified in 3GPP TS 33.501 [6]. + +# --- 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.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [7] IETF RFC 9113: "HTTP/2". +- [8] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [9] IETF RFC 9110: "HTTP Semantics". +- [10] Void. +- [11] IETF RFC 793: "Transmission Control Protocol". +- [12] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [13] IETF RFC 7518: "JSON Web Algorithms (JWA)". + +- [14] IETF RFC 7516: "JSON Web Encryption (JWE)". +- [15] IETF RFC 4648: "The Base16, Base32, and Base64 Data Encodings". +- [16] IETF RFC 7515: "JSON Web Signature (JWS)". +- [17] IETF RFC 6901: "JavaScript Object Notation (JSON) Pointer". +- [18] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [19] 3GPP TS 23.003: "Numbering, addressing and identification". +- [20] 3GPP TR 21.900: "Technical Specification Group working methods". +- [21] IETF RFC 7468: "Textual Encodings of PKIX, PKCS, and CMS Structures". +- [22] IETF RFC 9457: "Problem Details for HTTP APIs". +- [23] IETF RFC 1952: "GZIP file format specification version 4.3". +- [24] Void +- [25] 3GPP TS 29.518: "5G System; Access and Mobility Management Service; Stage 3". +- [26] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [27] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [28] 3GPP TS 22.261: "Service requirements for the 5G system; Stage 1". + +# --- 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]. + +**c-SEPP:** The SEPP that is present on the NF service consumer side is called the c-SEPP. + +**p-SEPP:** The SEPP that is present on the NF service producer side is called the p-SEPP. + +**NOTE:** For the purpose of N32-c procedures, the two interacting SEPPs are called "initiating" SEPP and "responding" SEPP. The c-SEPP and p-SEPP terminology is not used in this specification though it is used in 3GPP TS 33.501 [6]. + +**c-IPX:** The IPX on the NF service consumer side. + +**p-IPX:** The IPX of the NF service producer side. + +**N32-c context:** This context is set up at the SEPP after the Security Capability Exchange procedure is finalized. It defines the security capability that is mutually agreed and effective for both the cSEPP and the pSEPP. + +**Roaming Intermediary:** an entity that provides roaming related services (see clause 3.1 of 3GPP TS 33.501 [6]). + +## 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]. + +| | | +|------|---------| +| GZIP | GNU ZIP | +|------|---------| + +| | | +|-------|------------------------------------------| +| IPX | IP Exchange Service | +| JOSE | Javascript Object Signing and Encryption | +| JWT | JSON Web Encryption | +| JWS | JSON Web Signature | +| PRINS | PRotocol for N32 INterconnect Security | +| SEPP | Security and Edge Protection Proxy | +| TLS | Transport Layer Security | +| UPU | UE Parameters Update | + +# 4 General Description + +## 4.1 Introduction + +This clause provides a general description of the interconnect interfaces used between the PLMNs and/or SNPNs for transporting the service based interface message exchanges. + +## 4.2 N32 Interface + +### 4.2.1 General + +The N32 interface is used between SEPPs of different PLMNs for both roaming and PLMN interconnect scenarios. + +The N32 interface may also be used between SEPPs from an SNPN and another SNPN or PLMN, for SNPN interconnect scenarios (e.g. for SNPN connectivity with a Credentials Holder network, see clause 5.30.2.9.3 of 3GPP TS 23.501 [2]). Unless specified otherwise, references to "PLMN" throughout this specification shall be substituted by "SNPN" for a SEPP that is deployed in an SNPN. + +The SEPP that is on the NF service consumer side is called the c-SEPP and the SEPP that is on the NF service producer is called the p-SEPP. The NF service consumer or SCP may be configured with the c-SEPP or discover the c-SEPP by querying the NRF. The NF service producer or SCP may be configured with the p-SEPP or discover the p-SEPP by querying the NRF. + +The N32 interface can be logically considered as 2 separate interfaces as given below. + +- N32-c, a control plane interface between the SEPPs for performing initial handshake and negotiating the parameters to be applied for the actual N32 message forwarding. +- N32-f, a forwarding interface between the SEPPs which is used for forwarding the communication between the NF service consumer and the NF service producer after applying application level security protection or TLS security protection. + +### 4.2.2 N32-c Interface + +The following figure shows the scope of the N32-c interface. + +![Diagram showing the N32-c interface between two SEPPs in different PLMNs.](e58a867750e4ae01604318506b79df7a_img.jpg) + +The diagram illustrates the N32-c interface between two SEPPs. On the left is a box labeled "SEPP in PLMN A" and on the right is a box labeled "SEPP in PLMN B". A double-headed arrow labeled "N32-c" connects the two boxes, indicating a bidirectional control plane interface. + +Diagram showing the N32-c interface between two SEPPs in different PLMNs. + +**Figure 4.2.2-1: N32-c Interface** + +The N32-c interface provides the following functionalities: + +- Initial handshake procedure between the SEPP in PLMN A (called the initiating SEPP) and the SEPP in PLMN B (called the responding SEPP), that involves capability negotiation and parameter exchange as specified in 3GPP TS 33.501 [6]. + +### 4.2.3 N32-f Interface + +The following figures shows the scope of the N32-f interface. + +![Figure 4.2.3-1a: N32-f Interface with TLS security. This diagram shows two boxes labeled 'SEPP in PLMN A' and 'SEPP in PLMN B'. Between them are two dashed boxes labeled 'IPX (PLMN A Side)' and 'IPX (PLMN B Side)'. A solid line labeled 'N32-f' connects the two IPX boxes. Arrows indicate a bidirectional flow of messages between the SEPPs through the IPX providers.](7f17c430b9598e4d748a8041457810b3_img.jpg) + +Figure 4.2.3-1a: N32-f Interface with TLS security. This diagram shows two boxes labeled 'SEPP in PLMN A' and 'SEPP in PLMN B'. Between them are two dashed boxes labeled 'IPX (PLMN A Side)' and 'IPX (PLMN B Side)'. A solid line labeled 'N32-f' connects the two IPX boxes. Arrows indicate a bidirectional flow of messages between the SEPPs through the IPX providers. + +**Figure 4.2.3-1a: N32-f Interface with TLS security** + +![Figure 4.2.3-1b: N32-f Interface with PRINS. This diagram shows two boxes labeled 'SEPP in PLMN A' and 'SEPP in PLMN B'. Between them are two dashed boxes labeled 'IPX (PLMN A Side)' and 'IPX (PLMN B Side)'. The connections between the SEPP and the first IPX, between the two IPX boxes, and between the second IPX and the SEPP are all labeled 'N32-f' with double-headed arrows, indicating that the N32-f interface is used at each hop when PRINS is negotiated.](853f59c89931a666c07903b31d098277_img.jpg) + +Figure 4.2.3-1b: N32-f Interface with PRINS. This diagram shows two boxes labeled 'SEPP in PLMN A' and 'SEPP in PLMN B'. Between them are two dashed boxes labeled 'IPX (PLMN A Side)' and 'IPX (PLMN B Side)'. The connections between the SEPP and the first IPX, between the two IPX boxes, and between the second IPX and the SEPP are all labeled 'N32-f' with double-headed arrows, indicating that the N32-f interface is used at each hop when PRINS is negotiated. + +**Figure 4.2.3-1b: N32-f Interface with PRINS** + +The N32-f interface shall be used to forward the HTTP/2 messages of the NF service producers and the NF service consumers in different PLMN, through the SEPPs of the respective PLMN. + +If TLS is the negotiated security policy between the SEPP, then the N32-f shall involve only the forwarding of the HTTP/2 messages of the NF service producers and the NF service consumers without any reformatting at the SEPPs and/or the IPXs (see figure 4.2.3-1a). + +The application layer security protection functionality of the N32-f is used only if the PProtocol for N32 INterconnect Security (PRINS) is negotiated between the SEPPs using N32-c (see figure 4.2.3-1b). + +The N32-f interface provides the following application layer security protection functionalities: + +- Message protection of the information exchanged between the NF service consumer and the NF service producer across PLMNs by applying application layer security mechanisms as specified in 3GPP TS 33.501 [6]. +- Forwarding of the application layer protected message from a SEPP in one PLMN to a SEPP in another PLMN. Such forwarding may involve IPX providers on path. +- If IPX providers are on the path from SEPP in PLMN A to SEPP in PLMN B, the forwarding on the N32-f interface may involve the insertion of content modification instructions which the receiving SEPP applies after verifying the integrity of such modification instructions. + +## 4.3 Protocol Stack + +### 4.3.1 General + +The protocol stack for the N32 interface is shown below in Figure 4.3.1-1. + +![N32 Protocol Stack diagram showing layers from Application down to L1.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +| | +|----------------------------------------------| +| Application (PRINS may be used for security) | +| HTTP/2 | +| TLS (Conditional) | +| TCP | +| IP | +| L2 | +| L1 | + +N32 Protocol Stack diagram showing layers from Application down to L1. + +Figure 4.3.1-1: N32 Protocol Stack + +The N32 interfaces (N32-c and N32-f) use HTTP/2 protocol (see clause 4.2.2 and 4.2.3, respectively) with JSON (see clause 4.2.4) as the application layer serialization protocol. For the security protection at the transport layer, the SEPPs shall support TLS as specified in clause 13.1.2 of 3GPP TS 33.501 [6]. + +For the N32-f interface, the application layer (i.e the JSON content) encapsulates the complete HTTP/2 message between the NF service consumer and the NF service producer, by transforming the HTTP/2 headers and the body into specific JSON attributes as specified in clause 6.2. For the scenarios when there are IPX entities between SEPPs, see clause 4.3.2 for TLS/PRINS usage. + +### 4.3.2 HTTP/2 Protocol + +#### 4.3.2.1 General + +HTTP/2 as described in IETF RFC 9113 [7] shall be used for N32 interface. + +#### 4.3.2.2 HTTP standard headers + +The HTTP request standard headers and the HTTP response standard headers that shall be supported on the N32 interface are defined in Table 4.2.2.2-1 and in Table 4.2.2.2-2 respectively. + +Table 4.3.2.2-1: Mandatory to support HTTP request standard headers + +| Name | Reference | Description | +|-----------------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Accept | IETF RFC 9110 [9] | This header is used to specify response media types that are acceptable. | +| Accept-Encoding | IETF RFC 9110 [9] | This header may be used to indicate what response content-encodings (e.g gzip) are acceptable in the response. | +| Content-Length | IETF RFC 9110 [10] | This header is used to provide the anticipated size, as a decimal number of octets, for a potential content. | +| Content-Type | IETF RFC 9110 [9] | This header is used to indicate the media type of the associated representation. | +| Via | IETF RFC 9110 [10] | This header is used to indicate the intermediate proxies in the service request path. Please refer to clause 6.10.8 of 3GPP TS 29.500 [4] for encoding of the via header | + +**Table 4.3.2.2-2: Mandatory to support HTTP response standard headers** + +| Name | Reference | Description | +|------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Content-Length | IETF RFC 9110 [10] | This header may be used to provide the anticipated size, as a decimal number of octets, for a potential content. | +| Content-Type | IETF RFC 9110 [9] | This header shall be used to indicate the media type of the associated representation. | +| Content-Encoding | IETF RFC 9110 [9] | This header may be used in some responses to indicate to the HTTP/2 client the content encodings (e.g gzip) applied to the response body beyond those inherent in the media type. | +| Via | IETF RFC 9110 [10] | This header is used to indicate the intermediate proxies in the service response path. Please refer to clause 6.10.8 of 3GPP TS 29.500 [4] for encoding of the via header. | +| Server | IETF RFC 9110 [9] | This header is used to indicate the originator of an HTTP error response. | + +#### 4.3.2.3 HTTP custom headers + +The HTTP custom headers specified in clause 5.2.3 of 3GPP TS 29.500 [4] shall be supported on the N32 interface. + +#### 4.3.2.4 HTTP/2 connection management + +Each SEPP initiates HTTP/2 connections towards its peer SEPP for the following purposes + +- N32-c interface +- N32-f interface + +The scope of the HTTP/2 connection used for the N32-c interface is short-lived. Once the initial handshake is completed the connection is torn down as specified in 3GPP TS 33.501 [6]. The HTTP/2 connection used for N32-c is end to end between the SEPPs and does not involve an IPX to intercept the HTTP/2 connection, though an IPX may be involved for IP level routing. + +The scope of the HTTP/2 connection used for the N32-f interface is long-lived. The N32-f HTTP/2 connection at a SEPP can be: + +- Case A: Towards a SEPP of another PLMN without involving any IPX intermediaries or involving IPX intermediaries where IPX does not require modification or observation of the information; or +- Case B: Towards a SEPP of another PLMN via IPX where IPX requires modification or observation of the information. In this case, the HTTP/2 connection from a SEPP terminates at the next hop IPX with the IPX acting as a HTTP proxy. + +For the N32-f interface the HTTP/2 connection management requirements specified in clause 5.2.6 of 3GPP TS 29.500 [4] shall be applicable. The URI scheme used for the N32-f JOSE protected message forwarding API shall be "http". If confidentiality protection of all IEs for the N32-f JOSE protected message forwarding procedure is required, then: + +- For case A, the security between the SEPPs shall be ensured by means of an IPSec or TLS connection; +- For case B, hop-by-hop security between the SEPP and the IPXs should be established on N32-f. This hop-by-hop security shall be established using an IPSec or TLS connection. + +### 4.3.3 Transport Protocol + +The Transmission Control Protocol as described in IETF RFC 793 [11] shall be used as transport protocol as required by HTTP/2 (see IETF RFC 9113 [7]). + +When there is no IPX between the SEPPs or IPX(s) are offering only IP routing service without modification or observation of the content, TLS shall be used for security protection (see clause 13.1.2 of 3GPP TS 33.501 [6]). When there is IPX between the SEPPs and IPX requires modification or observation of the content, TLS or NDS/IP should be used for security protection as specified in clause 13.1.2 of 3GPP TS 33.501 [6]. + +NOTE: When using TCP as the transport protocol, an HTTP/2 connection is mapped to a TCP connection. + +### 4.3.4 Serialization Protocol + +The JavaScript Object Notation (JSON) format as described in IETF RFC 8259 [8] shall be used as the serialization protocol. + +# 5 N32 Procedures + +## 5.1 Introduction + +The procedures on the N32 interface are split into two categories: + +- Procedures that happen end to end between the SEPPs on the N32-c interface; +- Procedures that are used for the forwarding of messages on the service based interface between the NF service consumer and the NF service producer via the SEPP across the N32-f interface. + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-----------------------------------|--------|----------------------------------|---------------------------------------------|-----------------|-------| +| N32 Handshake | 6.1 | N32-c Handshake Service | TS29573_N32_Handshake.yaml | n32c-handshake | A.2 | +| JOSE Protected Message Forwarding | 6.2 | N32-f Message Forwarding Service | TS29573_JOSEProtectedMessageForwarding.yaml | n32f-forward | A.3 | +| Nsepp_Telescopic_FQDN_Mapping | 6.3 | SEPP Telescopc FQDN Mapping | TS29573_SeppTelescopcFqdnMapping.yaml | nsepp-telescopc | A.4 | + +## 5.2 N32 Handshake Procedures (N32-c) + +### 5.2.1 General + +The N32 handshake procedure is used between the SEPPs in two PLMNs to mutually authenticate each other and negotiate the security mechanism to use over N32-f along with associated security configuration parameters. + +A HTTP/2 connection shall be established between the initiating SEPP and the responding SEPP end to end over TLS. The following N32 handshake procedures are specified in the clauses below. + +- Security Capability Negotiation Procedure +- Parameter Exchange Procedure +- N32-f Context Termination Procedure +- N32-f Error Reporting Procedure + +### 5.2.2 Security Capability Negotiation Procedure + +The initiating SEPP shall initiate a Security Capability Negotiation procedure towards the responding SEPP to agree on a security mechanism to use for protecting NF service related signalling over N32-f. An end to end TLS connection shall be setup between the SEPPs before the initiation of this procedure. This procedure may also be used to tear down + +the N32-f TLS connection if the remote SEPP indicated support of the feature NFLTST during the setup of the N32-c connection. The procedure is described in Figure 5.2.2-1 below. + +![Sequence diagram of Security Capability Negotiation Procedure between Initiating SEPP and Responding SEPP.](16152cf1d84aea10848758f51a91ff6a_img.jpg) + +``` + +sequenceDiagram + participant Initiating SEPP + participant Responding SEPP + Note left of Initiating SEPP: Initiating SEPP + Note right of Responding SEPP: Responding SEPP + Initiating SEPP->>Responding SEPP: 1. POST .../exchange-capability (SecNegotiateReqData) + Responding SEPP-->>Initiating SEPP: 2a. 200 OK (SecNegotiateRspData) + Responding SEPP-->>Initiating SEPP: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram of Security Capability Negotiation Procedure between Initiating SEPP and Responding SEPP. + +**Figure 5.2.2-1: Security Capability Negotiation Procedure** + +- The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the "SecNegotiateReqData" IE carrying the following information: + - Supported security capabilities (i.e., PRINS and/or TLS); + - Whether the 3gpp-Sbi-Target-apiRoot HTTP header is supported, if TLS security is supported; + - Sender PLMN ID(s) or SNPN ID(s); + - Target PLMN ID or SNPN ID; + - Purpose of the intended usage of N32 connection. + - The senderN32fFqdn IE, if the initiating SEPP wishes the responding SEPP to establish the N32-f connection towards a specific FQDN (of the initiating SEPP). + - The senderN32fPortList IE, if the initiating SEPP wishes the responding SEPP to establish the N32-f connection using a specific port number. When present, the list shall contain one port number per supported security capability (i.e., PRINS and/or TLS). + +If different PLMNs or SNPNs are represented by different PLMN IDs or SNPN IDs (respectively) supported by a SEPP, then the SEPP shall use separate N32-connections for each pair of local and remote PLMN or SNPN. Both SEPPs shall store the mapping between the N32 connections and their pair of PLMN IDs or SNPN IDs. + +NOTE 1: If SEPPs support separate FQDN per PLMN or SNPN, then Target PLMN Id or Target SNPN Id is not required as target PLMN or SNPN can be selected by the FQDN. + +To tear down the N32-f connection when negotiated security scheme is TLS, the "SecNegotiateReqData" IE shall contain: + +- Supported security capability set to "NONE" +- On successful processing of the request, the responding SEPP shall respond to the initiating SEPP with a "200 OK" status code and a POST response body that contains "SecNegotiateRspData" IE carrying the following information: + - Selected security capability (i.e., PRINS or TLS); + - Whether the 3gpp-Sbi-Target-apiRoot HTTP header is supported, if TLS security is selected; + - Sender PLMN ID(s) or SNPN ID(s). + - Purpose of the accepted usage of N32 connection. + - The senderN32fFqdn IE, if the responding SEPP wishes the initiating SEPP to establish the N32-f connection towards a specific FQDN (of the responding SEPP). + - The senderN32fPort IE, if the responding SEPP wishes the initiating SEPP to establish the N32-f connection using a specific port number. + +NOTE 2: Same SEPP endpoints can serve all accepted purposes over the same N32-f connection established as the result of request/response messages. + +The responding SEPP compares the initiating SEPP's supported security capabilities to its own supported security capabilities and selects, based on its local policy, a security mechanism, which is supported by both the SEPPs. If the selected security capability indicates any other capability other than PRINS, then the HTTP/2 connection initiated between the two SEPPs for the N32 handshake procedures shall be terminated. The negotiated security capability shall be applicable on both the directions. If the selected security capability is PRINS, then the two SEPPs may decide to create (if not available) / maintain HTTP/2 connection(s) where each SEPP acts as a client towards the other (which acts as a server). This may be used for later signalling of N32-f error reporting procedure (see clause 5.2.5) and N32-f context termination procedure (see clause 5.2.4). + +If different PLMNs or SNPNs are represented by different PLMN IDs or SNPN IDs (respectively) supported by a SEPP, then the SEPP shall use separate N32-connections for each pair of local and remote PLMN or SNPN. Both SEPPs shall store the mapping between the N32 connections and their pair of PLMN IDs or SNPN IDs. + +The SEPP shall select the PLMN or SNPN from the list of supported PLMN(s) or SNPN(s) based on the received Target PLMN ID or SNPN ID, or based on PLMN or SNPN specific FQDN used in the request, and provide the selected PLMN's PLMN Id(s) in the plmnIdList or the selected SNPN's SNPN Id(s) in the snpnIdList. + +In case no purposes are exchanged, the receiving SEPP shall assume by default that purposes are for Roaming and inter-PLMN mobility as described in clause 6.1.5.3.9. + +The initiating SEPP and/or responding SEPP may enable the establishment of an N32 connection for the purpose of Disaster Roaming only during disaster conditions. + +When the request is for tearing down the existing N32-f TLS connection, the "SecNegotiateRspData" IE shall contain: + +- Supported security capability set to "NONE" + +and, subsequently, both SEPP shall terminate the N32-c and N32-f TLS connection. + +If the initiating SEPP receives the senderN32fQdn IE and/or the senderN32fPort IE from the responding SEPP, the initiating SEPP shall establish the N32-f connection towards the responding SEPP using the received N32-f FQDN and/or the senderN32fPort IE. + +If the responding SEPP receives the senderN32fQdn IE and/or the senderN32fPortList IE from the initiating SEPP, the responding SEPP shall establish the N32-f connection towards the initiating SEPP using the received N32-f FQDN and/or the N32-f port number received in the senderN32fPortList IE corresponding to the selected security capability (i.e., TLS or PRINS). + +If the N32-f context exists between the peer SEPPs, and the N32 exchange capability request is not for tearing down the N32-f connections, the responding SEPP shall: + +- stop sending any further messages over the N32-f towards the initiating SEPP; +- delete the current N32-f context and terminate any N32-f connection with the initiating SEPP; and +- process the received exchange capability request. + +2b. On failure or redirection, the responding SEPP shall respond to the initiating SEPP with an appropriate status code as specified in clause 6.1.4.2. + +If the responding SEPP has sent an outgoing Security Capability Negotiation request to the initiating SEPP, the responding SEPP shall compare the FQDN of the initiating SEPP that has been received in the incoming Security Capability Negotiation request message with the FQDN of the responding SEPP that has been sent in the outgoing Security Capability Negotiation request. If the responding SEPP's FQDN lexicographically precedes, it shall reject the incoming HTTP request message with the cause "N32C\_EXCHANGE\_CAPABILITY\_ONGOING" and it shall continue with its initiated procedure and vice versa. + +EXAMPLE: assuming SEPP A's FQDN is "sepp.5gc.mnc345.mcc012.3gppnetwork.org" and SEPP B's FQDN is "sepp.5gc.mnc346.mcc012.3gppnetwork.org", then SEPP A's FQDN precedes SEPP B's FQDN and SEPP A proceeds with its exchange capability procedure. + +A SEPP may be configured to accept an HTTP request from a given PLMN and not to send an HTTP request for exchange capability towards that PLMN. + +### 5.2.3 Parameter Exchange Procedure + +#### 5.2.3.1 General + +The parameter exchange procedure shall be executed if the security capability negotiation procedure selected the security capability as PRINS. The parameter exchange procedure is performed to: + +- Agree on a cipher suite to use for protecting NF service related signalling over N32-f; and +- Optionally, exchange the protection policies to use for protecting NF service related signalling over N32. + +#### 5.2.3.2 Parameter Exchange Procedure for Cipher Suite Negotiation + +The parameter exchange procedure for cipher suite negotiation shall be performed after the security capability negotiation procedure if the selected security policy is PRINS. If there is a change in the cipher suite and the SEPP wants to renegotiate it, then the SEPP may reuse the parameter exchange procedure to override what was exchanged before. + +The procedure is described in Figure 5.2.3.2-1 below. + +![Sequence diagram showing the Parameter Exchange Procedure for Cipher Suite Negotiation between an Initiating SEPP and a Responding SEPP. The Initiating SEPP sends a POST request (1) to the Responding SEPP. The Responding SEPP responds with either a 200 OK (2a) or a 4xx/5xx (2b) response.](e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg) + +``` + +sequenceDiagram + participant Initiating SEPP + participant Responding SEPP + Note right of Initiating SEPP: 1. POST .../exchange-params +(SecParamExchReqData) + Initiating SEPP->>Responding SEPP: 1. POST .../exchange-params +(SecParamExchReqData) + Note left of Responding SEPP: 2a. 200 OK (SecParamExchRspData) + Responding SEPP-->>Initiating SEPP: 2a. 200 OK (SecParamExchRspData) + Note left of Responding SEPP: 2b. 4xx/5xx (ProblemDetails) + Responding SEPP-->>Initiating SEPP: 2b. 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram showing the Parameter Exchange Procedure for Cipher Suite Negotiation between an Initiating SEPP and a Responding SEPP. The Initiating SEPP sends a POST request (1) to the Responding SEPP. The Responding SEPP responds with either a 200 OK (2a) or a 4xx/5xx (2b) response. + +**Figure 5.2.3.2-1: Parameter Exchange Procedure for Cipher Suite Negotiation** + +1. The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the "SecParamExchReqData" IE carrying the following information + +- Supported cipher suites; + +The supported cipher suites shall be an ordered list with the cipher suites mandated by 3GPP TS 33.501 [6] appearing at the top of the list. + +The initiating SEPP also provides a N32-f context identifier for the responding SEPP to use towards the initiating SEPP for subsequent JOSE Protected Message Forwarding procedures over N32-f (see clause 5.3.3) when the responding SEPP acts as the forwarding SEPP. + +- 2a. On successful processing of the request, the responding SEPP shall respond to the initiating SEPP with a "200 OK" status code and a POST response body that contains the following information + +- Selected cipher suite + +The responding SEPP compares the initiating SEPP's supported cipher suites to its own supported cipher suites and selects, based on its local policy, a cipher suite, which is supported by both the SEPPs. The responding SEPP's supported cipher suites shall be an ordered list with the cipher suites mandated by 3GPP TS 33.501 [6] appearing at the top of the list. The selected cipher suite is applicable for both the directions of communication between the SEPPs. + +The responding SEPP also provides a N32-f context identifier for the initiating SEPP to use towards the responding SEPP for subsequent JOSE Protected Message Forwarding procedures over N32-f (see clause 5.3.3) when the initiating SEPP acts as the forwarding SEPP. + +If the receiving SEPP already has a previously negotiated cipher suite, the SEPP shall overwrite it with the new one. + +2b. On failure, the responding p-SEPP shall respond to the initiating SEPP with an appropriate 4xx/5xx status code as specified in clause 6.1.4.3. If the SEPP already has a previously negotiated cipher suite, the SEPP shall continue to use the same. + +NOTE : If a SEPP already has a previously negotiated cipher suite and a new cipher suite is also received, the SEPP starts applying the new cipher suite immediately and also continues with the old cipher suite for a limited time period. This allows messages with old policies to be completed gracefully. + +If the initiating SEPP receives a security parameter exchange request from the responding SEPP before receiving a response for its request (i.e security parameter exchange procedure collision), the initiating SEPP shall compare its FQDN that was sent in its request with the FQDN of the responding SEPP that is received in the security parameter exchange request message. If the initiating SEPP's FQDN lexicographically precedes, it shall reject the incoming HTTP request message with the cause "SECURITY\_PARAM\_EXCHANGE\_COLLISION" and it shall continue with its initiated procedure and vice versa. + +EXAMPLE: Assuming SEPP A's FQDN is "sepp.5gc.mnc345.mcc012.3gppnetwork.org" and SEPP B's FQDN is "sepp.5gc.mnc346.mcc012.3gppnetwork.org", then SEPP A's FQDN precedes SEPP B's FQDN and SEPP A proceeds with its security parameter exchange procedure. + +#### 5.2.3.3 Parameter Exchange Procedure for Protection Policy Exchange + +The parameter exchange procedure for protection policy exchange may be performed after the Parameter Exchange Procedure for Cipher Suite Negotiation (see clause 5.2.3.2). If a HTTP/2 connection does not exist towards the peer SEPP at the time of initiating this procedure, the HTTP/2 connection shall be established. If there is a change in the protection policy exchange and the SEPP wants to renegotiate it, then the SEPP may reuse the parameter exchange procedure for the protection policy exchange to override what was exchanged before. If the parameter exchange procedure for the protection policy exchange is not performed then the protection policies between the SEPP shall be exchanged out of bands. + +The procedure is described in Figure 5.2.3.3-1 below. + +![Sequence diagram showing the Parameter Exchange Procedure for Protection Policy Exchange between an Initiating SEPP and a Responding SEPP. The Initiating SEPP sends a POST request (1. POST .../exchange-params) to the Responding SEPP. The Responding SEPP responds with either a 200 OK (2a. 200 OK) or a 4xx/5xx status code (2b. 4xx/5xx).](f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg) + +``` + +sequenceDiagram + participant Initiating SEPP + participant Responding SEPP + Note left of Initiating SEPP: Initiating SEPP + Note right of Responding SEPP: Responding SEPP + Initiating SEPP->>Responding SEPP: 1. POST .../exchange-params (SecParamExchReqData) + Responding SEPP-->>Initiating SEPP: 2a. 200 OK (SecParamExchRspData) + Responding SEPP-->>Initiating SEPP: 2b. 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram showing the Parameter Exchange Procedure for Protection Policy Exchange between an Initiating SEPP and a Responding SEPP. The Initiating SEPP sends a POST request (1. POST .../exchange-params) to the Responding SEPP. The Responding SEPP responds with either a 200 OK (2a. 200 OK) or a 4xx/5xx status code (2b. 4xx/5xx). + +**Figure 5.2.3.3-1: Parameter Exchange Procedure for Protection Policy Exchange** + +1. The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the "SecParamExchReqData" IE carrying the following information + +- Protection policy information + +The protection policy information contains: + +- API to IE mapping containing the mapping information of list of leaf IEs for each: + +- Request/response and Subscribe / Unsubscribe service operation, identified by the API URI and method; and/or +- Callbacks (e.g Notification service operation), identified by the value of the 3GPP custom HTTP header "3gpp-Sbi-Callback" (see clause 5.2.3 of 3GPP TS 29.500 [4]). +- List of IE types that are to be protected across N32-f (i.e the data type encryption policy as specified in clause 13.2.3.2 of 3GPP TS 33.501 [6]); and +- Modification policy: Against each leaf IE in the API to IE mapping information, a boolean flag indicating whether that IE is allowed to be modified by an IPX on the side of the SEPP sending the protection policy information. + +2a. On successful processing of the request, the responding SEPP shall respond to the initiating SEPP with a "200 OK" status code and a POST response body that contains the following information + +- Selected protection policy information + +The Selected protection policy information contains the IEs allowed to be modified by an IPX on the side of the responding SEPP. If the responding SEPP connects to several IPXs, an isModifiable IE may be included to indicate an IE is allowed to be modified by all IPX(s) or an map type of isModifiableByIpx IE may be included to indicate an IE is allowed to be modified by an IPX identified by the key of ipxProviderId IE if this IE is allowed to be modified by some of (but not all) the IPX(s), as specified in clause 13.2.3.4 of 3GPP TS 33.501 [6]. + +The initiating SEPP shall store the modification policy which are sent from responding SEPP in selected protection policy information and the responding SEPP shall store the modification policy which are sent from the initiating SEPP in the protection policy information. The SEPP receiving the subsequent message transfers over N32-f shall check whether the modifications performed by the IPXs were permitted by the respective modification policy. + +The SEPPs shall store the encryption policy in selected protection policy information and shall apply this policy for subsequent message transfers over N32-f. The encryption policy in selected protection policy is applicable for both the directions of communication between the SEPPs. + +If the receiving SEPP already has a previously negotiated protection policy information, the SEPP shall overwrite it with the new one. + +The HTTP/2 connection used for the N32 handshake procedures may be terminated after the completion of this procedure. + +2b. On failure, the responding SEPP shall respond to the initiating SEPP with an appropriate 4xx/5xx status code as specified in clause 6.1.4.3. If the SEPP already has previously negotiated protection policy information, the SEPP shall continue to use the same. + +NOTE : If a SEPP already has a previously negotiated cipher suite and a new cipher suite is also received, the SEPP starts applying the new cipher suite immediately and also continues with the old cipher suite for a limited time period. This allows messages with old policies to be completed gracefully. + +An illustration of how the protection policy is stored and looked up in the SEPP is provided in figure 5.2.3.3-2 + +![Diagram illustrating Protection Policy Storage and Lookup in SEPP. It shows how the SEPP uses API URI, HTTP Method, and IE Info to look up protection policies and callback types.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +The diagram illustrates the Protection Policy Storage and Lookup in SEPP. It shows the following components and flow: + +- API URI Storage:** Four boxes labeled API URI1, API URI2, API URI3, and API URI4 are stacked vertically on the left. +- Policy Lookup:** + - API URI1 and API URI2 are connected to a box containing "HTTP Method" and "IE Info". This box points to a policy box containing "Data Type Encryption Policy = IETypeList" and "Modification Policy = IETypeList". + - API URI3 and API URI4 are connected to another box containing "HTTP Method" and "IE Info". This box points to another policy box containing "Data Type Encryption Policy = IETypeList" and "Modification Policy = IETypeList". +- Incoming Request Processing:** + - An "Incoming HTTP Request" box points to a step: "2. Search for an API URI matching the :path in incoming HTTP request/response to the SEPP", which then points back to the API URI boxes. + - The "Incoming HTTP Request" also points to a step: "1. If the incoming HTTP message has "3gpp-Sbi-Callback" header lookup the callback type list exchanged during protection policy exchange". +- Callback Type Lookup:** + - The step "1. If the incoming HTTP message has "3gpp-Sbi-Callback" header lookup the callback type list exchanged during protection policy exchange" points to a box containing "Callback Type#n", "Callback Type#2", and "Callback Type#1". + - This box points to an "IE Info" box. + - The "IE Info" box points to a policy box containing "Data Type Encryption Policy = IETypeList" and "Modification Policy = IETypeList". + +Diagram illustrating Protection Policy Storage and Lookup in SEPP. It shows how the SEPP uses API URI, HTTP Method, and IE Info to look up protection policies and callback types. + +**Figure 5.2.3.3-2: Protection Policy Storage and Lookup in SEPP** + +During the N32-f message forwarding, the SEPP looks at a HTTP request or response it receives from an NF service consumer or NF service producer and then uses the above tables to decide which IEs and headers in the message it shall cipher and integrity protect and which IEs it shall allow the IPXes to modify. + +#### 5.2.3.4 Parameter Exchange Procedure for Security Information list Exchange + +The initiating SEPP shall initiate a Security Information list exchange procedure towards the responding SEPP to exchange the Security Information lists that contain information on IPX public keys or certificates that are needed to verify IPX modifications at the receiving SEPP as specified in clause 13.2.2.2 of 3GPP TS 33.501 [6]. If there is a + +change in the security information list and the SEPP wants to renegotiate it, then the SEPP may reuse the parameter exchange procedure for the security information list exchange to override what was exchanged before. + +The procedure is described in Figure 5.2.3.4-1 below. + +![Sequence diagram showing the Parameter Exchange Procedure for Security Information List exchange between an Initiating SEPP and a Responding SEPP. The Initiating SEPP sends a POST .../exchange-params (SecParamExchReqData) to the Responding SEPP. The Responding SEPP responds with either a 200 OK (SecParamExchRspData) or a 4xx/5xx (ProblemDetails).](7d3d5fb5d09c0cd35a9d637be241651e_img.jpg) + +``` + +sequenceDiagram + participant Initiating SEPP + participant Responding SEPP + Note left of Initiating SEPP: Initiating SEPP + Note right of Responding SEPP: Responding SEPP + Initiating SEPP->>Responding SEPP: 1. POST .../exchange-params (SecParamExchReqData) + Responding SEPP-->>Initiating SEPP: 2a. 200 OK (SecParamExchRspData) + Responding SEPP-->>Initiating SEPP: 2b. 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram showing the Parameter Exchange Procedure for Security Information List exchange between an Initiating SEPP and a Responding SEPP. The Initiating SEPP sends a POST .../exchange-params (SecParamExchReqData) to the Responding SEPP. The Responding SEPP responds with either a 200 OK (SecParamExchRspData) or a 4xx/5xx (ProblemDetails). + +**Figure 5.2.3.4-1: Parameter Exchange Procedure for Security Information List exchange** + +1. The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the "SecParamExchReqData" IE carrying the following information: + - IPX provider identifier connected to the initiating SEPP; + - List of raw public keys or certificates for that IPX. + - 2a. On successful processing of the request, the responding SEPP shall respond to the initiating SEPP with a "200 OK" status code and a POST response body that contains the "SecParamExchRspData" IE carrying the following information: + - IPX provider identifier connected to the responding SEPP; + - List of raw public keys or certificates for that IPX. + +If the receiving SEPP already has a previously negotiated security information list, the SEPP shall overwrite it with the new one. + - 2b. On failure, the responding SEPP shall respond to the initiating SEPP with an appropriate 4xx/5xx status code as specified in clause 6.1.4.3. If the SEPP already has previously negotiated security information list, the SEPP shall continue to use the same. +- NOTE : If a SEPP already has a previously negotiated cipher suite and a new cipher suite is also received, the SEPP starts applying the new cipher suite immediately and also continues with the old cipher suite for a limited time period. This allows messages with old policies to be completed gracefully. + +### 5.2.4 N32-f Context Termination Procedure + +After the completion of the security capability negotiation procedure and/or the parameter exchange procedures, an N32-f context is established between the two SEPPs. The "n32fContextId" of each SEPP is provided to the other SEPP. This context identifier shall be stored in each SEPP until the context is explicitly terminated by the N32-f context termination procedure. The SEPP that is initiating the N32-f context termination procedure shall use the HTTP method POST on the URI: {apiRoot}/n32c-handshake//n32f-terminate. If a HTTP/2 connection does not exist towards the receiving SEPP, a HTTP/2 connection shall be created before initiating this procedure. The procedure is shown below in Figure 5.2.4-1. + +![Sequence diagram of N32f Context Termination Procedure between Initiating SEPP and Responding SEPP.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +``` + +sequenceDiagram + participant Initiating SEPP + participant Responding SEPP + Note right of Initiating SEPP: 1. POST .../n32f-terminate (N32fContextInfo) + Initiating SEPP->>Responding SEPP: 1. POST .../n32f-terminate (N32fContextInfo) + Note left of Responding SEPP: 2a. 200 OK (N32fContextInfo) + Responding SEPP-->>Initiating SEPP: 2a. 200 OK (N32fContextInfo) + Note left of Responding SEPP: 2b. 4xx/5xx (ProblemDetails) + Responding SEPP-->>Initiating SEPP: 2b. 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram of N32f Context Termination Procedure between Initiating SEPP and Responding SEPP. + +**Figure 5.2.4-1: N32f Context Termination Procedure** + +1. The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the N32-f context id information that is to be terminated. +- 2a. On success, the responding SEPP, shall: + - stop sending any further messages over the N32-f towards the initiating SEPP; + - once all the ongoing N32-f message exchanges with the initiating SEPP are completed or timed out, delete the N32-f context identified by the "n32fContextId" provided in the request. + +The N32-f HTTP/2 connections from the responding SEPP shall not be deleted if they terminate at an IPX, since that HTTP/2 connection may carry traffic towards other PLMN SEPPs as well. The responding SEPP shall return the status code "200 OK" together with an N32ContextInfo content that carries the "n32fContextId" of the initiating SEPP that the responding SEPP has stored. + +The initiating SEPP shall: + +- stop sending any further messages over the N32-f towards the responding SEPP; +- once all the ongoing N32-f message exchanges with the responding SEPP are completed or timed out, delete the local N32-f context identified by this "n32fContextId". + +If the initiating SEPP receives a N32-f termination request from the responding SEPP before receiving a response for its request (i.e N32-f Context Termination Procedure collision), the initiating SEPP shall process the received N32-f termination request from the responding SEPP and shall return the status code "200 OK" together with an N32ContextInfo content that carries the "n32fContextId" of the responding SEPP that the initiating SEPP has stored. The initiating SEPP shall behave as specified above without waiting for a response from the responding SEPP for its N32-f Context Termination request. + +- 2b. On failure, the responding SEPP shall return an appropriate 4xx/5xx status code together with the "ProblemDetails" JSON body. + +### 5.2.5 N32-f Error Reporting Procedure + +When a SEPP is not able to process a message it received over the N32-f interface due to errors, the error information is conveyed to the sending SEPP by using the N32-f error reporting procedure over the N32-c interface. The SEPP that is initiating the N32-f error reporting procedure shall use the HTTP method POST on the URI: {apiRoot}/n32c-handshake//n32f-error. If a HTTP/2 connection does not exist towards the receiving SEPP, a HTTP/2 connection shall be created before initiating this procedure. The procedure is shown below in Figure 5.2.5-1. + +![Sequence diagram of N32f Error Reporting Procedure between Initiating SEPP and Responding SEPP.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +``` + +sequenceDiagram + participant Initiating SEPP + participant Responding SEPP + Note right of Initiating SEPP: 1. POST .../n32f-error (N32fErrorInfo) + Initiating SEPP->>Responding SEPP: Request + Note left of Responding SEPP: 2a. 204 No Content + Responding SEPP-->>Initiating SEPP: Success Response + Note left of Responding SEPP: 2b. 4xx/5xx (ProblemDetails) + Responding SEPP-->>Initiating SEPP: Error Response + +``` + +Sequence diagram of N32f Error Reporting Procedure between Initiating SEPP and Responding SEPP. + +**Figure 5.2.5-1: N32f Error Reporting Procedure** + +1. The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the N32-f error information that is to be reported. +- 2a. On success, the responding SEPP, shall: + - log that the N32-f request / response message identified by the "n32fMessageId" is not processed by the receiving SEPP; + The responding SEPP shall return the status code "204 No Content". +- 2b. On failure, the responding SEPP shall return an appropriate 4xx/5xx status code together with the "ProblemDetails" JSON body. + +## 5.3 Message Forwarding Procedure on N32 (N32-f) + +### 5.3.1 Introduction + +The N32-f interface is used between two SEPPs for: + +- The forwarding of JOSE protected HTTP/2 messages between the NF service consumer and the NF service producer across two PLMNs, when PRINS is the negotiated security policy. The message forwarding on N32-f shall be based on the negotiated security capability and the exchanged security parameters between the two SEPPs (see clause 5.2). +- Forwarding of the HTTP/2 messages between the NF service consumer and the NF service producer without any reformatting and application layer protection, when TLS is the negotiated security policy. + +### 5.3.2 Use of Application Layer Security + +#### 5.3.2.1 General + +If the negotiated security capability between the two SEPPs is PRINS, one or more HTTP/2 connections between the two SEPPs for the forwarding of JOSE protected message shall be established, which may involve IPX providers on path. The forwarding of messages over the N32-f interface involves the following steps at the sending SEPP: + +1. Identification of the protection policy applicable for the API being invoked (i.e either a request/response NF service API or a subscribe/unsubscribe service API or a notification API). +2. Message reformatting as per the identified protection policy. +3. Forwarding of the reformatted message over the N32 interface. + +The processing of a message received over the N32-f interface at the receiving IPX provider involves the following steps: + +1. Apply the modifications in the "modificationsBlock" appended by the sending IPX provider as JSON patches in the DataToIntegrityProtectBlock (from the decoded "aad" part), if the "modificationsBlock" is received in the message. + +2. Determine further modifications required based on modification policy and insert the modification entries in "modificationsBlock". +3. Forwarding the received message with the above inserted modification entries in "modificationsBlock" over the N32 interface. + +The processing of a message received over the N32-f interface at the receiving SEPP involves the following steps. + +1. Identify the N32-f context using the N32-f context Id received in the message. +2. Verify the integrity protection of the message using the keying material obtained from the TLS layer during the parameter exchange procedure for that N32-f context (see 3GPP TS 33.501 [6]). The TLS connection from which the keying material is obtained is the N32-c TLS connection used for the parameter exchange procedure. +3. Decrypt the ciphertext part of the received JWE message. Decode the "aad" part of the JWE message using BASE64URL decoding. +4. For each entry in the "modificationsBlock" of the received message: + - First verify the integrity protection of that entry using the keying material applicable for the IPX that inserted that block (using the "identity" IE in the "modificationsBlock"); + - Identify the modifications policy exchanged during the parameter exchange procedure with the sending SEPP if the IPX that inserted the modificationsBlock is from the sending SEPP side; else identify the modifications policy applicable for the IPX based on local configuration; + - Check if the inserted modifications are as per the identified modifications policy; + - Apply the modifications as a JSON patch in the DataToIntegrityProtectBlock (from the decoded "aad" part). +5. Form the original JSON request / response body from the decrypted ciphertext and the decoded integrity verified "aad" block possibly modified as described in step 4. +6. If the reconstructed HTTP message has an "Authorization" header, then the SEPP shall check whether the service consumer's PLMN ID or SNPN ID is present in the Bearer token contained in the Authorization header (see 3GPP TS 29.510 [18], clause 6.3.5.2.4) and if it matches with the "Remote PLMN ID" or "Remote SNPN ID" of the N32-f context. If they do not match, the SEPP shall respond to the sending SEPP with "403 Forbidden" status code with the application specific cause set as "PLMNID\_MISMATCH" or "SNPNID\_MISMATCH". + +NOTE 1: In this case, the N32-f Error Reporting procedure specified in clause 5.2.5 is not used since the processing of the complete N32-f message fails at the receiving SEPP. + +NOTE 2: If the service consumer's PLMN ID or SNPN ID is present in the reconstructed HTTP message, then the receiving SEPP compares this with the sending SEPP's PLMN ID or SNPN ID, which is retrieved from N32f Context (see clause 5.9.3 in 3GPP TS 33.501 [6]). See the above step 6 for the receiving SEPP behaviour. If the service consumer's PLMN ID and SNPN ID are not present, the comparison is not done. + +SEPPs and IPX should support gzip coding (see IETF RFC 1952 [23]) in HTTP requests and responses and indicate so in the Accept-Encoding header, as described in clause 6.9 of 3GPP TS 29.500 [4] and clause 6.2.2.2.3. + +#### 5.3.2.2 Protection Policy Lookup + +When a SEPP receives a HTTP/2 request or response message intended to be routed towards another PLMN, the sending SEPP shall identify the protection policy as given below + +1. Identify the target PLMN from the ":authority" part of the message using the format specified in clause 6.1.4.3 of 3GPP TS 29.500 [4]. +2. Check if the incoming HTTP/2 message has the "3gpp-Sbi-Callback" header. When present, the SEPP shall select the data encryption and modification policy applicable for the specific notification type, identified by the value of the "3gpp-Sbi-Callback" header and the target PLMN, using the notification type list stored as specified in subclass 5.2.3.3. + +3. Else, if it is a HTTP/2 request message, then from the ":authority" and ":path" part of the received HTTP/2 request message, form the API URI. For the identified PLMN, check if a protection policy exists for the API URI using the table stored as specified in clause 5.2.3.3. +4. Else, if it is a HTTP/2 response message, then based on the HTTP/2 stream ID on which the response is received, identify the corresponding request that was sent by the SEPP and the protection policy applicable for that request, as specified in step 3. +5. If an entry is not found, then it means that either the particular API has no protection policy exchanged. + +Once a protection policy is identified, the SEPP shall apply the application layer security as per the identified protection policy. + +#### 5.3.2.3 Message Reformatting + +A SEPP on the sending side PLMN applies message reformatting in the following cases: + +- When it receives a HTTP/2 request message from an NF service consumer to a an NF service producer in another PLMN; +- When it receives a response HTTP/2 response message from an NF service producer to an NF service consumer in another PLMN. +- When it receives a HTTP/2 notification request message from an NF service producer to an NF service consumer in another PLMN; +- When it receives a HTTP/2 notification response message from an NF service consumer to an NF service producer in another PLMN + +The SEPP shall reformat the HTTP/2 message by encapsulating the whole message into the body of a new HTTP POST message. The body of the HTTP POST request / response message shall contain the reformatted original HTTP/2 request/response message respectively. The HTTP POST request/response body shall be encoded as the "N32fReformattedReqMsg"/"N32fReformattedRspMsg" JSON bodies respectively, as specified in clause 6.2.5. + +The "N32fReformattedReqMsg"/"N32fReformattedRspMsg" are structured as given below: + +![Figure 5.3.2.3-1: JSON representation of a reformatted HTTP message. The diagram shows the mapping of N32fReformattedReqMsg / N32fReformattedRspMsg components to FlatJweJson and FlatJwsJson structures. FlatJweJson contains Headers, protected, unprotected, iv, aad, and ciphertext (BASE64URL of JWE CipherText). FlatJwsJson contains Unprotected, headers, payload, and JWS signature. The ciphertext is derived from BASE64URL (DataToIntegrityProtectBlock) and Input to JWE Cipher Text (DataToIntegrityProtectAndCipherBlock).](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +The diagram illustrates the JSON representation of a reformatted HTTP message. It shows the mapping of components from `N32fReformattedReqMsg / N32fReformattedRspMsg` to `FlatJweJson` and `FlatJwsJson`. + +- FlatJweJson** structure: + - Headers, protected, unprotected + - iv + - aad + - ciphertext = BASE64URL(JWE CipherText) +- FlatJwsJson** structure: + - Unprotected, headers + - payload + - JWS signature +- BASE64URL (DataToIntegrityProtectBlock)** structure: + - metaData(n32fContextId) + - requestLine / statusLine + - Headers = array{"header":
, "value": {free form obj}} + - JsonPayload = [{"ieName": , "value": {free form obj}}] +- Input to JWE Cipher Text (DataToIntegrityProtectAndCipherBlock)** structure: + - [ "hdr1val", {payload 1}, "payload 2", ... ] +- BASE64URL (Modifications)** structure: + - operations (array of PatchItem) + - identity + - tag + +Figure 5.3.2.3-1: JSON representation of a reformatted HTTP message. The diagram shows the mapping of N32fReformattedReqMsg / N32fReformattedRspMsg components to FlatJweJson and FlatJwsJson structures. FlatJweJson contains Headers, protected, unprotected, iv, aad, and ciphertext (BASE64URL of JWE CipherText). FlatJwsJson contains Unprotected, headers, payload, and JWS signature. The ciphertext is derived from BASE64URL (DataToIntegrityProtectBlock) and Input to JWE Cipher Text (DataToIntegrityProtectAndCipherBlock). + +Figure 5.3.2.3-1 JSON representation of a reformatted HTTP message + +The "cipherText" part of the reformatted message in FlatJweJson shall be prepared as given below + +![Figure 5.3.2.3-2: Transformation of HTTP Header and Content to Encrypt into CipherText. The diagram shows a linear process: Input for Cipher Text -> Encryption Function -> BASE64URL Transform -> Ciphertext part of FlatJweJson.](088921fa3f5a44c8551815122517eefd_img.jpg) + +The diagram illustrates the transformation of HTTP Header and Content to Encrypt into CipherText. The process is as follows: + +- Input for Cipher Text**: { "hdr1value", {payload1 obj}, "payload2 val", ... } +- Encryption Function**: $\Phi(\text{Input})$ +- BASE64URL Transform**: BASE64URL(JWE Ciphertext) +- Ciphertext part of FlatJweJson** + +Figure 5.3.2.3-2: Transformation of HTTP Header and Content to Encrypt into CipherText. The diagram shows a linear process: Input for Cipher Text -> Encryption Function -> BASE64URL Transform -> Ciphertext part of FlatJweJson. + +Figure 5.3.2.3-2 Transformation of HTTP Header and Content to Encrypt into CipherText + +- Based on the protection policy exchanged between the SEPPs, the sending SEPP prepares an input for the JWT ciphering and integrity protection as an array of arbitrary types in the "DataToIntegrityProtectAndCipher" block with each entry containing either a HTTP header value or the value of a JSON payload IE of the API message being reformatted. The index value "encBlockIdx" in the contentpart of DataToIntegrityProtectBlock shall point to the index of a header value or IE value in this input array. +- The input block is fed into an encryption function along with the other required inputs for JWT as specified in IETF RFC 7516 [14]. +- The encryption function outputs the cipher text information. This cipher text is then subjected to BASE64URL transformation as specified in IETF RFC 4648 [15] clause 5. + +4. The output of the BASE64URL transform is then encoded as the ciphertext part of FlatJweJson IE specified in clause 6.2.5.2.11. + +#### 5.3.2.4 Message Forwarding to Peer SEPP + +Once a SEPP reformats the HTTP/2 message into the "N32ReformattedReqMsg"/"N32ReformattedRspMsg" JSON object as specified in clause 5.3.2, the SEPP forwards the message to the receiving SEPP by invoking a HTTP POST method as shown in figure 5.3.2.4-1 below. + +![Sequence diagram showing message forwarding between SEPP (PLMN A) and SEPP (PLMN B).](705ee99c3c44fd2a1ea6a3348ce8878f_img.jpg) + +``` + +sequenceDiagram + participant SEPP_A as SEPP (PLMN A) + participant SEPP_B as SEPP (PLMN B) + Note left of SEPP_A: Initiating SEPP + SEPP_A->>SEPP_B: 1. POST .../n32f-process (N32fReformattedReqMsg) + Note right of SEPP_B: Responding SEPP + SEPP_B-->>SEPP_A: 2a. 200 OK (N32fReformattedRspMsg) + SEPP_B-->>SEPP_A: 2b. 4xx/5xx (ProblemDetails) + +``` + +The diagram illustrates the interaction between two SEPPs, SEPP (PLMN A) and SEPP (PLMN B). SEPP (PLMN A) sends a POST request (1. POST .../n32f-process (N32fReformattedReqMsg)) to SEPP (PLMN B). SEPP (PLMN B) responds with either a 200 OK (2a. 200 OK (N32fReformattedRspMsg)) or a 4xx/5xx status code (2b. 4xx/5xx (ProblemDetails)). + +Sequence diagram showing message forwarding between SEPP (PLMN A) and SEPP (PLMN B). + +**Figure 5.3.2.4-1 Message Forwarding between SEPP on N32-f** + +1. The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the "N32ReformattedReqMsg" IE carrying the reformatted HTTP/2 message. The request message shall contain the "n32fContextId" information provided by the responding SEPP to the initiating SEPP earlier during the parameter exchange procedure (see clause 5.2.3). The responding SEPP shall use the "n32fContextId" information to: + - Locate the agreed cipher suite and protection policy; + - Locate the n32fContextId to be used in the response. + +If the HTTP request/response message to be forwarded over N32-f includes an 3gpp-Sbi-Message-Priority header, the initiating/responding SEPP should additionally insert a 3gpp-Sbi-Message-Priority header in the N32-f message with the same contents as the 3gpp-Sbi-Message-Priority header encoded within the "N32ReformattedReqMsg"/"N32ReformattedRspMsg" IE respectively. + +NOTE 1: Replicating the information in a N32-f message header enables the receiving SEPP to determine the priority of the forwarded HTTP request/response without having to parse the N32-f message content. + +The HTTP request content may be compressed hop by hop over N32-f, if the initiating SEPP or IPX and its next hop (IPX or SEPP) support gzip coding (see IETF RFC 1952 [23]). + +- 2a. On successful processing of the request, the responding SEPP shall: + - decompress the N32-f HTTP request content, if it is compressed; + - reconstruct the HTTP/2 message towards the NF service producer; + - compress the reconstructed HTTP request if the reconstructed HTTP content contains a Content-Encoding header indicating gzip compression; + - forward the reconstructed HTTP/2 message to the NF service producer; + - wait for the response from the NF service producer; and then + - once the response from the NF service producer is received, respond to the initiating SEPP with a "200 OK" status code and a POST response body that contains the "N32ReformattedRspMsg". The "N32ReformattedRspMsg" shall contain the reformatted HTTP response message from the responding PLMN. The response message shall contain the "n32fContextId" information provided by the initiating SEPP to the responding SEPP earlier during the parameter exchange procedure (see clause 5.2.3). + +NOTE 2: For unsuccessful processing of the request with "PLMNID\_MISMATCH", see clause 5.3.2.1. + +The responding SEPP shall be able to map the response received from the NF service producer to the HTTP/2 stream ID for the corresponding response it needs to generate towards the initiating SEPP. The HTTP/2 stream ID and the HTTP/2 connection information on either side shall be used to derive this mapping. + +The HTTP response content may be compressed hop by hop over N32-f, if the responding SEPP or IPX and its next hop (IPX or SEPP) support gzip coding (see IETF RFC 1952 [23]). + +- 2b. On failure or unsuccessful processing of the request, the responding SEPP shall respond to the initiating SEPP with an appropriate 4xx/5xx status code, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error as specified in clause 6.2.4.2. The "cause" attribute shall be set to "UNSPECIFIED", if the responding SEPP fails to process the reconstructed message, and the error is reported by N32f error reporting procedure as specified in clause 5.2.5. + +#### 5.3.2.5 JOSE Protected Forwarding Options + +The JOSE Protected Forwarding Options is used by the sending SEPP or IPX to discover the communication options supported by its next hop (IPX or SEPP) for N32-f message processing. + +![Sequence diagram showing the discovery of communication options. A box labeled 'SEPP or IPX' on the left sends a message '1. OPTIONS .../n32f-process' to a box labeled 'IPX or SEPP' on the right. The 'IPX or SEPP' box responds with '2. 204 No Content Or 4xx/5xx (ProblemDetails)' back to the 'SEPP or IPX' box.](f2ea0f64a770b22b902820457d262265_img.jpg) + +``` + +sequenceDiagram + participant SEPP or IPX + participant IPX or SEPP + Note left of SEPP or IPX: SEPP or IPX + Note right of IPX or SEPP: IPX or SEPP + SEPP or IPX->>IPX or SEPP: 1. OPTIONS .../n32f-process + IPX or SEPP-->>SEPP or IPX: 2. 204 No Content +Or 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram showing the discovery of communication options. A box labeled 'SEPP or IPX' on the left sends a message '1. OPTIONS .../n32f-process' to a box labeled 'IPX or SEPP' on the right. The 'IPX or SEPP' box responds with '2. 204 No Content Or 4xx/5xx (ProblemDetails)' back to the 'SEPP or IPX' box. + +**Figure 5.3.2.5-1: Procedure for the discovery of communication options supported by the next hop** + +1. The sending SEPP or IPX shall send an OPTIONS request to discover the communication options supported by its next hop (IPX or SEPP) for N32-f message processing. +2. If the request is accepted, the next hop (IPX or SEPP) shall respond with the status code 204 No Content and include an Accept-Encoding header (as described in IETF RFC 9110 [24]). + +On failure, the next hop shall return one of the HTTP status code listed in Table 6.2.4.3.2.1-3. + +### 5.3.3 Message Forwarding to Peer SEPP when TLS is used + +When the negotiated security policy between the SEPPs is TLS, then the procedures described in clause 5.3.2 shall not be applied. Messages shall be forwarded to the peer SEPP as specified in clause 6.1.4.3.4 of 3GPP TS 29.500 [4]. + +On failure or unsuccessful processing of the incoming N32-f request, the responding SEPP shall respond to the initiating SEPP with an appropriate 4xx/5xx status code including a ProblemDetails structure with the "cause" attribute set to one of the following application errors as specified in Table 5.3.3-1. + +**Table 5.3.3-1: Protocol and application errors generated by SEPP** + +| Protocol or application Error | HTTP status code | Description | +|-------------------------------|------------------|--------------------------------------------------------------------------------------------------------------| +| "CONTEXT_NOT_FOUND" | 403 Forbidden | The N32-f request which was received over TLS connection is rejected due to having no related N32-c context. | + +### 5.3.4 Void + +## 5.4 Nsepp\_Telescopic\_FQDN\_Mapping Service + +### 5.4.1 General + +The Nsepp\_Telescopic\_FQDN\_Mapping service is used between any Network Function and the SEPPs in the same PLMN, if TLS protection between the Network Function and the SEPP relies on using telescopic FQDN. See clause 28.5.2 of 3GPP TS 23.003 [19] and clause 6.1.4.3 of 3GPP TS 29.500 [4]) for the definition and use of Telescopic FQDN. + +### 5.4.2 Foreign FQDN to Telescopic FQDN Mapping Procedure + +This procedure is initiated by an NF Service Consumer (typically an NRF or an NSSF) that needs to interact with a NF in a foreign PLMN (typically the corresponding NRF or NSSF), and to do so, it needs to build a telescopic FQDN of said NF (i.e. concatenation of the FQDN of the foreign FQDN, and the FQDN of the local SEPP), and then the resulting telescopic FQDN needs to be "flattened" (i.e. the FQDN of the NF in the foreign PLMN needs to be converted to a singel label). The procedure is described in Figure 5.4.2-1 below. + +![Sequence diagram of the Foreign FQDN to Telescopic FQDN Mapping Procedure. It shows an NF Service Consumer sending a GET request to a SEPP, and the SEPP responding with either a 200 OK (TelescopicMapping) or a 4xx/5xx (ProblemDetails).](7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant SEPP + Note left of NF Service Consumer: + NF Service Consumer->>SEPP: 1. GET .../mapping?foreign-fqdn= + Note right of SEPP: + SEPP-->>NF Service Consumer: 2a. 200 OK (TelescopicMapping) + SEPP-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) +``` + +Sequence diagram of the Foreign FQDN to Telescopic FQDN Mapping Procedure. It shows an NF Service Consumer sending a GET request to a SEPP, and the SEPP responding with either a 200 OK (TelescopicMapping) or a 4xx/5xx (ProblemDetails). + +Figure 5.4.2-1: Foreign FQDN to Telescopic FQDN Mapping Procedure + +1. The NF Service Consumer issues an HTTP GET request towards the local SEPP with a query parameter "foreign-fqdn" containing the FQDN of the NF in the foreign PLMN, that needs to be transformed into a flattened telescopic FQDN. +- 2a. On successful processing of the request, the responding SEPP shall respond to the NF Service Consumer with a "200 OK" status code and a response body that contains a JSON object of type "TelescopicMapping", containing as attributes the label to be used as first label in the telescopic FQDN, and the domain of the local SEPP to be appended after such first label. The resulting FQDN shall be used by the NF Consumer to setup a TLS session terminated in the local SEPP, where the SEPP shall present a server certificate with a wildcard domain matching the returned telescopic FQDN. + +### 5.4.3 Telescopic FQDN to Foreign FQDN Mapping Procedure + +This procedure is initiated by an NF Service Consumer (typically another SEPP) that has received a service request with an unknown first label of a telescopic FQDN. Typically, this SEPP may interact with other SEPPs in the same PLMN in order to determine if there is an existing mapping for a given label to an FQDN of a foreign FQDN; this procedure is only expected to be used when multiple SEPPs are deployed in a PLMN. The procedure is described in Figure 5.4.3-1 below. + +![Sequence diagram showing the Foreign FQDN to Telescopic FQDN Mapping Procedure. An NF Service Consumer sends a GET request to a SEPP. The SEPP responds with either a 200 OK (TelescopicMapping) or a 4xx/5xx (ProblemDetails).](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SEPP + Note left of NF Service Consumer: 1. GET .../mapping?telescopic-label=